@decaf-ts/core 0.5.47 → 0.6.0

package/lib/persistence/index.d.ts

@@ -2,6 +2,7 @@ export * from "./Dispatch";
 export * from "./constants";
 export * from "./decorators";
 export * from "./errors";
+export * from "./migrations";
 export * from "./ObserverHandler";
 export * from "./Sequence";
 export * from "./types";

package/lib/persistence/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/persistence/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2BAA2B;AAC3B,iDAA2B;AAE3B,kDAA4B;AAC5B,mDAA6B;AAC7B,+CAAyB;AACzB,wDAAkC;AAClC,iDAA2B;AAC3B,8CAAwB;AACxB,gDAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/persistence/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2BAA2B;AAC3B,iDAA2B;AAE3B,kDAA4B;AAC5B,mDAA6B;AAC7B,+CAAyB;AACzB,mDAA6B;AAC7B,wDAAkC;AAClC,iDAA2B;AAC3B,8CAAwB;AACxB,gDAA0B"}

package/lib/persistence/migrations.cjs

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbsMigration = void 0;
+exports.prefixMethod = prefixMethod;
+exports.migration = migration;
+const Adapter_1 = require("./Adapter.cjs");
+const db_decorators_1 = require("@decaf-ts/db-decorators");
+const logging_1 = require("@decaf-ts/logging");
+const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+const constants_1 = require("./constants.cjs");
+const decoration_1 = require("@decaf-ts/decoration");
+const errors_1 = require("./errors.cjs");
+function prefixMethod(obj, after, prefix, afterName) {
+    async function wrapper(...args) {
+        let results;
+        try {
+            results = await Promise.resolve(prefix.call(this, ...args));
+        }
+        catch (e) {
+            if (e instanceof errors_1.MigrationRuleError)
+                return;
+            throw e;
+        }
+        return Promise.resolve(after.apply(this, results));
+    }
+    const wrapped = wrapper.bind(obj);
+    const name = afterName ? afterName : after.name;
+    Object.defineProperty(wrapped, "name", {
+        enumerable: true,
+        configurable: true,
+        writable: false,
+        value: name,
+    });
+    obj[name] = wrapped;
+}
+class AbsMigration extends logging_1.LoggedClass {
+    constructor() {
+        super();
+        this.transaction = true;
+        [this.up, this.down].forEach((m) => {
+            const name = m.name;
+            prefixMethod(this, m, this.prefix(name));
+        });
+    }
+    get adapter() {
+        const meta = decoration_1.Metadata.get(this.constructor, constants_1.PersistenceKeys.MIGRATION);
+        if (!meta)
+            throw new db_decorators_1.InternalError(`No migration metadata for ${this.constructor.name}`);
+        const flavour = meta.flavour;
+        return Adapter_1.Adapter.get(flavour);
+    }
+    async enforceRules(qr, adapter, l) {
+        const rules = decoration_1.Metadata.get(this.constructor, constants_1.PersistenceKeys.MIGRATION)?.rules;
+        if (!rules || !rules.length)
+            return true;
+        let log;
+        for (const rule of rules) {
+            log = l.for(rule);
+            const result = await rule(qr, adapter, log);
+            if (!result)
+                return false;
+        }
+        return true;
+    }
+    prefix(name) {
+        return async function preffix(qrOrAdapter) {
+            let qr;
+            if (qrOrAdapter instanceof Adapter_1.Adapter) {
+                qr = this.getQueryRunner(qrOrAdapter.client);
+            }
+            else {
+                qr = qrOrAdapter;
+                qrOrAdapter = this.adapter;
+            }
+            const log = this.log.for(name);
+            const allowed = await this.enforceRules(qr, qrOrAdapter, log);
+            if (!allowed) {
+                log.verbose(`Skipping migration ${this.constructor.name} due to rules`);
+                throw new errors_1.MigrationRuleError("Migration skipped for rule enforcement");
+            }
+            return [qr, qrOrAdapter, log];
+        }.bind(this);
+    }
+}
+exports.AbsMigration = AbsMigration;
+function migration(flavour, rules) {
+    function innerMigration(flavour, rules) {
+        return function (original) {
+            const current = decoration_1.Metadata["innerGet"](Symbol.for(constants_1.PersistenceKeys.MIGRATION), flavour) ||
+                [];
+            decoration_1.Metadata.set(constants_1.PersistenceKeys.MIGRATION, flavour, [
+                ...current,
+                {
+                    class: original,
+                },
+            ]);
+            return (0, decoration_1.metadata)(constants_1.PersistenceKeys.MIGRATION, {
+                flavour: flavour,
+                rules: rules,
+            })(original);
+        };
+    }
+    return decorator_validation_1.Decoration.for(constants_1.PersistenceKeys.MIGRATION)
+        .define({
+        decorator: innerMigration,
+        args: [flavour, rules],
+    })
+        .apply();
+}
+//# sourceMappingURL=migrations.js.map

