@contentful/create-contentful-app 1.7.16 → 1.8.0

package/README.md

@@ -96,6 +96,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
   -h, --help                    shows all available CLI options
 ```
 

package/lib/app-actions/typescript/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = (payload) => __awaiter(void 0, void 0, void 0, function* () {
+    const { parameters } = payload;
+    const response = {
+        message: `Hello from your hosted app action. I received the following message as a paramater: ${JSON.stringify(parameters.message)} `,
+    };
+    return response;
+});

package/lib/constants.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEMPLATES = exports.EXAMPLES_REPO_URL = exports.CREATE_APP_DEFINITION_GUIDE_URL = void 0;
+exports.CONTENTFUL_APP_MANIFEST = exports.EXAMPLES_PATH = exports.TEMPLATES = exports.EXAMPLES_REPO_URL = exports.CREATE_APP_DEFINITION_GUIDE_URL = void 0;
 exports.CREATE_APP_DEFINITION_GUIDE_URL = 'https://ctfl.io/app-tutorial#embed-your-app-in-the-contentful-web-app';
 exports.EXAMPLES_REPO_URL = 'https://github.com/contentful/apps/tree/master/examples';
 exports.TEMPLATES = ['javascript', 'typescript', 'vue', 'vite-react', 'nextjs'];
+exports.EXAMPLES_PATH = 'contentful/apps/examples/';
+exports.CONTENTFUL_APP_MANIFEST = 'contentful-app-manifest.json';

package/lib/getTemplateSource.js

@@ -19,11 +19,8 @@ const chalk_1 = __importDefault(require("chalk"));
 const types_1 = require("./types");
 const logger_1 = require("./logger");
 const constants_1 = require("./constants");
+const utils_1 = require("./utils");
 const CONTENTFUL_APPS_EXAMPLE_FOLDER = 'https://api.github.com/repos/contentful/apps/contents/examples';
-const EXAMPLES_PATH = 'contentful/apps/examples/';
-function isContentfulTemplate(url) {
-    return Object.values(types_1.ContentfulExample).some((t) => url.includes(EXAMPLES_PATH + t));
-}
 function getGithubFolderNames() {
     return __awaiter(this, void 0, void 0, function* () {
         const response = yield (0, node_fetch_1.default)(CONTENTFUL_APPS_EXAMPLE_FOLDER);
@@ -88,7 +85,7 @@ function promptExampleSelection() {
 }
 function selectTemplate(template) {
     (0, logger_1.wrapInBlanks)((0, logger_1.highlight)(`---- Cloning the ${chalk_1.default.cyan(template)} template...`));
-    return EXAMPLES_PATH + template;
+    return constants_1.EXAMPLES_PATH + template;
 }
 function makeContentfulExampleSource(options) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -108,7 +105,7 @@ function getTemplateSource(options) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         const source = (_a = options.source) !== null && _a !== void 0 ? _a : (yield makeContentfulExampleSource(options));
-        if (options.source && !isContentfulTemplate(source)) {
+        if (options.source && !(0, utils_1.isContentfulTemplate)(source)) {
             (0, logger_1.warn)(`Template at ${(0, logger_1.highlight)(source)} is not an official Contentful app template!`);
         }
         return source;

package/lib/includeAppAction.js

@@ -0,0 +1,68 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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 fs_1 = require("fs");
+const path_1 = require("path");
+const constants_1 = require("./constants");
+function cloneAppAction(templateIsTypescript, destination) {
+    const actionPath = (0, path_1.resolve)(templateIsTypescript
+        ? 'src/app-actions/typescript/index.ts'
+        : 'src/app-actions/javascript/index.js');
+    const manifestPath = (0, path_1.resolve)(templateIsTypescript
+        ? `src/app-actions/typescript/${constants_1.CONTENTFUL_APP_MANIFEST}`
+        : `src/app-actions/javascript/${constants_1.CONTENTFUL_APP_MANIFEST}`);
+    // write the action
+    const appAction = (0, fs_1.readFileSync)(actionPath, { encoding: 'utf-8' }).toString();
+    const appActionDirectoryPath = `${destination}/actions`;
+    (0, fs_1.mkdirSync)(appActionDirectoryPath);
+    (0, fs_1.writeFileSync)(`${appActionDirectoryPath}/example${templateIsTypescript ? '.ts' : '.js'}`, appAction);
+    // write the manifest
+    const manifest = JSON.parse((0, fs_1.readFileSync)(manifestPath, { encoding: 'utf-8' }));
+    (0, fs_1.writeFileSync)(`${destination}/${constants_1.CONTENTFUL_APP_MANIFEST}`, JSON.stringify(manifest));
+    // write the build file if necessary
+    if (!templateIsTypescript) {
+        const buildFilePath = 'src/app-actions/javascript/build-actions.js';
+        const buildFile = (0, fs_1.readFileSync)(buildFilePath, { encoding: 'utf-8' }).toString();
+        (0, fs_1.writeFileSync)(`${destination}/build-actions.js`, buildFile);
+    }
+    // modify package.json build commands
+    const packageJsonLocation = `${destination}/package.json`;
+    const packageJsonExists = (0, fs_1.existsSync)(packageJsonLocation);
+    if (!packageJsonExists) {
+        console.error('Failed to add app action build commands.');
+        return;
+    }
+    const packageJson = JSON.parse((0, fs_1.readFileSync)(packageJsonLocation, { encoding: 'utf-8' }));
+    const updatedPackageJson = Object.assign(Object.assign({}, packageJson), { scripts: Object.assign(Object.assign({}, packageJson.scripts), { 'build-actions': `${templateIsTypescript ? 'tsc actions/*.ts --outDir build/actions' : 'node build-actions.js'}`, build: `${packageJson.scripts.build} && npm run build-actions` }) });
+    (0, fs_1.writeFileSync)(packageJsonLocation, JSON.stringify(updatedPackageJson, null, '  '));
+}
+exports.cloneAppAction = cloneAppAction;
+const promptIncludeActionInTemplate = ({ fullAppFolder, templateSource, }) => __awaiter(void 0, void 0, void 0, function* () {
+    const { includeAppAction } = yield 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(templateIsTypescript, fullAppFolder);
+    }
+});
+exports.promptIncludeActionInTemplate = promptIncludeActionInTemplate;

package/lib/index.js

@@ -27,6 +27,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 DEFAULT_APP_NAME = 'contentful-app';
 function successMessage(folder, useYarn) {
     console.log(`
