@bluealba/pae-bootstrap-lib 1.7.2-develop-1171

package/LICENSE

@@ -0,0 +1,134 @@
+Required Notice: Copyright Blue Alba LLC 2025 (https://bluealba.com)
+
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you
+must agree to them as both strict obligations and
+conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the
+software that would otherwise infringe the licensor's
+copyright in it for any permitted purpose. However,
+you may only distribute the software according to
+[Distribution License](#distribution-license) and make
+changes or new works based on the software according to
+[Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software. Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or
+the URL for them above, as well as copies of any plain-text
+lines beginning with `Required Notice:` that the licensor
+provided with the software. For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software
+that covers patent claims the licensor can license, as well
+as patent claims that the licensor becomes able to license.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for
+the benefit of public knowledge, personal study, private
+entertainment, hobby projects, amateur pursuits, or religious
+observance, without any anticipated commercial application,
+is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution,
+public research organization, public safety or health
+organization, environmental protection organization, or
+government institution is use for a permitted purpose
+regardless of the source of funding or obligations resulting
+from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else. These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice. Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms, including any portion of the
+software.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization. **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise. Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

package/README.md

@@ -0,0 +1,43 @@
+# pae-boostrap-lib
+
+BlueAlba Platform Boostrapping library.
+Used by bootstrap modules to setup the platform applications definitions.
+
+Example usage
+
+```typescript jsx
+bootstrapPlatform({
+  path: join(process.cwd(), 'src', 'data')
+})
+```
+
+# Folder & Files conventions
+
+Each folder potentially represents an application if it has an `application.json` file.
+Each folder might optionally contain definition files that must follow the names: `(modules | operations | roles).json`
+If it defines an `application.json` then all resources declared in the previously mentioned files will be automatically
+created scoped to that application.
+Otherwise a folder that doesn't have `application.json` might define resources as well but they will be created
+as global resources.
+
+At the top there are platform defitions such as `shared-libraries.json`
+
+```
+.
+  - shared-libraries.json
+  - my-application
+      application.json
+      modules.json
+      operations.json
+      roles.json
+  - another-application
+      application.json
+      modules.json
+      operations.json
+  - third-application
+      application.json
+      modules.json
+  - global    (all folders without an application.json will create global resources)
+      modules.json
+      operations.json
+```

package/dist/src/bootstrap/bootstrap-platform.d.ts

@@ -0,0 +1,32 @@
+import { BootstrapModule } from "./domain/bootstrap-sync-metadata.interface";
+/**
+ * Optional properties to customize the bootstrapPlatform process.
+ */
+export type BootstrapOptions = {
+    /**
+     * A path to the folder where all the data definition resides which is going to be processed/sync
+     * Default is the current working directory (CWD)
+     */
+    path?: string;
+    /**
+     * A list of application folder names to be excluded
+     */
+    exclude?: string[];
+    /**
+     * Limit the scope of synchronization only to the elements created by the service indicated in this setting
+     */
+    scopedTo: string;
+    /**
+     * Optionally customize the computed raw list of platform modules.
+     * This is for backward compatibility with projects which had a single bootstrap for multiple platforms
+     * Adding and overriding some modules according to some env vars.
+     */
+    transformModules?: (modules: BootstrapModule[]) => BootstrapModule[];
+};
+/**
+ * Reads the current application src/data folder assembles all the platform definitions
+ * and calls PAE API's to synchronize.
+ * This is the single-entry point to implement bootstrap projects without any code at all.
+ */
+export declare const bootstrapPlatform: (options: BootstrapOptions) => Promise<void>;
+//# sourceMappingURL=bootstrap-platform.d.ts.map

package/dist/src/bootstrap/bootstrap-platform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap-platform.d.ts","sourceRoot":"","sources":["../../../src/bootstrap/bootstrap-platform.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,MAAM,4CAA4C,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,EAAE,KAAK,eAAe,EAAE,CAAC;CACtE,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAU,SAAS,gBAAgB,kBAqChE,CAAC"}

package/dist/src/bootstrap/bootstrap-platform.js

@@ -0,0 +1,75 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bootstrapPlatform = void 0;
+const read_bootstrap_applications_1 = require("./read-bootstrap-applications");
+const initialize_pae_client_1 = __importDefault(require("./initialize-pae-client"));
+const ramda_1 = require("ramda");
+const run_bootstrap_sync_service_1 = require("./run-bootstrap-sync.service");
+const pae_core_1 = require("@bluealba/pae-core");
+const fix_created_by_1 = __importDefault(require("./fix-created-by"));
+/**
+ * Reads the current application src/data folder assembles all the platform definitions
+ * and calls PAE API's to synchronize.
+ * This is the single-entry point to implement bootstrap projects without any code at all.
+ */
+const bootstrapPlatform = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    if (!options.scopedTo) {
+        throw new Error('No options.scopedTo was provider neither the env var SERVICE_ACCESS_NAME is present ! Set one to identify the bootstrap as author for creating/updating entities in the platform');
+    }
+    // init PAE
+    const pae = yield (0, initialize_pae_client_1.default)();
+    // read all files
+    const platform = (0, read_bootstrap_applications_1.readPlatformBootstrapFolder)((_a = options.path) !== null && _a !== void 0 ? _a : process.cwd(), options);
+    const applications = Object.values(platform.applications);
+    // REVIEWME: this is a temporal behavior for the moment when added the missing createdBy/updatedBy fields
+    // it must be removed after all projects already run this once in 1.4.2
+    yield (0, fix_created_by_1.default)(platform, pae, options.scopedTo);
+    // sync
+    yield (0, run_bootstrap_sync_service_1.runBootstrapSync)(pae, {
+        syncConfig: {
+            scopedTo: options.scopedTo,
+        },
+        sharedLibraries: platform.sharedLibraries,
+        // TODO: refactor this. We should be passing the list of applications.
+        //   this way we will be synchronizing "apps" instead of individual entities. And we could create better logs.
+        catalog: ((_b = options.transformModules) !== null && _b !== void 0 ? _b : ramda_1.identity)(applications.flatMap(app => app.modules)),
+        modulesConfig: (applications.flatMap(app => app.modulesConfig) || [])
+            .map(({ name, config }) => ({ moduleName: name, customProps: config })),
+        applicationsAuthz: applications
+            .filter(app => app.name !== pae_core_1.GLOBAL_APPLICATION_NAME)
+            .map(
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        (_a) => {
+            var { modules, operations, roles, modulesConfig } = _a, others = __rest(_a, ["modules", "operations", "roles", "modulesConfig"]);
+            return others;
+        }),
+        rolesAuthz: applications.flatMap(app => app.roles),
+        operationsAuthz: applications.flatMap(app => app.operations)
+    });
+});
+exports.bootstrapPlatform = bootstrapPlatform;
+//# sourceMappingURL=bootstrap-platform.js.map

package/dist/src/bootstrap/bootstrap-platform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap-platform.js","sourceRoot":"","sources":["../../../src/bootstrap/bootstrap-platform.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+EAA4E;AAC5E,oFAA0D;AAC1D,iCAAiC;AACjC,6EAAgE;AAChE,iDAA6D;AAC7D,sEAA4C;AA+B5C;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAO,OAAyB,EAAE,EAAE;;IACnE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,kLAAkL,CAAC,CAAA;IACrM,CAAC;IAED,WAAW;IACX,MAAM,GAAG,GAAG,MAAM,IAAA,+BAAmB,GAAE,CAAC;IAExC,iBAAiB;IACjB,MAAM,QAAQ,GAAG,IAAA,yDAA2B,EAAC,MAAA,OAAO,CAAC,IAAI,mCAAI,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAE1D,yGAAyG;IACzG,uEAAuE;IACvE,MAAM,IAAA,wBAAY,EAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEnD,OAAO;IACP,MAAM,IAAA,6CAAgB,EAAC,GAAG,EAAE;QAC1B,UAAU,EAAE;YACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B;QACD,eAAe,EAAE,QAAQ,CAAC,eAAe;QACzC,sEAAsE;QACtE,8GAA8G;QAE9G,OAAO,EAAE,CAAC,MAAA,OAAO,CAAC,gBAAgB,mCAAI,gBAAQ,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACzF,aAAa,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;aAClE,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;QACzE,iBAAiB,EAAE,YAAY;aAC5B,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,kCAAuB,CAAC;aACnD,GAAG;QACF,6DAA6D;QAC7D,CAAC,EAAwD,EAAE,EAAE;gBAA5D,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,OAAa,EAAR,MAAM,cAAtD,mDAAwD,CAAF;YAAO,OAAA,MAAM,CAAA;SAAA,CACrE;QACH,UAAU,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC;QAClD,eAAe,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC;KAC7D,CAAC,CAAC;AACL,CAAC,CAAA,CAAC;AArCW,QAAA,iBAAiB,qBAqC5B"}

package/dist/src/bootstrap/domain/bootstrap-sync-metadata.interface.d.ts

@@ -0,0 +1,37 @@
+import { CreateOperationDTO } from "@bluealba/pae-core/dist/src/authorization/dto/create-operation.dto";
+import { CreateSharedLibraryDTO } from "@bluealba/pae-core/dist/src/orchestrator/dto/create-shared-library.dto";
+import { CreateOrUpdateModule } from "@bluealba/pae-core";
+import { CreateApplicationDTO } from "@bluealba/pae-core/dist/src/authorization/dto/create-application.dto";
+import { CreateRoleDTO } from "@bluealba/pae-core/dist/src/authorization/dto/create-role.dto";
+import { UpdateModuleUIConfigDTO } from "@bluealba/pae-core/dist/src/catalog/dto/update-module-ui-config.dto";
+import { BootstrapOptions } from "../bootstrap-platform";
+export interface OperationAuthzBootstrap extends Omit<CreateOperationDTO, 'applicationName'>, Partial<Pick<CreateOperationDTO, 'applicationName'>> {
+    roles?: string[];
+}
+export interface ModuleConfig {
+    name: string;
+    config: Record<string, any>;
+}
+export interface BootstrapSyncMetadata {
+    syncConfig: {
+        scopedTo: BootstrapOptions['scopedTo'];
+    };
+    sharedLibraries?: CreateSharedLibraryDTO[];
+    catalog?: BootstrapModule[];
+    applicationsAuthz?: CreateApplicationDTO[];
+    rolesAuthz?: CreateRoleDTO[];
+    operationsAuthz?: OperationAuthzBootstrap[];
+    modulesConfig?: UpdateModuleUIConfigDTO[];
+}
+export type BootstrapModule = CreateOrUpdateModule;
+export type BootstrapApplication = CreateApplicationDTO & {
+    modules: BootstrapModule[];
+    operations: CreateOperationDTO[];
+    roles: CreateRoleDTO[];
+    modulesConfig: ModuleConfig[];
+};
+export type BootstrapPlatform = {
+    sharedLibraries: CreateSharedLibraryDTO[];
+    applications: Record<string, BootstrapApplication>;
+};
+//# sourceMappingURL=bootstrap-sync-metadata.interface.d.ts.map

package/dist/src/bootstrap/domain/bootstrap-sync-metadata.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap-sync-metadata.interface.d.ts","sourceRoot":"","sources":["../../../../src/bootstrap/domain/bootstrap-sync-metadata.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oEAAoE,CAAC;AACxG,OAAO,EAAE,sBAAsB,EAAE,MAAM,wEAAwE,CAAC;AAChH,OAAO,EAAE,oBAAoB,EAAkB,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,sEAAsE,CAAC;AAC5G,OAAO,EAAE,aAAa,EAAE,MAAM,+DAA+D,CAAC;AAC9F,OAAO,EAAE,uBAAuB,EAAE,MAAM,qEAAqE,CAAC;AAC9G,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,MAAM,WAAW,uBAAwB,SACvC,IAAI,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAC3C,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,CAAC;IACpD,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE;QACV,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAC;KACxC,CAAC;IACF,eAAe,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAC3C,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B,iBAAiB,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAC3C,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAC7B,eAAe,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC5C,aAAa,CAAC,EAAE,uBAAuB,EAAE,CAAC;CAC3C;AAED,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAA;AAElD,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACxD,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,UAAU,EAAE,kBAAkB,EAAE,CAAC;IACjC,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,eAAe,EAAE,sBAAsB,EAAE,CAAC;IAC1C,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CACpD,CAAA"}

package/dist/src/bootstrap/domain/bootstrap-sync-metadata.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=bootstrap-sync-metadata.interface.js.map

package/dist/src/bootstrap/domain/bootstrap-sync-metadata.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap-sync-metadata.interface.js","sourceRoot":"","sources":["../../../../src/bootstrap/domain/bootstrap-sync-metadata.interface.ts"],"names":[],"mappings":""}

package/dist/src/bootstrap/domain/domain-validation.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=domain-validation.test.d.ts.map

package/dist/src/bootstrap/domain/domain-validation.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"domain-validation.test.d.ts","sourceRoot":"","sources":["../../../../src/bootstrap/domain/domain-validation.test.ts"],"names":[],"mappings":""}