Skip to content

Commit ff56e13

Browse files
committed
Update @configcat/sdk to v1.0.0
1 parent bb46d7c commit ff56e13

File tree

5 files changed

+59
-62
lines changed

5 files changed

+59
-62
lines changed

package-lock.json

Lines changed: 5 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,6 @@
6161
"vue-tsc": "^2.2.8"
6262
},
6363
"dependencies": {
64-
"@configcat/sdk": "^0.1.1"
64+
"@configcat/sdk": "^1.0.0"
6565
}
6666
}

src/index.ts

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,70 @@
1-
import { Internals } from "@configcat/sdk";
2-
31
export {
42
default as ConfigCatPlugin,
53
type PluginOptions as ConfigCatPluginOptions
64
} from './plugins/ConfigCatPlugin';
75

86
export { default as FeatureWrapper } from './components/FeatureWrapper.vue';
97

10-
export const {
11-
createConsoleLogger,
12-
createFlagOverridesFromMap,
13-
createFlagOverridesFromQueryParams
14-
} = Internals;
8+
/* Public type re-exports from @configcat/sdk */
9+
10+
// These exports should be kept in sync with the exports listed in the `src/index/browser.ts` module
11+
// located in the `js-unified-sdk` repo (https://github.com/configcat/js-unified-sdk).
12+
13+
export { createConsoleLogger, createFlagOverridesFromMap, createFlagOverridesFromQueryParams } from "@configcat/sdk";
1514

16-
export type IQueryStringProvider = Internals.IQueryStringProvider;
15+
export type { IQueryStringProvider } from "@configcat/sdk";
1716

18-
/* Public types re-export from @configcat/sdk */
17+
export { LocalStorageConfigCache } from "@configcat/sdk";
1918

20-
// These exports should be kept in sync with the exports listed in the `src/index.ts` module
21-
// located in the `js-unified-sdk` repo (https://github.com/configcat/js-unified-sdk)!
19+
export { IndexedDBConfigCache } from "@configcat/sdk";
2220

23-
export { PollingMode } from "@configcat/sdk";
21+
export { XmlHttpRequestConfigFetcher } from "@configcat/sdk";
22+
23+
export { ClientSideFetchApiConfigFetcher } from "@configcat/sdk";
24+
25+
// These exports should be kept in sync with the exports listed in the `src/index.ts` module.
26+
27+
export type { IConfigCatCache } from "@configcat/sdk";
28+
29+
export type { IConfigCatClient, IConfigCatClientSnapshot } from "@configcat/sdk";
2430

2531
export type { IAutoPollOptions, ILazyLoadingOptions, IManualPollOptions, IOptions } from "@configcat/sdk";
2632

27-
export { DataGovernance } from "@configcat/sdk";
33+
export { DataGovernance, PollingMode } from "@configcat/sdk";
2834

29-
export type { IConfigCatLogger, LogEventId, LogMessage } from "@configcat/sdk";
35+
export type { IConfigCatLogger, LogEventId, LogFilterCallback, LogMessage } from "@configcat/sdk";
3036

31-
export { LogLevel } from "@configcat/sdk";
37+
export { FormattableLogMessage, LogLevel } from "@configcat/sdk";
3238

33-
export { FormattableLogMessage } from "@configcat/sdk";
39+
export type { FetchErrorCauses, IConfigCatConfigFetcher } from "@configcat/sdk";
3440

35-
export type { IConfigCatCache } from "@configcat/sdk";
41+
export { FetchError, FetchRequest, FetchResponse } from "@configcat/sdk";
42+
43+
export { PrerequisiteFlagComparator, SegmentComparator, SettingType, UserComparator } from "@configcat/sdk";
44+
45+
export type { RefreshResult } from "@configcat/sdk";
46+
47+
export { ClientCacheState, RefreshErrorCode } from "@configcat/sdk";
48+
49+
export type { FlagOverrides, IOverrideDataSource } from "@configcat/sdk";
50+
51+
export { OverrideBehaviour } from "@configcat/sdk";
3652

