@appsemble/cli 0.21.0 → 0.21.2

package/README.md

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

package/commands/serve.d.ts

@@ -1,6 +1,6 @@
 import { type Argv } from 'yargs';
-import { type BaseArguments } from '../types.js';
-interface ServeArguments extends BaseArguments {
+export interface ServeArguments {
+    remote: string;
     path: string;
     port: number;
     'api-port': number;
@@ -12,4 +12,3 @@ export declare const command = "serve path";
 export declare const description = "Serve an app with a local development server.";
 export declare function builder(yargs: Argv): Argv<any>;
 export declare function handler(argv: ServeArguments): Promise<void>;
-export {};

package/commands/serve.js

@@ -13,6 +13,7 @@ import { traverseAppDirectory } from '../lib/app.js';
 import { buildBlock, getBlockConfig, makePayload } from '../lib/block.js';
 import { createApiServer, createStaticServer } from '../lib/createServers.js';
 import { loadWebpackConfig } from '../lib/loadWebpackConfig.js';
+import { setArgv } from '../server/argv.js';
 import { setAppName } from '../server/db/methods.js';
 import { Resource } from '../server/models/Resource.js';
 export const command = 'serve path';
@@ -52,6 +53,7 @@ export function builder(yargs) {
     });
 }
 export async function handler(argv) {
+    setArgv(argv);
     const appPath = join(process.cwd(), argv.path);
     const [, , , appsembleApp] = await traverseAppDirectory(appPath, 'development', new FormData());
     const appRoles = appsembleApp.definition.roles;
@@ -203,7 +205,6 @@ export async function handler(argv) {
         $updated: new Date().toISOString(),
     };
     const appsembleApiServer = createApiServer({
-        argv,
         context: {
             appHost: `http://localhost:${argv.port}`,
             appsembleApp: stubbedApp,
@@ -228,7 +229,6 @@ export async function handler(argv) {
     });
     const api = http.createServer(appsembleApiServer.callback());
     const staticServer = await createStaticServer({
-        argv,
         context: {
             apiUrl: `http://localhost:${argv['api-port']}`,
             appHost: `http://localhost:${argv.port}`,

package/lib/createServers.d.ts

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

package/lib/createServers.js

@@ -10,9 +10,10 @@ 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 { argv } from '../server/argv.js';
 import * as controllers from '../server/controllers/index.js';
 import { appRouter } from '../server/routes/appRouter/index.js';
-export async function createStaticServer({ argv, context, webpackConfigs, }) {
+export async function createStaticServer({ context, webpackConfigs, }) {
     const app = new Koa();
     app.use(loggerMiddleware());
     app.use(boomMiddleware());
@@ -27,7 +28,7 @@ export async function createStaticServer({ argv, context, webpackConfigs, }) {
     app.use(appRouter);
     return app;
 }
-export function createApiServer({ argv, context }) {
+export function createApiServer({ context }) {
     const app = new Koa();
     app.use(loggerMiddleware());
     app.use(boomMiddleware());

package/lib/getBlockConfigFromTypeScript.js

@@ -18,7 +18,7 @@ function getNodeComments(checker, node) {
     const comments = symbol.getDocumentationComment(checker);
     if (comments.length) {
         return comments
-            .map((comment) => comment.kind === 'lineBreak' ? comment.text : comment.text.trim().replace(/\r\n/g, '\n'))
+            .map((comment) => comment.kind === 'lineBreak' ? comment.text : comment.text.trim().replaceAll('\r\n', '\n'))
             .join('');
     }
 }
@@ -49,10 +49,9 @@ 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, '');
+                    .replaceAll(/^\s+|\s+$/g, '');
                 return convert(undefined, processedDescription);
             }
             return convert(undefined, description);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/cli",
-  "version": "0.21.0",
+  "version": "0.21.2",
   "description": "The CLI for developing with Appsemble apps and blocks",
   "keywords": [
     "app",
@@ -34,9 +34,9 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/node-utils": "0.21.0",
-    "@appsemble/types": "0.21.0",
-    "@appsemble/utils": "0.21.0",
+    "@appsemble/node-utils": "0.21.2",
+    "@appsemble/types": "0.21.2",
+    "@appsemble/utils": "0.21.2",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "@hapi/boom": "^10.0.0",
     "@koa/cors": "^4.0.0",
@@ -69,16 +69,16 @@
     "postcss-load-config": "^4.0.0",
     "postcss-url": "^10.0.0",
     "raw-body": "^2.0.0",
-    "read-pkg-up": "^9.0.0",
+    "read-pkg-up": "^10.0.0",
     "sharp": "^0.32.0",
     "ts-json-schema-generator": "^1.0.0",
-    "type-fest": "^3.0.0",
+    "type-fest": "^4.0.0",
     "webpack": "^5.0.0",
     "yaml": "^2.0.0",
     "yargs": "^17.0.0"
   },
   "devDependencies": {
-    "@appsemble/types": "0.21.0",
+    "@appsemble/types": "0.21.2",
     "@types/concat-stream": "^2.0.0",
     "@types/inquirer": "^9.0.0",
     "@types/normalize-path": "^3.0.0",

package/server/argv.d.ts

@@ -0,0 +1,117 @@
+export interface Argv {
+    /**
+     * Amount by which the logging verbosity is decreased from its default.
+     */
+    quiet: number;
+    /**
+     * Amount by which the logging verbosity is increased from its default.
+     */
+    verbose: number;
+    /**
+     * The hostname on which the Appsemble app is served.
+     */
+    host: string;
+    /**
+     * The static HTTP server port to use.
+     *
+     * This is the port where the app is accessible.
+     *
+     * @default 9090
+     */
+    port: number;
+    /**
+     * The path to the app to publish.
+     */
+    path?: string;
+    /**
+     * The Appsemble development HTTP server port to use.
+     *
+     * This is the port where the Appsemble development API endpoints are available.
+     *
+     * @default 9191
+     */
+    'api-port': number;
+    /**
+     * The remote to use synchronizing blocks.
+     *
+     * @default 'https://appsemble.app'
+     */
+    remote?: string;
+    /**
+     * Whether to overwrite remote blocks cache if it exists.
+     */
+    'overwrite-block-cache': boolean;
+    /**
+     * The role to set to the mocked authenticated user.
+     */
+    'user-role'?: string;
+    /**
+     * The role to set to the mocked authenticated user in the team.
+     *
+     * @default 'member'
+     */
+    'team-role'?: string;
+}
+export declare const argv: {
+    /**
+     * Amount by which the logging verbosity is decreased from its default.
+     */
+    quiet: number;
+    /**
+     * Amount by which the logging verbosity is increased from its default.
+     */
+    verbose: number;
+    /**
+     * The hostname on which the Appsemble app is served.
+     */
+    host: string;
+    /**
+     * The static HTTP server port to use.
+     *
+     * This is the port where the app is accessible.
+     *
+     * @default 9090
+     */
+    port: number;
+    /**
+     * The path to the app to publish.
+     */
+    path?: string;
+    /**
+     * The Appsemble development HTTP server port to use.
+     *
+     * This is the port where the Appsemble development API endpoints are available.
+     *
+     * @default 9191
+     */
+    'api-port': number;
+    /**
+     * The remote to use synchronizing blocks.
+     *
+     * @default 'https://appsemble.app'
+     */
+    remote?: string;
+    /**
+     * Whether to overwrite remote blocks cache if it exists.
+     */
+    'overwrite-block-cache': boolean;
+    /**
+     * The role to set to the mocked authenticated user.
+     */
+    'user-role'?: string;
+    /**
+     * The role to set to the mocked authenticated user in the team.
+     *
+     * @default 'member'
+     */
+    'team-role'?: string;
+};
+/**
+ * Reset argv using the specified options.
+ *
+ * Unspecified options will be reset to their default values.
+ *
+ * @param options The argument overrides to set.
+ * @returns The argv instance.
+ */
+export declare function setArgv(options: Partial<Argv>): Argv;

package/server/argv.js

@@ -0,0 +1,25 @@
+const defaults = {
+    quiet: 0,
+    verbose: 0,
+    host: 'http://localhost:9090',
+    port: 9090,
+    path: undefined,
+    'api-port': 9191,
+    remote: undefined,
+    'overwrite-block-cache': false,
+    'user-role': undefined,
+    'team-role': undefined,
+};
+export const argv = { ...defaults };
+/**
+ * Reset argv using the specified options.
+ *
+ * Unspecified options will be reset to their default values.
+ *
+ * @param options The argument overrides to set.
+ * @returns The argv instance.
+ */
+export function setArgv(options) {
+    return Object.assign(argv, defaults, options);
+}
+//# sourceMappingURL=argv.js.map

package/server/options/parseQuery.js

@@ -76,7 +76,7 @@ function parseOdataOrder(query) {
 export function parseQuery({ $filter, $orderby }) {
     return {
         where: parseOdataFilter($filter),
-        order: parseOdataOrder($orderby ? $orderby.replace(/(^|\B)\$author\/id(\b|$)/g, '$author') : undefined),
+        order: parseOdataOrder($orderby ? $orderby.replaceAll(/(^|\B)\$author\/id(\b|$)/g, '$author') : undefined),
     };
 }
 //# sourceMappingURL=parseQuery.js.map