@contentful/app-scripts 2.1.4 → 2.3.0

package/lib/add-locations/add-locations.d.ts

@@ -0,0 +1,2 @@
+import { AddLocationsSettings } from '../types';
+export declare function add(settings: AddLocationsSettings): Promise<void>;

package/lib/add-locations/add-locations.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.add = add;
+const ora_1 = __importDefault(require("ora"));
+const chalk_1 = require("chalk");
+const utils_1 = require("../utils");
+const contentful_management_1 = require("contentful-management");
+const create_type_safe_locations_1 = require("../create-type-safe-locations");
+async function add(settings) {
+    const { accessToken, organization, definition, host } = settings;
+    const activationSpinner = (0, ora_1.default)('Adding locations').start();
+    const plainClient = (0, contentful_management_1.createClient)({ accessToken, host }, { type: 'plain' });
+    const defaultLocations = [{ location: 'dialog' }];
+    try {
+        const currentDefinition = await plainClient.appDefinition.get({
+            appDefinitionId: definition.value,
+            organizationId: organization.value,
+        });
+        const typeSafeLocations = (0, create_type_safe_locations_1.createTypeSafeLocations)(settings);
+        currentDefinition.locations = [
+            ...(currentDefinition.locations ?? defaultLocations),
+            ...typeSafeLocations,
+        ];
+        const appBundleId = currentDefinition.bundle?.sys.id;
+        const currentBundle = appBundleId ? await plainClient.appBundle.get({
+            appDefinitionId: definition.value,
+            appBundleId,
+            organizationId: organization.value,
+        }) : await Promise.resolve(undefined);
+        const hasFrontendFiles = (currentBundle?.files?.length ?? 0) > 0;
+        const hasSrc = !!currentDefinition.src;
+        const useDefaultSrc = !hasFrontendFiles && !hasSrc;
+        if (useDefaultSrc) {
+            currentDefinition.src = 'http://localhost:3000';
+        }
+        await plainClient.appDefinition.update({
+            appDefinitionId: definition.value,
+            organizationId: organization.value,
+        }, currentDefinition);
+        console.log(`
+      ${(0, chalk_1.cyan)('Success!')} Your locations were added to ${(0, chalk_1.cyan)(definition.name)}
+      Locations: ${(0, chalk_1.yellow)(typeSafeLocations.map((l) => (0, chalk_1.bold)(l.location)).join(', '))}`);
+    }
+    catch (err) {
+        (0, utils_1.throwError)(err, 'Something went wrong addding locations. Make sure you used the correct definition-id.');
+    }
+    finally {
+        activationSpinner.stop();
+    }
+}

package/lib/add-locations/build-add-locations-settings.d.ts

@@ -0,0 +1,3 @@
+import { AddLocationsOptions, AddLocationsSettings } from '../types';
+export declare function buildAddLocationsSettings(options: AddLocationsOptions): Promise<AddLocationsSettings>;
+export declare function hostProtocolFilter(input: string): string;

package/lib/add-locations/build-add-locations-settings.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAddLocationsSettings = buildAddLocationsSettings;
+exports.hostProtocolFilter = hostProtocolFilter;
+const chalk_1 = __importDefault(require("chalk"));
+const inquirer_1 = require("inquirer");
+const get_app_info_1 = require("../get-app-info");
+const constants_1 = require("../constants");
+const location_prompts_1 = require("../location-prompts");
+async function buildAddLocationsSettings(options) {
+    const appPrompts = [];
+    const { host } = options;
+    if (!host) {
+        appPrompts.push({
+            name: 'host',
+            message: `Contentful CMA endpoint URL:`,
+            default: constants_1.DEFAULT_CONTENTFUL_API_HOST,
+            filter: hostProtocolFilter,
+        });
+    }
+    const { host: interactiveHost } = await (0, inquirer_1.prompt)(appPrompts);
+    const hostValue = host || interactiveHost;
+    const appInfo = await (0, get_app_info_1.getAppInfo)({ ...options, host: hostValue });
+    const locationPrompts = [];
+    const currentLocations = new Set(appInfo.definition.locations);
+    const possibleLocations = location_prompts_1.selectLocationsPrompt.choices.filter((locationChoice) => !currentLocations.has(locationChoice.value));
+    if (possibleLocations.length === 0) {
+        console.log(`${chalk_1.default.red('No locations to add')}`);
+        // eslint-disable-next-line no-process-exit
+        process.exit(1);
+    }
+    if (possibleLocations.length > 0) {
+        locationPrompts.push({
+            ...location_prompts_1.selectLocationsPrompt,
+            choices: possibleLocations,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            validate(input) {
+                if (input.length < 1) {
+                    return 'You must choose at least one location to add.';
+                }
+                return true;
+            },
+        });
+        if (possibleLocations.some((location) => location.value === 'entry-field')) {
+            locationPrompts.push({ ...location_prompts_1.selectFieldsPrompt });
+        }
+        if (possibleLocations.some((location) => location.value === 'page')) {
+            locationPrompts.push({ ...location_prompts_1.pageNavPrompt });
+            locationPrompts.push({ ...location_prompts_1.pageNavLinkNamePrompt });
+            locationPrompts.push({ ...location_prompts_1.pageNavLinkPathPrompt });
+        }
+    }
+    const addLocationSettings = await (0, inquirer_1.prompt)(locationPrompts);
+    return {
+        host: hostValue,
+        ...addLocationSettings,
+        ...appInfo,
+    };
+}
+function hostProtocolFilter(input) {
+    return input.replace(/^https?:\/\//, '');
+}

package/lib/add-locations/index.d.ts

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

package/lib/add-locations/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addLocations = void 0;
+const add_locations_1 = require("./add-locations");
+const build_add_locations_settings_1 = require("./build-add-locations-settings");
+const interactive = async (options) => {
+    const settings = await (0, build_add_locations_settings_1.buildAddLocationsSettings)(options);
+    await (0, add_locations_1.add)(settings);
+};
+const nonInteractive = async () => {
+    throw new Error(`"add-locations" is not available in non-interactive mode`);
+};
+exports.addLocations = {
+    interactive,
+    nonInteractive,
+};

package/lib/bin.js

@@ -103,11 +103,22 @@ async function runCommand(command, options) {
         .action(async (options) => {
         await runCommand(index_1.upsertActions, options);
     });
+    commander_1.program
+        .command('add-locations')
+        .description('Add locations(s) to an App')
+        .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.addLocations, options);
+    });
     commander_1.program.hook('preAction', (thisCommand) => {
         (0, index_1.track)({ command: thisCommand.args[0], ci: thisCommand.opts().ci });
     });
     await commander_1.program.parseAsync(process.argv);
 })().catch((e) => {
     console.error(e);
-    throw e;
+    // eslint-disable-next-line no-process-exit
+    process.exit(1);
 });

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

