@forge/manifest 7.7.0-next.5 → 7.7.0-next.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/manifest
 
+## 7.7.0-next.6
+
+### Minor Changes
+
+- be67acb: Interpolate string resources in modules
+
 ## 7.7.0-next.5
 
 ### Patch Changes

package/out/interpolator/environment-variable-interpolator.d.ts

@@ -0,0 +1,15 @@
+import { InterpolatorType, ManifestInterpolator, ManifestInterpolatorError } from './manifest-interpolator';
+import { ManifestSchema } from '../schema/manifest';
+export declare class EnvironmentVariableInterpolatorError extends ManifestInterpolatorError {
+    constructor(message: string);
+}
+export declare class EnvironmentVariableInterpolator implements ManifestInterpolator {
+    private readonly envVarsRecord;
+    type: InterpolatorType;
+    POSSIBLE_ENVIRONMENT_VARIABLE: RegExp;
+    private envVarsToReplace;
+    constructor(envVarsRecord?: Record<string, string | undefined>);
+    interpolate(manifest: ManifestSchema): ManifestSchema;
+    private environmentVariableReviver;
+}
+//# sourceMappingURL=environment-variable-interpolator.d.ts.map

package/out/interpolator/environment-variable-interpolator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment-variable-interpolator.d.ts","sourceRoot":"","sources":["../../src/interpolator/environment-variable-interpolator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAC5G,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAIpD,qBAAa,oCAAqC,SAAQ,yBAAyB;gBACrE,OAAO,EAAE,MAAM;CAI5B;AAKD,qBAAa,+BAAgC,YAAW,oBAAoB;IAS9D,OAAO,CAAC,QAAQ,CAAC,aAAa;IAR1C,IAAI,EAAE,gBAAgB,CAAyC;IAI/D,6BAA6B,SAAqC;IAElE,OAAO,CAAC,gBAAgB,CAAW;gBAEN,aAAa,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAM;IAInF,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,cAAc;IAKrD,OAAO,CAAC,0BAA0B,CAkBhC;CACH"}

package/out/interpolator/environment-variable-interpolator.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnvironmentVariableInterpolator = exports.EnvironmentVariableInterpolatorError = void 0;
+const tslib_1 = require("tslib");
+const yaml_1 = require("yaml");
+const manifest_interpolator_1 = require("./manifest-interpolator");
+const text_1 = require("../text");
+const Sentry = tslib_1.__importStar(require("@sentry/node"));
+class EnvironmentVariableInterpolatorError extends manifest_interpolator_1.ManifestInterpolatorError {
+    constructor(message) {
+        super(message);
+        this.name = 'EnvironmentVariableInterpolatorError';
+    }
+}
+exports.EnvironmentVariableInterpolatorError = EnvironmentVariableInterpolatorError;
+class EnvironmentVariableInterpolator {
+    envVarsRecord;
+    type = manifest_interpolator_1.InterpolatorType.ENVIRONMENT_VARIABLE;
+    POSSIBLE_ENVIRONMENT_VARIABLE = /\$\{([a-zA-Z_][a-zA-Z0-9_]*)\}/g;
+    envVarsToReplace;
+    constructor(envVarsRecord = {}) {
+        this.envVarsRecord = envVarsRecord;
+        this.envVarsToReplace = [];
+    }
+    interpolate(manifest) {
+        this.envVarsToReplace = manifest.environment?.variables ?? [];
+        return (0, yaml_1.parse)(JSON.stringify(manifest), this.environmentVariableReviver);
+    }
+    environmentVariableReviver = (_, value) => {
+        if (!(typeof value == 'string')) {
+            return value;
+        }
+        value = value.replace(this.POSSIBLE_ENVIRONMENT_VARIABLE, (original, envVarName) => {
+            if (!this.envVarsToReplace.includes(envVarName)) {
+                return original;
+            }
+            const envVar = this.envVarsRecord[envVarName];
+            if (envVar === undefined) {
+                throw new EnvironmentVariableInterpolatorError(text_1.errors.schema.missingEnvironmentVariable(envVarName));
+            }
+            Sentry.captureMessage('replaced environment variable');
+            return envVar;
+        });
+        return value;
+    };
+}
+exports.EnvironmentVariableInterpolator = EnvironmentVariableInterpolator;

package/out/interpolator/manifest-interpolator-manager.d.ts

@@ -0,0 +1,9 @@
+import { ManifestSchema } from '../schema/manifest';
+import { ManifestInterpolator } from './manifest-interpolator';
+export declare class ManifestInterpolatorManager {
+    private interpolators;
+    constructor();
+    addInterpolator(interpolator: ManifestInterpolator): void;
+    interpolate(manifest: string): ManifestSchema;
+}
+//# sourceMappingURL=manifest-interpolator-manager.d.ts.map