package/lib/persistence/migrations.d.ts

@@ -0,0 +1,21 @@
+import { Migration } from "./types";
+import { Adapter } from "./Adapter";
+import { Context, RepositoryFlags } from "@decaf-ts/db-decorators";
+import { LoggedClass, Logger } from "@decaf-ts/logging";
+export declare function prefixMethod(obj: any, after: (...args: any[]) => any, prefix: (...args: any[]) => any, afterName?: string): void;
+export declare abstract class AbsMigration<A extends Adapter<CONF, CONN, QUERY, FLAGS, CONTEXT>, CONF, CONN, QUERY, QUERYRUNNER = CONN, FLAGS extends RepositoryFlags = RepositoryFlags, CONTEXT extends Context<FLAGS> = Context<FLAGS>> extends LoggedClass implements Migration<QUERYRUNNER, A, CONF, CONN, QUERY, FLAGS, CONTEXT> {
+    transaction: boolean;
+    protected constructor();
+    protected get adapter(): A;
+    protected abstract getQueryRunner(conn: CONN): QUERYRUNNER;
+    private enforceRules;
+    private prefix;
+    abstract down(qr: QUERYRUNNER, adapter: A, log: Logger): Promise<void>;
+    abstract up(qr: QUERYRUNNER, adapter: A, log: Logger): Promise<void>;
+}
+export type MigrationRule<A extends Adapter<CONF, CONN, QUERY, FLAGS, CONTEXT> = any, CONF = any, CONN = any, QUERY = any, QUERYRUNNER = CONN, FLAGS extends RepositoryFlags = RepositoryFlags, CONTEXT extends Context<FLAGS> = Context<FLAGS>> = (qr: QUERYRUNNER, adapter: A, log: Logger) => Promise<boolean>;
+export type MigrationMetadata = {
+    flavour: string;
+    rules?: MigrationRule[];
+};
+export declare function migration(flavour: string, rules?: MigrationRule[]): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;

