@contentful/app-scripts 2.1.0 → 2.1.2

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);
@@ -86,10 +86,9 @@ async function runCommand(command, options) {
     commander_1.program
         .command('generate-function')
         .description('Generate a new Contentful Function')
-        .option('--name <name>', 'Name of the function')
-        .option('--template <language>', 'Select a template and language for the function')
-        .option('--example <example_name>', 'Select an example function to generate')
-        .option('--language <language>', 'Select a language for the function')
+        .option('-n, --name <name>', 'Name of the function')
+        .option('-e, --example <example>', 'Name of the reference example')
+        .option('-l, --language <language>', 'Select a language for the function')
         .action(async (options) => {
         await runCommand(index_1.generateFunction, options);
     });
@@ -98,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,3 @@
-import { GenerateFunctionSettings, GenerateFunctionOptions } from '../types';
-export declare function buildGenerateFunctionSettings(): Promise<GenerateFunctionSettings>;
-export declare function buildGenerateFunctionSettingsFromOptions(options: GenerateFunctionOptions): Promise<GenerateFunctionSettings>;
+import { GenerateFunctionSettings } from '../types';
+export declare function buildGenerateFunctionSettingsInteractive(): Promise<GenerateFunctionSettings>;
+export declare function buildGenerateFunctionSettingsCLI(options: GenerateFunctionSettings): Promise<GenerateFunctionSettings>;

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

@@ -3,8 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildGenerateFunctionSettings = buildGenerateFunctionSettings;
-exports.buildGenerateFunctionSettingsFromOptions = buildGenerateFunctionSettingsFromOptions;
+exports.buildGenerateFunctionSettingsInteractive = buildGenerateFunctionSettingsInteractive;
+exports.buildGenerateFunctionSettingsCLI = buildGenerateFunctionSettingsCLI;
 const inquirer_1 = __importDefault(require("inquirer"));
 const path_1 = __importDefault(require("path"));
 const get_github_folder_names_1 = require("./get-github-folder-names");
@@ -12,131 +12,80 @@ const constants_1 = require("./constants");
 const ora_1 = __importDefault(require("ora"));
 const chalk_1 = __importDefault(require("chalk"));
 const logger_1 = require("./logger");
-async function buildGenerateFunctionSettings() {
+async function buildGenerateFunctionSettingsInteractive() {
     const baseSettings = await inquirer_1.default.prompt([
         {
             name: 'name',
             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}`);
+    }
+    const filteredSources = await (0, get_github_folder_names_1.getGithubFolderNames)();
+    const sourceSpecificSettings = await inquirer_1.default.prompt([
         {
-            name: 'sourceType',
-            message: 'Do you want to start with a blank template or use one of our examples?',
+            name: 'example',
+            message: 'Select an example:',
+            type: 'list',
+            choices: filteredSources,
+        },
+        {
+            name: 'language',
+            message: 'Select a language',
             type: 'list',
             choices: [
-                { name: 'Template', value: 'template' },
-                { name: 'Example', value: 'example' },
+                { name: 'TypeScript', value: 'typescript' },
+                { name: 'JavaScript', value: 'javascript' },
             ],
-            default: 'template',
+            default: 'typescript',
         }
     ]);
-    if (constants_1.BANNED_FUNCTION_NAMES.includes(baseSettings.name)) {
-        throw new Error(`Invalid function name: ${baseSettings.name}`);
-    }
-    let sourceSpecificSettings;
-    if (baseSettings.sourceType === 'template') {
-        sourceSpecificSettings = await inquirer_1.default.prompt([
-            {
-                name: 'language',
-                message: 'Pick a template',
-                type: 'list',
-                choices: [
-                    { name: 'TypeScript', value: 'typescript' },
-                    { name: 'JavaScript', value: 'javascript' },
-                ],
-                default: 'typescript',
-            }
-        ]);
-        sourceSpecificSettings.sourceName = sourceSpecificSettings.language.toLowerCase();
-    }
-    else {
-        const availableExamples = await (0, get_github_folder_names_1.getGithubFolderNames)();
-        const filteredExamples = availableExamples.filter((template) => constants_1.ACCEPTED_EXAMPLE_FOLDERS.includes(template));
-        sourceSpecificSettings = await inquirer_1.default.prompt([
-            {
-                name: 'sourceName',
-                message: 'Select an example:',
-                type: 'list',
-                choices: filteredExamples,
-            },
-            {
-                name: 'language',
-                message: 'Pick a template',
-                type: 'list',
-                choices: [
-                    { name: 'TypeScript', value: 'typescript' },
-                    { name: 'JavaScript', value: 'javascript' },
-                ],
-                default: 'typescript',
-            }
-        ]);
-    }
-    baseSettings.sourceName = sourceSpecificSettings.sourceName;
+    baseSettings.example = sourceSpecificSettings.example;
     baseSettings.language = sourceSpecificSettings.language;
     return baseSettings;
 }
 function validateArguments(options) {
-    const templateRequired = ['name', 'template'];
-    const exampleRequired = ['name', 'example', 'language'];
+    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');
+    }
     if (constants_1.BANNED_FUNCTION_NAMES.includes(options.name)) {
         throw new Error(`Invalid function name: ${options.name}`);
     }
-    if ('template' in options) {
-        if (!templateRequired.every((key) => key in options)) {
-            throw new Error('You must specify a function name and a template');
+    // 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 if ('example' in options) {
-        if (!exampleRequired.every((key) => key in options)) {
-            throw new Error('You must specify a function name, an example, and a language');
+        else {
+            options[optionKey] = value;
         }
     }
-    else {
-        throw new Error('You must specify either --template or --example');
-    }
 }
-async function buildGenerateFunctionSettingsFromOptions(options) {
+async function buildGenerateFunctionSettingsCLI(options) {
     const validateSpinner = (0, ora_1.default)('Validating your input\n').start();
     const settings = {};
     try {
         validateArguments(options);
-        for (const key in options) { // convert all options to lowercase and trim
-            const optionKey = key;
-            options[optionKey] = options[optionKey].toLowerCase().trim();
+        // 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(', ')}`);
         }
-        if ('example' in options) {
-            if ('template' in options) {
-                throw new Error('Cannot specify both --template and --example');
-            }
-            if (!constants_1.ACCEPTED_EXAMPLE_FOLDERS.includes(options.example)) {
-                throw new Error(`Invalid example name: ${options.example}`);
-            }
-            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;
-            }
-            settings.sourceType = 'example';
-            settings.sourceName = options.example;
-            settings.name = options.name;
+        // 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 if ('template' in options) {
-            if ('language' in options && options.language && options.language != options.template) {
-                console.warn(`Ignoring language option: ${options.language}. Defaulting to ${options.template}.`);
-            }
-            if (!constants_1.ACCEPTED_LANGUAGES.includes(options.template)) {
-                console.warn(`Invalid language: ${options.template}. Defaulting to TypeScript.`);
-                settings.language = 'typescript';
-                settings.sourceName = 'typescript';
-            }
-            else {
-                settings.language = options.template;
-                settings.sourceName = options.template;
-            }
-            settings.sourceType = 'template';
-            settings.name = options.name;
+        else {
+            settings.language = options.language;
         }
+        settings.example = options.example;
+        settings.name = options.name;
         return settings;
     }
     catch (err) {

package/lib/generate-function/clone.js

@@ -45,11 +45,7 @@ async function cloneFunction(localPath, settings) {
     }
 }
 function getCloneURL(settings) {
-    let cloneURL = `${constants_1.REPO_URL}/${settings.sourceName}`; // this is the default for template
-    if (settings.sourceType === 'example') {
-        cloneURL = `${constants_1.REPO_URL}/${settings.sourceName}/${settings.language}`;
-    }
-    return cloneURL;
+    return `${constants_1.REPO_URL}/${settings.example}/${settings.language}`; // this is the default for template
 }
 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/index.d.ts

@@ -1,5 +1,5 @@
-import { GenerateFunctionOptions } from "../types";
+import { GenerateFunctionSettings } from "../types";
 export declare const generateFunction: {
     interactive: () => Promise<void>;
-    nonInteractive: (options: GenerateFunctionOptions) => Promise<void>;
+    nonInteractive: (options: GenerateFunctionSettings) => Promise<void>;
 };

package/lib/generate-function/index.js

@@ -4,11 +4,11 @@ exports.generateFunction = void 0;
 const build_generate_function_settings_1 = require("./build-generate-function-settings");
 const create_function_1 = require("./create-function");
 const interactive = async () => {
-    const generateFunctionSettings = await (0, build_generate_function_settings_1.buildGenerateFunctionSettings)();
+    const generateFunctionSettings = await (0, build_generate_function_settings_1.buildGenerateFunctionSettingsInteractive)();
     return (0, create_function_1.create)(generateFunctionSettings);
 };
 const nonInteractive = async (options) => {
-    const generateFunctionSettings = await (0, build_generate_function_settings_1.buildGenerateFunctionSettingsFromOptions)(options);
+    const generateFunctionSettings = await (0, build_generate_function_settings_1.buildGenerateFunctionSettingsCLI)(options);
     return (0, create_function_1.create)(generateFunctionSettings);
 };
 exports.generateFunction = {

package/lib/types.d.ts

@@ -71,21 +71,9 @@ export interface BuildFunctionsOptions {
     esbuildConfig?: string;
     watch?: boolean;
 }
-export type SourceType = 'template' | 'example';
 export type Language = 'javascript' | 'typescript';
-export type AcceptedFunctionExamples = 'appevent-handler';
-export type SourceName = Language | AcceptedFunctionExamples;
 export interface GenerateFunctionSettings {
     name: string;
-    sourceType: SourceType;
-    sourceName: SourceName;
+    example: string;
     language: Language;
 }
-export type GenerateFunctionOptions = {
-    name: string;
-} & ({
-    example: AcceptedFunctionExamples;
-    language: Language;
-} | {
-    template: Language;
-});

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.0",
+  "version": "2.1.2",
   "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\"",
@@ -67,7 +67,7 @@
     "tiged": "^2.12.7",
     "zod": "^3.24.1"
   },
-  "gitHead": "c5dc99f22aa80565484497549a0b4f4dc5e35b7b",
+  "gitHead": "b88a46b43fc31d1da7cf625f32a5beb03badf99e",
   "devDependencies": {
     "@types/adm-zip": "0.5.7",
     "@types/analytics-node": "3.1.14",