@balena/pinejs 17.1.0-build-joshbwlng-tasks-e3dcb0e73ea9c960af553c67cbf7121650f8d1ea-1 → 17.1.0-build-model-based-typings-c276ef4fb8482a246c25940d617d76b76847eff8-1

package/src/config-loader/env.ts

@@ -49,7 +49,7 @@ export const cache = {
 	apiKeyActorId: false as CacheOpts,
 };
 
-import { boolVar, intVar } from '@balena/env-parsing';
+import { boolVar } from '@balena/env-parsing';
 import memoize from 'memoizee';
 import memoizeWeak = require('memoizee/weak');
 export const createCache = <T extends (...args: any[]) => any>(
@@ -146,8 +146,3 @@ export const migrator = {
 	 */
 	asyncMigrationIsEnabled: boolVar('PINEJS_ASYNC_MIGRATION_ENABLED', true),
 };
-
-export const tasks = {
-	queueConcurrency: intVar('PINEJS_QUEUE_CONCURRENCY', 0),
-	queueIntervalMS: intVar('PINEJS_QUEUE_INTERVAL_MS', 1000),
-};

package/src/data-server/sbvr-server.js

@@ -133,14 +133,15 @@ export async function setup(app, sbvrUtils, db) {
 						},
 					},
 				})
