@featbit/js-client-sdk 3.0.13 → 4.0.0

package/src/platform/requests.ts

@@ -1,77 +1,77 @@
-// These are not full specifications of the interface, but instead subsets
-// based on the functionality needed by the SDK. Exposure of the full standard
-// would require much more per platform implementation for platforms that do not
-// natively support fetch.
-
-/**
- * Interface for headers that are part of a fetch response.
- */
-export interface IHeaders {
-  /**
-   * Get a header by name.
-   *
-   * https://developer.mozilla.org/en-US/docs/Web/API/Headers/get
-   *
-   * @param name The name of the header to get.
-   */
-  get(name: string): string | null;
-
-  /**
-   * Returns an iterator allowing iteration of all the keys contained
-   * in this object.
-   *
-   * https://developer.mozilla.org/en-US/docs/Web/API/Headers/keys
-   *
-   */
-  keys(): Iterable<string>;
-
-  /**
-   * Returns an iterator allowing iteration of all the values contained
-   * in this object.
-   *
-   * https://developer.mozilla.org/en-US/docs/Web/API/Headers/values
-   */
-  values(): Iterable<string>;
-
-  /**
-   * Returns an iterator allowing iteration of all the key-value pairs in
-   * the object.
-   *
-   * https://developer.mozilla.org/en-US/docs/Web/API/Headers/entries
-   */
-  entries(): Iterable<[string, string]>;
-
-  /**
-   * Returns true if the header is present.
-   * @param name The name of the header to check.
-   */
-  has(name: string): boolean;
-}
-
-/**
- * Interface for fetch responses.
- */
-export interface IResponse {
-  status: number;
-
-  /**
-   * Read the response and provide it as a string.
-   */
-  text(): Promise<string>;
-
-  /**
-   * Read the response and provide it as decoded json.
-   */
-  json(): Promise<any>;
-}
-
-export interface IRequestOptions {
-  headers?: Record<string, string>;
-  method?: string;
-  body?: string;
-  timeout?: number;
-}
-
-export interface IRequests {
-  fetch(url: string, options?: IRequestOptions): Promise<IResponse>;
+// These are not full specifications of the interface, but instead subsets
+// based on the functionality needed by the SDK. Exposure of the full standard
+// would require much more per platform implementation for platforms that do not
+// natively support fetch.
+
+/**
+ * Interface for headers that are part of a fetch response.
+ */
+export interface IHeaders {
+  /**
+   * Get a header by name.
+   *
+   * https://developer.mozilla.org/en-US/docs/Web/API/Headers/get
+   *
+   * @param name The name of the header to get.
+   */
+  get(name: string): string | null;
+
+  /**
+   * Returns an iterator allowing iteration of all the keys contained
+   * in this object.
+   *
+   * https://developer.mozilla.org/en-US/docs/Web/API/Headers/keys
+   *
+   */
+  keys(): Iterable<string>;
+
+  /**
+   * Returns an iterator allowing iteration of all the values contained
+   * in this object.
+   *
+   * https://developer.mozilla.org/en-US/docs/Web/API/Headers/values
+   */
+  values(): Iterable<string>;
+
+  /**
+   * Returns an iterator allowing iteration of all the key-value pairs in
+   * the object.
+   *
+   * https://developer.mozilla.org/en-US/docs/Web/API/Headers/entries
+   */
+  entries(): Iterable<[string, string]>;
+
+  /**
+   * Returns true if the header is present.
+   * @param name The name of the header to check.
+   */
+  has(name: string): boolean;
+}
+
+/**
+ * Interface for fetch responses.
+ */
+export interface IResponse {
+  status: number;
+
+  /**
+   * Read the response and provide it as a string.
+   */
+  text(): Promise<string>;
+
+  /**
+   * Read the response and provide it as decoded json.
+   */
+  json(): Promise<any>;
+}
+
+export interface IRequestOptions {
+  headers?: Record<string, string>;
+  method?: string;
+  body?: string;
+  timeout?: number;
+}
+
+export interface IRequests {
+  fetch(url: string, options?: IRequestOptions): Promise<IResponse>;
 }

package/src/store/BaseStore.ts

@@ -1,126 +1,126 @@
-import { IStore } from "../platform";
-import { IKeyedStoreItem, IStoreDataStorage, IStoreItem, IStoreKindData } from "./store";
-import { IUser } from "../options";
-import { IDataKind } from "../IDataKind";
-
-export class BaseStore implements IStore {
-  protected store: IStoreDataStorage  = {} as IStoreDataStorage;
-
-  protected initCalled = false;
-
-  protected _user: IUser = {} as IUser;
-
-  constructor() {
-  }
-
-  async identify(user: IUser) {
-    this._user = {...user};
-
-    await this.saveUser();
-    await this.loadStoreFromStorage();
-  }
-
-  get user(): IUser {
-    return this._user;
-  }
-
-  protected async addItem(kind: IDataKind, key: string, item: IStoreItem) {
-    let items = this.store[kind.namespace];
-    if (!items) {
-      items = {};
-      this.store[kind.namespace] = items;
-    }
-    if (Object.hasOwnProperty.call(items, key)) {
-      const old = items[key];
-      // we use <= here, the reason is that when a segment is changed, the upstream service would push the flag
-      // to client SDK with flag timestamp (version) instead of segment timestamp, so to ensure that the new flag value
-      // is saved, we need to use <=
-      if (!old || old.version <= item.version) {
-        items[key] = item;
-      }
-    } else {
-      items[key] = item;
-    }
-
-    if (item.version > this.store.version) {
-      this.store.version = item.version;
-    }
-
-    await this.dumpStoreToStorage();
-  }
-
-  get(kind: IDataKind, key: string): IStoreItem | null {
-    const items = this.store[kind.namespace];
-    if (items) {
-      if (Object.prototype.hasOwnProperty.call(items, key)) {
-        const item = items[key];
-        if (item) {
-          return item;
-        }
-      }
-    }
-    return null;
-  }
-
-  all(kind: IDataKind): [IStoreKindData, number] {
-    const result: IStoreKindData = {};
-    const items = this.store[kind.namespace] ?? {};
-    Object.entries(items).forEach(([key, item]) => {
-      if (item) {
-        result[key] = <IStoreItem>item;
-      }
-    });
-
-    return [result, this.store.version];
-  }
-
-  async init(allData: IStoreDataStorage) {
-    this.store = allData as IStoreDataStorage;
-
-    Object.keys(allData).map(namespace => {
-      Object.entries(allData[namespace]).forEach(([_, item]) => {
-        const ele = item as IStoreItem;
-        if (ele.version > this.store.version) {
-          this.store.version = ele.version;
-        }
-      })
-    });
-
-    await this.dumpStoreToStorage();
-    this.initCalled = true;
-  }
-
-  async upsert(kind: IDataKind, data: IKeyedStoreItem) {
-    await this.addItem(kind, data.key, data);
-  }
-
-  initialized(): boolean {
-    return this.initCalled;
-  }
-
-  /* eslint-disable class-methods-use-this */
-  close(): void {
-    // For the LocalStorage store this is a no-op.
-  }
-
-  get version(): number {
-    return this.store.version;
-  }
-
-  // This getter needs to be overridden in the child class
-  get description(): string {
-    return '';
-  }
-
-  // This method needs to be overridden in the child class
-  protected async saveUser(): Promise<void> {
-  }
-
-  // This method needs to be overridden in the child class
-  protected async loadStoreFromStorage(): Promise<void> {
-  }
-
-  // This method needs to be overridden in the child class
-  protected async dumpStoreToStorage(): Promise<void> {
-  }
+import { IStore } from "../platform";
+import { IKeyedStoreItem, IStoreDataStorage, IStoreItem, IStoreKindData } from "./store";
+import { IUser } from "../options";
+import { IDataKind } from "../IDataKind";
+
+export class BaseStore implements IStore {
+  protected store: IStoreDataStorage  = {} as IStoreDataStorage;
+
+  protected initCalled = false;
+
+  protected _user: IUser = {} as IUser;
+
+  constructor() {
+  }
+
+  async identify(user: IUser) {
+    this._user = {...user};
+
+    await this.saveUser();
+    await this.loadStoreFromStorage();
+  }
+
+  get user(): IUser {
+    return this._user;
+  }
+
+  protected async addItem(kind: IDataKind, key: string, item: IStoreItem) {
+    let items = this.store[kind.namespace];
+    if (!items) {
+      items = {};
+      this.store[kind.namespace] = items;
+    }
+    if (Object.hasOwnProperty.call(items, key)) {
+      const old = items[key];
+      // we use <= here, the reason is that when a segment is changed, the upstream service would push the flag
+      // to client SDK with flag timestamp (version) instead of segment timestamp, so to ensure that the new flag value
+      // is saved, we need to use <=
+      if (!old || old.version <= item.version) {
+        items[key] = item;
+      }
+    } else {
+      items[key] = item;
+    }
+
+    if (item.version > this.store.version) {
+      this.store.version = item.version;
+    }
+
+    await this.dumpStoreToStorage();
+  }
+
+  get(kind: IDataKind, key: string): IStoreItem | null {
+    const items = this.store[kind.namespace];
+    if (items) {
+      if (Object.prototype.hasOwnProperty.call(items, key)) {
+        const item = items[key];
+        if (item) {
+          return item;
+        }
+      }
+    }
+    return null;
+  }
+
+  all(kind: IDataKind): [IStoreKindData, number] {
+    const result: IStoreKindData = {};
+    const items = this.store[kind.namespace] ?? {};
+    Object.entries(items).forEach(([key, item]) => {
+      if (item) {
+        result[key] = <IStoreItem>item;
+      }
+    });
+
+    return [result, this.store.version];
+  }
+
+  async init(allData: IStoreDataStorage) {
+    this.store = allData as IStoreDataStorage;
+
+    Object.keys(allData).map(namespace => {
+      Object.entries(allData[namespace]).forEach(([_, item]) => {
+        const ele = item as IStoreItem;
+        if (ele.version > this.store.version) {
+          this.store.version = ele.version;
+        }
+      })
+    });
+
+    await this.dumpStoreToStorage();
+    this.initCalled = true;
+  }
+
+  async upsert(kind: IDataKind, data: IKeyedStoreItem) {
+    await this.addItem(kind, data.key, data);
+  }
+
+  initialized(): boolean {
+    return this.initCalled;
+  }
+
+  /* eslint-disable class-methods-use-this */
+  close(): void {
+    // For the LocalStorage store this is a no-op.
+  }
+
+  get version(): number {
+    return this.store.version;
+  }
+
+  // This getter needs to be overridden in the child class
+  get description(): string {
+    return '';
+  }
+
+  // This method needs to be overridden in the child class
+  protected async saveUser(): Promise<void> {
+  }
+
+  // This method needs to be overridden in the child class
+  protected async loadStoreFromStorage(): Promise<void> {
+  }
+
+  // This method needs to be overridden in the child class
+  protected async dumpStoreToStorage(): Promise<void> {
+  }
 }

package/src/store/DataKinds.ts

@@ -1,7 +1,7 @@
-import { IDataKind } from "../IDataKind";
-
-export default class DataKinds {
-  static readonly Flags: IDataKind = {
-    namespace: 'flags'
-  };
+import { IDataKind } from "../IDataKind";
+
+export default class DataKinds {
+  static readonly Flags: IDataKind = {
+    namespace: 'flags'
+  };
 }

package/src/store/IDataSourceUpdates.ts

@@ -1,68 +1,68 @@
-import { IDataKind } from "../IDataKind";
-import { IStoreDataStorage, IKeyedStoreItem } from "./store";
-
-/**
- * Interface that a data source implementation will use to push data into the SDK.
- *
- * The data source interacts with this object, rather than manipulating the data store directly, so
- * that the SDK can perform any other necessary operations that must happen when data is updated.
- */
-export interface IDataSourceUpdates {
-  /**
-   * Completely overwrites the current contents of the data store with a set of items for each
-   * collection.
-   *
-   * @param userKeyId
-   *  The key ID of the user whose data is being updated.
-   *
-   * @param allData
-   *   An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
-   *   the value is an object that maps keys to entities. The actual type of this parameter is
-   *   `interfaces.FullDataSet<VersionedData>`.
-   *
-   * @param callback
-   *   Will be called when the store has been initialized.
-   */
-  init(userKeyId: string, allData: IStoreDataStorage, callback?: () => void): Promise<void>;
-
-  /**
-   * Compare old and new data, check if any update exists
-   * If update exists, send onUpdate events
-   *
-   * @param oldData
-   *   An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
-   *   the value is an object that maps keys to entities. The actual type of this parameter is
-   *   `interfaces.FullDataSet<VersionedData>`.
-   *
-   * @param newData
-   *   An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
-   *   the value is an object that maps keys to entities. The actual type of this parameter is
-   *   `interfaces.FullDataSet<VersionedData>`.
-   *
-   * @param callback
-   *   Will be called when the store has been initialized.
-   */
-  checkUpdates(oldData: IStoreDataStorage, newData: IStoreDataStorage, callback?: () => void): void;
-
-  /**
-   * Updates or inserts an item in the specified collection. For updates, the object will only be
-   * updated if the existing version is less than the new version.
-   *
-   * @param userKeyId
-   *  The key ID of the user whose data is being updated.
-   *
-   * @param kind
-   *   The type of data to be accessed. The actual type of this parameter is
-   *   {@link IDataKind}.
-   *
-   * @param data
-   *   The contents of the entity, as an object that can be converted to JSON. The store
-   *   should check the `version` property of this object, and should *not* overwrite any
-   *   existing data if the existing `version` is greater than or equal to that value.
-   *   The actual type of this parameter is {@link IKeyedStoreItem}.
-   *
-   * @param callback
-   *   Will be called after the upsert operation is complete.
-   */
-  upsert(userKeyId: string, kind: IDataKind, data: IKeyedStoreItem, callback: () => void): Promise<void>;
-}
+import { IDataKind } from "../IDataKind";
+import { IStoreDataStorage, IKeyedStoreItem } from "./store";
+
+/**
+ * Interface that a data source implementation will use to push data into the SDK.
+ *
+ * The data source interacts with this object, rather than manipulating the data store directly, so
+ * that the SDK can perform any other necessary operations that must happen when data is updated.
+ */
+export interface IDataSourceUpdates {
+  /**
+   * Completely overwrites the current contents of the data store with a set of items for each
+   * collection.
+   *
+   * @param userKeyId
+   *  The key ID of the user whose data is being updated.
+   *
+   * @param allData
+   *   An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
+   *   the value is an object that maps keys to entities. The actual type of this parameter is
+   *   `interfaces.FullDataSet<VersionedData>`.
+   *
+   * @param callback
+   *   Will be called when the store has been initialized.
+   */
+  init(userKeyId: string, allData: IStoreDataStorage, callback?: () => void): Promise<void>;
+
+  /**
+   * Compare old and new data, check if any update exists
+   * If update exists, send onUpdate events
+   *
+   * @param oldData
+   *   An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
+   *   the value is an object that maps keys to entities. The actual type of this parameter is
+   *   `interfaces.FullDataSet<VersionedData>`.
+   *
+   * @param newData
+   *   An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
+   *   the value is an object that maps keys to entities. The actual type of this parameter is
+   *   `interfaces.FullDataSet<VersionedData>`.
+   *
+   * @param callback
+   *   Will be called when the store has been initialized.
+   */
+  checkUpdates(oldData: IStoreDataStorage, newData: IStoreDataStorage, callback?: () => void): void;
+
+  /**
+   * Updates or inserts an item in the specified collection. For updates, the object will only be
+   * updated if the existing version is less than the new version.
+   *
+   * @param userKeyId
+   *  The key ID of the user whose data is being updated.
+   *
+   * @param kind
+   *   The type of data to be accessed. The actual type of this parameter is
+   *   {@link IDataKind}.
+   *
+   * @param data
+   *   The contents of the entity, as an object that can be converted to JSON. The store
+   *   should check the `version` property of this object, and should *not* overwrite any
+   *   existing data if the existing `version` is greater than or equal to that value.
+   *   The actual type of this parameter is {@link IKeyedStoreItem}.
+   *
+   * @param callback
+   *   Will be called after the upsert operation is complete.
+   */
+  upsert(userKeyId: string, kind: IDataKind, data: IKeyedStoreItem, callback: () => void): Promise<void>;
+}

package/src/store/InMemoryStore.ts

@@ -1,37 +1,37 @@
-import {
-  StoreStorageKey,
-  IStoreDataStorage
-} from "./store";
-import { BaseStore } from "./BaseStore";
-
-export default class InMemoryStore extends BaseStore {
-  private allStores: { [DataStoreStorageKey: string]: IStoreDataStorage } = {};
-
-  constructor() {
-    super();
-  }
-
-  /* eslint-disable class-methods-use-this */
-  close(): void {
-    // For the LocalStorage store this is a no-op.
-  }
-
-  get description(): string {
-    return 'in-memory-store'
-  }
-
-  protected async saveUser(): Promise<void> {
-    // For in-memory store, this is a no-op.
-  }
-
-  protected override async dumpStoreToStorage() {
-    const storageKey = `${StoreStorageKey}-${this._user.keyId}`;
-    this.allStores[storageKey] = {...this.store};
-  }
-
-  protected override async loadStoreFromStorage() {
-    const storageKey = `${StoreStorageKey}-${this._user.keyId}`;
-
-    this.store = this.allStores[storageKey] ?? { flags: {}, version: 0 };
-  }
+import {
+  StoreStorageKey,
+  IStoreDataStorage
+} from "./store";
+import { BaseStore } from "./BaseStore";
+
+export default class InMemoryStore extends BaseStore {
+  private allStores: { [DataStoreStorageKey: string]: IStoreDataStorage } = {};
+
+  constructor() {
+    super();
+  }
+
+  /* eslint-disable class-methods-use-this */
+  close(): void {
+    // For the LocalStorage store this is a no-op.
+  }
+
+  get description(): string {
+    return 'in-memory-store'
+  }
+
+  protected async saveUser(): Promise<void> {
+    // For in-memory store, this is a no-op.
+  }
+
+  protected override async dumpStoreToStorage() {
+    const storageKey = `${StoreStorageKey}-${this._user.keyId}`;
+    this.allStores[storageKey] = {...this.store};
+  }
+
+  protected override async loadStoreFromStorage() {
+    const storageKey = `${StoreStorageKey}-${this._user.keyId}`;
+
+    this.store = this.allStores[storageKey] ?? { flags: {}, version: 0 };
+  }
 }

package/src/store/index.ts

@@ -1,6 +1,6 @@
-export * from './DataKinds';
-export * from './IDataSourceUpdates';
-export * from './InMemoryStore';
-export * from './serialization';
-export * from './store';
+export * from './DataKinds';
+export * from './IDataSourceUpdates';
+export * from './InMemoryStore';
+export * from './serialization';
+export * from './store';
 export * from './BaseStore';