@contentful/app-scripts 1.22.0 → 1.24.0

package/README.md

@@ -220,6 +220,32 @@ When passing the `--ci` argument adding all variables as arguments is required
 
 **Note:** You can also pass all arguments in interactive mode to skip being asked for it.
 
+### Install the AppDefinition into a specific space / environment
+
+It opens a dialog to select the space and environment where the app associated with the given [AppDefinition](https://www.contentful.com/developers/docs/extensibility/app-framework/app-definition/) should be installed.
+
+> **Example**
+>
+> ```shell
+> $ npx --no-install @contentful/app-scripts install --definition-id some-definition-id
+> ```
+
+You can also execute this command without the argument if the environment variable (`CONTENTFUL_APP_DEF_ID`) has been set.
+
+> **Example**
+>
+> ```shell
+> $ CONTENTFUL_APP_DEF_ID=some-definition-id npx --no-install @contentful/app-scripts install
+> ```
+
+By default, the script will install the app into the default host URL: `app.contentful.com`. If you want to install the app into a different host URL, you can set the argument `--host` to the desired host URL.
+
+> **Example**
+>
+> ```shell
+> $ npx --no-install @contentful/app-scripts install --definition-id some-definition-id --host api.eu.contentful.com
+> ```
+
 ### 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:

package/lib/bin.js

@@ -65,6 +65,14 @@ async function runCommand(command, options) {
         .action(async (options) => {
         await runCommand(feedback_1.feedback, options);
     });
+    commander_1.program
+        .command('install')
+        .description('Opens a picker to select the space and environment for installing the app associated with a given AppDefinition')
+        .option('--definition-id  [defId]', 'The id of your apps definition')
+        .option('--host [host]', 'Contentful domain to use')
+        .action(async (options) => {
+        await runCommand(index_1.install, options);
+    });
     commander_1.program.hook('preAction', (thisCommand) => {
         (0, index_1.track)({ command: thisCommand.args[0], ci: thisCommand.opts().ci });
     });

package/lib/constants.d.ts

@@ -6,3 +6,4 @@ export declare const DEFAULT_BUNDLES_TO_KEEP = 50;
 export declare const DEFAULT_BUNDLES_TO_FETCH = 1000;
 export declare const MAX_CONCURRENT_DELETION_CALLS = 5;
 export declare const DEFAULT_CONTENTFUL_API_HOST = "api.contentful.com";
+export declare const DEFAULT_CONTENTFUL_APP_HOST = "app.contentful.com";

package/lib/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_CONTENTFUL_API_HOST = exports.MAX_CONCURRENT_DELETION_CALLS = exports.DEFAULT_BUNDLES_TO_FETCH = exports.DEFAULT_BUNDLES_TO_KEEP = exports.APP_DEF_ENV_KEY = exports.ORG_ID_ENV_KEY = exports.ACCESS_TOKEN_ENV_KEY = exports.DOTENV_FILE = void 0;
+exports.DEFAULT_CONTENTFUL_APP_HOST = exports.DEFAULT_CONTENTFUL_API_HOST = exports.MAX_CONCURRENT_DELETION_CALLS = exports.DEFAULT_BUNDLES_TO_FETCH = exports.DEFAULT_BUNDLES_TO_KEEP = exports.APP_DEF_ENV_KEY = exports.ORG_ID_ENV_KEY = exports.ACCESS_TOKEN_ENV_KEY = exports.DOTENV_FILE = void 0;
 exports.DOTENV_FILE = '.env';
 exports.ACCESS_TOKEN_ENV_KEY = 'CONTENTFUL_ACCESS_TOKEN';
 exports.ORG_ID_ENV_KEY = 'CONTENTFUL_ORG_ID';
@@ -9,3 +9,4 @@ exports.DEFAULT_BUNDLES_TO_KEEP = 50;
 exports.DEFAULT_BUNDLES_TO_FETCH = 1000;
 exports.MAX_CONCURRENT_DELETION_CALLS = 5;
 exports.DEFAULT_CONTENTFUL_API_HOST = 'api.contentful.com';
+exports.DEFAULT_CONTENTFUL_APP_HOST = 'app.contentful.com';

package/lib/index.d.ts

@@ -5,3 +5,4 @@ export { cleanup } from './clean-up';
 export { open } from './open';
 export { track } from './analytics';
 export { feedback } from './feedback';
+export { install } from './install';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.feedback = exports.track = exports.open = exports.cleanup = exports.activate = exports.upload = exports.createAppDefinition = void 0;
+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");
@@ -15,3 +15,5 @@ var analytics_1 = require("./analytics");
 Object.defineProperty(exports, "track", { enumerable: true, get: function () { return analytics_1.track; } });
 var feedback_1 = require("./feedback");
 Object.defineProperty(exports, "feedback", { enumerable: true, get: function () { return feedback_1.feedback; } });
+var install_1 = require("./install");
+Object.defineProperty(exports, "install", { enumerable: true, get: function () { return install_1.install; } });

package/lib/install/index.d.ts

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

package/lib/install/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.install = void 0;
+const install_1 = require("./install");
+const interactive = async (options) => {
+    (0, install_1.installToEnvironment)(options);
+};
+const nonInteractive = async () => {
+    throw new Error(`"install" is not available in non-interactive mode`);
+};
+exports.install = {
+    interactive,
+    nonInteractive,
+};

package/lib/install/install.d.ts

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

package/lib/install/install.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.installToEnvironment = void 0;
+const open_1 = __importDefault(require("open"));
+const chalk_1 = __importDefault(require("chalk"));
+const inquirer_1 = __importDefault(require("inquirer"));
+const constants_1 = require("../constants");
+async function installToEnvironment(options) {
+    let definitionId;
+    if (options.definitionId) {
+        definitionId = options.definitionId;
+    }
+    else if (process.env[constants_1.APP_DEF_ENV_KEY]) {
+        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;
+    }
+    if (!definitionId) {
+        console.log(`
+        ${chalk_1.default.red('Error:')} There was no app-definition defined.
+
+        Please add it with ${chalk_1.default.cyan('--definition-id=<app-definition-id>')}
+        or set the environment variable ${chalk_1.default.cyan(`${constants_1.APP_DEF_ENV_KEY} = <app-definition-id>`)}
+      `);
+        throw new Error('No app-definition-id');
+    }
+    const host = options.host || constants_1.DEFAULT_CONTENTFUL_APP_HOST;
+    const redirectUrl = `https://${host}/deeplink?link=apps`;
+    try {
+        (0, open_1.default)(`${redirectUrl}&id=${definitionId}`);
+    }
+    catch (err) {
+        console.log(`${chalk_1.default.red('Error:')} Failed to open browser`);
+        console.log(err.message);
+        throw err;
+    }
+}
+exports.installToEnvironment = installToEnvironment;

package/lib/types.d.ts

@@ -50,6 +50,10 @@ export interface CleanupSettings {
 export interface OpenSettingsOptions {
     definitionId?: string;
 }
+export interface InstallOptions {
+    definitionId?: string;
+    host?: string;
+}
 export interface UploadOptions {
     organizationId?: string;
     definitionId?: string;

package/lib/utils.js

@@ -9,9 +9,11 @@ const chalk_1 = __importDefault(require("chalk"));
 const inquirer_1 = __importDefault(require("inquirer"));
 const cache_credential_1 = require("./cache-credential");
 const DEFAULT_MANIFEST_PATH = './contentful-app-manifest.json';
-const graphQLEvents = {
+const functionEvents = {
     fieldMappingEvent: 'graphql.field.mapping',
     queryEvent: 'graphql.query',
+    resourceLinksSearchEvent: 'resources.search',
+    resourceLinksLookupEvent: 'resources.lookup',
 };
 const appEvents = {
     appEventFilter: 'appevent.filter',
@@ -101,7 +103,7 @@ function getEntityFromManifest(type) {
                 ? item.allowNetworks.map(exports.stripProtocol)
                 : [];
             const accepts = 'accepts' in item && Array.isArray(item.accepts) ? item.accepts : undefined;
-            const hasInvalidEvent = accepts?.some((event) => ![...Object.values(graphQLEvents), ...Object.values(appEvents)].includes(event));
+            const hasInvalidEvent = accepts?.some((event) => ![...Object.values(functionEvents), ...Object.values(appEvents)].includes(event));
             const hasInvalidNetwork = allowNetworks.find((netWork) => !(0, exports.isValidNetwork)(netWork));
             if (hasInvalidNetwork) {
                 console.log(`${chalk_1.default.red('Error:')} Invalid IP address ${hasInvalidNetwork} found in the allowNetworks array for ${type} "${item.name}".`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.22.0",
+  "version": "1.24.0",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -52,7 +52,7 @@
     "bottleneck": "2.19.5",
     "chalk": "4.1.2",
     "commander": "12.1.0",
-    "contentful-management": "11.26.2",
+    "contentful-management": "11.27.1",
     "dotenv": "16.4.5",
     "ignore": "5.3.1",
     "inquirer": "8.2.6",
@@ -60,14 +60,14 @@
     "open": "8.4.2",
     "ora": "5.4.1"
   },
-  "gitHead": "7aee855902d01d921a74350772f24ce1d90aeff8",
+  "gitHead": "7441f7531b4d9165d7936372acafbb82a180dccd",
   "devDependencies": {
     "@tsconfig/node18": "18.2.4",
     "@types/adm-zip": "0.5.5",
     "@types/analytics-node": "3.1.14",
     "@types/chai": "4.3.16",
     "@types/inquirer": "8.2.1",
-    "@types/lodash": "4.17.4",
+    "@types/lodash": "4.17.5",
     "@types/mocha": "10.0.6",
     "@types/proxyquire": "1.3.31",
     "@types/sinon": "17.0.3",