3753
export type {
38-
ConditionTypeMap, ICondition, IConditionUnion, IConfig, IPercentageOption, IPrerequisiteFlagCondition,
39-
ISegment, ISegmentCondition, ISetting, ISettingUnion, ISettingValueContainer, ITargetingRule,
40-
IUserCondition, IUserConditionUnion, SettingTypeMap, SettingValue, UserConditionComparisonValueTypeMap,
41-
VariationIdValue
54+
Condition, ConditionContainer, Config, PercentageOption, PrerequisiteFlagCondition, Segment, SegmentCondition,
55+
Setting, SettingValue, SettingValueContainer, SettingValueModel, TargetingRule, UserCondition, VariationIdValue,
4256
} from "@configcat/sdk";
4357

44-
export { PrerequisiteFlagComparator, SegmentComparator, SettingType, UserComparator } from "@configcat/sdk";
58+
export { ConfigJson, deserializeConfig, prepareConfig, createSettingFromValue } from "@configcat/sdk";
4559

46-
export type { IConfigCatClient, IConfigCatClientSnapshot, SettingKeyValue } from "@configcat/sdk";
60+
export type { IEvaluationDetails, EvaluationDetails, SettingKeyValue, SettingTypeOf } from "@configcat/sdk";
4761

48-
export type { IEvaluationDetails, SettingTypeOf } from "@configcat/sdk";
62+
export { EvaluationErrorCode } from "@configcat/sdk";
4963

5064
export type { IUser, UserAttributeValue } from "@configcat/sdk";
5165

5266
export { User } from "@configcat/sdk";
5367

54-
export type { FlagOverrides } from "@configcat/sdk";
55-
56-
export { OverrideBehaviour } from "@configcat/sdk";
57-
58-
export { ClientCacheState, RefreshResult } from "@configcat/sdk";
59-
60-
export type { HookEvents, IProvidesHooks } from "@configcat/sdk";
68+
export type { HookEvents, IProvidesConfigCatClient, IProvidesHooks } from "@configcat/sdk";
6169

62-
export { ConfigJson } from "@configcat/sdk";
70+
export type { Message } from "@configcat/sdk";

