@forge/cli-shared 8.20.0 → 8.21.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/cli-shared
 
+## 8.21.0
+
+### Minor Changes
+
+- 7f9ae91: Added variable prompting and structure skeleton for forge module add
+
+## 8.21.0-next.0
+
+### Minor Changes
+
+- 7f9ae91: Added variable prompting and structure skeleton for forge module add
+
 ## 8.20.0
 
 ### Minor Changes

package/out/apps/index.d.ts

@@ -5,5 +5,6 @@ export * from './package-installer';
 export * from './register-app';
 export * from './sites';
 export * from './template';
+export * from './template-module';
 export * from './get-app-owner';
 //# sourceMappingURL=index.d.ts.map

package/out/apps/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/apps/index.ts"],"names":[],"mappings":"AAEA,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/apps/index.ts"],"names":[],"mappings":"AAEA,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC"}

package/out/apps/index.js

@@ -8,4 +8,5 @@ tslib_1.__exportStar(require("./package-installer"), exports);
 tslib_1.__exportStar(require("./register-app"), exports);
 tslib_1.__exportStar(require("./sites"), exports);
 tslib_1.__exportStar(require("./template"), exports);
+tslib_1.__exportStar(require("./template-module"), exports);
 tslib_1.__exportStar(require("./get-app-owner"), exports);

package/out/apps/template-module.d.ts

@@ -0,0 +1,62 @@
+export declare class BifrostFetchError extends Error {
+    constructor(message: string);
+}
+export declare type UIFramework = 'ui-kit' | 'custom-ui';
+export interface TemplateVariableDef {
+    name: string;
+    prompt: string;
+    default?: string;
+}
+export interface ModuleTemplateMeta {
+    name: string;
+    displayName: string;
+    description: string;
+    product: string;
+    category?: string;
+    uiFramework?: UIFramework;
+    moduleKey: string;
+    dependencies?: Record<string, string> | string[];
+    devDependencies?: Record<string, string> | string[];
+    frontend?: {
+        dependencies?: string[];
+        devDependencies?: string[];
+    };
+    customUiDependencies?: string[];
+    customUiDevDependencies?: string[];
+    requiredScopes?: string[];
+    variables?: TemplateVariableDef[];
+    fileOperations?: Array<{
+        type: 'create' | 'append' | 'merge' | 'update';
+        source?: string;
+        target: string;
+        template?: boolean;
+    }>;
+    variants?: Record<UIFramework, {
+        manifestPath?: string;
+        dependencies?: Record<string, string> | string[];
+        devDependencies?: Record<string, string> | string[];
+        frontend?: {
+            dependencies?: string[];
+            devDependencies?: string[];
+        };
+        variables?: TemplateVariableDef[];
+        fileOperations?: Array<{
+            type: 'create' | 'append' | 'merge' | 'update';
+            source?: string;
+            target: string;
+            template?: boolean;
+        }>;
+    }>;
+    cacheDir?: string;
+}
+export declare class TemplateModuleServices {
+    private readonly baseUrl;
+    private templatesCache;
+    constructor(baseUrl?: string);
+    getAvailableModules(product: string): Promise<ModuleTemplateMeta[]>;
+    private fetchModuleTemplates;
+    fetchManifestFragment(manifestPath: string): Promise<string>;
+    downloadModuleAssets(template: ModuleTemplateMeta, uiFramework?: UIFramework): Promise<ModuleTemplateMeta>;
+    cleanupCache(cacheDir: string): void;
+}
+//# sourceMappingURL=template-module.d.ts.map

