@contentful/app-scripts 1.11.0 → 1.13.0

package/lib/open/open-settings.js

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

package/lib/organization-api.d.ts

@@ -0,0 +1,7 @@
+import { ClientAPI } from 'contentful-management';
+export interface Organization {
+    name: string;
+    value: string;
+}
+export declare function selectOrganization(client: ClientAPI): Promise<Organization>;
+export declare function getOrganizationById(client: ClientAPI, orgId: string): Promise<Organization>;

package/lib/organization-api.js

@@ -1,57 +1,45 @@
-const ora = require('ora');
-const { selectFromList } = require('./utils');
-const { throwError } = require('./utils');
-const { ORG_ID_ENV_KEY } = require('../utils/constants');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrganizationById = exports.selectOrganization = void 0;
+const ora_1 = __importDefault(require("ora"));
+const utils_1 = require("./utils");
+const constants_1 = require("./constants");
 async function fetchOrganizations(client) {
-  try {
-    const orgs = await client.getOrganizations();
-
-    return orgs.items.map((org) => ({
-      name: org.name,
-      value: org.sys.id,
-    }));
-  } catch (err) {
-    throwError(
-      err,
-      'Could not fetch your organizations. Make sure you provided a valid access token.'
-    );
-  }
+    try {
+        const orgs = await client.getOrganizations();
+        return orgs.items.map((org) => ({
+            name: org.name,
+            value: org.sys.id,
+        }));
+    }
+    catch (err) {
+        return (0, utils_1.throwError)(err, 'Could not fetch your organizations. Make sure you provided a valid access token.');
+    }
 }
-
 async function selectOrganization(client) {
-  const orgSpinner = ora('Fetching your organizations...').start();
-  let organizations = null;
-
-  try {
-    organizations = await fetchOrganizations(client);
-  } finally {
-    orgSpinner.stop();
-  }
-
-  if (!organizations) {
-    return null;
-  }
-
-  return await selectFromList(organizations, 'Select an organization:', ORG_ID_ENV_KEY);
+    const orgSpinner = (0, ora_1.default)('Fetching your organizations...').start();
+    try {
+        const organizations = await fetchOrganizations(client);
+        return await (0, utils_1.selectFromList)(organizations, 'Select an organization:', constants_1.ORG_ID_ENV_KEY);
+    }
+    finally {
+        orgSpinner.stop();
+    }
 }
-
+exports.selectOrganization = selectOrganization;
 async function getOrganizationById(client, orgId) {
-  try {
-    const org = await client.getOrganization(orgId);
-    return {
-      name: org.name,
-      value: org.sys.id,
-    };
-  } catch (err) {
-    throwError(
-      err,
-      'Could not fetch your organization. Make sure you provided a valid access token.'
-    );
-  }
+    try {
+        const org = await client.getOrganization(orgId);
+        return {
+            name: org.name,
+            value: org.sys.id,
+        };
+    }
+    catch (err) {
+        return (0, utils_1.throwError)(err, 'Could not fetch your organization. Make sure you provided a valid access token.');
+    }
 }
-
-module.exports = {
-  selectOrganization,
-  getOrganizationById,
-};
+exports.getOrganizationById = getOrganizationById;

package/lib/types.d.ts

@@ -0,0 +1,73 @@
+import { Definition } from "./definition-api";
+import { Organization } from "./organization-api";
+export interface FunctionAppAction {
+    id: string;
+    name: string;
+    description: string;
+    category: 'Custom';
+    type: 'function';
+    path: string;
+    allowNetworks?: string[];
+    entryFile?: string;
+}
+export interface DeliveryFunction {
+    id: string;
+    name: string;
+    description: string;
+    path: string;
+    allowNetworks?: string[];
+    entryFile?: string;
+}
+export interface ActivateOptions {
+    bundleId: string;
+    organizationId?: string;
+    definitionId?: string;
+    token?: string;
+    host?: string;
+}
+export interface ActivateSettings {
+    bundleId: string;
+    organization: Organization;
+    definition: Definition;
+    accessToken: string;
+    host?: string;
+}
+export interface CleanupOptions {
+    organizationId?: string;
+    definitionId?: string;
+    token?: string;
+    host?: string;
+    keep?: string;
+}
+export interface CleanupSettings {
+    keep: number;
+    host?: string;
+    accessToken: string;
+    organization: Organization;
+    definition: Definition;
+}
+export interface OpenSettingsOptions {
+    definitionId?: string;
+}
+export interface UploadOptions {
+    organizationId?: string;
+    definitionId?: string;
+    token?: string;
+    bundleDir?: string;
+    comment?: string;
+    skipActivation?: boolean;
+    host?: string;
+    userAgentApplication?: string;
+}
+export interface UploadSettings {
+    organization: Organization;
+    definition: Definition;
+    accessToken: string;
+    comment?: string;
+    bundleDirectory: string;
+    skipActivation?: boolean;
+    userAgentApplication?: string;
+    host?: string;
+    actions?: FunctionAppAction[];
+    deliveryFunctions?: DeliveryFunction[];
+}

