@contentful/app-scripts 1.17.0 → 1.19.0

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

@@ -10,12 +10,16 @@ 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 = (0, contentful_management_1.createClient)({ accessToken: token, host, hostUpload: host.replace(/^api/i, 'upload') });
+    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) {
-    (0, validate_bundle_1.validateBundle)(settings.bundleDirectory || '.');
+    (0, validate_bundle_1.validateBundle)(settings.bundleDirectory || '.', settings);
     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');

package/lib/upload/validate-bundle.d.ts

@@ -1 +1,2 @@
-export declare const validateBundle: (path: string) => void;
+import { UploadSettings } from '../types';
+export declare const validateBundle: (path: string, { functions, actions }: Pick<UploadSettings, 'functions' | 'actions'>) => void;

package/lib/upload/validate-bundle.js

@@ -8,14 +8,14 @@ const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const chalk_1 = __importDefault(require("chalk"));
 const ACCEPTED_ENTRY_FILES = ['index.html'];
-const getEntryFile = (files) => files.find(file => ACCEPTED_ENTRY_FILES.includes(file));
+const getEntryFile = (files) => files.find((file) => ACCEPTED_ENTRY_FILES.includes(file));
 const ABSOLUTE_PATH_REG_EXP = /(src|href)="\/([^/])([^"]*)+"/g;
 const fileContainsAbsolutePath = (fileContent) => {
     return [...fileContent.matchAll(ABSOLUTE_PATH_REG_EXP)].length > 0;
 };
-const validateBundle = (path) => {
+const validateBundle = (path, { functions, actions }) => {
     const buildFolder = path_1.default.join('./', path);
-    const files = fs_1.default.readdirSync(buildFolder);
+    const files = fs_1.default.readdirSync(buildFolder, { recursive: true, encoding: 'utf-8' });
     const entry = getEntryFile(files);
     if (!entry) {
         throw new Error('Make sure your bundle includes a valid index.html file in its root folder.');
@@ -26,5 +26,17 @@ const validateBundle = (path) => {
         console.warn(`${chalk_1.default.red('Warning:')} This bundle uses absolute paths. Please use relative paths instead for correct rendering. See more details here https://www.contentful.com/developers/docs/extensibility/app-framework/app-bundle/#limitations`);
         console.log('----------------------------');
     }
+    if (functions) {
+        const functionWithoutEntryFile = functions.find(({ path }) => !files.includes(path));
+        if (functionWithoutEntryFile) {
+            throw new Error(`Function "${functionWithoutEntryFile.id}" is missing its entry file at "${path_1.default.join(buildFolder, functionWithoutEntryFile.path)}".`);
+        }
+    }
+    if (actions) {
+        const actionWithoutEntryFile = actions.find(({ path }) => !files.includes(path));
+        if (actionWithoutEntryFile) {
+            throw new Error(`Action "${actionWithoutEntryFile.id}" is missing its entry file at "${path_1.default.join(buildFolder, actionWithoutEntryFile.path)}".`);
+        }
+    }
 };
 exports.validateBundle = validateBundle;

package/lib/utils.js

@@ -9,6 +9,15 @@ 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 = {
+    fieldMappingEvent: 'graphql.field.mapping',
+    queryEvent: 'graphql.query',
+};
+const appEvents = {
+    appEventFilter: 'appevent.filter',
+    appEventHandler: 'appevent.handler',
+    appEventTransformation: 'appevent.transformation',
+};
 const throwValidationException = (subject, message, details) => {
     console.log(`${chalk_1.default.red('Validation Error:')} Missing or invalid ${subject}.`);
     message && console.log(message);
@@ -87,15 +96,12 @@ function getEntityFromManifest(type) {
             return;
         }
         logProgress(`${type === 'actions' ? 'App Actions' : 'functions'} found in ${chalk_1.default.bold(DEFAULT_MANIFEST_PATH)}.`);
-        const fieldMappingEvent = "graphql.field.mapping";
-        const queryEvent = "graphql.query";
-        const appEventFilter = 'appevent.filter';
         const items = manifest[type].map((item) => {
             const allowNetworks = Array.isArray(item.allowNetworks)
                 ? item.allowNetworks.map(exports.stripProtocol)
                 : [];
             const accepts = 'accepts' in item && Array.isArray(item.accepts) ? item.accepts : undefined;
-            const hasInvalidEvent = accepts?.some((event) => ![fieldMappingEvent, queryEvent, appEventFilter].includes(event));
+            const hasInvalidEvent = accepts?.some((event) => ![...Object.values(graphQLEvents), ...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.17.0",
+  "version": "1.19.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.0.0",
-    "contentful-management": "11.23.0",
+    "contentful-management": "11.24.5",
     "dotenv": "16.4.5",
     "ignore": "5.3.1",
     "inquirer": "8.2.6",
@@ -60,9 +60,9 @@
     "open": "8.4.2",
     "ora": "5.4.1"
   },
-  "gitHead": "7576b84daf5069f42177cd8d43117f5f3c7056be",
+  "gitHead": "42e054adc754dae0657882b09f1ab7adcc9adecf",
   "devDependencies": {
-    "@tsconfig/node18": "18.2.2",
+    "@tsconfig/node18": "18.2.4",
     "@types/adm-zip": "0.5.5",
     "@types/analytics-node": "3.1.14",
     "@types/inquirer": "8.2.1",