src/plugins/ConfigCatPlugin.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Internals, PollingMode } from "@configcat/sdk";
1+
import { Internals, LocalStorageConfigCache, PollingMode, XmlHttpRequestConfigFetcher } from "@configcat/sdk";
22
import CONFIGCAT_SDK_VERSION from "./Version";
33
// Types
44
import type { App } from "vue";
@@ -22,9 +22,9 @@ export default {
2222
const configCatKernel: Internals.IConfigCatKernel = {
2323
sdkType: "ConfigCat-Vue",
2424
sdkVersion: CONFIGCAT_SDK_VERSION,
25-
configFetcher: new Internals.XmlHttpRequestConfigFetcher(),
2625
eventEmitterFactory: () => new Internals.DefaultEventEmitter(),
27-
defaultCacheFactory: Internals.LocalStorageConfigCache.tryGetFactory()
26+
defaultCacheFactory: LocalStorageConfigCache["tryGetFactory"](),
27+
configFetcherFactory: XmlHttpRequestConfigFetcher["getFactory"](),
2828
};
2929

3030
const configCatClient = Internals.getClient(

tests/mocks/ConfigCatClientMocks.ts

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
import { ConfigJson, ClientCacheState, HookEvents, IConfig, IConfigCatClient, IConfigCatClientSnapshot, IEvaluationDetails, RefreshResult, SettingKeyValue, SettingTypeOf, SettingValue, User } from "../../src";
2-
import { Internals } from "@configcat/sdk";
3-
import { Config } from "@configcat/sdk/lib/esm/ProjectConfig.js";
4-
import { isAllowedValue } from "@configcat/sdk/lib/esm/RolloutEvaluator.js";
1+
import { Config, ConfigJson, ClientCacheState, EvaluationDetails, HookEvents, IConfigCatClient, IConfigCatClientSnapshot, Internals, prepareConfig, RefreshResult, SettingKeyValue, SettingTypeOf, SettingValue, User } from "@configcat/sdk";
2+
import { isAllowedValue } from "@configcat/sdk/lib/esm/ProjectConfig.js";
53

64
export class ConfigCatClientMockBase implements IConfigCatClient {
75
constructor(
@@ -11,7 +9,7 @@ export class ConfigCatClientMockBase implements IConfigCatClient {
119
getValueAsync<T extends SettingValue>(key: string, defaultValue: T, user?: User | undefined): Promise<SettingTypeOf<T>> {
1210
throw new Error("Method not implemented.");
1311
}
14-
getValueDetailsAsync<T extends SettingValue>(key: string, defaultValue: T, user?: User | undefined): Promise<IEvaluationDetails<SettingTypeOf<T>>> {
12+
getValueDetailsAsync<T extends SettingValue>(key: string, defaultValue: T, user?: User | undefined): Promise<EvaluationDetails<SettingTypeOf<T>>> {
1513
throw new Error("Method not implemented.");
1614
}
1715
getAllKeysAsync(): Promise<string[]> {
@@ -20,7 +18,7 @@ export class ConfigCatClientMockBase implements IConfigCatClient {
2018
getAllValuesAsync(user?: User | undefined): Promise<SettingKeyValue<SettingValue>[]> {
2119
throw new Error("Method not implemented.");
2220
}
23-
getAllValueDetailsAsync(user?: User | undefined): Promise<IEvaluationDetails<SettingValue>[]> {
21+
getAllValueDetailsAsync(user?: User | undefined): Promise<EvaluationDetails<SettingValue>[]> {
2422
throw new Error("Method not implemented.");
2523
}
2624
getKeyAndValueAsync(variationId: string): Promise<SettingKeyValue<SettingValue> | null> {
@@ -82,7 +80,7 @@ export class ConfigCatClientMockBase implements IConfigCatClient {
8280
export class ConfigCatClientSnapshotMockBase implements IConfigCatClientSnapshot {
8381
constructor(
8482
public cacheState = ClientCacheState.NoFlagData,
85-
public fetchedConfig: IConfig | null = null) {
83+
public fetchedConfig: Config | null = null) {
8684
}
8785

8886
getAllKeys(): readonly string[] {
@@ -91,7 +89,10 @@ export class ConfigCatClientSnapshotMockBase implements IConfigCatClientSnapshot
9189
getValue<T extends SettingValue>(key: string, defaultValue: T, user?: User | undefined): SettingTypeOf<T> {
9290
throw new Error("Method not implemented.");
9391
}
94-
getValueDetails<T extends SettingValue>(key: string, defaultValue: T, user?: User | undefined): IEvaluationDetails<SettingTypeOf<T>> {
92+
getValueDetails<T extends SettingValue>(key: string, defaultValue: T, user?: User | undefined): EvaluationDetails<SettingTypeOf<T>> {
93+
throw new Error("Method not implemented.");
94+
}
95+
getKeyAndValue(variationId: string): SettingKeyValue | null {
9596
throw new Error("Method not implemented.");
9697
}
9798
}
@@ -186,7 +187,7 @@ function createConfigFromValue(key: string, value: NonNullable<SettingValue>): C
186187
f: { [key]: { t: settingType, v: settingValue } as ConfigJson.SettingUnion }
187188
};
188189

189-
return new Config(configJson);
190+
return prepareConfig(configJson);
190191
}
191192

192193
function isValidSettingValue(settingValue: NonNullable<SettingValue>, defaultValue: SettingValue) {

0 commit comments

Comments
 (0)