@toolsplus/nx-forge 6.0.1 → 6.0.2

package/src/shared/manifest/util-manifest.d.ts

@@ -1,24 +1,33 @@
 import { ManifestSchema } from '@forge/manifest';
 import { HostedResourcesSchema } from '@forge/manifest/out/schema/manifest';
-export type ResourceType = 'ui-kit' | 'custom-ui' | 'generic';
+export type ResourceType = 'ui-kit' | 'custom-ui' | 'static';
 export type ResourceTypeIndex = {
     [resourceKey: string]: ResourceType;
 };
 /**
  * Computes an index from resource key to resource type which is either `ui-kit`,
- * `custom-ui` or `generic`. The resource type is inferred from the module
- * declaration. If a module has both the `resource` property and `render: native`
- * declared, its resource must be of type UI Kit. If a module, only declares the
- * `resource` property and its `render` property (if exists) is not `native`,
- * its resource must be a Custom UI. In all other cases, the resource type is
- * Generic.
+ * `custom-ui` or `static`.
+ *
+ * Refer to the docs on {@link resourceTypeByResourceDefinition} for details
+ * on how the resource type is inferred.
  *
  * @param manifestSchema Complete manifest definition to analyze
  */
 export declare const getResourceTypeIndex: (manifestSchema: ManifestSchema) => ResourceTypeIndex;
 /**
- * Determines if type of the given resource. If the resource is not referenced
- * by any module it is considered a generic resource.
+ * Determines if type of the given resource.
+ *
+ * The resource type is determined by the following reduction:
+ *
+ * - If the resource is referenced by a module as a 'resource', infer a Custom
+ *   UI or UI Kit resource.
+ * - If the resource key is referenced via resource string interpolation
+ *   (resource:<resource-key>;) anywhere in the manifest, infer a static resource.
+ * - Else infer Custom UI. These kind of resources are typically used as Modal
+ *   dialogs in Custom UIs. They are not referenced in the manifest and instead,
+ *   opened via @forge/bridge in Custom UI code.
+ *
+ * @see https://developer.atlassian.com/platform/forge/apis-reference/ui-api-bridge/modal/
  *
  * @param manifestSchema Complete manifest definition
  * @param resource Resource to resolve against the manifest definition

package/src/shared/manifest/util-manifest.js

@@ -13,7 +13,7 @@ const isObject = (v) => typeof v === 'object' && v !== null;
  *              `native`
  * - Custom UI: module has the `resource` property and the `render` property is
  *              not `native` or missing
- * - Generic:   none of the above, consider it a generic resource
+ * - Static:    none of the above, consider it a static resource
  *
  * @param moduleDefinition Module definition to analyze
  */
@@ -22,55 +22,71 @@ const resourceTypeByModuleDefinition = (moduleDefinition) => {
         return 'ui-kit';
     if (!!moduleDefinition['resource'] && moduleDefinition['render'] !== 'native')
         return 'custom-ui';
-    return 'generic';
+    return 'static';
 };
 /**
  * Computes an index from resource key to resource type which is either `ui-kit`,
- * `custom-ui` or `generic`. The resource type is inferred from the module
- * declaration. If a module has both the `resource` property and `render: native`
- * declared, its resource must be of type UI Kit. If a module, only declares the
- * `resource` property and its `render` property (if exists) is not `native`,
- * its resource must be a Custom UI. In all other cases, the resource type is
- * Generic.
+ * `custom-ui` or `static`.
+ *
+ * Refer to the docs on {@link resourceTypeByResourceDefinition} for details
+ * on how the resource type is inferred.
  *
  * @param manifestSchema Complete manifest definition to analyze
  */
