@acmekit/modules-sdk 2.13.1

package/dist/acmekit-module.d.ts

@@ -0,0 +1,149 @@
+import { InternalModuleDeclaration, LinkModuleDefinition, LoadedModule, AcmeKitContainer, ModuleBootstrapDeclaration, ModuleDefinition, ModuleExports, ModuleJoinerConfig, ModuleResolution } from "@acmekit/types";
+declare global {
+    interface AcmeKitModule {
+        getLoadedModules(aliases?: Map<string, string>): {
+            [key: string]: LoadedModule;
+        }[];
+        getModuleInstance(moduleKey: string, alias?: string): LoadedModule;
+    }
+}
+export type MigrationOptions = {
+    moduleKey: string;
+    modulePath: string;
+    container?: AcmeKitContainer;
+    options?: Record<string, any>;
+    moduleExports?: ModuleExports;
+    cwd?: string;
+};
+export type ModuleBootstrapOptions = {
+    moduleKey: string;
+    defaultPath: string;
+    declaration?: ModuleBootstrapDeclaration;
+    moduleExports?: ModuleExports;
+    sharedContainer?: AcmeKitContainer;
+    moduleDefinition?: ModuleDefinition;
+    injectedDependencies?: Record<string, any>;
+    /**
+     * In this mode, all instances are partially loaded, meaning that the module will not be fully loaded and the services will not be available.
+     * Don't forget to clear the instances (AcmeKitModule.clearInstances()) after the migration are done.
+     */
+    migrationOnly?: boolean;
+    /**
+     * Forces the modules bootstrapper to only run the modules loaders and return prematurely. This
+     * is meant for modules that have data loader. In a test env, in order to clear all data
+     * and load them back, we need to run those loader again
+     */
+    loaderOnly?: boolean;
+    workerMode?: "shared" | "worker" | "server";
+    cwd?: string;
+};
+export type LinkModuleBootstrapOptions = {
+    definition: LinkModuleDefinition;
+    declaration?: InternalModuleDeclaration;
+    moduleExports?: ModuleExports;
+    injectedDependencies?: Record<string, any>;
+    cwd?: string;
+    migrationOnly?: boolean;
+    schemaOnly?: boolean;
+};
+export type RegisterModuleJoinerConfig = ModuleJoinerConfig | ((modules: ModuleJoinerConfig[]) => ModuleJoinerConfig);
+declare class AcmeKitModule {
+    private static instances_;
+    private static modules_;
+    private static customLinks_;
+    private static loading_;
+    private static joinerConfig_;
+    private static moduleResolutions_;
+    static getLoadedModules(aliases?: Map<string, string>): {
+        [key: string]: LoadedModule;
+    }[];
+    static onApplicationStart(onApplicationStartCb?: () => void): void;
+    static onApplicationShutdown(): Promise<void>;
+    static onApplicationPrepareShutdown(): Promise<void>;
+    static clearInstances(): void;
+    static isInstalled(moduleKey: string, alias?: string): boolean;
+    static getJoinerConfig(moduleKey: string): ModuleJoinerConfig;
+    static getAllJoinerConfigs(): ModuleJoinerConfig[];
+    static getModuleResolutions(moduleKey: string): ModuleResolution;
+    static getAllModuleResolutions(): ModuleResolution[];
+    static unregisterModuleResolution(moduleKey: string): void;
+    static setModuleResolution(moduleKey: string, resolution: ModuleResolution): ModuleResolution;
+    static setJoinerConfig(moduleKey: string, config: ModuleJoinerConfig): ModuleJoinerConfig;
+    static setCustomLink(config: RegisterModuleJoinerConfig): void;
+    static getCustomLinks(): RegisterModuleJoinerConfig[];
+    static getModuleInstance(moduleKey: string, alias?: string): any | undefined;
+    private static registerModule;
+    /**
+     * Load all modules and resolve them once they are loaded
+     * @param modulesOptions
+     * @param migrationOnly
+     * @param loaderOnly
+     * @param workerMode
+     */
+    static bootstrapAll(modulesOptions: Omit<ModuleBootstrapOptions, "migrationOnly" | "loaderOnly" | "workerMode" | "schemaOnly">[], { migrationOnly, loaderOnly, workerMode, schemaOnly, cwd, }: {
+        migrationOnly?: boolean;
+        loaderOnly?: boolean;
+        workerMode?: ModuleBootstrapOptions["workerMode"];
+        cwd?: string;
+        schemaOnly?: boolean;
+    }): Promise<{
+        [key: string]: any;
+    }[]>;
+    /**
+     * Load a single module and resolve it once it is loaded
+     * @param moduleKey
+     * @param defaultPath
+     * @param declaration
+     * @param moduleExports
+     * @param sharedContainer
+     * @param moduleDefinition
+     * @param injectedDependencies
+     * @param migrationOnly
+     * @param loaderOnly
+     * @param workerMode
+     */
+    static bootstrap<T>({ moduleKey, defaultPath, declaration, moduleExports, sharedContainer, moduleDefinition, injectedDependencies, migrationOnly, loaderOnly, workerMode, cwd, }: ModuleBootstrapOptions): Promise<{
+        [key: string]: T;
+    }>;
+    /**
+     * Load all modules and then resolve them once they are loaded
+     *
+     * @param modulesOptions
+     * @param migrationOnly
+     * @param loaderOnly
+     * @param workerMode
+     * @protected
+     */
+    protected static bootstrap_<T>(modulesOptions: Omit<ModuleBootstrapOptions, "migrationOnly" | "loaderOnly" | "workerMode" | "cwd" | "schemaOnly">[], { migrationOnly, loaderOnly, workerMode, cwd, schemaOnly, }: {
+        migrationOnly?: boolean;
+        loaderOnly?: boolean;
+        workerMode?: "shared" | "worker" | "server";
+        cwd?: string;
+        schemaOnly?: boolean;
+    }): Promise<{
+        [key: string]: T;
+    }[]>;
+    /**
+     * Resolve all the modules once they all have been loaded through the bootstrap
+     * and store their references in the instances_ map and return them
+     *
+     * @param hashKey
+     * @param modDeclaration
+     * @param moduleResolutions
+     * @param container
+     * @private
+     */
+    private static resolveLoadedModule;
+    static bootstrapLink({ definition, declaration, moduleExports, injectedDependencies, cwd, migrationOnly, schemaOnly, }: LinkModuleBootstrapOptions): Promise<{
+        [key: string]: unknown;
+    }>;
+    static migrateGenerate({ options, container, moduleExports, moduleKey, modulePath, cwd, }: MigrationOptions): Promise<void>;
+    static migrateUp({ options, container, moduleExports, moduleKey, modulePath, cwd, }: MigrationOptions): Promise<{
+        name: string;
+        path: string;
+    }[]>;
+    static migrateDown({ options, container, moduleExports, moduleKey, modulePath, cwd, }: MigrationOptions, migrationNames?: string[]): Promise<void>;
+}
+declare const GlobalAcmeKitModule: typeof AcmeKitModule;
+export { GlobalAcmeKitModule as AcmeKitModule };
+//# sourceMappingURL=acmekit-module.d.ts.map

