@appsemble/cli 0.20.45 → 0.21.0

package/lib/block.js

@@ -1,6 +1,6 @@
 import { createReadStream, existsSync } from 'node:fs';
 import { mkdir, readdir, readFile, rm } from 'node:fs/promises';
-import { basename, join, relative, resolve as resolvePath } from 'node:path';
+import { basename, extname, join, relative, resolve as resolvePath } from 'node:path';
 import { inspect } from 'node:util';
 import { AppsembleError, getWorkspaces, logger, opendirSafe, readData, writeData, } from '@appsemble/node-utils';
 import { compareStrings } from '@appsemble/utils';
@@ -102,6 +102,7 @@ export async function makePayload(config) {
     const { dir, output } = config;
     const distPath = resolvePath(dir, output);
     const form = new FormData();
+    const gatheredData = {};
     const { description, layout, longDescription, name, version, visibility } = config;
     const { actions, events, messages, parameters } = getBlockConfigFromTypeScript(config);
     const files = await readdir(dir);
@@ -117,20 +118,30 @@ export async function makePayload(config) {
         }
     }
     append('actions', actions);
+    gatheredData.actions = actions;
     append('description', description);
+    gatheredData.description = description;
     append('longDescription', longDescription);
+    gatheredData.longDescription = longDescription;
     append('events', events);
+    gatheredData.events = events;
     append('layout', layout);
+    gatheredData.layout = layout;
     if (visibility) {
         append('visibility', visibility);
+        gatheredData.visibility = visibility;
     }
     append('name', name);
+    gatheredData.name = name;
     append('parameters', parameters);
+    gatheredData.parameters = parameters;
     append('version', version);