package/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/upload/build-upload-settings.d.ts

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

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

@@ -1,59 +1,55 @@
-// @ts-check
-
-const inquirer = require('inquirer');
-const { getAppInfo } = require('../get-app-info');
-const { getActionsManifest } = require('../utils');
-const { CONTENTFUL_API_HOST } = require('../../utils/constants');
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAppUploadSettings = void 0;
+const inquirer_1 = require("inquirer");
+const get_app_info_1 = require("../get-app-info");
+const utils_1 = require("../utils");
+const constants_1 = require("../constants");
 async function buildAppUploadSettings(options) {
-  const actionsManifest = getActionsManifest();
-  const prompts = [];
-  const { bundleDir, comment, skipActivation, host } = options;
-  if (!bundleDir) {
-    prompts.push({
-      name: 'bundleDirectory',
-      message: `Bundle directory, if not default:`,
-      default: './build',
-    });
-  }
-  if (!comment) {
-    prompts.push({
-      name: 'comment',
-      message: `Add a comment to the created bundle:`,
-      default: '',
-    });
-  }
-  if (skipActivation === undefined) {
-    prompts.push({
-      type: 'confirm',
-      name: 'activateBundle',
-      message: `Do you want to activate the bundle after upload?`,
-      default: true,
-    });
-  }
-  if (!host) {
-    prompts.push({
-      name: 'host',
-      message: `Contentful CMA endpoint URL:`,
-      default: CONTENTFUL_API_HOST,
-    });
-  }
-
-  const { activateBundle, ...appUploadSettings } = await inquirer.prompt(prompts);
-
-  const appInfo = await getAppInfo(options);
-  // Add app-config & dialog automatically
-  return {
-    bundleDirectory: bundleDir,
-    skipActivation: skipActivation === undefined ? !activateBundle : skipActivation,
-    comment,
-    host,
-    actions: actionsManifest,
-    ...appUploadSettings,
-    ...appInfo,
-  };
+    const actionsManifest = (0, utils_1.getEntityFromManifest)('actions');
+    const deliveryFnManifest = (0, utils_1.getEntityFromManifest)('deliveryFunctions');
+    const prompts = [];
+    const { bundleDir, comment, skipActivation, host } = options;
+    if (!bundleDir) {
+        prompts.push({
+            name: 'bundleDirectory',
+            message: `Bundle directory, if not default:`,
+            default: './build',
+        });
+    }
+    if (!comment) {
+        prompts.push({
+            name: 'comment',
+            message: `Add a comment to the created bundle:`,
+            default: '',
+        });
+    }
+    if (skipActivation === undefined) {
+        prompts.push({
+            type: 'confirm',
+            name: 'activateBundle',
+            message: `Do you want to activate the bundle after upload?`,
+            default: true,
+        });
+    }
+    if (!host) {
+        prompts.push({
+            name: 'host',
+            message: `Contentful CMA endpoint URL:`,
+            default: constants_1.DEFAULT_CONTENTFUL_API_HOST,
+        });
+    }
+    const { activateBundle, ...appUploadSettings } = await (0, inquirer_1.prompt)(prompts);
+    const appInfo = await (0, get_app_info_1.getAppInfo)(options);
+    return {
+        bundleDirectory: bundleDir,
+        skipActivation: skipActivation === undefined ? !activateBundle : skipActivation,
+        comment,
+        host,
+        actions: actionsManifest,
+        deliveryFunctions: deliveryFnManifest,
+        ...appUploadSettings,
+        ...appInfo,
+    };
 }
-
-module.exports = {
-  buildAppUploadSettings,
-};
+exports.buildAppUploadSettings = buildAppUploadSettings;

package/lib/upload/create-app-bundle.d.ts

