@contentful/app-scripts 2.1.1 → 2.1.3

package/lib/analytics.js

@@ -19,7 +19,9 @@ function track({ command, ci }) {
         const client = new analytics_node_1.Analytics({
             writeKey: SEGMENT_WRITE_KEY,
         });
-        client.on('error', (err) => { });
+        client.on('error', (err) => {
+            /* noop */
+        });
         client.track({
             event: 'app-cli-app-scripts',
             properties: {

package/lib/bin.js

@@ -22,7 +22,7 @@ async function runCommand(command, options) {
         .description('Upload your build folder and create an AppBundle')
         .option('--bundle-dir [directory]', 'The directory of your build folder')
         .option('--organization-id [orgId]', 'The id of your organization')
-        .option('--definition-id [defId]', 'The id of your app\'s definition')
+        .option('--definition-id [defId]', "The id of your app's definition")
         .option('--token [accessToken]', 'Your content management access token')
         .option('--comment [comment]', 'Optional comment for the created bundle')
         .option('--skip-activation', 'A Boolean flag to skip automatic activation')
@@ -35,7 +35,7 @@ async function runCommand(command, options) {
         .description('Mark an AppBundle as "active" for a given AppDefinition')
         .option('--bundle-id [bundleId]', 'The id of your bundle')
         .option('--organization-id [orgId]', 'The id of your organization')
-        .option('--definition-id  [defId]', 'The id of your app\'s definition')
+        .option('--definition-id  [defId]', "The id of your app's definition")
         .option('--token [accessToken]', 'Your content management access token')
         .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
         .action(async (options) => {
@@ -44,7 +44,7 @@ async function runCommand(command, options) {
     commander_1.program
         .command('open-settings')
         .description('Opens the app editor for a given AppDefinition')
-        .option('--definition-id  [defId]', 'The id of your app\'s definition')
+        .option('--definition-id  [defId]', "The id of your app's definition")
         .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
         .action(async (options) => {
         await runCommand(index_1.open, options);
@@ -53,7 +53,7 @@ async function runCommand(command, options) {
         .command('bundle-cleanup')
         .description('Removes old, non-active bundles, only keeps the 50 most recent ones')
         .option('--organization-id [orgId]', 'The id of your organization')
-        .option('--definition-id  [defId]', 'The id of your app\'s definition')
+        .option('--definition-id  [defId]', "The id of your app's definition")
         .option('--token [accessToken]', 'Your content management access token')
         .option('--keep [keepAmount]', 'The amount of bundles that should remain')
         .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
@@ -69,7 +69,7 @@ async function runCommand(command, options) {
     commander_1.program
         .command('install')
         .description('Opens a picker to select the space and environment for installing the app associated with a given AppDefinition')
-        .option('--definition-id  [defId]', 'The id of your app\'s definition')
+        .option('--definition-id  [defId]', "The id of your app's definition")
         .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
         .action(async (options) => {
         await runCommand(index_1.install, options);
@@ -97,7 +97,7 @@ async function runCommand(command, options) {
         .description('Upsert Action(s) for an App')
         .option('-m, --manifest-file <path>', 'Contentful app manifest file path')
         .option('--organization-id [orgId]', 'The id of your organization')
-        .option('--definition-id  [defId]', 'The id of your app\'s definition')
+        .option('--definition-id  [defId]', "The id of your app's definition")
         .option('--token [accessToken]', 'Your content management access token')
         .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
         .action(async (options) => {

package/lib/generate-function/build-generate-function-settings.d.ts

@@ -1,3 +1,4 @@
 import { GenerateFunctionSettings } from '../types';
 export declare function buildGenerateFunctionSettingsInteractive(): Promise<GenerateFunctionSettings>;
+export declare function validateArguments(options: GenerateFunctionSettings): void;
 export declare function buildGenerateFunctionSettingsCLI(options: GenerateFunctionSettings): Promise<GenerateFunctionSettings>;

package/lib/generate-function/build-generate-function-settings.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildGenerateFunctionSettingsInteractive = buildGenerateFunctionSettingsInteractive;
+exports.validateArguments = validateArguments;
 exports.buildGenerateFunctionSettingsCLI = buildGenerateFunctionSettingsCLI;
 const inquirer_1 = __importDefault(require("inquirer"));
 const path_1 = __importDefault(require("path"));
@@ -12,6 +13,7 @@ const constants_1 = require("./constants");
 const ora_1 = __importDefault(require("ora"));
 const chalk_1 = __importDefault(require("chalk"));
 const logger_1 = require("./logger");
+const types_1 = require("./types");
 async function buildGenerateFunctionSettingsInteractive() {
     const baseSettings = await inquirer_1.default.prompt([
         {
@@ -19,9 +21,7 @@ async function buildGenerateFunctionSettingsInteractive() {
             message: `Function name (${path_1.default.basename(process.cwd())}):`,
         },
     ]);
-    if (constants_1.BANNED_FUNCTION_NAMES.includes(baseSettings.name)) {
-        throw new Error(`Invalid function name: ${baseSettings.name}`);
-    }
+    validateFunctionName(baseSettings);
     const filteredSources = await (0, get_github_folder_names_1.getGithubFolderNames)();
     const sourceSpecificSettings = await inquirer_1.default.prompt([
         {
@@ -45,25 +45,38 @@ async function buildGenerateFunctionSettingsInteractive() {
     baseSettings.language = sourceSpecificSettings.language;
     return baseSettings;
 }
+function validateFunctionName(baseSettings) {
+    if (constants_1.BANNED_FUNCTION_NAMES.includes(baseSettings.name)) {
+        throw new types_1.ValidationError(chalk_1.default.red(`Invalid function name: ${baseSettings.name} is not allowed.`));
+    }
+    else if (!(/^[a-z0-9]+$/i.test(baseSettings.name))) {
+        throw new types_1.ValidationError(chalk_1.default.red(`Invalid function name: ${baseSettings.name}. Note that function names must be alphanumeric.`));
+    }
+}
 function validateArguments(options) {
     const requiredParams = ['name', 'example', 'language'];
     if (!requiredParams.every((key) => key in options)) {
-        throw new Error('You must specify a function name, an example, and a language');
+        throw new types_1.ValidationError(chalk_1.default.red('You must specify a function name, an example, and a language'));
     }
-    if (constants_1.BANNED_FUNCTION_NAMES.includes(options.name)) {
-        throw new Error(`Invalid function name: ${options.name}`);
+    validateFunctionName(options);
+    // Check if the language is valid
+    if (!constants_1.ACCEPTED_LANGUAGES.includes(options.language)) {
+        (0, logger_1.warn)(`Invalid language: ${options.language}. Defaulting to TypeScript.`);
+        options.language = 'typescript';
     }
     // Convert options to lowercase and trim whitespace
     for (const key in options) {
         const optionKey = key;
         const value = options[optionKey].toLowerCase().trim();
         if (optionKey === 'language') {
-            // Assert that the value is of type Language
             options[optionKey] = value;
         }
-        else {
+        else if (optionKey === 'example') {
             options[optionKey] = value;
         }
+        else { // don't want to lowercase function names
+            options[optionKey] = options[optionKey].trim();
+        }
     }
 }
 async function buildGenerateFunctionSettingsCLI(options) {
@@ -74,16 +87,9 @@ async function buildGenerateFunctionSettingsCLI(options) {
         // Check if the source exists
         const filteredSources = await (0, get_github_folder_names_1.getGithubFolderNames)();
         if (!filteredSources.includes(options.example)) {
-            throw new Error(`Invalid example name: ${options.example}. Please choose from: ${filteredSources.join(', ')}`);
-        }
-        // Check if the language is valid
-        if (!constants_1.ACCEPTED_LANGUAGES.includes(options.language)) {
-            (0, logger_1.warn)(`Invalid language: ${options.language}. Defaulting to TypeScript.`);
-            settings.language = 'typescript';
-        }
-        else {
-            settings.language = options.language;
+            throw new types_1.ValidationError(`Invalid example name: ${options.example}. Please choose from: ${filteredSources.join(', ')}`);
         }
+        settings.language = options.language;
         settings.example = options.example;
         settings.name = options.name;
         return settings;
@@ -91,10 +97,9 @@ async function buildGenerateFunctionSettingsCLI(options) {
     catch (err) {
         console.log(`
         ${chalk_1.default.red('Validation failed')}
-        ${err.message}
       `);
         // eslint-disable-next-line no-process-exit
-        process.exit(1);
+        throw err;
     }
     finally {
         validateSpinner.stop();

package/lib/generate-function/clone.js

@@ -41,11 +41,11 @@ async function cloneFunction(localPath, settings) {
     }
     catch (e) {
         (0, logger_1.error)(`Failed to clone function ${(0, logger_1.highlight)(chalk_1.default.cyan(settings.name))}`, e);
-        process.exit(1);
+        throw Error(chalk_1.default.red('Failed to clone function ') + (0, logger_1.highlight)(chalk_1.default.cyan(settings.name)));
     }
 }
 function getCloneURL(settings) {
-    return `${constants_1.REPO_URL}/${settings.example}/${settings.language}`; // this is the default for template
+    return `${constants_1.REPO_URL}/${settings.example}/${settings.language}`;
 }
 async function touchupAppManifest(localPath, settings, renameFunctionFile) {
     const appManifest = JSON.parse(node_fs_1.default.readFileSync(`${localPath}/${constants_1.CONTENTFUL_APP_MANIFEST}`, 'utf-8'));

package/lib/generate-function/constants.js

@@ -4,7 +4,7 @@ exports.BANNED_FUNCTION_NAMES = exports.CONTENTFUL_FUNCTIONS_EXAMPLE_REPO_PATH =
 exports.EXAMPLES_PATH = 'contentful/apps/function-examples/';
 exports.APP_MANIFEST = 'app-manifest.json';
 exports.CONTENTFUL_APP_MANIFEST = 'contentful-app-manifest.json';
-exports.IGNORED_CLONED_FILES = [exports.APP_MANIFEST, `package.json`];
+exports.IGNORED_CLONED_FILES = [exports.APP_MANIFEST, exports.CONTENTFUL_APP_MANIFEST, `package.json`];
 exports.REPO_URL = 'https://github.com/contentful/apps/function-examples';
 exports.ACCEPTED_EXAMPLE_FOLDERS = [
     'appevent-handler',

package/lib/generate-function/index.js

@@ -3,13 +3,34 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateFunction = void 0;
 const build_generate_function_settings_1 = require("./build-generate-function-settings");
 const create_function_1 = require("./create-function");
+const types_1 = require("./types");
 const interactive = async () => {
-    const generateFunctionSettings = await (0, build_generate_function_settings_1.buildGenerateFunctionSettingsInteractive)();
-    return (0, create_function_1.create)(generateFunctionSettings);
+    try {
+        const generateFunctionSettings = await (0, build_generate_function_settings_1.buildGenerateFunctionSettingsInteractive)();
+        return (0, create_function_1.create)(generateFunctionSettings);
+    }
+    catch (e) {
+        if (e instanceof types_1.ValidationError) {
+            console.error(e.message);
+        }
+        else {
+            console.error(e);
+        }
+    }
 };
 const nonInteractive = async (options) => {
-    const generateFunctionSettings = await (0, build_generate_function_settings_1.buildGenerateFunctionSettingsCLI)(options);
-    return (0, create_function_1.create)(generateFunctionSettings);
+    try {
+        const generateFunctionSettings = await (0, build_generate_function_settings_1.buildGenerateFunctionSettingsCLI)(options);
+        return (0, create_function_1.create)(generateFunctionSettings);
+    }
+    catch (e) {
+        if (e instanceof types_1.ValidationError) {
+            console.error(e.message);
+        }
+        else {
+            console.error(e);
+        }
+    }
 };
 exports.generateFunction = {
     interactive,

package/lib/generate-function/types.d.ts

@@ -2,3 +2,6 @@ export declare class HTTPResponseError extends Error {
 }
 export declare class InvalidTemplateError extends Error {
 }
+export declare class ValidationError extends Error {
+    constructor(message: string);
+}

package/lib/generate-function/types.js

@@ -1,9 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidTemplateError = exports.HTTPResponseError = void 0;
+exports.ValidationError = exports.InvalidTemplateError = exports.HTTPResponseError = void 0;
 class HTTPResponseError extends Error {
 }
 exports.HTTPResponseError = HTTPResponseError;
 class InvalidTemplateError extends Error {
 }
 exports.InvalidTemplateError = InvalidTemplateError;
+class ValidationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ValidationError";
+    }
+}
+exports.ValidationError = ValidationError;

package/lib/upload/create-app-bundle.d.ts

@@ -1,3 +1,4 @@
 import { UploadSettings } from '../types';
 export declare function createAppBundleFromUpload(settings: UploadSettings, appUploadId: string): Promise<import("contentful-management").AppBundle | null>;
+export declare function processCreateAppBundleError(err: any): any;
 export declare function createAppBundleFromSettings(settings: UploadSettings): Promise<void | import("contentful-management").AppBundle>;

package/lib/upload/create-app-bundle.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createAppBundleFromUpload = createAppBundleFromUpload;
+exports.processCreateAppBundleError = processCreateAppBundleError;
 exports.createAppBundleFromSettings = createAppBundleFromSettings;
 const chalk_1 = __importDefault(require("chalk"));
 const ora_1 = __importDefault(require("ora"));
@@ -31,21 +32,36 @@ async function createAppBundleFromUpload(settings, appUploadId) {
         });
     }
     catch (err) {
-        try {
-            const message = JSON.parse(err.message);
-            if (message['status'] == 403 && message.details?.reasons) {
-                (0, utils_1.showCreationError)('app upload', message['details']['reasons']);
+        (0, utils_1.showCreationError)('app upload', processCreateAppBundleError(err));
+    }
+    bundleSpinner.stop();
+    return appBundle;
+}
+function processCreateAppBundleError(err) {
+    try {
+        const message = JSON.parse(err.message);
+        const reasons = message.details?.reasons;
+        if (message.status !== 403 || !reasons) {
+            return err.message;
+        }
+        if (message['status'] == 403 && message.details?.reasons) {
+            if (reasons.includes('Not entitled to App Functions.')) {
+                return 'Your app seems to be using App Functions, which your organization is not entitled to. Remove your app function, or upgrade your account to proceed with your app upload.';
+            }
+            else if (reasons.includes('App Functions beta not enabled.')) {
+                return 'Your app seems to be using App Functions, which your organization has not enabled in the Preview Center. In the Contentful web app, go to the Account Menu → Preview Center → App Functions to enable and proceed with your app upload.';
             }
             else {
-                (0, utils_1.showCreationError)('app upload', message);
+                return reasons;
             }
         }
-        catch (e) {
-            (0, utils_1.showCreationError)('app upload', err.message);
+        else {
+            return reasons;
         }
     }
-    bundleSpinner.stop();
-    return appBundle;
+    catch (e) {
+        return err.message;
+    }
 }
 async function createAppBundleFromSettings(settings) {
     let appUpload = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -25,7 +25,7 @@
     "contentful-app-scripts": "lib/bin.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",
     "test": "ts-mocha \"./{,!(node_modules)/**/}*.test.ts\"",
@@ -55,7 +55,7 @@
     "bottleneck": "2.19.5",
     "chalk": "4.1.2",
     "commander": "12.1.0",
-    "contentful-management": "11.47.3",
+    "contentful-management": "11.48.0",
     "dotenv": "16.4.7",
     "esbuild": "^0.25.0",
     "ignore": "7.0.3",
@@ -67,7 +67,7 @@
     "tiged": "^2.12.7",
     "zod": "^3.24.1"
   },
-  "gitHead": "c86c0866476bf0cae4f72ff8730c2ff9c120a593",
+  "gitHead": "19544e247831ead71d56506298ed3335aa852d4a",
   "devDependencies": {
     "@types/adm-zip": "0.5.7",
     "@types/analytics-node": "3.1.14",