-const getResourceTypeIndex = (manifestSchema) => {
-    var _a;
-    return (0, manifest_1.getAllModules)((_a = manifestSchema.modules) !== null && _a !== void 0 ? _a : {}).reduce((acc, moduleDefinition) => {
-        if (isObject(moduleDefinition) &&
-            Object.hasOwn(moduleDefinition, 'resource') &&
-            typeof moduleDefinition['resource'] === 'string') {
-            const resourceKey = moduleDefinition['resource'];
-            const resourceType = resourceTypeByModuleDefinition(moduleDefinition);
-            const existingIndexEntry = acc[resourceKey];
-            if (existingIndexEntry && existingIndexEntry !== resourceType) {
-                devkit_1.logger.warn(`Inconsistent resource mapping in manifest.yml: Module with key ${moduleDefinition['key']} declares its resource to be of type ${resourceType} but other modules pointing to the same resource appear to be of a different type`);
-            }
-            return Object.assign(Object.assign({}, acc), { [resourceKey]: resourceType });
-        }
-        return acc;
-    }, {});
-};
+const getResourceTypeIndex = (manifestSchema) => (manifestSchema.resources || []).reduce((acc, resource) => {
+    const resourceKey = resource.key;
+    const resourceType = (0, exports.resourceTypeByResourceDefinition)(manifestSchema)(resource);
+    const existingIndexEntry = acc[resourceKey];
+    if (existingIndexEntry && existingIndexEntry !== resourceType) {
+        devkit_1.logger.warn(`Inconsistent resource type inference: Resource with key ${resource.key} has been inferred as type '${resourceType}' but has already been inferred as type '${existingIndexEntry}'`);
+    }
+    return {
+        ...acc,
+        [resourceKey]: resourceType,
+    };
+}, {});
 exports.getResourceTypeIndex = getResourceTypeIndex;
 /**
- * Determines if type of the given resource. If the resource is not referenced
- * by any module it is considered a generic resource.
+ * Determines if type of the given resource.
+ *
+ * The resource type is determined by the following reduction:
+ *
+ * - If the resource is referenced by a module as a 'resource', infer a Custom
+ *   UI or UI Kit resource.
+ * - If the resource key is referenced via resource string interpolation
+ *   (resource:<resource-key>;) anywhere in the manifest, infer a static resource.
+ * - Else infer Custom UI. These kind of resources are typically used as Modal
+ *   dialogs in Custom UIs. They are not referenced in the manifest and instead,
+ *   opened via @forge/bridge in Custom UI code.
+ *
+ * @see https://developer.atlassian.com/platform/forge/apis-reference/ui-api-bridge/modal/
  *
  * @param manifestSchema Complete manifest definition
  * @param resource Resource to resolve against the manifest definition
  */
