@contentful/app-scripts 2.4.0-alpha.0 → 2.5.0

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/generate-function/clone.d.ts

@@ -1,9 +1,9 @@
-import { GenerateFunctionSettings } from '../types';
-export declare function cloneFunction(localPath: string, settings: GenerateFunctionSettings): Promise<void>;
-export declare function getCloneURL(settings: GenerateFunctionSettings): string;
-export declare function touchupAppManifest(localPath: string, settings: GenerateFunctionSettings, renameFunctionFile: string): Promise<void>;
+import { GenerateFunctionSettingsInput } from '../types';
+export declare function cloneFunction(localPath: string, settings: GenerateFunctionSettingsInput): Promise<void>;
+export declare function getCloneURL(settings: GenerateFunctionSettingsInput): string;
+export declare function touchupAppManifest(localPath: string, settings: GenerateFunctionSettingsInput, renameFunctionFile: string): Promise<void>;
 export declare function moveFilesToFinalDirectory(localTmpPath: string, localFunctionsPath: string, localPath: string): void;
-export declare function renameClonedFiles(localTmpPath: string, settings: GenerateFunctionSettings): string;
+export declare function renameClonedFiles(localTmpPath: string, settings: GenerateFunctionSettingsInput): string;
 export declare function resolvePaths(localPath: string): {
     localTmpPath: string;
     localFunctionsPath: string;

package/lib/generate-function/clone.js

@@ -32,7 +32,7 @@ async function cloneFunction(localPath, settings) {
         const { localTmpPath, localFunctionsPath } = resolvePaths(localPath);
         const cloneURL = getCloneURL(settings);
         // Pass keepPackageJson if available in settings (from GenerateFunctionSettingsCLI)
-        const keepPackageJson = 'keepPackageJson' in settings ? settings.keepPackageJson : undefined;
+        const keepPackageJson = 'keepPackageJson' in settings && typeof settings.keepPackageJson === 'boolean' ? settings.keepPackageJson : false;
         await cloneAndResolveManifests(cloneURL, localTmpPath, localPath, localFunctionsPath, keepPackageJson);
         // now rename the function file. Find the file with a .ts or .js extension
         const renameFunctionFile = renameClonedFiles(localTmpPath, settings);
@@ -96,19 +96,18 @@ function resolvePaths(localPath) {
     const localFunctionsPath = (0, node_path_1.resolve)(localPath, 'functions');
     return { localTmpPath, localFunctionsPath };
 }
-async function cloneAndResolveManifests(cloneURL, localTmpPath, localPath, localFunctionsPath, keepPackageJson) {
+async function cloneAndResolveManifests(cloneURL, localTmpPath, localPath, localFunctionsPath, keepPackageJson = false) {
     const tigedInstance = await clone(cloneURL, localTmpPath);
     // merge the manifest from the template folder to the root folder
     await mergeAppManifest(localPath, localTmpPath);
-    // modify package.json build commands
+    // create a deep copy of the IGNORED_CLONED_FILES array
+    const ignoredFiles = Array.from(constants_1.IGNORED_CLONED_FILES);
     if (!keepPackageJson) {
+        // modify package.json build commands
         await updatePackageJsonWithBuild(localPath, localTmpPath);
-    }
-    // check if a tsconfig.json file exists already
-    const ignoredFiles = [...constants_1.IGNORED_CLONED_FILES];
-    if (!keepPackageJson) {
         ignoredFiles.push('package.json');
     }
+    // check if a tsconfig.json file exists already
     const tsconfigExists = await (0, file_1.exists)((0, node_path_1.resolve)(localFunctionsPath, 'tsconfig.json'));
     if (tsconfigExists) {
         ignoredFiles.push('tsconfig.json');

package/lib/types.d.ts

@@ -81,6 +81,7 @@ export interface GenerateFunctionSettings {
 export interface GenerateFunctionSettingsCLI extends GenerateFunctionSettings {
     keepPackageJson?: boolean;
 }
+export type GenerateFunctionSettingsInput = GenerateFunctionSettings | GenerateFunctionSettingsCLI;
 export interface AddLocationsOptions {
     organizationId?: string;
     definitionId?: 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "2.4.0-alpha.0",
+  "version": "2.5.0",
   "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": "1e2d5087dcc911e7590aab94e643eb1cea088cef",
+  "gitHead": "f60bbb2e3b86350ae3ae6125f1cf4a5c1ccf85e6",
   "devDependencies": {
     "@types/adm-zip": "0.5.7",
     "@types/analytics-node": "3.1.14",