@appsemble/cli 0.27.9 → 0.27.10

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.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.27.9/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.9)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.10/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.10)
 [![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.10/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

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/lib/app.d.ts

@@ -1,7 +1,7 @@
 /// <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 AppsembleRC, type AppVisibility } from '@appsemble/types';
 import FormData from 'form-data';
 interface PublishAppParams {
     /**
@@ -227,4 +227,59 @@ export declare function publishApp({ clientCredentials, context, dryRun, modifyC
  * @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 {};

package/lib/app.js

@@ -1,5 +1,5 @@
 import { cpSync, createReadStream, createWriteStream, existsSync } from 'node:fs';
-import { mkdir, readdir, readFile, rm, stat } from 'node:fs/promises';
+import { mkdir, readdir, rm, stat } from 'node:fs/promises';
 import { basename, dirname, join, parse, relative, resolve } from 'node:path';
 import { inspect } from 'node:util';
 import { applyAppVariant, AppsembleError, authenticate, logger, opendirSafe, readData, writeData, } from '@appsemble/node-utils';
@@ -44,6 +44,14 @@ export async function traverseAppDirectory(path, formData) {
     };
     logger.info(`Traversing directory for App files in ${path} 🕵`);
     await opendirSafe(path, async (filepath, filestat) => {
+        if (filestat.isFile() && filestat.name.toLowerCase().startsWith('readme')) {
+            logger.info(`Adding ${filepath}`);
+            formData.append('readmes', createReadStream(filepath));
+            if (filestat.name.toLowerCase().startsWith('readme.md')) {
+                gatheredData.readmeUrl = basename(filepath);
+            }
+            return;
+        }
         switch (filestat.name.toLowerCase()) {
             case '.appsemblerc.yaml':
                 logger.info(`Reading app settings from ${filepath}`);
@@ -70,11 +78,6 @@ export async function traverseAppDirectory(path, formData) {
                 return;
             case 'maskable-icon.png':
                 return;
-            case 'readme.md':
-                logger.info(`Including longDescription from ${filepath}`);
-                formData.append('longDescription', await readFile(filepath, 'utf8'));
-                gatheredData.longDescription = await readFile(filepath, 'utf8');
-                return;
             case 'screenshots':
                 return opendirSafe(filepath, (screenshotPath, screenshotStat) => {
                     if (screenshotStat.isDirectory() &&
@@ -124,7 +127,7 @@ export async function traverseAppDirectory(path, formData) {
                 gatheredData.controllerImplementations = controllerImplementations;
                 break;
             default:
-                logger.warn(`Found unused file ${filepath}`);
+                break;
         }
     });
     if (yaml === undefined) {
@@ -722,7 +725,7 @@ export async function publishApp({ clientCredentials, context, dryRun, modifyCon
             }
         }
     }
-    if (appVariantPath !== path) {
+    if (appVariantPath !== path && modifyContext && !dryRun) {
         const [defaultAppRc] = await readData(join(path, '.appsemblerc.yaml'));
         defaultAppRc.context[context] = rc.context[context];
         await writeData(join(path, '.appsemblerc.yaml'), defaultAppRc, { sort: false });
@@ -759,4 +762,68 @@ export async function resolveAppIdAndRemote(appPath, name, defaultRemote, defaul
     }
     return [id, coerceRemote(resolvedRemote)];
 }
+export async function patchApp({ id, remote, ...options }) {
+    const formData = new FormData();
+    if (options.path !== undefined) {
+        logger.info(`Setting app path to ${options.path}`);
+        formData.append('path', options.path);
+    }
+    if (options.force !== undefined) {
+        formData.append('force', String(options.force));
+    }
+    if (options.demoMode !== undefined) {
+        logger.info(`Setting app demo mode to ${options.demoMode}`);
+        formData.append('demoMode', String(options.demoMode));
+    }
+    if (options.template !== undefined) {
+        logger.info(`Setting template to ${options.template}`);
+        formData.append('template', String(options.template));
+    }
+    if (options.visibility !== undefined) {
+        logger.info(`Setting app visibility to ${options.visibility}`);
+        formData.append('visibility', options.visibility);
+    }
+    if (options.iconBackground !== undefined) {
+        logger.info(`Setting app icon background to ${options.iconBackground}`);
+        formData.append('iconBackground', options.iconBackground);
+    }
+    if (options.showAppDefinition !== undefined) {
+        logger.info(`Setting showAppDefinition to ${options.showAppDefinition}`);
+        formData.append('showAppDefinition', String(options.showAppDefinition));
+    }
+    if (options.showAppsembleLogin !== undefined) {
+        logger.info(`Setting showAppsembleLogin to ${options.showAppsembleLogin}`);
+        formData.append('showAppsembleLogin', String(options.showAppsembleLogin));
+    }
+    if (options.showAppsembleOAuth2Login !== undefined) {
+        logger.info(`Setting showAppsembleOAuth2Login to ${options.showAppsembleOAuth2Login}`);
+        formData.append('showAppsembleOAuth2Login', String(options.showAppsembleOAuth2Login));
+    }
+    if (options.enableSelfRegistration !== undefined) {
+        logger.info(`Setting enableSelfRegistration to ${options.enableSelfRegistration}`);
+        formData.append('enableSelfRegistration', String(options.enableSelfRegistration));
+    }
+    try {
+        if (!formData.getLengthSync() && options.locked === undefined) {
+            logger.warn('Nothing to patch. Need at least one additional argument to patch app.');
+            return;
+        }
+        if (formData.getLengthSync()) {
+            const { data } = await axios.patch(`/api/apps/${id}`, formData);
+            logger.info(`Successfully updated app with id ${id}`);
+            const { host, protocol } = new URL(remote);
+            logger.info(`App URL: ${protocol}//${data.path}.${data.OrganizationId}.${host}`);
+        }
+        if (options.locked !== undefined) {
+            await axios.post(`/api/apps/${id}/lock`, {
+                locked: options.locked,
+            });
+            logger.info(`Successfully set app lock value for app with id ${id} to ${options.locked}`);
+        }
+        logger.info(`App store page: ${new URL(`/apps/${id}`, remote)}`);
+    }
+    catch (error) {
+        logger.error(error);
+    }
+}
 //# sourceMappingURL=app.js.map

package/lib/app.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/app.test.js

@@ -0,0 +1,164 @@
+import { authenticate } from '@appsemble/node-utils';
+import { authorizeClientCredentials, createServer, createTestUser, models, setArgv, useTestDatabase, } from '@appsemble/server';
+import { setTestApp } from 'axios-test-instance';
+import { hash } from 'bcrypt';
+import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
+import { patchApp } from './app.js';
+import { initAxios } from './initAxios.js';
+const { App, Organization, OrganizationMember } = models;
+const argv = { host: 'http://localhost', secret: 'test', aesSecret: 'testSecret' };
+let user;
+let organization;
+let testApp;
+async function authorizeCLI(scopes) {
+    const OAuth2AuthorizationCode = await authorizeClientCredentials(scopes);
+    const { id, secret } = OAuth2AuthorizationCode;
+    await OAuth2AuthorizationCode.update({ secret: await hash(secret, 10) });
+    await authenticate(testApp.defaults.baseURL, scopes, `${id}:${secret}`);
+}
+useTestDatabase(import.meta);
+beforeAll(() => {
+    vi.useFakeTimers();
+    setArgv(argv);
+});
+beforeEach(async () => {
+    vi.clearAllTimers();
+    vi.setSystemTime(0);
+    const server = await createServer();
+    testApp = await setTestApp(server);
+    initAxios({ remote: testApp.defaults.baseURL });
+    user = await createTestUser();
+    organization = await Organization.create({
+        id: 'testorganization',
+        name: 'Test Organization',
+    });
+    await OrganizationMember.create({
+        OrganizationId: organization.id,
+        UserId: user.id,
+        role: 'Owner',
+    });
+});
+afterAll(() => {
+    vi.useRealTimers();
+});
+describe('patchApp', () => {
+    it('should apply patches to app', async () => {
+        const patches = {
+            demoMode: true,
+            enableSelfRegistration: true,
+            iconBackground: '#FFFFFF',
+            locked: 'fullLock',
+            path: 'updated-path',
+            showAppDefinition: true,
+            showAppsembleLogin: true,
+            showAppsembleOAuth2Login: true,
+            template: true,
+            visibility: 'private',
+        };
+        const app = await App.create({
+            path: 'test-app',
+            definition: { name: 'Test App', defaultPage: 'Test Page' },
+            vapidPublicKey: 'a',
+            vapidPrivateKey: 'b',
+            visibility: 'public',
+            OrganizationId: organization.id,
+        }, { raw: true });
+        await authorizeCLI('apps:write');
+        await patchApp({
+            ...patches,
+            remote: testApp.defaults.baseURL,
+            id: app.id,
+        });
+        await app.reload();
+        expect(app.dataValues).toStrictEqual(expect.objectContaining({ ...app.dataValues, ...patches }));
+        expect(app.dataValues).toMatchInlineSnapshot(`
+      {
+        "OrganizationId": "testorganization",
+        "controllerCode": null,
+        "controllerImplementations": null,
+        "coreStyle": null,
+        "created": 1970-01-01T00:00:00.000Z,
+        "definition": {
+          "defaultPage": "Test Page",
+          "name": "Test App",
+        },
+        "deleted": null,
+        "demoMode": true,
+        "domain": null,
+        "emailHost": null,
+        "emailName": null,
+        "emailPassword": null,
+        "emailPort": 587,
+        "emailSecure": true,
+        "emailUser": null,
+        "enableSelfRegistration": true,
+        "enableUnsecuredServiceSecrets": false,
+        "googleAnalyticsID": null,
+        "icon": null,
+        "iconBackground": "#FFFFFF",
+        "id": 1,
+        "locked": "fullLock",
+        "maskableIcon": null,
+        "path": "updated-path",
+        "scimEnabled": false,
+        "scimToken": null,
+        "sentryDsn": null,
+        "sentryEnvironment": null,
+        "sharedStyle": null,
+        "showAppDefinition": true,
+        "showAppsembleLogin": true,
+        "showAppsembleOAuth2Login": true,
+        "sslCertificate": null,
+        "sslKey": null,
+        "template": true,
+        "updated": 1970-01-01T00:00:00.000Z,
+        "vapidPrivateKey": "b",
+        "vapidPublicKey": "a",
+        "visibility": "private",
+      }
+    `);
+    });
+    it.each `
+    key                           | from          | to
+    ${'demoMode'}                 | ${false}      | ${true}
+    ${'demoMode'}                 | ${true}       | ${false}
+    ${'enableSelfRegistration'}   | ${false}      | ${true}
+    ${'enableSelfRegistration'}   | ${true}       | ${false}
+    ${'iconBackground'}           | ${''}         | ${'#FFFFFF'}
+    ${'path'}                     | ${'before'}   | ${'after'}
+    ${'locked'}                   | ${'unlocked'} | ${'studioLock'}
+    ${'locked'}                   | ${'unlocked'} | ${'fullLock'}
+    ${'locked'}                   | ${'fullLock'} | ${'unlocked'}
+    ${'showAppDefinition'}        | ${false}      | ${true}
+    ${'showAppDefinition'}        | ${true}       | ${false}
+    ${'showAppsembleLogin'}       | ${false}      | ${true}
+    ${'showAppsembleLogin'}       | ${true}       | ${false}
+    ${'showAppsembleOAuth2Login'} | ${false}      | ${true}
+    ${'showAppsembleOAuth2Login'} | ${true}       | ${false}
+    ${'template'}                 | ${false}      | ${true}
+    ${'template'}                 | ${true}       | ${false}
+    ${'visibility'}               | ${'public'}   | ${'unlisted'}
+    ${'visibility'}               | ${'public'}   | ${'private'}
+    ${'visibility'}               | ${'private'}  | ${'public'}
+  `('should patch $key from `$from` to `$to`', async ({ from, key, to }) => {
+        const app = await App.create({
+            path: 'test-app',
+            definition: { name: 'Test App', defaultPage: 'Test Page' },
+            vapidPublicKey: 'a',
+            vapidPrivateKey: 'b',
+            visibility: 'public',
+            OrganizationId: organization.id,
+            [key]: from,
+        }, { raw: true });
+        await authorizeCLI('apps:write');
+        await patchApp({
+            [key]: to,
+            remote: testApp.defaults.baseURL,
+            id: app.id,
+        });
+        expect(app.dataValues[key]).toStrictEqual(from);
+        await app.reload();
+        expect(app.dataValues[key]).toStrictEqual(to);
+    });
+});
+//# sourceMappingURL=app.test.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/cli",
-  "version": "0.27.9",
+  "version": "0.27.10",
   "description": "The CLI for developing with Appsemble apps and blocks",
   "keywords": [
     "app",
@@ -42,9 +42,9 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/node-utils": "0.27.9",
-    "@appsemble/types": "0.27.9",
-    "@appsemble/utils": "0.27.9",
+    "@appsemble/node-utils": "0.27.10",
+    "@appsemble/types": "0.27.10",
+    "@appsemble/utils": "0.27.10",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "@koa/cors": "^4.0.0",
     "@odata/parser": "^0.2.0",
@@ -87,7 +87,10 @@
     "yargs": "^17.0.0"
   },
   "devDependencies": {
-    "@appsemble/types": "0.27.9",
+    "@appsemble/types": "0.27.10",
+    "@appsemble/server": "0.27.10",
+    "bcrypt": "^5.0.0",
+    "axios-test-instance": "^7.0.0",
     "@types/concat-stream": "^2.0.0",
     "@types/inquirer": "^9.0.0",
     "@types/normalize-path": "^3.0.0",

package/server/options/getAppReadmes.d.ts

@@ -0,0 +1,2 @@
+import { type AppReadme as AppReadmeInterface, type GetAppSubEntityParams } from '@appsemble/node-utils';
+export declare function getAppReadmes({ app }: GetAppSubEntityParams): Promise<AppReadmeInterface[]>;

package/server/options/getAppReadmes.js

@@ -0,0 +1,11 @@
+import { readFile } from 'node:fs/promises';
+export async function getAppReadmes({ app }) {
+    const readme = await readFile(`${app.path}/readmes/${app.readmeUrl}`);
+    return [
+        {
+            id: 0,
+            file: readme,
+        },
+    ];
+}
+//# sourceMappingURL=getAppReadmes.js.map

package/server/options/index.d.ts

@@ -33,3 +33,4 @@ export * from './applyAppServiceSecrets.js';
 export * from './getAppMembers.js';
 export * from './getAppTeams.js';
 export * from './getAppUserInfo.js';
+export * from './getAppReadmes.js';

package/server/options/index.js

@@ -33,4 +33,5 @@ export * from './applyAppServiceSecrets.js';
 export * from './getAppMembers.js';
 export * from './getAppTeams.js';
 export * from './getAppUserInfo.js';
+export * from './getAppReadmes.js';
 //# sourceMappingURL=index.js.map

package/server/options/options.js

@@ -1,4 +1,4 @@
-import { applyAppServiceSecrets, checkRole, createAppAsset, createAppResourcesWithAssets, createSettings, createTheme, deleteAppAsset, deleteAppResource, email, getApp, getAppAssets, getAppBlockStyles, getAppDetails, getAppIcon, getAppMembers, getAppMessages, getAppResource, getAppResources, getAppScreenshots, getAppStyles, getAppTeams, getAppUrl, getAppUserInfo, getBlockAsset, getBlockMessages, getBlocksAssetsPaths, getCsp, getDbUpdated, getHost, getTheme, parseQuery, reloadUser, sendNotifications, updateAppResource, verifyResourceActionPermission, } from './index.js';
+import { applyAppServiceSecrets, checkRole, createAppAsset, createAppResourcesWithAssets, createSettings, createTheme, deleteAppAsset, deleteAppResource, email, getApp, getAppAssets, getAppBlockStyles, getAppDetails, getAppIcon, getAppMembers, getAppMessages, getAppReadmes, getAppResource, getAppResources, getAppScreenshots, getAppStyles, getAppTeams, getAppUrl, getAppUserInfo, getBlockAsset, getBlockMessages, getBlocksAssetsPaths, getCsp, getDbUpdated, getHost, getTheme, parseQuery, reloadUser, sendNotifications, updateAppResource, verifyResourceActionPermission, } from './index.js';
 export const options = {
     applyAppServiceSecrets,
     checkRole,
@@ -16,6 +16,7 @@ export const options = {
     getAppIcon,
     getAppMembers,
     getAppMessages,
+    getAppReadmes,
     getAppResource,
     getAppResources,
     getAppScreenshots,

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

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

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

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

package/templates/blocks/preact/package.json

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

package/templates/blocks/vanilla/package.json

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