-				.then(async (/** @type { Array<{ [key: string]: any }> } */ result) => {
+				.then(async (result) => {
 					if (result.length === 0) {
 						throw new Error('No SE data model found');
 					}
 					const instance = result[0];
 					await sbvrUtils.executeModel(tx, {
 						apiRoot: instance.is_of__vocabulary,
-						modelText: instance.model_value.value,
+						// prettier-ignore
+						modelText: /** @type { string } */ (instance.model_value.value),
 					});
 				});
 			await isServerOnAir(true);

package/src/database-layer/db.ts

@@ -98,13 +98,6 @@ export interface Database extends BaseDatabase {
 	) => Promise<Result>;
 	transaction: TransactionFn;
 	readTransaction: TransactionFn;
-	on?: (
-		name: 'notification',
-		fn: (...args: any[]) => Promise<void>,
-		options?: {
-			channel?: string;
-		},
-	) => void;
 }
 
 interface EngineParams {
@@ -696,24 +689,6 @@ if (maybePg != null) {
 		return {
 			engine: Engines.postgres,
 			executeSql: atomicExecuteSql,
-			on: async (name, fn, options) => {
-				if (name === 'notification' && options?.channel === undefined) {
-					throw new Error('Missing channel option for notification listener');
-				}
-
-				const client = await pool.connect();
-				client.on(name, async (msg) => {
-					try {
-						await fn(msg);
-					} catch (error) {
-						console.error('Error handling message:', error);
-					}
-				});
-
-				if (name === 'notification' && options?.channel !== undefined) {
-					await client.query(`LISTEN "${options.channel}";`);
-				}
-			},
 			transaction: createTransaction(async (stackTraceErr) => {
 				const client = await pool.connect();
 				const tx = new PostgresTx(client, false, stackTraceErr);

package/src/migrator/migrations.ts

@@ -0,0 +1,64 @@
+// These types were generated by @balena/abstract-sql-to-typescript v3.2.1
+
+import type { Types } from '@balena/abstract-sql-to-typescript';
+
+export interface Migration {
+	Read: {
+		created_at: Types['Date Time']['Read'];
+		modified_at: Types['Date Time']['Read'];
+		model_name: Types['Short Text']['Read'];
+		executed_migrations: Types['JSON']['Read'];
+	};
+	Write: {
+		created_at: Types['Date Time']['Write'];
+		modified_at: Types['Date Time']['Write'];
+		model_name: Types['Short Text']['Write'];
+		executed_migrations: Types['JSON']['Write'];
+	};
+}
+
+export interface MigrationLock {
+	Read: {
+		created_at: Types['Date Time']['Read'];
+		modified_at: Types['Date Time']['Read'];
+		model_name: Types['Short Text']['Read'];
+	};
+	Write: {
+		created_at: Types['Date Time']['Write'];
+		modified_at: Types['Date Time']['Write'];
+		model_name: Types['Short Text']['Write'];
+	};
+}
+
+export interface MigrationStatus {
+	Read: {
+		created_at: Types['Date Time']['Read'];
+		modified_at: Types['Date Time']['Read'];
+		migration_key: Types['Short Text']['Read'];
+		start_time: Types['Date Time']['Read'] | null;
+		last_run_time: Types['Date Time']['Read'] | null;
+		run_count: Types['Integer']['Read'];
+		migrated_row_count: Types['Integer']['Read'] | null;
+		error_count: Types['Integer']['Read'] | null;
+		is_backing_off: Types['Boolean']['Read'];
+		converged_time: Types['Date Time']['Read'] | null;
+	};
+	Write: {
+		created_at: Types['Date Time']['Write'];
+		modified_at: Types['Date Time']['Write'];
+		migration_key: Types['Short Text']['Write'];
+		start_time: Types['Date Time']['Write'] | null;
+		last_run_time: Types['Date Time']['Write'] | null;
+		run_count: Types['Integer']['Write'];
+		migrated_row_count: Types['Integer']['Write'] | null;
+		error_count: Types['Integer']['Write'] | null;
+		is_backing_off: Types['Boolean']['Write'];
+		converged_time: Types['Date Time']['Write'] | null;
+	};
+}
+
+export default interface $Model {
+	migration: Migration;
+	migration_lock: MigrationLock;
+	migration_status: MigrationStatus;
+}

package/src/migrator/sync.ts

@@ -1,3 +1,4 @@
+import type MigrationsModel from './migrations';
 import {
 	type MigrationTuple,
 	MigrationError,
@@ -16,7 +17,7 @@ import _ from 'lodash';
 import * as sbvrUtils from '../sbvr-api/sbvr-utils';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const modelText = require('./migrations.sbvr');
+const migrationsModel = require('./migrations.sbvr');
 
 type ApiRootModel = Model & { apiRoot: string };
 
@@ -136,45 +137,49 @@ const executeMigration = async (
 	}
 };
 
-export const config: Config = {
-	models: [
-		{
-			modelName: 'migrations',
-			apiRoot: 'migrations',
-			modelText,
-			migrations: {
-				'11.0.0-modified-at': `
-					ALTER TABLE "migration"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-				`,
-				'11.0.1-modified-at': `
-					ALTER TABLE "migration lock"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-				`,
-				'15.0.0-data-types': async (tx, { db }) => {
-					switch (db.engine) {
-						case 'mysql':
-							await tx.executeSql(`\
-								ALTER TABLE "migration"
-								MODIFY "executed migrations" JSON NOT NULL;`);
-							await tx.executeSql(`\
-								ALTER TABLE "migration status"
-								MODIFY "is backing off" BOOLEAN NOT NULL;`);
-							break;
-						case 'postgres':
-							await tx.executeSql(`\
-								ALTER TABLE "migration"
-								ALTER COLUMN "executed migrations" SET DATA TYPE JSONB USING "executed migrations"::JSONB;`);
-							await tx.executeSql(`\
-								ALTER TABLE "migration status"
-								ALTER COLUMN "is backing off" DROP DEFAULT,
-								ALTER COLUMN "is backing off" SET DATA TYPE BOOLEAN USING "is backing off"::BOOLEAN,
-								ALTER COLUMN "is backing off" SET DEFAULT FALSE;`);
-							break;
-						// No need to migrate for websql
-					}
-				},
-			},
+declare module '../sbvr-api/sbvr-utils' {
+	export interface API {
+		[migrationModelConfig.apiRoot]: PinejsClient<MigrationsModel>;
+	}
+}
+const migrationModelConfig = {
+	modelName: 'migrations',
+	apiRoot: 'migrations',
+	modelText: migrationsModel,
+	migrations: {
+		'11.0.0-modified-at': `
+			ALTER TABLE "migration"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+		`,
+		'11.0.1-modified-at': `
+			ALTER TABLE "migration lock"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+		`,
+		'15.0.0-data-types': async (tx, { db }) => {
+			switch (db.engine) {
+				case 'mysql':
+					await tx.executeSql(`\
+						ALTER TABLE "migration"
+						MODIFY "executed migrations" JSON NOT NULL;`);
+					await tx.executeSql(`\
+						ALTER TABLE "migration status"
+						MODIFY "is backing off" BOOLEAN NOT NULL;`);
+					break;
+				case 'postgres':
+					await tx.executeSql(`\
+						ALTER TABLE "migration"
+						ALTER COLUMN "executed migrations" SET DATA TYPE JSONB USING "executed migrations"::JSONB;`);
+					await tx.executeSql(`\
+						ALTER TABLE "migration status"
+						ALTER COLUMN "is backing off" DROP DEFAULT,
+						ALTER COLUMN "is backing off" SET DATA TYPE BOOLEAN USING "is backing off"::BOOLEAN,
+						ALTER COLUMN "is backing off" SET DEFAULT FALSE;`);
+					break;
+				// No need to migrate for websql
+			}
 		},
-	],
+	},
+} as const satisfies sbvrUtils.ExecutableModel;
+export const config: Config = {
+	models: [migrationModelConfig],
 };

package/src/sbvr-api/dev.ts

@@ -0,0 +1,26 @@
+// These types were generated by @balena/abstract-sql-to-typescript v3.2.1
+
+import type { Types } from '@balena/abstract-sql-to-typescript';
+
+export interface Model {
+	Read: {
+		created_at: Types['Date Time']['Read'];
+		modified_at: Types['Date Time']['Read'];
+		id: Types['Serial']['Read'];
+		is_of__vocabulary: Types['Short Text']['Read'];
+		model_type: Types['Short Text']['Read'];
+		model_value: Types['JSON']['Read'];
+	};
+	Write: {
+		created_at: Types['Date Time']['Write'];
+		modified_at: Types['Date Time']['Write'];
+		id: Types['Serial']['Write'];
+		is_of__vocabulary: Types['Short Text']['Write'];
+		model_type: Types['Short Text']['Write'];
+		model_value: Types['JSON']['Write'];
+	};
+}
+
+export default interface $Model {
+	model: Model;
+}

package/src/sbvr-api/hooks.ts

@@ -9,7 +9,6 @@ import _ from 'lodash';
 import { settleMapSeries } from './control-flow';
 import memoize from 'memoizee';
 import {
-	type PinejsClient,
 	type User,
 	type ApiKey,
 	resolveSynonym,
@@ -31,25 +30,27 @@ export interface HookReq {
 	hooks?: InstantiatedHooks;
 	is?: (type: string | string[]) => string | false | null;
 }
-export interface HookArgs {
+export interface HookArgs<Vocab extends string = string> {
 	req: HookReq;
 	request: ODataRequest;
-	api: PinejsClient;
+	api: (typeof api)[Vocab];
 	tx?: Tx | undefined;
 }
 export type HookResponse = PromiseLike<any> | null | void;
 
-export interface Hooks {
-	PREPARSE?: (options: Omit<HookArgs, 'request' | 'api'>) => HookResponse;
-	POSTPARSE?: (options: HookArgs) => HookResponse;
-	PRERUN?: (options: HookArgs & { tx: Tx }) => HookResponse;
+export interface Hooks<Vocab extends string = string> {
+	PREPARSE?: (
+		options: Omit<HookArgs<Vocab>, 'request' | 'api'>,
+	) => HookResponse;
+	POSTPARSE?: (options: HookArgs<Vocab>) => HookResponse;
+	PRERUN?: (options: HookArgs<Vocab> & { tx: Tx }) => HookResponse;
 	/** These are run in reverse translation order from newest to oldest */
 	POSTRUN?: (
-		options: HookArgs & { tx: Tx; result: Result | number | undefined },
+		options: HookArgs<Vocab> & { tx: Tx; result: Result | number | undefined },
 	) => HookResponse;
 	/** These are run in reverse translation order from newest to oldest */
 	PRERESPOND?: (
-		options: HookArgs & {
+		options: HookArgs<Vocab> & {
 			tx: Tx;
 			result?: Result | number | AnyObject;
 			/** This can be mutated to modify the response sent to the client */
@@ -58,7 +59,7 @@ export interface Hooks {
 	) => HookResponse;
 	/** These are run in reverse translation order from newest to oldest */
 	'POSTRUN-ERROR'?: (
-		options: HookArgs & { tx: Tx; error: TypedError | any },
+		options: HookArgs<Vocab> & { tx: Tx; error: TypedError | any },
 	) => HookResponse;
 }
 export type HookBlueprints = {
@@ -264,9 +265,9 @@ const apiHooks = {
 // Share hooks between merge and patch since they are the same operation,
 // just MERGE was the OData intermediary until the HTTP spec added PATCH.
 apiHooks.MERGE = apiHooks.PATCH;
-export const addHook = (
+export const addHook = <Vocab extends string>(
 	method: keyof typeof apiHooks,
-	vocabulary: string,
+	vocabulary: Vocab,
 	resourceName: string,
 	hooks:
 		| { [key in keyof Hooks]: HookBlueprint<NonNullable<Hooks[key]>> }
@@ -345,11 +346,11 @@ export const addHook = (
 	getHooks.clear();
 };
 
-export const addSideEffectHook = (
+export const addSideEffectHook = <Vocab extends string>(
 	method: HookMethod,
-	apiRoot: string,
+	apiRoot: Vocab,
 	resourceName: string,
-	hooks: Hooks,
+	hooks: Hooks<NoInfer<Vocab>>,
 ): void => {
 	addHook(method, apiRoot, resourceName, {
 		...hooks,
@@ -358,11 +359,11 @@ export const addSideEffectHook = (
 	});
 };
 
-export const addPureHook = (
+export const addPureHook = <Vocab extends string>(
 	method: HookMethod,
-	apiRoot: string,
+	apiRoot: Vocab,
 	resourceName: string,
-	hooks: Hooks,
+	hooks: Hooks<NoInfer<Vocab>>,
 ): void => {
 	addHook(method, apiRoot, resourceName, {
 		...hooks,

package/src/sbvr-api/permissions.ts

@@ -1,3 +1,4 @@
+import type AuthModel from './user';
 import type {
 	AbstractSqlModel,
 	AbstractSqlQuery,
@@ -51,6 +52,7 @@ import {
 	type ODataRequest,
 } from './uri-parser';
 import memoizeWeak = require('memoizee/weak');
+import type { Config } from '../config-loader/config-loader';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const userModel: string = require('./user.sbvr');
@@ -1118,7 +1120,7 @@ const memoizedGetConstrainedModel = (
 	getBoundConstrainedMemoizer(abstractSqlModel)(permissionsLookup, vocabulary);
 
 const getCheckPasswordQuery = _.once(() =>
-	sbvrUtils.api.Auth.prepare<{ username: string }>({
+	sbvrUtils.api.Auth.prepare<{ username: string }, 'user'>({
 		resource: 'user',
 		passthrough: {
 			req: rootRead,
@@ -1164,7 +1166,7 @@ export const checkPassword = async (
 
 const $getUserPermissions = (() => {
 	const getUserPermissionsQuery = _.once(() =>
-		sbvrUtils.api.Auth.prepare<{ userId: number }>({
+		sbvrUtils.api.Auth.prepare<{ userId: number }, 'permission'>({
 			resource: 'permission',
 			passthrough: {
 				req: rootRead,
@@ -1275,7 +1277,7 @@ export const getUserPermissions = async (
 
 const $getApiKeyPermissions = (() => {
 	const getApiKeyPermissionsQuery = _.once(() =>
-		sbvrUtils.api.Auth.prepare<{ apiKey: string }>({
+		sbvrUtils.api.Auth.prepare<{ apiKey: string }, 'permission'>({
 			resource: 'permission',
 			passthrough: {
 				req: rootRead,
@@ -1403,7 +1405,7 @@ export const getApiKeyPermissions = async (
 
 const getApiKeyActorId = (() => {
 	const getApiKeyActorIdQuery = _.once(() =>
-		sbvrUtils.api.Auth.prepare<{ apiKey: string }>({
+		sbvrUtils.api.Auth.prepare<{ apiKey: string }, 'api_key'>({
 			resource: 'api_key',
 			passthrough: {
 				req: rootRead,
@@ -1586,7 +1588,7 @@ let guestPermissionsInitialized = false;
 const getGuestPermissions = memoize(
 	async () => {
 		// Get guest user
-		const result = (await sbvrUtils.api.Auth.get({
+		const result = await sbvrUtils.api.Auth.get({
 			resource: 'user',
 			passthrough: {
 				req: rootRead,
@@ -1597,7 +1599,7 @@ const getGuestPermissions = memoize(
 			options: {
 				$select: 'id',
 			},
-		})) as { id: number } | undefined;
+		});
 		if (result == null) {
 			throw new Error('No guest user');
 		}
@@ -1686,49 +1688,53 @@ export const addPermissions = async (
 	}
 };
 
+declare module './sbvr-utils' {
+	export interface API {
+		[authModelConfig.apiRoot]: PinejsClient<AuthModel>;
+	}
+}
+const authModelConfig = {
+	apiRoot: 'Auth',
+	modelText: userModel,
+	customServerCode: exports,
+	migrations: {
+		'11.0.0-modified-at': `
+			ALTER TABLE "actor"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+
+			ALTER TABLE "api key"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+			ALTER TABLE "api key-has-permission"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+			ALTER TABLE "api key-has-role"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+
+			ALTER TABLE "permission"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+
+			ALTER TABLE "role"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+
+			ALTER TABLE "user"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+			ALTER TABLE "user-has-role"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+			ALTER TABLE "user-has-permission"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+		`,
+		'11.0.1-modified-at': `
+			ALTER TABLE "role-has-permission"
+			ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
+		`,
+		'14.42.0-api-key-expiry-date': `
+			ALTER TABLE "api key"
+			ADD COLUMN IF NOT EXISTS "expiry date" TIMESTAMP NULL;
+		`,
+	},
+} as const satisfies sbvrUtils.ExecutableModel;
 export const config = {
-	models: [
-		{
-			apiRoot: 'Auth',
-			modelText: userModel,
-			customServerCode: exports,
-			migrations: {
-				'11.0.0-modified-at': `
-					ALTER TABLE "actor"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-
-					ALTER TABLE "api key"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-					ALTER TABLE "api key-has-permission"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-					ALTER TABLE "api key-has-role"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-
-					ALTER TABLE "permission"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-
-					ALTER TABLE "role"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-
-					ALTER TABLE "user"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-					ALTER TABLE "user-has-role"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-					ALTER TABLE "user-has-permission"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-				`,
-				'11.0.1-modified-at': `
-					ALTER TABLE "role-has-permission"
-					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
-				`,
-				'14.42.0-api-key-expiry-date': `
-					ALTER TABLE "api key"
-					ADD COLUMN IF NOT EXISTS "expiry date" TIMESTAMP NULL;
-				`,
-			},
-		},
-	] as sbvrUtils.ExecutableModel[],
-};
+	models: [authModelConfig],
+} satisfies Config;
 export const setup = () => {
 	addHook('all', 'all', 'all', {
 		sideEffects: false,