@toolsplus/nx-forge 1.0.0

package/README.md

@@ -0,0 +1,11 @@
+# forge
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build forge` to build the library.
+
+## Running unit tests
+
+Run `nx test forge` to execute the unit tests via [Jest](https://jestjs.io).

package/executors.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "executors": {
+    "build": {
+      "implementation": "./src/executors/build/executor",
+      "schema": "./src/executors/build/schema.json",
+      "description": "build executor"
+    },
+    "deploy": {
+      "implementation": "./src/executors/deploy/executor",
+      "schema": "./src/executors/deploy/schema.json",
+      "description": "deploy executor"
+    }
+  }
+}

package/generators.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "name": "forge",
+  "version": "0.0.1",
+  "generators": {
+    "application": {
+      "factory": "./src/generators/application/generator",
+      "schema": "./src/generators/application/schema.json",
+      "description": "Create a Atlassian Forge application.",
+      "x-type": "application",
+      "aliases": ["app"]
+    },
+    "init": {
+      "factory": "./src/generators/init/generator",
+      "schema": "./src/generators/init/schema.json",
+      "description": "Initialize the @toolsplus/nx-forge plugin.",
+      "hidden": true
+    }
+  }
+}

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@toolsplus/nx-forge",
+  "version": "1.0.0",
+  "description": "Atlassian Forge plugin for Nx",
+  "main": "src/index.js",
+  "generators": "./generators.json",
+  "executors": "./executors.json",
+  "peerDependencies": {
+    "@nrwl/js": "^13.9.4",
+    "@nrwl/workspace": "^13.9.4"
+  },
+  "typings": "./src/index.d.ts",
+  "dependencies": {
+    "fs-extra": "^10.0.1",
+    "@forge/manifest": "^3.4.0",
+    "js-yaml": "^4.1.0"
+  }
+}

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

@@ -0,0 +1,5 @@
+import type { ExecutorContext } from '@nrwl/devkit';
+import { BuildExecutorOptions } from './schema';
+export default function runExecutor(rawOptions: BuildExecutorOptions, context: ExecutorContext): Promise<{
+    success: boolean;
+}>;

package/src/executors/build/executor.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const normalize_options_1 = require("./lib/normalize-options");
+const process_custom_ui_dependencies_1 = require("./lib/process-custom-ui-dependencies");
+const patch_manifest_yml_1 = require("./lib/patch-manifest-yml");
+const compile_typescript_1 = require("./lib/compile-typescript");
+const generate_package_json_1 = require("./lib/generate-package-json");
+const project_graph_1 = require("@nrwl/workspace/src/core/project-graph");
+function runExecutor(rawOptions, context) {
+    var e_1, _a;
+    return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        const { root, sourceRoot } = context.workspace.projects[context.projectName];
+        if (!sourceRoot) {
+            throw new Error(`${context.projectName} does not have a sourceRoot.`);
+        }
+        if (!root) {
+            throw new Error(`${context.projectName} does not have a root.`);
+        }
+        const options = (0, normalize_options_1.normalizeOptions)(rawOptions, context.root, sourceRoot, root);
+        const compilation = (0, compile_typescript_1.compileTypescript)(options, context);
+        try {
+            for (var compilation_1 = (0, tslib_1.__asyncValues)(compilation), compilation_1_1; compilation_1_1 = yield compilation_1.next(), !compilation_1_1.done;) {
+                const result = compilation_1_1.value;
+                if (!result.success) {
+                    throw new Error(`Failed to compile Typescript files for project ${context.projectName}.`);
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (compilation_1_1 && !compilation_1_1.done && (_a = compilation_1.return)) yield _a.call(compilation_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        (0, process_custom_ui_dependencies_1.processCustomUIDependencies)(options, context);
+        (0, patch_manifest_yml_1.patchManifestYml)(options);
+        (0, generate_package_json_1.generatePackageJson)(context.projectName, (0, project_graph_1.readCachedProjectGraph)(), options);
+        console.log('Executor ran for build');
+        return {
+            success: true,
+        };
+    });
+}
+exports.default = runExecutor;
+//# sourceMappingURL=executor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../../../../../packages/forge/src/executors/build/executor.ts"],"names":[],"mappings":";;;AAEA,+DAA2D;AAC3D,yFAAmF;AACnF,iEAA4D;AAC5D,iEAA6D;AAC7D,uEAAkE;AAClE,0EAAgF;AAEhF,SAA8B,WAAW,CACvC,UAAgC,EAChC,OAAwB;;;QAExB,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAE7E,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,CAAC,WAAW,8BAA8B,CAAC,CAAC;SACvE;QAED,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,CAAC,WAAW,wBAAwB,CAAC,CAAC;SACjE;QAED,MAAM,OAAO,GAAG,IAAA,oCAAgB,EAAC,UAAU,EAAE,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,WAAW,GAAG,IAAA,sCAAiB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;;YAExD,KAA2B,IAAA,gBAAA,2BAAA,WAAW,CAAA,iBAAA;gBAA3B,MAAM,MAAM,wBAAA,CAAA;gBACrB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;oBACnB,MAAM,IAAI,KAAK,CACb,kDAAkD,OAAO,CAAC,WAAW,GAAG,CACzE,CAAC;iBACH;aACF;;;;;;;;;QAED,IAAA,4DAA2B,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9C,IAAA,qCAAgB,EAAC,OAAO,CAAC,CAAC;QAC1B,IAAA,2CAAmB,EAAC,OAAO,CAAC,WAAW,EAAE,IAAA,sCAAsB,GAAE,EAAE,OAAO,CAAC,CAAC;QAE5E,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACtC,OAAO;YACL,OAAO,EAAE,IAAI;SACd,CAAC;;CACH;AAjCD,8BAiCC"}

package/src/executors/build/lib/compile-typescript.d.ts

@@ -0,0 +1,6 @@
+import { ExecutorContext } from '@nrwl/devkit';
+import { NormalizedOptions } from '../schema';
+export declare function compileTypescript(options: NormalizedOptions, context: ExecutorContext): AsyncGenerator<{
+    success: boolean;
+    outfile: string;
+}>;

package/src/executors/build/lib/compile-typescript.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compileTypescript = void 0;
+const devkit_1 = require("@nrwl/devkit");
+const tsc_impl_1 = require("@nrwl/js/src/executors/tsc/tsc.impl");
+function compileTypescript(options, context) {
+    const tscOptions = {
+        outputPath: (0, devkit_1.joinPathFragments)('dist', options.projectRoot),
+        tsConfig: `${options.projectRoot}/tsconfig.app.json`,
+        updateBuildableProjectDepsInPackageJson: false,
+        main: `${options.projectRoot}/src/index.ts`,
+        assets: [
+            `${options.projectRoot}/*.md`,
+            `${options.projectRoot}/manifest.yml`,
+        ],
+        watch: options.watch,
+        transformers: [],
+    };
+    return (0, tsc_impl_1.tscExecutor)(tscOptions, context);
+}
+exports.compileTypescript = compileTypescript;
+//# sourceMappingURL=compile-typescript.js.map

package/src/executors/build/lib/compile-typescript.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compile-typescript.js","sourceRoot":"","sources":["../../../../../../../packages/forge/src/executors/build/lib/compile-typescript.ts"],"names":[],"mappings":";;;AAAA,yCAAkE;AAElE,kEAAkE;AAGlE,SAAgB,iBAAiB,CAC/B,OAA0B,EAC1B,OAAwB;IAKxB,MAAM,UAAU,GAAuB;QACrC,UAAU,EAAE,IAAA,0BAAiB,EAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC;QAC1D,QAAQ,EAAE,GAAG,OAAO,CAAC,WAAW,oBAAoB;QACpD,uCAAuC,EAAE,KAAK;QAC9C,IAAI,EAAE,GAAG,OAAO,CAAC,WAAW,eAAe;QAC3C,MAAM,EAAE;YACN,GAAG,OAAO,CAAC,WAAW,OAAO;YAC7B,GAAG,OAAO,CAAC,WAAW,eAAe;SACtC;QACD,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,YAAY,EAAE,EAAE;KACjB,CAAC;IAEF,OAAO,IAAA,sBAAW,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAC1C,CAAC;AArBD,8CAqBC"}

package/src/executors/build/lib/copy-forge-app-files.d.ts

@@ -0,0 +1,2 @@
+import { NormalizedOptions } from '../schema';
+export declare function copyForgeAppFiles(options: NormalizedOptions): void;

package/src/executors/build/lib/copy-forge-app-files.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.copyForgeAppFiles = void 0;
+const fs_1 = require("fs");
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+const devkit_1 = require("@nrwl/devkit");
+const fileutils_1 = require("@nrwl/workspace/src/utilities/fileutils");
+function copyForgeAppFiles(options) {
+    devkit_1.logger.info('Copying Forge app files...');
+    if (!(0, fileutils_1.directoryExists)(options.outputPath)) {
+        (0, fs_1.mkdirSync)(options.outputPath, { recursive: true });
+    }
+    (0, fs_1.copyFileSync)((0, path_1.join)(options.root, options.projectRoot, 'manifest.yml'), (0, path_1.join)(options.outputPath, 'manifest.yml'));
+    (0, fs_1.copyFileSync)((0, path_1.join)(options.root, options.projectRoot, 'tsconfig.json'), (0, path_1.join)(options.outputPath, 'tsconfig.json'));
+    (0, fs_extra_1.copySync)((0, path_1.join)(options.root, options.sourceRoot), (0, path_1.join)(options.outputPath, 'src'), { recursive: true });
+    devkit_1.logger.info('Done copying Forge app files.');
+}
+exports.copyForgeAppFiles = copyForgeAppFiles;
+//# sourceMappingURL=copy-forge-app-files.js.map

package/src/executors/build/lib/copy-forge-app-files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copy-forge-app-files.js","sourceRoot":"","sources":["../../../../../../../packages/forge/src/executors/build/lib/copy-forge-app-files.ts"],"names":[],"mappings":";;;AAAA,2BAA6C;AAC7C,uCAAoC;AACpC,+BAA4B;AAC5B,yCAAsC;AACtC,uEAA0E;AAG1E,SAAgB,iBAAiB,CAAC,OAA0B;IAC1D,eAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAE1C,IAAI,CAAC,IAAA,2BAAe,EAAC,OAAO,CAAC,UAAU,CAAC,EAAE;QACxC,IAAA,cAAS,EAAC,OAAO,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;KACpD;IAED,IAAA,iBAAY,EACV,IAAA,WAAI,EAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,cAAc,CAAC,EACvD,IAAA,WAAI,EAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,CACzC,CAAC;IACF,IAAA,iBAAY,EACV,IAAA,WAAI,EAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,eAAe,CAAC,EACxD,IAAA,WAAI,EAAC,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,CAC1C,CAAC;IACF,IAAA,mBAAQ,EACN,IAAA,WAAI,EAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,EACtC,IAAA,WAAI,EAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,EAC/B,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB,CAAC;IAEF,eAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;AAC/C,CAAC;AAtBD,8CAsBC"}

package/src/executors/build/lib/generate-package-json.d.ts

@@ -0,0 +1,11 @@
+import type { ProjectGraph } from '@nrwl/devkit';
+import { NormalizedOptions } from '../schema';
+/**
+ * Merges the existing package.json details with a generated package.json that includes
+ * all required dependencies.
+ *
+ * @param projectName Name of the project
+ * @param graph Graph associated with the project
+ * @param options Builder options
+ */
+export declare function generatePackageJson(projectName: string, graph: ProjectGraph, options: NormalizedOptions): void;

