@contentful/app-scripts 1.33.0 → 2.0.0

package/README.md

@@ -310,3 +310,43 @@ Options:
 -m, --manifest-file <path> Contentful app manifest file path
 -w, --watch watch for changes
 -h, --help display help for command
+
+### Upsert App Actions
+
+Creates or updates Actions for an App using the configuration in a Contentful App Manifest file. Created resources will be synced back to your manifest file.
+
+#### Interactive mode:
+
+In the interactive mode, the CLI will ask for all required options.
+
+> **Example**
+>
+> ```shell
+> $ npx --no-install @contentful/app-scripts upsert-actions
+> ```
+
+#### Non-interactive mode:
+
+When passing the `--ci` argument adding all variables as arguments is required.
+
+> **Example**
+>
+> ```shell
+> $ npx --no-install @contentful/app-scripts upsert-actions --ci \
+>     --manifest-file path/to/contentful-app-manifest.json \
+>     --organization-id some-org-id \
+>     --definition-id some-app-def-id \
+>     --token $MY_CONTENTFUL_PAT
+> ```
+
+**Options:**
+
+| Argument            | Description                                                                                                                                | Default value                  |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------ |
+| `--manifest-file`   | The path to the Contentful app manifest file                                                                                               | `contentful-app-manifest.json` |
+| `--organization-id` | The ID of the organization which the app is defined in                                                                                     |                                |
+| `--definition-id`   | The ID of the app to which to add the actions                                                                                              |                                |
+| `--token`           | A personal [access token](https://www.contentful.com/developers/docs/references/content-management-api/#/reference/personal-access-tokens) |                                |
+| `--host`            | (optional) Contentful CMA-endpoint to use                                                                                                  | `api.contentful.com`           |
+
+**Note:** You can also pass all arguments in interactive mode to skip being asked for it.

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 apps 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 apps 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 apps 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 apps 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 apps 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);
@@ -93,6 +93,17 @@ async function runCommand(command, options) {
         .action(async (options) => {
         await runCommand(index_1.generateFunction, options);
     });
+    commander_1.program
+        .command('upsert-actions')
+        .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('--token [accessToken]', 'Your content management access token')
+        .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
+        .action(async (options) => {
+        await runCommand(index_1.upsertActions, options);
+    });
     commander_1.program.hook('preAction', (thisCommand) => {
         (0, index_1.track)({ command: thisCommand.args[0], ci: thisCommand.opts().ci });
     });

package/lib/build-functions/build-functions.d.ts

@@ -3,7 +3,6 @@ type ContentfulFunctionToBuild = Omit<ContentfulFunction, 'entryFile'> & {
     entryFile: string;
 };
 export declare const validateFunctions: (manifest: Record<string, any>) => void;
-export declare const resolveManifestFile: (options: BuildFunctionsOptions, cwd?: string) => any;
 export declare const resolveEsBuildConfig: (options: BuildFunctionsOptions, manifest: {
     functions: ContentfulFunctionToBuild[];
 }, cwd?: string) => any;

package/lib/build-functions/build-functions.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveEsBuildConfig = exports.resolveManifestFile = exports.validateFunctions = void 0;
+exports.resolveEsBuildConfig = exports.validateFunctions = void 0;
 exports.buildFunctions = buildFunctions;
 /* eslint-disable @typescript-eslint/no-var-requires */
 const esbuild_1 = __importDefault(require("esbuild"));
@@ -11,17 +11,18 @@ const path_1 = require("path");
 const node_modules_polyfill_1 = require("@esbuild-plugins/node-modules-polyfill");
 const node_globals_polyfill_1 = require("@esbuild-plugins/node-globals-polyfill");
 const zod_1 = require("zod");
+const utils_1 = require("../utils");
 const functionManifestSchema = zod_1.z
     .object({
     functions: zod_1.z.array(zod_1.z
         .object({
-        id: zod_1.z.string(),
+        id: zod_1.z.string().regex(utils_1.ID_REGEX, 'Invalid "id" (must only contain alphanumeric characters)'),
         name: zod_1.z.string(),
         description: zod_1.z.string(),
         path: zod_1.z.string(),
         entryFile: zod_1.z.string(),
         accepts: zod_1.z.array(zod_1.z.string()),
-    })
+    }, {})
         .required()),
 })
     .required();
@@ -52,12 +53,6 @@ const validateFunctions = (manifest) => {
     });
 };
 exports.validateFunctions = validateFunctions;
