@splitsoftware/splitio-commons 1.2.0 → 1.2.1-rc.0

package/types/sync/streaming/pushManagerNoUsers.d.ts

@@ -0,0 +1,13 @@
+import { IPushManagerCS } from './types';
+import { IStorageSync } from '../../storages/types';
+import { IReadinessManager } from '../../readiness/types';
+import { IPollingManager } from '../polling/types';
+import { IFetchAuthV2 } from '../../services/types';
+import { ISettings } from '../../types';
+import { IPlatform } from '../../sdkFactory/types';
+/**
+ * PushManager factory:
+ * - for server-side if key is not provided in settings.
+ * - for client-side, with support for multiple clients, if key is provided in settings
+ */
+export default function pushManagerFactory(pollingManager: IPollingManager, storage: IStorageSync, readiness: IReadinessManager, fetchAuthV2: IFetchAuthV2, platform: IPlatform, settings: ISettings): IPushManagerCS | undefined;

package/types/sync/streaming/pushManagerSS.d.ts

@@ -0,0 +1,11 @@
+import { IPushManager } from './types';
+import { IStorageSync } from '../../storages/types';
+import { IPollingManager } from '../polling/types';
+import { IReadinessManager } from '../../readiness/types';
+import { IFetchAuth } from '../../services/types';
+import { ISettings } from '../../types';
+import { IPlatform } from '../../sdkFactory/types';
+/**
+ * PushManager factory for server-side
+ */
+export default function pushManagerSSFactory(pollingManager: IPollingManager, storage: IStorageSync, readiness: IReadinessManager, fetchAuth: IFetchAuth, platform: IPlatform, settings: ISettings): IPushManager | undefined;

package/types/sync/submitters/telemetrySyncTask.d.ts

@@ -0,0 +1,17 @@
+import { ISyncTask, ITimeTracker } from '../types';
+import { IPostMetricsUsage } from '../../services/types';
+import { IStorageSync, TelemetryCacheSync } from '../../storages/types';
+import { TelemetryStatsPayload } from './types';
+import { ILogger } from '../../logger/types';
+/**
+ * Converts `impressions` data from cache into request payload.
+ */
+export declare function telemetryCacheAdapter(telemetryCache: TelemetryCacheSync, storage: IStorageSync): {
+    isEmpty(): boolean;
+    clear(): void;
+    state(): TelemetryStatsPayload;
+};
+/**
+ * Sync task that periodically posts impressions data
+ */
+export declare function telemetrySyncTaskFactory(log: ILogger, postMetricsUsage: IPostMetricsUsage, telemetryCache: TelemetryCacheSync, telemetryRefreshRate: number, latencyTracker: ITimeTracker, storage: IStorageSync): ISyncTask;

package/types/sync/syncManagerFromFile.d.ts

@@ -0,0 +1,2 @@
+import { SplitIO } from '../types';
+export declare function LocalhostFromFile(): SplitIO.LocalhostFactory;

package/types/sync/syncManagerFromObject.d.ts

@@ -0,0 +1,2 @@
+import { SplitIO } from '../types';
+export declare function LocalhostFromObject(): SplitIO.LocalhostFactory;

package/types/sync/syncManagerOffline.d.ts

@@ -0,0 +1,9 @@
+import { ISyncManagerCS, ISyncManagerFactoryParams } from './types';
+import { ISplitsParser } from './offline/splitsParser/types';
+/**
+ * Offline SyncManager factory.
+ * Can be used for server-side API, and client-side API with or without multiple clients.
+ *
+ * @param splitsParser e.g., `splitsParserFromFile`, `splitsParserFromSettings`.
+ */
+export declare function syncManagerOfflineFactory(splitsParserFactory: () => ISplitsParser): (params: ISyncManagerFactoryParams) => ISyncManagerCS;

package/types/types.d.ts

@@ -375,6 +375,7 @@ interface IBasicClient extends IStatusInterface {
      * @returns {Promise<void>}
      */
     destroy(): Promise<void>;
+    isBrowserClient: boolean;
 }
 /**
  * Common definitions between SDK instances for different environments interface.

package/types/utils/EventEmitter.d.ts

@@ -0,0 +1,4 @@
+import { IEventEmitter } from '../types';
+export declare const EventEmitter: {
+    new (): IEventEmitter;
+};

package/types/utils/lang/errors.d.ts

@@ -0,0 +1,10 @@
+export declare class SplitError extends Error {
+    constructor(msg?: string);
+}
+export declare class SplitTimeoutError extends SplitError {
+    constructor(msg?: string);
+}
+export declare class SplitNetworkError extends SplitError {
+    statusCode?: number;
+    constructor(msg?: string, code?: number);
+}

package/types/utils/murmur3/commons.d.ts

@@ -0,0 +1,12 @@
+export declare function UTF16ToUTF8(key: string): string | undefined;
+/*!
+ * +----------------------------------------------------------------------------------+
+ * | murmurHash3.js v3.0.0 (http://github.com/karanlyons/murmurHash3.js)              |
+ * | A TypeScript/JavaScript implementation of MurmurHash3's hashing algorithms.      |
+ * |----------------------------------------------------------------------------------|
+ * | Copyright (c) 2012-2020 Karan Lyons. Freely distributable under the MIT license. |
+ * +----------------------------------------------------------------------------------+
+ */
+export declare function x86Multiply(m: number, n: number): number;
+export declare function x86Rotl(m: number, n: number): number;
+export declare function x86Fmix(h: number): number;

package/types/utils/murmur3/legacy.d.ts

@@ -0,0 +1,2 @@
+export declare function hash(str: string, seed: number): number;
+export declare function bucket(str: string, seed: number): number;

package/types/utils/settingsValidation/buildMetadata.d.ts

@@ -0,0 +1,3 @@
+import { IMetadata } from '../../dtos/types';
+import { ISettings } from '../../types';
+export default function buildMetadata(settings: ISettings): IMetadata;

package/types/utils/settingsValidation/localhost/index.d.ts

@@ -0,0 +1,9 @@
+import { ISettings } from '../../../types';
+/**
+ * This function validates `settings.storage` object
+ *
+ * @param {any} settings config object provided by the user to initialize the sdk
+ *
+ * @returns {Object} valid storage factory. It might be the default `InMemoryStorageCSFactory` if the provided storage is invalid.
+ */
+export declare function validateLocalhost(settings: ISettings): import("../../../types").SplitIO.LocalhostFactory | undefined;

package/types/utils/settingsValidation/logger.d.ts

@@ -0,0 +1,11 @@
+import { ILogger } from '../../logger/types';
+/**
+ * Validates the `log` (logger) property at config.
+ *
+ * @param settings user config object
+ * @returns the provided logger or a no-op logger if no one is provided
+ * @throws throws an error if a logger was provided but is invalid
+ */
+export default function logger(settings: {
+    log: unknown;
+}): ILogger;