@toolsplus/nx-forge 4.1.0 → 4.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toolsplus/nx-forge",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Atlassian Forge plugin for Nx",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",
@@ -10,7 +10,7 @@
     "nx": "^18.0.0"
   },
   "dependencies": {
-    "@forge/manifest": "^5.5.0",
+    "@forge/manifest": "^6.1.0",
     "@nx/devkit": "18.0.6",
     "@nx/eslint": "18.0.6",
     "@nx/jest": "18.0.6",
@@ -18,6 +18,7 @@
     "@nx/webpack": "18.0.6",
     "fs-extra": "^10.0.1",
     "js-yaml": "^4.1.0",
+    "jsonata": "^2.0.4",
     "tslib": "^2.3.0"
   },
   "type": "commonjs",

package/src/executors/deploy/executor.d.ts

@@ -1,4 +1,5 @@
+import { ExecutorContext } from '@nx/devkit';
 import { DeployExecutorOptions } from './schema';
-export default function runExecutor(options: DeployExecutorOptions): Promise<{
+export default function runExecutor(rawOptions: DeployExecutorOptions, context: ExecutorContext): Promise<{
     success: boolean;
 }>;

package/src/executors/deploy/executor.js

@@ -3,8 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
 const async_commands_1 = require("../../utils/forge/async-commands");
-function runExecutor(options) {
+const transform_manifest_yml_1 = require("./lib/transform-manifest-yml");
+const normalizeOptions = (options, context) => {
+    const isEnvironmentName = (c) => ['development', 'staging', 'production'].includes(c);
+    if (isEnvironmentName(context.configurationName)) {
+        return Object.assign(Object.assign({}, options), { environment: context.configurationName });
+    }
+    else {
+        return options;
+    }
+};
+function runExecutor(rawOptions, context) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const options = normalizeOptions(rawOptions, context);
+        if (options.manifestTransform && options.manifestTransform !== '') {
+            devkit_1.logger.info(`Applying Forge manifest transformation ${context.configurationName ? `(${context.configurationName})` : ''}: ${options.manifestTransform}`);
+            yield (0, transform_manifest_yml_1.transformManifestYml)(options, context);
+        }
         const args = [
             'deploy',
             `--environment=${options.environment}`,

package/src/executors/deploy/executor.js.map

@@ -1 +1 @@
-{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../../../../../packages/nx-forge/src/executors/deploy/executor.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AAEpC,qEAAwE;AAExE,SAA8B,WAAW,CAAC,OAA8B;;QACtE,MAAM,IAAI,GAAG;YACX,QAAQ;YACR,iBAAiB,OAAO,CAAC,WAAW,EAAE;YACtC,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClD,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAChE,CAAC;QAEF,eAAM,CAAC,GAAG,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAE/C,MAAM,IAAA,qCAAoB,EAAC,IAAI,EAAE;YAC/B,GAAG,EAAE,OAAO,CAAC,UAAU;SACxB,CAAC,CAAC;QAEH,eAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CAAA;AAnBD,8BAmBC"}
+{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../../../../../packages/nx-forge/src/executors/deploy/executor.ts"],"names":[],"mappings":";;;AAAA,uCAAqD;AAErD,qEAAwE;AACxE,yEAAoE;AAEpE,MAAM,gBAAgB,GAAG,CACvB,OAA8B,EAC9B,OAAwB,EACD,EAAE;IACzB,MAAM,iBAAiB,GAAG,CACxB,CAAS,EACkC,EAAE,CAC7C,CAAC,aAAa,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEvD,IAAI,iBAAiB,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACjD,uCACK,OAAO,KACV,WAAW,EAAE,OAAO,CAAC,iBAAiB,IACtC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC,CAAC;AAEF,SAA8B,WAAW,CACvC,UAAiC,EACjC,OAAwB;;QAExB,MAAM,OAAO,GAAG,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAEtD,IAAI,OAAO,CAAC,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,KAAK,EAAE,EAAE,CAAC;YAClE,eAAM,CAAC,IAAI,CACT,0CACE,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC,EACjE,KAAK,OAAO,CAAC,iBAAiB,EAAE,CACjC,CAAC;YACF,MAAM,IAAA,6CAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,IAAI,GAAG;YACX,QAAQ;YACR,iBAAiB,OAAO,CAAC,WAAW,EAAE;YACtC,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClD,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAChE,CAAC;QAEF,eAAM,CAAC,GAAG,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAE/C,MAAM,IAAA,qCAAoB,EAAC,IAAI,EAAE;YAC/B,GAAG,EAAE,OAAO,CAAC,UAAU;SACxB,CAAC,CAAC;QAEH,eAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CAAA;AAjCD,8BAiCC"}

package/src/executors/deploy/lib/transform-manifest-yml.d.ts

@@ -0,0 +1,5 @@
+import { DeployExecutorOptions } from '../schema';
+import { ExecutorContext } from '@nx/devkit';
+type Options = Pick<DeployExecutorOptions, 'outputPath' | 'manifestTransform' | 'verify'>;
+export declare const transformManifestYml: (options: Options, context: ExecutorContext) => Promise<void>;
+export {};

package/src/executors/deploy/lib/transform-manifest-yml.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformManifestYml = void 0;
+const tslib_1 = require("tslib");
+const jsonata_1 = tslib_1.__importDefault(require("jsonata"));
+const manifest_yml_1 = require("../../../utils/forge/manifest-yml");
+const devkit_1 = require("@nx/devkit");
+const transformManifestYml = (options, context) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    let expression;
+    try {
+        expression = (0, jsonata_1.default)(options.manifestTransform);
+    }
+    catch (error) {
+        throw new Error(`Failed to parse expression '${options.manifestTransform}': ${(_a = error.message) !== null && _a !== void 0 ? _a : JSON.stringify(error)}`);
+    }
+    const manifestPath = (0, devkit_1.joinPathFragments)(context.root, options.outputPath, 'manifest.yml');
+    const manifest = yield (0, manifest_yml_1.readManifestYml)(manifestPath);
+    expression.registerFunction('env', (s) => process.env[s], '<s:(sl)>');
+    const transformedManifest = yield expression.evaluate(manifest);
+    if (options.verify) {
+        yield (0, manifest_yml_1.validateManifestContent)(transformedManifest);
+    }
+    (0, manifest_yml_1.writeManifestYml)(manifestPath, transformedManifest);
+});
+exports.transformManifestYml = transformManifestYml;
+//# sourceMappingURL=transform-manifest-yml.js.map

package/src/executors/deploy/lib/transform-manifest-yml.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-manifest-yml.js","sourceRoot":"","sources":["../../../../../../../packages/nx-forge/src/executors/deploy/lib/transform-manifest-yml.ts"],"names":[],"mappings":";;;;AAAA,8DAA8C;AAE9C,oEAI2C;AAC3C,uCAAgE;AAOzD,MAAM,oBAAoB,GAAG,CAClC,OAAgB,EAChB,OAAwB,EACxB,EAAE;;IACF,IAAI,UAAsB,CAAC;IAC3B,IAAI,CAAC;QACH,UAAU,GAAG,IAAA,iBAAO,EAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,+BAA+B,OAAO,CAAC,iBAAiB,MACtD,MAAA,KAAK,CAAC,OAAO,mCAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CACvC,EAAE,CACH,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,IAAA,0BAAiB,EACpC,OAAO,CAAC,IAAI,EACZ,OAAO,CAAC,UAAU,EAClB,cAAc,CACf,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,8BAAe,EAAC,YAAY,CAAC,CAAC;IAErD,UAAU,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;IAEtE,MAAM,mBAAmB,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEhE,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,IAAA,sCAAuB,EAAC,mBAAmB,CAAC,CAAC;IACrD,CAAC;IAED,IAAA,+BAAgB,EAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC;AACtD,CAAC,CAAA,CAAC;AAhCW,QAAA,oBAAoB,wBAgC/B"}

package/src/executors/deploy/schema.d.ts

@@ -4,4 +4,5 @@ export interface DeployExecutorOptions {
   verify: boolean;
   interactive: boolean;
   verbose: boolean;
+  manifestTransform?: string;
 }

package/src/executors/deploy/schema.json

@@ -33,6 +33,10 @@
       "description": "Run deployment in verbose mode.",
       "alias": "v",
       "default": false
+    },
+    "manifestTransform": {
+      "type": "string",
+      "description": "A JSONata expression that transforms the manifest.yml content before the deployment."
     }
   },
   "required": ["outputPath"]

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

@@ -1,5 +1,6 @@
 import { ManifestSchema } from '@forge/manifest';
-export declare function readManifestYml(path: string): Promise<ManifestSchema>;
+export declare const validateManifestContent: (manifestContent: ManifestSchema) => Promise<ManifestSchema>;
+export declare const readManifestYml: (path: string) => 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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractCustomUIProjectNames = exports.writeManifestYml = exports.readManifestYml = void 0;
+exports.extractCustomUIProjectNames = exports.writeManifestYml = exports.readManifestYml = exports.validateManifestContent = void 0;
 const tslib_1 = require("tslib");
 const manifest_1 = require("@forge/manifest");
 const FULL_SCHEMA = tslib_1.__importStar(require("@forge/manifest/out/schema/manifest-schema.json"));
@@ -15,23 +15,28 @@ class ManifestYmlValidator extends manifest_1.AbstractValidationProcessor {
         ]);
     }
 }