package/out/interpolator/manifest-interpolator-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-interpolator-manager.d.ts","sourceRoot":"","sources":["../../src/interpolator/manifest-interpolator-manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAoB,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAMjF,qBAAa,2BAA2B;IACtC,OAAO,CAAC,aAAa,CAA8C;;IAUnE,eAAe,CAAC,YAAY,EAAE,oBAAoB,GAAG,IAAI;IASzD,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc;CAO9C"}

package/out/interpolator/manifest-interpolator-manager.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestInterpolatorManager = void 0;
+const yaml_1 = require("yaml");
+class ManifestInterpolatorManager {
+    interpolators;
+    constructor() {
+        this.interpolators = new Map();
+    }
+    addInterpolator(interpolator) {
+        this.interpolators.set(interpolator.type, interpolator);
+    }
+    interpolate(manifest) {
+        let interpolatedManifest = (0, yaml_1.parse)(manifest);
+        for (const interpolator of this.interpolators.values()) {
+            interpolatedManifest = interpolator.interpolate(interpolatedManifest);
+        }
+        return interpolatedManifest;
+    }
+}
+exports.ManifestInterpolatorManager = ManifestInterpolatorManager;

package/out/interpolator/manifest-interpolator.d.ts

@@ -0,0 +1,13 @@
+import { ManifestSchema } from '../schema/manifest';
+export declare class ManifestInterpolatorError extends Error {
+    constructor(message: string);
+}
+export declare enum InterpolatorType {
+    STRING_RESOURCE = 0,
+    ENVIRONMENT_VARIABLE = 1
+}
+export interface ManifestInterpolator {
+    type: InterpolatorType;
+    interpolate(manifest: ManifestSchema): ManifestSchema;
+}
+//# sourceMappingURL=manifest-interpolator.d.ts.map

package/out/interpolator/manifest-interpolator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-interpolator.d.ts","sourceRoot":"","sources":["../../src/interpolator/manifest-interpolator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,qBAAa,yBAA0B,SAAQ,KAAK;gBACtC,OAAO,EAAE,MAAM;CAI5B;AAED,oBAAY,gBAAgB;IAC1B,eAAe,IAAA;IACf,oBAAoB,IAAA;CACrB;AAKD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,gBAAgB,CAAC;IAMvB,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,cAAc,CAAC;CACvD"}

package/out/interpolator/manifest-interpolator.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InterpolatorType = exports.ManifestInterpolatorError = void 0;
+class ManifestInterpolatorError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'ManifestInterpolatorError';
+    }
+}
+exports.ManifestInterpolatorError = ManifestInterpolatorError;
+var InterpolatorType;
+(function (InterpolatorType) {
+    InterpolatorType[InterpolatorType["STRING_RESOURCE"] = 0] = "STRING_RESOURCE";
+    InterpolatorType[InterpolatorType["ENVIRONMENT_VARIABLE"] = 1] = "ENVIRONMENT_VARIABLE";
+})(InterpolatorType = exports.InterpolatorType || (exports.InterpolatorType = {}));

package/out/interpolator/string-resource-interpolator.d.ts

@@ -0,0 +1,14 @@
+import { ManifestSchema } from '../schema/manifest';
+import { InterpolatorType, ManifestInterpolator, ManifestInterpolatorError } from './manifest-interpolator';
+export declare class StringResourceInterpolatorError extends ManifestInterpolatorError {
+    constructor(message: string);
+}
+export declare class StringResourceInterpolator implements ManifestInterpolator {
+    type: InterpolatorType;
+    interpolate(manifest: ManifestSchema): ManifestSchema;
+    private fetchContentFromResourceFile;
+    private getResourcePath;
+    private checkIfResourceIsValid;
+    private checkIfResourceTypeIsSupported;
+}
+//# sourceMappingURL=string-resource-interpolator.d.ts.map

package/out/interpolator/string-resource-interpolator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-resource-interpolator.d.ts","sourceRoot":"","sources":["../../src/interpolator/string-resource-interpolator.ts"],"names":[],"mappings":"AACA,OAAO,EAAyB,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAG3E,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAY5G,qBAAa,+BAAgC,SAAQ,yBAAyB;gBAChE,OAAO,EAAE,MAAM;CAI5B;AAKD,qBAAa,0BAA2B,YAAW,oBAAoB;IACrE,IAAI,EAAE,gBAAgB,CAAoC;IAE1D,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,cAAc;IAiBrD,OAAO,CAAC,4BAA4B;IASpC,OAAO,CAAC,eAAe;IAavB,OAAO,CAAC,sBAAsB;IAc9B,OAAO,CAAC,8BAA8B;CAOvC"}

