@contentful/create-contentful-app 1.17.3 → 1.17.4

package/lib/constants.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IGNORED_CLONED_FILES = exports.CONTENTFUL_APP_MANIFEST = exports.EXAMPLES_PATH = exports.IGNORED_EXAMPLE_FOLDERS = 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';
+// These are the examples that are listed as templates instead of examples
+// OR should otherwise not be included in the list of examples displayed in the interactive mode
 exports.IGNORED_EXAMPLE_FOLDERS = [
     'javascript',
     'typescript',

package/lib/getGithubFolderNames.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGithubFolderNames = exports.CONTENTFUL_APPS_EXAMPLE_FOLDER = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const types_1 = require("./types");
+const chalk_1 = __importDefault(require("chalk"));
+exports.CONTENTFUL_APPS_EXAMPLE_FOLDER = 'https://api.github.com/repos/contentful/apps/contents/examples';
+async function getGithubFolderNames() {
+    try {
+        const response = await (0, node_fetch_1.default)(exports.CONTENTFUL_APPS_EXAMPLE_FOLDER);
+        if (!response.ok) {
+            throw new types_1.HTTPResponseError(`${chalk_1.default.red('Error:')} Failed to fetch Contentful app templates: ${response.status} ${response.statusText}`);
+        }
+        const contents = await response.json();
+        const filteredContents = contents.filter((content) => content.type === 'dir');
+        return filteredContents.map((content) => content.name);
+    }
+    catch (err) {
+        if (err instanceof types_1.HTTPResponseError) {
+            throw err;
+        }
+        else {
+            throw new Error(`Failed to fetch Contentful app templates: ${err}`);
+        }
+    }
+}
+exports.getGithubFolderNames = getGithubFolderNames;

package/lib/getTemplateSource.js

@@ -3,22 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTemplateSource = void 0;
-const node_fetch_1 = __importDefault(require("node-fetch"));
+exports.getTemplateSource = exports.makeContentfulExampleSource = void 0;
 const inquirer_1 = __importDefault(require("inquirer"));
 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';
-async function getGithubFolderNames() {
-    const response = await (0, node_fetch_1.default)(CONTENTFUL_APPS_EXAMPLE_FOLDER);
-    const contents = await response.json();
-    return contents
-        .filter((content) => content.type === 'dir' && !constants_1.IGNORED_EXAMPLE_FOLDERS.includes(content.name))
-        .map((content) => content.name);
-}
+const getGithubFolderNames_1 = require("./getGithubFolderNames");
 async function promptExampleSelection() {
     let template = 'typescript';
     // ask user whether to start with a blank template or use an example
@@ -55,14 +47,17 @@ async function promptExampleSelection() {
     }
     else {
         // get available templates from examples
-        const availableTemplates = await getGithubFolderNames();
+        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));
+        console.log(availableTemplates.length, filteredTemplates.length);
         // ask user to select a template from the available examples
         const { example } = await inquirer_1.default.prompt([
             {
                 name: 'example',
                 message: 'Select a template',
                 type: 'list',
-                choices: availableTemplates,
+                choices: filteredTemplates,
             },
         ]);
         template = example;
@@ -76,7 +71,14 @@ function selectTemplate(template) {
 }
 async function makeContentfulExampleSource(options) {
     if (options.example) {
-        return selectTemplate(options.example);
+        // check to see if the example is valid
+        const availableTemplates = await (0, getGithubFolderNames_1.getGithubFolderNames)();
+        const isValidContentfulExample = availableTemplates.includes(options.example);
+        if (!isValidContentfulExample) {
+            throw new types_1.InvalidTemplateError(`${chalk_1.default.red(`Invalid template:`)} The example name ${(0, logger_1.highlight)(chalk_1.default.cyan(options.example))} is not valid. Please use one of Contentful's public example apps from ${(0, logger_1.highlight)(`https://github.com/contentful/apps/tree/master/examples`)}. Use the ${(0, logger_1.code)(`--example`)} option followed by the example name.`);
+        }
+        const templateSource = selectTemplate(options.example);
+        return templateSource;
     }
     if (options.javascript) {
         return selectTemplate(types_1.ContentfulExample.Javascript);
@@ -89,6 +91,7 @@ async function makeContentfulExampleSource(options) {
     }
     return await promptExampleSelection();
 }
+exports.makeContentfulExampleSource = makeContentfulExampleSource;
 async function getTemplateSource(options) {
     const source = options.source ?? (await makeContentfulExampleSource(options));
     if (options.source && !(0, utils_1.isContentfulTemplate)(source)) {

package/lib/includeFunction.js

@@ -3,11 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cloneFunction = void 0;
+exports.cloneFunction = exports.functionTemplateFromName = void 0;
+const chalk_1 = __importDefault(require("chalk"));
 const path_1 = require("path");
-const constants_1 = require("./constants");
+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
@@ -22,21 +25,23 @@ const VALID_FUNCTION_TEMPLATES_DIRS = [
     'external-references',
     'comment-bot',
 ];
-function functionTemplateFromName(functionName) {
+function functionTemplateFromName(functionName, destination) {
     let dirName = functionName;
     if (!VALID_FUNCTION_TEMPLATES_DIRS.includes(dirName)) {
-        console.error(`Invalid function template: ${functionName}. Must be one of ${VALID_FUNCTION_TEMPLATES_DIRS.join(', ')}.`);
-        process.exit(1);
+        // 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 "${functionName}".`));
+        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)}`, templateIsJavascript ? 'javascript' : 'typescript');
+        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);
@@ -49,8 +54,7 @@ async function cloneFunction(destination, templateIsJavascript, functionName) {
         const packageJsonLocation = (0, path_1.resolve)(`${destination}/package.json`);
         const packageJsonExists = await (0, file_1.exists)(packageJsonLocation);
         if (!packageJsonExists) {
-            console.error(`Failed to add function build commands: ${packageJsonLocation} does not exist.`);
-            return;
+            throw new Error(`Failed to add function build commands: ${packageJsonLocation} does not exist.`);
         }
         const writeBuildCommand = (0, file_1.mergeJsonIntoFile)({
             source: `${functionDirectoryPath}/package.json`,
@@ -64,7 +68,7 @@ async function cloneFunction(destination, templateIsJavascript, functionName) {
         });
     }
     catch (e) {
-        console.error(e);
+        (0, logger_1.error)(`Failed to clone function ${(0, logger_1.highlight)(chalk_1.default.cyan(functionName))}`, e);
         process.exit(1);
     }
 }

package/lib/index.js

@@ -119,7 +119,7 @@ async function initProject(appName, options) {
         successMessage(fullAppFolder, useYarn);
     }
     catch (err) {
-        (0, logger_1.error)(`Failed to create ${appName}`, err);
+        (0, logger_1.error)(`Failed to create ${(0, logger_1.highlight)(chalk_1.default.cyan(appName))}`, err);
         process.exit(1);
     }
 }

package/lib/logger.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.code = exports.success = exports.choice = exports.highlight = exports.wrapInBlanks = exports.error = exports.warn = void 0;
 const chalk_1 = __importDefault(require("chalk"));
+const types_1 = require("./types");
 function warn(message) {
     console.log(`${chalk_1.default.yellow('Warning:')} ${message}`);
 }
@@ -14,6 +15,11 @@ function error(message, error) {
     if (error === undefined) {
         return;
     }
+    else if (error instanceof types_1.InvalidTemplateError || error instanceof types_1.HTTPResponseError) {
+        // for known errors, we just want to show the message
+        console.log();
+        console.log(error.message);
+    }
     else if (error instanceof Error) {
         console.log();
         console.log(error);

package/lib/template.js

@@ -67,7 +67,6 @@ function cleanUp(destination) {
 }
 async function cloneTemplateIn(destination, source) {
     await clone(source, destination);
-    console.log((0, logger_1.success)('Done!'));
     try {
         validate(destination);
     }
@@ -77,5 +76,6 @@ async function cloneTemplateIn(destination, source) {
         throw e;
     }
     cleanUp(destination);
+    console.log((0, logger_1.success)('Done!'));
 }
 exports.cloneTemplateIn = cloneTemplateIn;

package/lib/types.js

@@ -1,7 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentfulExample = void 0;
+exports.HTTPResponseError = exports.InvalidTemplateError = exports.ContentfulExample = void 0;
 exports.ContentfulExample = {
     Javascript: 'javascript',
     Typescript: 'typescript',
 };
+class InvalidTemplateError extends Error {
+}
+exports.InvalidTemplateError = InvalidTemplateError;
+class HTTPResponseError extends Error {
+}
+exports.HTTPResponseError = HTTPResponseError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/create-contentful-app",
-  "version": "1.17.3",
+  "version": "1.17.4",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -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.40.2",
+    "contentful-management": "11.40.3",
     "mocha": "^10.2.0",
     "sinon": "^19.0.0",
     "sinon-chai": "^3.7.0",
     "ts-node": "^10.9.2"
   },
-  "gitHead": "526f5b4c5cd834168a30397d1e4104476ef2dc05"
+  "gitHead": "dce83a3e18571b2f0550c3a447d07fffb1145155"
 }