@@ -95,10 +96,24 @@ function initProject(appName, options) {
             appName = yield validateAppName(appName);
             const fullAppFolder = (0, path_1.resolve)(process.cwd(), appName);
             console.log(`Creating a Contentful app in ${(0, logger_1.highlight)((0, tildify_1.default)(fullAppFolder))}.`);
-            const isInteractive = !normalizedOptions.example && !normalizedOptions.source && !normalizedOptions.javascript && !normalizedOptions.typescript;
+            const isInteractive = !normalizedOptions.example &&
+                !normalizedOptions.source &&
+                !normalizedOptions.javascript &&
+                !normalizedOptions.typescript;
             const templateSource = yield (0, getTemplateSource_1.getTemplateSource)(options);
-            (0, analytics_1.track)({ template: templateSource, manager: normalizedOptions.npm ? 'npm' : 'yarn', interactive: isInteractive });
+            (0, analytics_1.track)({
+                template: templateSource,
+                manager: normalizedOptions.npm ? 'npm' : 'yarn',
+                interactive: isInteractive,
+            });
             yield (0, template_1.cloneTemplateIn)(fullAppFolder, templateSource);
+            // Ask to include a hosted app action if the user has selected a template
+            if (isInteractive && (0, utils_1.isContentfulTemplate)(templateSource)) {
+                yield (0, includeAppAction_1.promptIncludeActionInTemplate)({ fullAppFolder, templateSource });
+            }
+            if (!isInteractive && (0, utils_1.isContentfulTemplate)(templateSource) && normalizedOptions.action) {
+                (0, includeAppAction_1.cloneAppAction)(!!normalizedOptions.typescript, fullAppFolder);
+            }
             updatePackageName(fullAppFolder);
             const useYarn = normalizedOptions.yarn || (0, utils_1.detectManager)() === 'yarn';
             (0, logger_1.wrapInBlanks)((0, logger_1.highlight)(`---- Installing the dependencies for your app (using ${chalk_1.default.cyan(useYarn ? 'yarn' : 'npm')})...`));
@@ -142,6 +157,7 @@ function initProject(appName, options) {
             `provide a template by its source repository.`,
             `format: URL (HTTPS or SSH) or ${(0, logger_1.code)('vendor:user/repo')} (e.g., ${(0, logger_1.code)('github:user/repo')})`,
         ].join('\n'))