package/out/interpolator/string-resource-interpolator.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringResourceInterpolator = exports.StringResourceInterpolatorError = void 0;
+const fs_1 = require("fs");
+const types_1 = require("../types");
+const errors_1 = require("../text/errors");
+const manifest_interpolator_1 = require("./manifest-interpolator");
+const mime_types_1 = require("mime-types");
+const MODULE_PROPERTIES_TO_INTERPOLATE = [
+    { moduleType: types_1.AllModuleTypes.RovoAgent, property: 'prompt' }
+];
+class StringResourceInterpolatorError extends manifest_interpolator_1.ManifestInterpolatorError {
+    constructor(message) {
+        super(message);
+        this.name = 'StringResourceInterpolatorError';
+    }
+}
+exports.StringResourceInterpolatorError = StringResourceInterpolatorError;
+class StringResourceInterpolator {
+    type = manifest_interpolator_1.InterpolatorType.STRING_RESOURCE;
+    interpolate(manifest) {
+        MODULE_PROPERTIES_TO_INTERPOLATE.forEach(({ moduleType, property }) => {
+            const modules = manifest.modules?.[moduleType];
+            modules?.forEach((module) => {
+                if (module.hasOwnProperty(property)) {
+                    const moduleAny = module;
+                    const propertyValue = moduleAny[property];
+                    if (propertyValue.startsWith('resource:')) {
+                        moduleAny[property] = this.fetchContentFromResourceFile(propertyValue, manifest);
+                    }
+                }
+            });
+        });
+        return manifest;
+    }
+    fetchContentFromResourceFile(modulePropertyWithStringResource, manifest) {
+        const resourcePath = this.getResourcePath(manifest, modulePropertyWithStringResource);
+        try {
+            return (0, fs_1.readFileSync)(resourcePath, 'utf8');
+        }
+        catch (error) {
+            throw new StringResourceInterpolatorError(errors_1.errors.schema.errorReadingResourceFile(resourcePath, error?.message));
+        }
+    }
+    getResourcePath(manifest, resourceString) {
+        const resourceUrl = new URL(resourceString);
+        const [resourceKey, relativePath] = resourceUrl.pathname.split(';');
+        const resource = this.checkIfResourceIsValid(manifest, resourceKey);
+        const resourcePath = `${resource.path}/${relativePath}`;
+        this.checkIfResourceTypeIsSupported(resourcePath);
+        return resourcePath;
+    }
+    checkIfResourceIsValid(manifest, resourceKey) {
+        const resource = manifest.resources?.find((resource) => resource.key === resourceKey);
+        if (!resource) {
+            throw new StringResourceInterpolatorError(errors_1.errors.schema.resourceNotFound(resourceKey));
+        }
+        if (!resource.path) {
+            throw new StringResourceInterpolatorError(errors_1.errors.schema.resourcePathNotDefined(resourceKey));
+        }
+        return resource;
+    }
+    checkIfResourceTypeIsSupported(resourcePath) {
+        const mimeType = (0, mime_types_1.lookup)(resourcePath);
+        if (!mimeType || !mimeType.startsWith('text')) {
+            throw new StringResourceInterpolatorError(errors_1.errors.schema.resourceFileNotSupported(resourcePath));
+        }
+    }
+}
+exports.StringResourceInterpolator = StringResourceInterpolator;

package/out/text/errors.d.ts