package/src/executors/build/lib/generate-package-json.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatePackageJson = void 0;
+const devkit_1 = require("@nrwl/devkit");
+const create_package_json_1 = require("@nrwl/workspace/src/utilities/create-package-json");
+/**
+ * Merges the existing package.json details with a generated package.json that includes
+ * all required dependencies.
+ *
+ * @param projectName Name of the project
+ * @param graph Graph associated with the project
+ * @param options Builder options
+ */
+function generatePackageJson(projectName, graph, options) {
+    var _a;
+    const packageJson = (0, create_package_json_1.createPackageJson)(projectName, graph, options);
+    packageJson.main = (_a = packageJson.main) !== null && _a !== void 0 ? _a : options.outputFileName;
+    delete packageJson.devDependencies;
+    (0, devkit_1.writeJsonFile)(`${options.outputPath}/package.json`, packageJson);
+}
+exports.generatePackageJson = generatePackageJson;
+//# sourceMappingURL=generate-package-json.js.map

package/src/executors/build/lib/generate-package-json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-package-json.js","sourceRoot":"","sources":["../../../../../../../packages/forge/src/executors/build/lib/generate-package-json.ts"],"names":[],"mappings":";;;AACA,yCAA6C;AAC7C,2FAAsF;AAGtF;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,WAAmB,EACnB,KAAmB,EACnB,OAA0B;;IAE1B,MAAM,WAAW,GAAG,IAAA,uCAAiB,EAAC,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACnE,WAAW,CAAC,IAAI,GAAG,MAAA,WAAW,CAAC,IAAI,mCAAI,OAAO,CAAC,cAAc,CAAC;IAC9D,OAAO,WAAW,CAAC,eAAe,CAAC;IACnC,IAAA,sBAAa,EAAC,GAAG,OAAO,CAAC,UAAU,eAAe,EAAE,WAAW,CAAC,CAAC;AACnE,CAAC;AATD,kDASC"}

