@appsemble/cli 0.23.3 → 0.23.4

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.23.3/config/assets/logo.svg) Appsemble CLI
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.23.4/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.23.3/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.23.3)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.23.4/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.23.4)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -144,8 +144,8 @@ arguments.
 appsemble app create
 ```
 
-The Appsemble CLI can be used to create, update and delete apps. For example, to create an app in
-the `apps/my-app` directory, run:
+The Appsemble CLI can be used to create, export, import and update apps. For example, to create an
+app in the `apps/my-app` directory, run:
 
 ```sh
 appsemble app publish apps/my-app
@@ -163,6 +163,22 @@ To delete an app using the CLI use the following command:
 appsemble app delete --id <appId>
 ```
 
+To export an app as a zip file, run the following:
+
+```sh
+appsemble app export --id <app-id>
+```
+
+Supported arguments for this app are `resources` and `path`. Resources is used to specify whether to
+include the resources in the exported file and path is the path of the folder where you want to put
+your downloaded file. Path is `./apps` by default and resources is set to `false`.
+
+To import an app from a zip file, use the following command:
+
+```sh
+appsemble app import <path-of-zip-file> --organization <organizationId>
+```
+
 For a more in depth explanation of how to build apps, use our
 [app building guide](https://appsemble.app/docs/guide).
 
@@ -288,5 +304,5 @@ appsemble run-cronjobs --interval 30
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.23.3/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.23.4/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/commands/app/export.d.ts

@@ -0,0 +1,12 @@
+import { type Argv } from 'yargs';
+import { type BaseArguments } from '../../types.js';
+interface ExportAppArgs extends BaseArguments {
+    id: number;
+    resources: boolean;
+    path?: string;
+}
+export declare const command = "export";
+export declare const description = "Export an app as a zip file using app id.\n  App definition, styles and messages are exported by default, to export resources, make sure you have suitable permissions and use the '--resources' flag.";
+export declare function builder(yargs: Argv): Argv<any>;
+export declare function handler(args: ExportAppArgs): Promise<void>;
+export {};

package/commands/app/export.js

@@ -0,0 +1,29 @@
+import { join } from 'node:path';
+import { authenticate, logger } from '@appsemble/node-utils';
+import { exportAppAsZip } from '../../lib/app.js';
+export const command = 'export';
+export const description = `Export an app as a zip file using app id.
+  App definition, styles and messages are exported by default, to export resources, make sure you have suitable permissions and use the '--resources' flag.`;
+export function builder(yargs) {
+    return yargs
+        .option('id', {
+        describe: 'Id of the app to be exported as a zip file',
+        demandOption: true,
+    })
+        .option('resources', {
+        describe: 'Boolean representing whether the resources should be exported or not',
+        default: false,
+    })
+        .option('path', {
+        describe: 'Path of the folder where you want to put your exported file.',
+    });
+}
+export async function handler(args) {
+    const { clientCredentials, id: appId, path: outputDirectory, remote, resources } = args;
+    const defaultOutputDirectory = join(process.cwd(), 'apps');
+    await authenticate(remote, 'apps:export', clientCredentials);
+    logger.info(`Exporting app with id: ${appId}`);
+    await exportAppAsZip(appId, resources, outputDirectory || defaultOutputDirectory, remote);
+    logger.info('Export completed successfully');
+}
+//# sourceMappingURL=export.js.map

package/commands/app/import.d.ts

@@ -0,0 +1,11 @@
+import { type Argv } from 'yargs';
+import { type BaseArguments } from '../../types.js';
+interface ImportAppArgs extends BaseArguments {
+    organization: string;
+    path: string;
+}
+export declare const command = "import <path>";
+export declare const description = "Import an app from a zip file using organization id. App definition, styles, resources and messages can be imported from the zip file.";
+export declare function builder(yargs: Argv): Argv<any>;
+export declare function handler(args: ImportAppArgs): Promise<void>;
+export {};

package/commands/app/import.js

@@ -0,0 +1,36 @@
+import { readFile } from 'node:fs/promises';
+import { authenticate, logger } from '@appsemble/node-utils';
+import axios from 'axios';
+export const command = 'import <path>';
+export const description = 'Import an app from a zip file using organization id. App definition, styles, resources and messages can be imported from the zip file.';
+export function builder(yargs) {
+    return yargs
+        .positional('path', {
+        describe: 'Path of the zip file you want to import.',
+        required: true,
+    })
+        .option('organization', {
+        describe: 'Id of the organization to which app will be imported.',
+        demandOption: true,
+    });
+}
+export async function handler(args) {
+    const { clientCredentials, organization, path: inputFile, remote } = args;
+    const [, extName] = inputFile.split('.');
+    if (extName !== 'zip') {
+        logger.error('Input file must be a zip file.');
+        return;
+    }
+    await authenticate(remote, 'apps:write', clientCredentials);
+    logger.info(`Importing app to organization: ${organization}`);
+    const zipFile = await readFile(inputFile);
+    const config = {
+        base: remote,
+        headers: {
+            'Content-Type': 'application/zip',
+        },
+    };
+    await axios.post(`/api/apps/import/organization/${organization}`, zipFile, config);
+    logger.info('Importing app completed successfully');
+}
+//# sourceMappingURL=import.js.map

package/commands/app/index.js

@@ -1,6 +1,8 @@
 import * as create from './create.js';
 import * as remove from './delete.js';
+import * as exportApp from './export.js';
 import * as extractMessages from './extract-messages.js';
+import * as importApp from './import.js';
 import * as publish from './publish.js';
 import * as update from './update.js';
 export { noop as handler } from '@appsemble/utils';
@@ -11,7 +13,9 @@ export function builder(yargs) {
         .command(publish)
         .command(create)
         .command(remove)
+        .command(exportApp)
         .command(extractMessages)
+        .command(importApp)
         .command(update)
         .demandCommand(1);
 }

package/commands/config/get.js

@@ -1,5 +1,5 @@
 import { has } from '@appsemble/utils';
-import { readPackageUp } from 'read-pkg-up';
+import { readPackageUp } from 'read-package-up';
 export const command = 'get <key>';
 export const description = 'Get an Appsemble configuration option from package.json.';
 export function builder(yargs) {

package/commands/config/set.js

@@ -1,7 +1,7 @@
 import { inspect } from 'node:util';
 import { logger, writeData } from '@appsemble/node-utils';
 import { has } from '@appsemble/utils';
-import { readPackageUp } from 'read-pkg-up';
+import { readPackageUp } from 'read-package-up';
 export const command = 'set <key> <value>';
 export const description = 'Set an Appsemble configuration option in package.json.';
 export function builder(yargs) {

package/lib/app.d.ts

@@ -145,6 +145,15 @@ interface UpdateAppParams {
  * @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 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, resources: boolean, path: string, remote: string): Promise<void>;
 /**
  * Upload messages for an app.
  *

package/lib/app.js

@@ -1,4 +1,4 @@
-import { createReadStream, existsSync } from 'node:fs';
+import { createReadStream, createWriteStream, existsSync } from 'node:fs';
 import { mkdir, readdir, readFile, stat } from 'node:fs/promises';
 import { basename, join, parse, relative, resolve } from 'node:path';
 import { inspect } from 'node:util';
@@ -105,6 +105,26 @@ export async function traverseAppDirectory(path, context, formData) {
         : maskableIconPath;
     return [discoveredContext, rc, yaml, gatheredData];
 }
+/**
+ * Export an app as a zip file.
+ *
+ * @param appId Id of the app to be exported.
+ * @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 async function exportAppAsZip(appId, resources, path, remote) {
+    const app = await axios.get(`/api/apps/${appId}`);
+    const { name } = app.data.definition;
+    const response = await axios.get(`/api/apps/${appId}/export?resources=${resources}`, {
+        baseURL: remote,
+        responseType: 'stream',
+    });
+    const zipFileName = join(path, `${name}_${appId}.zip`);
+    const writeStream = createWriteStream(zipFileName);
+    response.data.pipe(writeStream);
+    logger.info(`Successfully downloaded file: ${zipFileName}`);
+}
 /**
  * Upload messages for an app.
  *

package/lib/authentication.js

@@ -31,7 +31,7 @@ function waitForCredentials(url) {
             catch {
                 throwKoaError(ctx, 400, 'Invalid JSON');
             }
-            assertKoaError(typeof credentials === 'string' && validate(credentials), ctx, 400, 'Invalid client credentials');
+            assertKoaError(typeof credentials === 'string' && !validate(credentials), ctx, 400, 'Invalid client credentials');
             ctx.status = 204;
             server.close();
             resolve(credentials);

package/lib/block.d.ts

@@ -25,7 +25,7 @@ export declare function getBlockConfig(dir: string): Promise<BlockConfig>;
 /**
  * Discover Appsemble blocks based on workspaces in a monorepo.
  *
- * Both Lerna and Yarn workspaces are supported.
+ * npm workspaces are supported.
  *
  * @param root The project root in which to find workspaces.
  * @returns Discovered Appsemble blocks.

package/lib/block.js

@@ -78,7 +78,7 @@ export async function getBlockConfig(dir) {
 /**
  * Discover Appsemble blocks based on workspaces in a monorepo.
  *
- * Both Lerna and Yarn workspaces are supported.
+ * npm workspaces are supported.
  *
  * @param root The project root in which to find workspaces.
  * @returns Discovered Appsemble blocks.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/cli",
-  "version": "0.23.3",
+  "version": "0.23.4",
   "description": "The CLI for developing with Appsemble apps and blocks",
   "keywords": [
     "app",
@@ -42,9 +42,9 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/node-utils": "0.23.3",
-    "@appsemble/types": "0.23.3",
-    "@appsemble/utils": "0.23.3",
+    "@appsemble/node-utils": "0.23.4",
+    "@appsemble/types": "0.23.4",
+    "@appsemble/utils": "0.23.4",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "@koa/cors": "^4.0.0",
     "@odata/parser": "^0.2.0",
@@ -55,7 +55,7 @@
     "csvtojson": "^2.0.0",
     "fast-glob": "^3.0.0",
     "form-data": "^4.0.0",
-    "global-cache-dir": "^5.0.0",
+    "global-cache-dir": "^6.0.0",
     "inquirer": "^9.0.0",
     "jsonschema": "^1.0.0",
     "koa": "^2.0.0",
@@ -76,7 +76,7 @@
     "postcss-load-config": "^4.0.0",
     "postcss-url": "^10.0.0",
     "raw-body": "^2.0.0",
-    "read-pkg-up": "^10.0.0",
+    "read-package-up": "^11.0.0",
     "sharp": "^0.32.0",
     "ts-json-schema-generator": "^1.0.0",
     "type-fest": "^4.0.0",
@@ -85,7 +85,7 @@
     "yargs": "^17.0.0"
   },
   "devDependencies": {
-    "@appsemble/types": "0.23.3",
+    "@appsemble/types": "0.23.4",
     "@types/concat-stream": "^2.0.0",
     "@types/inquirer": "^9.0.0",
     "@types/normalize-path": "^3.0.0",

package/templates/apps/empty/app-definition.yaml

@@ -6,7 +6,7 @@ pages:
   - name: Example Page A
     blocks:
       - type: action-button
-        version: 0.23.3
+        version: 0.23.4
         parameters:
           icon: arrow-right
         actions:
@@ -17,7 +17,7 @@ pages:
   - name: Example Page B
     blocks:
       - type: action-button
-        version: 0.23.3
+        version: 0.23.4
         parameters:
           icon: arrow-left
         actions:

package/templates/blocks/mini-jsx/package.json

@@ -2,7 +2,7 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "@appsemble/sdk": "0.23.3",
+    "@appsemble/sdk": "0.23.4",
     "mini-jsx": "^4.0.0"
   }
 }

package/templates/blocks/preact/package.json

@@ -2,8 +2,8 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "@appsemble/preact": "0.23.3",
-    "@appsemble/sdk": "0.23.3",
+    "@appsemble/preact": "0.23.4",
+    "@appsemble/sdk": "0.23.4",
     "preact": "^10.0.0"
   }
 }

package/templates/blocks/vanilla/package.json

@@ -2,6 +2,6 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "@appsemble/sdk": "0.23.3"
+    "@appsemble/sdk": "0.23.4"
   }
 }

package/types.d.ts

@@ -1,5 +1,5 @@
 import { type AppVisibility } from '@appsemble/types';
-import { type PackageJson } from 'read-pkg-up';
+import { type PackageJson } from 'read-package-up';
 import { type JsonObject } from 'type-fest';
 /**
  * The base arguments from the command line.