@contentful/app-scripts 1.33.0 → 1.33.2

package/lib/bin.js

@@ -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);
     });

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

@@ -1,3 +1,4 @@
-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 validateArguments(options: GenerateFunctionSettings): void;
+export declare function buildGenerateFunctionSettingsCLI(options: GenerateFunctionSettings): Promise<GenerateFunctionSettings>;

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

@@ -3,8 +3,9 @@ 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.validateArguments = validateArguments;
+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,140 +13,93 @@ 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() {
+const types_1 = require("./types");
+async function buildGenerateFunctionSettingsInteractive() {
     const baseSettings = await inquirer_1.default.prompt([
         {
             name: 'name',
             message: `Function name (${path_1.default.basename(process.cwd())}):`,
         },
+    ]);
+    validateFunctionName(baseSettings);
+    const filteredSources = await (0, get_github_folder_names_1.getGithubFolderNames)();
+    const sourceSpecificSettings = await inquirer_1.default.prompt([
+        {
+            name: 'example',
+            message: 'Select an example:',
+            type: 'list',
+            choices: filteredSources,
+        },
         {
-            name: 'sourceType',
-            message: 'Do you want to start with a blank template or use one of our examples?',
+            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',
         }
     ]);
+    baseSettings.example = sourceSpecificSettings.example;
+    baseSettings.language = sourceSpecificSettings.language;
+    return baseSettings;
+}
+function validateFunctionName(baseSettings) {
     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();
+        throw new types_1.ValidationError(chalk_1.default.red(`Invalid function name: ${baseSettings.name} is not allowed.`));
     }
-    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',
-            }
-        ]);
+    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.`));
     }
-    baseSettings.sourceName = sourceSpecificSettings.sourceName;
-    baseSettings.language = sourceSpecificSettings.language;
-    return baseSettings;
 }
 function validateArguments(options) {
-    const templateRequired = ['name', 'template'];
-    const exampleRequired = ['name', 'example', 'language'];
-    if (constants_1.BANNED_FUNCTION_NAMES.includes(options.name)) {
-        throw new Error(`Invalid function name: ${options.name}`);
+    const requiredParams = ['name', 'example', 'language'];
+    if (!requiredParams.every((key) => key in options)) {
+        throw new types_1.ValidationError(chalk_1.default.red('You must specify a function name, an example, and a language'));
     }
-    if ('template' in options) {
-        if (!templateRequired.every((key) => key in options)) {
-            throw new Error('You must specify a function name and a template');
-        }
+    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';
     }
-    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');
+    // Convert options to lowercase and trim whitespace
+    for (const key in options) {
+        const optionKey = key;
+        const value = options[optionKey].toLowerCase().trim();
+        if (optionKey === 'language') {
+            options[optionKey] = value;
+        }
+        else if (optionKey === 'example') {
+            options[optionKey] = value;
+        }
+        else { // don't want to lowercase function names
+            options[optionKey] = options[optionKey].trim();
         }
-    }
-    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();
-        }
-        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;
-        }
-        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;
+        // Check if the source exists
+        const filteredSources = await (0, get_github_folder_names_1.getGithubFolderNames)();
+        if (!filteredSources.includes(options.example)) {
+            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;
     }
     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,23 +41,19 @@ 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) {
-    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}`;
 }
 async function touchupAppManifest(localPath, settings, renameFunctionFile) {
     const appManifest = JSON.parse(node_fs_1.default.readFileSync(`${localPath}/${constants_1.CONTENTFUL_APP_MANIFEST}`, 'utf-8'));
     const entry = appManifest["functions"][appManifest["functions"].length - 1];
     entry.id = settings.name;
     // the path always has a .js extension
-    entry.path = `./functions/${renameFunctionFile.replace('.ts', '.js')}`;
-    entry.entryFile = `./functions/${renameFunctionFile}`;
+    entry.path = `functions/${renameFunctionFile.replace('.ts', '.js')}`;
+    entry.entryFile = `functions/${renameFunctionFile}`;
     await node_fs_1.default.writeFileSync(`${localPath}/${constants_1.CONTENTFUL_APP_MANIFEST}`, JSON.stringify(appManifest, null, 2));
 }
 function moveFilesToFinalDirectory(localTmpPath, localFunctionsPath) {

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.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

@@ -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.buildGenerateFunctionSettings)();
-    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.buildGenerateFunctionSettingsFromOptions)(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/types.d.ts

@@ -82,21 +82,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.33.0",
+  "version": "1.33.2",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -57,7 +57,7 @@
     "commander": "12.1.0",
     "contentful-management": "11.47.2",
     "dotenv": "16.4.7",
-    "esbuild": "^0.25.0",
+    "esbuild": "^0.25.1",
     "ignore": "7.0.3",
     "inquirer": "8.2.6",
     "lodash": "4.17.21",
@@ -67,7 +67,7 @@
     "tiged": "^2.12.7",
     "zod": "^3.24.1"
   },
-  "gitHead": "c34e17b5b5023762d190708c19281809eb14734b",
+  "gitHead": "16080d23910b9db1ed499202123da3ba1c975d3a",
   "devDependencies": {
     "@types/adm-zip": "0.5.7",
     "@types/analytics-node": "3.1.14",