@appsemble/cli 0.28.6 → 0.28.8

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.28.6/config/assets/logo.svg) Appsemble CLI
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.28.8/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.28.6/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.28.6)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.28.8/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.28.8)
 [![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.28.6/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.28.8/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/commands/team/create.js

@@ -18,11 +18,11 @@ export function builder(yargs) {
     })
         .option('app', {
         describe: 'The path to the app.',
-        demandOption: 'context',
+        implies: 'context',
     })
         .option('context', {
         describe: 'If specified, use the specified context from .appsemblerc.yaml',
-        demandOption: 'app',
+        implies: 'app',
     });
 }
 export async function handler({ annotation, app, appId, clientCredentials, context, name, remote, }) {

package/commands/team/update.js

@@ -15,6 +15,14 @@ export function builder(yargs) {
         .option('annotation', {
         type: 'array',
         describe: 'The new list of annotations. The format is key=value.',
+    })
+        .option('app', {
+        describe: 'The path to the app.',
+        implies: 'context',
+    })
+        .option('context', {
+        describe: 'If specified, use the specified context from .appsemblerc.yaml to resolve appId and remote',
+        implies: 'app',
     })
         .option('app-id', {
         describe: 'The ID of the app to delete the team from.',

package/lib/app.js

@@ -678,16 +678,19 @@ export async function resolveAppIdAndRemote(appPath, name, defaultRemote, defaul
         const rcPath = join(appPath, '.appsemblerc.yaml');
         const [rc] = await readData(rcPath);
         const context = (_a = rc.context) === null || _a === void 0 ? void 0 : _a[name];
-        if (!defaultAppId) {
+        if (context === null || context === void 0 ? void 0 : context.id) {
             id = context === null || context === void 0 ? void 0 : context.id;
         }
-        if (context.remote) {
+        if (context === null || context === void 0 ? void 0 : context.remote) {
             resolvedRemote = context.remote;
         }
     }
     if (id == null) {
         throw new AppsembleError(`App ID was not found in context.${name}.id nor in --app-id`);
     }
+    if (resolvedRemote == null) {
+        throw new AppsembleError(`App remote was not found in context.${name}.remote nor in --remote`);
+    }
     return [id, coerceRemote(resolvedRemote)];
 }
 /**

package/lib/app.test.js

@@ -1,10 +1,11 @@
+import { writeFile } from 'node:fs/promises';
 import { readFixture, resolveFixture } from '@appsemble/node-utils';
 import { createServer, createTestUser, models, setArgv, useTestDatabase } from '@appsemble/server';
 import { ISODateTimePattern } from '@appsemble/utils';
 import { setTestApp } from 'axios-test-instance';
 import FormData from 'form-data';
 import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
-import { deleteApp, patchApp, publishApp, traverseAppDirectory, updateApp } from './app.js';
+import { deleteApp, patchApp, publishApp, resolveAppIdAndRemote, traverseAppDirectory, updateApp, writeAppMessages, } from './app.js';
 import { initAxios } from './initAxios.js';
 import { authorizeCLI } from './testUtils.js';
 const { App, AppBlockStyle, AppCollection, AppCollectionApp, AppMessages, AppOAuth2Secret, AppSamlSecret, AppScreenshot, AppServiceSecret, AppVariable, Asset, BlockVersion, Organization, OrganizationMember, Resource, } = models;
@@ -179,7 +180,8 @@ describe('publishApp', () => {
         expect(asset).toStrictEqual([]);
     });
     it('should throw an error if the user doesn’t have enough scope permissions', async () => {
-        const clientCredentials = await authorizeCLI('blocks:write resources:write', testApp);
+        const clientCredentials = await authorizeCLI('', testApp);
+        vi.useRealTimers();
         await expect(() => publishApp({
             path: resolveFixture('apps/test'),
             organization: organization.id,
@@ -188,10 +190,26 @@ describe('publishApp', () => {
             // Required defaults
             visibility: 'unlisted',
             iconBackground: '#ffffff',
-        })).rejects.toThrow('write EPIPE');
+        })).rejects.toThrow('Request failed with status code 401');
+        vi.useFakeTimers();
         const app = await App.findOne();
         expect(app).toBeNull();
     });
+    it('should not publish if dryRun is specified', async () => {
+        const clientCredentials = await authorizeCLI('apps:write resources:write', testApp);
+        await publishApp({
+            path: resolveFixture('apps/test'),
+            organization: organization.id,
+            remote: testApp.defaults.baseURL,
+            clientCredentials,
+            // Required defaults
+            visibility: 'unlisted',
+            iconBackground: '#ffffff',
+            dryRun: true,
+        });
+        const apps = await App.findAll();
+        expect(apps).toStrictEqual([]);
+    });
     it('should publish app with resources and assets', async () => {
         vi.useRealTimers();
         const clientCredentials = await authorizeCLI('apps:write resources:write', testApp);
@@ -943,6 +961,30 @@ describe('updateApp', () => {
         const asset = await Asset.findAll();
         expect(asset).toStrictEqual([]);
     });
+    it('should throw an error if the user doesn’t have enough scope permissions', async () => {
+        const clientCredentials = await authorizeCLI('', testApp);
+        vi.useRealTimers();
+        await expect(() => updateApp({
+            id: app.id,
+            force: false,
+            path: resolveFixture('apps/test'),
+            remote: testApp.defaults.baseURL,
+            clientCredentials,
+            // Required defaults
+            visibility: 'unlisted',
+            iconBackground: '#ffffff',
+        })).rejects.toThrow('Request failed with status code 401');
+        vi.useFakeTimers();
+        await app.reload();
+        expect(app).toMatchObject({
+            path: 'test-app',
+            definition: { name: 'Test App', defaultPage: 'Test Page' },
+            vapidPublicKey: 'a',
+            vapidPrivateKey: 'b',
+            visibility: 'public',
+            OrganizationId: organization.id,
+        });
+    });
     it('should update app with resources and assets', async () => {
         vi.useRealTimers();
         const clientCredentials = await authorizeCLI('apps:write resources:write', testApp);
@@ -1973,6 +2015,13 @@ describe('traverseAppDirectory', () => {
         }, `
       {
         "context": {
+          "notFound": {
+            "organization": "testorganization",
+          },
+          "resolve": {
+            "id": 5,
+            "remote": "http://localhost:5555",
+          },
           "test": {
             "appLock": "studioLock",
             "assets": true,
@@ -2072,6 +2121,32 @@ describe('traverseAppDirectory', () => {
         await expect(() => traverseAppDirectory(resolveFixture('apps/empty'), null, formData)).rejects.toThrow('No app definition found');
     });
 });
+describe('resolveAppIdAndRemote', () => {
+    it('should find and return app id and remote from appsembleRC', async () => {
+        const [appId, remote] = await resolveAppIdAndRemote(resolveFixture('apps/test'), 'resolve', 'http://localhost:8888', 55);
+        expect(appId).toBe(5);
+        expect(remote).toBe('http://localhost:5555/');
+    });
+    it('should fallback to default appId and remote if not found in context', async () => {
+        const [appId, remote] = await resolveAppIdAndRemote(resolveFixture('apps/test'), 'notFound', 'http://localhost:8888', 55);
+        expect(appId).toBe(55);
+        expect(remote).toBe('http://localhost:8888/');
+    });
+    it('should throw if the appId is not found in context and defaultAppId is not specified', async () => {
+        await expect(() => resolveAppIdAndRemote(resolveFixture('apps/test'), 'notFound', 'http://localhost:8888', null)).rejects.toThrow('App ID was not found');
+    });
+    it('should throw if the remote is not found in context and defaultAppRemote is not specified', async () => {
+        const app = await App.create({
+            path: 'test-app',
+            definition: { name: 'Test App', defaultPage: 'Test Page' },
+            vapidPublicKey: 'a',
+            vapidPrivateKey: 'b',
+            visibility: 'public',
+            OrganizationId: organization.id,
+        });
+        await expect(() => resolveAppIdAndRemote(resolveFixture('apps/test'), 'notFound', null, app.id)).rejects.toThrow('App remote was not found');
+    });
+});
 describe('deleteApp', () => {
     it('should throw if an error occurs', async () => {
         const clientCredentials = await authorizeCLI('apps:delete', testApp);
@@ -2092,4 +2167,35 @@ describe('deleteApp', () => {
         expect(foundApps).toStrictEqual([]);
     });
 });
+describe('writeAppMessages', () => {
+    it('should extract messages from app-definition and write to file in i18n directory', async () => {
+        const initialMessages = JSON.parse(String(await readFixture('apps/test-messages/i18n/nl.json')));
+        expect(initialMessages).toMatchObject({
+            app: {},
+        });
+        await writeAppMessages(resolveFixture('apps/test-messages'), ['nl'], [], 'json');
+        const messages = JSON.parse(String(await readFixture('apps/test-messages/i18n/nl.json')));
+        expect(messages).toMatchObject({
+            app: {
+                description: '',
+                name: '',
+                'pages.test-page': '',
+            },
+        });
+        await writeFile(resolveFixture('apps/test-messages/i18n/nl.json'), JSON.stringify(initialMessages, null, '\t'));
+    });
+    it('should throw if the language file does not exist', async () => {
+        await expect(() => writeAppMessages(resolveFixture('apps/test-messages'), ['hr'], [], 'json')).rejects.toThrow('Missing translations file');
+    });
+    it('should throw if there are empty messages in a verified file', async () => {
+        const initialMessages = JSON.parse(String(await readFixture('apps/test-messages/i18n/nl.json')));
+        expect(initialMessages).toMatchObject({
+            app: {},
+        });
+        await expect(() => writeAppMessages(resolveFixture('apps/test-messages'), ['nl'], ['nl'], 'json')).rejects.toThrow('Missing translation');
+    });
+    it('should throw if app definition does not exist in the app folder', async () => {
+        await expect(() => writeAppMessages(resolveFixture('apps/empty'), ['nl'], [], 'json')).rejects.toThrow('Couldn’t find app definition');
+    });
+});
 //# sourceMappingURL=app.test.js.map

package/lib/block.test.js

@@ -2,15 +2,42 @@ import { resolveFixture } from '@appsemble/node-utils';
 import { createServer, createTestUser, models, setArgv, useTestDatabase } from '@appsemble/server';
 import { setTestApp } from 'axios-test-instance';
 import concat from 'concat-stream';
-import { beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
-import { deleteBlock } from './block.js';
+import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
+import { deleteBlock, traverseBlockThemes } from './block.js';
 import { initAxios } from './initAxios.js';
 import { makeProjectPayload } from './project.js';
 import { authorizeCLI } from './testUtils.js';
 useTestDatabase(import.meta);
 const argv = { host: 'http://localhost', secret: 'test', aesSecret: 'testSecret' };
 let testApp;
-const { BlockVersion, Organization, OrganizationMember } = models;
+let user;
+let organization;
+const { App, AppBlockStyle, BlockVersion, Organization, OrganizationMember, Theme } = models;
+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',
+    });
+    await Organization.create({ id: 'appsemble', name: 'Appsemble' });
+});
+afterAll(() => {
+    vi.useRealTimers();
+});
 describe('makeProjectPayload', () => {
     it('should create a form-data payload', async () => {
         const payload = await makeProjectPayload({
@@ -105,29 +132,6 @@ export const string = 'with-icon';
     });
 });
 describe('deleteBlock', () => {
-    let user;
-    let organization;
-    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',
-        });
-    });
     it('should delete a block', async () => {
         const block = await BlockVersion.create({
             OrganizationId: organization.id,
@@ -146,4 +150,84 @@ describe('deleteBlock', () => {
         expect(foundBlocks).toStrictEqual([]);
     });
 });
+describe('traverseBlockThemes', () => {
+    it('should upload css from a file in the app directory', async () => {
+        const app = await App.create({
+            path: 'test-app',
+            definition: { name: 'Test App', defaultPage: 'Test Page' },
+            vapidPublicKey: 'a',
+            vapidPrivateKey: 'b',
+            visibility: 'public',
+            OrganizationId: organization.id,
+        });
+        await BlockVersion.create({
+            name: 'test',
+            OrganizationId: 'appsemble',
+            version: '0.0.0',
+            parameters: {
+                type: 'object',
+                properties: {
+                    foo: {
+                        type: 'number',
+                    },
+                },
+            },
+        });
+        await authorizeCLI('apps:write', testApp);
+        await traverseBlockThemes(resolveFixture('apps/test'), app.id, testApp.defaults.baseURL, false);
+        const style = await AppBlockStyle.findOne();
+        expect(style.dataValues).toMatchInlineSnapshot(`
+      {
+        "AppId": 1,
+        "block": "@appsemble/test",
+        "created": 1970-01-01T00:00:00.000Z,
+        "style": ".tux {
+        color: rgb(0 0 0);
+      }",
+        "updated": 1970-01-01T00:00:00.000Z,
+      }
+    `);
+    });
+    it('should throw if the block does not exist', async () => {
+        const app = await App.create({
+            path: 'test-app',
+            definition: { name: 'Test App', defaultPage: 'Test Page' },
+            vapidPublicKey: 'a',
+            vapidPrivateKey: 'b',
+            visibility: 'public',
+            OrganizationId: organization.id,
+        });
+        await authorizeCLI('apps:write', testApp);
+        await expect(() => traverseBlockThemes(resolveFixture('apps/test'), app.id, testApp.defaults.baseURL, false)).rejects.toThrow('Request failed with status code 404');
+        const style = await AppBlockStyle.findOne();
+        expect(style).toBeNull();
+    });
+    it('should not upload css from core and shared directories', async () => {
+        const app = await App.create({
+            path: 'test-app',
+            definition: { name: 'Test App', defaultPage: 'Test Page' },
+            vapidPublicKey: 'a',
+            vapidPrivateKey: 'b',
+            visibility: 'public',
+            OrganizationId: organization.id,
+        });
+        await BlockVersion.create({
+            name: 'test',
+            OrganizationId: 'appsemble',
+            version: '0.0.0',
+            parameters: {
+                type: 'object',
+                properties: {
+                    foo: {
+                        type: 'number',
+                    },
+                },
+            },
+        });
+        await authorizeCLI('apps:write', testApp);
+        await traverseBlockThemes(resolveFixture('apps/test'), app.id, testApp.defaults.baseURL, false);
+        const style = await Theme.findAll();
+        expect(style).toStrictEqual([]);
+    });
+});
 //# sourceMappingURL=block.test.js.map

package/lib/organization.test.js

@@ -1,3 +1,4 @@
+import { createFixtureStream, readFixture } from '@appsemble/node-utils';
 import { createServer, createTestUser, models, setArgv, useTestDatabase } from '@appsemble/server';
 import { setTestApp } from 'axios-test-instance';
 import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
@@ -32,23 +33,18 @@ describe('createOrganization', () => {
             id: 'test',
             name: 'Test',
             email: 'test@example.com',
-            icon: null,
+            icon: createFixtureStream('apps/tux.png'),
             website: 'https://example.com',
         });
         const organization = await Organization.findOne();
-        expect(organization).toMatchInlineSnapshot(`
-      {
-        "created": 1970-01-01T00:00:00.000Z,
-        "deleted": null,
-        "description": "test description",
-        "email": "test@example.com",
-        "icon": null,
-        "id": "test",
-        "name": "Test",
-        "updated": 1970-01-01T00:00:00.000Z,
-        "website": "https://example.com",
-      }
-    `);
+        expect(organization).toMatchObject({
+            description: 'test description',
+            email: 'test@example.com',
+            icon: await readFixture('apps/tux.png'),
+            id: 'test',
+            name: 'Test',
+            website: 'https://example.com',
+        });
     });
     it('should not create a new organization with duplicate id', async () => {
         const organization = await Organization.create({
@@ -83,19 +79,21 @@ describe('updateOrganization', () => {
         await updateOrganization({
             id: organization.id,
             name: 'Test changed',
-            description: null,
+            description: 'Description Changed',
             email: 'test@example.com',
             website: null,
-            icon: null,
+            icon: createFixtureStream('apps/tux.png'),
         });
         await organization.reload();
-        expect(organization.dataValues).toMatchInlineSnapshot(`
+        expect(organization.dataValues).toMatchInlineSnapshot({
+            icon: expect.any(Buffer),
+        }, `
       {
         "created": 1970-01-01T00:00:00.000Z,
         "deleted": null,
-        "description": null,
+        "description": "Description Changed",
         "email": "test@example.com",
-        "icon": null,
+        "icon": Any<Buffer>,
         "id": "test",
         "name": "Test changed",
         "updated": 1970-01-01T00:00:00.000Z,

package/lib/team.test.js

@@ -3,7 +3,7 @@ import { TeamRole } from '@appsemble/utils';
 import { setTestApp } from 'axios-test-instance';
 import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
 import { initAxios } from './initAxios.js';
-import { createTeam, deleteMember, deleteTeam, inviteMember, updateMember, updateTeam, } from './team.js';
+import { createTeam, deleteMember, deleteTeam, inviteMember, resolveAnnotations, updateMember, updateTeam, } from './team.js';
 import { authorizeCLI } from './testUtils.js';
 const { App, AppMember, BlockVersion, Organization, OrganizationMember, Team, TeamMember } = models;
 const argv = { host: 'http://localhost', secret: 'test', aesSecret: 'testSecret' };
@@ -603,4 +603,18 @@ describe('deleteMember', () => {
         await expect(() => deleteMember({ appId: app.id, remote: testApp.defaults.baseURL, user: user.id, id: team.id })).rejects.toThrow('Request failed with status code 400');
     });
 });
+describe('resolveAnnotations', () => {
+    it('should resolve team annotations', () => {
+        const unresolvedAnnotations = ['foo=bar', 'hello=world'];
+        const annotations = resolveAnnotations(unresolvedAnnotations);
+        expect(annotations).toMatchObject({
+            foo: 'bar',
+            hello: 'world',
+        });
+    });
+    it('should throw an error if annotations are not in right format', () => {
+        const unresolvedAnnotations = ['foo:bar', 'hello.world'];
+        expect(() => resolveAnnotations(unresolvedAnnotations)).toThrow('One of the annotations did not follow the pattern of key=value');
+    });
+});
 //# sourceMappingURL=team.test.js.map

package/package.json

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

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

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

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

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

package/templates/blocks/preact/package.json

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

package/templates/blocks/vanilla/package.json

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

package/vitest.setup.js

@@ -1,4 +1,5 @@
-import { setFixtureBase, setLogLevel } from '@appsemble/node-utils';
+import { CREDENTIALS_ENV_VAR, setFixtureBase, setLogLevel } from '@appsemble/node-utils';
 setFixtureBase(import.meta);
+delete process.env[CREDENTIALS_ENV_VAR];
 setLogLevel(0);
 //# sourceMappingURL=vitest.setup.js.map