package/src/executors/build/lib/load-manifest-yml.d.ts

@@ -0,0 +1,2 @@
+import { ManifestSchema } from '@forge/manifest';
+export declare function loadManifestYml(manifestPath: string): ManifestSchema;

package/src/executors/build/lib/load-manifest-yml.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadManifestYml = void 0;
+const manifest_1 = require("@forge/manifest");
+const FULL_SCHEMA = require("@forge/manifest/out/schema/manifest-schema.json");
+function loadManifestYml(manifestPath) {
+    const { manifestObject, success: isManifestParseSuccess, errors, } = new ManifestYmlValidator().process(manifestPath);
+    if (!isManifestParseSuccess) {
+        throw new Error(`Failed to parse manifest.yml (${manifestPath}): ${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;
+}
+exports.loadManifestYml = loadManifestYml;
+class ManifestYmlValidator extends manifest_1.AbstractValidationProcessor {
+    constructor() {
+        super([
+            new manifest_1.FileValidator(),
+            new manifest_1.YamlValidator(),
+            new manifest_1.SchemaValidator(FULL_SCHEMA),
+        ]);
+    }
+}
+//# sourceMappingURL=load-manifest-yml.js.map

package/src/executors/build/lib/load-manifest-yml.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load-manifest-yml.js","sourceRoot":"","sources":["../../../../../../../packages/forge/src/executors/build/lib/load-manifest-yml.ts"],"names":[],"mappings":";;;AAAA,8CAMyB;AACzB,+EAA+E;AAE/E,SAAgB,eAAe,CAAC,YAAoB;IAClD,MAAM,EACJ,cAAc,EACd,OAAO,EAAE,sBAAsB,EAC/B,MAAM,GACP,GAAG,IAAI,oBAAoB,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAErD,IAAI,CAAC,sBAAsB,EAAE;QAC3B,MAAM,IAAI,KAAK,CACb,iCAAiC,YAAY,MAAM,MAAM;aACtD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACrB,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;KACH;IAED,MAAM,cAAc,GAAmB,cAAc,CAAC,YAAY,CAAC;IAEnE,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;KACtE;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAtBD,0CAsBC;AAED,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"}

package/src/executors/build/lib/normalize-options.d.ts

@@ -0,0 +1,2 @@
+import type { BuildExecutorOptions, NormalizedOptions } from '../schema';
+export declare function normalizeOptions(options: BuildExecutorOptions, root: string, sourceRoot: string, projectRoot: string): NormalizedOptions;

package/src/executors/build/lib/normalize-options.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeOptions = void 0;
+const path_1 = require("path");
+function normalizeOptions(options, root, sourceRoot, projectRoot) {
+    var _a, _b;
+    return Object.assign(Object.assign({}, options), { root,
+        sourceRoot,
+        projectRoot, customUIPath: (_a = options.customUIPath) !== null && _a !== void 0 ? _a : 'customUI', outputPath: (0, path_1.resolve)(root, options.outputPath), outputFileName: 'index.js', watch: (_b = options.watch) !== null && _b !== void 0 ? _b : false });
+}
+exports.normalizeOptions = normalizeOptions;
+//# sourceMappingURL=normalize-options.js.map

package/src/executors/build/lib/normalize-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-options.js","sourceRoot":"","sources":["../../../../../../../packages/forge/src/executors/build/lib/normalize-options.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAG/B,SAAgB,gBAAgB,CAC9B,OAA6B,EAC7B,IAAY,EACZ,UAAkB,EAClB,WAAmB;;IAEnB,uCACK,OAAO,KACV,IAAI;QACJ,UAAU;QACV,WAAW,EACX,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,UAAU,EAChD,UAAU,EAAE,IAAA,cAAO,EAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,EAC7C,cAAc,EAAE,UAAU,EAC1B,KAAK,EAAE,MAAA,OAAO,CAAC,KAAK,mCAAI,KAAK,IAC7B;AACJ,CAAC;AAhBD,4CAgBC"}

package/src/executors/build/lib/patch-manifest-yml.d.ts

@@ -0,0 +1,10 @@
+import { NormalizedOptions } from '../schema';
+/**
+ * Patches the output manifest.yml file to replace resource path parameters to point to the actual Custom UI build
+ * artifacts instead of the Nx project reference.
+ *
+ * This assumes that Custom UI artifacts have already been copied to the output directory in a previous step.
+ *
+ * @param options Executor options
+ */
+export declare function patchManifestYml(options: NormalizedOptions): void;

package/src/executors/build/lib/patch-manifest-yml.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patchManifestYml = void 0;
+const fs_1 = require("fs");
+const js_yaml_1 = require("js-yaml");
+const devkit_1 = require("@nrwl/devkit");
+const load_manifest_yml_1 = require("./load-manifest-yml");
+/**
+ * Patches the output manifest.yml file to replace resource path parameters to point to the actual Custom UI build
+ * artifacts instead of the Nx project reference.
+ *
+ * This assumes that Custom UI artifacts have already been copied to the output directory in a previous step.
+ *
+ * @param options Executor options
+ */
+function patchManifestYml(options) {
+    const manifestPath = (0, devkit_1.joinPathFragments)(options.outputPath, 'manifest.yml');
+    devkit_1.logger.info(`Patching ${manifestPath}...`);
+    const manifestSchema = (0, load_manifest_yml_1.loadManifestYml)(manifestPath);
+    const resources = manifestSchema.resources || [];
+    const patchedManifest = Object.assign(Object.assign({}, manifestSchema), { resources: resources.map((r) => patchResource(options.customUIPath, r)) });
+    const patchedManifestContent = (0, js_yaml_1.dump)(patchedManifest, {});
+    (0, fs_1.writeFileSync)(manifestPath, patchedManifestContent, { encoding: 'utf8' });
+    devkit_1.logger.info(`Done patching ${manifestPath}.`);
+}
+exports.patchManifestYml = patchManifestYml;
+function patchResource(customUIPath, resource) {
+    return Object.assign(Object.assign({}, resource), { path: `${customUIPath}/${resource.path}` });
+}
+//# sourceMappingURL=patch-manifest-yml.js.map

package/src/executors/build/lib/patch-manifest-yml.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch-manifest-yml.js","sourceRoot":"","sources":["../../../../../../../packages/forge/src/executors/build/lib/patch-manifest-yml.ts"],"names":[],"mappings":";;;AAAA,2BAAmC;AACnC,qCAA+B;AAC/B,yCAAyD;AAIzD,2DAAsD;AAEtD;;;;;;;GAOG;AACH,SAAgB,gBAAgB,CAAC,OAA0B;IACzD,MAAM,YAAY,GAAG,IAAA,0BAAiB,EAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAE3E,eAAM,CAAC,IAAI,CAAC,YAAY,YAAY,KAAK,CAAC,CAAC;IAE3C,MAAM,cAAc,GAAG,IAAA,mCAAe,EAAC,YAAY,CAAC,CAAC;IAErD,MAAM,SAAS,GAAc,cAAc,CAAC,SAAS,IAAI,EAAE,CAAC;IAC5D,MAAM,eAAe,mCAChB,cAAc,KACjB,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,GACxE,CAAC;IAEF,MAAM,sBAAsB,GAAG,IAAA,cAAI,EAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IACzD,IAAA,kBAAa,EAAC,YAAY,EAAE,sBAAsB,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAE1E,eAAM,CAAC,IAAI,CAAC,iBAAiB,YAAY,GAAG,CAAC,CAAC;AAChD,CAAC;AAjBD,4CAiBC;AAED,SAAS,aAAa,CACpB,YAAoB,EACpB,QAA+B;IAE/B,uCACK,QAAQ,KACX,IAAI,EAAE,GAAG,YAAY,IAAI,QAAQ,CAAC,IAAI,EAAE,IACxC;AACJ,CAAC"}

package/src/executors/build/lib/process-custom-ui-dependencies.d.ts

@@ -0,0 +1,16 @@
+import type { ExecutorContext } from '@nrwl/devkit';
+import { Resources } from '@forge/manifest';
+import { NormalizedOptions } from '../schema';
+/**
+ * Verifies that Custom UI projects are correctly linked to the Nx Forge app and copies build artifacts into the app's
+ * output directory.
+ *
+ * In particular this will make sure that each resource listed in the manifest.yml has its path configured to point to
+ * a Nx project in this workspace. Additionally, this will ensure that each specified Custom UI project is listed as an
+ * implicit dependency of the project. This requirement ensures that Custom UI dependencies are being built before the
+ * Forge app is being built.
+ *
+ * @param options Executor options
+ * @param context Executor context
+ */
+export declare function processCustomUIDependencies(options: NormalizedOptions, context: ExecutorContext): Resources;

package/src/executors/build/lib/process-custom-ui-dependencies.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processCustomUIDependencies = void 0;
+const fs_extra_1 = require("fs-extra");
+const fs_1 = require("fs");
+const devkit_1 = require("@nrwl/devkit");
+const load_manifest_yml_1 = require("./load-manifest-yml");
+/**
+ * Verifies that Custom UI projects are correctly linked to the Nx Forge app and copies build artifacts into the app's
+ * output directory.
+ *
+ * In particular this will make sure that each resource listed in the manifest.yml has its path configured to point to
+ * a Nx project in this workspace. Additionally, this will ensure that each specified Custom UI project is listed as an
+ * implicit dependency of the project. This requirement ensures that Custom UI dependencies are being built before the
+ * Forge app is being built.
+ *
+ * @param options Executor options
+ * @param context Executor context
+ */
+function processCustomUIDependencies(options, context) {
+    const manifestPath = (0, devkit_1.joinPathFragments)(context.root, 'apps', context.projectName, 'manifest.yml');
+    const manifestSchema = (0, load_manifest_yml_1.loadManifestYml)(manifestPath);
+    const resources = manifestSchema.resources || [];
+    resources.forEach((r) => verifyAndCopyCustomUIDependency(r, context, options));
+    return resources;
+}
+exports.processCustomUIDependencies = processCustomUIDependencies;
+const verifyAndCopyCustomUIDependency = (resource, context, options) => {
+    var _a, _b, _c;
+    const customUIProjectName = resource.path;
+    const customUIProjectConfiguration = context.workspace.projects[customUIProjectName];
+    if (!customUIProjectConfiguration) {
+        throw new Error(`Nx workspace is missing project for CustomUI path ${customUIProjectName}. Make sure the Custom UI resource path references a project in your Nx workspace.`);
+    }
+    if (!((_a = context.workspace.projects[context.projectName].implicitDependencies) === null || _a === void 0 ? void 0 : _a.includes(customUIProjectName))) {
+        throw new Error(`Project ${customUIProjectName} is configured as Forge Custom UI resource but not listed as implicit dependency of the Forge project (${context.projectName}). Add ${customUIProjectName} to the 'implicitDependencies' array in this project's 'project.json', or remove the Custom UI resource from the app's manifest.yml.`);
+    }
+    const customUIBuildTargetOutputPath = (_c = (_b = customUIProjectConfiguration.targets['build']) === null || _b === void 0 ? void 0 : _b.options) === null || _c === void 0 ? void 0 : _c.outputPath;
+    const absoluteCustomUIBuildTargetOutputPath = (0, devkit_1.joinPathFragments)(context.root, customUIBuildTargetOutputPath);
+    if (!customUIBuildTargetOutputPath ||
+        !(0, fs_1.existsSync)(absoluteCustomUIBuildTargetOutputPath) ||
+        (0, fs_1.readdirSync)(absoluteCustomUIBuildTargetOutputPath).length === 0) {
+        throw new Error(`Project ${customUIProjectName} is missing build artifacts. Make sure the project produces Custom UI compatible build artifacts.`);
+    }
+    devkit_1.logger.info(`Copying ${customUIProjectName} Custom UI build artifacts...`);
+    (0, fs_extra_1.copySync)(absoluteCustomUIBuildTargetOutputPath, (0, devkit_1.joinPathFragments)(options.outputPath, options.customUIPath, customUIProjectName), { recursive: true });
+    devkit_1.logger.info(`Done copying ${customUIProjectName} Custom UI build artifacts.`);
+};
+//# sourceMappingURL=process-custom-ui-dependencies.js.map

package/src/executors/build/lib/process-custom-ui-dependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-custom-ui-dependencies.js","sourceRoot":"","sources":["../../../../../../../packages/forge/src/executors/build/lib/process-custom-ui-dependencies.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AACpC,2BAA6C;AAE7C,yCAAyD;AAIzD,2DAAsD;AAEtD;;;;;;;;;;;GAWG;AACH,SAAgB,2BAA2B,CACzC,OAA0B,EAC1B,OAAwB;IAExB,MAAM,YAAY,GAAG,IAAA,0BAAiB,EACpC,OAAO,CAAC,IAAI,EACZ,MAAM,EACN,OAAO,CAAC,WAAW,EACnB,cAAc,CACf,CAAC;IACF,MAAM,cAAc,GAAG,IAAA,mCAAe,EAAC,YAAY,CAAC,CAAC;IACrD,MAAM,SAAS,GAAc,cAAc,CAAC,SAAS,IAAI,EAAE,CAAC;IAE5D,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CACtB,+BAA+B,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CACrD,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AAlBD,kEAkBC;AAED,MAAM,+BAA+B,GAAG,CACtC,QAA+B,EAC/B,OAAwB,EACxB,OAA0B,EACpB,EAAE;;IACR,MAAM,mBAAmB,GAAG,QAAQ,CAAC,IAAI,CAAC;IAE1C,MAAM,4BAA4B,GAChC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAElD,IAAI,CAAC,4BAA4B,EAAE;QACjC,MAAM,IAAI,KAAK,CACb,qDAAqD,mBAAmB,oFAAoF,CAC7J,CAAC;KACH;IAED,IACE,CAAC,CAAA,MAAA,OAAO,CAAC,SAAS,CAAC,QAAQ,CACzB,OAAO,CAAC,WAAW,CACpB,CAAC,oBAAoB,0CAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAA,EACrD;QACA,MAAM,IAAI,KAAK,CACb,WAAW,mBAAmB,0GAA0G,OAAO,CAAC,WAAW,UAAU,mBAAmB,sIAAsI,CAC/T,CAAC;KACH;IAED,MAAM,6BAA6B,GACjC,MAAA,MAAA,4BAA4B,CAAC,OAAO,CAAC,OAAO,CAAC,0CAAE,OAAO,0CAAE,UAAU,CAAC;IACrE,MAAM,qCAAqC,GAAG,IAAA,0BAAiB,EAC7D,OAAO,CAAC,IAAI,EACZ,6BAA6B,CAC9B,CAAC;IAEF,IACE,CAAC,6BAA6B;QAC9B,CAAC,IAAA,eAAU,EAAC,qCAAqC,CAAC;QAClD,IAAA,gBAAW,EAAC,qCAAqC,CAAC,CAAC,MAAM,KAAK,CAAC,EAC/D;QACA,MAAM,IAAI,KAAK,CACb,WAAW,mBAAmB,mGAAmG,CAClI,CAAC;KACH;IAED,eAAM,CAAC,IAAI,CAAC,WAAW,mBAAmB,+BAA+B,CAAC,CAAC;IAC3E,IAAA,mBAAQ,EACN,qCAAqC,EACrC,IAAA,0BAAiB,EACf,OAAO,CAAC,UAAU,EAClB,OAAO,CAAC,YAAY,EACpB,mBAAmB,CACpB,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB,CAAC;IACF,eAAM,CAAC,IAAI,CAAC,gBAAgB,mBAAmB,6BAA6B,CAAC,CAAC;AAChF,CAAC,CAAC"}

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

@@ -0,0 +1,14 @@
+export interface BuildExecutorOptions {
+  customUIPath?: string;
+  outputPath: string;
+  watch: boolean;
+}
+
+export interface NormalizedOptions extends BuildExecutorOptions {
+  root: string;
+  sourceRoot: string;
+  projectRoot: string;
+  customUIPath: string;
+  outputPath: string;
+  outputFileName: string;
+}

package/src/executors/build/schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "cli": "nx",
+  "title": "Forge application build target",
+  "description": "Forge application build target options for Build Facade",
+  "type": "object",
+  "properties": {
+    "outputPath": {
+      "type": "string",
+      "description": "Output path of the generated files."
+    },
+    "customUIPath": {
+      "type": "string",
+      "description": "Custom UI output path relative to the outputPath."
+    },
+    "watch": {
+      "type": "boolean",
+      "description": "Enable re-building when files change.",
+      "default": false
+    }
+  },
+  "required": ["outputPath"]
+}

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

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

package/src/executors/deploy/executor.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const child_process_1 = require("child_process");
+const devkit_1 = require("@nrwl/devkit");
+function runExecutor(options) {
+    return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        const args = [
+            'deploy',
+            `--environment=${options.environment}`,
+            ...(options.verbose === true ? ['--verbose'] : []),
+            ...(options.verify === false ? ['--no-verify'] : []),
+            ...(options.interactive === false ? ['--non-interactive'] : []),
+        ];
+        const command = `forge deploy ${args.join(' ')}`;
+        devkit_1.logger.log(`Running: ${command}`);
+        // https://2ality.com/2018/05/child-process-streams.html#running-commands-in-child-processes
+        const deploymentProcess = (0, child_process_1.spawn)('forge', args, {
+            cwd: options.outputPath,
+            stdio: [process.stdin, process.stdout, process.stderr],
+        });
+        yield onExit(deploymentProcess);
+        devkit_1.logger.log('✅ Forge app deployed');
+        return {
+            success: true,
+        };
+    });
+}
+exports.default = runExecutor;
+// https://2ality.com/2018/05/child-process-streams.html#waiting-for-a-child-process-to-exit-via-a-promise
+function onExit(childProcess) {
+    return new Promise((resolve, reject) => {
+        childProcess.once('exit', (code) => {
+            if (code === 0) {
+                resolve(undefined);
+            }
+            else {
+                reject(new Error('Exit with error code: ' + code));
+            }
+        });
+        childProcess.once('error', (err) => {
+            reject(err);
+        });
+    });
+}
+//# sourceMappingURL=executor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../../../../../packages/forge/src/executors/deploy/executor.ts"],"names":[],"mappings":";;;AAAA,iDAAoD;AACpD,yCAAsC;AAGtC,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,MAAM,OAAO,GAAG,gBAAgB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACjD,eAAM,CAAC,GAAG,CAAC,YAAY,OAAO,EAAE,CAAC,CAAC;QAElC,4FAA4F;QAC5F,MAAM,iBAAiB,GAAG,IAAA,qBAAK,EAAC,OAAO,EAAE,IAAI,EAAE;YAC7C,GAAG,EAAE,OAAO,CAAC,UAAU;YACvB,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;SACvD,CAAC,CAAC;QACH,MAAM,MAAM,CAAC,iBAAiB,CAAC,CAAC;QAEhC,eAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CAAA;AAvBD,8BAuBC;AAED,0GAA0G;AAC1G,SAAS,MAAM,CAAC,YAA0B;IACxC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;YACzC,IAAI,IAAI,KAAK,CAAC,EAAE;gBACd,OAAO,CAAC,SAAS,CAAC,CAAC;aACpB;iBAAM;gBACL,MAAM,CAAC,IAAI,KAAK,CAAC,wBAAwB,GAAG,IAAI,CAAC,CAAC,CAAC;aACpD;QACH,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;YACxC,MAAM,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,7 @@
+export interface DeployExecutorOptions {
+  outputPath: string;
+  environment: 'development' | 'staging' | 'production';
+  verify: boolean;
+  interactive: boolean;
+  verbose: boolean;
+}

package/src/executors/deploy/schema.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "cli": "nx",
+  "title": "Forge application deploy target",
+  "description": "Forge application deploy target",
+  "type": "object",
+  "properties": {
+    "outputPath": {
+      "type": "string",
+      "description": "The output path of the Forge app files.",
+      "visible": false
+    },
+    "environment": {
+      "type": "string",
+      "enum": ["development", "staging", "production"],
+      "description": "Environment to deploy to: development, staging, production.",
+      "alias": "e",
+      "default": "development"
+    },
+    "verify": {
+      "type": "boolean",
+      "description": "Run pre-deployment checks.",
+      "default": true
+    },
+    "interactive": {
+      "type": "boolean",
+      "description": "Run deployment with or without input prompts.",
+      "default": true
+    },
+    "verbose": {
+      "type": "boolean",
+      "description": "Run deployment in verbose mode.",
+      "alias": "v",
+      "default": false
+    }
+  },
+  "required": ["outputPath"]
+}

package/src/generators/application/files/README.md

@@ -0,0 +1,35 @@
+# <%= name %>
+
+## Prerequisites
+
+Before you can start using this app with Forge make sure to initially build the app using
+
+    nx build <%= name %>
+
+After that, proceed with the initial registration of the app with the Forge platform by running the following commands from the dist directory:  
+
+    forge register
+    forge deploy
+    forge install
+
+
+This will initially register the app with the Forge platform, deploy the code and finally install the app on any of your Atlassian applications.
+
+## Dev loop
+
+When the app code changes, the updated code has to rebuilt by calling 
+
+    nx build <%= name %>
+
+and re-deployed to the Forge platform using
+
+    forge deploy
+
+If the app's `manifest.yml` changed, you may have to upgrade an existing installation by running
+
+    forge install --upgrade
+
+
+
+
+

package/src/generators/application/files/manifest.yml

@@ -0,0 +1,6 @@
+modules:
+  function:
+    - key: resolver
+      handler: index.handler
+app:
+  id: ari:cloud:ecosystem::app/to-be-generated

package/src/generators/application/files/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "<%= name %>",
+  "version": "0.0.0",
+  "main": "index.js",
+  "private": true
+}

package/src/generators/application/files/src/index.ts__tmpl__

@@ -0,0 +1,6 @@
+import Resolver from '@forge/resolver';
+
+const resolver = new Resolver();
+
+export const handler = resolver.getDefinitions();
+