@forge/cli-shared 8.23.1-next.5 → 8.23.1-next.6-experimental-5c60439

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @forge/cli-shared
 
+## 8.23.1-next.6-experimental-5c60439
+
+### Minor Changes
+
+- 2415638: Prerelease of forge module add command
+
+### Patch Changes
+
+- 22145f6: Surfacing error messages in the Forge CLI for apps that are missing billing information
+- Updated dependencies [ccdcfc3]
+- Updated dependencies [8197e66]
+- Updated dependencies [723fab8]
+- Updated dependencies [4493006]
+- Updated dependencies [5beb8ad]
+- Updated dependencies [f1f11f0]
+- Updated dependencies [b7b1f36]
+- Updated dependencies [9f3add6]
+  - @forge/manifest@12.9.0-next.5-experimental-5c60439
+
+## 8.23.1-next.6
+
+### Patch Changes
+
+- Updated dependencies [8197e66]
+  - @forge/manifest@12.9.0-next.5
+
 ## 8.23.1-next.5
 
 ### Patch Changes

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

@@ -15,11 +15,12 @@ export interface ModuleTemplateMeta {
     category?: string;
     uiFramework?: UIFramework;
     moduleKey: string;
-    dependencies?: Record<string, string> | string[];
-    devDependencies?: Record<string, string> | string[];
+    manifestPath?: string;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
     frontend?: {
-        dependencies?: string[];
-        devDependencies?: string[];
+        dependencies?: Record<string, string>;
+        devDependencies?: Record<string, string>;
     };
     customUiDependencies?: string[];
     customUiDevDependencies?: string[];
@@ -33,11 +34,11 @@ export interface ModuleTemplateMeta {
     }>;
     variants?: Record<UIFramework, {
         manifestPath?: string;
-        dependencies?: Record<string, string> | string[];
-        devDependencies?: Record<string, string> | string[];
+        dependencies?: Record<string, string>;
+        devDependencies?: Record<string, string>;
         frontend?: {
-            dependencies?: string[];
-            devDependencies?: string[];
+            dependencies?: Record<string, string>;
+            devDependencies?: Record<string, string>;
         };
         variables?: TemplateVariableDef[];
         fileOperations?: Array<{
@@ -56,7 +57,9 @@ export declare class TemplateModuleServices {
     getAvailableModules(product: string): Promise<ModuleTemplateMeta[]>;
     private fetchModuleTemplates;
     fetchManifestFragment(manifestPath: string): Promise<string>;
-    downloadModuleAssets(template: ModuleTemplateMeta, uiFramework?: UIFramework): Promise<ModuleTemplateMeta>;
+    applyVariant(template: ModuleTemplateMeta, uiFramework?: UIFramework): ModuleTemplateMeta;
+    prepareModuleMetadata(template: ModuleTemplateMeta, uiFramework?: UIFramework): Promise<ModuleTemplateMeta>;
+    downloadModuleBundle(template: ModuleTemplateMeta, uiFramework?: UIFramework): Promise<void>;
     cleanupCache(cacheDir: string): void;
 }
 //# sourceMappingURL=template-module.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"template-module.d.ts","sourceRoot":"","sources":["../../src/apps/template-module.ts"],"names":[],"mappings":"AAWA,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;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC1C,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,CAAC;QACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACzC,QAAQ,CAAC,EAAE;YACT,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAC1C,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;gBAG/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;IAYlE,YAAY,CAAC,QAAQ,EAAE,kBAAkB,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,kBAAkB;IAqBnF,qBAAqB,CAChC,QAAQ,EAAE,kBAAkB,EAC5B,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO,CAAC,kBAAkB,CAAC;IAajB,oBAAoB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IA2ClG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;CAO5C"}

package/out/apps/template-module.js

@@ -7,6 +7,7 @@ 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 adm_zip_1 = tslib_1.__importDefault(require("adm-zip"));
 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';
@@ -52,41 +53,77 @@ class TemplateModuleServices {
         }
         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);
+    applyVariant(template, uiFramework) {
+        if (!uiFramework)
+            return { ...template };
+        const variantData = template.variants?.[uiFramework];
+        if (!variantData) {
+            throw new Error(text_1.Text.module.add.errorInvalidUIFramework(uiFramework, template.moduleKey));
         }
         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
+            uiFramework,
+            manifestPath: variantData.manifestPath ?? template.manifestPath,
+            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
         };
     }
+    async prepareModuleMetadata(template, uiFramework) {
+        const resolved = this.applyVariant(template, uiFramework);
+        const cacheDir = fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), 'forge-module-'));
+        if (resolved.manifestPath) {
+            const manifestFragment = await this.fetchManifestFragment(resolved.manifestPath);
+            fs_1.default.writeFileSync(path_1.default.join(cacheDir, 'manifest-fragment.yml'), manifestFragment);
+        }
+        return { ...resolved, cacheDir };
+    }
+    async downloadModuleBundle(template, uiFramework) {
+        if (!template.fileOperations?.length) {
+            return;
+        }
+        if (!template.cacheDir) {
+            throw new Error(text_1.Text.module.add.errorCacheDirMissing(template.moduleKey));
+        }
+        const rel = uiFramework ? `${template.moduleKey}/${uiFramework}/bundle.zip` : `${template.moduleKey}/bundle.zip`;
+        const url = `${this.baseUrl}${rel}`;
+        let res;
+        try {
+            res = await (0, node_fetch_1.default)(url);
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            throw new Error(text_1.Text.module.add.errorFailedToDownloadBundle(template.moduleKey, message), { cause: err });
+        }
+        if (!res.ok) {
+            throw new BifrostFetchError(`${text_1.Text.module.errors.bifrostZipFetchFailed(template.moduleKey, res.status, res.statusText)} (last URL: ${url})`);
+        }
+        const arrayBuffer = await res.arrayBuffer();
+        const zipPath = path_1.default.join(template.cacheDir, 'bundle.zip');
+        fs_1.default.writeFileSync(zipPath, Buffer.from(arrayBuffer));
+        try {
+            new adm_zip_1.default(zipPath).extractAllTo(template.cacheDir, true);
+        }
+        catch (err) {
+            throw new BifrostFetchError(text_1.Text.module.add.errorZipExtractionFailed(template.moduleKey, err.message));
+        }
+        finally {
+            try {
+                fs_1.default.rmSync(zipPath, { force: true });
+            }
+            catch (cleanupErr) {
+                console.warn(`${text_1.Text.module.add.errorZipCleanupFailed(template.moduleKey)}`);
+            }
+        }
+    }
     cleanupCache(cacheDir) {
         try {
             fs_1.default.rmSync(cacheDir, { recursive: true, force: true });
         }
         catch {
+            throw new Error(text_1.Text.module.add.errorCacheCleanupFailed(cacheDir));
         }
     }
 }