@uniformdev/cli 18.19.0 → 18.20.0

package/dist/sync/index.d.ts

@@ -1,118 +0,0 @@
-import { Change } from 'diff';
-import { Argv } from 'yargs';
-
-type SyncEngineLogOptions = {
-    id: string;
-    providerId: string;
-    displayName: string;
-    action: 'create' | 'update' | 'delete';
-    whatIf: boolean;
-    diff: Change[];
-};
-type SyncEngineObject<TObject> = {
-    /** Unique ID that is identical across all providers */
-    id: string;
-    /** Provider specific ID. Value is provided to deleteObject() function (always the provider ID from the same provider that issued it). */
-    providerId: string;
-    /** Optional display name of the object for log messages. The providerId will be used if this is not set. */
-    displayName?: string;
-    /** The object being synced. */
-    object: TObject;
-};
-type SyncEngineDataSource<TObject> = {
-    /** The objects to sync. */
-    objects: AsyncIterable<SyncEngineObject<TObject>>;
-    /**
-     * Called when the sync engine detects a need to update a synced object.
-     * Only called if this source is the target of a sync operation.
-     * @param obj The object to write to the data source
-     * @param existingObj The existing object that matches this one in the data source (if any)
-     */
-    writeObject: (obj: SyncEngineObject<TObject>, existingObj?: SyncEngineObject<TObject>) => Promise<void>;
-    /**
-     * Called when the sync engine detects a need to delete an object in this data source.
-     * Only called if this source is the target of a sync operation.
-     */
-    deleteObject: (providerId: string, obj: SyncEngineObject<TObject>) => Promise<void>;
-    /**
-     * Called when the sync engine finishes synchronization.
-     */
-    onSyncComplete?: (isTarget: boolean) => Promise<void>;
-};
-type SyncEngineOptions<TObject> = {
-    source: SyncEngineDataSource<TObject>;
-    target: SyncEngineDataSource<TObject>;
-    compareContents?: (source: SyncEngineObject<TObject>, target: SyncEngineObject<TObject>) => boolean;
-    mode: 'mirror' | 'createOrUpdate' | 'create';
-    /** Compare sources, but do not execute actions */
-    whatIf?: boolean;
-    /** An exception will normally br thrown if the sync source has nothing in it; this option allows the sync to continue (potentially deleting everything in the target) */
-    allowEmptySource?: boolean;
-    log?: (options: SyncEngineLogOptions) => void;
-};
-declare function syncEngine<TObject>({ source, target, compareContents, mode, allowEmptySource, whatIf, log, }: SyncEngineOptions<TObject>): Promise<void>;
-declare class SyncEngineError<TObject> extends Error {
-    constructor(innerError: unknown, sourceObject: SyncEngineObject<TObject>);
-}
-
-type CreateArraySyncEngineDataSourceOptions<TObject> = {
-    objects: Array<TObject>;
-    selectIdentifier: (object: TObject) => string;
-    selectDisplayName?: (object: TObject) => string;
-    onSyncComplete?: (isTarget: boolean, result: Array<TObject>) => Promise<void>;
-};
-declare function createArraySyncEngineDataSource<TObject>({ objects, selectIdentifier, selectDisplayName, onSyncComplete, }: CreateArraySyncEngineDataSourceOptions<TObject>): Promise<SyncEngineDataSource<TObject> & {
-    extractCurrent: () => Array<TObject>;
-}>;
-
-type CreateFileSyncEngineDataSourceOptions<TObject> = {
-    directory: string;
-    selectIdentifier: (object: TObject) => string;
-    selectDisplayName?: (object: TObject) => string;
-    selectFilename?: (object: TObject) => string;
-    format?: 'json' | 'yaml';
-};
-declare function createFileSyncEngineDataSource<TObject>({ directory, format, selectIdentifier, selectDisplayName, selectFilename, }: CreateFileSyncEngineDataSourceOptions<TObject>): Promise<SyncEngineDataSource<TObject>>;
-
-type UniformPackage = {
-    [key: string]: unknown;
-};
-declare function readUniformPackage(filename: string, assertExists: boolean): UniformPackage;
-declare function writeUniformPackage(filename: string, packageContents: UniformPackage): void;
-
-type DiffMode = 'off' | 'on' | 'update';
-declare function createSyncEngineConsoleLogger(options?: {
-    diffMode?: DiffMode;
-    indent?: string;
-    prefix?: string;
-}): ({ action, displayName, whatIf, diff }: SyncEngineLogOptions) => void;
-
-type ApiArgs = {
-    apiKey: string;
-    apiHost: string;
-    edgeApiHost: string;
-    proxy?: string;
-};
-declare function withApiOptions<T>(yargs: Argv<T>): Argv<T>;
-declare function nodeFetchProxy(proxy: string | undefined): typeof fetch;
-type ProjectArgs = {
-    project: string;
-};
-declare function withProjectOptions<T>(yargs: Argv<T>): Argv<T>;
-type FormatArgs = {
-    format: 'json' | 'yaml';
-    filename?: string;
-};
-declare function withFormatOptions<T>(yargs: Argv<T>): Argv<T>;
-type DiffArgs = {
-    diff: DiffMode;
-};
-declare function withDiffOptions<T>(yargs: Argv<T>): Argv<T>;
-declare function isPathAPackageFile(path: string): boolean;
-declare function emitWithFormat(object: any, format?: string, filename?: string): void;
-declare function readFileToObject<T = unknown>(filename: string): T;
-declare function paginateAsync<TResult>(fetchPage: (offset: number, limit: number) => Promise<TResult[]>, options: {
-    pageSize: number;
-}): AsyncIterableIterator<TResult>;
-
-export { ApiArgs, CreateArraySyncEngineDataSourceOptions, CreateFileSyncEngineDataSourceOptions, DiffArgs, DiffMode, FormatArgs, ProjectArgs, SyncEngineDataSource, SyncEngineError, SyncEngineLogOptions, SyncEngineObject, SyncEngineOptions, UniformPackage, createArraySyncEngineDataSource, createFileSyncEngineDataSource, createSyncEngineConsoleLogger, emitWithFormat, isPathAPackageFile, nodeFetchProxy, paginateAsync, readFileToObject, readUniformPackage, syncEngine, withApiOptions, withDiffOptions, withFormatOptions, withProjectOptions, writeUniformPackage };