package/lib/persistence/migrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/persistence/migrations.ts"],"names":[],"mappings":";;;AAaA,oCA0BC;AAwGD,8BAyBC;AAvKD,2CAAoC;AACpC,2DAIiC;AACjC,+CAAwD;AACxD,yEAA4D;AAC5D,+CAA8C;AAC9C,qDAA0D;AAC1D,yCAA8C;AAE9C,SAAgB,YAAY,CAC1B,GAAQ,EACR,KAA8B,EAC9B,MAA+B,EAC/B,SAAkB;IAElB,KAAK,UAAU,OAAO,CAAY,GAAG,IAAW;QAC9C,IAAI,OAAc,CAAC;QACnB,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,IAAI,CAAC,YAAY,2BAAkB;gBAAE,OAAO;YAC5C,MAAM,CAAC,CAAC;QACV,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;IAChD,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE;QACrC,UAAU,EAAE,IAAI;QAChB,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,IAAI;KACZ,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;AACtB,CAAC;AAED,MAAsB,YASpB,SAAQ,qBAAW;IAKnB;QACE,KAAK,EAAE,CAAC;QAHV,gBAAW,GAAG,IAAI,CAAC;QAIjB,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACjC,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;YACpB,YAAY,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAc,OAAO;QACnB,MAAM,IAAI,GAAG,qBAAQ,CAAC,GAAG,CACvB,IAAI,CAAC,WAAkB,EACvB,2BAAe,CAAC,SAAS,CAC1B,CAAC;QACF,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,6BAAa,CACrB,6BAA6B,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CACrD,CAAC;QACJ,MAAM,OAAO,GAAW,IAAI,CAAC,OAAO,CAAC;QACrC,OAAO,iBAAO,CAAC,GAAG,CAAC,OAAO,CAAM,CAAC;IACnC,CAAC;IAIO,KAAK,CAAC,YAAY,CAAC,EAAe,EAAE,OAAU,EAAE,CAAS;QAC/D,MAAM,KAAK,GAQL,qBAAQ,CAAC,GAAG,CAChB,IAAI,CAAC,WAAkB,EACvB,2BAAe,CAAC,SAAS,CAC1B,EAAE,KAAK,CAAC;QACT,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QACzC,IAAI,GAAW,CAAC;QAChB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;QAC5B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,IAAY;QACzB,OAAO,KAAK,UAAU,OAAO,CAE3B,WAA4B;YAE5B,IAAI,EAAe,CAAC;YACpB,IAAI,WAAW,YAAY,iBAAO,EAAE,CAAC;gBACnC,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAC/C,CAAC;iBAAM,CAAC;gBACN,EAAE,GAAG,WAAW,CAAC;gBACjB,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC;YAC7B,CAAC;YACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,WAAgB,EAAE,GAAG,CAAC,CAAC;YACnE,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,GAAG,CAAC,OAAO,CAAC,sBAAsB,IAAI,CAAC,WAAW,CAAC,IAAI,eAAe,CAAC,CAAC;gBACxE,MAAM,IAAI,2BAAkB,CAAC,wCAAwC,CAAC,CAAC;YACzE,CAAC;YACD,OAAO,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;QAChC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;CAKF;AArFD,oCAqFC;AAiBD,SAAgB,SAAS,CAAC,OAAe,EAAE,KAAuB;IAChE,SAAS,cAAc,CAAC,OAAe,EAAE,KAAuB;QAC9D,OAAO,UAAU,QAAgB;YAC/B,MAAM,OAAO,GACX,qBAAQ,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,2BAAe,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;gBACpE,EAAE,CAAC;YACL,qBAAQ,CAAC,GAAG,CAAC,2BAAe,CAAC,SAAS,EAAE,OAAO,EAAE;gBAC/C,GAAG,OAAO;gBACV;oBACE,KAAK,EAAE,QAAQ;iBAChB;aACF,CAAC,CAAC;YACH,OAAO,IAAA,qBAAQ,EAAC,2BAAe,CAAC,SAAS,EAAE;gBACzC,OAAO,EAAE,OAAO;gBAChB,KAAK,EAAE,KAAK;aACb,CAAC,CAAC,QAAQ,CAAC,CAAC;QACf,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,iCAAU,CAAC,GAAG,CAAC,2BAAe,CAAC,SAAS,CAAC;SAC7C,MAAM,CAAC;QACN,SAAS,EAAE,cAAc;QACzB,IAAI,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC;KACvB,CAAC;SACD,KAAK,EAAE,CAAC;AACb,CAAC"}

package/lib/persistence/types.d.ts

@@ -1,6 +1,7 @@
-import { BulkCrudOperationKeys, OperationKeys } from "@decaf-ts/db-decorators";
+import { BulkCrudOperationKeys, Context, OperationKeys, RepositoryFlags } from "@decaf-ts/db-decorators";
 import { Adapter } from "./Adapter";
 import { Observable } from "../interfaces/index";
+import { Logger } from "@decaf-ts/logging";
 /**
  * @description Type representing possible ID formats for database events
  * @summary A union type that defines the possible formats for event identifiers in the persistence layer.
@@ -26,3 +27,8 @@ export interface AdapterDispatch extends Observable {
     close(): Promise<void>;
     updateObservers(table: string, event: OperationKeys | BulkCrudOperationKeys | string, id: EventIds): Promise<void>;
 }
+export interface Migration<QUERYRUNNER, A extends Adapter<CONF, CONN, QUERY, FLAGS, CONTEXT>, CONF, CONN, QUERY, FLAGS extends RepositoryFlags = RepositoryFlags, CONTEXT extends Context<FLAGS> = Context<FLAGS>> {
+    transaction: boolean;
+    up(qr: QUERYRUNNER, adapter?: A, log?: Logger): Promise<void>;
+    down(qr: QUERYRUNNER, adapter?: A, log?: Logger): Promise<void>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/core",
-  "version": "0.5.47",
+  "version": "0.6.0",
   "description": "Core persistence module for the decaf framework",
   "type": "module",
   "exports": {