-const resolveManifestFile = (options, cwd = process.cwd()) => {
-    return require(options.manifestFile
-        ? (0, path_1.resolve)(cwd, options.manifestFile)
-        : (0, path_1.resolve)(cwd, 'contentful-app-manifest.json'));
-};
-exports.resolveManifestFile = resolveManifestFile;
 const getEntryPoints = (manifest, cwd = process.cwd()) => {
     return manifest.functions.reduce((result, contentfulFunction) => {
         const fileProperties = (0, path_1.parse)(contentfulFunction.path);
@@ -85,7 +80,7 @@ const resolveEsBuildConfig = (options, manifest, cwd = process.cwd()) => {
 };
 exports.resolveEsBuildConfig = resolveEsBuildConfig;
 async function buildFunctions(options) {
-    const manifest = (0, exports.resolveManifestFile)(options);
+    const manifest = (0, utils_1.resolveManifestFile)(options);
     try {
         console.log('Building functions');
         (0, exports.validateFunctions)(manifest);

package/lib/index.d.ts

@@ -8,3 +8,4 @@ export { feedback } from './feedback';
 export { install } from './install';
 export { buildFunctions } from './build-functions';
 export { generateFunction } from './generate-function';
+export { upsertActions } from './upsert-actions';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateFunction = exports.buildFunctions = exports.install = exports.feedback = exports.track = exports.open = exports.cleanup = exports.activate = exports.upload = exports.createAppDefinition = void 0;
+exports.upsertActions = exports.generateFunction = exports.buildFunctions = exports.install = exports.feedback = exports.track = exports.open = exports.cleanup = exports.activate = exports.upload = exports.createAppDefinition = void 0;
 var create_app_definition_1 = require("./create-app-definition");
 Object.defineProperty(exports, "createAppDefinition", { enumerable: true, get: function () { return create_app_definition_1.createAppDefinition; } });
 var upload_1 = require("./upload");
@@ -21,3 +21,5 @@ var build_functions_1 = require("./build-functions");
 Object.defineProperty(exports, "buildFunctions", { enumerable: true, get: function () { return build_functions_1.buildFunctions; } });
 var generate_function_1 = require("./generate-function");
 Object.defineProperty(exports, "generateFunction", { enumerable: true, get: function () { return generate_function_1.generateFunction; } });
+var upsert_actions_1 = require("./upsert-actions");
+Object.defineProperty(exports, "upsertActions", { enumerable: true, get: function () { return upsert_actions_1.upsertActions; } });

package/lib/types.d.ts

@@ -1,15 +1,5 @@
 import { Definition } from './definition-api';
 import { Organization } from './organization-api';
-export interface FunctionAppAction {
-    id: string;
-    name: string;
-    description: string;
-    category: 'Custom';
-    type: 'function';
-    path: string;
-    allowNetworks?: string[];
-    entryFile?: string;
-}
 export interface ContentfulFunction {
     id: string;
     name: string;
@@ -74,7 +64,6 @@ export interface UploadSettings {
     skipActivation?: boolean;
     userAgentApplication?: string;
     host?: string;
-    actions?: FunctionAppAction[];
     functions?: ContentfulFunction[];
 }
 export interface BuildFunctionsOptions {

package/lib/upload/build-upload-settings.js

@@ -7,8 +7,7 @@ const get_app_info_1 = require("../get-app-info");
 const utils_1 = require("../utils");
 const constants_1 = require("../constants");
 async function buildAppUploadSettings(options) {
-    const actionsManifest = (0, utils_1.getEntityFromManifest)('actions');
-    const functionManifest = (0, utils_1.getEntityFromManifest)('functions');
+    const functionManifest = (0, utils_1.getFunctionsFromManifest)();
     const prompts = [];
     const { bundleDir, comment, skipActivation, host } = options;
     if (!bundleDir) {
@@ -49,7 +48,6 @@ async function buildAppUploadSettings(options) {
         skipActivation: skipActivation === undefined ? !activateBundle : skipActivation,
         comment,
         host: hostValue,
-        actions: actionsManifest,
         functions: functionManifest,
         ...appUploadSettings,
         ...appInfo,

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

@@ -11,7 +11,7 @@ const utils_1 = require("../utils");
 const contentful_management_1 = require("contentful-management");
 const create_app_upload_1 = require("./create-app-upload");
 async function createAppBundleFromUpload(settings, appUploadId) {
-    const { accessToken, host, userAgentApplication, comment, actions, functions } = settings;
+    const { accessToken, host, userAgentApplication, comment, functions } = settings;
     const clientSpinner = (0, ora_1.default)('Verifying your upload...').start();
     const client = (0, contentful_management_1.createClient)({
         accessToken,
@@ -27,7 +27,6 @@ async function createAppBundleFromUpload(settings, appUploadId) {
         appBundle = await appDefinition.createAppBundle({
             appUploadId,
             comment: comment && comment.length > 0 ? comment : undefined,
-            actions,
             functions,
         });
     }

package/lib/upload/get-upload-settings-args.js

@@ -17,8 +17,7 @@ const requiredOptions = {
 };
 async function getUploadSettingsArgs(options) {
     const validateSpinner = (0, ora_1.default)('Validating your input...').start();
-    const actionsManifest = (0, utils_1.getEntityFromManifest)('actions');
-    const functionManifest = (0, utils_1.getEntityFromManifest)('functions');
+    const functionManifest = (0, utils_1.getFunctionsFromManifest)();
     const { bundleDir, comment, skipActivation, host, userAgentApplication } = options;
     try {
         (0, validate_arguments_1.validateArguments)(requiredOptions, options, 'upload');
@@ -30,7 +29,6 @@ async function getUploadSettingsArgs(options) {
             comment,
             host,
             userAgentApplication,
-            actions: actionsManifest,
             functions: functionManifest,
         };
     }

package/lib/upload/validate-bundle.d.ts

@@ -1,2 +1,2 @@
 import { UploadSettings } from '../types';
-export declare const validateBundle: (path: string, { functions, actions }: Pick<UploadSettings, "functions" | "actions">) => void;
+export declare const validateBundle: (path: string, { functions }: Pick<UploadSettings, "functions">) => void;

package/lib/upload/validate-bundle.js

@@ -13,11 +13,11 @@ const ABSOLUTE_PATH_REG_EXP = /(src|href)="\/([^/])([^"]*)+"/g;
 const fileContainsAbsolutePath = (fileContent) => {
     return [...fileContent.matchAll(ABSOLUTE_PATH_REG_EXP)].length > 0;
 };
-const validateBundle = (path, { functions, actions }) => {
+const validateBundle = (path, { functions }) => {
     const buildFolder = path_1.default.join('./', path);
     const files = fs_1.default.readdirSync(buildFolder, { recursive: true, encoding: 'utf-8' });
     const entry = getEntryFile(files);
-    if (!entry && !functions && !actions) {
+    if (!entry && !functions) {
         throw new Error('Ensure your bundle includes a valid index.html file in its root folder, or a valid Contentful Function entrypoint (defined in your contentful-app-manifest.json file).');
     }
     if (entry) {
@@ -34,11 +34,5 @@ const validateBundle = (path, { functions, actions }) => {
             throw new Error(`Function "${functionWithoutEntryFile.id}" is missing its entry file at "${path_1.default.join(buildFolder, functionWithoutEntryFile.path)}".`);
         }
     }
-    if (actions) {
-        const actionWithoutEntryFile = actions.find(({ path }) => !files.includes(path));
-        if (actionWithoutEntryFile) {
-            throw new Error(`Action "${actionWithoutEntryFile.id}" is missing its entry file at "${path_1.default.join(buildFolder, actionWithoutEntryFile.path)}".`);
-        }
-    }
 };
 exports.validateBundle = validateBundle;

package/lib/upsert-actions/client.d.ts

@@ -0,0 +1,4 @@
+import { AppActionProps, CreateAppActionProps, PlainClientAPI } from 'contentful-management';
+export declare function createAction(client: PlainClientAPI, appDefinitionId: string, payload: CreateAppActionProps): Promise<AppActionProps>;
+export declare function getExistingAction(client: PlainClientAPI, appDefinitionId: string, appActionId: string): Promise<AppActionProps | null>;
+export declare function updateAction(client: PlainClientAPI, appDefinitionId: string, appActionId: string, payload: CreateAppActionProps): Promise<AppActionProps>;

package/lib/upsert-actions/client.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAction = createAction;
+exports.getExistingAction = getExistingAction;
+exports.updateAction = updateAction;
+const chalk_1 = require("chalk");
+async function createAction(client, appDefinitionId, payload) {
+    const action = await client.appAction.create({
+        appDefinitionId,
+    }, payload);
+    console.log(`
+			${(0, chalk_1.cyan)('Success!')} Created Action ${(0, chalk_1.cyan)(action.name)} with ID ${(0, chalk_1.cyan)(action.sys.id)} for App ${(0, chalk_1.cyan)(appDefinitionId)}.`);
+    return action;
+}
+async function getExistingAction(client, appDefinitionId, appActionId) {
+    try {
+        return await client.appAction.get({
+            appDefinitionId,
+            appActionId,
+        });
+    }
+    catch (err) {
+        if (err.name === 'NotFound') {
+            return null;
+        }
+        throw err;
+    }
+}
+async function updateAction(client, appDefinitionId, appActionId, payload) {
+    const action = await client.appAction.update({
+        appDefinitionId,
+        appActionId,
+    }, payload);
+    console.log(`
+			${(0, chalk_1.cyan)('Success!')} Updated Action ${(0, chalk_1.cyan)(action.name)} with ID ${(0, chalk_1.cyan)(appActionId)} for App ${(0, chalk_1.cyan)(appDefinitionId)}.`);
+    return action;
+}

package/lib/upsert-actions/get-cli-args.d.ts

@@ -0,0 +1,2 @@
+import { CreateAppActionSettings } from "./types";
+export declare function getCreateAppActionsArgs(settings: Record<string, any>): Promise<Required<CreateAppActionSettings>>;

package/lib/upsert-actions/get-cli-args.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCreateAppActionsArgs = getCreateAppActionsArgs;
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const get_app_info_1 = require("../get-app-info");
+const validate_arguments_1 = require("../validate-arguments");
+const requiredOptions = {
+    organizationId: '--organization-id',
+    definitionId: '--definition-id',
+    token: '--token',
+};
+async function getCreateAppActionsArgs(settings) {
+    const validateSpinner = (0, ora_1.default)('Validating your input').start();
+    try {
+        (0, validate_arguments_1.validateArguments)(requiredOptions, settings, 'upsert-actions');
+        const appInfo = await (0, get_app_info_1.getAppInfo)(settings);
+        return {
+            host: settings.host || 'api.contentful.com',
+            manifestFile: settings.manifestFile,
+            accessToken: settings.token,
+            appDefinitionId: appInfo.definition.value,
+            organizationId: appInfo.organization.value,
+        };
+    }
+    catch (err) {
+        console.log(`
+			${chalk_1.default.red('Validation failed')}
+			${err.message}
+		`);
+        // eslint-disable-next-line no-process-exit
+        process.exit(1);
+    }
+    finally {
+        validateSpinner.stop();
+    }
+}

package/lib/upsert-actions/index.d.ts

@@ -0,0 +1,5 @@
+import { type CreateAppActionSettings } from './types';
+export declare const upsertActions: {
+    interactive: (options: CreateAppActionSettings) => Promise<void>;
+    nonInteractive: (options: CreateAppActionSettings) => Promise<void>;
+};

package/lib/upsert-actions/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upsertActions = void 0;
+const upsert_actions_1 = require("./upsert-actions");
+const get_cli_args_1 = require("./get-cli-args");
+const prompt_interactive_args_1 = require("./prompt-interactive-args");
+const interactive = async (options) => {
+    const settings = await (0, prompt_interactive_args_1.promptCreateAppAction)(options);
+    await (0, upsert_actions_1.upsertAppActions)(settings);
+};
+const nonInteractive = async (options) => {
+    const settings = await (0, get_cli_args_1.getCreateAppActionsArgs)(options);
+    await (0, upsert_actions_1.upsertAppActions)(settings);
+};
+exports.upsertActions = {
+    interactive,
+    nonInteractive,
+};

package/lib/upsert-actions/make-cma-payload.d.ts

@@ -0,0 +1,2 @@
+import { AppActionManifest, CreateAppActionPayload } from './types';
+export declare function makeAppActionCMAPayload(action: AppActionManifest): CreateAppActionPayload;

package/lib/upsert-actions/make-cma-payload.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeAppActionCMAPayload = makeAppActionCMAPayload;
+function makeAppActionCMAPayload(action) {
+    const baseProps = {
+        name: action.name,
+        ...(action.description && { description: action.description }),
+        ...(action.id && { id: action.id }),
+    };
+    const additionalPropsByType = action.type === 'function-invocation'
+        ? {
+            type: action.type,
+            function: {
+                sys: {
+                    id: action.functionId,
+                    linkType: 'Function',
+                    type: 'Link',
+                },
+            },
+        }
+        : {
+            type: action.type,
+            url: action.url,
+        };
+    const additionalPropsByCategory = action.category === 'Custom'
+        ? {
+            category: action.category,
+            parameters: action.parameters,
+        }
+        : {
+            category: action.category,
+        };
+    const payload = {
+        ...baseProps,
+        ...additionalPropsByType,
+        ...additionalPropsByCategory,
+    };
+    return payload;
+}

package/lib/upsert-actions/prompt-interactive-args.d.ts

@@ -0,0 +1,2 @@
+import { CreateAppActionSettings } from './types';
+export declare function promptCreateAppAction(options: Record<string, any>): Promise<Required<CreateAppActionSettings>>;

package/lib/upsert-actions/prompt-interactive-args.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptCreateAppAction = promptCreateAppAction;
+const inquirer_1 = require("inquirer");
+const constants_1 = require("../constants");
+const get_app_info_1 = require("../get-app-info");
+async function promptCreateAppAction(options) {
+    const { manifestFile, host } = options;
+    const prompts = [];
+    if (manifestFile === undefined) {
+        prompts.push({
+            type: 'input',
+            name: 'manifestFile',
+            message: `Path to your Contentful app manifest file:`,
+            default: constants_1.DEFAULT_APP_MANIFEST_PATH,
+        });
+    }
+    if (!host) {
+        prompts.push({
+            name: 'host',
+            message: `Contentful CMA endpoint URL:`,
+            default: 'api.contentful.com',
+        });
+    }
+    const { host: interactiveHost, manifestFile: interactiveManifest } = await (0, inquirer_1.prompt)(prompts);
+    const hostValue = host || interactiveHost;
+    const manifestFileValue = manifestFile || interactiveManifest;
+    const appInfo = await (0, get_app_info_1.getAppInfo)({ ...options, host: hostValue });
+    return {
+        host: hostValue,
+        manifestFile: manifestFileValue,
+        appDefinitionId: appInfo.definition.value,
+        accessToken: appInfo.accessToken,
+        organizationId: appInfo.organization.value,
+    };
+}

package/lib/upsert-actions/types.d.ts

@@ -0,0 +1,52 @@
+import { AppActionCategoryType, AppActionParameterDefinition } from "contentful-management";
+export type BaseAppActionProps = {
+    id?: string;
+    name: string;
+    description?: string;
+};
+export type FunctionAppActionManifestProps = {
+    type: 'function-invocation';
+    functionId: string;
+};
+export type EndpointAppActionProps = {
+    type: 'endpoint';
+    url: string;
+};
+export type CustomCategoryAppActionProps = {
+    category: 'Custom';
+    parameters: AppActionParameterDefinition[];
+};
+export type BuiltInCategoryAppActionProps = {
+    category: Omit<AppActionCategoryType, 'Custom'>;
+};
+type CategoryProps = CustomCategoryAppActionProps | BuiltInCategoryAppActionProps;
+export type FunctionAppActionProps = {
+    id?: string;
+    type: 'function-invocation';
+    function: {
+        sys: {
+            id: string;
+            linkType: string;
+            type: string;
+        };
+    };
+};
+export type AppActionManifest = BaseAppActionProps & (FunctionAppActionManifestProps | EndpointAppActionProps) & CategoryProps;
+export type CreateAppActionPayload = BaseAppActionProps & (FunctionAppActionProps | EndpointAppActionProps) & CategoryProps;
+export type AppActionToCreate = {
+    actions: AppActionManifest[];
+};
+export type CreateAppActionOptions = AppActionToCreate & {
+    organizationId: string;
+    appDefinitionId: string;
+    accessToken: string;
+    host: string;
+};
+export type CreateAppActionSettings = {
+    manifestFile?: string;
+    organizationId?: string;
+    appDefinitionId?: string;
+    accessToken?: string;
+    host?: string;
+};
+export {};

package/lib/upsert-actions/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/upsert-actions/upsert-actions.d.ts

@@ -0,0 +1,16 @@
+import { AppActionProps, PlainClientAPI } from 'contentful-management';
+import { AppActionManifest, CreateAppActionPayload, CreateAppActionSettings } from './types';
+export declare function doUpsert(client: PlainClientAPI, appDefinitionId: string, payload: CreateAppActionPayload): Promise<AppActionProps>;
+export declare function syncUpsertToManifest(manifestActions: AppActionManifest[], actionsToSync: {
+    [i: number]: AppActionManifest;
+}, manifest: Record<string, any>, manifestFile: string): void;
+export declare function processActionManifests(actions: AppActionManifest[], doUpsert: (payload: CreateAppActionPayload) => Promise<AppActionProps>): Promise<{
+    actionsToSync: {
+        [i: number]: AppActionManifest;
+    };
+    errors: {
+        details: any;
+        path: (string | number)[];
+    }[];
+}>;
+export declare function upsertAppActions(settings: Required<CreateAppActionSettings>): Promise<void>;

package/lib/upsert-actions/upsert-actions.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.doUpsert = doUpsert;
+exports.syncUpsertToManifest = syncUpsertToManifest;
+exports.processActionManifests = processActionManifests;
+exports.upsertAppActions = upsertAppActions;
+const chalk_1 = require("chalk");
+const contentful_management_1 = require("contentful-management");
+const node_fs_1 = __importDefault(require("node:fs"));
+const ora_1 = __importDefault(require("ora"));
+const utils_1 = require("../utils");
+const client_1 = require("./client");
+const make_cma_payload_1 = require("./make-cma-payload");
+const validation_1 = require("./validation");
+async function doUpsert(client, appDefinitionId, payload) {
+    if (payload.id) {
+        const existingAction = await (0, client_1.getExistingAction)(client, appDefinitionId, payload.id);
+        if (existingAction) {
+            const { id, ...update } = payload;
+            return (0, client_1.updateAction)(client, appDefinitionId, id, update);
+        }
+        else if (!existingAction && payload.type === 'endpoint') {
+            throw new Error(`Action with id ${payload.id} not found. Endpoint actions may not set a custom ID.`);
+        }
+    }
+    return (0, client_1.createAction)(client, appDefinitionId, payload);
+}
+function syncUpsertToManifest(manifestActions, actionsToSync, manifest, manifestFile) {
+    const actions = manifestActions.map((action, i) => {
+        const syncedAction = actionsToSync[i];
+        return syncedAction || action;
+    });
+    node_fs_1.default.writeFileSync(manifestFile, JSON.stringify({ ...manifest, actions }, null, 2));
+    console.log(`Remote updates synced to your manifest file at ${(0, chalk_1.yellow)(manifestFile)}.`);
+}
+async function processActionManifests(actions, doUpsert) {
+    const actionsToSync = {};
+    const errors = [];
+    for (const i in actions) {
+        const action = actions[i];
+        const payload = (0, make_cma_payload_1.makeAppActionCMAPayload)(action);
+        try {
+            const appAction = await doUpsert(payload);
+            actionsToSync[i] = {
+                ...action,
+                id: appAction.sys.id,
+            };
+        }
+        catch (err) {
+            errors.push({ details: err, path: ['actions', i] });
+        }
+    }
+    return { actionsToSync, errors };
+}
+async function upsertAppActions(settings) {
+    const { accessToken, appDefinitionId, host, organizationId, manifestFile } = settings;
+    const manifest = await (0, utils_1.resolveManifestFile)({ manifestFile });
+    const actions = (0, validation_1.validateActionsManifest)(manifest);
+    const spinner = (0, ora_1.default)('Creating your app action(s)').start();
+    const client = (0, contentful_management_1.createClient)({
+        accessToken,
+        host,
+    }, {
+        type: 'plain',
+        defaults: {
+            organizationId,
+        },
+    });
+    const { actionsToSync, errors } = await processActionManifests(actions, async (payload) => doUpsert(client, appDefinitionId, payload));
+    syncUpsertToManifest(actions, actionsToSync, manifest, manifestFile);
+    if (errors.length) {
+        const error = new Error(`Failed to upsert actions`);
+        Object.assign(error, { details: errors.map(({ details }) => details) });
+        (0, utils_1.throwError)(error, 'Failed to upsert actions');
+    }
+    spinner.stop();
+}

package/lib/upsert-actions/validation.d.ts

@@ -0,0 +1,9 @@
+import { CreateAppActionOptions as UpsertAppActionOptions } from './types';
+export declare const validateId: (id: string) => {
+    ok: boolean;
+    message: string;
+} | {
+    ok: boolean;
+    message?: undefined;
+};
+export declare function validateActionsManifest(manifest: Record<string, any>): UpsertAppActionOptions['actions'];

package/lib/upsert-actions/validation.js

@@ -0,0 +1,77 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateId = void 0;
+exports.validateActionsManifest = validateActionsManifest;
+const zod_1 = __importDefault(require("zod"));
+const utils_1 = require("../utils");
+const parametersSchema = zod_1.default
+    .array(zod_1.default.object({
+    id: zod_1.default.string(),
+    name: zod_1.default.string(),
+    description: zod_1.default.string().optional(),
+    type: zod_1.default.enum(['Symbol', 'Enum', 'Number', 'Boolean']),
+    required: zod_1.default.boolean(),
+    default: zod_1.default.union([zod_1.default.string(), zod_1.default.number(), zod_1.default.boolean()]).optional(),
+}));
+const validateId = (id) => {
+    if (!utils_1.ID_REGEX.test(id)) {
+        return {
+            ok: false,
+            message: `Invalid "id" (must only contain alphanumeric characters). Received: ${id}.`,
+        };
+    }
+    return { ok: true };
+};
+exports.validateId = validateId;
+function validateActionsManifest(manifest) {
+    if (!manifest.actions) {
+        throw new Error('Invalid App Action manifest: missing "actions" field');
+    }
+    const { actions } = manifest;
+    if (!Array.isArray(actions)) {
+        throw new Error('Invalid App Action manifest: "actions" must be an array');
+    }
+    const errors = actions.reduce((acc, action) => {
+        if (!action.name) {
+            acc.push(new Error('Invalid App Action manifest: Actions must define a "name".'));
+        }
+        if (!action.type) {
+            acc.push(new Error('Invalid App Action manifest: Actions must define a "type".'));
+        }
+        if (!action.category) {
+            acc.push(new Error('Invalid App Action manifest: Actions must define a "category".'));
+        }
+        if (action.type === 'function-invocation' && (!action.functionId || action.url)) {
+            acc.push(new Error('Invalid App Action manifest: "function-invocation" Actions must define a "functionId" and may not target a "url".'));
+        }
+        if (action.type === 'endpoint' && (!action.url || action.functionId)) {
+            acc.push(new Error('Invalid App Action manifest: "endpoint" Actions must define a "url" and may not target a "functionId".'));
+        }
+        if (action.id) {
+            const { ok, message } = (0, exports.validateId)(action.id);
+            if (!ok) {
+                acc.push(new Error(`Invalid App Action manifest: ${message}`));
+            }
+        }
+        if (action.category !== 'Custom' && action.parameters) {
+            acc.push(new Error('Invalid App Action manifest: native Action categories may not define "parameters"'));
+        }
+        if (action.category === 'Custom' && !action.parameters) {
+            acc.push(new Error('Invalid App Action manifest: "Custom" Action categories must define "parameters"'));
+        }
+        if (action.category === 'Custom' && action.parameters) {
+            const parametersValidationResult = parametersSchema.safeParse(action.parameters);
+            if (!parametersValidationResult.success) {
+                acc.push(new Error(`Invalid App Action manifest: invalid "parameters" - ${JSON.stringify(parametersValidationResult.error.errors)}`));
+            }
+        }
+        return acc;
+    }, []);
+    if (errors.length) {
+        throw new Error(errors.map((error) => error.message).join('\n'));
+    }
+    return actions;
+}

package/lib/utils.d.ts

@@ -1,13 +1,15 @@
 import { Definition } from './definition-api';
 import { Organization } from './organization-api';
-import { ContentfulFunction, FunctionAppAction } from './types';
+import { ContentfulFunction } from './types';
 export declare const throwValidationException: (subject: string, message?: string, details?: string) => never;
 export declare const isValidNetwork: (address: string) => boolean;
 export declare const stripProtocol: (url: string) => string;
 export declare const showCreationError: (subject: string, message: string) => void;
 export declare const throwError: (err: Error, message: string) => never;
 export declare const selectFromList: <T extends Definition | Organization>(list: T[], message: string, cachedOptionEnvVar: string) => Promise<T>;
-type Entities<Type> = Type extends 'actions' ? Omit<FunctionAppAction, 'entryFile'>[] : Omit<ContentfulFunction, 'entryFile'>[];
-export declare function getEntityFromManifest<Type extends 'actions' | 'functions'>(type: Type): Entities<Type> | undefined;
+export declare function getFunctionsFromManifest(): Omit<ContentfulFunction, 'entryFile'>[] | undefined;
 export declare function getWebAppHostname(host: string | undefined): string;
-export {};
+export declare const resolveManifestFile: (options: {
+    manifestFile?: string;
+}, cwd?: string) => any;
+export declare const ID_REGEX: RegExp;

package/lib/utils.js

@@ -3,14 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.selectFromList = exports.throwError = exports.showCreationError = exports.stripProtocol = exports.isValidNetwork = exports.throwValidationException = void 0;
-exports.getEntityFromManifest = getEntityFromManifest;
+exports.ID_REGEX = exports.resolveManifestFile = exports.selectFromList = exports.throwError = exports.showCreationError = exports.stripProtocol = exports.isValidNetwork = exports.throwValidationException = void 0;
+exports.getFunctionsFromManifest = getFunctionsFromManifest;
 exports.getWebAppHostname = getWebAppHostname;
 const fs_1 = __importDefault(require("fs"));
 const chalk_1 = __importDefault(require("chalk"));
 const inquirer_1 = __importDefault(require("inquirer"));
 const cache_credential_1 = require("./cache-credential");
 const constants_1 = require("./constants");
+const node_path_1 = require("node:path");
 const DEFAULT_MANIFEST_PATH = './contentful-app-manifest.json';
 const functionEvents = {
     appActionCall: 'appaction.call',
@@ -105,18 +106,18 @@ const selectFromList = async (list, message, cachedOptionEnvVar) => {
     }
 };
 exports.selectFromList = selectFromList;
-function getEntityFromManifest(type) {
+function getFunctionsFromManifest() {
     const isManifestExists = fs_1.default.existsSync(DEFAULT_MANIFEST_PATH);
     if (!isManifestExists) {
         return;
     }
     try {
         const manifest = JSON.parse(fs_1.default.readFileSync(DEFAULT_MANIFEST_PATH, { encoding: 'utf8' }));
-        if (!Array.isArray(manifest[type]) || manifest[type].length === 0) {
+        if (!Array.isArray(manifest['functions']) || manifest['functions'].length === 0) {
             return;
         }
-        logProgress(`${type === 'actions' ? 'App Actions' : 'functions'} found in ${chalk_1.default.bold(DEFAULT_MANIFEST_PATH)}.`);
-        const items = manifest[type].map((item) => {
+        logProgress(`functions found in ${chalk_1.default.bold(DEFAULT_MANIFEST_PATH)}.`);
+        const items = manifest['functions'].map((item) => {
             const allowNetworks = Array.isArray(item.allowNetworks)
                 ? item.allowNetworks.map(exports.stripProtocol)
                 : [];
@@ -124,12 +125,12 @@ function getEntityFromManifest(type) {
             const hasInvalidEvent = accepts?.some((event) => !Object.values(functionEvents).includes(event));
             const hasInvalidNetwork = allowNetworks.find((netWork) => !(0, exports.isValidNetwork)(netWork));
             if (hasInvalidNetwork) {
-                console.log(`${chalk_1.default.red('Error:')} Invalid IP address ${hasInvalidNetwork} found in the allowNetworks array for ${type} "${item.name}".`);
+                console.log(`${chalk_1.default.red('Error:')} Invalid IP address ${hasInvalidNetwork} found in the allowNetworks array for Function "${item.name}".`);
                 // eslint-disable-next-line no-process-exit
                 process.exit(1);
             }
             if (hasInvalidEvent) {
-                console.log(`${chalk_1.default.red('Error:')} Invalid events found in the accepts array for ${type} "${item.name}".`);
+                console.log(`${chalk_1.default.red('Error:')} Invalid events found in the accepts array for Function "${item.name}".`);
                 // eslint-disable-next-line no-process-exit
                 process.exit(1);
             }
@@ -153,3 +154,10 @@ function getEntityFromManifest(type) {
 function getWebAppHostname(host) {
     return host && host.includes('api') ? host.replace('api', 'app') : constants_1.DEFAULT_CONTENTFUL_APP_HOST;
 }
+const resolveManifestFile = (options, cwd = process.cwd()) => {
+    return require(options.manifestFile
+        ? (0, node_path_1.resolve)(cwd, options.manifestFile)
+        : (0, node_path_1.resolve)(cwd, 'contentful-app-manifest.json'));
+};
+exports.resolveManifestFile = resolveManifestFile;
+exports.ID_REGEX = /^[a-zA-Z0-9]+$/;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.33.0",
+  "version": "2.0.0",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -10,8 +10,8 @@
     "directory": "packages/contentful--app-scripts"
   },
   "engines": {
-    "node": ">=14",
-    "npm": ">=6"
+    "node": ">=18",
+    "npm": ">=9"
   },
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -67,7 +67,7 @@
     "tiged": "^2.12.7",
     "zod": "^3.24.1"
   },
-  "gitHead": "c34e17b5b5023762d190708c19281809eb14734b",
+  "gitHead": "b978a5b14bd327dafbd4349fbc6b624eaffb5e05",
   "devDependencies": {
     "@types/adm-zip": "0.5.7",
     "@types/analytics-node": "3.1.14",
@@ -76,12 +76,12 @@
     "@types/lodash": "4.17.15",
     "@types/mocha": "10.0.10",
     "@types/proxyquire": "1.3.31",
-    "@types/sinon": "17.0.3",
+    "@types/sinon": "17.0.4",
     "chai": "4.5.0",
     "mocha": "10.8.2",
     "proxyquire": "2.1.3",
     "sinon": "19.0.2",
-    "ts-mocha": "10.0.0",
+    "ts-mocha": "11.1.0",
     "ts-node": "10.9.2"
   }
 }