@forge/manifest 7.6.1-next.1 → 7.7.0-next.10

package/CHANGELOG.md

@@ -1,5 +1,65 @@
 # @forge/manifest
 
+## 7.7.0-next.10
+
+### Patch Changes
+
+- 26f8528: Update manifest definitions
+
+## 7.7.0-next.9
+
+### Patch Changes
+
+- 13fb92c: Update forge repo with unit tests for manifest schema changes Jira, Confluence, Bitbucket
+
+## 7.7.0-next.8
+
+### Patch Changes
+
+- f40d3b5: Update manifest definitions
+
+## 7.7.0-next.7
+
+### Patch Changes
+
+- 7160171: Update manifest definitions
+
+## 7.7.0-next.6
+
+### Minor Changes
+
+- be67acb: Interpolate string resources in modules
+
+## 7.7.0-next.5
+
+### Patch Changes
+
+- b0ad6d7: Update manifest definitions
+
+## 7.7.0-next.4
+
+### Minor Changes
+
+- c341349: Show warning if action doesn't have name attribute
+
+## 7.7.0-next.3
+
+### Patch Changes
+
+- 10f4545: Update package readme to include instruction on how to update schema in the package
+
+## 7.7.0-next.2
+
+### Minor Changes
+
+- c113f86: Show warning if action is not referenced by any agent
+- 9a546fd: Lint unique module key across Connect and Forge modules
+
+### Patch Changes
+
+- c6377ba: Update unit test in manifest validator
+- bf0fab6: Update manifest definitions
+
 ## 7.6.1-next.1
 
 ### Patch Changes

package/README.md

@@ -35,3 +35,6 @@ export interface ManifestValidationResult {
   errors?: ValidationError[];
 }
 ```
+
+## Updating Manifest schemas
+The schemas in this package are automatically updated from Shipyard daily. Any manual changes to these files will be reverted. Please raise a PR in [app-host-artifacts](https://bitbucket.org/atlassian/app-host-artifacts/src/master/) instead.

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;