@contentful/app-scripts 1.32.2 → 1.32.3

package/README.md

@@ -177,6 +177,16 @@ You can also execute this command without the argument if the environment variab
 > $ CONTENTFUL_APP_DEF_ID=some-definition-id npx --no-install @contentful/app-scripts open-settings
 > ```
 
+**Options:**
+
+| Argument          | Description                                  | Default value        |
+| ----------------- | -------------------------------------------- | -------------------- |
+|                   |
+| `--definition-id` | The ID of the app to which to add the bundle |
+| `--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.
+
 ### Clean up bundles
 
 Allows you to clean the list of previous bundles. It fetches the list and deletes all bundles except the 50 newest ones.
@@ -246,6 +256,16 @@ By default, the script will install the app into the default host URL: `app.cont
 > $ npx --no-install @contentful/app-scripts install --definition-id some-definition-id --host api.eu.contentful.com
 > ```
 
+**Options:**
+
+| Argument          | Description                                  | Default value        |
+| ----------------- | -------------------------------------------- | -------------------- |
+|                   |
+| `--definition-id` | The ID of the app to which to add the bundle |
+| `--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.
+
 ### Tracking
 
 We gather depersonalized usage data of our CLI tools in order to improve experience. If you do not want your data to be gathered, you can opt out by providing an env variable `DISABLE_ANALYTICS` set to any value:
@@ -286,7 +306,7 @@ When passing the `--ci` argument adding all variables as arguments is required
 **Options:**
 
 Options:
-  -e, --esbuild-config <path>  custom esbuild config file path
-  -m, --manifest-file <path>   Contentful app manifest file path
-  -w, --watch                  watch for changes
-  -h, --help                   display help for command
+-e, --esbuild-config <path> custom esbuild config file path
+-m, --manifest-file <path> Contentful app manifest file path
+-w, --watch watch for changes
+-h, --help display help for command

package/lib/activate/build-bundle-activate-settings.js

@@ -23,11 +23,12 @@ async function buildBundleActivateSettings(options) {
             default: 'api.contentful.com',
         });
     }
-    const appActivateSettings = await inquirer_1.default.prompt(prompts);
-    const appInfo = await (0, get_app_info_1.getAppInfo)(options);
+    const { host: interactiveHost, ...appActivateSettings } = await inquirer_1.default.prompt(prompts);
+    const hostValue = host || interactiveHost;
+    const appInfo = await (0, get_app_info_1.getAppInfo)({ ...options, host: hostValue });
     return {
         bundleId,
-        host,
+        host: hostValue,
         ...appActivateSettings,
         ...appInfo,
     };

package/lib/bin.js

@@ -26,7 +26,7 @@ async function runCommand(command, options) {
         .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')
-        .option('--host [host]', 'Contentful domain to use')
+        .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
         .action(async (options) => {
         await runCommand(index_1.upload, options);
     });
@@ -37,7 +37,7 @@ async function runCommand(command, options) {
         .option('--organization-id [orgId]', 'The id of your organization')
         .option('--definition-id  [defId]', 'The id of your apps definition')
         .option('--token [accessToken]', 'Your content management access token')
-        .option('--host [host]', 'Contentful domain to use')
+        .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
         .action(async (options) => {
         await runCommand(index_1.activate, options);
     });
@@ -45,6 +45,7 @@ async function runCommand(command, options) {
         .command('open-settings')
         .description('Opens the app editor for a given AppDefinition')
         .option('--definition-id  [defId]', 'The id of your apps definition')
+        .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
         .action(async (options) => {
         await runCommand(index_1.open, options);
     });
@@ -55,7 +56,7 @@ async function runCommand(command, options) {
         .option('--definition-id  [defId]', 'The id of your apps definition')
         .option('--token [accessToken]', 'Your content management access token')
         .option('--keep [keepAmount]', 'The amount of bundles that should remain')
-        .option('--host [host]', 'Contentful domain to use')
+        .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
         .action(async (options) => {
         await runCommand(index_1.cleanup, options);
     });
@@ -69,7 +70,7 @@ async function runCommand(command, options) {
         .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('--host [host]', 'Contentful domain to use')
+        .option('--host [host]', 'Contentful subdomain to use, e.g. "api.contentful.com"')
         .action(async (options) => {
         await runCommand(index_1.install, options);
     });

package/lib/clean-up/build-clean-up-settings.js

@@ -22,11 +22,12 @@ async function buildCleanUpSettings(options) {
             default: constants_1.DEFAULT_CONTENTFUL_API_HOST,
         });
     }
-    const appCleanUpSettings = await (0, inquirer_1.prompt)(prompts);
-    const appInfo = await (0, get_app_info_1.getAppInfo)(options);
+    const { host: interactiveHost, ...appCleanUpSettings } = await (0, inquirer_1.prompt)(prompts);
+    const hostValue = host || interactiveHost;
+    const appInfo = await (0, get_app_info_1.getAppInfo)({ ...options, host: hostValue });
     return {
         keep: keep === undefined ? +appCleanUpSettings.keep : +keep,
-        host,
+        host: hostValue,
         ...appCleanUpSettings,
         ...appInfo,
     };

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

@@ -42,7 +42,8 @@ function assertValidArguments(accessToken, appDefinitionSettings) {
 }
 async function createAppDefinition(accessToken, appDefinitionSettings) {
     assertValidArguments(accessToken, appDefinitionSettings);
-    const client = (0, contentful_management_1.createClient)({ accessToken, host: appDefinitionSettings.host });
+    const host = appDefinitionSettings.host;
+    const client = (0, contentful_management_1.createClient)({ accessToken, host });
     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;
@@ -92,16 +93,17 @@ async function createAppDefinition(accessToken, appDefinitionSettings) {
         await (0, cache_credential_1.cacheEnvVars)({
             [constants_1.APP_DEF_ENV_KEY]: createdAppDefinition.sys.id,
         });
+        const webApp = (0, utils_1.getWebAppHostname)(host);
         console.log(`
   ${chalk_1.default.greenBright('Success!')} Created an app definition for ${chalk_1.default.bold(appName)} in ${chalk_1.default.bold(selectedOrg.name)}.
 
