@contentful/app-scripts 1.21.0 → 1.22.0

package/lib/analytics.js

@@ -26,7 +26,7 @@ function track({ command, ci }) {
                 command,
                 ci: String(ci),
             },
-            anonymousId: Date.now().toString(),
+            anonymousId: Date.now().toString(), // generate a random id
             timestamp: new Date(),
         });
         // eslint-disable-next-line no-empty

package/lib/create-app-definition/build-app-definition-settings.d.ts

@@ -1,8 +1,13 @@
-import { AppLocation, FieldType } from 'contentful-management';
+import { AppLocation, FieldType, ParameterDefinition, InstallationParameterType } from 'contentful-management';
 export interface AppDefinitionSettings {
     name: string;
     locations: AppLocation['location'][];
     fields?: FieldType[];
     host?: string;
+    buildAppParameters: boolean;
+    parameters?: {
+        instance: ParameterDefinition[];
+        installation: ParameterDefinition<InstallationParameterType>[];
+    };
 }
 export declare function buildAppDefinitionSettings(): Promise<AppDefinitionSettings>;

package/lib/create-app-definition/build-app-definition-settings.js

@@ -8,6 +8,7 @@ const chalk_1 = __importDefault(require("chalk"));
 const inquirer_1 = __importDefault(require("inquirer"));
 const path_1 = __importDefault(require("path"));
 const constants_1 = require("../constants");
