@balena/pinejs 19.7.2 → 20.0.0-build-esm-724decc895c0df04c6238f249763a742cc5efa39-1

package/src/bin/odata-compiler.ts

@@ -1,4 +1,4 @@
-import { getAbstractSqlModelFromFile, version, writeAll } from './utils';
+import { getAbstractSqlModelFromFile, version, writeAll } from './utils.js';
 import type {
 	AbstractSqlModel,
 	SqlResult,
@@ -44,7 +44,7 @@ const translateOData = async (
 	outputFile?: string,
 ) => {
 	const request = await generateAbstractSqlQuery(
-		getAbstractSqlModelFromFile(modelFile, program.opts().model),
+		await getAbstractSqlModelFromFile(modelFile, program.opts().model),
 		odata,
 	);
 	const json = JSON.stringify(request.abstractSqlQuery, null, 2);
@@ -68,7 +68,7 @@ const compileOData = async (
 	outputFile?: string,
 ) => {
 	const translatedRequest = await generateAbstractSqlQuery(
-		getAbstractSqlModelFromFile(modelFile, program.opts().model),
+		await getAbstractSqlModelFromFile(modelFile, program.opts().model),
 		odata,
 	);
 	const { compileRequest } = await import('../sbvr-api/abstract-sql.js');

package/src/bin/sbvr-compiler.ts

@@ -1,6 +1,6 @@
-import { version, writeAll, writeSqlModel } from './utils';
+import { version, writeAll, writeSqlModel } from './utils.js';
 import { program } from 'commander';
-import * as fs from 'fs';
+import fs from 'fs';
 
 const getSE = (inputFile: string) => fs.readFileSync(inputFile, 'utf8');
 

package/src/bin/utils.ts

@@ -1,16 +1,18 @@
 process.env.PINEJS_CACHE_FILE =
-	process.env.PINEJS_CACHE_FILE || __dirname + '/.pinejs-cache.json';
+	process.env.PINEJS_CACHE_FILE ||
+	fileURLToPath(new URL('.pinejs-cache.json', import.meta.url));
 
 import type { SqlModel } from '@balena/abstract-sql-compiler';
-import type { Config, Model } from '../config-loader/config-loader';
-import type * as SbvrUtils from '../sbvr-api/sbvr-utils';
+import type { Config, Model } from '../config-loader/config-loader.js';
 import type { AbstractSqlModel } from '@balena/abstract-sql-compiler';
 
-import * as fs from 'fs';
-import * as path from 'path';
-import '../server-glue/sbvr-loader';
+import fs from 'fs';
+import path from 'path';
+import '../server-glue/sbvr-loader.js';
+import { fileURLToPath } from 'url';
+import { loadSBVR } from '../server-glue/sbvr-loader.js';
 
-export { version } from '../config-loader/env';
+export { version } from '../config-loader/env.js';
 
 export const writeAll = (output: string, outputFile?: string): void => {
 	if (outputFile) {
@@ -68,15 +70,21 @@ const getConfigModel = (
 	return fileContents;
 };
 
-export const getAbstractSqlModelFromFile = (
+export const getAbstractSqlModelFromFile = async (
 	modelFile: string,
 	modelName: string | undefined,
-): AbstractSqlModel => {
+): Promise<AbstractSqlModel> => {
 	let fileContents: string | Model | AbstractSqlModel | Config;
 	try {
-		fileContents = require(path.resolve(modelFile));
+		fileContents = await import(path.resolve(modelFile));
 	} catch {
-		fileContents = fs.readFileSync(require.resolve(modelFile), 'utf8');
+		fileContents = await fs.promises.readFile(path.resolve(modelFile), 'utf8');
+		try {
+			// Try to parse the file as JSON
+			fileContents = JSON.parse(fileContents);
+		} catch {
+			// Ignore error as it's likely just a text sbvr file
+		}
 	}
 	let seModel: string;
 	if (fileContents == null) {
@@ -94,16 +102,16 @@ export const getAbstractSqlModelFromFile = (
 		} else if ('modelText' in configModel && configModel.modelText != null) {
 			seModel = configModel.modelText;
 		} else if ('modelFile' in configModel && configModel.modelFile != null) {
-			seModel = fs.readFileSync(require.resolve(configModel.modelFile), 'utf8');
+			seModel = await loadSBVR(configModel.modelFile, import.meta);
 		} else {
 			throw new Error('Unrecognized config file');
 		}
 	} else {
 		throw new Error('Unrecognized config file');
 	}
-	const { generateLfModel, generateAbstractSqlModel } =
-		// eslint-disable-next-line @typescript-eslint/no-var-requires
-		require('../sbvr-api/sbvr-utils') as typeof SbvrUtils;
+	const { generateLfModel, generateAbstractSqlModel } = await import(
+		'../sbvr-api/sbvr-utils.js'
+	);
 	let lfModel;
 	try {
 		lfModel = generateLfModel(seModel);

package/src/config-loader/config-loader.ts

@@ -1,15 +1,15 @@
-import type * as Express from 'express';
+import type Express from 'express';
 import type {
 	AbstractSqlModel,
 	Definition,
 } from '@balena/abstract-sql-compiler';
-import type { Database } from '../database-layer/db';
+import type { Database } from '../database-layer/db.js';
 import type {
 	AnyObject,
 	Dictionary,
 	RequiredField,
 	Resolvable,
-} from '../sbvr-api/common-types';
+} from '../sbvr-api/common-types.js';
 
 import {
 	type Migration,
@@ -18,23 +18,23 @@ import {
 	MigrationCategories,
 	isSyncMigration,
 	isAsyncMigration,
-} from '../migrator/utils';
+} from '../migrator/utils.js';
 
-import * as fs from 'fs';
+import fs from 'fs';
 import _ from 'lodash';
-import * as path from 'path';
+import path from 'path';
 
-import * as sbvrUtils from '../sbvr-api/sbvr-utils';
+import * as sbvrUtils from '../sbvr-api/sbvr-utils.js';
 
-import * as permissions from '../sbvr-api/permissions';
+import * as permissions from '../sbvr-api/permissions.js';
 import {
 	getDefaultHandler,
 	getUploaderMiddlware,
 	type WebResourceHandler,
 	setupUploadHooks,
 	setupWebresourceHandler,
-} from '../webresource-handler';
-import type { AliasValidNodeType } from '../sbvr-api/translations';
+} from '../webresource-handler/index.js';
+import type { AliasValidNodeType } from '../sbvr-api/translations.js';
 
 export type SetupFunction = (
 	app: Express.Application,
@@ -256,7 +256,7 @@ export const setup = (app: Express.Application) => {
 						let customCode: SetupFunction;
 						if (typeof model.customServerCode === 'string') {
 							try {
-								customCode = nodeRequire(model.customServerCode).setup;
+								customCode = (await import(model.customServerCode)).setup;
 							} catch (e: any) {
 								e.message = `Error loading custom server code: '${e.message}'`;
 								throw e;
@@ -291,7 +291,7 @@ export const setup = (app: Express.Application) => {
 			let root: string;
 			let configObj: Config;
 			if (config == null) {
-				root = path.resolve(process.argv[2]) || __dirname;
+				root = path.resolve(process.argv[2]) || import.meta.dirname;
 				configObj = await loadConfigFile(path.join(root, 'config.json'));
 			} else if (typeof config === 'string') {
 				root = path.dirname(config);

package/src/config-loader/env.ts

@@ -1,6 +1,6 @@
-import * as fs from 'fs';
+import { promises as fs } from 'fs';
 export const { version } = JSON.parse(
-	fs.readFileSync(require.resolve('../../package.json'), 'utf8'),
+	await fs.readFile(new URL(import.meta.resolve('../../package.json')), 'utf8'),
 );
 
 const { PINEJS_DEBUG } = process.env;
@@ -56,7 +56,7 @@ export const cache = {
 
 import { boolVar, intVar } from '@balena/env-parsing';
 import memoize from 'memoizee';
-import memoizeWeak from 'memoizee/weak';
+import memoizeWeak from 'memoizee/weak.js';
 export const createCache = <T extends (...args: any[]) => any>(
 	cacheName: keyof typeof cache,
 	fn: T,

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

@@ -1,8 +1,8 @@
-import * as permissions from '../sbvr-api/permissions';
-import type { Resolvable } from '../sbvr-api/common-types';
+import * as permissions from '../sbvr-api/permissions.js';
+import type { Resolvable } from '../sbvr-api/common-types.js';
 import type { Handler } from 'express';
-import type { Config, SetupFunction } from '../config-loader/config-loader';
-import type { Tx } from '../database-layer/db';
+import type { Config, SetupFunction } from '../config-loader/config-loader.js';
+import type { Tx } from '../database-layer/db.js';
 
 const uiModel = `\
 Vocabulary: ui

package/src/database-layer/db.ts

@@ -1,15 +1,15 @@
 /// <references types="websql"/>
-import type * as Mysql from 'mysql';
-import type * as Pg from 'pg';
-import type * as PgConnectionString from 'pg-connection-string';
-import type { Dictionary, Resolvable } from '../sbvr-api/common-types';
+import type Mysql from 'mysql';
+import type Pg from 'pg';
+import type PgConnectionString from 'pg-connection-string';
+import type { Dictionary, Resolvable } from '../sbvr-api/common-types.js';
 
 import { Engines } from '@balena/abstract-sql-compiler';
 import { EventEmitter } from 'eventemitter3';
 import _ from 'lodash';
 import { TypedError } from 'typed-error';
-import * as env from '../config-loader/env';
-import { fromCallback, timeout } from '../sbvr-api/control-flow';
+import * as env from '../config-loader/env.js';
+import { fromCallback, timeout } from '../sbvr-api/control-flow.js';
 
 export const metrics = new EventEmitter();
 
@@ -487,8 +487,10 @@ const createTransaction = (createFunc: CreateTransactionFn): TransactionFn => {
 };
 
 let maybePg: typeof Pg | undefined;
+let maybePgConnectionString: typeof PgConnectionString | undefined;
 try {
-	maybePg = require('pg');
+	maybePg = (await import('pg')).default;
+	maybePgConnectionString = (await import('pg-connection-string')).default;
 } catch {
 	// Ignore errors
 }
@@ -543,10 +545,15 @@ if (maybePg != null) {
 		let pool: Pg.Pool;
 		let replica: Pg.Pool;
 		if (typeof connectString === 'string') {
-			// eslint-disable-next-line @typescript-eslint/no-var-requires
-			const pgConnectionString: typeof PgConnectionString = require('pg-connection-string');
+			if (maybePgConnectionString == null) {
+				throw new Error(
+					'pg-connection-string is required for string connection strings',
+				);
+			}
 			// We have to cast because of the use of null vs undefined
-			const config = pgConnectionString.parse(connectString) as Pg.PoolConfig;
+			const config = maybePgConnectionString.parse(
+				connectString,
+			) as Pg.PoolConfig;
 			pool = initPool(config);
 		} else {
 			const config = connectString;
@@ -728,7 +735,7 @@ if (maybePg != null) {
 
 let maybeMysql: typeof Mysql | undefined;
 try {
-	maybeMysql = require('mysql');
+	maybeMysql = (await import('mysql')).default;
 } catch {
 	// Ignore errors
 }

package/src/extended-sbvr-parser/extended-sbvr-parser.ts

@@ -1,9 +1,9 @@
 import { SBVRParser } from '@balena/sbvr-parser';
-import { requireSBVR } from '../server-glue/sbvr-loader';
-import { version as sbvrParserVersion } from '@balena/sbvr-parser/package.json';
-import { version } from '../config-loader/env';
+import { importSBVR } from '../server-glue/sbvr-loader.js';
+import SbvrParserPackage from '@balena/sbvr-parser/package.json' with { type: 'json' };
+import { version } from '../config-loader/env.js';
 
-const Types = requireSBVR('@balena/sbvr-types/Type.sbvr', require);
+const Types = await importSBVR('@balena/sbvr-types/Type.sbvr', import.meta);
 
 export const ExtendedSBVRParser = SBVRParser._extend({
 	initialize() {
@@ -13,5 +13,5 @@ export const ExtendedSBVRParser = SBVRParser._extend({
 		this.AddBuiltInVocab(Types);
 		return this;
 	},
-	version: sbvrParserVersion + '+' + version,
+	version: SbvrParserPackage.version + '+' + version,
 });

package/src/http-transactions/transactions.js

@@ -1,8 +1,8 @@
 import { odataNameToSqlName } from '@balena/odata-to-abstract-sql';
-import { requireSBVR } from '../server-glue/sbvr-loader';
-const transactionModel = requireSBVR('./transaction.sbvr', require);
+import { importSBVR } from '../server-glue/sbvr-loader.js';
+const transactionModel = await importSBVR('./transaction.sbvr', import.meta);
 
-/** @type {import('../config-loader/config-loader').Config} */
+/** @type {import('../config-loader/config-loader.js').Config} */
 export const config = {
 	models: [
 		{
@@ -53,7 +53,7 @@ ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT N
 /** @type {(modelName: string) => void} */
 export let addModelHooks;
 
-/** @type { import('../config-loader/config-loader').SetupFunction } */
+/** @type { import('../config-loader/config-loader.js').SetupFunction } */
 export function setup(app, sbvrUtils) {
 	addModelHooks = (modelName) => {
 		// TODO: Add checks on POST/PATCH requests as well.

package/src/migrator/async.ts

@@ -1,8 +1,8 @@
-import type { Tx } from '../database-layer/db';
-import type { Model } from '../config-loader/config-loader';
+import type { Tx } from '../database-layer/db.js';
+import type { Model } from '../config-loader/config-loader.js';
 
 import _ from 'lodash';
-import * as sbvrUtils from '../sbvr-api/sbvr-utils';
+import * as sbvrUtils from '../sbvr-api/sbvr-utils.js';
 
 type ApiRootModel = Model & { apiRoot: string };
 
@@ -24,8 +24,8 @@ import {
 	filterAndSortPendingMigrations,
 	type MigrationStatus,
 	type BaseAsyncMigration,
-} from './utils';
-import { booleanToEnabledString } from '../config-loader/env';
+} from './utils.js';
+import { booleanToEnabledString } from '../config-loader/env.js';
 
 export const run = async (tx: Tx, model: ApiRootModel): Promise<void> => {
 	const { migrations } = model;

package/src/migrator/sync.ts

@@ -1,4 +1,4 @@
-import type MigrationsModel from './migrations';
+import type MigrationsModel from './migrations.js';
 import {
 	type MigrationTuple,
 	MigrationError,
@@ -9,15 +9,15 @@ import {
 	type RunnableMigrations,
 	filterAndSortPendingMigrations,
 	getRunnableSyncMigrations,
-} from './utils';
-import type { Tx } from '../database-layer/db';
-import type { Config, Model } from '../config-loader/config-loader';
+} from './utils.js';
+import type { Tx } from '../database-layer/db.js';
+import type { Config, Model } from '../config-loader/config-loader.js';
 
 import _ from 'lodash';
-import * as sbvrUtils from '../sbvr-api/sbvr-utils';
-import { requireSBVR } from '../server-glue/sbvr-loader';
+import * as sbvrUtils from '../sbvr-api/sbvr-utils.js';
+import { importSBVR } from '../server-glue/sbvr-loader.js';
 
-const migrationsModel = requireSBVR('./migrations.sbvr', require);
+const migrationsModel = await importSBVR('./migrations.sbvr', import.meta);
 
 type ApiRootModel = Model & { apiRoot: string };
 
@@ -137,7 +137,7 @@ const executeMigration = async (
 	}
 };
 
-declare module '../sbvr-api/sbvr-utils' {
+declare module '../sbvr-api/sbvr-utils.js' {
 	export interface API {
 		[migrationModelConfig.apiRoot]: PinejsClient<MigrationsModel>;
 	}

package/src/migrator/utils.ts

@@ -1,16 +1,16 @@
-import type { Result, Tx } from '../database-layer/db';
-import type { Resolvable } from '../sbvr-api/common-types';
+import type { Result, Tx } from '../database-layer/db.js';
+import type { Resolvable } from '../sbvr-api/common-types.js';
 
 import { createHash } from 'crypto';
 import { Engines } from '@balena/abstract-sql-compiler';
 import _ from 'lodash';
 import { TypedError } from 'typed-error';
-import { migrator as migratorEnv } from '../config-loader/env';
-export { migrator as migratorEnv } from '../config-loader/env';
-import { PINEJS_ADVISORY_LOCK } from '../config-loader/env';
-import { delay } from '../sbvr-api/control-flow';
+import { migrator as migratorEnv } from '../config-loader/env.js';
+export { migrator as migratorEnv } from '../config-loader/env.js';
+import { PINEJS_ADVISORY_LOCK } from '../config-loader/env.js';
+import { delay } from '../sbvr-api/control-flow.js';
 
-import * as sbvrUtils from '../sbvr-api/sbvr-utils';
+import * as sbvrUtils from '../sbvr-api/sbvr-utils.js';
 export enum MigrationCategories {
 	'sync' = 'sync',
 	'async' = 'async',

package/src/odata-metadata/odata-metadata-generator.ts

@@ -3,8 +3,9 @@ import type {
 	AbstractSqlTable,
 } from '@balena/abstract-sql-compiler';
 
-import sbvrTypes, { type SbvrType } from '@balena/sbvr-types';
-import { version } from '../config-loader/env';
+import type { SbvrType } from '@balena/sbvr-types';
+import { sbvrTypes } from '../sbvr-api/sbvr-utils.js';
+import { version } from '../config-loader/env.js';
 
 const getResourceName = (resourceName: string): string =>
 	resourceName

package/src/passport-pinejs/mount-login-router.ts

@@ -1,7 +1,7 @@
-import * as passportPinejs from './passport-pinejs';
+import * as passportPinejs from './passport-pinejs.js';
 import type { Express } from 'express';
-import { PinejsSessionStore } from '../pinejs-session-store/pinejs-session-store';
-import type { setup } from '../config-loader/config-loader';
+import { PinejsSessionStore } from '../pinejs-session-store/pinejs-session-store.js';
+import type { setup } from '../config-loader/config-loader.js';
 
 export const mountLoginRouter = async (
 	configLoader: ReturnType<typeof setup>,

package/src/passport-pinejs/passport-pinejs.ts

@@ -1,10 +1,10 @@
-import type * as Express from 'express';
-import type * as Passport from 'passport';
-import type * as PassportLocal from 'passport-local';
-import type * as ConfigLoader from '../config-loader/config-loader';
-import type { User } from '../sbvr-api/sbvr-utils';
+import type Express from 'express';
+import type Passport from 'passport';
+import type PassportLocal from 'passport-local';
+import type * as ConfigLoader from '../config-loader/config-loader.js';
+import type { User } from '../sbvr-api/sbvr-utils.js';
 
-import * as permissions from '../sbvr-api/permissions';
+import * as permissions from '../sbvr-api/permissions.js';
 
 // Returns a middleware that will handle logging in using `username` and `password` body properties
 export let login: (

package/src/pinejs-session-store/pinejs-session-store.ts

@@ -1,9 +1,9 @@
-import type { Config } from '../config-loader/config-loader';
-import type { AnyObject } from '../sbvr-api/common-types';
+import type { Config } from '../config-loader/config-loader.js';
+import type { AnyObject } from '../sbvr-api/common-types.js';
 
 import { Store } from 'express-session';
-import * as permissions from '../sbvr-api/permissions';
-import { api } from '../sbvr-api/sbvr-utils';
+import * as permissions from '../sbvr-api/permissions.js';
+import { api } from '../sbvr-api/sbvr-utils.js';
 
 export { Store };
 

package/src/sbvr-api/abstract-sql.ts

@@ -1,18 +1,18 @@
 import _ from 'lodash';
 
-import * as AbstractSQLCompiler from '@balena/abstract-sql-compiler';
+import AbstractSQLCompiler from '@balena/abstract-sql-compiler';
 import type { BindKey } from '@balena/odata-parser';
 import {
 	type ODataBinds,
 	odataNameToSqlName,
 	isBindReference,
 } from '@balena/odata-to-abstract-sql';
-import deepFreeze = require('deep-freeze');
+import deepFreeze from 'deep-freeze';
 import memoize from 'memoizee';
-import * as env from '../config-loader/env';
-import { BadRequestError, SqlCompilationError } from './errors';
-import * as sbvrUtils from './sbvr-utils';
-import type { ODataRequest } from './uri-parser';
+import * as env from '../config-loader/env.js';
+import { BadRequestError, SqlCompilationError } from './errors.js';
+import * as sbvrUtils from './sbvr-utils.js';
+import type { ODataRequest } from './uri-parser.js';
 
 const getMemoizedCompileRule = memoize(
 	(engine: AbstractSQLCompiler.Engines) =>

package/src/sbvr-api/cached-compile.ts

@@ -1,4 +1,4 @@
-import type * as Fs from 'fs';
+import type Fs from 'fs';
 
 import _ from 'lodash';
 
@@ -12,7 +12,7 @@ let cache: null | {
 } = null;
 let fs: undefined | typeof Fs;
 try {
-	fs = require('fs');
+	fs = await import('fs');
 } catch {
 	// Ignore error
 }

package/src/sbvr-api/control-flow.ts

@@ -1,4 +1,4 @@
-import type { Resolvable } from './common-types';
+import type { Resolvable } from './common-types.js';
 
 import _ from 'lodash';
 import { TypedError } from 'typed-error';

package/src/sbvr-api/errors.ts

@@ -1,4 +1,4 @@
-import type { AnyObject, Tail } from './common-types';
+import type { AnyObject, Tail } from './common-types.js';
 
 import { TypedError } from 'typed-error';
 

package/src/sbvr-api/express-extension.ts

@@ -3,7 +3,7 @@
 declare global {
 	// eslint-disable-next-line @typescript-eslint/no-namespace
 	namespace Express {
-		type PineUser = import('./sbvr-utils').User;
+		type PineUser = import('./sbvr-utils.js').User;
 
 		// Augment Express.User to include the props of our PineUser.
 		// eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -11,7 +11,7 @@ declare global {
 
 		interface Request {
 			user?: User;
-			apiKey?: import('./sbvr-utils').ApiKey;
+			apiKey?: import('./sbvr-utils.js').ApiKey;
 		}
 	}
 }

package/src/sbvr-api/hooks.ts

@@ -1,12 +1,12 @@
-import type { OptionalField, Resolvable } from './common-types';
-import type { Result, Tx } from '../database-layer/db';
-import type { ODataRequest, ParsedODataRequest } from './uri-parser';
+import type { OptionalField, Resolvable } from './common-types.js';
+import type { Result, Tx } from '../database-layer/db.js';
+import type { ODataRequest, ParsedODataRequest } from './uri-parser.js';
 import type { AnyObject } from 'pinejs-client-core';
 import type { TypedError } from 'typed-error';
 import type { SupportedMethod } from '@balena/odata-to-abstract-sql';
 
 import _ from 'lodash';
-import { settleMapSeries } from './control-flow';
+import { settleMapSeries } from './control-flow.js';
 import memoize from 'memoizee';
 import {
 	type User,
@@ -15,7 +15,7 @@ import {
 	getAbstractSqlModel,
 	api,
 	type Response,
-} from './sbvr-utils';
+} from './sbvr-utils.js';
 
 export interface HookReq {
 	user?: User;

package/src/sbvr-api/odata-response.ts

@@ -18,13 +18,17 @@ declare module '@balena/abstract-sql-compiler' {
 	}
 }
 
-import type { Result, Row } from '../database-layer/db';
+import type { Result, Row } from '../database-layer/db.js';
 
 import { sqlNameToODataName } from '@balena/odata-to-abstract-sql';
-import sbvrTypes, { type SbvrType } from '@balena/sbvr-types';
+import type { SbvrType } from '@balena/sbvr-types';
 import _ from 'lodash';
-import { resolveNavigationResource, resolveSynonym } from './sbvr-utils';
-import { getWebresourceHandler } from '../webresource-handler';
+import {
+	sbvrTypes,
+	resolveNavigationResource,
+	resolveSynonym,
+} from './sbvr-utils.js';
+import { getWebresourceHandler } from '../webresource-handler/index.js';
 
 const checkForExpansion = async (
 	vocab: string,