-function readManifestYml(path) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const { manifestObject, success: isManifestParseSuccess, errors, } = yield new ManifestYmlValidator().process(path);
-        if (!isManifestParseSuccess ||
-            !manifestObject ||
-            !manifestObject.typedContent) {
-            throw new Error(`Failed to parse manifest.yml (${path}): ${(errors || [])
-                .map((e) => e.message)
-                .join('\n')}`);
-        }
-        const manifestSchema = manifestObject.typedContent;
-        if (!manifestSchema) {
-            throw new Error('Manifest parse result did not return any content.');
-        }
-        return manifestSchema;
-    });
-}
+const schemaAndFileValidator = (manifestFilePath) => new ManifestYmlValidator().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);
+    if (!isManifestParseSuccess ||
+        !manifestObject ||
+        !manifestObject.typedContent) {
+        throw new Error(`Failed to validate manifest input: ${(errors || [])
+            .map((e) => e.message)
+            .join('\n')}`);
+    }
+    const manifestSchema = manifestObject.typedContent;
+    if (!manifestSchema) {
+        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);
 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,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;AACD,SAAsB,eAAe,CAAC,IAAY;;QAChD,MAAM,EACJ,cAAc,EACd,OAAO,EAAE,sBAAsB,EAC/B,MAAM,GACP,GAAG,MAAM,IAAI,oBAAoB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEnD,IACE,CAAC,sBAAsB;YACvB,CAAC,cAAc;YACf,CAAC,cAAc,CAAC,YAAY,EAC5B,CAAC;YACD,MAAM,IAAI,KAAK,CACb,iCAAiC,IAAI,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;iBACtD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;iBACrB,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;QACJ,CAAC;QAED,MAAM,cAAc,GAAmB,cAAc,CAAC,YAAY,CAAC;QAEnE,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;CAAA;AA1BD,0CA0BC;AAED;;;;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,2BAA2B,GAAG,CACzC,QAAwB,EACd,EAAE;IACZ,OAAO,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACvD,CAAC,CAAC;AAJW,QAAA,2BAA2B,+BAItC"}
+{"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;AAGnC,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,IACE,CAAC,sBAAsB;QACvB,CAAC,cAAc;QACf,CAAC,cAAc,CAAC,YAAY,EAC5B,CAAC;QACD,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,2BAA2B,GAAG,CACzC,QAAwB,EACd,EAAE;IACZ,OAAO,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACvD,CAAC,CAAC;AAJW,QAAA,2BAA2B,+BAItC"}