package/dist/acmekit-module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"acmekit-module.d.ts","sourceRoot":"","sources":["../src/acmekit-module.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,yBAAyB,EACzB,oBAAoB,EACpB,YAAY,EACZ,gBAAgB,EAChB,0BAA0B,EAC1B,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,gBAAgB,CAAA;AAyBvB,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,aAAa;QACrB,gBAAgB,CACd,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAC5B;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;SAAE,EAAE,CAAA;QACpC,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,YAAY,CAAA;KACnE;CACF;AAUD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,gBAAgB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,0BAA0B,CAAA;IACxC,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,eAAe,CAAC,EAAE,gBAAgB,CAAA;IAClC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IACnC,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,UAAU,EAAE,oBAAoB,CAAA;IAChC,WAAW,CAAC,EAAE,yBAAyB,CAAA;IACvC,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1C,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,0BAA0B,GAClC,kBAAkB,GAClB,CAAC,CAAC,OAAO,EAAE,kBAAkB,EAAE,KAAK,kBAAkB,CAAC,CAAA;AAE3D,cAAM,aAAa;IACjB,OAAO,CAAC,MAAM,CAAC,UAAU,CACd;IACX,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAwC;IAC/D,OAAO,CAAC,MAAM,CAAC,YAAY,CAAmC;IAC9D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAuC;IAC9D,OAAO,CAAC,MAAM,CAAC,aAAa,CAA6C;IACzE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA2C;WAE9D,gBAAgB,CAC5B,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAC5B;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE,EAAE;WAUtB,kBAAkB,CAAC,oBAAoB,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;WAiBrD,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;WAiBtC,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;WAiBnD,cAAc,IAAI,IAAI;WAQtB,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO;WAWvD,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,kBAAkB;WAItD,mBAAmB,IAAI,kBAAkB,EAAE;WAI3C,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB;WAIzD,uBAAuB,IAAI,gBAAgB,EAAE;WAI7C,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;WAcnD,mBAAmB,CAC/B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,gBAAgB,GAC3B,gBAAgB;WAML,eAAe,CAC3B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kBAAkB,GACzB,kBAAkB;WAMP,aAAa,CAAC,MAAM,EAAE,0BAA0B,GAAG,IAAI;WAIvD,cAAc,IAAI,0BAA0B,EAAE;WAI9C,iBAAiB,CAC7B,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,GACb,GAAG,GAAG,SAAS;IAkBlB,OAAO,CAAC,MAAM,CAAC,cAAc;IA0B7B;;;;;;OAMG;WACiB,YAAY,CAC9B,cAAc,EAAE,IAAI,CAClB,sBAAsB,EACtB,eAAe,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,CAC7D,EAAE,EACH,EACE,aAAa,EACb,UAAU,EACV,UAAU,EACV,UAAU,EACV,GAAG,GACJ,EAAE;QACD,aAAa,CAAC,EAAE,OAAO,CAAA;QACvB,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,UAAU,CAAC,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAA;QACjD,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,GACA,OAAO,CACR;QACE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB,EAAE,CACJ;IAUD;;;;;;;;;;;;OAYG;WACiB,SAAS,CAAC,CAAC,EAAE,EAC/B,SAAS,EACT,WAAW,EACX,WAAW,EACX,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,UAAU,EACV,UAAU,EACV,GAAG,GACJ,EAAE,sBAAsB,GAAG,OAAO,CAAC;QAClC,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;KACjB,CAAC;IA0BF;;;;;;;;OAQG;qBACoB,UAAU,CAAC,CAAC,EACjC,cAAc,EAAE,IAAI,CAClB,sBAAsB,EACtB,eAAe,GAAG,YAAY,GAAG,YAAY,GAAG,KAAK,GAAG,YAAY,CACrE,EAAE,EACH,EACE,aAAa,EACb,UAAU,EACV,UAAU,EACV,GAAmB,EACnB,UAAU,GACX,EAAE;QACD,aAAa,CAAC,EAAE,OAAO,CAAA;QACvB,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAC3C,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,GACA,OAAO,CACR;QACE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;KACjB,EAAE,CACJ;IAuJD;;;;;;;;;OASG;mBACkB,mBAAmB;WA8EpB,aAAa,CAAC,EAChC,UAAU,EACV,WAAW,EACX,aAAa,EACb,oBAAoB,EACpB,GAAG,EACH,aAAa,EACb,UAAU,GACX,EAAE,0BAA0B,GAAG,OAAO,CAAC;QACtC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KACvB,CAAC;WA+HkB,eAAe,CAAC,EAClC,OAAO,EACP,SAAS,EACT,aAAa,EACb,SAAS,EACT,UAAU,EACV,GAAG,GACJ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;WAmCf,SAAS,CAAC,EAC5B,OAAO,EACP,SAAS,EACT,aAAa,EACb,SAAS,EACT,UAAU,EACV,GAAG,GACJ,EAAE,gBAAgB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;WAuC3C,WAAW,CAC7B,EACE,OAAO,EACP,SAAS,EACT,aAAa,EACb,SAAS,EACT,UAAU,EACV,GAAG,GACJ,EAAE,gBAAgB,EACnB,cAAc,CAAC,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC;CAmCjB;AAGD,QAAA,MAAM,mBAAmB,EAA2B,OAAO,aAAa,CAAA;AAExE,OAAO,EAAE,mBAAmB,IAAI,aAAa,EAAE,CAAA"}