@contentful/create-contentful-app 1.18.7-alpha.0 → 1.18.7

package/README.md

@@ -95,6 +95,7 @@ Options:
   -e, --example <example-name>                  bootstrap an example app from https://github.com/contentful/apps/tree/master/examples
   -s, --source <url>                            provide a template by its source repository.
                                                 format: URL (HTTPS or SSH) or vendor:user/repo (e.g., github:user/repo)
+  -a, --actions                                 includes a hosted app action in ts or js template
   -f, --function <function-template-name>       include the specified function template
   -h, --help                                    shows all available CLI options
 ```

package/lib/getTemplateSource.js

@@ -86,7 +86,7 @@ async function makeContentfulExampleSource(options) {
     if (options.typescript) {
         return selectTemplate(types_1.ContentfulExample.Typescript);
     }
-    if (options.function) {
+    if (options.function || options.action) {
         return selectTemplate(types_1.ContentfulExample.Typescript);
     }
     return await promptExampleSelection();

package/lib/includeAppAction.js

@@ -0,0 +1,70 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptIncludeActionInTemplate = exports.cloneAppAction = void 0;
+const inquirer_1 = __importDefault(require("inquirer"));
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const constants_1 = require("./constants");
+const tiged_1 = __importDefault(require("tiged"));
+const logger_1 = require("./logger");
+const package_1 = require("./utils/package");
+const file_1 = require("./utils/file");
+const addBuildCommand = (0, package_1.getAddBuildCommandFn)({
+    name: 'build:actions',
+    command: 'node build-actions.js',
+});
+async function cloneAppAction(destination, templateIsJavascript) {
+    try {
+        console.log((0, logger_1.highlight)('---- Cloning hosted app action.'));
+        // Clone the app actions template to the created directory under the folder 'actions'
+        const templateSource = (0, path_1.join)('contentful/apps/examples/hosted-app-action-templates', templateIsJavascript ? 'javascript' : 'typescript');
+        const appActionDirectoryPath = (0, path_1.resolve)(`${destination}/actions`);
+        const d = await (0, tiged_1.default)(templateSource, { mode: 'tar', disableCache: true });
+        await d.clone(appActionDirectoryPath);
+        // move the manifest from the actions folder to the root folder
+        const writeAppManifest = await (0, file_1.mergeJsonIntoFile)({
+            source: `${appActionDirectoryPath}/${constants_1.CONTENTFUL_APP_MANIFEST}`,
+            destination: `${destination}/${constants_1.CONTENTFUL_APP_MANIFEST}`,
+        });
+        // move the build file from the actions folder to the root folder
+        const copyBuildFile = await (0, promises_1.rename)(`${appActionDirectoryPath}/build-actions.js`, `${destination}/build-actions.js`);
+        // modify package.json build commands
+        const packageJsonLocation = (0, path_1.resolve)(`${destination}/package.json`);
+        const packageJsonExists = await (0, file_1.exists)(packageJsonLocation);
+        if (!packageJsonExists) {
+            console.error(`Failed to add app action build commands: ${packageJsonLocation} does not exist.`);
+            return;
+        }
+        const writeBuildCommand = await (0, file_1.mergeJsonIntoFile)({
+            source: `${appActionDirectoryPath}/package.json`,
+            destination: packageJsonLocation,
+            mergeFn: addBuildCommand,
+        });
+        await Promise.all([writeAppManifest, copyBuildFile, writeBuildCommand]);
+        await d.remove(appActionDirectoryPath, destination, { action: 'remove', files: constants_1.IGNORED_CLONED_FILES.map(fileName => `${appActionDirectoryPath}/${fileName}`) });
+    }
+    catch (e) {
+        console.log(e);
+        process.exit(1);
+    }
+}
+exports.cloneAppAction = cloneAppAction;
+const promptIncludeActionInTemplate = async ({ fullAppFolder, templateSource, }) => {
+    const { includeAppAction } = await inquirer_1.default.prompt([
+        {
+            name: 'includeAppAction',
+            message: 'Do you want to include a hosted app action?',
+            type: 'confirm',
+            default: false,
+        },
+    ]);
+    // put app action into the template
+    if (includeAppAction) {
+        const templateIsTypescript = templateSource.includes('typescript');
+        cloneAppAction(fullAppFolder, templateIsTypescript);
+    }
+};
+exports.promptIncludeActionInTemplate = promptIncludeActionInTemplate;

package/lib/index.js

@@ -18,6 +18,7 @@ const chalk_1 = __importDefault(require("chalk"));
 const constants_1 = require("./constants");
 const getTemplateSource_1 = require("./getTemplateSource");
 const analytics_1 = require("./analytics");
+const includeAppAction_1 = require("./includeAppAction");
 const includeFunction_1 = require("./includeFunction");
 const DEFAULT_APP_NAME = 'contentful-app';
 function successMessage(folder, useYarn) {
@@ -86,7 +87,8 @@ async function initProject(appName, options) {
             !normalizedOptions.source &&
             !normalizedOptions.javascript &&
             !normalizedOptions.typescript &&
-            !normalizedOptions.function;
+            !normalizedOptions.function &&
+            !normalizedOptions.action;
         const templateSource = await (0, getTemplateSource_1.getTemplateSource)(options);
         (0, analytics_1.track)({
             template: templateSource,
@@ -94,6 +96,9 @@ async function initProject(appName, options) {
             interactive: isInteractive,
         });
         await (0, template_1.cloneTemplateIn)(fullAppFolder, templateSource);
+        if (!isInteractive && (0, utils_1.isContentfulTemplate)(templateSource) && normalizedOptions.action) {
+            await (0, includeAppAction_1.cloneAppAction)(fullAppFolder, !!normalizedOptions.javascript);
+        }
         if (!isInteractive && (0, utils_1.isContentfulTemplate)(templateSource) && normalizedOptions.function) {
             // If function flag is specified, but no function name is provided, we default to external-references
             // for legacy support

package/lib/utils.js

@@ -55,12 +55,14 @@ function normalizeOptions(options) {
         delete normalizedOptions.example;
         delete normalizedOptions.typescript;
         delete normalizedOptions.javascript;
+        delete normalizedOptions.action;
         delete normalizedOptions.function;
     }
     if (normalizedOptions.example) {
         fallbackOption = '--example';
         delete normalizedOptions.typescript;
         delete normalizedOptions.javascript;
+        delete normalizedOptions.action;
         delete normalizedOptions.function;
     }
     if (normalizedOptions.typescript) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/create-contentful-app",
-  "version": "1.18.7-alpha.0",
+  "version": "1.18.7",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -14,8 +14,8 @@
     "directory": "packages/contentful--create-contentful-app"
   },
   "engines": {
-    "node": ">=18",
-    "npm": ">=9"
+    "node": ">=14.15.0",
+    "npm": ">=6"
   },
   "main": "lib/index.js",
   "lint-staged": {
@@ -36,7 +36,7 @@
     "test": "mocha 'test/**/*.spec.{js,ts}'"
   },
   "dependencies": {
-    "@contentful/app-scripts": "^2.1.2",
+    "@contentful/app-scripts": "2.1.3",
     "@segment/analytics-node": "^2.2.0",
     "chalk": "4.1.2",
     "commander": "12.1.0",
@@ -74,11 +74,11 @@
     "@types/validate-npm-package-name": "4.0.2",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
-    "contentful-management": "11.47.3",
+    "contentful-management": "11.48.0",
     "mocha": "^10.2.0",
     "sinon": "^19.0.0",
     "sinon-chai": "^3.7.0",
     "ts-node": "^10.9.2"
   },
-  "gitHead": "006fbdd907070e3f3b251876a499a97bf7fffd6f"
+  "gitHead": "19544e247831ead71d56506298ed3335aa852d4a"
 }