@appsemble/cli 0.25.1 → 0.26.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.25.1/config/assets/logo.svg) Appsemble CLI
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.26.0/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.25.1/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.25.1)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.26.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.26.0)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -169,9 +169,10 @@ To export an app as a zip file, run the following:
 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`.
+Supported arguments for this app are `resources`, `assets` and `path`. Resources is used to specify
+whether to include the resources in the exported file, the same can be applied to assets and path is
+the path of the folder where you want to put your downloaded file. The default path is `./apps`, and
+resources and assets are by default `false`.
 
 To import an app from a zip file, use the following command:
 
@@ -304,5 +305,5 @@ appsemble run-cronjobs --interval 30
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.25.1/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.26.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/commands/app/create.js

@@ -136,6 +136,7 @@ export async function handler(args) {
                 roles: ['$public'],
                 schema: {
                     type: 'object',
+                    properties: {},
                     additionalProperties: false,
                 },
             },

package/commands/app/export.d.ts

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

package/commands/app/export.js

@@ -3,7 +3,8 @@ 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.`;
+  App definition, styles, icon and messages are exported by default, to export resources, make sure you have suitable permissions and use the '--resources' flag.
+  Similarly for assets use the --assets flag to include assets in the export.`;
 export function builder(yargs) {
     return yargs
         .option('id', {
@@ -12,18 +13,20 @@ export function builder(yargs) {
     })
         .option('resources', {
         describe: 'Boolean representing whether the resources should be exported or not',
-        default: false,
+    })
+        .option('assets', {
+        describe: 'Boolean representing whether assets should be exported.',
     })
         .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 { assets = false, clientCredentials, id: appId, path: outputDirectory, remote, resources = false, } = 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);
+    await exportAppAsZip(appId, assets, resources, outputDirectory || defaultOutputDirectory, remote);
     logger.info('Export completed successfully');
 }
 //# sourceMappingURL=export.js.map

package/commands/serve.js

@@ -120,7 +120,7 @@ export async function handler(argv) {
         };
     }));
     const localBlocksPromises = localBlocksConfigs.map(async (blockConfig) => {
-        await buildBlock(blockConfig);
+        await buildBlock(blockConfig, 'development');
         const [, blockImplementations] = await makeProjectPayload(blockConfig);
         return {
             ...blockImplementations,

package/lib/app.d.ts

@@ -165,11 +165,12 @@ export declare function traverseAppDirectory(path: string, context: string, form
  * 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, resources: boolean, path: string, remote: string): Promise<void>;
+export declare function exportAppAsZip(appId: number, assets: boolean, resources: boolean, path: string, remote: string): Promise<void>;
 /**
  * Upload messages for an app.
  *

package/lib/app.js

@@ -131,14 +131,15 @@ export async function traverseAppDirectory(path, context, formData) {
  * 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 async function exportAppAsZip(appId, resources, path, remote) {
+export async function exportAppAsZip(appId, assets, 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}`, {
+    const response = await axios.get(`/api/apps/${appId}/export?resources=${resources}&assets=${assets}`, {
         baseURL: remote,
         responseType: 'stream',
     });

package/lib/block.d.ts

@@ -12,7 +12,7 @@ import { type Stats } from 'webpack';
  * @param buildConfig The config of the block to build.
  * @returns The Webpack stats object.
  */
-export declare function buildBlock(buildConfig: ProjectBuildConfig): Promise<Stats>;
+export declare function buildBlock(buildConfig: ProjectBuildConfig, env?: 'development' | 'production'): Promise<Stats>;
 interface DeleteBlockVersionParams {
     organization: string;
     blockName: string;

package/lib/block.js

@@ -19,8 +19,8 @@ import { processCss } from './processCss.js';
  * @param buildConfig The config of the block to build.
  * @returns The Webpack stats object.
  */
-export async function buildBlock(buildConfig) {
-    const conf = await getProjectWebpackConfig(buildConfig, 'production', join(buildConfig.dir, buildConfig.output));
+export async function buildBlock(buildConfig, env) {
+    const conf = await getProjectWebpackConfig(buildConfig, env || 'production', join(buildConfig.dir, buildConfig.output));
     if (existsSync(conf.output.path)) {
         logger.warn(`Removing ${conf.output.path}`);
         await rm(conf.output.path, { force: true, recursive: true });
@@ -28,7 +28,7 @@ export async function buildBlock(buildConfig) {
     logger.info(`Building ${buildConfig.name}@${buildConfig.version} 🔨`);
     const compiler = webpack(conf);
     return new Promise((resolve, reject) => {
-        compiler.run((err, stats) => {
+        const callback = (err, stats) => {
             if (err) {
                 reject(err);
             }
@@ -39,7 +39,13 @@ export async function buildBlock(buildConfig) {
                 logger.verbose(stats.toString({ colors: true }));
                 resolve(stats);
             }
-        });
+        };
+        if (env === 'development') {
+            compiler.watch({ ignored: /node_modules/ }, callback);
+        }
+        else {
+            compiler.run(callback);
+        }
     });
 }
 export async function deleteBlock({ blockName, blockVersion, organization, remote, }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/cli",
-  "version": "0.25.1",
+  "version": "0.26.0",
   "description": "The CLI for developing with Appsemble apps and blocks",
   "keywords": [
     "app",
@@ -42,9 +42,9 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/node-utils": "0.25.1",
-    "@appsemble/types": "0.25.1",
-    "@appsemble/utils": "0.25.1",
+    "@appsemble/node-utils": "0.26.0",
+    "@appsemble/types": "0.26.0",
+    "@appsemble/utils": "0.26.0",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "@koa/cors": "^4.0.0",
     "@odata/parser": "^0.2.0",
@@ -87,7 +87,7 @@
     "yargs": "^17.0.0"
   },
   "devDependencies": {
-    "@appsemble/types": "0.25.1",
+    "@appsemble/types": "0.26.0",
     "@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.25.1
+        version: 0.26.0
         parameters:
           icon: arrow-right
         actions:
@@ -17,7 +17,7 @@ pages:
   - name: Example Page B
     blocks:
       - type: action-button
-        version: 0.25.1
+        version: 0.26.0
         parameters:
           icon: arrow-left
         actions:

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

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

package/templates/blocks/preact/package.json

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

package/templates/blocks/vanilla/package.json

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