@@ -10,6 +10,10 @@ export declare const errors: {
         additionalProperties: (additionalProperty: string) => string;
         notAllowed: (props: string[] | undefined) => string;
         missingEnvironmentVariable: (variable: string) => string;
+        errorReadingResourceFile: (variable: string, errorMessage: string) => string;
+        resourceNotFound: (variable: string) => string;
+        resourcePathNotDefined: (variable: string) => string;
+        resourceFileNotSupported: (variable: string) => string;
     };
     permissions: {
         invalidPermission: (element: string, value: string) => string;

package/out/text/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/text/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAG1C,eAAO,MAAM,MAAM;8BACS,MAAM,KAAG,MAAM;2BACpB,MAAM;yBAEN,MAAM,GAAG,SAAS,QAAQ,MAAM,EAAE,UAAU,MAAM,GAAG,SAAS,KAAG,MAAM;;uBAO3E,MAAM,EAAE,EAAE,GAAG,SAAS,KAAG,MAAM;4BAI1B,MAAM,EAAE,KAAG,MAAM;mCACV,MAAM,SAAS,MAAM,mBAAmB,MAAM,KAAG,MAAM;mDAIvC,MAAM,KAAG,MAAM;4BAEtC,MAAM,EAAE,GAAG,SAAS,KAAG,MAAM;+CAIV,MAAM;;;qCAGhB,MAAM,SAAS,MAAM,KAAG,MAAM;4CAEvB,MAAM,SAAS,MAAM,KAAG,MAAM;oDAEtB,MAAM,OAAO,MAAM,KAAG,MAAM;kDAE9B,MAAM,OAAO,MAAM,KAAG,MAAM;wCAEtC,MAAM,SAAS,MAAM,EAAE,KAAG,MAAM;;;uCAMjC,MAAM,KAAG,MAAM;0CACZ,MAAM,KAAG,MAAM;;;gCAGzB,MAAM,KAAG,MAAM;6BACpB,MAAM;+BACJ,MAAM;iCACF,MAAM,KAAG,MAAM;yCACP,MAAM,eAAe,MAAM,KAAG,MAAM;yCAEpC,MAAM,eAAe,MAAM,KAAG,MAAM;yCAEpC,MAAM,eAAe,MAAM,KAAG,MAAM;oCAEzC,MAAM;6CACG,MAAM,KAAG,MAAM;0EAEc,MAAM,KAAG,MAAM;4DAE7B,MAAM,KAAG,MAAM;6DAEd,MAAM,KAAG,MAAM;;yCAGrC,MAAM,KAAG,MAAM;iCAEvB,MAAM,KAAG,MAAM;4CACJ,MAAM,gBAAgB,MAAM,KAAG,MAAM;sCAE3C,MAAM,gBAAgB,MAAM,gBAAgB,MAAM,KAAG,MAAM;;;wDAIzC,MAAM,qBAAqB,MAAM,KAAG,MAAM;4CAEtD,MAAM,qBAAqB,MAAM,KAAG,MAAM;;;yCAI7C,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;2CAIhD,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;sDAEvC,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;8DAEvB,MAAM,aAAa,MAAM,cAAc,MAAM,KAAG,MAAM;6EAEvC,MAAM,qBAAqB,MAAM,KAAG,MAAM;yEAE9C,MAAM,qBAAqB,MAAM,KAAG,MAAM;;wCAG/E,MAAM;sDACU,MAAM,KAAG,MAAM;iDAEpB,MAAM,KAAG,MAAM;2DAEL,MAAM,KAAG,MAAM;0CAEhC,MAAM,OAAO,MAAM,KAAG,MAAM;yDAEb,MAAM,KAAG,MAAM;uEAED,MAAM,KAAG,MAAM;;;;mCAKjD,MAAM,KAAG,MAAM;mCAEf,MAAM,KAAG,MAAM;;;qCAIb,MAAM,KAAG,MAAM;;;0CAIV,MAAM,KAAG,MAAM;;;4CAIb,MAAM,EAAE,KAAG,MAAM;;;wCAIrB,cAAc,OAAO,MAAM,UAAU,MAAM,EAAE,KAAG,MAAM;;;mCAI3D,MAAM,EAAE,KAAG,MAAM;;;4DAIQ,MAAM,KAAG,MAAM;qCAEtC,MAAM,KAAG,MAAM;2CAET,MAAM,KAAG,MAAM;;;oCAGtB,MAAM,KAAG,MAAM;;oCAEjB,MAAM,SAAS,MAAM,KAAG,MAAM;qCAI7B,MAAM,YAAY,MAAM,KAAG,MAAM;;;;;iCAQrC,MAAM,KAAG,MAAM;;;;oDAKI,MAAM;8DACM,MAAM,qBAAqB,MAAM,KAAG,MAAM;kDAEtD,MAAM,qBAAqB,MAAM,KAAG,MAAM;;;wDAIpC,MAAM,KAAG,MAAM;;;oDAInB,MAAM,aAAa,MAAM,KAAG,MAAM;yCAE7C,MAAM,KAAG,MAAM;0CACd,MAAM,KAAG,MAAM;;;;kCAKrB,MAAM,OAAO,MAAM,KAAG,MAAM;iCAE7B,MAAM,OAAO,MAAM,KAAG,MAAM;oCAEzB,MAAM,OAAO,MAAM,KAAG,MAAM;gDAEhB,MAAM,KAAG,MAAM;uCAExB,MAAM,KAAG,MAAM;+BACvB,MAAM,OAAO,MAAM,KAAG,MAAM;;;;;;;;kCASzB,MAAM,UAAU,MAAM,KAAG,MAAM;gCAEjC,MAAM,KAAG,MAAM;2CAEJ,MAAM,eAAe,MAAM,KAAG,MAAM;;;uCAI1C,MAAM;uCAEJ,MAAM,KAAG,MAAM;qCAEnB,MAAM;;6CAGA,MAAM;;;mDAIE,MAAM,KAAG,MAAM;;;;4CAKxB,MAAM,SAAS,MAAM,KAAG,MAAM;4CAE9B,MAAM,KAAG,MAAM;4CACf,MAAM,SAAS,MAAM,KAAG,MAAM;+CAE3B,MAAM,aAAa,MAAM,SAAS,MAAM,KAAG,MAAM;yCAEvD,MAAM,SAAS,MAAM,KAAG,MAAM;4CAE3B,MAAM,SAAS,MAAM,KAAG,MAAM;gDAE1B,MAAM,aAAa,MAAM,KAAG,MAAM;4CAEtC,MAAM,SAAS,MAAM,KAAG,MAAM;;;2CAI7B,MAAM;;;gCAInB,MAAM;;;;;0DAKwB,MAAM,KAAG,MAAM;sDAEnB,MAAM,KAAG,MAAM;kDAEnB,MAAM,QAAQ,MAAM,KAAG,MAAM;mDAE5B,MAAM,KAAG,MAAM;mCAE/B,MAAM,KAAG,MAAM;;oDAEE,MAAM,aAAa,MAAM,KAAG,MAAM;;CAGjF,CAAC;AAEF,oBAAY,UAAU;IACpB,eAAe,2BAA2B;IAC1C,eAAe,wBAAwB;IACvC,WAAW,4BAA4B;IACvC,WAAW,+BAA+B;IAC1C,aAAa,8BAA8B;IAC3C,OAAO,0BAA0B;IACjC,cAAc,kCAAkC;IAChD,SAAS,4BAA4B;IACrC,SAAS,4BAA4B;IACrC,UAAU,wBAAwB;IAClC,GAAG,8BAA8B;IACjC,eAAe,0BAA0B;CAC1C"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/text/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAG1C,eAAO,MAAM,MAAM;8BACS,MAAM,KAAG,MAAM;2BACpB,MAAM;yBAEN,MAAM,GAAG,SAAS,QAAQ,MAAM,EAAE,UAAU,MAAM,GAAG,SAAS,KAAG,MAAM;;uBAO3E,MAAM,EAAE,EAAE,GAAG,SAAS,KAAG,MAAM;4BAI1B,MAAM,EAAE,KAAG,MAAM;mCACV,MAAM,SAAS,MAAM,mBAAmB,MAAM,KAAG,MAAM;mDAIvC,MAAM,KAAG,MAAM;4BAEtC,MAAM,EAAE,GAAG,SAAS,KAAG,MAAM;+CAIV,MAAM;6CACR,MAAM,gBAAgB,MAAM;qCAEpC,MAAM;2CACA,MAAM;6CACJ,MAAM;;;qCAGd,MAAM,SAAS,MAAM,KAAG,MAAM;4CAEvB,MAAM,SAAS,MAAM,KAAG,MAAM;oDAEtB,MAAM,OAAO,MAAM,KAAG,MAAM;kDAE9B,MAAM,OAAO,MAAM,KAAG,MAAM;wCAEtC,MAAM,SAAS,MAAM,EAAE,KAAG,MAAM;;;uCAMjC,MAAM,KAAG,MAAM;0CACZ,MAAM,KAAG,MAAM;;;gCAGzB,MAAM,KAAG,MAAM;6BACpB,MAAM;+BACJ,MAAM;iCACF,MAAM,KAAG,MAAM;yCACP,MAAM,eAAe,MAAM,KAAG,MAAM;yCAEpC,MAAM,eAAe,MAAM,KAAG,MAAM;yCAEpC,MAAM,eAAe,MAAM,KAAG,MAAM;oCAEzC,MAAM;6CACG,MAAM,KAAG,MAAM;0EAEc,MAAM,KAAG,MAAM;4DAE7B,MAAM,KAAG,MAAM;6DAEd,MAAM,KAAG,MAAM;;yCAGrC,MAAM,KAAG,MAAM;iCAEvB,MAAM,KAAG,MAAM;4CACJ,MAAM,gBAAgB,MAAM,KAAG,MAAM;sCAE3C,MAAM,gBAAgB,MAAM,gBAAgB,MAAM,KAAG,MAAM;;;wDAIzC,MAAM,qBAAqB,MAAM,KAAG,MAAM;4CAEtD,MAAM,qBAAqB,MAAM,KAAG,MAAM;;;yCAI7C,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;2CAIhD,MAAM,aAAa,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;sDAEvC,MAAM,QAAQ,MAAM,EAAE,KAAG,MAAM;8DAEvB,MAAM,aAAa,MAAM,cAAc,MAAM,KAAG,MAAM;6EAEvC,MAAM,qBAAqB,MAAM,KAAG,MAAM;yEAE9C,MAAM,qBAAqB,MAAM,KAAG,MAAM;;wCAG/E,MAAM;sDACU,MAAM,KAAG,MAAM;iDAEpB,MAAM,KAAG,MAAM;2DAEL,MAAM,KAAG,MAAM;0CAEhC,MAAM,OAAO,MAAM,KAAG,MAAM;yDAEb,MAAM,KAAG,MAAM;uEAED,MAAM,KAAG,MAAM;;;;mCAKjD,MAAM,KAAG,MAAM;mCAEf,MAAM,KAAG,MAAM;;;qCAIb,MAAM,KAAG,MAAM;;;0CAIV,MAAM,KAAG,MAAM;;;4CAIb,MAAM,EAAE,KAAG,MAAM;;;wCAIrB,cAAc,OAAO,MAAM,UAAU,MAAM,EAAE,KAAG,MAAM;;;mCAI3D,MAAM,EAAE,KAAG,MAAM;;;4DAIQ,MAAM,KAAG,MAAM;qCAEtC,MAAM,KAAG,MAAM;2CAET,MAAM,KAAG,MAAM;;;oCAGtB,MAAM,KAAG,MAAM;;oCAEjB,MAAM,SAAS,MAAM,KAAG,MAAM;qCAI7B,MAAM,YAAY,MAAM,KAAG,MAAM;;;;;iCAQrC,MAAM,KAAG,MAAM;;;;oDAKI,MAAM;8DACM,MAAM,qBAAqB,MAAM,KAAG,MAAM;kDAEtD,MAAM,qBAAqB,MAAM,KAAG,MAAM;;;wDAIpC,MAAM,KAAG,MAAM;;;oDAInB,MAAM,aAAa,MAAM,KAAG,MAAM;yCAE7C,MAAM,KAAG,MAAM;0CACd,MAAM,KAAG,MAAM;;;;kCAKrB,MAAM,OAAO,MAAM,KAAG,MAAM;iCAE7B,MAAM,OAAO,MAAM,KAAG,MAAM;oCAEzB,MAAM,OAAO,MAAM,KAAG,MAAM;gDAEhB,MAAM,KAAG,MAAM;uCAExB,MAAM,KAAG,MAAM;+BACvB,MAAM,OAAO,MAAM,KAAG,MAAM;;;;;;;;kCASzB,MAAM,UAAU,MAAM,KAAG,MAAM;gCAEjC,MAAM,KAAG,MAAM;2CAEJ,MAAM,eAAe,MAAM,KAAG,MAAM;;;uCAI1C,MAAM;uCAEJ,MAAM,KAAG,MAAM;qCAEnB,MAAM;;6CAGA,MAAM;;;mDAIE,MAAM,KAAG,MAAM;;;;4CAKxB,MAAM,SAAS,MAAM,KAAG,MAAM;4CAE9B,MAAM,KAAG,MAAM;4CACf,MAAM,SAAS,MAAM,KAAG,MAAM;+CAE3B,MAAM,aAAa,MAAM,SAAS,MAAM,KAAG,MAAM;yCAEvD,MAAM,SAAS,MAAM,KAAG,MAAM;4CAE3B,MAAM,SAAS,MAAM,KAAG,MAAM;gDAE1B,MAAM,aAAa,MAAM,KAAG,MAAM;4CAEtC,MAAM,SAAS,MAAM,KAAG,MAAM;;;2CAI7B,MAAM;;;gCAInB,MAAM;;;;;0DAKwB,MAAM,KAAG,MAAM;sDAEnB,MAAM,KAAG,MAAM;kDAEnB,MAAM,QAAQ,MAAM,KAAG,MAAM;mDAE5B,MAAM,KAAG,MAAM;mCAE/B,MAAM,KAAG,MAAM;;oDAEE,MAAM,aAAa,MAAM,KAAG,MAAM;;CAGjF,CAAC;AAEF,oBAAY,UAAU;IACpB,eAAe,2BAA2B;IAC1C,eAAe,wBAAwB;IACvC,WAAW,4BAA4B;IACvC,WAAW,+BAA+B;IAC1C,aAAa,8BAA8B;IAC3C,OAAO,0BAA0B;IACjC,cAAc,kCAAkC;IAChD,SAAS,4BAA4B;IACrC,SAAS,4BAA4B;IACrC,UAAU,wBAAwB;IAClC,GAAG,8BAA8B;IACjC,eAAe,0BAA0B;CAC1C"}

