@contentful/app-scripts 2.2.0 → 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,6 +103,16 @@ 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 });
     });

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

@@ -9,6 +9,7 @@ const inquirer_1 = __importDefault(require("inquirer"));
 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.
@@ -20,103 +21,11 @@ NOTE: This will create an app definition in your Contentful organization.
             name: 'name',
             message: `App name (${node_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;
-            },
-        },
+        { ...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

@@ -11,6 +11,7 @@ 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();
@@ -48,31 +49,7 @@ async function createAppDefinition(accessToken, appDefinitionSettings) {
     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 || node_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 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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "2.2.0",
+  "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": "f74bc713b10f3b7eafc95193327bebc91ec64d74",
+  "gitHead": "94da155a27c586d7a26e4448da180bde6cf61817",
   "devDependencies": {
     "@types/adm-zip": "0.5.7",
     "@types/analytics-node": "3.1.14",