package/out/apps/template-module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-module.d.ts","sourceRoot":"","sources":["../../src/apps/template-module.ts"],"names":[],"mappings":"AAUA,qBAAa,iBAAkB,SAAQ,KAAK;gBAC9B,OAAO,EAAE,MAAM;CAI5B;AAED,oBAAY,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;AAEjD,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;IACjD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;IACpD,QAAQ,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QACxB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;KAC5B,CAAC;IAEF,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IACnC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,SAAS,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAClC,cAAc,CAAC,EAAE,KAAK,CAAC;QACrB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;QAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC,CAAC;IAEH,QAAQ,CAAC,EAAE,MAAM,CACf,WAAW,EACX;QACE,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;QACjD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;QACpD,QAAQ,CAAC,EAAE;YACT,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;SAC5B,CAAC;QACF,SAAS,CAAC,EAAE,mBAAmB,EAAE,CAAC;QAClC,cAAc,CAAC,EAAE,KAAK,CAAC;YACrB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;YAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,MAAM,EAAE,MAAM,CAAC;YACf,QAAQ,CAAC,EAAE,OAAO,CAAC;SACpB,CAAC,CAAC;KACJ,CACF,CAAC;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,cAAc,CAAqC;gBAE/C,OAAO,CAAC,EAAE,MAAM;IAIf,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAOlE,oBAAoB;IAsBrB,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAa5D,oBAAoB,CAC/B,QAAQ,EAAE,kBAAkB,EAC5B,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO,CAAC,kBAAkB,CAAC;IAkCvB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;CAO5C"}

package/out/apps/template-module.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemplateModuleServices = exports.BifrostFetchError = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
+const os_1 = tslib_1.__importDefault(require("os"));
+const url_1 = require("url");
+const text_1 = require("../ui/text");
+const BIFROST_BASE_URL = 'https://forge-templates-bifrost.ddev.frontend.public.atl-paas.net/assets/';
+const MODULE_INDEX_FILE = 'template-modules.json';
+class BifrostFetchError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'BifrostFetchError';
+    }
+}
+exports.BifrostFetchError = BifrostFetchError;
+class TemplateModuleServices {
+    baseUrl;
+    templatesCache = null;
+    constructor(baseUrl) {
+        this.baseUrl = baseUrl ?? BIFROST_BASE_URL;
+    }
+    async getAvailableModules(product) {
+        const infos = await this.fetchModuleTemplates();
+        const filtered = infos.filter((i) => i.product === product);
+        return filtered;
+    }
+    async fetchModuleTemplates() {
+        if (this.templatesCache) {
+            return this.templatesCache;
+        }
+        const indexUrl = new url_1.URL(MODULE_INDEX_FILE, this.baseUrl);
+        const res = await (0, node_fetch_1.default)(indexUrl);
+        if (!res.ok) {
+            throw new BifrostFetchError(text_1.Text.module.errors.bifrostIndexFetchFailed(res.status, res.statusText));
+        }
+        const json = await res.json();
+        if (Array.isArray(json)) {
+            this.templatesCache = json;
+            return this.templatesCache;
+        }
+        throw new BifrostFetchError(text_1.Text.module.errors.bifrostIndexInvalid);
+    }
+    async fetchManifestFragment(manifestPath) {
+        const url = `${this.baseUrl}${manifestPath}`;
+        const res = await (0, node_fetch_1.default)(url);
+        if (!res.ok) {
+            throw new BifrostFetchError(text_1.Text.module.errors.bifrostManifestFragmentFetchFailed(res.status, res.statusText));
+        }
+        return await res.text();
+    }
+    async downloadModuleAssets(template, uiFramework) {
+        let manifestFragment;
+        let variantData;
+        if (uiFramework) {
+            variantData = template.variants?.[uiFramework];
+            if (!variantData)
+                throw new Error(text_1.Text.module.add.errorInvalidUIFramework(uiFramework, template.moduleKey));
+        }
+        if (variantData?.manifestPath) {
+            manifestFragment = await this.fetchManifestFragment(variantData.manifestPath);
+        }
+        const cacheDir = fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), 'forge-module-'));
+        if (manifestFragment) {
+            fs_1.default.writeFileSync(path_1.default.join(cacheDir, 'manifest-fragment.yml'), manifestFragment);
+        }
+        return {
+            ...template,
+            ...(variantData
+                ? {
+                    uiFramework,
+                    dependencies: variantData.dependencies ?? template.dependencies,
+                    devDependencies: variantData.devDependencies ?? template.devDependencies,
+                    frontend: variantData.frontend ?? template.frontend,
+                    variables: variantData.variables ?? template.variables,
+                    fileOperations: variantData.fileOperations ?? template.fileOperations
+                }
+                : {}),
+            cacheDir
+        };
+    }
+    cleanupCache(cacheDir) {
+        try {
+            fs_1.default.rmSync(cacheDir, { recursive: true, force: true });
+        }
+        catch {
+        }
+    }
+}
+exports.TemplateModuleServices = TemplateModuleServices;