package/out/text/errors.js

@@ -22,7 +22,11 @@ exports.errors = {
         notAllowed: (props) => props
             ? `does not support the following Forge properties - ${props.map((v) => "'" + v + "'").join(', ')}`
             : 'provided properties do not match schema. Learn more about modules at https://go.atlassian.com/forge-modules',
-        missingEnvironmentVariable: (variable) => `could not find environment variable '${variable}'`
+        missingEnvironmentVariable: (variable) => `could not find environment variable '${variable}'`,
+        errorReadingResourceFile: (variable, errorMessage) => `error while reading resource file: '${variable}'. Error: ${errorMessage}`,
+        resourceNotFound: (variable) => `could not find resource: '${variable}'`,
+        resourcePathNotDefined: (variable) => `resource path not defined for resource: '${variable}'`,
+        resourceFileNotSupported: (variable) => `resource file type not supported: '${variable}'`
     },
     permissions: {
         invalidPermission: (element, value) => `Invalid '${element}' permission in the manifest.yml file - '${value}'. Learn more about permissions at: https://go.atlassian.com/forge-permissions.`,

package/out/utils/index.d.ts

@@ -2,7 +2,8 @@ export * from './get-all-modules';
 export * from './line-finder';
 export * from './module-key-cleaner';
 export * from './module-references';
-export * from './manifest-parser';
+export * from './manifest-parser-builder';
+export type { ManifestParser } from './manifest-parser';
 export * from './module-i18n-helper';
 export * from './translation-value-getter';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,YAAY,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC"}

package/out/utils/index.js

@@ -5,6 +5,6 @@ tslib_1.__exportStar(require("./get-all-modules"), exports);
 tslib_1.__exportStar(require("./line-finder"), exports);
 tslib_1.__exportStar(require("./module-key-cleaner"), exports);
 tslib_1.__exportStar(require("./module-references"), exports);
-tslib_1.__exportStar(require("./manifest-parser"), exports);
+tslib_1.__exportStar(require("./manifest-parser-builder"), exports);
 tslib_1.__exportStar(require("./module-i18n-helper"), exports);
 tslib_1.__exportStar(require("./translation-value-getter"), exports);

package/out/utils/manifest-parser-builder.d.ts

@@ -0,0 +1,8 @@
+import { ManifestParser } from './manifest-parser';
+export declare class ManifestParserBuilder {
+    private manifestInterpolatorManager;
+    constructor();
+    withInterpolators(): ManifestParserBuilder;
+    build(): ManifestParser;
+}
+//# sourceMappingURL=manifest-parser-builder.d.ts.map

package/out/utils/manifest-parser-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-parser-builder.d.ts","sourceRoot":"","sources":["../../src/utils/manifest-parser-builder.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAMnD,qBAAa,qBAAqB;IAChC,OAAO,CAAC,2BAA2B,CAA8B;;IAcjE,iBAAiB,IAAI,qBAAqB;IAU1C,KAAK,IAAI,cAAc;CAGxB"}

package/out/utils/manifest-parser-builder.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestParserBuilder = void 0;
+const environment_variable_interpolator_1 = require("../interpolator/environment-variable-interpolator");
+const manifest_interpolator_manager_1 = require("../interpolator/manifest-interpolator-manager");
+const string_resource_interpolator_1 = require("../interpolator/string-resource-interpolator");
+const manifest_parser_1 = require("./manifest-parser");
+class ManifestParserBuilder {
+    manifestInterpolatorManager;
+    constructor() {
+        this.manifestInterpolatorManager = new manifest_interpolator_manager_1.ManifestInterpolatorManager();
+    }
+    withInterpolators() {
+        this.manifestInterpolatorManager.addInterpolator(new environment_variable_interpolator_1.EnvironmentVariableInterpolator(process.env));
+        this.manifestInterpolatorManager.addInterpolator(new string_resource_interpolator_1.StringResourceInterpolator());
+        return this;
+    }
+    build() {
+        return new manifest_parser_1.ManifestParser(this.manifestInterpolatorManager);
+    }
+}
+exports.ManifestParserBuilder = ManifestParserBuilder;

package/out/utils/manifest-parser.d.ts

@@ -1,4 +1,4 @@
-import { ManifestSchema } from '../schema/manifest';
+import { ManifestInterpolatorManager } from '../interpolator/manifest-interpolator-manager';
 export declare class ManifestParserError extends Error {
     constructor(message: string);
     getAttributes(): {
@@ -6,11 +6,9 @@ export declare class ManifestParserError extends Error {
     };
 }
 export declare class ManifestParser {
-    private readonly envVarsRecord;
-    private envVarsToReplace;
-    constructor(envVarsRecord?: Record<string, string | undefined>);
-    parseManifest(manifest: string): ManifestSchema;
+    private manifestInterpolator;
+    constructor(manifestInterpolator: ManifestInterpolatorManager);
+    parseManifest(manifest: string): import("../index").ManifestSchema;
     parseManifestAsString: (manifest: string) => string;
-    private environmentVariableReviver;
 }
 //# sourceMappingURL=manifest-parser.d.ts.map

package/out/utils/manifest-parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-parser.d.ts","sourceRoot":"","sources":["../../src/utils/manifest-parser.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAKpD,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;IAMpB,aAAa;;;CAKrB;AAMD,qBAAa,cAAc;IAGb,OAAO,CAAC,QAAQ,CAAC,aAAa;IAF1C,OAAO,CAAC,gBAAgB,CAAW;gBAEN,aAAa,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAM;IAI5E,aAAa,CAAC,QAAQ,EAAE,MAAM;IAMrC,qBAAqB,aAAc,MAAM,YAAgE;IAEzG,OAAO,CAAC,0BAA0B,CAkBhC;CACH"}
+{"version":3,"file":"manifest-parser.d.ts","sourceRoot":"","sources":["../../src/utils/manifest-parser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,2BAA2B,EAAE,MAAM,+CAA+C,CAAC;AAK5F,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;IAMpB,aAAa;;;CAKrB;AAKD,qBAAa,cAAc;IACb,OAAO,CAAC,oBAAoB;gBAApB,oBAAoB,EAAE,2BAA2B;IAQrE,aAAa,CAAC,QAAQ,EAAE,MAAM;IAgB9B,qBAAqB,aAAc,MAAM,YAAgE;CAC1G"}

package/out/utils/manifest-parser.js

@@ -1,10 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ManifestParser = exports.ManifestParserError = void 0;
-const tslib_1 = require("tslib");
 const yaml_1 = require("yaml");
-const errors_1 = require("../text/errors");
-const Sentry = tslib_1.__importStar(require("@sentry/node"));
+const manifest_interpolator_1 = require("../interpolator/manifest-interpolator");
 const yamlConfigOptions = { indent: 2, skipInvalid: true };
 class ManifestParserError extends Error {
     constructor(message) {
@@ -17,36 +15,22 @@ class ManifestParserError extends Error {
     }
 }
 exports.ManifestParserError = ManifestParserError;
-const POSSIBLE_ENVIRONMENT_VARIABLE = /\$\{([a-zA-Z_][a-zA-Z0-9_]*)\}/g;
 class ManifestParser {
-    envVarsRecord;
-    envVarsToReplace;
-    constructor(envVarsRecord = {}) {
-        this.envVarsRecord = envVarsRecord;
-        this.envVarsToReplace = [];
+    manifestInterpolator;
+    constructor(manifestInterpolator) {
+        this.manifestInterpolator = manifestInterpolator;
     }
     parseManifest(manifest) {
-        const rawManifest = (0, yaml_1.parse)(manifest);
-        this.envVarsToReplace = rawManifest.environment?.variables ?? [];
-        return (0, yaml_1.parse)(manifest, this.environmentVariableReviver);
-    }
-    parseManifestAsString = (manifest) => (0, yaml_1.stringify)(this.parseManifest(manifest), yamlConfigOptions);
-    environmentVariableReviver = (_, value) => {
-        if (!(typeof value == 'string')) {
-            return value;
+        try {
+            return this.manifestInterpolator.interpolate(manifest);
         }
-        value = value.replace(POSSIBLE_ENVIRONMENT_VARIABLE, (original, envVarName) => {
-            if (!this.envVarsToReplace.includes(envVarName)) {
-                return original;
-            }
-            const envVar = this.envVarsRecord[envVarName];
-            if (envVar === undefined) {
-                throw new ManifestParserError(errors_1.errors.schema.missingEnvironmentVariable(envVarName));
+        catch (error) {
+            if (error instanceof manifest_interpolator_1.ManifestInterpolatorError) {
+                throw new ManifestParserError(error.message);
             }
-            Sentry.captureMessage('replaced environment variable');
-            return envVar;
-        });
-        return value;
-    };
+            throw error;
+        }
+    }
+    parseManifestAsString = (manifest) => (0, yaml_1.stringify)(this.parseManifest(manifest), yamlConfigOptions);
 }
 exports.ManifestParser = ManifestParser;

package/out/validators/yaml-validator.d.ts

@@ -1,8 +1,6 @@
 import { ManifestObject, ManifestValidationResult } from '../types';
 import { ValidatorInterface } from './validator-interface';
 export declare class YamlValidator<T> implements ValidatorInterface<ManifestObject<T> | undefined, T> {
-    private manifestParser;
-    constructor();
     validate(manifest: ManifestObject<T> | undefined): Promise<ManifestValidationResult<T>>;
 }
 //# sourceMappingURL=yaml-validator.d.ts.map

package/out/validators/yaml-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"yaml-validator.d.ts","sourceRoot":"","sources":["../../src/validators/yaml-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AAIpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAG3D,qBAAa,aAAa,CAAC,CAAC,CAAE,YAAW,kBAAkB,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC;IAC3F,OAAO,CAAC,cAAc,CAAiB;;IAIjC,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC;CAiD9F"}
+{"version":3,"file":"yaml-validator.d.ts","sourceRoot":"","sources":["../../src/validators/yaml-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AAIpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAG3D,qBAAa,aAAa,CAAC,CAAC,CAAE,YAAW,kBAAkB,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC;IACrF,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC;CAiD9F"}

package/out/validators/yaml-validator.js

@@ -5,12 +5,8 @@ const tslib_1 = require("tslib");
 const yaml_1 = require("yaml");
 const fs_1 = tslib_1.__importDefault(require("fs"));
 const text_1 = require("../text");
-const __1 = require("..");
+const utils_1 = require("../utils");
 class YamlValidator {
-    manifestParser;
-    constructor() {
-        this.manifestParser = new __1.ManifestParser(process.env);
-    }
     async validate(manifest) {
         if (!manifest || !manifest.filePath) {
             return {
@@ -20,7 +16,7 @@ class YamlValidator {
         }
         try {
             const content = fs_1.default.readFileSync(manifest.filePath, 'utf8');
-            const manifestContent = this.manifestParser.parseManifest(content);
+            const manifestContent = new utils_1.ManifestParserBuilder().withInterpolators().build().parseManifest(content);
             return {
                 success: true,
                 manifestObject: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/manifest",
-  "version": "7.7.0-next.5",
+  "version": "7.7.0-next.6",
   "description": "Definitions and validations of the Forge manifest",
   "main": "out/index.js",
   "scripts": {
@@ -30,6 +30,7 @@
     "cheerio": "^0.22.0",
     "glob": "^10.3.10",
     "lodash": "^4.17.21",
+    "mime-types": "^2.1.35",
     "yaml": "^2.3.4"
   }
 }