@oliasoft-open-source/node-json-migrator 2.3.10 → 3.0.0-beta-1

package/dist/index.d.cts

@@ -0,0 +1,81 @@
+import { IDatabase, IHelpers } from 'pg-promise';
+
+/**
+ * Generate a new dataset migration
+ */
+declare const createMigration: (directory: string, description: string) => Promise<void>;
+
+type TMigration = {
+    fileName?: string;
+    fileHash?: string;
+    sequence?: string;
+    isValidFileName?: boolean;
+    fileHashFromPlan?: string;
+    fileHashFromHistory?: string;
+    skippedFileHashes?: string[];
+    sequenceFromHistory?: string;
+    script?: string;
+    migrator?: (payload: unknown) => unknown;
+};
+type TConfig = {
+    directory: string;
+    database?: IDatabase<unknown>;
+    pgpHelpers?: IHelpers;
+    entity?: string;
+    version?: string;
+    printPendingFileNames?: boolean;
+    force?: boolean;
+    dry?: boolean;
+    importModule?: boolean;
+    autoInitializeTable?: boolean;
+};
+
+declare const getPlannedMigrations: ({ config }: {
+    config: TConfig;
+}) => Promise<{
+    plannedMigrations: TMigration[] & any[];
+    nextVersion: string;
+}>;
+
+declare const getPlannedVersion: ({ config }: {
+    config: any;
+}) => Promise<any>;
+
+/**
+ * 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, }: {
+    payload: unknown;
+    config: TConfig;
+}) => Promise<{
+    nextPayload: unknown;
+    nextVersion: string;
+}>;
+
+/**
+ * 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 module-with-string fixes its stack trace handling (see OW-8879 and
+ * https://github.com/exuanbo/module-from-string/issues/18)
+ */
+declare const pipe: (migrations: TMigration[], payload: unknown) => unknown;
+
+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, pipe, printVersionHistory };

package/dist/index.d.mts

@@ -0,0 +1,81 @@
+import { IDatabase, IHelpers } from 'pg-promise';
+
+/**
+ * Generate a new dataset migration
+ */
+declare const createMigration: (directory: string, description: string) => Promise<void>;
+
+type TMigration = {
+    fileName?: string;
+    fileHash?: string;
+    sequence?: string;
+    isValidFileName?: boolean;
+    fileHashFromPlan?: string;
+    fileHashFromHistory?: string;
+    skippedFileHashes?: string[];
+    sequenceFromHistory?: string;
+    script?: string;
+    migrator?: (payload: unknown) => unknown;
+};
+type TConfig = {
+    directory: string;
+    database?: IDatabase<unknown>;
+    pgpHelpers?: IHelpers;
+    entity?: string;
+    version?: string;
+    printPendingFileNames?: boolean;
+    force?: boolean;
+    dry?: boolean;
+    importModule?: boolean;
+    autoInitializeTable?: boolean;
+};
+
+declare const getPlannedMigrations: ({ config }: {
+    config: TConfig;
+}) => Promise<{
+    plannedMigrations: TMigration[] & any[];
+    nextVersion: string;
+}>;
+
+declare const getPlannedVersion: ({ config }: {
+    config: any;
+}) => Promise<any>;
+
+/**
+ * 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, }: {
+    payload: unknown;
+    config: TConfig;
+}) => Promise<{
+    nextPayload: unknown;
+    nextVersion: string;
+}>;
+
+/**
+ * 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 module-with-string fixes its stack trace handling (see OW-8879 and
+ * https://github.com/exuanbo/module-from-string/issues/18)
+ */
+declare const pipe: (migrations: TMigration[], payload: unknown) => unknown;
+
+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, pipe, printVersionHistory };