-  ${chalk_1.default.dim(`NOTE: You can update this app definition in your organization settings:
-        ${chalk_1.default.underline(`https://app.contentful.com/deeplink?link=org`)}`)}
+  ${chalk_1.default.dim(`NOTE: You can update this app definition in your apps settings:
+        ${chalk_1.default.underline(`https://${webApp}/deeplink?link=app-definition-list`)}`)}
 
   ${chalk_1.default.bold('Next steps:')}
     1. Run your app with ${chalk_1.default.cyan('`npm start`')} inside of your app folder.
     2. Install this app definition to one of your spaces by opening:
-        ${chalk_1.default.underline(`https://app.contentful.com/deeplink?link=apps&id=${createdAppDefinition.sys.id}`)}
+        ${chalk_1.default.underline(`https://${webApp}/deeplink?link=apps&id=${createdAppDefinition.sys.id}`)}
     3. Learn how to build your first Contentful app:
         ${chalk_1.default.underline(`https://ctfl.io/app-tutorial`)}
       `);

package/lib/install/install.js

@@ -8,8 +8,10 @@ const open_1 = __importDefault(require("open"));
 const chalk_1 = __importDefault(require("chalk"));
 const inquirer_1 = __importDefault(require("inquirer"));
 const constants_1 = require("../constants");
+const utils_1 = require("../utils");
 async function installToEnvironment(options) {
     let definitionId;
+    const prompts = [];
     if (options.definitionId) {
         definitionId = options.definitionId;
     }
@@ -17,15 +19,22 @@ async function installToEnvironment(options) {
         definitionId = process.env[constants_1.APP_DEF_ENV_KEY];
     }
     else {
-        const prompts = await inquirer_1.default.prompt([
-            {
-                name: 'definitionId',
-                message: `The id of the app:`,
-            },
-        ]);
-        definitionId = prompts.definitionId;
+        prompts.push({
+            name: 'definitionId',
+            message: `The id of the app:`,
+        });
     }
-    if (!definitionId) {
+    if (!options.host) {
+        prompts.push({
+            name: 'host',
+            message: `Contentful CMA endpoint URL:`,
+            default: constants_1.DEFAULT_CONTENTFUL_API_HOST,
+        });
+    }
+    const openSettingsOptions = await inquirer_1.default.prompt(prompts);
+    const hostValue = options.host || openSettingsOptions?.host;
+    const appDefinitionIdValue = definitionId || openSettingsOptions?.definitionId;
+    if (!appDefinitionIdValue) {
         console.log(`
         ${chalk_1.default.red('Error:')} There was no app-definition defined.
 
@@ -34,8 +43,8 @@ async function installToEnvironment(options) {
       `);
         throw new Error('No app-definition-id');
     }
-    const host = options.host || constants_1.DEFAULT_CONTENTFUL_APP_HOST;
-    const redirectUrl = `https://${host}/deeplink?link=apps`;
+    const webApp = (0, utils_1.getWebAppHostname)(hostValue);
+    const redirectUrl = `https://${webApp}/deeplink?link=apps`;
     try {
         (0, open_1.default)(`${redirectUrl}&id=${definitionId}`);
     }

package/lib/open/open-settings.d.ts

@@ -1,3 +1,2 @@
 import { OpenSettingsOptions } from '../types';
-export declare const REDIRECT_URL = "https://app.contentful.com/deeplink?link=app-definition";
 export declare function openSettings(options: OpenSettingsOptions): Promise<void>;

package/lib/open/open-settings.js

@@ -3,15 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REDIRECT_URL = void 0;
 exports.openSettings = openSettings;
 const open_1 = __importDefault(require("open"));
 const chalk_1 = __importDefault(require("chalk"));
 const inquirer_1 = __importDefault(require("inquirer"));
 const constants_1 = require("../constants");
-exports.REDIRECT_URL = 'https://app.contentful.com/deeplink?link=app-definition';
+const utils_1 = require("../utils");
 async function openSettings(options) {
     let definitionId;
+    const prompts = [];
     if (options.definitionId) {
         definitionId = options.definitionId;
     }
@@ -19,15 +19,22 @@ async function openSettings(options) {
         definitionId = process.env[constants_1.APP_DEF_ENV_KEY];
     }
     else {
-        const prompts = await inquirer_1.default.prompt([
-            {
-                name: 'definitionId',
-                message: `The id of the app:`,
-            },
-        ]);
-        definitionId = prompts.definitionId;
+        prompts.push({
+            name: 'definitionId',
+            message: `The id of the app:`,
+        });
     }
-    if (!definitionId) {
+    if (!options.host) {
+        prompts.push({
+            name: 'host',
+            message: `Contentful CMA endpoint URL:`,
+            default: constants_1.DEFAULT_CONTENTFUL_API_HOST,
+        });
+    }
+    const openSettingsOptions = await inquirer_1.default.prompt(prompts);
+    const hostValue = options.host || openSettingsOptions?.host;
+    const appDefinitionIdValue = definitionId || openSettingsOptions?.definitionId;
+    if (!appDefinitionIdValue) {
         console.log(`
         ${chalk_1.default.red('Error:')} There was no app-definition defined.
 
@@ -36,8 +43,10 @@ async function openSettings(options) {
       `);
         throw new Error('No app-definition-id');
     }
+    const webApp = (0, utils_1.getWebAppHostname)(hostValue);
+    const redirectUrl = `https://${webApp}/deeplink?link=app-definition`;
     try {
-        (0, open_1.default)(`${exports.REDIRECT_URL}&id=${definitionId}`);
+        (0, open_1.default)(`${redirectUrl}&id=${appDefinitionIdValue}`);
     }
     catch (err) {
         console.log(`${chalk_1.default.red('Error:')} Failed to open browser`);

package/lib/types.d.ts

@@ -49,6 +49,7 @@ export interface CleanupSettings {
 }
 export interface OpenSettingsOptions {
     definitionId?: string;
+    host?: string;
 }
 export interface InstallOptions {
     definitionId?: string;

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

@@ -41,13 +41,14 @@ async function buildAppUploadSettings(options) {
             filter: hostProtocolFilter,
         });
     }
-    const { activateBundle, ...appUploadSettings } = await (0, inquirer_1.prompt)(prompts);
-    const appInfo = await (0, get_app_info_1.getAppInfo)(options);
+    const { activateBundle, host: interactiveHost, ...appUploadSettings } = await (0, inquirer_1.prompt)(prompts);
+    const hostValue = host || interactiveHost;
+    const appInfo = await (0, get_app_info_1.getAppInfo)({ ...options, host: hostValue });
     return {
         bundleDirectory: bundleDir,
         skipActivation: skipActivation === undefined ? !activateBundle : skipActivation,
         comment,
-        host,
+        host: hostValue,
         actions: actionsManifest,
         functions: functionManifest,
         ...appUploadSettings,

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

@@ -59,13 +59,14 @@ async function createAppBundleFromSettings(settings) {
 
   Bundle Id: ${chalk_1.default.yellow(appBundle.sys.id)}
   `);
+    const webApp = (0, utils_1.getWebAppHostname)(settings.host);
     if (settings.skipActivation) {
         console.log(`
   ${chalk_1.default.green(`NEXT STEPS:`)}
 
     ${chalk_1.default.bold('You can activate this app bundle in your apps settings:')}
 
-      ${chalk_1.default.underline('https://app.contentful.com/deeplink?link=app-definition-list')}
+      ${chalk_1.default.underline(`https://${webApp}/deeplink?link=app-definition-list`)}
 
     ${chalk_1.default.bold('or by simply running the cli command:')}
 

package/lib/utils.d.ts

@@ -9,4 +9,5 @@ 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 getWebAppHostname(host: string | undefined): string;
 export {};

package/lib/utils.js

@@ -5,10 +5,12 @@ var __importDefault = (this && this.__importDefault) || function (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.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 DEFAULT_MANIFEST_PATH = './contentful-app-manifest.json';
 const functionEvents = {
     appActionCall: 'appaction.call',
@@ -19,7 +21,7 @@ const functionEvents = {
     resourceTypeMappingEvent: 'graphql.resourcetype.mapping',
     queryEvent: 'graphql.query',
     resourceLinksSearchEvent: 'resources.search',
-    resourceLinksLookupEvent: 'resources.lookup'
+    resourceLinksLookupEvent: 'resources.lookup',
 };
 const throwValidationException = (subject, message, details) => {
     console.log(`${chalk_1.default.red('Validation Error:')} Missing or invalid ${subject}.`);
@@ -148,3 +150,6 @@ function getEntityFromManifest(type) {
         process.exit(1);
     }
 }
+function getWebAppHostname(host) {
+    return host && host.includes('api') ? host.replace('api', 'app') : constants_1.DEFAULT_CONTENTFUL_APP_HOST;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.32.2",
+  "version": "1.32.3",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -54,23 +54,23 @@
     "bottleneck": "2.19.5",
     "chalk": "4.1.2",
     "commander": "12.1.0",
-    "contentful-management": "11.40.3",
+    "contentful-management": "11.47.1",
     "dotenv": "16.4.7",
     "esbuild": "^0.24.0",
-    "ignore": "7.0.0",
+    "ignore": "7.0.3",
     "inquirer": "8.2.6",
     "lodash": "4.17.21",
     "open": "8.4.2",
     "ora": "5.4.1",
     "zod": "^3.24.1"
   },
-  "gitHead": "5bc6d159d2a14c8df1fc67f5fb30829094146a6b",
+  "gitHead": "0164f4178143298b7b042452670f591830b15968",
   "devDependencies": {
     "@types/adm-zip": "0.5.7",
     "@types/analytics-node": "3.1.14",
     "@types/chai": "4.3.16",
     "@types/inquirer": "8.2.1",
-    "@types/lodash": "4.17.13",
+    "@types/lodash": "4.17.15",
     "@types/mocha": "10.0.10",
     "@types/proxyquire": "1.3.31",
     "@types/sinon": "17.0.3",