@contentful/app-scripts 2.4.0 → 2.5.1

package/README.md

@@ -60,6 +60,40 @@ interface Script<Result, Options> {
 >
 > Both interactive and nonInteractive version of the same script is meant to return the same result.
 
+### Generate Function
+Allows generating a new function template from our [function examples](https://github.com/contentful/apps/tree/master/function-examples). Automatically updates `contentful-app-manifest.json` and merges scripts/dependencies from `package.json` into existing project.
+
+#### Interactive mode:
+
+In the interactive mode, the CLI will ask for all required options.
+
+> **Example**
+>
+> ```shell
+> $ npx --no-install @contentful/app-scripts generate-function
+> ```
+
+#### Non-interactive mode:
+
+When passing the `--ci` argument the command will fail when the required variables are not set as arguments.
+
+> **Example**
+>
+> ```shell
+> $ npx --no-install @contentful/app-scripts generate-function --ci \
+>     --name <name> \
+>     --example <example> \
+>     --language <javascript/typescript> \
+> ```
+
+**Options:**
+
+| Argument            | Description                                                                                                                                | Default value        |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------- |
+| `--name`      | The name of your function.                                                                                      |                      |
+| `--example` | The name of the example as listed in our [function examples](https://github.com/contentful/apps/tree/master/function-examples)                                                                                                            |                      |
+| `--language`   | Choice of javascript or typescript                                                                                          |                      |
+
 ### Create App Definition
 
 Allows creating a new [AppDefinition](https://www.contentful.com/developers/docs/extensibility/app-framework/app-definition/)

package/lib/activate/activate-bundle.d.ts

@@ -1,2 +1,2 @@
 import { ActivateSettings } from '../types';
-export declare function activateBundle({ accessToken, organization, definition, bundleId, host, }: ActivateSettings): Promise<void>;
+export declare function activateBundle({ accessToken, organization, definition, bundleId, host, hasFrontend, }: ActivateSettings): Promise<void>;

package/lib/activate/activate-bundle.js

@@ -8,10 +8,11 @@ const ora_1 = __importDefault(require("ora"));
 const chalk_1 = require("chalk");
 const utils_1 = require("../utils");
 const contentful_management_1 = require("contentful-management");
-async function activateBundle({ accessToken, organization, definition, bundleId, host, }) {
+async function activateBundle({ accessToken, organization, definition, bundleId, host, hasFrontend, }) {
     const activationSpinner = (0, ora_1.default)('Activating your bundle').start();
     const plainClient = (0, contentful_management_1.createClient)({ accessToken, host }, { type: 'plain' });
     const defaultLocations = [{ location: 'dialog' }];
+    let doesBundleHaveFrontend = hasFrontend;
     const currentDefinition = await plainClient.appDefinition.get({
         appDefinitionId: definition.value,
         organizationId: organization.value,
@@ -23,10 +24,29 @@ async function activateBundle({ accessToken, organization, definition, bundleId,
             type: 'Link',
         },
     };
-    if (!currentDefinition.locations?.length) {
+    // if `hasFrontend` is not passed in, fetch the bundle to determine if it has a frontend
+    let bundle;
+    if (doesBundleHaveFrontend === undefined) {
+        bundle = await plainClient.appBundle.get({
+            appBundleId: bundleId,
+            appDefinitionId: definition.value,
+            organizationId: organization.value,
+        });
+        if (bundle.files.length) {
+            doesBundleHaveFrontend = true;
+        }
+        else {
+            doesBundleHaveFrontend = false;
+        }
+    }
+    // if the bundle has frontend code in the bundle, remove the src from the definition since the frontend will now be hosted by Contentful
+    if (doesBundleHaveFrontend) {
+        delete currentDefinition.src;
+    }
+    // if the bundle has frontend code and there are no locations already on the app definition set the default location to dialog
+    if (doesBundleHaveFrontend && !currentDefinition.locations?.length) {
         currentDefinition.locations = defaultLocations;
     }
-    delete currentDefinition.src;
     try {
         await plainClient.appDefinition.update({
             appDefinitionId: definition.value,

package/lib/types.d.ts

@@ -23,6 +23,7 @@ export interface ActivateSettings {
     definition: Definition;
     accessToken: string;
     host?: string;
+    hasFrontend?: boolean;
 }
 export interface CleanupOptions {
     organizationId?: string;

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

@@ -48,9 +48,6 @@ function processCreateAppBundleError(err) {
             if (reasons.includes('Not entitled to App Functions.')) {
                 return 'Your app seems to be using App Functions, which your organization is not entitled to. Remove your app function, or upgrade your account to proceed with your app upload.';
             }
-            else if (reasons.includes('App Functions beta not enabled.')) {
-                return 'Your app seems to be using App Functions, which your organization has not enabled in the Preview Center. In the Contentful web app, go to the Account Menu → Preview Center → App Functions to enable and proceed with your app upload.';
-            }
             else {
                 return reasons;
             }

package/lib/upload/index.js

@@ -16,7 +16,8 @@ async function uploadAndActivate(settings) {
         console.log('Remember that in order to be invoked, your App Event function(s) must be linked to your App Event subscription using the CMA or the Events tab of the App Details page.');
     }
     if (!settings.skipActivation && bundle) {
-        await (0, activate_bundle_1.activateBundle)({ ...settings, bundleId: bundle.sys.id });
+        const hasFrontend = bundle.files.length > 0;
+        await (0, activate_bundle_1.activateBundle)({ ...settings, bundleId: bundle.sys.id, hasFrontend });
         (0, feedback_1.logFeedbackNudge)();
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "2.4.0",
+  "version": "2.5.1",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -67,7 +67,7 @@
     "tiged": "^2.12.7",
     "zod": "^3.24.1"
   },
-  "gitHead": "571371b92e6f7a3542d76192a15f002771708a86",
+  "gitHead": "bebf291cff542d30de78de03eea44f3d5621e3b1",
   "devDependencies": {
     "@types/adm-zip": "0.5.7",
     "@types/analytics-node": "3.1.14",