+    gatheredData.version = version;
     if (icon) {
         const iconPath = join(dir, icon);
         logger.info(`Using icon: ${iconPath}`);
         form.append('icon', createReadStream(iconPath));
+        gatheredData.iconUrl = basename(iconPath, extname(iconPath));
     }
     if (messages) {
         if (!files.includes('i18n')) {
@@ -160,6 +171,7 @@ export async function makePayload(config) {
             messagesResult[language] = m;
         }
         form.append('messages', JSON.stringify(messagesResult));
+        gatheredData.messages = messagesResult;
     }
     if (files.includes('examples')) {
         await opendirSafe(join(dir, 'examples'), async (file, stat) => {
@@ -168,6 +180,7 @@ export async function makePayload(config) {
             }
             logger.info(`Adding example file ${file}`);
             form.append('examples', await readFile(file, 'utf8'));
+            gatheredData.examples = [...(gatheredData.examples || []), basename(file, extname(file))];
         }, { allowMissing: true });
     }
     await opendirSafe(distPath, (fullpath, stat) => {
@@ -180,8 +193,9 @@ export async function makePayload(config) {
         form.append('files', createReadStream(fullpath), {
             filename: encodeURIComponent(relativePath),
         });
+        gatheredData.files = [...(gatheredData.files || []), relativePath];
     }, { recursive: true });
-    return form;
+    return [form, gatheredData];
 }
 /**
  * Publish a new block version.
@@ -191,7 +205,7 @@ export async function makePayload(config) {
  */
 export async function publishBlock(config, ignoreConflict) {
     logger.info(`Publishing ${config.name}@${config.version}…`);
-    const form = await makePayload(config);
+    const [form] = await makePayload(config);
     try {
         await axios.post('/api/blocks', form);
         logger.info(`Successfully published ${config.name}@${config.version} 🎉`);

package/lib/block.test.js

@@ -13,9 +13,10 @@ describe('makePayload', () => {
             actions: { onClick: {} },
             events: { listen: { test: {} } },
         });
-        const boundary = payload.getBoundary();
+        const [formData] = payload;
+        const boundary = formData.getBoundary();
         const buffer = await new Promise((resolve) => {
-            payload.pipe(concat(resolve));
+            formData.pipe(concat(resolve));
         });
         expect(String(buffer)).toBe(`--${boundary}\r
 Content-Disposition: form-data; name="actions"\r
@@ -57,9 +58,10 @@ export const string = 'no-icon';
             actions: {},
             events: {},
         });
-        const boundary = payload.getBoundary();
+        const [formData] = payload;
+        const boundary = formData.getBoundary();
         const buffer = await new Promise((resolve) => {
-            payload.pipe(concat(resolve));
+            formData.pipe(concat(resolve));
         });
         expect(String(buffer)).toBe(`--${boundary}\r
 Content-Disposition: form-data; name="actions"\r

package/lib/coercers.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="node" />
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { type ReadStream } from 'node:fs';
 /**
  * Convert a remote to a valid URL.

package/lib/createServers.d.ts

@@ -0,0 +1,19 @@
+import Koa from 'koa';
+import { type Configuration } from 'webpack';
+interface CreateServerOptions {
+    /**
+     * Server arguments
+     */
+    argv: Record<string, any>;
+    /**
+     * Additional context to append to the server.
+     */
+    context?: Record<string, any>;
+    /**
+     * Webpack configurations to serve using Webpack dev server middleware.
+     */
+    webpackConfigs?: Configuration[];
+}
+export declare function createStaticServer({ argv, context, webpackConfigs, }: CreateServerOptions): Promise<Koa>;
+export declare function createApiServer({ argv, context }: CreateServerOptions): Koa;
+export {};

package/lib/createServers.js

@@ -0,0 +1,57 @@
+import { bodyParser, boomMiddleware, conditional, frontend, loggerMiddleware, parameters, serializer, } from '@appsemble/node-utils';
+import { api } from '@appsemble/utils';
+import { notFound } from '@hapi/boom';
+import cors from '@koa/cors';
+import Koa from 'koa';
+import compose from 'koa-compose';
+import compress from 'koa-compress';
+import range from 'koa-range';
+import { koas } from 'koas-core';
+import { operations } from 'koas-operations';
+import { statusCode } from 'koas-status-code';
+import pkg from '../package.json' assert { type: 'json' };
+import * as controllers from '../server/controllers/index.js';
+import { appRouter } from '../server/routes/appRouter/index.js';
+export async function createStaticServer({ argv, context, webpackConfigs, }) {
+    const app = new Koa();
+    app.use(loggerMiddleware());
+    app.use(boomMiddleware());
+    app.use(range);
+    Object.assign(app.context, context);
+    if (process.env.NODE_ENV === 'production') {
+        app.use(compress());
+    }
+    if (!['test', 'production'].includes(process.env.NODE_ENV)) {
+        app.use(await frontend(webpackConfigs, argv));
+    }
+    app.use(appRouter);
+    return app;
+}
+export function createApiServer({ argv, context }) {
+    const app = new Koa();
+    app.use(loggerMiddleware());
+    app.use(boomMiddleware());
+    app.use(range);
+    Object.assign(app.context, context);
+    if (process.env.NODE_ENV === 'production') {
+        app.use(compress());
+    }
+    app.use(compose([
+        conditional((ctx) => ctx.path.startsWith('/api') || ctx.path === '/oauth2/token', cors()),
+        koas(api(pkg.version, argv), [
+            parameters(),
+            bodyParser(),
+            serializer(),
+            statusCode(),
+            operations({ controllers, throwOnNotImplemented: false }),
+        ]),
+        ({ path }, next) => {
+            if (path.startsWith('/api/')) {
+                throw notFound('URL not found');
+            }
+            return next();
+        },
+    ]));
+    return app;
+}
+//# sourceMappingURL=createServers.js.map

package/lib/getBlockConfigFromTypeScript.js

@@ -49,6 +49,7 @@ function processInterface(iface, checker, convert) {
                 const comments = (_a = commentRanges === null || commentRanges === void 0 ? void 0 : commentRanges.map((r) => source.slice(r.pos, r.end))) !== null && _a !== void 0 ? _a : [];
                 const [block] = parse(comments[0]);
                 const processedDescription = block.source
+                    // @ts-expect-error https://github.com/syavorsky/comment-parser/pull/163
                     .map((src) => src.tokens.description)
                     .join('\n')
                     .replace(/^\s+|\s+$/g, '');

package/lib/getBlockConfigFromTypeScript.test.js

@@ -5,7 +5,7 @@ import { AppsembleError, resolveFixture } from '@appsemble/node-utils';
 import { ts } from 'ts-json-schema-generator';
 import { getBlockConfigFromTypeScript } from './getBlockConfigFromTypeScript.js';
 beforeEach(() => {
-    import.meta.jest.spyOn(process, 'cwd').mockReturnValue(resolveFixture('.'));
+    vi.spyOn(process, 'cwd').mockReturnValue(resolveFixture('.'));
 });
 describe('getBlockConfigFromTypeScript', () => {
     it('should extract configuration from a TypeScript project', () => {
@@ -50,7 +50,7 @@ describe('getBlockConfigFromTypeScript', () => {
         });
     });
     it('should not use TypeScript if all metadata is present in the original config', () => {
-        import.meta.jest.spyOn(ts, 'createProgram');
+        vi.spyOn(ts, 'createProgram');
         const input = {
             actions: {},
             events: { emit: { foo: {} }, listen: { bar: {} } },

package/lib/organization.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import { type ReadStream } from 'node:fs';
 interface CreateOrganizationArguments {
     description: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/cli",
-  "version": "0.20.45",
+  "version": "0.21.0",
   "description": "The CLI for developing with Appsemble apps and blocks",
   "keywords": [
     "app",
@@ -31,22 +31,37 @@
   ],
   "scripts": {
     "prepack": "tsc --noEmit false",
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest"
+    "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/node-utils": "0.20.45",
-    "@appsemble/types": "0.20.45",
-    "@appsemble/utils": "0.20.45",
+    "@appsemble/node-utils": "0.21.0",
+    "@appsemble/types": "0.21.0",
+    "@appsemble/utils": "0.21.0",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
+    "@hapi/boom": "^10.0.0",
+    "@koa/cors": "^4.0.0",
+    "@odata/parser": "^0.2.0",
     "axios": "^1.0.0",
     "chalk": "^4.0.0",
     "comment-parser": "^1.0.0",
     "cosmiconfig": "^7.0.0",
+    "csvtojson": "^2.0.0",
     "fast-glob": "^3.0.0",
     "form-data": "^4.0.0",
+    "global-cache-dir": "^5.0.0",
     "inquirer": "^9.0.0",
     "jsonschema": "^1.0.0",
     "koa": "^2.0.0",
+    "koa-compose": "^4.0.0",
+    "koa-compress": "^5.0.0",
+    "koa-range": "^0.3.0",
+    "koas-core": "^0.7.0",
+    "koas-operations": "^0.7.0",
+    "koas-status-code": "^0.7.0",
+    "language-tags": "^1.0.0",
+    "lodash-es": "^4.0.0",
+    "mime-types": "^2.0.0",
+    "node-json-db": "^2.0.0",
     "normalize-path": "^3.0.0",
     "open": "^9.0.0",
     "postcss": "^8.0.0",
@@ -55,6 +70,7 @@
     "postcss-url": "^10.0.0",
     "raw-body": "^2.0.0",
     "read-pkg-up": "^9.0.0",
+    "sharp": "^0.32.0",
     "ts-json-schema-generator": "^1.0.0",
     "type-fest": "^3.0.0",
     "webpack": "^5.0.0",
@@ -62,7 +78,7 @@
     "yargs": "^17.0.0"
   },
   "devDependencies": {
-    "@appsemble/types": "0.20.45",
+    "@appsemble/types": "0.21.0",
     "@types/concat-stream": "^2.0.0",
     "@types/inquirer": "^9.0.0",
     "@types/normalize-path": "^3.0.0",
@@ -70,6 +86,7 @@
     "@types/postcss-url": "^10.0.0",
     "concat-stream": "^2.0.0"
   },
+  "peerDependencies": {},
   "optionalDependencies": {
     "keytar": "^7.0.0"
   },

package/server/controllers/action.d.ts

@@ -0,0 +1,6 @@
+import { type Middleware } from 'koa';
+export declare const proxyDelete: Middleware;
+export declare const proxyGet: Middleware;
+export declare const proxyPatch: Middleware;
+export declare const proxyPost: Middleware;
+export declare const proxyPut: Middleware;

package/server/controllers/action.js

@@ -0,0 +1,8 @@
+import { createProxyDelete, createProxyGet, createProxyPatch, createProxyPost, createProxyPut, } from '@appsemble/node-utils';
+import { options } from '../options/options.js';
+export const proxyDelete = createProxyDelete(options);
+export const proxyGet = createProxyGet(options);
+export const proxyPatch = createProxyPatch(options);
+export const proxyPost = createProxyPost(options);
+export const proxyPut = createProxyPut(options);
+//# sourceMappingURL=action.js.map

package/server/controllers/appMembers.d.ts

@@ -0,0 +1,2 @@
+import { type Middleware } from 'koa';
+export declare const getAppMember: Middleware;

package/server/controllers/appMembers.js

@@ -0,0 +1,4 @@
+import { createGetAppMember } from '@appsemble/node-utils';
+import { options } from '../options/options.js';
+export const getAppMember = createGetAppMember(options);
+//# sourceMappingURL=appMembers.js.map

package/server/controllers/appMessages.d.ts

@@ -0,0 +1,2 @@
+import { type Middleware } from 'koa';
+export declare const getMessages: Middleware;

package/server/controllers/appMessages.js

@@ -0,0 +1,4 @@
+import { createGetMessages } from '@appsemble/node-utils';
+import { options } from '../options/options.js';
+export const getMessages = createGetMessages(options);
+//# sourceMappingURL=appMessages.js.map

package/server/controllers/assets.d.ts

@@ -0,0 +1,4 @@
+import { type Middleware } from 'koa';
+export declare const getAssets: Middleware;
+export declare const getAssetById: Middleware;
+export declare const createAsset: Middleware;

package/server/controllers/assets.js

@@ -0,0 +1,6 @@
+import { createCreateAsset, createGetAssetById, createGetAssets } from '@appsemble/node-utils';
+import { options } from '../options/options.js';
+export const getAssets = createGetAssets(options);
+export const getAssetById = createGetAssetById(options);
+export const createAsset = createCreateAsset(options);
+//# sourceMappingURL=assets.js.map

package/server/controllers/index.d.ts

@@ -0,0 +1,7 @@
+export * from './action.js';
+export * from './appMessages.js';
+export * from './resources.js';
+export * from './assets.js';
+export * from './appMembers.js';
+export * from './teams.js';
+export * from './oauth2Provider.js';

package/server/controllers/index.js

@@ -0,0 +1,8 @@
+export * from './action.js';
+export * from './appMessages.js';
+export * from './resources.js';
+export * from './assets.js';
+export * from './appMembers.js';
+export * from './teams.js';
+export * from './oauth2Provider.js';
+//# sourceMappingURL=index.js.map

package/server/controllers/oauth2Provider.d.ts

@@ -0,0 +1,2 @@
+import { type Middleware } from 'koa';
+export declare const getUserInfo: Middleware;

package/server/controllers/oauth2Provider.js

@@ -0,0 +1,4 @@
+import { createGetUserInfo } from '@appsemble/node-utils';
+import { options } from '../options/options.js';
+export const getUserInfo = createGetUserInfo(options);
+//# sourceMappingURL=oauth2Provider.js.map

package/server/controllers/resources.d.ts

@@ -0,0 +1,7 @@
+import { type Middleware } from 'koa';
+export declare const createResource: Middleware;
+export declare const countResources: Middleware;
+export declare const getResourceById: Middleware;
+export declare const queryResources: Middleware;
+export declare const updateResource: Middleware;
+export declare const deleteResource: Middleware;

package/server/controllers/resources.js

@@ -0,0 +1,9 @@
+import { createCountResources, createCreateResource, createDeleteResource, createGetResourceById, createQueryResources, createUpdateResource, } from '@appsemble/node-utils';
+import { options } from '../options/options.js';
+export const createResource = createCreateResource(options);
+export const countResources = createCountResources(options);
+export const getResourceById = createGetResourceById(options);
+export const queryResources = createQueryResources(options);
+export const updateResource = createUpdateResource(options);
+export const deleteResource = createDeleteResource(options);
+//# sourceMappingURL=resources.js.map

package/server/controllers/teams.d.ts

@@ -0,0 +1,2 @@
+import { type Middleware } from 'koa';
+export declare const getTeams: Middleware;

package/server/controllers/teams.js

@@ -0,0 +1,4 @@
+import { createGetTeams } from '@appsemble/node-utils';
+import { options } from '../options/options.js';
+export const getTeams = createGetTeams(options);
+//# sourceMappingURL=teams.js.map

package/server/db/index.d.ts

@@ -0,0 +1,2 @@
+import { JsonDB } from 'node-json-db';
+export declare function getDb(appName: string): Promise<JsonDB>;

package/server/db/index.js

@@ -0,0 +1,10 @@
+import { join } from 'node:path';
+import globalCacheDir from 'global-cache-dir';
+import { Config, JsonDB } from 'node-json-db';
+export async function getDb(appName) {
+    const cacheDir = await globalCacheDir('appsemble');
+    const dir = join(cacheDir, appName, 'db.json');
+    const config = new Config(dir, true, true, '/');
+    return new JsonDB(config);
+}
+//# sourceMappingURL=index.js.map

package/server/db/methods.d.ts

@@ -0,0 +1,11 @@
+import { type FindOptions } from '@appsemble/node-utils';
+export declare function setAppName(name: string): void;
+export declare const Methods: {
+    create<M>(values: Record<string, unknown>, modelDir?: string): Promise<M>;
+    bulkCreate<M_1>(values: Record<string, unknown>[], modelDir?: string, override?: boolean): Promise<[] | M_1[]>;
+    findById<M_2>(id: number | string, modelDir?: string): Promise<M_2>;
+    findOne<M_3>(query: FindOptions, modelDir?: string): Promise<M_3>;
+    findAll<M_4>(query?: FindOptions, modelDir?: string): Promise<[] | M_4[]>;
+    updateOne<M_5>(id: number | string, values: Record<string, unknown>, modelDir?: string): Promise<M_5>;
+    deleteOne(id: number | string, modelDir?: string): Promise<void>;
+};