@contentful/app-scripts 1.33.0-alpha.0 → 1.33.1

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

@@ -1,80 +0,0 @@
-"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

@@ -1,9 +0,0 @@
-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

@@ -1,77 +0,0 @@
-"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;
-}