@contentful/app-scripts 1.11.0 → 1.13.0

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

@@ -1,127 +1,95 @@
-const path = require('path');
-
-const { createClient } = require('contentful-management');
-const chalk = require('chalk');
-const { isString, isPlainObject, has } = require('lodash');
-
-const { throwValidationException, selectFromList } = require('../utils');
-const { cacheEnvVars } = require('../../utils/cache-credential');
-const { ORG_ID_ENV_KEY, APP_DEF_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.createAppDefinition = void 0;
+const path_1 = __importDefault(require("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");
 async function fetchOrganizations(client) {
-  try {
-    const orgs = await client.getOrganizations();
-
-    return orgs.items.map((org) => ({
-      name: org.name,
-      value: org.sys.id,
-    }));
-  } catch (err) {
-    console.log(`
-${chalk.red(
-  'Error:'
-)} 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) {
+        console.log(`
+${chalk_1.default.red('Error:')} Could not fetch your organizations. Make sure you provided a valid access token.
 
 ${err.message}
     `);
-
-    throw err;
-  }
+        throw err;
+    }
 }
-
 function assertValidArguments(accessToken, appDefinitionSettings) {
-  if (!isString(accessToken)) {
-    throwValidationException('AccessToken', `Expected string got ${typeof accessToken}`);
-  }
-
-  if (!isPlainObject(appDefinitionSettings) || !has(appDefinitionSettings, 'locations')) {
-    throwValidationException(
-      'AppDefinitionSettings',
-      `Expected plain object with 'location' property, got ${JSON.stringify(
-        appDefinitionSettings,
-        null,
-        2
-      )}`,
-      `Example: ${JSON.stringify(
-        {
-          name: 'app-name',
-          locations: ['entry-field'],
-          fields: [{ type: 'Boolean' }],
-        },
-        null,
-        2
-      )}`
-    );
-  }
+    if (!(0, lodash_1.isString)(accessToken)) {
+        (0, utils_1.throwValidationException)('AccessToken', `Expected string got ${typeof accessToken}`);
+    }
+    if (!(0, lodash_1.isPlainObject)(appDefinitionSettings) || !(0, lodash_1.has)(appDefinitionSettings, 'locations')) {
+        (0, utils_1.throwValidationException)('AppDefinitionSettings', `Expected plain object with 'location' property, got ${JSON.stringify(appDefinitionSettings, null, 2)}`, `Example: ${JSON.stringify({
+            name: 'app-name',
+            locations: ['entry-field'],
+            fields: [{ type: 'Boolean' }],
+        }, null, 2)}`);
+    }
 }
-
-async function createAppDefinition(accessToken, appDefinitionSettings = { locations: [] }) {
-  assertValidArguments(accessToken, appDefinitionSettings);
-
-  const client = createClient({ accessToken });
-  const organizations = await fetchOrganizations(client);
-
-  const selectedOrg = await selectFromList(
-    organizations,
-    'Select an organization for your app:',
-    ORG_ID_ENV_KEY
-  );
-  const organizationId = selectedOrg.value;
-
-  const appName = appDefinitionSettings.name || path.basename(process.cwd());
-  const body = {
-    name: appName,
-    src: 'http://localhost:3000',
-    locations: appDefinitionSettings.locations.map((location) => {
-      if (location === 'entry-field') {
-        return {
-          location,
-          fieldTypes: appDefinitionSettings.fields,
-        };
-      }
-
-      return {
-        location,
-      };
-    }),
-  };
-
-  try {
-    const organization = await client.getOrganization(organizationId);
-    const createdAppDefinition = await organization.createAppDefinition(body);
-    await cacheEnvVars({
-      [APP_DEF_ENV_KEY]: createdAppDefinition.sys.id,
-    });
-
-    console.log(`
-  ${chalk.greenBright('Success!')} Created an app definition for ${chalk.bold(appName)} in ${chalk.bold(
-      selectedOrg.name
-    )}.
-
-  ${chalk.dim(`NOTE: You can update this app definition in your organization settings:
-        ${chalk.underline(`https://app.contentful.com/deeplink?link=org`)}`)}
-
-  ${chalk.bold('Next steps:')}
-    1. Run your app with ${chalk.cyan('`npm start`')} inside of your app folder.
+async function createAppDefinition(accessToken, appDefinitionSettings) {
+    assertValidArguments(accessToken, appDefinitionSettings);
+    const client = (0, contentful_management_1.createClient)({ accessToken });
+    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 body = {
+        name: appName,
+        src: 'http://localhost:3000',
+        locations: appDefinitionSettings.locations.map((location) => {
+            if (location === 'entry-field') {
+                return {
+                    location,
+                    fieldTypes: appDefinitionSettings.fields || [],
+                };
+            }
+            return {
+                location,
+            };
+        }),
+    };
+    try {
+        const organization = await client.getOrganization(organizationId);
+        const createdAppDefinition = await organization.createAppDefinition(body);
+        await (0, cache_credential_1.cacheEnvVars)({
+            [constants_1.APP_DEF_ENV_KEY]: createdAppDefinition.sys.id,
+        });
+        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.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.underline(
-          `https://app.contentful.com/deeplink?link=apps&id=${createdAppDefinition.sys.id}`
-        )}
+        ${chalk_1.default.underline(`https://app.contentful.com/deeplink?link=apps&id=${createdAppDefinition.sys.id}`)}
     3. Learn how to build your first Contentful app:
-        ${chalk.underline(`https://ctfl.io/app-tutorial`)}
+        ${chalk_1.default.underline(`https://ctfl.io/app-tutorial`)}
       `);
-  } catch (err) {
-    console.log(`
+    }
+    catch (err) {
+        console.log(`
   Something went wrong while creating the app definition.
-  Run ${chalk.cyan('`npx @contentful/app-scripts create-app-definition`')} to try again.
+  Run ${chalk_1.default.cyan('`npx @contentful/app-scripts create-app-definition`')} to try again.
 
   ${err.message}
     `);
-
-    throw err;
-  }
+        throw err;
+    }
 }
-
-module.exports = {
-  createAppDefinition,
-};
+exports.createAppDefinition = createAppDefinition;

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

@@ -0,0 +1,4 @@
+export declare const createAppDefinition: {
+    interactive: () => Promise<void>;
+    nonInteractive: () => Promise<never>;
+};

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

@@ -1,15 +1,18 @@
-const {buildAppDefinitionSettings} = require('./build-app-definition-settings')
-const {createAppDefinition} = require('./create-app-definition')
-const {getManagementToken} = require('../get-management-token')
-
-module.exports = {
-  async interactive() {
-    const appDefinitionSettings = await buildAppDefinitionSettings();
-    const managementToken = await getManagementToken();
-
-    return createAppDefinition(managementToken, appDefinitionSettings);
-  },
-  async nonInteractive() {
-    throw new Error(`"create-app-definition" is not available in non-interactive mode`)
-  }
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAppDefinition = void 0;
+const build_app_definition_settings_1 = require("./build-app-definition-settings");
+const create_app_definition_1 = require("./create-app-definition");
+const get_management_token_1 = require("../get-management-token");
+const interactive = async () => {
+    const appDefinitionSettings = await (0, build_app_definition_settings_1.buildAppDefinitionSettings)();
+    const managementToken = await (0, get_management_token_1.getManagementToken)();
+    return (0, create_app_definition_1.createAppDefinition)(managementToken, appDefinitionSettings);
+};
+const nonInteractive = async () => {
+    throw new Error(`"create-app-definition" is not available in non-interactive mode`);
+};
+exports.createAppDefinition = {
+    interactive,
+    nonInteractive,
+};

package/lib/definition-api.d.ts

@@ -0,0 +1,7 @@
+import { ClientAPI } from 'contentful-management';
+export interface Definition {
+    name: string;
+    value: 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

@@ -1,50 +1,43 @@
-const ora = require('ora');
-const { selectFromList } = require('./utils');
-const { throwError } = require('./utils');
-const { APP_DEF_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.getDefinitionById = exports.selectDefinition = void 0;
+const ora_1 = __importDefault(require("ora"));
+const utils_1 = require("./utils");
+const constants_1 = require("./constants");
 async function fetchDefinitions(client, orgId) {
-  try {
-    const organization = await client.getOrganization(orgId);
-    const definitions = await organization.getAppDefinitions();
-    return definitions.items.map((def) => ({
-      name: def.name,
-      value: def.sys.id,
-    }));
-  } catch (err) {
-    throwError(
-      'Could not fetch your app-definitions. Make sure you provided a valid access token.',
-      err
-    );
-  }
+    try {
+        const organization = await client.getOrganization(orgId);
+        const definitions = await organization.getAppDefinitions();
+        return definitions.items.map((def) => ({
+            name: def.name,
+            value: def.sys.id,
+        }));
+    }
+    catch (err) {
+        return (0, utils_1.throwError)(err, 'Could not fetch your app-definitions. Make sure you provided a valid access token.');
+    }
 }
-
 async function selectDefinition(client, orgId) {
-  const defSpinner = ora('Fetching all definitions...').start();
-  const definitions = await fetchDefinitions(client, orgId);
-  defSpinner.stop();
-
-  return await selectFromList(definitions, 'Select an app:', APP_DEF_ENV_KEY);
+    const defSpinner = (0, ora_1.default)('Fetching all definitions...').start();
+    const definitions = await fetchDefinitions(client, orgId);
+    defSpinner.stop();
+    return await (0, utils_1.selectFromList)(definitions, 'Select an app:', constants_1.APP_DEF_ENV_KEY);
 }
-
+exports.selectDefinition = selectDefinition;
 async function getDefinitionById(client, orgId, defId) {
-  try {
-    const organization = await client.getOrganization(orgId);
-    const definition = await organization.getAppDefinition(defId);
-    return {
-      name: definition.name,
-      value: definition.sys.id,
-    };
-  } catch (err) {
-    throwError(
-      'Could not fetch your app-definition. Make sure you provided a valid definition id or access token.',
-      err
-    );
-    throw err;
-  }
+    try {
+        const organization = await client.getOrganization(orgId);
+        const definition = await organization.getAppDefinition(defId);
+        return {
+            name: definition.name,
+            value: definition.sys.id,
+        };
+    }
+    catch (err) {
+        return (0, utils_1.throwError)(err, 'Could not fetch your app-definition. Make sure you provided a valid definition id or access token.');
+    }
 }
-
-module.exports = {
-  selectDefinition,
-  getDefinitionById,
-};
+exports.getDefinitionById = getDefinitionById;

package/lib/get-app-info.d.ts

@@ -0,0 +1,10 @@
+export declare const getAppInfo: ({ organizationId, definitionId, token, host, }: {
+    organizationId?: string | undefined;
+    definitionId?: string | undefined;
+    token?: string | undefined;
+    host?: string | undefined;
+}) => Promise<{
+    accessToken: string;
+    organization: import("./organization-api").Organization;
+    definition: import("./definition-api").Definition;
+}>;

package/lib/get-app-info.js

@@ -1,28 +1,23 @@
-const { getDefinitionById, selectDefinition } = require('./definition-api');
-const { selectOrganization, getOrganizationById } = require('./organization-api');
-const { createClient } = require('contentful-management');
-const { getManagementToken } = require('./get-management-token');
-
-const getAppInfo = async (options) => {
-  const { host } = options;
-  const accessToken = options.token || (await getManagementToken(host));
-  const client = createClient({ accessToken, host });
-
-  const organization = options.organizationId
-    ? await getOrganizationById(client, options.organizationId)
-    : await selectOrganization(client);
-
-  const definition = options.definitionId
-    ? await getDefinitionById(client, organization.value, options.definitionId)
-    : await selectDefinition(client, organization.value);
-
-  return {
-    accessToken,
-    organization,
-    definition,
-  };
-};
-
-module.exports = {
-  getAppInfo,
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppInfo = void 0;
+const definition_api_1 = require("./definition-api");
+const organization_api_1 = require("./organization-api");
+const contentful_management_1 = require("contentful-management");
+const get_management_token_1 = require("./get-management-token");
+const getAppInfo = async ({ organizationId, definitionId, token, host, }) => {
+    const accessToken = token || (await (0, get_management_token_1.getManagementToken)(host));
+    const client = (0, contentful_management_1.createClient)({ accessToken, host });
+    const organization = organizationId
+        ? await (0, organization_api_1.getOrganizationById)(client, organizationId)
+        : await (0, organization_api_1.selectOrganization)(client);
+    const definition = definitionId
+        ? await (0, definition_api_1.getDefinitionById)(client, organization.value, definitionId)
+        : await (0, definition_api_1.selectDefinition)(client, organization.value);
+    return {
+        accessToken,
+        organization,
+        definition,
+    };
 };
+exports.getAppInfo = getAppInfo;

package/lib/get-management-token.d.ts

@@ -0,0 +1 @@
+export declare function getManagementToken(host?: string): Promise<string>;

package/lib/get-management-token.js

@@ -1,64 +1,57 @@
+"use strict";
 /* eslint-disable no-console, no-process-exit */
-
-const chalk = require('chalk');
-const open = require('open');
-const inquirer = require('inquirer');
-const { cacheEnvVars } = require('../utils/cache-credential');
-const { createClient } = require('contentful-management');
-const { ACCESS_TOKEN_ENV_KEY } = require('../utils/constants');
-
-const checkTokenValidity = async (accessToken, host) => {
-  try {
-    const client = createClient({ accessToken, host });
-    await client.getCurrentUser();
-    return true;
-  } catch (err) {
-    return false;
-  }
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-
-async function getManagementToken(host) {
-  const redirectUrl = 'https://www.contentful.com/developers/cli-oauth-page/';
-  const CLIENT_ID = '9f86a1d54f3d6f85c159468f5919d6e5d27716b3ed68fd01bd534e3dea2df864';
-  const oauthUrl = `https://be.contentful.com/oauth/authorize?response_type=token&scope=content_management_manage&client_id=${CLIENT_ID}&&redirect_uri=${encodeURIComponent(
-    redirectUrl
-  )}`;
-
-  const cachedAccessToken = process.env[ACCESS_TOKEN_ENV_KEY];
-  const cachedTokenValid = await checkTokenValidity(cachedAccessToken, host);
-
-  if (cachedTokenValid) {
-    return cachedAccessToken;
-  }
-
-  try {
-    open(oauthUrl);
-  } catch (err) {
-    console.log(`${chalk.red('Error:')} Failed to open browser`);
-    console.log(err.message);
-    throw err;
-  }
-
-  const { mgmtToken } = await inquirer.prompt([
-    {
-      name: 'mgmtToken',
-      message: 'Please paste your access token:',
-      type: 'password',
-      validate(answer) {
-        if (!answer) {
-          return `${chalk.red('Error:')} Failed to login into Contentful.`;
-        }
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getManagementToken = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const open_1 = __importDefault(require("open"));
+const inquirer_1 = __importDefault(require("inquirer"));
+const cache_credential_1 = require("./cache-credential");
+const contentful_management_1 = require("contentful-management");
+const constants_1 = require("./constants");
+const checkTokenValidity = async (accessToken = '', host) => {
+    try {
+        const client = (0, contentful_management_1.createClient)({ accessToken, host });
+        await client.getCurrentUser();
         return true;
-      },
-    },
-  ]);
-
-  await cacheEnvVars({ [ACCESS_TOKEN_ENV_KEY]: mgmtToken });
-
-  return mgmtToken;
-}
-
-module.exports = {
-  getManagementToken,
+    }
+    catch (err) {
+        return false;
+    }
 };
+async function getManagementToken(host) {
+    const redirectUrl = 'https://www.contentful.com/developers/cli-oauth-page/';
+    const CLIENT_ID = '9f86a1d54f3d6f85c159468f5919d6e5d27716b3ed68fd01bd534e3dea2df864';
+    const oauthUrl = `https://be.contentful.com/oauth/authorize?response_type=token&scope=content_management_manage&client_id=${CLIENT_ID}&&redirect_uri=${encodeURIComponent(redirectUrl)}`;
+    const cachedAccessToken = process.env[constants_1.ACCESS_TOKEN_ENV_KEY];
+    const cachedTokenValid = await checkTokenValidity(cachedAccessToken, host);
+    if (cachedTokenValid) {
+        return cachedAccessToken;
+    }
+    try {
+        (0, open_1.default)(oauthUrl);
+    }
+    catch (err) {
+        console.log(`${chalk_1.default.red('Error:')} Failed to open browser`);
+        console.log(err.message);
+        throw err;
+    }
+    const { mgmtToken } = await inquirer_1.default.prompt([
+        {
+            name: 'mgmtToken',
+            message: 'Please paste your access token:',
+            type: 'password',
+            validate(answer) {
+                if (!answer) {
+                    return `${chalk_1.default.red('Error:')} Failed to login into Contentful.`;
+                }
+                return true;
+            },
+        },
+    ]);
+    await (0, cache_credential_1.cacheEnvVars)({ [constants_1.ACCESS_TOKEN_ENV_KEY]: mgmtToken });
+    return mgmtToken;
+}
+exports.getManagementToken = getManagementToken;

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+export { createAppDefinition } from './create-app-definition';
+export { upload } from './upload';
+export { activate } from './activate';
+export { cleanup } from './clean-up';
+export { open } from './open';
+export { track } from './analytics';

package/lib/index.js

@@ -1,15 +1,15 @@
-const createAppDefinition = require('./create-app-definition');
-const upload = require('./upload');
-const activate = require('./activate');
-const cleanup = require('./clean-up');
-const open = require('./open');
-const track = require('../utils/analytics');
-
-module.exports = {
-  createAppDefinition,
-  upload,
-  activate,
-  cleanup,
-  open,
-  track,
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+Object.defineProperty(exports, "upload", { enumerable: true, get: function () { return upload_1.upload; } });
+var activate_1 = require("./activate");
+Object.defineProperty(exports, "activate", { enumerable: true, get: function () { return activate_1.activate; } });
+var clean_up_1 = require("./clean-up");
+Object.defineProperty(exports, "cleanup", { enumerable: true, get: function () { return clean_up_1.cleanup; } });
+var open_1 = require("./open");
+Object.defineProperty(exports, "open", { enumerable: true, get: function () { return open_1.open; } });
+var analytics_1 = require("./analytics");
+Object.defineProperty(exports, "track", { enumerable: true, get: function () { return analytics_1.track; } });

package/lib/open/index.d.ts

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

package/lib/open/index.js

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

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

@@ -0,0 +1,3 @@
+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>;