@oliasoft-open-source/node-json-migrator 4.6.0-beta-2 → 5.0.0

package/dist/index.d.cts

@@ -1,165 +0,0 @@
-import { ITask, IDatabase, IHelpers } from 'pg-promise';
-
-/**
- * Generate a new entity migration
- */
-declare const createMigration: (directory: string, description: string, entity: string, enableMetaData?: boolean) => Promise<void>;
-
-type TPlanEntry = {
-    fileName: string;
-    fileHash: string;
-    sequence: string;
-};
-type TPlan = TPlanEntry[];
-type TPayload = Record<string, unknown>;
-type TMetaData = Record<string, unknown>;
-type TMigration = {
-    fileName?: string;
-    fileHash?: string;
-    sequence?: string;
-    isValidFileName?: boolean;
-    fileHashFromPlan?: string;
-    fileHashFromHistory?: string;
-    skippedFileHashes?: string[];
-    sequenceFromHistory?: string;
-    script?: string;
-    filePath?: string;
-    migrator?: (payload: TPayload, metaData?: TMetaData) => TPayload;
-};
-type TRecordDetails = {
-    id: number | string;
-    name: string;
-    created: string | Date;
-    version: string;
-    currentPlan?: TPlan;
-};
-type TRecordDetailsList = TRecordDetails[];
-type TEntityColumnNames = {
-    id: string;
-    name: string;
-    payload: string;
-    etag?: string;
-    version: string;
-    created: string;
-};
-type TRecord<T extends TEntityColumnNames = TEntityColumnNames, TData = TPayload> = {
-    [K in T['id']]: number | string;
-} & {
-    [K in T['name']]: string;
-} & {
-    [K in T['payload']]: TData;
-} & (T['etag'] extends string ? {
-    [K in T['etag']]?: string;
-} : Record<never, never>) & {
-    [K in T['version']]: string;
-} & {
-    [K in T['created']]: string | Date;
-};
-type TConfig = {
-    directory: string;
-    database?: IDatabase<unknown>;
-    pgpHelpers?: IHelpers;
-    entity?: string;
-    entityTableName?: string;
-    entityColumnNames?: TEntityColumnNames;
-    version?: string;
-    printPendingFileNames?: boolean;
-    force?: boolean;
-    dry?: boolean;
-    importModule?: boolean;
-    autoInitializeTable?: boolean;
-};
-type TBeforeMigrateRecordPayload = {
-    currentRecord: TRecord;
-    transaction?: ITask<unknown>;
-    dry: boolean;
-};
-type TBeforeMigrateRecord = (params: TBeforeMigrateRecordPayload) => Promise<void>;
-type TAfterMigrateRecordPayload = {
-    currentRecord: TRecord;
-    nextRecord: TRecord;
-    transaction?: ITask<unknown>;
-    dry: boolean;
-};
-type TAfterMigrateRecord = (params: TAfterMigrateRecordPayload) => Promise<void>;
-type TMigrationErrorPayload = {
-    id: string;
-    name: string;
-    created: string | Date;
-    error: unknown;
-    stackTrace?: string;
-};
-type TOnMigrationErrorsPayload = {
-    migrationErrors: TMigrationErrorPayload[];
-    dry: boolean;
-};
-type TOnMigrationErrors = (params: TOnMigrationErrorsPayload) => Promise<void>;
-
-declare const getPlannedMigrations: ({ config }: {
-    config: TConfig;
-}) => Promise<{
-    validatedPlan: {
-        fileHash: string;
-        fileName: string;
-        sequence: string;
-    }[];
-    plannedMigrations: TMigration[] & {
-        fileHash: string;
-        migrator: (...args: unknown[]) => unknown;
-    }[];
-    nextVersion: string;
-}>;
-
-declare const getPlannedVersion: ({ config }: {
-    config: any;
-}) => Promise<string>;
-
-/**
- * Migrates a payload
- *
- * There are two ways to use this function:
- * i) function looks up the pending migrations for you (default)
- * ii) pass in pre-fetched pending migrators via config.pending
- */
-declare const migrate: ({ payload, config, metaData, }: {
-    payload: TPayload;
-    config: TConfig;
-    metaData?: TMetaData;
-}) => Promise<{
-    nextPayload: TPayload;
-    nextVersion: string;
-}>;
-
-/**
- * Migrate all records (only use via command line interface)
- */
-declare const migrateAll: ({ config, beforeMigrateRecord, afterMigrateRecord, onMigrationErrors, }: {
-    config: TConfig;
-    beforeMigrateRecord: TBeforeMigrateRecord;
-    afterMigrateRecord: TAfterMigrateRecord;
-    onMigrationErrors: TOnMigrationErrors;
-}) => Promise<void>;
-
-/**
- * Executes the pending migrators on a payload, returns modified payload
- *
- * Loosely based on:
- *  - Eric Elliott's pipe implementation https://medium.com/javascript-scene/reduce-composing-software-fe22f0c39a1d
- *  - lodash flow https://lodash.com/docs/4.17.15#flow
- *
- * Implementation includes exception handling to extend errors with the filename
- * until native dynamic imports fix their stack trace handling (see OW-8879)
- */
-declare const pipe: (migrations: TMigration[], payload: TPayload, metaData?: TMetaData) => TPayload;
-
-declare const getVersions: (db: IDatabase<unknown>, entity: string) => Promise<any[]>;
-
-/**
- * Prints the version history of plan.json (for debugging)
- */
-declare const printVersionHistory: ({ config }: {
-    config: TConfig;
-}) => Promise<void>;
-
-export { createMigration, getPlannedMigrations, getPlannedVersion, getVersions, migrate, migrateAll, pipe, printVersionHistory };
-export type { TAfterMigrateRecord, TAfterMigrateRecordPayload, TBeforeMigrateRecord, TBeforeMigrateRecordPayload, TConfig, TEntityColumnNames, TMetaData, TMigration, TMigrationErrorPayload, TOnMigrationErrors, TOnMigrationErrorsPayload, TPayload, TPlan, TPlanEntry, TRecord, TRecordDetails, TRecordDetailsList };