+            .option('-a, --action', 'include a hosted app action in your app')
             .action(initProject);
         yield commander_1.program.parseAsync();
     });

package/lib/types.js

@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContentfulExample = void 0;
 exports.ContentfulExample = {
     Javascript: 'javascript',
-    Typescript: 'typescript'
+    Typescript: 'typescript',
 };

package/lib/utils.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeOptions = exports.detectManager = exports.rmIfExists = exports.exec = void 0;
+exports.isContentfulTemplate = exports.normalizeOptions = exports.detectManager = exports.rmIfExists = exports.exec = void 0;
 const child_process_1 = require("child_process");
 const fs_1 = require("fs");
 const path_1 = require("path");
 const logger_1 = require("./logger");
+const types_1 = require("./types");
+const constants_1 = require("./constants");
 const MUTUALLY_EXCLUSIVE_OPTIONS = ['source', 'example', 'typescript', 'javascript'];
 function exec(command, args, options) {
     return new Promise((resolve, reject) => {
@@ -53,11 +55,13 @@ function normalizeOptions(options) {
         delete normalizedOptions.example;
         delete normalizedOptions.typescript;
         delete normalizedOptions.javascript;
+        delete normalizedOptions.action;
     }
     if (normalizedOptions.example) {
         fallbackOption = '--example';
         delete normalizedOptions.typescript;
         delete normalizedOptions.javascript;
+        delete normalizedOptions.action;
     }
     if (normalizedOptions.typescript) {
         fallbackOption = '--typescript';
@@ -70,3 +74,7 @@ function normalizeOptions(options) {
     return normalizedOptions;
 }
 exports.normalizeOptions = normalizeOptions;
+function isContentfulTemplate(url) {
+    return Object.values(types_1.ContentfulExample).some((t) => url.includes(constants_1.EXAMPLES_PATH + t));
+}
+exports.isContentfulTemplate = isContentfulTemplate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/create-contentful-app",
-  "version": "1.7.16",
+  "version": "1.8.0",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -35,14 +35,14 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@contentful/app-scripts": "1.7.13",
+    "@contentful/app-scripts": "1.8.1",
     "analytics-node": "^6.2.0",
     "chalk": "4.1.2",
-    "commander": "10.0.0",
+    "commander": "10.0.1",
     "degit": "2.8.4",
     "inquirer": "8.2.5",
     "node-fetch": "2.6.7",
-    "rimraf": "4.1.2",
+    "rimraf": "5.0.0",
     "tildify": "2.0.0",
     "validate-npm-package-name": "5.0.0"
   },
@@ -62,11 +62,12 @@
     "@types/chalk": "2.2.0",
     "@types/degit": "2.8.3",
     "@types/inquirer": "8.2.1",
-    "@types/node": "14.18.38",
+    "@types/node": "14.18.42",
     "@types/node-fetch": "^2.6.2",
     "@types/rimraf": "3.0.2",
     "@types/tildify": "2.0.2",
-    "@types/validate-npm-package-name": "4.0.0"
+    "@types/validate-npm-package-name": "4.0.0",
+    "contentful-management": "10.32.0"
   },
-  "gitHead": "510d14511bd2b7fcda3285510e62b026efafded8"
+  "gitHead": "8904c6715a206de6298692d331c478a7bb90126e"
 }