@@ -1,4 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -7,7 +40,7 @@ exports.resolveEsBuildConfig = exports.validateFunctions = void 0;
 exports.buildFunctions = buildFunctions;
 /* eslint-disable @typescript-eslint/no-var-requires */
 const esbuild_1 = __importDefault(require("esbuild"));
-const path_1 = require("path");
+const node_path_1 = __importStar(require("node: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");
@@ -50,33 +83,60 @@ const validateFunctions = (manifest) => {
         if (acceptsSet.size !== accepts.length) {
             throw new Error(`Duplicate values found in 'accepts' for function with id '${id}'.`);
         }
+        // Validate POSIX style paths
+        if (path.includes('\\')) {
+            throw new Error(`Function path must use POSIX style forward slashes, got: '${path}'`);
+        }
+        if (entryFile.includes('\\')) {
+            throw new Error(`Function entryFile must use POSIX style forward slashes, got: '${entryFile}'`);
+        }
     });
 };
 exports.validateFunctions = validateFunctions;
-const getEntryPoints = (manifest, cwd = process.cwd()) => {
+/**
+ * Build the esbuild config `entryPoints` object from the functions manifest.
+ * Uses posix style paths for consistency with the app manifest.
+ */
+const getEntryPoints = (manifest) => {
     return manifest.functions.reduce((result, contentfulFunction) => {
-        const fileProperties = (0, path_1.parse)(contentfulFunction.path);
-        const fileName = (0, path_1.join)(fileProperties.dir, fileProperties.name);
-        result[fileName] = (0, path_1.resolve)(cwd, contentfulFunction.entryFile);
+        const fileProperties = node_path_1.default.posix.parse(contentfulFunction.entryFile);
+        const buildAlias = node_path_1.default.posix.join(fileProperties.dir, fileProperties.name);
+        const resolvedPath = node_path_1.default.posix.resolve('.', contentfulFunction.entryFile);
+        let relativePath = node_path_1.default.posix.relative('.', resolvedPath);
+        if (!relativePath.startsWith('.')) {
+            relativePath = `./${relativePath}`;
+        }
+        result[buildAlias] = relativePath;
         return result;
     }, {});
 };
 const resolveEsBuildConfig = (options, manifest, cwd = process.cwd()) => {
-    return options.esbuildConfig
-        ? require((0, path_1.resolve)(cwd, options.esbuildConfig))
-        : {
-            entryPoints: getEntryPoints(manifest, cwd),
-            bundle: true,
-            outdir: 'build',
-            format: 'esm',
-            target: 'es2022',
-            minify: true,
-            define: {
-                global: 'globalThis',
-            },
-            plugins: [(0, node_modules_polyfill_1.NodeModulesPolyfillPlugin)(), (0, node_globals_polyfill_1.NodeGlobalsPolyfillPlugin)()],
-            logLevel: 'info',
-        };
+    if (options.esbuildConfig) {
+        const esbuildConfigFileProperties = (0, node_path_1.parse)(options.esbuildConfig);
+        const dir = esbuildConfigFileProperties.dir === '' ? cwd : esbuildConfigFileProperties.dir;
+        const absolutePath = (0, node_path_1.resolve)(dir, esbuildConfigFileProperties.base);
+        const relativePath = (0, node_path_1.relative)(__dirname, absolutePath);
+        // Convert the relative path to a module path that require() can use
+        // On Windows, this means convert ..\path\to\file.js to ../path/to/file.js
+        let modulePath = relativePath.replaceAll("\\", '/');
+        if (!modulePath.startsWith('./')) {
+            modulePath = `./${modulePath}`;
+        }
+        return require(modulePath);
+    }
+    return {
+        entryPoints: getEntryPoints(manifest),
+        bundle: true,
+        outdir: 'build',
+        format: 'esm',
+        target: 'es2022',
+        minify: true,
+        define: {
+            global: 'globalThis',
+        },
+        plugins: [(0, node_modules_polyfill_1.NodeModulesPolyfillPlugin)(), (0, node_globals_polyfill_1.NodeGlobalsPolyfillPlugin)()],
+        logLevel: 'info',
+    };
 };
 exports.resolveEsBuildConfig = resolveEsBuildConfig;
 async function buildFunctions(options) {

package/lib/cache-credential/index.js

@@ -5,14 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cacheEnvVars = cacheEnvVars;
 const dotenv_1 = __importDefault(require("dotenv"));
-const fs_1 = __importDefault(require("fs"));
+const node_fs_1 = __importDefault(require("node:fs"));
 const os_1 = require("os");
 const ignore_1 = __importDefault(require("ignore"));
 const chalk_1 = __importDefault(require("chalk"));
 const constants_1 = require("../constants");
 const ig = (0, ignore_1.default)();
-const fsPromises = fs_1.default.promises;
-const fsConstants = fs_1.default.constants;
+const fsPromises = node_fs_1.default.promises;
+const fsConstants = node_fs_1.default.constants;
 // Always export set env vars by default
 dotenv_1.default.config();
 async function removeOldEnv(envKey) {

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

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

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

@@ -6,9 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildAppDefinitionSettings = buildAppDefinitionSettings;
 const chalk_1 = __importDefault(require("chalk"));
 const inquirer_1 = __importDefault(require("inquirer"));
-const path_1 = __importDefault(require("path"));
+const node_path_1 = __importDefault(require("node:path"));
 const constants_1 = require("../constants");
 const build_app_parameter_settings_1 = require("./build-app-parameter-settings");
+const location_prompts_1 = require("../location-prompts");
 async function buildAppDefinitionSettings() {
     console.log(chalk_1.default.dim(`
 NOTE: This will create an app definition in your Contentful organization.
@@ -18,105 +19,13 @@ NOTE: This will create an app definition in your Contentful organization.
     const appDefinitionSettings = await inquirer_1.default.prompt([
         {
             name: 'name',
-            message: `App name (${path_1.default.basename(process.cwd())}):`,
-        },
-        {
-            name: 'locations',
-            message: `Select where your app can be rendered:`,
-            type: 'checkbox',
-            choices: [
-                { name: 'App configuration screen ', value: 'app-config' },
-                { name: 'Entry field', value: 'entry-field' },
-                { name: 'Entry sidebar', value: 'entry-sidebar' },
-                { name: 'Entry editor', value: 'entry-editor' },
-                { name: 'Page', value: 'page' },
-                { name: 'Home', value: 'home' },
-            ],
-        },
-        {
-            name: 'fields',
-            message: 'Select the field types the app can be rendered:',
-            type: 'checkbox',
-            choices: [
-                { name: 'Short text', value: { type: 'Symbol' } },
-                { name: 'Short text, list', value: { type: 'Array', items: { type: 'Symbol' } } },
-                { name: 'Long text', value: { type: 'Text' } },
-                { name: 'Rich text', value: { type: 'RichText' } },
-                { name: 'Number, integer', value: { type: 'Integer' } },
-                { name: 'Number, decimal', value: { type: 'Number' } },
-                { name: 'Date and time', value: { type: 'Date' } },
-                { name: 'Location', value: { type: 'Location' } },
-                { name: 'Boolean', value: { type: 'Boolean' } },
-                { name: 'JSON object', value: { type: 'Object' } },
-                { name: 'Entry reference', value: { type: 'Link', linkType: 'Entry' } },
-                {
-                    name: 'Entry reference, list',
-                    value: {
-                        type: 'Array',
-                        items: {
-                            type: 'Link',
-                            linkType: 'Entry',
-                        },
-                    },
-                },
-                { name: 'Media reference', value: { type: 'Link', linkType: 'Asset' } },
-                {
-                    name: 'Media reference, list',
-                    value: { type: 'Array', items: { type: 'Link', linkType: 'Asset' } },
-                },
-            ],
-            when(answers) {
-                return answers.locations.includes('entry-field');
-            },
-            validate(input) {
-                if (input.length < 1) {
-                    return 'You must choose at least one field type.';
-                }
-                return true;
-            },
-        },
-        {
-            name: 'pageNav',
-            message: 'Page location: Would you like your page location to render in the main navigation?',
-            type: 'confirm',
-            default: false,
-            when(answers) {
-                return answers.locations.includes('page');
-            },
-        },
-        {
-            name: 'pageNavLinkName',
-            message: 'Page location: Provide a name for the link in the main navigation:',
-            when(answers) {
-                return answers.locations.includes('page') && answers.pageNav;
-            },
-            validate(input) {
-                if (input.length < 1 || input.length > 40) {
-                    return 'Size must be at least 1 and at most 40';
-                }
-                return true;
-            },
-        },
-        {
-            name: 'pageNavLinkPath',
-            message: 'Page location: Provide a path which starts with / and does not contain empty space:',
-            default: '/',
-            when(answers) {
-                return answers.locations.includes('page') && answers.pageNav;
-            },
-            validate(input) {
-                if (input.length > 512) {
-                    return 'Maximum 512 characters';
-                }
-                if (input.includes(' ')) {
-                    return 'Path cannot contain empty space';
-                }
-                if (!input.startsWith('/')) {
-                    return 'Path must start with /';
-                }
-                return true;
-            },
+            message: `App name (${node_path_1.default.basename(process.cwd())}):`,
         },
+        { ...location_prompts_1.selectLocationsPrompt },
+        { ...location_prompts_1.selectFieldsPrompt },
+        { ...location_prompts_1.pageNavPrompt },
+        { ...location_prompts_1.pageNavLinkNamePrompt },
+        { ...location_prompts_1.pageNavLinkPathPrompt },
         {
             name: 'host',
             message: `Contentful CMA endpoint URL:`,

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

@@ -1,2 +1,2 @@
-import { AppDefinitionSettings } from './build-app-definition-settings';
+import { AppDefinitionSettings } from '../types';
 export declare function createAppDefinition(accessToken: string, appDefinitionSettings: AppDefinitionSettings): Promise<void>;

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

@@ -4,13 +4,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createAppDefinition = createAppDefinition;
-const path_1 = __importDefault(require("path"));
+const node_path_1 = __importDefault(require("node:path"));
 const contentful_management_1 = require("contentful-management");
 const chalk_1 = __importDefault(require("chalk"));
 const lodash_1 = require("lodash");
 const utils_1 = require("../utils");
 const cache_credential_1 = require("../cache-credential");
 const constants_1 = require("../constants");
+const create_type_safe_locations_1 = require("../create-type-safe-locations");
 async function fetchOrganizations(client) {
     try {
         const orgs = await client.getOrganizations();
@@ -47,32 +48,8 @@ async function createAppDefinition(accessToken, appDefinitionSettings) {
     const organizations = await fetchOrganizations(client);
     const selectedOrg = await (0, utils_1.selectFromList)(organizations, 'Select an organization for your app:', constants_1.ORG_ID_ENV_KEY);
     const organizationId = selectedOrg.value;
-    const appName = appDefinitionSettings.name || path_1.default.basename(process.cwd());
-    const locations = appDefinitionSettings.locations.map((location) => {
-        if (location === 'entry-field') {
-            return {
-                location,
-                fieldTypes: appDefinitionSettings.fields || [],
-            };
-        }
-        if (location === 'page') {
-            const { pageNav, pageNavLinkName, pageNavLinkPath } = appDefinitionSettings;
-            return {
-                location,
-                ...(pageNav
-                    ? {
-                        navigationItem: {
-                            name: pageNavLinkName,
-                            path: pageNavLinkPath,
-                        },
-                    }
-                    : {}),
-            };
-        }
-        return {
-            location,
-        };
-    });
+    const appName = appDefinitionSettings.name || node_path_1.default.basename(process.cwd());
+    const locations = (0, create_type_safe_locations_1.createTypeSafeLocations)(appDefinitionSettings);
     const hasFrontendLocation = locations.some(({ location }) => location !== 'dialog');
     const body = {
         name: appName,

package/lib/create-type-safe-locations.d.ts

@@ -0,0 +1,15 @@
+import { LocationsSettings } from "./types";
+export declare function createTypeSafeLocations(settings: LocationsSettings): ({
+    location: "entry-field";
+    fieldTypes: import("contentful-management").FieldType[];
+} | {
+    navigationItem?: {
+        name: string | undefined;
+        path: string | undefined;
+    } | undefined;
+    location: "page";
+    fieldTypes?: undefined;
+} | {
+    location: "app-config" | "entry-sidebar" | "entry-editor" | "dialog" | "home";
+    fieldTypes?: undefined;
+})[];

package/lib/create-type-safe-locations.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTypeSafeLocations = createTypeSafeLocations;
+function createTypeSafeLocations(settings) {
+    const { locations, fields, pageNav, pageNavLinkName, pageNavLinkPath } = settings;
+    return locations.map((location) => {
+        if (location === 'entry-field') {
+            return {
+                location,
+                fieldTypes: fields || [],
+            };
+        }
+        if (location === 'page') {
+            return {
+                location,
+                ...(pageNav
+                    ? {
+                        navigationItem: {
+                            name: pageNavLinkName,
+                            path: pageNavLinkPath,
+                        },
+                    }
+                    : {}),
+            };
+        }
+        return {
+            location,
+        };
+    });
+}

package/lib/definition-api.d.ts

@@ -2,6 +2,7 @@ import { ClientAPI } from 'contentful-management';
 export interface Definition {
     name: string;
     value: string;
+    locations: string[];
 }
 export declare function selectDefinition(client: ClientAPI, orgId: string): Promise<Definition>;
 export declare function getDefinitionById(client: ClientAPI, orgId: string, defId: string): Promise<Definition>;

package/lib/definition-api.js

@@ -23,6 +23,7 @@ async function fetchDefinitions(client, orgId) {
         return batchedAppDefinitions.map((def) => ({
             name: def.name,
             value: def.sys.id,
+            locations: def.locations ? def.locations.map((location) => location.location) : [],
         }));
     }
     catch (err) {
@@ -42,6 +43,7 @@ async function getDefinitionById(client, orgId, defId) {
         return {
             name: definition.name,
             value: definition.sys.id,
+            locations: definition.locations ? definition.locations.map((location) => location.location) : [],
         };
     }
     catch (err) {

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

@@ -7,7 +7,7 @@ exports.buildGenerateFunctionSettingsInteractive = buildGenerateFunctionSettings
 exports.validateArguments = validateArguments;
 exports.buildGenerateFunctionSettingsCLI = buildGenerateFunctionSettingsCLI;
 const inquirer_1 = __importDefault(require("inquirer"));
-const path_1 = __importDefault(require("path"));
+const node_path_1 = __importDefault(require("node:path"));
 const get_github_folder_names_1 = require("./get-github-folder-names");
 const constants_1 = require("./constants");
 const ora_1 = __importDefault(require("ora"));
@@ -18,7 +18,7 @@ async function buildGenerateFunctionSettingsInteractive() {
     const baseSettings = await inquirer_1.default.prompt([
         {
             name: 'name',
-            message: `Function name (${path_1.default.basename(process.cwd())}):`,
+            message: `Function name (${node_path_1.default.basename(process.cwd())}):`,
         },
     ]);
     validateFunctionName(baseSettings);

package/lib/generate-function/clone.js

@@ -17,7 +17,7 @@ exports.updatePackageJsonWithBuild = updatePackageJsonWithBuild;
 const tiged = require('tiged');
 const node_fs_1 = __importDefault(require("node:fs"));
 const chalk_1 = __importDefault(require("chalk"));
-const path_1 = require("path");
+const node_path_1 = require("node:path");
 const constants_1 = require("./constants");
 const logger_1 = require("./logger");
 const file_1 = require("./utils/file");
@@ -48,13 +48,15 @@ function getCloneURL(settings) {
     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 appManifestPath = (0, node_path_1.resolve)(localPath, constants_1.CONTENTFUL_APP_MANIFEST);
+    const appManifest = JSON.parse(node_fs_1.default.readFileSync(appManifestPath, 'utf-8'));
     const entry = appManifest["functions"][appManifest["functions"].length - 1];
     entry.id = settings.name;
     // the path always has a .js extension
+    // and path and entryFile are always POSIX style paths
     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));
+    await node_fs_1.default.writeFileSync(appManifestPath, JSON.stringify(appManifest, null, 2));
 }
 function moveFilesToFinalDirectory(localTmpPath, localFunctionsPath) {
     node_fs_1.default.cpSync(localTmpPath, localFunctionsPath, { recursive: true });
@@ -67,12 +69,12 @@ function renameClonedFiles(localTmpPath, settings) {
         throw new Error(`No function file found in ${localTmpPath}`);
     }
     const newFunctionFile = `${settings.name}.${settings.language === 'typescript' ? 'ts' : 'js'}`;
-    node_fs_1.default.renameSync(`${localTmpPath}/${functionFile}`, `${localTmpPath}/${newFunctionFile}`);
+    node_fs_1.default.renameSync((0, node_path_1.resolve)(localTmpPath, functionFile), (0, node_path_1.resolve)(localTmpPath, newFunctionFile));
     return newFunctionFile;
 }
 function resolvePaths(localPath) {
-    const localTmpPath = (0, path_1.resolve)(`${localPath}/tmp`); // we require a tmp directory because tiged overwrites all files in the target directory
-    const localFunctionsPath = (0, path_1.resolve)(`${localPath}/functions`);
+    const localTmpPath = (0, node_path_1.resolve)(localPath, 'tmp'); // we require a tmp directory because tiged overwrites all files in the target directory
+    const localFunctionsPath = (0, node_path_1.resolve)(localPath, 'functions');
     return { localTmpPath, localFunctionsPath };
 }
 async function cloneAndResolveManifests(cloneURL, localTmpPath, localPath, localFunctionsPath) {
@@ -83,7 +85,7 @@ async function cloneAndResolveManifests(cloneURL, localTmpPath, localPath, local
     await updatePackageJsonWithBuild(localPath, localTmpPath);
     // check if a tsconfig.json file exists already
     const ignoredFiles = constants_1.IGNORED_CLONED_FILES;
-    const tsconfigExists = await (0, file_1.exists)(`${localFunctionsPath}/tsconfig.json`);
+    const tsconfigExists = await (0, file_1.exists)((0, node_path_1.resolve)(localFunctionsPath, 'tsconfig.json'));
     if (tsconfigExists) {
         ignoredFiles.push('tsconfig.json');
     }
@@ -99,19 +101,19 @@ async function clone(cloneURL, localFunctionsPath) {
     return tigedInstance;
 }
 async function mergeAppManifest(localPath, localTmpPath) {
-    const finalAppManifestType = await (0, file_1.exists)(`${localPath}/${constants_1.CONTENTFUL_APP_MANIFEST}`);
+    const finalAppManifestType = await (0, file_1.exists)((0, node_path_1.resolve)(localPath, constants_1.CONTENTFUL_APP_MANIFEST));
     const tmpAppManifestType = await (0, file_1.whichExists)(localTmpPath, [constants_1.CONTENTFUL_APP_MANIFEST, constants_1.APP_MANIFEST]); // find the app manifest in the cloned files
     if (!finalAppManifestType) {
         await (0, file_1.mergeJsonIntoFile)({
-            source: `${localTmpPath}/${tmpAppManifestType}`,
-            destination: `${localPath}/${constants_1.CONTENTFUL_APP_MANIFEST}`, // always save as contentful-app-manifest.json
+            source: (0, node_path_1.resolve)(localTmpPath, tmpAppManifestType),
+            destination: (0, node_path_1.resolve)(localPath, constants_1.CONTENTFUL_APP_MANIFEST), // always save as contentful-app-manifest.json
         });
     }
     else {
         // add the function to the json's "functions" array
         await (0, file_1.mergeJsonIntoFile)({
-            source: `${localTmpPath}/${tmpAppManifestType}`,
-            destination: `${localPath}/${constants_1.CONTENTFUL_APP_MANIFEST}`,
+            source: (0, node_path_1.resolve)(localTmpPath, tmpAppManifestType),
+            destination: (0, node_path_1.resolve)(localPath, constants_1.CONTENTFUL_APP_MANIFEST),
             mergeFn: (destinationJson = {}, sourceJson = {}) => {
                 if (!destinationJson.functions) {
                     destinationJson.functions = [];
@@ -125,11 +127,11 @@ async function mergeAppManifest(localPath, localTmpPath) {
     }
 }
 async function updatePackageJsonWithBuild(localPath, localTmpPath) {
-    const packageJsonLocation = (0, path_1.resolve)(`${localPath}/package.json`);
+    const packageJsonLocation = (0, node_path_1.resolve)(localPath, 'package.json');
     const packageJsonExists = await (0, file_1.exists)(packageJsonLocation);
     if (packageJsonExists) {
         await (0, file_1.mergeJsonIntoFile)({
-            source: `${localTmpPath}/package.json`,
+            source: (0, node_path_1.resolve)(localTmpPath, 'package.json'),
             destination: packageJsonLocation,
             mergeFn: addBuildCommand,
         });

package/lib/generate-function/utils/file.js

@@ -9,12 +9,12 @@ exports.exists = exists;
 exports.whichExists = whichExists;
 const merge_options_1 = __importDefault(require("merge-options"));
 const promises_1 = require("fs/promises");
-const path_1 = require("path");
+const node_path_1 = require("node:path");
 async function getJsonData(path) {
     if (!path) {
         return undefined;
     }
-    const normalizedPath = (0, path_1.resolve)(path);
+    const normalizedPath = (0, node_path_1.resolve)(path);
     if (!(await exists(normalizedPath))) {
         return undefined;
     }
@@ -24,7 +24,7 @@ async function mergeJsonIntoFile({ source, destination, mergeFn = merge_options_
     const sourceJson = await getJsonData(source);
     const destinationJson = await getJsonData(destination);
     const mergedJson = mergeFn(destinationJson, sourceJson);
-    await (0, promises_1.writeFile)((0, path_1.resolve)(destination), JSON.stringify(mergedJson, null, '  '));
+    await (0, promises_1.writeFile)((0, node_path_1.resolve)(destination), JSON.stringify(mergedJson, null, '  '));
 }
 function exists(path) {
     return (0, promises_1.access)(path)
@@ -40,7 +40,7 @@ function exists(path) {
 async function whichExists(basePath, paths) {
     for (const path of paths) {
         try {
-            await (0, promises_1.access)((0, path_1.join)(basePath, path));
+            await (0, promises_1.access)((0, node_path_1.join)(basePath, path));
             return path;
         }
         catch (error) {

package/lib/index.d.ts

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

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.upsertActions = exports.generateFunction = exports.buildFunctions = exports.install = exports.feedback = exports.track = exports.open = exports.cleanup = exports.activate = exports.upload = exports.createAppDefinition = void 0;
+exports.addLocations = 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");
@@ -23,3 +23,5 @@ 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; } });
+var add_locations_1 = require("./add-locations");
+Object.defineProperty(exports, "addLocations", { enumerable: true, get: function () { return add_locations_1.addLocations; } });

package/lib/location-prompts.d.ts

@@ -0,0 +1,72 @@
+import { LocationsSettings } from "./types";
+export declare const selectLocationsPrompt: {
+    name: string;
+    message: string;
+    type: string;
+    choices: {
+        name: string;
+        value: string;
+    }[];
+};
+export declare const selectFieldsPrompt: {
+    name: string;
+    message: string;
+    type: string;
+    choices: ({
+        name: string;
+        value: {
+            type: string;
+            items?: undefined;
+            linkType?: undefined;
+        };
+    } | {
+        name: string;
+        value: {
+            type: string;
+            items: {
+                type: string;
+                linkType?: undefined;
+            };
+            linkType?: undefined;
+        };
+    } | {
+        name: string;
+        value: {
+            type: string;
+            linkType: string;
+            items?: undefined;
+        };
+    } | {
+        name: string;
+        value: {
+            type: string;
+            items: {
+                type: string;
+                linkType: string;
+            };
+            linkType?: undefined;
+        };
+    })[];
+    when(answers: LocationsSettings): boolean;
+    validate(input: any): true | "You must choose at least one field type.";
+};
+export declare const pageNavPrompt: {
+    name: string;
+    message: string;
+    type: string;
+    default: boolean;
+    when(answers: LocationsSettings): boolean;
+};
+export declare const pageNavLinkNamePrompt: {
+    name: string;
+    message: string;
+    when(answers: LocationsSettings): boolean | undefined;
+    validate(input: any): true | "Size must be at least 1 and at most 40";
+};
+export declare const pageNavLinkPathPrompt: {
+    name: string;
+    message: string;
+    default: string;
+    when(answers: LocationsSettings): boolean | undefined;
+    validate(input: any): true | "Maximum 512 characters" | "Path cannot contain empty space" | "Path must start with /";
+};

package/lib/location-prompts.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pageNavLinkPathPrompt = exports.pageNavLinkNamePrompt = exports.pageNavPrompt = exports.selectFieldsPrompt = exports.selectLocationsPrompt = void 0;
+exports.selectLocationsPrompt = {
+    name: 'locations',
+    message: `Select where your app can be rendered:`,
+    type: 'checkbox',
+    choices: [
+        { name: 'App configuration screen ', value: 'app-config' },
+        { name: 'Entry field', value: 'entry-field' },
+        { name: 'Entry sidebar', value: 'entry-sidebar' },
+        { name: 'Entry editor', value: 'entry-editor' },
+        { name: 'Page', value: 'page' },
+        { name: 'Home', value: 'home' },
+    ],
+};
+exports.selectFieldsPrompt = {
+    name: 'fields',
+    message: 'Select the field types the app can be rendered:',
+    type: 'checkbox',
+    choices: [
+        { name: 'Short text', value: { type: 'Symbol' } },
+        { name: 'Short text, list', value: { type: 'Array', items: { type: 'Symbol' } } },
+        { name: 'Long text', value: { type: 'Text' } },
+        { name: 'Rich text', value: { type: 'RichText' } },
+        { name: 'Number, integer', value: { type: 'Integer' } },
+        { name: 'Number, decimal', value: { type: 'Number' } },
+        { name: 'Date and time', value: { type: 'Date' } },
+        { name: 'Location', value: { type: 'Location' } },
+        { name: 'Boolean', value: { type: 'Boolean' } },
+        { name: 'JSON object', value: { type: 'Object' } },
+        { name: 'Entry reference', value: { type: 'Link', linkType: 'Entry' } },
+        {
+            name: 'Entry reference, list',
+            value: {
+                type: 'Array',
+                items: {
+                    type: 'Link',
+                    linkType: 'Entry',
+                },
+            },
+        },
+        { name: 'Media reference', value: { type: 'Link', linkType: 'Asset' } },
+        {
+            name: 'Media reference, list',
+            value: { type: 'Array', items: { type: 'Link', linkType: 'Asset' } },
+        },
+    ],
+    when(answers) {
+        return answers.locations.includes('entry-field');
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    validate(input) {
+        if (input.length < 1) {
+            return 'You must choose at least one field type.';
+        }
+        return true;
+    },
+};
+exports.pageNavPrompt = {
+    name: 'pageNav',
+    message: 'Page location: Would you like your page location to render in the main navigation?',
+    type: 'confirm',
+    default: false,
+    when(answers) {
+        return answers.locations.includes('page');
+    },
+};
+exports.pageNavLinkNamePrompt = {
+    name: 'pageNavLinkName',
+    message: 'Page location: Provide a name for the link in the main navigation:',
+    when(answers) {
+        return answers.locations.includes('page') && answers.pageNav;
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    validate(input) {
+        if (input.length < 1 || input.length > 40) {
+            return 'Size must be at least 1 and at most 40';
+        }
+        return true;
+    },
+};
+exports.pageNavLinkPathPrompt = {
+    name: 'pageNavLinkPath',
+    message: 'Page location: Provide a path which starts with / and does not contain empty space:',
+    default: '/',
+    when(answers) {
+        return answers.locations.includes('page') && answers.pageNav;
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    validate(input) {
+        if (input.length > 512) {
+            return 'Maximum 512 characters';
+        }
+        if (input.includes(' ')) {
+            return 'Path cannot contain empty space';
+        }
+        if (!input.startsWith('/')) {
+            return 'Path must start with /';
+        }
+        return true;
+    },
+};

package/lib/types.d.ts

@@ -1,3 +1,4 @@
+import { AppLocation, FieldType, InstallationParameterType, ParameterDefinition } from 'contentful-management';
 import { Definition } from './definition-api';
 import { Organization } from './organization-api';
 export interface ContentfulFunction {
@@ -77,3 +78,31 @@ export interface GenerateFunctionSettings {
     example: string;
     language: Language;
 }
+export interface AddLocationsOptions {
+    organizationId?: string;
+    definitionId?: string;
+    token?: string;
+    host?: string;
+}
+export interface LocationsSettings {
+    locations: AppLocation['location'][];
+    fields?: FieldType[];
+    pageNav?: boolean;
+    pageNavLinkName?: string;
+    pageNavLinkPath?: string;
+}
+export interface AddLocationsSettings extends LocationsSettings {
+    organization: Organization;
+    definition: Definition;
+    accessToken: string;
+    host?: string;
+}
+export interface AppDefinitionSettings extends LocationsSettings {
+    name: string;
+    host?: string;
+    buildAppParameters: boolean;
+    parameters?: {
+        instance: ParameterDefinition[];
+        installation: ParameterDefinition<InstallationParameterType>[];
+    };
+}

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

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildAppUploadSettings = buildAppUploadSettings;
 exports.hostProtocolFilter = hostProtocolFilter;
@@ -6,6 +9,7 @@ const inquirer_1 = require("inquirer");
 const get_app_info_1 = require("../get-app-info");
 const utils_1 = require("../utils");
 const constants_1 = require("../constants");
+const node_path_1 = __importDefault(require("node:path"));
 async function buildAppUploadSettings(options) {
     const functionManifest = (0, utils_1.getFunctionsFromManifest)();
     const prompts = [];
@@ -14,7 +18,7 @@ async function buildAppUploadSettings(options) {
         prompts.push({
             name: 'bundleDirectory',
             message: `Bundle directory, if not default:`,
-            default: './build',
+            default: node_path_1.default.resolve('.', 'build'),
         });
     }
     if (!comment) {

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

@@ -22,7 +22,7 @@ async function createAppUpload(settings) {
     (0, validate_bundle_1.validateBundle)(settings.bundleDirectory || '.', settings);
     let appUpload = null;
     const zipFileSpinner = (0, ora_1.default)('Preparing your files for upload...').start();
-    const zipFile = await (0, create_zip_from_directory_1.createZipFileFromDirectory)(settings.bundleDirectory || '../types');
+    const zipFile = await (0, create_zip_from_directory_1.createZipFileFromDirectory)(settings.bundleDirectory || '.');
     zipFileSpinner.stop();
     if (!zipFile)
         return;

package/lib/upload/create-zip-from-directory.js

@@ -7,10 +7,11 @@ exports.createZipFileFromDirectory = createZipFileFromDirectory;
 const chalk_1 = __importDefault(require("chalk"));
 const adm_zip_1 = __importDefault(require("adm-zip"));
 const utils_1 = require("../utils");
+const node_path_1 = require("node:path");
 async function createZipFileFromDirectory(path) {
     try {
         const zip = new adm_zip_1.default();
-        zip.addLocalFolder(path);
+        zip.addLocalFolder((0, node_path_1.resolve)(path));
         console.log("");
         console.log(`  ----------------------------
 

package/lib/upload/validate-bundle.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateBundle = void 0;
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_fs_1 = __importDefault(require("node:fs"));
 const chalk_1 = __importDefault(require("chalk"));
 const ACCEPTED_ENTRY_FILES = ['index.html'];
 const getEntryFile = (files) => files.find((file) => ACCEPTED_ENTRY_FILES.includes(file));
@@ -14,14 +14,14 @@ const fileContainsAbsolutePath = (fileContent) => {
     return [...fileContent.matchAll(ABSOLUTE_PATH_REG_EXP)].length > 0;
 };
 const validateBundle = (path, { functions }) => {
-    const buildFolder = path_1.default.join('./', path);
-    const files = fs_1.default.readdirSync(buildFolder, { recursive: true, encoding: 'utf-8' });
+    const buildFolder = node_path_1.default.join('.', path);
+    const files = node_fs_1.default.readdirSync(buildFolder, { recursive: true, encoding: 'utf-8' });
     const entry = getEntryFile(files);
     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) {
-        const entryFile = fs_1.default.readFileSync(path_1.default.join(buildFolder, entry), { encoding: 'utf8' });
+        const entryFile = node_fs_1.default.readFileSync(node_path_1.default.join(buildFolder, entry), { encoding: 'utf8' });
         if (fileContainsAbsolutePath(entryFile)) {
             console.log('----------------------------');
             console.warn(`${chalk_1.default.red('Warning:')} This bundle uses absolute paths. Please use relative paths instead for correct rendering. See more details here https://www.contentful.com/developers/docs/extensibility/app-framework/app-bundle/#limitations`);
@@ -29,9 +29,10 @@ const validateBundle = (path, { functions }) => {
         }
     }
     if (functions) {
-        const functionWithoutEntryFile = functions.find(({ path }) => !files.includes(path));
+        const posixFormattedFiles = new Set(files.map((file) => file.replace(/\\/g, '/')));
+        const functionWithoutEntryFile = functions.find(({ path }) => !posixFormattedFiles.has(path));
         if (functionWithoutEntryFile) {
-            throw new Error(`Function "${functionWithoutEntryFile.id}" is missing its entry file at "${path_1.default.join(buildFolder, functionWithoutEntryFile.path)}".`);
+            throw new Error(`Function "${functionWithoutEntryFile.id}" is missing its entry file at "${node_path_1.default.join(buildFolder, functionWithoutEntryFile.path)}".`);
         }
     }
 };

package/lib/utils.js

@@ -6,13 +6,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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 node_fs_1 = __importDefault(require("node: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 DEFAULT_MANIFEST_PATH = (0, node_path_1.resolve)('.', 'contentful-app-manifest.json');
 const functionEvents = {
     appActionCall: 'appaction.call',
     appEventFilter: 'appevent.filter',
@@ -107,12 +107,12 @@ const selectFromList = async (list, message, cachedOptionEnvVar) => {
 };
 exports.selectFromList = selectFromList;
 function getFunctionsFromManifest() {
-    const isManifestExists = fs_1.default.existsSync(DEFAULT_MANIFEST_PATH);
+    const isManifestExists = node_fs_1.default.existsSync(DEFAULT_MANIFEST_PATH);
     if (!isManifestExists) {
         return;
     }
     try {
-        const manifest = JSON.parse(fs_1.default.readFileSync(DEFAULT_MANIFEST_PATH, { encoding: 'utf8' }));
+        const manifest = JSON.parse(node_fs_1.default.readFileSync(DEFAULT_MANIFEST_PATH, { encoding: 'utf8' }));
         if (!Array.isArray(manifest['functions']) || manifest['functions'].length === 0) {
             return;
         }
@@ -155,9 +155,10 @@ 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
+    const manifestPath = options.manifestFile
         ? (0, node_path_1.resolve)(cwd, options.manifestFile)
-        : (0, node_path_1.resolve)(cwd, 'contentful-app-manifest.json'));
+        : (0, node_path_1.resolve)(cwd, 'contentful-app-manifest.json');
+    return JSON.parse(node_fs_1.default.readFileSync(manifestPath, 'utf-8'));
 };
 exports.resolveManifestFile = resolveManifestFile;
 exports.ID_REGEX = /^[a-zA-Z0-9]+$/;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "2.1.4",
+  "version": "2.3.0",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -67,7 +67,7 @@
     "tiged": "^2.12.7",
     "zod": "^3.24.1"
   },
-  "gitHead": "4538fa97b37141989cf9788881901c326e0c26c1",
+  "gitHead": "94da155a27c586d7a26e4448da180bde6cf61817",
   "devDependencies": {
     "@types/adm-zip": "0.5.7",
     "@types/analytics-node": "3.1.14",
@@ -75,6 +75,7 @@
     "@types/inquirer": "8.2.1",
     "@types/lodash": "4.17.16",
     "@types/mocha": "10.0.10",
+    "@types/node": "^22.13.10",
     "@types/proxyquire": "1.3.31",
     "@types/sinon": "17.0.4",
     "chai": "4.5.0",