@contentful/create-contentful-app 1.18.8 → 2.0.0

package/README.md

@@ -95,7 +95,6 @@ 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

@@ -49,7 +49,9 @@ async function promptExampleSelection() {
         // get available templates from examples
         const availableTemplates = await (0, getGithubFolderNames_1.getGithubFolderNames)();
         // filter out the ignored ones that are listed as templates instead of examples
-        const filteredTemplates = availableTemplates.filter((template) => !constants_1.IGNORED_EXAMPLE_FOLDERS.includes(template));
+        const filteredTemplates = availableTemplates
+            .filter((template) => !constants_1.IGNORED_EXAMPLE_FOLDERS.includes(template))
+            .filter((template) => !template.includes('function'));
         console.log(availableTemplates.length, filteredTemplates.length);
         // ask user to select a template from the available examples
         const { example } = await inquirer_1.default.prompt([
@@ -86,7 +88,7 @@ async function makeContentfulExampleSource(options) {
     if (options.typescript) {
         return selectTemplate(types_1.ContentfulExample.Typescript);
     }
-    if (options.function || options.action) {
+    if (options.function) {
         return selectTemplate(types_1.ContentfulExample.Typescript);
     }
     return await promptExampleSelection();

package/lib/index.js

@@ -18,8 +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 app_scripts_1 = require("@contentful/app-scripts");
 const DEFAULT_APP_NAME = 'contentful-app';
 function successMessage(folder, useYarn) {
     console.log(`
@@ -87,8 +86,7 @@ async function initProject(appName, options) {
             !normalizedOptions.source &&
             !normalizedOptions.javascript &&
             !normalizedOptions.typescript &&
-            !normalizedOptions.function &&
-            !normalizedOptions.action;
+            !normalizedOptions.function;
         const templateSource = await (0, getTemplateSource_1.getTemplateSource)(options);
         (0, analytics_1.track)({
             template: templateSource,
@@ -96,16 +94,27 @@ 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
             if (normalizedOptions.function === true) {
                 normalizedOptions.function = 'external-references';
             }
-            await (0, includeFunction_1.cloneFunction)(fullAppFolder, !!normalizedOptions.javascript, normalizedOptions.function);
+            process.chdir(fullAppFolder);
+            (0, logger_1.wrapInBlanks)(`To add additional function templates to your app, use ${(0, logger_1.highlight)(chalk_1.default.green(`
+          npx @contentful/app-scripts@latest generate-function \\
+            --ci \\
+            --name <name> \\
+            --example <example> \\
+            --language <typescript/javascript>`))}`);
+            const functionName = normalizedOptions.function
+                .toLowerCase()
+                .replace(/-([a-z])/g, (match, letter) => letter.toUpperCase());
+            await app_scripts_1.generateFunction.nonInteractive({
+                example: normalizedOptions.function,
+                language: 'typescript',
+                name: functionName,
+            });
         }
         updatePackageName(fullAppFolder);
         const useYarn = normalizedOptions.yarn || (0, utils_1.detectManager)() === 'yarn';
@@ -148,7 +157,6 @@ async 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 the ts or js template')
         .option('-f, --function [function-template-name]', 'include the specified function template')
         .action(initProject);
     await commander_1.program.parseAsync();

package/lib/utils.js

@@ -55,14 +55,12 @@ 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.8",
+  "version": "2.0.0",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -14,8 +14,8 @@
     "directory": "packages/contentful--create-contentful-app"
   },
   "engines": {
-    "node": ">=14.15.0",
-    "npm": ">=6"
+    "node": ">=18",
+    "npm": ">=9"
   },
   "main": "lib/index.js",
   "lint-staged": {
@@ -28,7 +28,7 @@
     "create-contentful-app": "lib/index.js"
   },
   "scripts": {
-    "prettier": "prettier **/*.js --write --ignore-path .gitignore",
+    "prettier": "prettier **/*.ts --write --ignore-path .gitignore",
     "lint": "eslint ./src",
     "lint:fix": "npm run lint -- --fix",
     "pre-commit": "lint-staged",
@@ -80,5 +80,5 @@
     "sinon-chai": "^3.7.0",
     "ts-node": "^10.9.2"
   },
-  "gitHead": "4538fa97b37141989cf9788881901c326e0c26c1"
+  "gitHead": "d58b78ba56df989e585aae54cb297e186c8e713b"
 }

package/lib/includeAppAction.js

@@ -1,70 +0,0 @@
-"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/includeFunction.js

@@ -1,75 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cloneFunction = exports.functionTemplateFromName = void 0;
-const chalk_1 = __importDefault(require("chalk"));
-const path_1 = require("path");
-const rimraf_1 = require("rimraf");
-const tiged_1 = __importDefault(require("tiged"));
-const constants_1 = require("./constants");
-const logger_1 = require("./logger");
-const types_1 = require("./types");
-const file_1 = require("./utils/file");
-const package_1 = require("./utils/package");
-// TODO: after appActions work we can change this getAddBuildCommandFn params from command -> defaultCommand as examples will have build commands
-const addBuildCommand = (0, package_1.getAddBuildCommandFn)({
-    name: 'build:functions',
-    command: 'contentful-app-scripts build-functions --ci',
-});
-const VALID_FUNCTION_TEMPLATES_DIRS = [
-    'appevent-filter',
-    'appevent-handler',
-    'appevent-transformation',
-    'external-references',
-    'comment-bot',
-];
-function functionTemplateFromName(functionName, destination) {
-    let dirName = functionName;
-    if (!VALID_FUNCTION_TEMPLATES_DIRS.includes(dirName)) {
-        // cleanup in case of invalid example
-        rimraf_1.rimraf.sync(destination);
-        throw new types_1.InvalidTemplateError(`${chalk_1.default.red(`Invalid function template:`)} The function name ${(0, logger_1.highlight)(chalk_1.default.cyan(functionName))} is not valid. Must be one of: ${(0, logger_1.highlight)(VALID_FUNCTION_TEMPLATES_DIRS.join(', '))}.`);
-    }
-    if (functionName === 'external-references')
-        dirName = 'templates'; // backwards compatible for the apps repo examples folder for delivery functions (external-references)
-    return dirName;
-}
-exports.functionTemplateFromName = functionTemplateFromName;
-async function cloneFunction(destination, templateIsJavascript, functionName) {
-    try {
-        console.log((0, logger_1.highlight)(`---- Cloning function ${chalk_1.default.cyan(functionName)}...`));
-        // Clone the function template to the created directory under the folder 'actions'
-        const templateSource = (0, path_1.join)(`contentful/apps/examples/function-${functionTemplateFromName(functionName, destination)}`, templateIsJavascript ? 'javascript' : 'typescript');
-        const functionDirectoryPath = (0, path_1.resolve)(`${destination}/functions`);
-        const d = (0, tiged_1.default)(templateSource, { mode: 'tar', disableCache: true });
-        await d.clone(functionDirectoryPath);
-        // merge the manifest from the template folder to the root folder
-        const writeAppManifest = (0, file_1.mergeJsonIntoFile)({
-            source: `${functionDirectoryPath}/${constants_1.CONTENTFUL_APP_MANIFEST}`,
-            destination: `${destination}/${constants_1.CONTENTFUL_APP_MANIFEST}`,
-        });
-        // modify package.json build commands
-        const packageJsonLocation = (0, path_1.resolve)(`${destination}/package.json`);
-        const packageJsonExists = await (0, file_1.exists)(packageJsonLocation);
-        if (!packageJsonExists) {
-            throw new Error(`Failed to add function build commands: ${packageJsonLocation} does not exist.`);
-        }
-        const writeBuildCommand = (0, file_1.mergeJsonIntoFile)({
-            source: `${functionDirectoryPath}/package.json`,
-            destination: packageJsonLocation,
-            mergeFn: addBuildCommand,
-        });
-        await Promise.all([writeAppManifest, writeBuildCommand]);
-        await d.remove(functionDirectoryPath, destination, {
-            action: 'remove',
-            files: constants_1.IGNORED_CLONED_FILES.map((fileName) => `${functionDirectoryPath}/${fileName}`),
-        });
-    }
-    catch (e) {
-        (0, logger_1.error)(`Failed to clone function ${(0, logger_1.highlight)(chalk_1.default.cyan(functionName))}`, e);
-        process.exit(1);
-    }
-}
-exports.cloneFunction = cloneFunction;