@@ -0,0 +1,3 @@
+import { UploadSettings } from '../types';
+export declare function createAppBundleFromUpload(settings: UploadSettings, appUploadId: string): Promise<import("contentful-management").AppBundle | null>;
+export declare function createAppBundleFromSettings(settings: UploadSettings): Promise<void | import("contentful-management").AppBundle>;

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

@@ -1,84 +1,78 @@
-const chalk = require('chalk');
-const ora = require('ora');
-const { showCreationError } = require('../utils');
-const { createClient } = require('contentful-management');
-
-const { createAppUpload } = require('./create-app-upload');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAppBundleFromSettings = exports.createAppBundleFromUpload = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const utils_1 = require("../utils");
+const contentful_management_1 = require("contentful-management");
+const create_app_upload_1 = require("./create-app-upload");
 async function createAppBundleFromUpload(settings, appUploadId) {
-  const { accessToken, host, userAgentApplication, comment, actions } = settings;
-  const clientSpinner = ora('Verifying your upload...').start();
-  const client = createClient({
-    accessToken,
-    host,
-    application: userAgentApplication ? userAgentApplication : 'contentful.app-scripts',
-  });
-  const organization = await client.getOrganization(settings.organization.value);
-  const appDefinition = await organization.getAppDefinition(settings.definition.value);
-  clientSpinner.stop();
-
-  let appBundle = null;
-  const bundleSpinner = ora('Creating the app bundle...').start();
-  try {
-    appBundle = await appDefinition.createAppBundle({
-      appUploadId,
-      comment: comment && comment.length > 0 ? comment : undefined,
-      actions,
+    const { accessToken, host, userAgentApplication, comment, actions, deliveryFunctions } = settings;
+    const clientSpinner = (0, ora_1.default)('Verifying your upload...').start();
+    const client = (0, contentful_management_1.createClient)({
+        accessToken,
+        host,
+        application: userAgentApplication ? userAgentApplication : 'contentful.app-scripts',
     });
-  } catch (err) {
-    showCreationError('app upload', err.message);
-  }
-  bundleSpinner.stop();
-  return appBundle;
+    const organization = await client.getOrganization(settings.organization.value);
+    const appDefinition = await organization.getAppDefinition(settings.definition.value);
+    clientSpinner.stop();
+    let appBundle = null;
+    const bundleSpinner = (0, ora_1.default)('Creating the app bundle...').start();
+    try {
+        appBundle = await appDefinition.createAppBundle({
+            appUploadId,
+            comment: comment && comment.length > 0 ? comment : undefined,
+            actions,
+            deliveryFunctions,
+        });
+    }
+    catch (err) {
+        (0, utils_1.showCreationError)('app upload', err.message);
+    }
+    bundleSpinner.stop();
+    return appBundle;
 }
-
+exports.createAppBundleFromUpload = createAppBundleFromUpload;
 async function createAppBundleFromSettings(settings) {
-  let appUpload = null;
-  try {
-    appUpload = await createAppUpload(settings);
+    let appUpload = null;
+    try {
+        appUpload = await (0, create_app_upload_1.createAppUpload)(settings);
+        if (!appUpload)
+            return;
+        console.log(`
+  ${chalk_1.default.yellow('Done!')} Your files were successfully uploaded and a new AppUpload (${chalk_1.default.dim(appUpload.sys.id)}) has been created.`);
+    }
+    catch (err) {
+        return (0, utils_1.showCreationError)('app upload', err.message);
+    }
+    console.log('');
+    console.log(`  ----------------------------`);
+    const appBundle = await createAppBundleFromUpload(settings, appUpload.sys.id);
+    if (!appBundle)
+        return;
     console.log(`
-  ${chalk.yellow('Done!')} Your files were successfully uploaded and a new AppUpload (${chalk.dim(
-      appUpload.sys.id
-    )}) has been created.`);
-  } catch (err) {
-    showCreationError('app upload', err.message);
-  }
-
-  if (!appUpload) return;
-
-  console.log('');
-  console.log(`  ----------------------------`);
-  const appBundle = await createAppBundleFromUpload(settings, appUpload.sys.id);
+  ${chalk_1.default.cyan('Success!')} Created a new app bundle for ${chalk_1.default.cyan(settings.definition.name)} in ${chalk_1.default.bold(settings.organization.name)}.
 
-  if (!appBundle) return;
-
-  console.log(`
-  ${chalk.cyan('Success!')} Created a new app bundle for ${chalk.cyan(
-    settings.definition.name
-  )} in ${chalk.bold(settings.organization.name)}.
-
-  Bundle Id: ${chalk.yellow(appBundle.sys.id)}
+  Bundle Id: ${chalk_1.default.yellow(appBundle.sys.id)}
   `);
+    if (settings.skipActivation) {
+        console.log(`
+  ${chalk_1.default.green(`NEXT STEPS:`)}
 
-  if (settings.skipActivation) {
-    console.log(`
-  ${chalk.green(`NEXT STEPS:`)}
-
-    ${chalk.bold('You can activate this app bundle in your apps settings:')}
+    ${chalk_1.default.bold('You can activate this app bundle in your apps settings:')}
 
-      ${chalk.underline('https://app.contentful.com/deeplink?link=app-definition-list')}
+      ${chalk_1.default.underline('https://app.contentful.com/deeplink?link=app-definition-list')}
 
-    ${chalk.bold('or by simply running the cli command:')}
+    ${chalk_1.default.bold('or by simply running the cli command:')}
 
-      ${chalk.underline('npx @contentful/app-scripts activate')}
+      ${chalk_1.default.underline('npx @contentful/app-scripts activate')}
 
   `);
-  }
-
-  return appBundle;
+    }
+    return appBundle;
 }
-
-module.exports = {
-  createAppBundleFromSettings,
-  createAppBundleFromUpload,
-};
+exports.createAppBundleFromSettings = createAppBundleFromSettings;

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

@@ -0,0 +1,2 @@
+import { UploadSettings } from '../types';
+export declare function createAppUpload(settings: UploadSettings): Promise<import("contentful-management").AppUpload | null | undefined>;

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

@@ -1,40 +1,35 @@
-const ora = require('ora');
-const { createZipFileFromDirectory } = require('./create-zip-from-directory');
-const { validateBundle } = require('./validate-bundle');
-const { showCreationError } = require('../utils');
-const { createClient } = require('contentful-management');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAppUpload = void 0;
+const ora_1 = __importDefault(require("ora"));
+const create_zip_from_directory_1 = require("./create-zip-from-directory");
+const validate_bundle_1 = require("./validate-bundle");
+const utils_1 = require("../utils");
+const contentful_management_1 = require("contentful-management");
 async function createAppBundleFromFile(orgId, token, zip, host = '') {
-  const client = await createClient({ accessToken: token, host, hostUpload: host.replace(/^api/i, 'upload') });
-  const org = await client.getOrganization(orgId);
-  return await org.createAppUpload(zip);
+    const client = (0, contentful_management_1.createClient)({ accessToken: token, host, hostUpload: host.replace(/^api/i, 'upload') });
+    const org = await client.getOrganization(orgId);
+    return await org.createAppUpload(zip);
 }
-
 async function createAppUpload(settings) {
-  validateBundle(settings.bundleDirectory || '.');
-  let appUpload = null;
-  const zipFileSpinner = ora('Preparing your files for upload...').start();
-  const zipFile = await createZipFileFromDirectory(settings.bundleDirectory || '.');
-  zipFileSpinner.stop();
-
-  if (!zipFile) return;
-
-  const uploadSpinner = ora('Uploading your files...').start();
-  try {
-    appUpload = await createAppBundleFromFile(
-      settings.organization.value,
-      settings.accessToken,
-      zipFile,
-      settings.host
-    );
-  } catch (err) {
-    showCreationError('app bundle', err.message);
-  }
-
-  uploadSpinner.stop();
-  return appUpload;
+    (0, validate_bundle_1.validateBundle)(settings.bundleDirectory || '.');
+    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');
+    zipFileSpinner.stop();
+    if (!zipFile)
+        return;
+    const uploadSpinner = (0, ora_1.default)('Uploading your files...').start();
+    try {
+        appUpload = await createAppBundleFromFile(settings.organization.value, settings.accessToken, zipFile, settings.host);
+    }
+    catch (err) {
+        (0, utils_1.showCreationError)('app bundle', err.message);
+    }
+    uploadSpinner.stop();
+    return appUpload;
 }
-
-module.exports = {
-  createAppUpload,
-};
+exports.createAppUpload = createAppUpload;

package/lib/upload/create-zip-from-directory.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="node" />
+export declare function createZipFileFromDirectory(path: string): Promise<Buffer | null>;