-const resourceTypeByResourceDefinition = (manifestSchema) => (resource) => {
-    var _a;
-    for (const moduleDefinition of (0, manifest_1.getAllModules)((_a = manifestSchema.modules) !== null && _a !== void 0 ? _a : {})) {
-        if (isObject(moduleDefinition) &&
-            Object.hasOwn(moduleDefinition, 'resource') &&
-            typeof moduleDefinition['resource'] === 'string' &&
-            moduleDefinition['resource'] === resource.key) {
-            return resourceTypeByModuleDefinition(moduleDefinition);
+const resourceTypeByResourceDefinition = (manifestSchema) => {
+    const manifestSchemaString = JSON.stringify(manifestSchema);
+    return (resource) => {
+        var _a;
+        for (const moduleDefinition of (0, manifest_1.getAllModules)((_a = manifestSchema.modules) !== null && _a !== void 0 ? _a : {})) {
+            if (isObject(moduleDefinition) &&
+                Object.hasOwn(moduleDefinition, 'resource') &&
+                typeof moduleDefinition['resource'] === 'string' &&
+                moduleDefinition['resource'] === resource.key) {
+                return resourceTypeByModuleDefinition(moduleDefinition);
+            }
         }
-    }
-    return 'generic';
+        // If the resource key is referenced in the manifest via a resource
+        // string interpolation, assume it is a static resource
+        if (manifestSchemaString.includes(`resource:${resource.key};`)) {
+            return 'static';
+        }
+        // Assume that the resource is a Custom UI. There may be resources which are
+        // not directly referenced in the manifest. For example, UI Kit modal dialogs
+        // can be referenced in other Custom UI projects and loaded via @forge/bridge.
+        // https://developer.atlassian.com/platform/forge/apis-reference/ui-api-bridge/modal/
+        return 'custom-ui';
+    };
 };
 exports.resourceTypeByResourceDefinition = resourceTypeByResourceDefinition;
 /**

package/src/shared/manifest/util-manifest.js.map

@@ -1 +1 @@
-{"version":3,"file":"util-manifest.js","sourceRoot":"","sources":["../../../../../../packages/nx-forge/src/shared/manifest/util-manifest.ts"],"names":[],"mappings":";;;AAAA,8CAAgE;AAEhE,uCAAoC;AAEpC,8CAA8C;AAC9C,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAe,EAAE,CAC3C,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,CAAC;AAItC;;;;;;;;;;;GAWG;AACH,MAAM,8BAA8B,GAAG,CACrC,gBAAwB,EACV,EAAE;IAChB,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,KAAK,QAAQ;QAC3E,OAAO,QAAQ,CAAC;IAClB,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,KAAK,QAAQ;QAC3E,OAAO,WAAW,CAAC;IACrB,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAGF;;;;;;;;;;GAUG;AACI,MAAM,oBAAoB,GAAG,CAClC,cAA8B,EACX,EAAE;;IACrB,OAAA,IAAA,wBAAa,EAAC,MAAA,cAAc,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,MAAM,CAChD,CAAC,GAAG,EAAE,gBAAgB,EAAE,EAAE;QACxB,IACE,QAAQ,CAAC,gBAAgB,CAAC;YAC1B,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,UAAU,CAAC;YAC3C,OAAO,gBAAgB,CAAC,UAAU,CAAC,KAAK,QAAQ,EAChD,CAAC;YACD,MAAM,WAAW,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACjD,MAAM,YAAY,GAAG,8BAA8B,CAAC,gBAAgB,CAAC,CAAC;YACtE,MAAM,kBAAkB,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC;YAE5C,IAAI,kBAAkB,IAAI,kBAAkB,KAAK,YAAY,EAAE,CAAC;gBAC9D,eAAM,CAAC,IAAI,CACT,kEAAkE,gBAAgB,CAAC,KAAK,CAAC,wCAAwC,YAAY,mFAAmF,CACjO,CAAC;YACJ,CAAC;YAED,uCACK,GAAG,KACN,CAAC,WAAW,CAAC,EAAE,YAAY,IAC3B;QACJ,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAuB,CACxB,CAAA;CAAA,CAAC;AA5BS,QAAA,oBAAoB,wBA4B7B;AAEJ;;;;;;GAMG;AACI,MAAM,gCAAgC,GAC3C,CAAC,cAA8B,EAAE,EAAE,CACnC,CAAC,QAA+B,EAAgB,EAAE;;IAChD,KAAK,MAAM,gBAAgB,IAAI,IAAA,wBAAa,EAC1C,MAAA,cAAc,CAAC,OAAO,mCAAI,EAAE,CAC7B,EAAE,CAAC;QACF,IACE,QAAQ,CAAC,gBAAgB,CAAC;YAC1B,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,UAAU,CAAC;YAC3C,OAAO,gBAAgB,CAAC,UAAU,CAAC,KAAK,QAAQ;YAChD,gBAAgB,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,GAAG,EAC7C,CAAC;YACD,OAAO,8BAA8B,CAAC,gBAAgB,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAhBS,QAAA,gCAAgC,oCAgBzC;AAEJ;;;;;;;;;;;GAWG;AACI,MAAM,cAAc,GACzB,CAAC,cAA8B,EAAE,qBAAqC,EAAE,EAAE,CAC1E,CAAC,QAA+B,EAAW,EAAE,CAC3C,qBAAqB,CAAC,QAAQ,CAC5B,IAAA,wCAAgC,EAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,CAC3D,CAAC;AALO,QAAA,cAAc,kBAKrB"}
+{"version":3,"file":"util-manifest.js","sourceRoot":"","sources":["../../../../../../packages/nx-forge/src/shared/manifest/util-manifest.ts"],"names":[],"mappings":";;;AAAA,8CAAgE;AAEhE,uCAAoC;AAEpC,8CAA8C;AAC9C,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAe,EAAE,CAC3C,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,CAAC;AAItC;;;;;;;;;;;GAWG;AACH,MAAM,8BAA8B,GAAG,CACrC,gBAAwB,EACV,EAAE;IAChB,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,KAAK,QAAQ;QAC3E,OAAO,QAAQ,CAAC;IAClB,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,KAAK,QAAQ;QAC3E,OAAO,WAAW,CAAC;IACrB,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAGF;;;;;;;;GAQG;AACI,MAAM,oBAAoB,GAAG,CAClC,cAA8B,EACX,EAAE,CACrB,CAAC,cAAc,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;IACxD,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;IACjC,MAAM,YAAY,GAChB,IAAA,wCAAgC,EAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC7D,MAAM,kBAAkB,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC;IAE5C,IAAI,kBAAkB,IAAI,kBAAkB,KAAK,YAAY,EAAE,CAAC;QAC9D,eAAM,CAAC,IAAI,CACT,2DAA2D,QAAQ,CAAC,GAAG,+BAA+B,YAAY,4CAA4C,kBAAkB,GAAG,CACpL,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,GAAG;QACN,CAAC,WAAW,CAAC,EAAE,YAAY;KAC5B,CAAC;AACJ,CAAC,EAAE,EAAuB,CAAC,CAAC;AAnBjB,QAAA,oBAAoB,wBAmBH;AAE9B;;;;;;;;;;;;;;;;;GAiBG;AACI,MAAM,gCAAgC,GAAG,CAC9C,cAA8B,EAC9B,EAAE;IACF,MAAM,oBAAoB,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAC5D,OAAO,CAAC,QAA+B,EAAgB,EAAE;;QACvD,KAAK,MAAM,gBAAgB,IAAI,IAAA,wBAAa,EAC1C,MAAA,cAAc,CAAC,OAAO,mCAAI,EAAE,CAC7B,EAAE,CAAC;YACF,IACE,QAAQ,CAAC,gBAAgB,CAAC;gBAC1B,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,UAAU,CAAC;gBAC3C,OAAO,gBAAgB,CAAC,UAAU,CAAC,KAAK,QAAQ;gBAChD,gBAAgB,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,GAAG,EAC7C,CAAC;gBACD,OAAO,8BAA8B,CAAC,gBAAgB,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;QAED,mEAAmE;QACnE,uDAAuD;QACvD,IAAI,oBAAoB,CAAC,QAAQ,CAAC,YAAY,QAAQ,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC;YAC/D,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,4EAA4E;QAC5E,6EAA6E;QAC7E,8EAA8E;QAC9E,qFAAqF;QACrF,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC;AACJ,CAAC,CAAC;AA9BW,QAAA,gCAAgC,oCA8B3C;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,cAAc,GACzB,CAAC,cAA8B,EAAE,qBAAqC,EAAE,EAAE,CAC1E,CAAC,QAA+B,EAAW,EAAE,CAC3C,qBAAqB,CAAC,QAAQ,CAC5B,IAAA,wCAAgC,EAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,CAC3D,CAAC;AALO,QAAA,cAAc,kBAKrB"}

package/src/utils/forge/async-commands.js

@@ -13,7 +13,7 @@ const runForgeCommandAsync = (args, opts = {}) => {
     const pmc = (0, devkit_1.getPackageManagerCommand)();
     const cliProcess = (0, child_process_1.spawn)(pmc.exec, ['forge', ...args], {
         cwd: opts.cwd,
-        env: Object.assign(Object.assign({}, process.env), opts.env),
+        env: { ...process.env, ...opts.env },
         stdio: [process.stdin, process.stdout, process.stderr],
         shell: true,
     });

package/src/utils/forge/async-commands.js.map

@@ -1 +1 @@
-{"version":3,"file":"async-commands.js","sourceRoot":"","sources":["../../../../../../packages/nx-forge/src/utils/forge/async-commands.ts"],"names":[],"mappings":";;;AAAA,iDAAsC;AACtC,uCAAsD;AAEtD;;;;;GAKG;AACI,MAAM,oBAAoB,GAAG,CAClC,IAAc,EACd,OAAkD,EAAE,EACrC,EAAE;IACjB,MAAM,GAAG,GAAG,IAAA,iCAAwB,GAAE,CAAC;IACvC,MAAM,UAAU,GAAG,IAAA,qBAAK,EAAC,GAAG,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,EAAE;QACrD,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,GAAG,kCAAO,OAAO,CAAC,GAAG,GAAK,IAAI,CAAC,GAAG,CAAE;QACpC,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;QACtD,KAAK,EAAE,IAAI;KACZ,CAAC,CAAC;IACH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;YACvC,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,OAAO,CAAC,SAAS,CAAC,CAAC;YACrB,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,KAAK,CAAC,wBAAwB,GAAG,IAAI,CAAC,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;YACtC,MAAM,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAvBW,QAAA,oBAAoB,wBAuB/B"}
+{"version":3,"file":"async-commands.js","sourceRoot":"","sources":["../../../../../../packages/nx-forge/src/utils/forge/async-commands.ts"],"names":[],"mappings":";;;AAAA,iDAAsC;AACtC,uCAAsD;AAEtD;;;;;GAKG;AACI,MAAM,oBAAoB,GAAG,CAClC,IAAc,EACd,OAAkD,EAAE,EACrC,EAAE;IACjB,MAAM,GAAG,GAAG,IAAA,iCAAwB,GAAE,CAAC;IACvC,MAAM,UAAU,GAAG,IAAA,qBAAK,EAAC,GAAG,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,EAAE;QACrD,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE;QACpC,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;QACtD,KAAK,EAAE,IAAI;KACZ,CAAC,CAAC;IACH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;YACvC,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,OAAO,CAAC,SAAS,CAAC,CAAC;YACrB,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,KAAK,CAAC,wBAAwB,GAAG,IAAI,CAAC,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;YACtC,MAAM,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAvBW,QAAA,oBAAoB,wBAuB/B"}

package/src/utils/forge/manifest-yml.d.ts

@@ -1,6 +1,8 @@
 import { ManifestSchema } from '@forge/manifest';
 export declare const validateManifestContent: (manifestContent: ManifestSchema) => Promise<ManifestSchema>;
-export declare const readManifestYml: (path: string) => Promise<ManifestSchema>;
+export declare const readManifestYml: (path: string, options?: {
+    interpolate: boolean;
+}) => Promise<ManifestSchema>;
 /**
  * Writes the given manifest file to the specified file path.
  * @param path File path where to write the file to (incl. manifest.yml).

package/src/utils/forge/manifest-yml.js

@@ -7,21 +7,22 @@ const FULL_SCHEMA = tslib_1.__importStar(require("@forge/manifest/out/schema/man
 const js_yaml_1 = require("js-yaml");
 const fs_1 = require("fs");
 const util_manifest_1 = require("../../shared/manifest/util-manifest");
+const yaml_validator_1 = tslib_1.__importDefault(require("./yaml-validator"));
 class ManifestYmlValidator extends manifest_1.AbstractValidationProcessor {
-    constructor() {
+    constructor(options) {
         super([
             new manifest_1.FileValidator(),
-            new manifest_1.YamlValidator(),
+            new yaml_validator_1.default(options),
             new manifest_1.SchemaValidator(FULL_SCHEMA),
         ]);
     }
 }
-const schemaAndFileValidator = (manifestFilePath) => new ManifestYmlValidator().process(manifestFilePath);
+const schemaAndFileValidator = (options) => (manifestFilePath) => new ManifestYmlValidator(options).process(manifestFilePath);
 const schemaContentValidator = (manifestContent) => new manifest_1.SchemaValidator(FULL_SCHEMA).validate({
     yamlContent: manifestContent,
 });
-const validateManifestSchema = (validator) => (input) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    const { manifestObject, success: isManifestParseSuccess, errors, } = yield validator(input);
+const validateManifestSchema = (validator) => async (input) => {
+    const { manifestObject, success: isManifestParseSuccess, errors, } = await validator(input);
     if (!isManifestParseSuccess || !(manifestObject === null || manifestObject === void 0 ? void 0 : manifestObject.typedContent)) {
         throw new Error(`Failed to validate manifest input: ${(errors || [])
             .map((e) => e.message)
@@ -32,10 +33,10 @@ const validateManifestSchema = (validator) => (input) => tslib_1.__awaiter(void
         throw new Error('Manifest parse result did not return any content.');
     }
     return manifestSchema;
-});
+};
 const validateManifestContent = (manifestContent) => validateManifestSchema(schemaContentValidator)(manifestContent);
 exports.validateManifestContent = validateManifestContent;
-const readManifestYml = (path) => validateManifestSchema(schemaAndFileValidator)(path);
+const readManifestYml = (path, options = { interpolate: true }) => validateManifestSchema(schemaAndFileValidator(options))(path);
 exports.readManifestYml = readManifestYml;
 /**
  * Writes the given manifest file to the specified file path.

package/src/utils/forge/manifest-yml.js.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-yml.js","sourceRoot":"","sources":["../../../../../../packages/nx-forge/src/utils/forge/manifest-yml.ts"],"names":[],"mappings":";;;;AAAA,8CAMyB;AACzB,qGAA+E;AAC/E,qCAA+B;AAC/B,2BAAmC;AAEnC,uEAAqE;AAErE,MAAM,oBAAqB,SAAQ,sCAA2C;IAC5E;QACE,KAAK,CAAC;YACJ,IAAI,wBAAa,EAAE;YACnB,IAAI,wBAAa,EAAE;YACnB,IAAI,0BAAe,CAAC,WAAW,CAAC;SACjC,CAAC,CAAC;IACL,CAAC;CACF;AAMD,MAAM,sBAAsB,GAAoC,CAC9D,gBAAwB,EACxB,EAAE,CAAC,IAAI,oBAAoB,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAE1D,MAAM,sBAAsB,GAA4C,CACtE,eAA+B,EAC/B,EAAE,CACF,IAAI,0BAAe,CAAiB,WAAW,CAAC,CAAC,QAAQ,CAAC;IACxD,WAAW,EAAE,eAAe;CAC7B,CAAC,CAAC;AAEL,MAAM,sBAAsB,GAC1B,CAAI,SAAqC,EAAE,EAAE,CAC7C,CAAO,KAAQ,EAAE,EAAE;IACjB,MAAM,EACJ,cAAc,EACd,OAAO,EAAE,sBAAsB,EAC/B,MAAM,GACP,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC;IAE3B,IAAI,CAAC,sBAAsB,IAAI,CAAC,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,YAAY,CAAA,EAAE,CAAC;QAC7D,MAAM,IAAI,KAAK,CACb,sCAAsC,CAAC,MAAM,IAAI,EAAE,CAAC;aACjD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACrB,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAmB,cAAc,CAAC,YAAY,CAAC;IAEnE,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC,CAAA,CAAC;AAEG,MAAM,uBAAuB,GAAG,CAAC,eAA+B,EAAE,EAAE,CACzE,sBAAsB,CAAC,sBAAsB,CAAC,CAAC,eAAe,CAAC,CAAC;AADrD,QAAA,uBAAuB,2BAC8B;AAE3D,MAAM,eAAe,GAAG,CAAC,IAAY,EAA2B,EAAE,CACvE,sBAAsB,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,CAAC;AAD1C,QAAA,eAAe,mBAC2B;AAEvD;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,KAAqB,EAAQ,EAAE;IAC5E,MAAM,OAAO,GAAG,IAAA,cAAI,EAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAChC,IAAA,kBAAa,EAAC,IAAI,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC;AAHW,QAAA,gBAAgB,oBAG3B;AAEF;;;;;GAKG;AACI,MAAM,6BAA6B,GAAG,CAC3C,QAAwB,EACd,EAAE;IACZ,OAAO,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC;SAC9B,MAAM,CAAC,IAAA,8BAAc,EAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;SACzD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC,CAAC;AANW,QAAA,6BAA6B,iCAMxC"}
+{"version":3,"file":"manifest-yml.js","sourceRoot":"","sources":["../../../../../../packages/nx-forge/src/utils/forge/manifest-yml.ts"],"names":[],"mappings":";;;;AAAA,8CAKyB;AACzB,qGAA+E;AAC/E,qCAA+B;AAC/B,2BAAmC;AAEnC,uEAAqE;AACrE,8EAA6C;AAE7C,MAAM,oBAAqB,SAAQ,sCAA2C;IAC5E,YAAY,OAAiC;QAC3C,KAAK,CAAC;YACJ,IAAI,wBAAa,EAAE;YACnB,IAAI,wBAAa,CAAC,OAAO,CAAC;YAC1B,IAAI,0BAAe,CAAC,WAAW,CAAC;SACjC,CAAC,CAAC;IACL,CAAC;CACF;AAMD,MAAM,sBAAsB,GAC1B,CAAC,OAAiC,EAAmC,EAAE,CACvE,CAAC,gBAAwB,EAAE,EAAE,CAC3B,IAAI,oBAAoB,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAEhE,MAAM,sBAAsB,GAA4C,CACtE,eAA+B,EAC/B,EAAE,CACF,IAAI,0BAAe,CAAiB,WAAW,CAAC,CAAC,QAAQ,CAAC;IACxD,WAAW,EAAE,eAAe;CAC7B,CAAC,CAAC;AAEL,MAAM,sBAAsB,GAC1B,CAAI,SAAqC,EAAE,EAAE,CAC7C,KAAK,EAAE,KAAQ,EAAE,EAAE;IACjB,MAAM,EACJ,cAAc,EACd,OAAO,EAAE,sBAAsB,EAC/B,MAAM,GACP,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC;IAE3B,IAAI,CAAC,sBAAsB,IAAI,CAAC,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,YAAY,CAAA,EAAE,CAAC;QAC7D,MAAM,IAAI,KAAK,CACb,sCAAsC,CAAC,MAAM,IAAI,EAAE,CAAC;aACjD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACrB,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAmB,cAAc,CAAC,YAAY,CAAC;IAEnE,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEG,MAAM,uBAAuB,GAAG,CAAC,eAA+B,EAAE,EAAE,CACzE,sBAAsB,CAAC,sBAAsB,CAAC,CAAC,eAAe,CAAC,CAAC;AADrD,QAAA,uBAAuB,2BAC8B;AAE3D,MAAM,eAAe,GAAG,CAC7B,IAAY,EACZ,UAAoC,EAAE,WAAW,EAAE,IAAI,EAAE,EAChC,EAAE,CAC3B,sBAAsB,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAJnD,QAAA,eAAe,mBAIoC;AAEhE;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,KAAqB,EAAQ,EAAE;IAC5E,MAAM,OAAO,GAAG,IAAA,cAAI,EAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAChC,IAAA,kBAAa,EAAC,IAAI,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC;AAHW,QAAA,gBAAgB,oBAG3B;AAEF;;;;;GAKG;AACI,MAAM,6BAA6B,GAAG,CAC3C,QAAwB,EACd,EAAE;IACZ,OAAO,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC;SAC9B,MAAM,CAAC,IAAA,8BAAc,EAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;SACzD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC,CAAC;AANW,QAAA,6BAA6B,iCAMxC"}

package/src/utils/forge/yaml-validator.d.ts

@@ -0,0 +1,19 @@
+import { ManifestObject } from '@forge/manifest';
+import { ValidatorInterface } from '@forge/manifest/out/validators/validator-interface';
+import { ManifestValidationResult } from '@forge/manifest/out/types';
+/**
+ * Copy of @forge/manifest YamlValidator with the only difference that the
+ * validator can be constructed with or without manifest interpolation. The
+ * validator provided by @forge/manifest does not provide an option to skip
+ * interpolation.
+ */
+declare class YamlValidator<T> implements ValidatorInterface<ManifestObject<T> | undefined, T> {
+    protected options: {
+        interpolate: boolean;
+    };
+    constructor(options: {
+        interpolate: boolean;
+    });
+    validate(manifest: ManifestObject<T> | undefined): Promise<ManifestValidationResult<T>>;
+}
+export default YamlValidator;

package/src/utils/forge/yaml-validator.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const manifest_1 = require("@forge/manifest");
+const node_fs_1 = require("node:fs");
+const yaml_1 = require("yaml");
+/**
+ * Copy of @forge/manifest YamlValidator with the only difference that the
+ * validator can be constructed with or without manifest interpolation. The
+ * validator provided by @forge/manifest does not provide an option to skip
+ * interpolation.
+ */
+class YamlValidator {
+    constructor(options) {
+        this.options = options;
+    }
+    async validate(manifest) {
+        var _a, _b, _c;
+        if (!(manifest === null || manifest === void 0 ? void 0 : manifest.filePath)) {
+            return {
+                success: false,
+                manifestObject: manifest,
+            };
+        }
+        try {
+            const content = (0, node_fs_1.readFileSync)(manifest.filePath, 'utf8');
+            const parserBuilder = this.options.interpolate
+                ? new manifest_1.ManifestParserBuilder().withInterpolators()
+                : new manifest_1.ManifestParserBuilder();
+            const manifestContent = parserBuilder
+                .build()
+                .parseManifest({ content, filePath: manifest.filePath });
+            return {
+                success: true,
+                manifestObject: {
+                    filePath: manifest.filePath,
+                    yamlContent: manifestContent,
+                    yamlContentByLine: content.split('\n'),
+                },
+            };
+        }
+        catch (e) {
+            if (e instanceof yaml_1.YAMLError) {
+                const pos = (_a = e.linePos) === null || _a === void 0 ? void 0 : _a[0];
+                return {
+                    success: false,
+                    errors: [
+                        {
+                            message: manifest_1.errors.invalidManifest(e.message.replace(/(at line).+/gms, '').trim()),
+                            reference: manifest_1.References.InvalidManifest,
+                            level: 'error',
+                            line: (_b = pos === null || pos === void 0 ? void 0 : pos.line) !== null && _b !== void 0 ? _b : 0,
+                            column: (_c = pos === null || pos === void 0 ? void 0 : pos.col) !== null && _c !== void 0 ? _c : 0,
+                        },
+                    ],
+                };
+            }
+            return {
+                success: false,
+                errors: [
+                    {
+                        message: manifest_1.errors.invalidManifest(e.message),
+                        reference: manifest_1.References.InvalidManifest,
+                        level: 'error',
+                        line: 0,
+                        column: 0,
+                    },
+                ],
+            };
+        }
+    }
+}
+exports.default = YamlValidator;
+//# sourceMappingURL=yaml-validator.js.map

package/src/utils/forge/yaml-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"yaml-validator.js","sourceRoot":"","sources":["../../../../../../packages/nx-forge/src/utils/forge/yaml-validator.ts"],"names":[],"mappings":";;AAAA,8CAKyB;AACzB,qCAAuC;AACvC,+BAAiC;AAIjC;;;;;GAKG;AACH,MAAM,aAAa;IAGjB,YAAsB,OAAiC;QAAjC,YAAO,GAAP,OAAO,CAA0B;IAAG,CAAC;IAC3D,KAAK,CAAC,QAAQ,CACZ,QAAuC;;QAEvC,IAAI,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,CAAA,EAAE,CAAC;YACxB,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,cAAc,EAAE,QAAQ;aACzB,CAAC;QACJ,CAAC;QACD,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAA,sBAAY,EAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACxD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW;gBAC5C,CAAC,CAAC,IAAI,gCAAqB,EAAE,CAAC,iBAAiB,EAAE;gBACjD,CAAC,CAAC,IAAI,gCAAqB,EAAE,CAAC;YAChC,MAAM,eAAe,GAAG,aAAa;iBAClC,KAAK,EAAE;iBACP,aAAa,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC3D,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,cAAc,EAAE;oBACd,QAAQ,EAAE,QAAQ,CAAC,QAAQ;oBAC3B,WAAW,EAAE,eAAe;oBAC5B,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;iBACvC;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,gBAAS,EAAE,CAAC;gBAC3B,MAAM,GAAG,GAAG,MAAA,CAAC,CAAC,OAAO,0CAAG,CAAC,CAAC,CAAC;gBAC3B,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,MAAM,EAAE;wBACN;4BACE,OAAO,EAAE,iBAAM,CAAC,eAAe,CAC7B,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAC/C;4BACD,SAAS,EAAE,qBAAU,CAAC,eAAe;4BACrC,KAAK,EAAE,OAAO;4BACd,IAAI,EAAE,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,mCAAI,CAAC;4BACpB,MAAM,EAAE,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,GAAG,mCAAI,CAAC;yBACtB;qBACF;iBACF,CAAC;YACJ,CAAC;YACD,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE;oBACN;wBACE,OAAO,EAAE,iBAAM,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC;wBAC1C,SAAS,EAAE,qBAAU,CAAC,eAAe;wBACrC,KAAK,EAAE,OAAO;wBACd,IAAI,EAAE,CAAC;wBACP,MAAM,EAAE,CAAC;qBACV;iBACF;aACF,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AACD,kBAAe,aAAa,CAAC"}