+const build_app_parameter_settings_1 = require("./build-app-parameter-settings");
 async function buildAppDefinitionSettings() {
     console.log(chalk_1.default.dim(`
 NOTE: This will create an app definition in your Contentful organization.
@@ -79,7 +80,16 @@ NOTE: This will create an app definition in your Contentful organization.
             message: `Contentful CMA endpoint URL:`,
             default: constants_1.DEFAULT_CONTENTFUL_API_HOST,
         },
+        {
+            name: 'buildAppParameters',
+            message: 'Would you like to specify App Parameter schemas? (see https://ctfl.io/app-parameters)',
+            type: 'confirm',
+            default: false,
+        },
     ]);
+    if (appDefinitionSettings.buildAppParameters) {
+        appDefinitionSettings.parameters = await (0, build_app_parameter_settings_1.buildAppParameterSettings)();
+    }
     appDefinitionSettings.locations = ['dialog', ...appDefinitionSettings.locations];
     return appDefinitionSettings;
 }

package/lib/create-app-definition/build-app-parameter-settings.d.ts

@@ -0,0 +1,5 @@
+import { InstallationParameterType, ParameterDefinition } from 'contentful-management';
+export declare function buildAppParameterSettings(): Promise<{
+    instance: ParameterDefinition[];
+    installation: ParameterDefinition<InstallationParameterType>[];
+}>;

package/lib/create-app-definition/build-app-parameter-settings.js

@@ -0,0 +1,183 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAppParameterSettings = void 0;
+const inquirer_1 = __importDefault(require("inquirer"));
+const lodash_1 = require("lodash");
+const PARAMETER_ID_RE = /^[a-zA-Z][a-zA-Z0-9_]*$/;
+const validateDefault = (input, type, options) => {
+    if (input === '')
+        return true;
+    switch (type) {
+        case 'Symbol':
+            return (0, lodash_1.isString)(input) || 'Default value must be a string.';
+        case 'Enum':
+            if (!(0, lodash_1.isString)(input))
+                return 'Default value must be a string.';
+            else if (options && !options.includes(input))
+                return 'Default value must be one of the options.';
+            return true;
+        case 'Number':
+            return (0, lodash_1.isNumber)(Number(input)) || 'Default value must be a number.';
+        case 'Boolean':
+            return input === 'true' || input === 'false' || 'Default value must be a boolean.';
+        default:
+            return true;
+    }
+};
+const validateEnumOptions = (input, type) => {
+    if (type !== 'Enum')
+        return true;
+    const allString = input.every(lodash_1.isString);
+    const allLabelled = input.every(lodash_1.isPlainObject);
+    return allString || allLabelled || 'Options should be all strings or all label objects.';
+};
+async function promptForParameter() {
+    const parameter = await inquirer_1.default.prompt([
+        {
+            name: 'instanceOrInstallation',
+            message: 'Is this an Instance or an Installation parameter?',
+            type: 'list',
+            choices: ['Instance', 'Installation'],
+        },
+        {
+            name: 'name',
+            message: 'Parameter name:',
+            validate(input) {
+                return input ? true : 'Parameter name is required.';
+            },
+        },
+        {
+            name: 'id',
+            message: 'Parameter ID:',
+            validate(input) {
+                if (!input)
+                    return 'Parameter ID is required.';
+                else if (!PARAMETER_ID_RE.test(input))
+                    return 'Parameter ID must start with a letter and contain only letters, numbers, and underscores.';
+                return true;
+            },
+        },
+        {
+            name: 'description',
+            message: 'Parameter description (optional):',
+        },
+        {
+            name: 'type',
+            message: 'Parameter type:',
+            type: 'list',
+            choices(answers) {
+                const parameterTypes = ['Boolean', 'Symbol', 'Number', 'Enum'];
+                // TODO uncomment when secret app installation parameters are finalized in the API
+                // if (answers.instanceOrInstallation === 'Installation') {
+                //   parameterTypes.push('Secret');
+                // }
+                return parameterTypes;
+            },
+        },
+        {
+            name: 'required',
+            message: 'Is this parameter required?',
+            type: 'confirm',
+            default: false,
+        },
+        {
+            name: 'options',
+            message: 'Parameter options (comma-separated) (optional):',
+            when(answers) {
+                return answers.type === 'Enum';
+            },
+            filter(input) {
+                return input ? input.split(',').map((opt) => opt.trim()) : [];
+            },
+            validate(input, answers) {
+                if (!input)
+                    return 'Options are required for Enum parameters.';
+                return validateEnumOptions(input, answers.type);
+            },
+        },
+        {
+            name: 'default',
+            message: 'Default value (leave blank if none):',
+            // TODO uncomment when secret app installation parameters are finalized in the API
+            // when(answers) {
+            //   return answers.type !== 'Secret';
+            // },
+            validate(input, answers) {
+                return validateDefault(input, answers.type, answers.options);
+            },
+        },
+        {
+            name: 'booleanLabels',
+            message: 'Parameter labels (true/false comma-separated) (optional):',
+            when(answers) {
+                return answers.type === 'Boolean';
+            },
+            filter(input) {
+                const labels = input ? input.split(',').map((label) => label.trim()) : [];
+                return JSON.stringify({
+                    true: labels[0] || '',
+                    false: labels[1] || '',
+                });
+            },
+        },
+        {
+            name: 'enumEmptyLabel',
+            message: 'Empty label (optional):',
+            filter(input) {
+                return JSON.stringify({
+                    empty: input.trim(),
+                });
+            },
+            when(answers) {
+                return answers.type === 'Enum';
+            },
+        },
+    ]);
+    return parameter;
+}
+async function buildAppParameterSettings() {
+    const parameters = {
+        instance: [],
+        installation: [],
+    };
+    let addMore = true;
+    while (addMore) {
+        try {
+            const parameter = await promptForParameter();
+            const labels = parameter.booleanLabels || parameter.enumEmptyLabel;
+            parameters[parameter.instanceOrInstallation.toLowerCase()].push({
+                id: parameter.id,
+                name: parameter.name,
+                description: parameter.description,
+                type: parameter.type,
+                required: parameter.required,
+                default: parameter.default,
+                options: parameter.options,
+                labels: labels ? JSON.parse(labels) : undefined,
+            });
+        }
+        catch (e) {
+            console.error('Failed to build parameter', e);
+        }
+        const { addAnother } = await inquirer_1.default.prompt({
+            name: 'addAnother',
+            message: 'Do you want to add another parameter?',
+            type: 'confirm',
+            default: false,
+        });
+        addMore = addAnother;
+    }
+    if ((0, lodash_1.uniq)(parameters.instance.map((p) => p.id)).length !== parameters.instance.length) {
+        console.log('Instance parameter IDs must be unique.');
+        return buildAppParameterSettings();
+    }
+    if ((0, lodash_1.uniq)(parameters.installation.map((p) => p.id)).length !== parameters.installation.length) {
+        console.log('Installation parameter IDs must be unique.');
+        return buildAppParameterSettings();
+    }
+    return parameters;
+}
+exports.buildAppParameterSettings = buildAppParameterSettings;

package/lib/create-app-definition/create-app-definition.js

@@ -33,7 +33,7 @@ function assertValidArguments(accessToken, appDefinitionSettings) {
         (0, utils_1.throwValidationException)('AccessToken', `Expected string got ${typeof accessToken}`);
     }
     if (!(0, lodash_1.isPlainObject)(appDefinitionSettings) || !(0, lodash_1.has)(appDefinitionSettings, 'locations')) {
-        (0, utils_1.throwValidationException)('AppDefinitionSettings', `Expected plain object with 'location' property, got ${JSON.stringify(appDefinitionSettings, null, 2)}`, `Example: ${JSON.stringify({
+        (0, utils_1.throwValidationException)('AppDefinitionSettings', `Expected plain object with 'locations' property, got ${JSON.stringify(appDefinitionSettings, null, 2)}`, `Example: ${JSON.stringify({
             name: 'app-name',
             locations: ['entry-field'],
             fields: [{ type: 'Boolean' }],
@@ -61,6 +61,14 @@ async function createAppDefinition(accessToken, appDefinitionSettings) {
                 location,
             };
         }),
+        parameters: {
+            ...(appDefinitionSettings.parameters?.instance && {
+                instance: appDefinitionSettings.parameters.instance,
+            }),
+            ...(appDefinitionSettings.parameters?.installation && {
+                installation: appDefinitionSettings.parameters.installation,
+            }),
+        },
     };
     try {
         const organization = await client.getOrganization(organizationId);

package/lib/get-app-info.d.ts

@@ -1,8 +1,8 @@
 export declare const getAppInfo: ({ organizationId, definitionId, token, host, }: {
-    organizationId?: string | undefined;
-    definitionId?: string | undefined;
-    token?: string | undefined;
-    host?: string | undefined;
+    organizationId?: string;
+    definitionId?: string;
+    token?: string;
+    host?: string;
 }) => Promise<{
     accessToken: string;
     organization: import("./organization-api").Organization;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -48,7 +48,7 @@
   },
   "dependencies": {
     "@segment/analytics-node": "^2.0.0",
-    "adm-zip": "0.5.12",
+    "adm-zip": "0.5.14",
     "bottleneck": "2.19.5",
     "chalk": "4.1.2",
     "commander": "12.1.0",
@@ -60,16 +60,19 @@
     "open": "8.4.2",
     "ora": "5.4.1"
   },
-  "gitHead": "81cc3ea1a7090350e4791112816a82b243c3fc14",
+  "gitHead": "7aee855902d01d921a74350772f24ce1d90aeff8",
   "devDependencies": {
     "@tsconfig/node18": "18.2.4",
     "@types/adm-zip": "0.5.5",
     "@types/analytics-node": "3.1.14",
+    "@types/chai": "4.3.16",
     "@types/inquirer": "8.2.1",
     "@types/lodash": "4.17.4",
     "@types/mocha": "10.0.6",
     "@types/proxyquire": "1.3.31",
     "@types/sinon": "17.0.3",
+    "chai": "5.1.1",
+    "mocha": "10.4.0",
     "proxyquire": "2.1.3",
     "sinon": "18.0.0",
     "ts-mocha": "10.0.0",