@contentful/create-contentful-app 1.8.10 → 1.9.1

package/lib/includeAppAction.js

@@ -14,11 +14,17 @@ var __importDefault = (this && this.__importDefault) || function (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 promises_1 = require("fs/promises");
 const path_1 = require("path");
 const constants_1 = require("./constants");
 const degit_1 = __importDefault(require("degit"));
 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',
+});
 function cloneAppAction(destination, templateIsTypescript) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -29,19 +35,25 @@ function cloneAppAction(destination, templateIsTypescript) {
             const d = yield (0, degit_1.default)(templateSource, { mode: 'tar', cache: false });
             yield d.clone(appActionDirectoryPath);
             // move the manifest from the actions folder to the root folder
-            (0, fs_1.renameSync)(`${appActionDirectoryPath}/${constants_1.CONTENTFUL_APP_MANIFEST}`, `${destination}/${constants_1.CONTENTFUL_APP_MANIFEST}`);
+            const writeAppManifest = yield (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
-            (0, fs_1.renameSync)(`${appActionDirectoryPath}/build-actions.js`, `${destination}/build-actions.js`);
+            const copyBuildFile = yield (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 = (0, fs_1.existsSync)(packageJsonLocation);
+            const packageJsonExists = yield (0, file_1.exists)(packageJsonLocation);
             if (!packageJsonExists) {
-                console.error('Failed to add app action build commands.');
+                console.error(`Failed to add app action build commands: ${packageJsonLocation} does not exist.`);
                 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': 'node build-actions.js', build: `${packageJson.scripts.build} && npm run build-actions` }) });
-            (0, fs_1.writeFileSync)(packageJsonLocation, JSON.stringify(updatedPackageJson, null, '  '));
+            const writeBuildCommand = yield (0, file_1.mergeJsonIntoFile)({
+                source: `${appActionDirectoryPath}/package.json`,
+                destination: packageJsonLocation,
+                mergeFn: addBuildCommand,
+            });
+            yield Promise.all([writeAppManifest, copyBuildFile, writeBuildCommand]);
         }
         catch (e) {
             console.log(e);

package/lib/includeDeliveryFunction.js

@@ -0,0 +1,63 @@
+"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.cloneDeliveryFunction = void 0;
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const constants_1 = require("./constants");
+const degit_1 = __importDefault(require("degit"));
+const logger_1 = require("./logger");
+const file_1 = require("./utils/file");
+const package_1 = require("./utils/package");
+const addBuildCommand = (0, package_1.getAddBuildCommandFn)({
+    name: 'build:delivery-functions',
+    command: 'node build-delivery-functions.js',
+});
+function cloneDeliveryFunction(destination, templateIsTypescript) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            console.log((0, logger_1.highlight)('---- Cloning hosted delivery function.'));
+            // Clone the delivery function template to the created directory under the folder 'actions'
+            const templateSource = (0, path_1.join)('contentful/apps/examples/hosted-delivery-function-templates', templateIsTypescript ? 'typescript' : 'javascript');
+            const deliveryFunctionDirectoryPath = (0, path_1.resolve)(`${destination}/delivery-functions`);
+            const d = yield (0, degit_1.default)(templateSource, { mode: 'tar', cache: false });
+            yield d.clone(deliveryFunctionDirectoryPath);
+            // merge the manifest from the template folder to the root folder
+            const writeAppManifest = (0, file_1.mergeJsonIntoFile)({
+                source: `${deliveryFunctionDirectoryPath}/${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 = (0, promises_1.rename)(`${deliveryFunctionDirectoryPath}/build-delivery-functions.js`, `${destination}/build-delivery-functions.js`);
+            // modify package.json build commands
+            const packageJsonLocation = (0, path_1.resolve)(`${destination}/package.json`);
+            const packageJsonExists = yield (0, file_1.exists)(packageJsonLocation);
+            if (!packageJsonExists) {
+                console.error(`Failed to add delivery function build commands: ${packageJsonLocation} does not exist.`);
+                return;
+            }
+            const writeBuildCommand = (0, file_1.mergeJsonIntoFile)({
+                source: `${deliveryFunctionDirectoryPath}/package.json`,
+                destination: packageJsonLocation,
+                mergeFn: addBuildCommand,
+            });
+            yield Promise.all([writeAppManifest, copyBuildFile, writeBuildCommand]);
+        }
+        catch (e) {
+            console.error(e);
+            process.exit(1);
+        }
+    });
+}
+exports.cloneDeliveryFunction = cloneDeliveryFunction;

package/lib/index.js

@@ -28,6 +28,7 @@ const constants_1 = require("./constants");
 const getTemplateSource_1 = require("./getTemplateSource");
 const analytics_1 = require("./analytics");
 const includeAppAction_1 = require("./includeAppAction");
+const includeDeliveryFunction_1 = require("./includeDeliveryFunction");
 const DEFAULT_APP_NAME = 'contentful-app';
 function successMessage(folder, useYarn) {
     console.log(`
@@ -108,7 +109,12 @@ function initProject(appName, options) {
             });
             yield (0, template_1.cloneTemplateIn)(fullAppFolder, templateSource);
             if (!isInteractive && (0, utils_1.isContentfulTemplate)(templateSource) && normalizedOptions.action) {
-                (0, includeAppAction_1.cloneAppAction)(fullAppFolder, !!normalizedOptions.typescript);
+                yield (0, includeAppAction_1.cloneAppAction)(fullAppFolder, !!normalizedOptions.typescript);
+            }
+            if (!isInteractive &&
+                (0, utils_1.isContentfulTemplate)(templateSource) &&
+                normalizedOptions.deliveryFunction) {
+                yield (0, includeDeliveryFunction_1.cloneDeliveryFunction)(fullAppFolder, !!normalizedOptions.typescript);
             }
             updatePackageName(fullAppFolder);
             const useYarn = normalizedOptions.yarn || (0, utils_1.detectManager)() === 'yarn';
@@ -154,6 +160,7 @@ function initProject(appName, options) {
             `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 the ts or js template')
+            .option('-d, --delivery-function', 'include a hosted delivery function template (EAP only, contact monet@contentful.com if interested)')
             .action(initProject);
         yield commander_1.program.parseAsync();
     });

package/lib/template.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 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) {
@@ -16,7 +39,7 @@ exports.cloneTemplateIn = void 0;
 const path_1 = require("path");
 const fs_1 = require("fs");
 const degit_1 = __importDefault(require("degit"));
-const rimraf_1 = __importDefault(require("rimraf"));
+const rimraf = __importStar(require("rimraf"));
 const logger_1 = require("./logger");
 const utils_1 = require("./utils");
 function clone(source, destination) {
@@ -62,7 +85,7 @@ function cloneTemplateIn(destination, source) {
         }
         catch (e) {
             // cleanup in case of invalid example
-            rimraf_1.default.sync(destination);
+            rimraf.sync(destination);
             throw e;
         }
         cleanUp(destination);

package/lib/utils/file.js

@@ -0,0 +1,46 @@
+"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.exists = exports.mergeJsonIntoFile = exports.getJsonData = void 0;
+const merge_options_1 = __importDefault(require("merge-options"));
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+function getJsonData(path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!path) {
+            return undefined;
+        }
+        const normalizedPath = (0, path_1.resolve)(path);
+        if (!(yield exists(normalizedPath))) {
+            return undefined;
+        }
+        return JSON.parse(yield (0, promises_1.readFile)(normalizedPath, { encoding: 'utf-8' }));
+    });
+}
+exports.getJsonData = getJsonData;
+function mergeJsonIntoFile({ source, destination, mergeFn = merge_options_1.default.bind({ concatArrays: false }), }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const sourceJson = yield getJsonData(source);
+        const destinationJson = yield getJsonData(destination);
+        const mergedJson = mergeFn(destinationJson, sourceJson);
+        yield (0, promises_1.writeFile)((0, path_1.resolve)(destination), JSON.stringify(mergedJson, null, '  '));
+    });
+}
+exports.mergeJsonIntoFile = mergeJsonIntoFile;
+function exists(path) {
+    return (0, promises_1.access)(path)
+        .then(() => true)
+        .catch(() => false);
+}
+exports.exists = exists;

package/lib/utils/package.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAddBuildCommandFn = void 0;
+const merge_options_1 = __importDefault(require("merge-options"));
+function getAddBuildCommandFn({ name, command }) {
+    return (packageJson, additionalProperties) => {
+        var _a, _b;
+        let buildCommand = (_b = (_a = packageJson === null || packageJson === void 0 ? void 0 : packageJson.scripts) === null || _a === void 0 ? void 0 : _a.build) !== null && _b !== void 0 ? _b : '';
+        const triggerCommand = `npm run ${name}`;
+        if (buildCommand === '') {
+            buildCommand = triggerCommand;
+        }
+        else if (!buildCommand.split(/\s*&+\s*/).includes(triggerCommand)) {
+            buildCommand += ` && ${triggerCommand}`;
+        }
+        return (0, merge_options_1.default)({}, packageJson, additionalProperties, {
+            scripts: { [name]: command, build: buildCommand },
+        });
+    };
+}
+exports.getAddBuildCommandFn = getAddBuildCommandFn;

package/lib/utils.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/create-contentful-app",
-  "version": "1.8.10",
+  "version": "1.9.1",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -32,15 +32,17 @@
     "lint": "eslint ./src",
     "lint:fix": "npm run lint -- --fix",
     "pre-commit": "lint-staged",
-    "build": "tsc"
+    "build": "tsc",
+    "test": "mocha 'test/**/*.spec.{js,ts}'"
   },
   "dependencies": {
-    "@contentful/app-scripts": "1.10.2",
+    "@contentful/app-scripts": "1.12.0",
     "analytics-node": "^6.2.0",
     "chalk": "4.1.2",
-    "commander": "10.0.1",
+    "commander": "11.0.0",
     "degit": "2.8.4",
-    "inquirer": "8.2.5",
+    "inquirer": "8.2.6",
+    "merge-options": "^3.0.4",
     "node-fetch": "2.6.7",
     "rimraf": "5.0.1",
     "tildify": "2.0.0",
@@ -57,17 +59,27 @@
     "access": "public"
   },
   "devDependencies": {
-    "@tsconfig/node16": "1.0.4",
+    "@tsconfig/node16": "16.1.1",
     "@types/analytics-node": "^3.1.9",
+    "@types/chai-as-promised": "^7.1.5",
     "@types/chalk": "2.2.0",
     "@types/degit": "2.8.3",
     "@types/inquirer": "8.2.1",
-    "@types/node": "14.18.47",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "14.18.55",
     "@types/node-fetch": "^2.6.2",
     "@types/rimraf": "3.0.2",
+    "@types/sinon": "^10.0.16",
+    "@types/sinon-chai": "^3.2.9",
     "@types/tildify": "2.0.2",
     "@types/validate-npm-package-name": "4.0.0",
-    "contentful-management": "10.35.4"
+    "chai": "^4.3.7",
+    "chai-as-promised": "^7.1.1",
+    "contentful-management": "10.40.0",
+    "mocha": "^10.2.0",
+    "sinon": "^15.2.0",
+    "sinon-chai": "^3.7.0",
+    "ts-node": "^10.9.1"
   },
-  "gitHead": "decd25e2e3c38482d6e636777f37de44fd49ab1c"
+  "gitHead": "e6ee977c9fc8db111bcd36c8caa1550f4829afb6"
 }