@appsemble/cli 0.40.8 → 0.40.10

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.40.8/config/assets/logo.svg) Appsemble CLI
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.40.10/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.40.8/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.40.8)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.40.10/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.40.10)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -271,5 +271,5 @@ appsemble run-cronjobs --interval 30
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.40.8/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.40.10/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/commands/app/update.js

@@ -60,7 +60,7 @@ export function builder(yargs) {
         type: 'boolean',
     })
         .option('assets', {
-        describe: 'Whether the assets from the `assets` directory should replace the seed assets of the app being updated.',
+        describe: 'Whether the assets of the app being updated should be synced with the `assets` directory. Unchanged assets are kept.',
         type: 'boolean',
         default: false,
     })

package/lib/app.d.ts

@@ -38,7 +38,16 @@ interface DeleteAppArgs {
 export declare function deleteApp({ clientCredentials, id, remote }: DeleteAppArgs): Promise<void>;
 export declare function publishSeedResources(path: string, app: App, remote: string): Promise<void>;
 export declare function publishSeedAppMembers(path: string, app: App, remote: string): Promise<void>;
-export declare function publishSeedAssets(path: string, app: App, remote: string, assetsClonable: boolean): Promise<void>;
+/**
+ * Read the seed asset files of an app.
+ *
+ * @param assetsPath The path to the assets directory.
+ * @returns The absolute file paths by the normalized name of the asset, or null if the directory
+ *   doesn't exist.
+ * @throws AppsembleError if a file normalizes to an empty name, or two files to the same name.
+ */
+export declare function getSeedAssetFiles(assetsPath: string): Promise<Map<string, string> | null>;
+export declare function publishSeedAssets(path: string, files: Map<string, string> | null, app: App, remote: string, assetsClonable: boolean): Promise<void>;
 export declare function publishAppConfig(path: string, app: App, remote: string): Promise<void>;
 /**
  * @param path The path to the app directory.

package/lib/app.js

@@ -2,8 +2,8 @@ import { createReadStream, createWriteStream, existsSync } from 'node:fs';
 import { mkdir, readdir, readFile, rm, stat } from 'node:fs/promises';
 import { basename, dirname, join, parse, relative, resolve } from 'node:path';
 import { inspect } from 'node:util';
-import { normalizeBlockName } from '@appsemble/lang-sdk';
-import { applyAppVariant, AppsembleError, authenticate, logger, opendirSafe, preProcessCSV, readData, writeData, } from '@appsemble/node-utils';
+import { normalize, normalizeBlockName, } from '@appsemble/lang-sdk';
+import { applyAppVariant, AppsembleError, authenticate, hashFile, logger, opendirSafe, preProcessCSV, readData, writeData, } from '@appsemble/node-utils';
 import { APP_VALIDATION_FAILED, } from '@appsemble/types';
 import { extractAppMessages, has, normalizeLocale } from '@appsemble/utils';
 import axios from 'axios';
@@ -363,40 +363,89 @@ export async function publishSeedAppMembers(path, app, remote) {
         logger.warn(`Missing members directory in ${path}. Skipping...`);
     }
 }
-export async function publishSeedAssets(path, app, remote, assetsClonable) {
+/**
+ * Read the seed asset files of an app.
+ *
+ * @param assetsPath The path to the assets directory.
+ * @returns The absolute file paths by the normalized name of the asset, or null if the directory
+ *   doesn't exist.
+ * @throws AppsembleError if a file normalizes to an empty name, or two files to the same name.
+ */
+export async function getSeedAssetFiles(assetsPath) {
+    if (!existsSync(assetsPath)) {
+        return null;
+    }
+    const assetFiles = await readdir(assetsPath);
+    const normalizedPaths = assetFiles.map((assetFile) => normalizePath(join(assetsPath, assetFile)));
+    const files = await fg(normalizedPaths, { absolute: true, onlyFiles: true });
+    const filesByName = new Map();
+    for (const file of files) {
+        const name = normalize(parse(file).name);
+        if (!name) {
+            throw new AppsembleError(`Asset file ${basename(file)} normalizes to an empty name`);
+        }
+        const collision = filesByName.get(name);
+        if (collision) {
+            throw new AppsembleError(`Asset files ${basename(collision)} and ${basename(file)} both normalize to ${name}`);
+        }
+        filesByName.set(name, file);
+    }
+    return filesByName;
+}
+export async function publishSeedAssets(path, files, app, remote, assetsClonable) {
     const assetsPath = join(path, 'assets');
     logger.info(`Publishing seed assets from ${assetsPath}`);
-    if (existsSync(assetsPath)) {
-        logger.info(`Deleting existing seed assets from app ${app.id}`);
-        try {
-            await axios.delete(`/api/apps/${app.id}/assets`, {
-                data: [],
+    if (!files) {
+        logger.warn(`Missing assets directory in ${path}. Skipping...`);
+        return;
+    }
+    const assetsUrl = `/api/apps/${app.id}/assets`;
+    try {
+        let serverAssets = [];
+        if (app.demoMode) {
+            // The asset endpoints only reach the ephemeral copies of a demo app, and the cleanup job
+            // gives those new ids on every run, so their seed assets can't be compared one by one.
+            logger.info(`Deleting existing seed assets from app ${app.id}`);
+            await axios.delete(assetsUrl, { data: [], baseURL: remote, params: { seed: true } });
+        }
+        else {
+            ({ data: serverAssets } = await axios.get(assetsUrl, {
                 baseURL: remote,
-                params: { seed: true },
-            });
-            const assetFiles = await readdir(assetsPath);
-            const normalizedPaths = assetFiles.map((assetFile) => normalizePath(join(assetsPath, assetFile)));
-            const files = await fg(normalizedPaths, { absolute: true, onlyFiles: true });
-            logger.info(`Publishing ${files.length} asset(s)`);
-            for (const assetFilePath of files) {
-                await publishAsset({
-                    name: parse(assetFilePath).name,
-                    // @ts-expect-error 2322 null is not assignable to type (strictNullChecks)
-                    appId: app.id,
-                    path: assetFilePath,
-                    remote,
-                    seed: true,
-                    clonable: assetsClonable,
-                });
+                params: { named: true },
+            }));
+        }
+        const serverAssetsByName = new Map(serverAssets.map((asset) => [asset.name, asset]));
+        for (const [name, file] of files) {
+            const serverAsset = serverAssetsByName.get(name);
+            if (serverAsset) {
+                if (serverAsset.sha256 === (await hashFile(file)) &&
+                    serverAsset.clonable === assetsClonable) {
+                    logger.info(`Keeping unchanged asset ${name}`);
+                    continue;
+                }
+                await axios.delete(assetsUrl, { data: [serverAsset.id], baseURL: remote });
             }
+            await publishAsset({
+                name,
+                // @ts-expect-error 2322 null is not assignable to type (strictNullChecks)
+                appId: app.id,
+                path: file,
+                remote,
+                seed: true,
+                clonable: assetsClonable,
+            });
         }
-        catch (error) {
-            logger.error('Something went wrong when creating assets:');
-            logger.error(error);
+        const removedSeedAssetIds = serverAssets
+            .filter(({ name, seed }) => seed && !files.has(name))
+            .map(({ id }) => id);
+        if (removedSeedAssetIds.length) {
+            logger.info(`Deleting ${removedSeedAssetIds.length} seed asset(s) without a local file`);
+            await axios.delete(assetsUrl, { data: removedSeedAssetIds, baseURL: remote });
         }
     }
-    else {
-        logger.warn(`Missing assets directory in ${path}. Skipping...`);
+    catch (error) {
+        logger.error('Something went wrong when creating assets:');
+        logger.error(error);
     }
 }
 function parseValueFromDefinition(value) {
@@ -899,6 +948,7 @@ export async function publishApp({ clientCredentials, context, dryRun, modifyCon
         logger.info(`Setting TOTP to ${totp}`);
         formData.append('totp', totp);
     }
+    const seedAssetFiles = assets && file.isDirectory() ? await getSeedAssetFiles(join(appVariantPath, 'assets')) : null;
     let authScope = 'apps:write';
     if (resources) {
         authScope += ' resources:write';
@@ -939,7 +989,7 @@ export async function publishApp({ clientCredentials, context, dryRun, modifyCon
         await publishAppConfig(appVariantPath, data, remote);
         // After uploading the app, publish seed resources and assets if they are available
         if (assets) {
-            await publishSeedAssets(appVariantPath, data, remote, assetsClonable);
+            await publishSeedAssets(appVariantPath, seedAssetFiles, data, remote, assetsClonable);
         }
         if (resources) {
             await publishSeedResources(appVariantPath, data, remote);
@@ -1119,6 +1169,7 @@ export async function updateApp({ clientCredentials, context, force, path, ...op
         logger.info(`Setting TOTP to ${totp}`);
         formData.append('totp', totp);
     }
+    const seedAssetFiles = assets && file.isDirectory() ? await getSeedAssetFiles(join(appVariantPath, 'assets')) : null;
     let authScope = 'apps:write';
     if (resources) {
         authScope += ' resources:write';
@@ -1163,7 +1214,7 @@ export async function updateApp({ clientCredentials, context, force, path, ...op
         await publishAppConfig(appVariantPath, data, remote);
         // After updating the app, publish seed resources and assets if they are available
         if (assets && (data.locked !== 'fullLock' || force)) {
-            await publishSeedAssets(appVariantPath, data, remote, assetsClonable);
+            await publishSeedAssets(appVariantPath, seedAssetFiles, data, remote, assetsClonable);
         }
         if (resources && (data.locked !== 'fullLock' || force)) {
             await publishSeedResources(appVariantPath, data, remote);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/cli",
-  "version": "0.40.8",
+  "version": "0.40.10",
   "description": "The CLI for developing with Appsemble apps and blocks",
   "keywords": [
     "app",
@@ -43,10 +43,10 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/node-utils": "0.40.8",
-    "@appsemble/types": "0.40.8",
-    "@appsemble/lang-sdk": "0.40.8",
-    "@appsemble/utils": "0.40.8",
+    "@appsemble/node-utils": "0.40.10",
+    "@appsemble/types": "0.40.10",
+    "@appsemble/lang-sdk": "0.40.10",
+    "@appsemble/utils": "0.40.10",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "@inquirer/prompts": "^8.0.0",
     "axios": "^1.0.0",
@@ -77,8 +77,8 @@
     "yargs": "^17.0.0"
   },
   "devDependencies": {
-    "@appsemble/types": "0.40.8",
-    "@appsemble/server": "0.40.8",
+    "@appsemble/types": "0.40.10",
+    "@appsemble/server": "0.40.10",
     "@types/concat-stream": "2.0.3",
     "@types/normalize-path": "3.0.2",
     "@types/postcss-import": "14.0.3",

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

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

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

@@ -5,7 +5,7 @@
     "*.css"
   ],
   "dependencies": {
-    "@appsemble/sdk": "0.40.8",
+    "@appsemble/sdk": "0.40.10",
     "mini-jsx": "^4.0.0"
   }
 }

package/templates/blocks/preact/package.json

@@ -5,8 +5,8 @@
     "*.css"
   ],
   "dependencies": {
-    "@appsemble/preact": "0.40.8",
-    "@appsemble/sdk": "0.40.8",
+    "@appsemble/preact": "0.40.10",
+    "@appsemble/sdk": "0.40.10",
     "preact": "^10.0.0"
   }
 }

package/templates/blocks/vanilla/package.json

@@ -5,6 +5,6 @@
     "*.css"
   ],
   "dependencies": {
-    "@appsemble/sdk": "0.40.8"
+    "@appsemble/sdk": "0.40.10"
   }
 }