@appsemble/node-utils 0.36.5-test.6 → 0.36.6-test.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.36.5-test.6/config/assets/logo.svg) Appsemble Node Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.36.6-test.0/config/assets/logo.svg) Appsemble Node Utilities
 
 > NodeJS utilities used by Appsemble internally.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/node-utils)](https://www.npmjs.com/package/@appsemble/node-utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.36.5-test.6/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.36.5-test.6)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.36.6-test.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.36.6-test.0)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ compatibility is not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.36.5-test.6/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.36.6-test.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/createUser.d.ts

@@ -6,5 +6,6 @@
  * @param password Password
  * @param timezone Timezone of the user
  * @param clientCredentials Used to make OAuth client credentials for permissions
+ * @param organization Optional organization id to add the user to if it exists
  */
-export declare function createUser(name: string, email: string, password: string, timezone?: string, clientCredentials?: string): Promise<void>;
+export declare function createUser(name: string, email: string, password: string, timezone?: string, clientCredentials?: string, organization?: string): Promise<void>;

package/createUser.js

@@ -16,8 +16,9 @@ async function insert(table, columns, values, client) {
  * @param password Password
  * @param timezone Timezone of the user
  * @param clientCredentials Used to make OAuth client credentials for permissions
+ * @param organization Optional organization id to add the user to if it exists
  */
-export async function createUser(name, email, password, timezone, clientCredentials) {
+export async function createUser(name, email, password, timezone, clientCredentials, organization) {
     if (!DATABASE_HOST || !DATABASE_NAME || !DATABASE_PASSWORD || !DATABASE_PORT || !DATABASE_USER) {
         throw new Error('Missing database credentials');
     }
@@ -33,6 +34,16 @@ export async function createUser(name, email, password, timezone, clientCredenti
     const userId = uuid();
     await insert('User', ['id', 'name', '"primaryEmail"', 'password', 'timezone', 'created', 'updated'], [userId, name, email, hashedPassword, timezone ?? 'Europe/Amsterdam', 'NOW()', 'NOW()'], client);
     await insert('EmailAuthorization', ['email', 'verified', 'created', 'updated', '"UserId"'], [email, true, 'NOW()', 'NOW()', userId], client);
+    const organizationIds = new Set(['appsemble']);
+    if (organization) {
+        organizationIds.add(organization);
+    }
+    for (const organizationId of organizationIds) {
+        const organizationResult = await client.query('SELECT id FROM "Organization" WHERE id = $1', [organizationId]);
+        if (organizationResult.rows.length > 0) {
+            await insert('OrganizationMember', ['"OrganizationId"', '"UserId"', 'role', 'created', 'updated'], [organizationId, userId, 'Maintainer', 'NOW()', 'NOW()'], client);
+        }
+    }
     if (clientCredentials) {
         const [clientId, clientPassword] = clientCredentials.split(':');
         const hashedClientPassword = await hash(clientPassword, 10);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.36.5-test.6",
+  "version": "0.36.6-test.0",
   "description": "NodeJS utilities used by Appsemble internally.",
   "keywords": [
     "app",
@@ -40,9 +40,9 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/lang-sdk": "0.36.5-test.6",
-    "@appsemble/types": "0.36.5-test.6",
-    "@appsemble/utils": "0.36.5-test.6",
+    "@appsemble/lang-sdk": "0.36.6-test.0",
+    "@appsemble/types": "0.36.6-test.0",
+    "@appsemble/utils": "0.36.6-test.0",
     "@formatjs/fast-memoize": "^2.0.0",
     "@fortawesome/fontawesome-free": "^6.0.0",
     "@kubernetes/client-node": "1.4.0",

package/resource.d.ts

@@ -16,6 +16,7 @@ export declare function serializeServerResource(data: any): JsonValue | {
     resource: JsonValue;
     assets: TempFile[];
 };
+export type SerializedServerResourceBody = ReturnType<typeof serializeServerResource>;
 /**
  * Get the resource definition of an app by name.
  *
@@ -32,13 +33,15 @@ export declare function getResourceDefinition(appDefinition: AppDefinition, reso
  * Extracts the IDs of resource request body.
  *
  * @param ctx The Koa context to extract the body from.
+ * @param suppliedBody A resource body to use directly without reading from context.
+ *   Supports multipart-style `{ resource, assets }` input.
  * @returns A tuple which consists of:
  *
  *   1. One or more resources processed from the request body.
  *   2. A list of newly uploaded assets which should be linked to the resources.
  *   3. preValidateProperty function used for reconstructing resources from a CSV file.
  */
-export declare function extractResourceBody(ctx: Context | ParameterizedContext<DefaultState, DefaultContext, any>): [
+export declare function extractResourceBody(ctx: Context | ParameterizedContext<DefaultState, DefaultContext, any> | undefined, suppliedBody?: SerializedServerResourceBody): [
     Record<string, unknown> | Record<string, unknown>[],
     TempFile[],
     PreValidatePropertyFunction | undefined
@@ -54,6 +57,7 @@ export declare function extractResourceBody(ctx: Context | ParameterizedContext<
  * @param knownExpires A previously known expires value.
  * @param knownAssetNameIds A list of asset ids with asset names that already exist.
  * @param [isPatch] if the "PATCH" HTTP method is being used.
+ * @param resourceBody Used to process resources from non-request contexts.
  * @returns A tuple which consists of:
  *
  *   1. One or more resources processed from the request body.
@@ -63,4 +67,4 @@ export declare function extractResourceBody(ctx: Context | ParameterizedContext<
 export declare function processResourceBody(ctx: Context | ParameterizedContext<DefaultState, DefaultContext, any>, definition: ResourceDefinition, knownAssetIds?: string[], knownExpires?: Date, knownAssetNameIds?: {
     id: string;
     name?: string;
-}[], isPatch?: boolean): [Record<string, unknown> | Record<string, unknown>[], PreparedAsset[], string[]];
+}[], isPatch?: boolean, resourceBody?: SerializedServerResourceBody): [Record<string, unknown> | Record<string, unknown>[], PreparedAsset[], string[]];

package/resource.js

@@ -43,6 +43,14 @@ export function serializeServerResource(data) {
         assets,
     };
 }
+function isSerializedMultipartBody(value) {
+    return (value != null &&
+        typeof value === 'object' &&
+        !Array.isArray(value) &&
+        'resource' in value &&
+        'assets' in value &&
+        Array.isArray(value.assets));
+}
 /**
  * Get the resource definition of an app by name.
  *
@@ -86,17 +94,31 @@ export function getResourceDefinition(appDefinition, resourceType, ctx, view) {
  * Extracts the IDs of resource request body.
  *
  * @param ctx The Koa context to extract the body from.
+ * @param suppliedBody A resource body to use directly without reading from context.
+ *   Supports multipart-style `{ resource, assets }` input.
  * @returns A tuple which consists of:
  *
  *   1. One or more resources processed from the request body.
  *   2. A list of newly uploaded assets which should be linked to the resources.
  *   3. preValidateProperty function used for reconstructing resources from a CSV file.
  */
-export function extractResourceBody(ctx) {
+export function extractResourceBody(ctx, suppliedBody) {
     let body;
-    let assets;
+    let assets = [];
     let preValidateProperty;
-    if (ctx?.request?.body && ctx.is('multipart/form-data')) {
+    if (suppliedBody !== undefined) {
+        if (isSerializedMultipartBody(suppliedBody)) {
+            assets = suppliedBody.assets;
+            body = suppliedBody.resource;
+            if (Array.isArray(body) && body.length === 1) {
+                [body] = body;
+            }
+        }
+        else {
+            body = suppliedBody;
+        }
+    }
+    else if (ctx?.request?.body && ctx.is('multipart/form-data')) {
         ({ assets = [], resource: body } = ctx.request.body);
         if (Array.isArray(body) && body.length === 1) {
             [body] = body;
@@ -107,11 +129,12 @@ export function extractResourceBody(ctx) {
             preValidateProperty = preProcessCSV;
         }
         ({ body } = ctx.request);
-        assets = [];
     }
-    else {
+    else if (ctx) {
         ({ body } = ctx);
-        assets = [];
+    }
+    else {
+        throw new Error('No resource body provided.');
     }
     return [
         Array.isArray(body) ? body.map(stripResource) : stripResource(body),
@@ -131,14 +154,15 @@ export function extractResourceBody(ctx) {
  * @param knownExpires A previously known expires value.
  * @param knownAssetNameIds A list of asset ids with asset names that already exist.
  * @param [isPatch] if the "PATCH" HTTP method is being used.
+ * @param resourceBody Used to process resources from non-request contexts.
  * @returns A tuple which consists of:
  *
  *   1. One or more resources processed from the request body.
  *   2. A list of newly uploaded assets which should be linked to the resources.
  *   3. Asset IDs from the `knownAssetIds` array which are no longer used.
  */
-export function processResourceBody(ctx, definition, knownAssetIds = [], knownExpires, knownAssetNameIds = [], isPatch = false) {
-    const [resource, assets, preValidateProperty] = extractResourceBody(ctx);
+export function processResourceBody(ctx, definition, knownAssetIds = [], knownExpires, knownAssetNameIds = [], isPatch = false, resourceBody) {
+    const [resource, assets, preValidateProperty] = extractResourceBody(ctx, resourceBody);
     const validator = new Validator();
     const reusedAssets = new Set();
     const usedAssetIndices = new Set();

package/server/routes/appRouter/blockAssetHandler.js

@@ -6,6 +6,7 @@ export function createBlockAssetHandler({ getBlockAsset }) {
         params: { filename, name, version }, } = ctx;
         const blockAsset = await getBlockAsset({ filename, name, version, context: ctx });
         assertKoaCondition(blockAsset != null, ctx, 404, 'Block asset not found');
+        ctx.set('Cache-Control', 'max-age=31536000,immutable');
         ctx.body = blockAsset.content;
         ctx.type = blockAsset.mime;
     };

package/server/routes/appRouter/index.js

@@ -35,7 +35,7 @@ export function createAppRouter(options) {
         },
         {
             route: '/service-worker.js',
-            get: createServiceWorkerHandler(options),
+            get: createServiceWorkerHandler(),
         },
         {
             route: /^\/icon-(?<size>\d+)\.png$/,

package/server/routes/appRouter/serviceWorkerHandler.d.ts

@@ -1,3 +1,2 @@
-import { type Options } from '@appsemble/node-utils';
 import { type Middleware } from 'koa';
-export declare function createServiceWorkerHandler({ getApp, getBlocksAssetsPaths }: Options): Middleware;
+export declare function createServiceWorkerHandler(): Middleware;

package/server/routes/appRouter/serviceWorkerHandler.js

@@ -1,22 +1,12 @@
 import { readFile } from 'node:fs/promises';
-import { getAppBlocks } from '@appsemble/lang-sdk';
-import { assertKoaCondition } from '@appsemble/node-utils';
-export function createServiceWorkerHandler({ getApp, getBlocksAssetsPaths }) {
+export function createServiceWorkerHandler() {
     return async (ctx) => {
         const production = process.env.NODE_ENV === 'production';
         const filename = production ? '/service-worker.js' : '/app/service-worker.js';
         const serviceWorker = await (production
             ? readFile(new URL('../../../../../dist/app/service-worker.js', import.meta.url), 'utf8')
             : ctx.fs.promises.readFile(filename, 'utf8'));
-        const app = await getApp({
-            context: ctx,
-            query: { attributes: ['id', 'definition'] },
-        });
-        assertKoaCondition(app != null, ctx, 404, 'App does not exist.');
-        const identifiableBlocks = getAppBlocks(app.definition);
-        const blocksAssetsPaths = await getBlocksAssetsPaths({ identifiableBlocks, context: ctx });
-        // App.version is a virtual column and comes from App.AppSnapshots
-        ctx.body = `const appVersion = ${app.version};const blockAssets=${JSON.stringify(blocksAssetsPaths)};${serviceWorker}`;
+        ctx.body = serviceWorker;
         ctx.type = 'application/javascript';
     };
 }

package/server/types.d.ts

@@ -1,5 +1,5 @@
 import { type Readable } from 'node:stream';
-import { type AppMemberGroup, type BlockDefinition, type ControllerDefinition, type CustomAppPermission, type EmailActionDefinition, type IdentifiableBlock, type ResourceDefinition, type Theme as ThemeType } from '@appsemble/lang-sdk';
+import { type ActionDefinition, type AppMemberGroup, type BlockDefinition, type ControllerDefinition, type CustomAppPermission, type EmailActionDefinition, type IdentifiableBlock, type ResourceDefinition, type Theme as ThemeType } from '@appsemble/lang-sdk';
 import { type App, type AppConfigEntry, type AppMemberInfo, type AppMessages, type Asset, type BlockManifest, type Group, type OrganizationPermission, type Resource } from '@appsemble/types';
 import { type RawAxiosRequestConfig } from 'axios';
 import { type DefaultContext as DefaultContextInterface, type DefaultState, type ParameterizedContext } from 'koa';
@@ -332,6 +332,16 @@ export interface SendNotificationsParams {
     body: string;
     link: string;
 }
+export interface HandleActionParams {
+    app: App;
+    action: ActionDefinition;
+    mailer: any;
+    data: any;
+    options: Options;
+    context: ParameterizedContext<DefaultState, DefaultContextInterface, any>;
+}
+export type ServerAction = (params: HandleActionParams) => Promise<any>;
+export type ServerActions = Partial<Record<ActionDefinition['type'], ServerAction>>;
 export interface AppDetails {
     appPath: string;
     organizationId: string;
@@ -416,6 +426,8 @@ export interface Options {
     email: (params: EmailParams) => Promise<void>;
     sendNotifications: (params: SendNotificationsParams) => Promise<void>;
     getAppVariables: (params: GetAppVariablesParams) => Promise<AppConfigEntry[]>;
+    handleAction?: (serverAction: ServerAction, params: HandleActionParams) => Promise<any>;
+    serverActions?: ServerActions;
 }
 export declare class TempFile {
     readonly filename: string;