@appsemble/cli 0.27.9 → 0.27.11

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.9/config/assets/logo.svg) Appsemble CLI
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.11/config/assets/logo.svg) Appsemble CLI
 
 > Manage apps and blocks from the command line.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/cli)](https://www.npmjs.com/package/@appsemble/cli)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.9/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.9)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.11/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.11)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -323,5 +323,5 @@ appsemble run-cronjobs --interval 30
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.9/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.11/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/__fixtures__/apps/test/README.md

@@ -0,0 +1 @@
+Test App

package/commands/app/patch.js

@@ -1,6 +1,5 @@
 import { authenticate, logger } from '@appsemble/node-utils';
-import axios from 'axios';
-import FormData from 'form-data';
+import { patchApp } from '../../lib/app.js';
 export const command = 'patch';
 export const description = 'Change the settings of an app without having the entire source.';
 export function builder(yargs) {
@@ -55,61 +54,11 @@ export function builder(yargs) {
 }
 export async function handler({ clientCredentials, id, remote, ...args }) {
     await authenticate(remote, 'apps:write', clientCredentials);
-    const formData = new FormData();
-    if (args.path) {
-        logger.info(`Setting app path to ${args.path}`);
-        formData.append('path', args.path);
-    }
-    if (args.force) {
-        formData.append('force', String(args.force));
-    }
-    if (args.demoMode) {
-        logger.info(`Setting app demo mode to ${args.demoMode}`);
-        formData.append('demoMode', String(args.demoMode));
-    }
-    if (args.template) {
-        logger.info(`Setting template to ${args.template}`);
-        formData.append('template', String(args.template));
-    }
-    if (args.visibility) {
-        logger.info(`Setting app visibility to ${args.visibility}`);
-        formData.append('visibility', args.visibility);
-    }
-    if (args.iconBackground) {
-        logger.info(`Setting app icon background to ${args.iconBackground}`);
-        formData.append('iconBackground', args.iconBackground);
-    }
-    if (args.showAppDefinition) {
-        logger.info(`Setting showAppDefinition to ${args.showAppDefinition}`);
-        formData.append('showAppDefinition', String(args.showAppDefinition));
-    }
-    if (args.showAppsembleLogin) {
-        logger.info(`Setting showAppsembleLogin to ${args.showAppsembleLogin}`);
-        formData.append('showAppsembleLogin', String(args.showAppsembleLogin));
-    }
-    if (args.showAppsembleOAuth2Login) {
-        logger.info(`Setting showAppsembleOAuth2Login to ${args.showAppsembleOAuth2Login}`);
-        formData.append('showAppsembleOAuth2Login', String(args.showAppsembleOAuth2Login));
-    }
-    if (args.enableSelfRegistration) {
-        logger.info(`Setting enableSelfRegistration to ${args.enableSelfRegistration}`);
-        formData.append('enableSelfRegistration', String(args.enableSelfRegistration));
-    }
-    try {
-        if (args.locked) {
-            await axios.post(`api/apps/${id}/lock`, {
-                locked: args.locked,
-            });
-            logger.info(`Successfully set app lock value for app with id ${id} to ${args.locked}`);
-            if (!formData.getLengthSync()) {
-                return;
-            }
-        }
-        await axios.patch(`/api/apps/${id}`, formData);
-        logger.info(`Successfully updated app with id ${id}`);
-    }
-    catch (error) {
-        logger.error(error);
-    }
+    logger.info(`Patching app ${id}`);
+    await patchApp({
+        ...args,
+        id,
+        remote,
+    });
 }
 //# sourceMappingURL=patch.js.map

package/commands/serve.js

@@ -56,7 +56,7 @@ export function builder(yargs) {
 export async function handler(argv) {
     setArgv(argv);
     const appPath = join(process.cwd(), argv.path);
-    const [, , appsembleApp] = await traverseAppDirectory(appPath, new FormData());
+    const [, , , appsembleApp] = await traverseAppDirectory(appPath, 'development', new FormData());
     const appRoles = appsembleApp.definition.roles;
     const passedUserRole = argv['user-role'];
     if (passedUserRole && !(appRoles === null || appRoles === void 0 ? void 0 : appRoles.includes(passedUserRole))) {

package/lib/app.d.ts

@@ -1,8 +1,56 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 import { type ReadStream } from 'node:fs';
-import { type App, type AppsembleRC, type AppVisibility } from '@appsemble/types';
+import { type App, type AppLock, type AppsembleContext, type AppsembleRC, type AppVisibility } from '@appsemble/types';
 import FormData from 'form-data';
+/**
+ * Traverses an app directory and appends the files it finds to the given FormData object.
+ *
+ * @param path The path of the app directory to traverse.
+ * @param context The Context to use from `.appsemblerc.yaml`.
+ * @param formData The FormData object to append the results into..
+ * @returns The context from `.appsemblerc.yaml` if a match was found.
+ */
+export declare function traverseAppDirectory(path: string, context: string, formData: FormData): Promise<[AppsembleContext, AppsembleRC, string, App]>;
+/**
+ * Export an app as a zip file.
+ *
+ * @param appId Id of the app to be exported.
+ * @param assets Boolean representing whether to include assets in the exported zip file.
+ * @param resources Boolean representing whether to include resources in the zip file.
+ * @param path Path of the folder where you want to put your downloaded file.
+ * @param remote The remote to fetch the app from.
+ */
+export declare function exportAppAsZip(appId: number, assets: boolean, resources: boolean, path: string, remote: string): Promise<void>;
+/**
+ * Upload messages for an app.
+ *
+ * @param path The path to the app directory.
+ * @param appId The app id to upload the messages for.
+ * @param remote The remote to upload the messages to.
+ * @param force Whether or not to force the update for locked apps.
+ */
+export declare function uploadMessages(path: string, appId: number, remote: string, force: boolean): Promise<void>;
+export declare function publishSeedResources(path: string, app: App, remote: string): Promise<void>;
+export declare function publishSeedAssets(path: string, app: App, remote: string, assetsClonable: boolean): Promise<void>;
+/**
+ * @param path The path to the app directory.
+ * @param languages A list of languages for which translations should be added in addition to the
+ *   existing ones.
+ * @param verify A list of languages to verify.
+ * @param format The file format that should be used for the output.
+ */
+export declare function writeAppMessages(path: string, languages: string[], verify: string[], format: 'json' | 'yaml'): Promise<void>;
+/**
+ * Resolve the app’s ID and remote based on the app context.
+ *
+ * @param appPath The path to the app.
+ * @param name Which context to use in the AppsembleRC file.
+ * @param defaultRemote The remote to fall back to.
+ * @param defaultAppId The app ID to fall back to.
+ * @returns The resolved app ID and remote.
+ */
+export declare function resolveAppIdAndRemote(appPath: string, name: string, defaultRemote: string, defaultAppId: number): Promise<[number, string]>;
 interface PublishAppParams {
     /**
      * The OAuth2 client credentials to use.
@@ -35,19 +83,15 @@ interface PublishAppParams {
     /**
      * Whether the App should be marked as a template.
      */
-    template: boolean;
+    template?: boolean;
     /**
      * Whether the App should be used in demo mode.
      */
-    demoMode: boolean;
-    /**
-     * Whether the App should seed resources and assets in demo mode.
-     */
-    seed: boolean;
+    demoMode?: boolean;
     /**
      * The icon to upload.
      */
-    icon: NodeJS.ReadStream | ReadStream;
+    icon?: NodeJS.ReadStream | ReadStream;
     /**
      * The background color to use for the icon in opaque contexts.
      */
@@ -55,28 +99,28 @@ interface PublishAppParams {
     /**
      * The maskable icon to upload.
      */
-    maskableIcon: NodeJS.ReadStream | ReadStream;
+    maskableIcon?: NodeJS.ReadStream | ReadStream;
     /**
      * Whether the API should be called with a dry run.
      */
-    dryRun: boolean;
+    dryRun?: boolean;
     /**
      * Whether resources from the `resources` directory should be published after publishing the app.
      */
-    resources: boolean;
+    resources?: boolean;
     /**
      * Whether assets from the `assets` directory should be published after publishing the app.
      */
-    assets: boolean;
+    assets?: boolean;
     /**
      * Whether published assets should be clonable. Ignored if `assets` equals false.
      */
-    assetsClonable: boolean;
+    assetsClonable?: boolean;
     /**
      * If the app context is specified,
      * modify it for the current context to include the id of the published app.
      */
-    modifyContext: boolean;
+    modifyContext?: boolean;
     /**
      * The ID to use for Google Analytics for the app.
      */
@@ -90,6 +134,12 @@ interface PublishAppParams {
      */
     sentryEnvironment?: string;
 }
+/**
+ * Publish a new app.
+ *
+ * @param options The options to use for publishing an app.
+ */
+export declare function publishApp({ clientCredentials, context, dryRun, modifyContext, path, ...options }: PublishAppParams): Promise<void>;
 interface UpdateAppParams {
     /**
      * The OAuth2 client credentials to use.
@@ -122,23 +172,23 @@ interface UpdateAppParams {
     /**
      * Whether the App should be marked as a template.
      */
-    template: boolean;
+    template?: boolean;
     /**
      * Whether the App should be used in demo mode.
      */
-    demoMode: boolean;
+    demoMode?: boolean;
     /**
      * Whether resources from the `resources` directory should be published after publishing the app.
      */
-    resources: boolean;
+    resources?: boolean;
     /**
      * Whether assets from the `assets` directory should be published after publishing the app.
      */
-    assets: boolean;
+    assets?: boolean;
     /**
      * Whether published assets should be clonable. Ignored if `assets` equals false.
      */
-    assetsClonable: boolean;
+    assetsClonable?: boolean;
     /**
      * Whether the locked property should be ignored.
      */
@@ -146,15 +196,15 @@ interface UpdateAppParams {
     /**
      * The icon to upload.
      */
-    icon: NodeJS.ReadStream | ReadStream;
+    icon?: NodeJS.ReadStream | ReadStream;
     /**
      * The background color to use for the icon in opaque contexts.
      */
-    iconBackground: string;
+    iconBackground?: string;
     /**
      * The maskable icon to upload.
      */
-    maskableIcon: NodeJS.ReadStream | ReadStream;
+    maskableIcon?: NodeJS.ReadStream | ReadStream;
     /**
      * The ID to use for Google Analytics for the app.
      */
@@ -168,63 +218,65 @@ interface UpdateAppParams {
      */
     sentryEnvironment?: string;
 }
-/**
- * Traverses an app directory and appends the files it finds to the given FormData object.
- *
- * @param path The path of the app directory to traverse.
- * @param formData The FormData object to append the results into..
- * @returns The context from `.appsemblerc.yaml` if a match was found.
- */
-export declare function traverseAppDirectory(path: string, formData: FormData): Promise<[AppsembleRC, string, App]>;
-/**
- * Export an app as a zip file.
- *
- * @param appId Id of the app to be exported.
- * @param assets Boolean representing whether to include assets in the exported zip file.
- * @param resources Boolean representing whether to include resources in the zip file.
- * @param path Path of the folder where you want to put your downloaded file.
- * @param remote The remote to fetch the app from.
- */
-export declare function exportAppAsZip(appId: number, assets: boolean, resources: boolean, path: string, remote: string): Promise<void>;
-/**
- * Upload messages for an app.
- *
- * @param path The path to the app directory.
- * @param appId The app id to upload the messages for.
- * @param remote The remote to upload the messages to.
- * @param force Whether or not to force the update for locked apps.
- */
-export declare function uploadMessages(path: string, appId: number, remote: string, force: boolean): Promise<void>;
-export declare function publishSeedResources(path: string, app: App, remote: string): Promise<void>;
-export declare function publishSeedAssets(path: string, app: App, remote: string, assetsClonable: boolean): Promise<void>;
-/**
- * @param path The path to the app directory.
- * @param languages A list of languages for which translations should be added in addition to the
- *   existing ones.
- * @param verify A list of languages to verify.
- * @param format The file format that should be used for the output.
- */
-export declare function writeAppMessages(path: string, languages: string[], verify: string[], format: 'json' | 'yaml'): Promise<void>;
 /**
  * Update an existing app.
  *
  * @param argv The command line options used for updating the app.
  */
 export declare function updateApp({ clientCredentials, context, force, path, ...options }: UpdateAppParams): Promise<void>;
-/**
- * Publish a new app.
- *
- * @param options The options to use for publishing an app.
- */
-export declare function publishApp({ clientCredentials, context, dryRun, modifyContext, path, ...options }: PublishAppParams): Promise<void>;
-/**
- * Resolve the app’s ID and remote based on the app context.
- *
- * @param appPath The path to the app.
- * @param name Which context to use in the AppsembleRC file.
- * @param defaultRemote The remote to fall back to.
- * @param defaultAppId The app ID to fall back to.
- * @returns The resolved app ID and remote.
- */
-export declare function resolveAppIdAndRemote(appPath: string, name: string, defaultRemote: string, defaultAppId: number): Promise<[number, string]>;
+interface PatchAppParams {
+    /**
+     * The path at which the app is hosted.
+     */
+    path?: string;
+    /**
+     * Whether the locked property should be ignored.
+     */
+    force?: boolean;
+    /**
+     * The ID of the app to update.
+     */
+    id?: number;
+    /**
+     * Visibility of the app in the public app store.
+     */
+    visibility?: AppVisibility;
+    /**
+     * The remote server to create the app on.
+     */
+    remote: string;
+    /**
+     * Whether the App should be marked as a template.
+     */
+    template?: boolean;
+    /**
+     * Whether the App should be used in demo mode.
+     */
+    demoMode?: boolean;
+    /**
+     * The background color to use for the icon in opaque contexts.
+     */
+    iconBackground?: string;
+    /**
+     * Whether or not the app definition is exposed for display in Appsemble Studio.
+     */
+    showAppDefinition?: boolean;
+    /**
+     * Whether the Appsemble password login method should be shown.
+     */
+    showAppsembleLogin?: boolean;
+    /**
+     * Whether the Appsemble OAuth2 login method should be shown.
+     */
+    showAppsembleOAuth2Login?: boolean;
+    /**
+     * Whether new users should be able to register themselves.
+     */
+    enableSelfRegistration?: boolean;
+    /**
+     * Whether the app is currently locked.
+     */
+    locked?: AppLock;
+}
+export declare function patchApp({ id, remote, ...options }: PatchAppParams): Promise<void>;
 export {};