@balena/odata-to-abstract-sql 7.1.6 → 7.1.7

package/.lintstagedrc

@@ -1,7 +1,4 @@
 {
-	"*.js": [
-		"balena-lint --fix"
-	],
 	"*.ts": [
 		"balena-lint --fix"
 	]

package/.versionbot/CHANGELOG.yml

@@ -1,3 +1,71 @@
+- commits:
+    - subject: "Tests: convert test/filterby to typescript"
+      hash: 92d206795a7e7f60da03a874785f364d995a2180
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: "Tests: convert test/expand to typescript"
+      hash: 04c310f3383173b67d69af394582c48e8724feb0
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: "Tests: convert test/orderby to typescript"
+      hash: a95840abc03109b1c719bed30b1e388c31fa69e0
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: "Tests: convert test/resource_parsing to typescript"
+      hash: e70202afdfa112c4e182abaf8ab7ff843faf56a8
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: "Tests: convert test/select to typescript"
+      hash: 12d873a51539f043143738fb632fb0d44952c6bc
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: "Tests: convert test/paging to typescript"
+      hash: a74eb53a5c4f0728d5aabb6e6e9748bd6ef28a86
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: "Tests: convert test/stress to typescript"
+      hash: 43402fa7238daa8c200781bdd42a29a409676fbc
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: "Tests: convert test/chai-sql to typescript"
+      hash: d9d203864ef9d29f7a993c69b4951e575bf8a0c1
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+  version: 7.1.7
+  title: ""
+  date: 2025-04-02T14:01:23.215Z
 - commits:
     - subject: Support path expressions of resources with 0..1 cardinality in
         $select/$filter/$orderby
@@ -55,7 +123,7 @@
       nested: []
   version: 7.1.6
   title: ""
-  date: 2025-03-28T05:44:00.263Z
+  date: 2025-03-28T05:47:18.848Z
 - commits:
     - subject: Fix translation of Resource -> Table when using a computed term
       hash: 1ece1c36cee6650d5ec72ba767842bb15fdcc953
@@ -1804,6 +1872,7 @@
 
 
 
+
                                                                 As balena-lint
                                                                 rejects `new
                                                                 Boolean()`, `new
@@ -1831,6 +1900,7 @@
 
 
 
+
                                                                 As engine and npm is
                                                                 now required as part
                                                                 of package.json we
@@ -1873,6 +1943,7 @@
 
 
 
+
                                                                 Ensure that the
                                                                 input passed in for
                                                                 JSON types is either
@@ -1978,6 +2049,7 @@
 
 
 
+
                                                                 This also deprecates
                                                                 the legacy version
                                                               footer:
@@ -2011,6 +2083,7 @@
 
 
 
+
                                                                 It can in fact be a
                                                                 lot of different
                                                                 things and that is
@@ -2045,6 +2118,7 @@
 
 
 
+
                                                                 We know what type
                                                                 they return and they
                                                                 should be explicitly
@@ -2084,6 +2158,7 @@
 
 
 
+
                                                                 Update
                                                                 @balena/sbvr-types
                                                                 from 3.4.18 to 3.5.0
@@ -2234,6 +2309,7 @@
 
 
 
+
                                                                 This also deprecates
                                                                 the legacy use of
                                                                 direct true/false

package/CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file
 automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 7.1.7 - 2025-04-02
+
+* Tests: convert test/filterby to typescript [Pagan Gazzard]
+* Tests: convert test/expand to typescript [Pagan Gazzard]
+* Tests: convert test/orderby to typescript [Pagan Gazzard]
+* Tests: convert test/resource_parsing to typescript [Pagan Gazzard]
+* Tests: convert test/select to typescript [Pagan Gazzard]
+* Tests: convert test/paging to typescript [Pagan Gazzard]
+* Tests: convert test/stress to typescript [Pagan Gazzard]
+* Tests: convert test/chai-sql to typescript [Pagan Gazzard]
+
 ## 7.1.6 - 2025-03-28
 
 

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@balena/odata-to-abstract-sql",
-  "version": "7.1.6",
+  "version": "7.1.7",
   "description": "A consumer of the OData parser, written in OMeta",
   "type": "commonjs",
   "main": "out/odata-to-abstract-sql.js",
   "scripts": {
-    "lint": "balena-lint -e js -e ts src test && tsc --noEmit && tsc --noEmit --project tsconfig.js.json",
-    "lint-fix": "balena-lint -e js -e ts --fix src test",
+    "lint": "balena-lint src test && tsc --noEmit && tsc --noEmit --project tsconfig.js.json",
+    "lint-fix": "balena-lint --fix src test",
     "pretest": "npm run prepare",
     "test": "mocha && npm run lint",
     "prepublish": "require-npm4-to-publish",
@@ -47,13 +47,14 @@
     "recursive": true,
     "require": "ts-node/register/transpile-only",
     "bail": true,
-    "_": "test/*.js"
+    "exclude": "test/**/*.d.ts",
+    "_": "test/**/*.ts"
   },
   "engines": {
     "node": ">=20.14.0",
     "npm": ">=10.7.0"
   },
   "versionist": {
-    "publishedAt": "2025-03-28T05:44:01.363Z"
+    "publishedAt": "2025-04-02T14:01:23.667Z"
   }
 }

package/test/{chai-sql.js → chai-sql.ts}

@@ -5,6 +5,19 @@ import fs from 'fs';
 import { createTranslator } from '@balena/lf-to-abstract-sql';
 import { SBVRParser } from '@balena/sbvr-parser';
 import sbvrTypes from '@balena/sbvr-types';
+import type {
+	AliasNode,
+	BindNode,
+	BooleanNode,
+	CountNode,
+	DateNode,
+	DateTruncNode,
+	DurationNode,
+	NullNode,
+	NumberNode,
+	ReferencedFieldNode,
+	TextNode,
+} from '@balena/abstract-sql-compiler';
 
 chai.use(chaiThings);
 
@@ -15,12 +28,12 @@ chai.use(function ($chai, utils) {
 		const obj = utils.flag(this, 'object');
 		return expect(obj).to.be.an.instanceof(Array);
 	});
-	const queryType = (type) =>
+	const queryType = (type: string) =>
 		function () {
 			const obj = utils.flag(this, 'object');
 			return expect(obj).to.contain.something.that.equals(type);
 		};
-	const bodyClause = (bodyType) =>
+	const bodyClause = (bodyType: string) =>
 		function (...bodyClauses) {
 			const obj = utils.flag(this, 'object');
 			if (bodyClauses.length === 0) {
@@ -39,7 +52,7 @@ chai.use(function ($chai, utils) {
 			}
 			return this;
 		};
-	const multiBodyClause = (bodyType) =>
+	const multiBodyClause = (bodyType: string) =>
 		function (...bodyClauses) {
 			const obj = utils.flag(this, 'object');
 			expect(obj).to.contain.something.that.deep.equals(
@@ -48,7 +61,7 @@ chai.use(function ($chai, utils) {
 			);
 			return this;
 		};
-	const binaryClause = (bodyType) =>
+	const binaryClause = (bodyType: string) =>
 		function (...bodyClauses) {
 			const obj = utils.flag(this, 'object');
 			for (let i = 0; i < bodyClauses.length; i++) {
@@ -112,7 +125,7 @@ chai.use(function ($chai, utils) {
 	utils.addMethod(assertionPrototype, 'offset', bodyClause('Offset'));
 });
 
-const generateClientModel = function (input) {
+const generateClientModel = function (input: string) {
 	const typeVocab = fs.readFileSync(
 		require.resolve('@balena/sbvr-types/Type.sbvr'),
 		'utf8',
@@ -149,25 +162,36 @@ clientModel.tables['copilot'].fields.push({
 	computed: ['Text', 'Junior'],
 });
 
-const odataNameToSqlName = (odataName) =>
+const odataNameToSqlName = (odataName: string) =>
 	odataName.replace(/__/g, '-').replace(/_/g, ' ');
 
-export function sqlNameToOdataName(sqlName) {
+export function sqlNameToOdataName(sqlName: string) {
 	return sqlName.replace(/-/g, '__').replace(/ /g, '_');
 }
 
+type AbstractSqlBind =
+	| BindNode
+	| NullNode
+	| DateTruncNode
+	| ReferencedFieldNode
+	| DurationNode;
 export function operandToAbstractSQLFactory(
-	binds = [],
+	binds: Array<BooleanNode | NumberNode | DateNode | NullNode | TextNode> = [],
 	defaultResource = 'pilot',
 	defaultParentAlias = defaultResource,
 ) {
-	let operandToAbstractSQL;
-	return (operandToAbstractSQL = function (
-		operand,
+	const operandToAbstractSQL = function (
+		operand:
+			| string
+			| number
+			| boolean
+			| Date
+			| [string, string, string]
+			| { abstractsql: AbstractSqlBind },
 		resource = defaultResource,
 		parentAlias = defaultParentAlias,
-	) {
-		if (operand.abstractsql != null) {
+	): AbstractSqlBind | AbstractSqlBind[] {
+		if (typeof operand === 'object' && 'abstractsql' in operand) {
 			return operand.abstractsql;
 		}
 		if (typeof operand === 'boolean') {
@@ -183,7 +207,6 @@ export function operandToAbstractSQLFactory(
 			return ['Bind', binds.length - 1];
 		}
 		if (typeof operand === 'string') {
-			let mapping;
 			if (operand === 'null') {
 				return ['Null'];
 			}
@@ -191,13 +214,13 @@ export function operandToAbstractSQLFactory(
 				return operand
 					.slice(1, -1)
 					.split(',')
-					.map(function (op) {
+					.map(function (op): AbstractSqlBind {
 						const n = parseInt(op, 10);
 						if (Number.isFinite(n)) {
-							return operandToAbstractSQL(n);
+							return operandToAbstractSQL(n) as AbstractSqlBind;
 						}
 
-						return operandToAbstractSQL(op);
+						return operandToAbstractSQL(op) as AbstractSqlBind;
 					});
 			}
 
@@ -208,6 +231,7 @@ export function operandToAbstractSQLFactory(
 				]);
 				return ['Bind', binds.length - 1];
 			}
+			let mapping;
 			const fieldParts = operand.split('/');
 			if (fieldParts.length > 1) {
 				let alias = parentAlias;
@@ -241,10 +265,10 @@ export function operandToAbstractSQLFactory(
 				return [
 					'DateTrunc',
 					['EmbeddedText', 'milliseconds'],
-					['ReferencedField'].concat(mapping),
+					['ReferencedField', ...mapping] as ReferencedFieldNode,
 				];
 			}
-			return ['ReferencedField'].concat(mapping);
+			return ['ReferencedField', ...mapping] as ReferencedFieldNode;
 		}
 		if (Array.isArray(operand)) {
 			return operandToAbstractSQL(...operand);
@@ -253,10 +277,11 @@ export function operandToAbstractSQLFactory(
 			return ['Duration', operand];
 		}
 		throw new Error('Unknown operand type: ' + operand);
-	});
+	};
+	return operandToAbstractSQL;
 }
 
-export const operandToOData = function (operand) {
+export const operandToOData = function (operand): string {
 	if (operand.odata != null) {
 		return operand.odata;
 	}
@@ -267,7 +292,7 @@ export const operandToOData = function (operand) {
 		return operandToOData(operand[0]);
 	}
 	if (operand !== null && typeof operand === 'object') {
-		const duration = [];
+		const duration: string[] = [];
 		let t = false;
 		if (operand.negative) {
 			duration.push('-');
@@ -302,7 +327,7 @@ export const operandToOData = function (operand) {
 	return operand;
 };
 
-export const shortenAlias = function (alias) {
+export const shortenAlias = function (alias: string) {
 	while (alias.length >= 64) {
 		alias = alias
 			.replace(/(^|[^-])pilot/, '$1pi')
@@ -312,7 +337,11 @@ export const shortenAlias = function (alias) {
 };
 
 export const aliasFields = (function () {
-	const aliasField = function (resourceAlias, verb, field) {
+	const aliasField = function (
+		resourceAlias: string,
+		verb: string,
+		field: Fields[number],
+	): Fields[number] {
 		if (field[0] === 'ReferencedField') {
 			return [
 				field[0],
@@ -321,12 +350,16 @@ export const aliasFields = (function () {
 			];
 		}
 		if (field[0] === 'Alias') {
-			return ['Alias', aliasField(resourceAlias, verb, field[1]), field[2]];
+			return [
+				'Alias',
+				aliasField(resourceAlias, verb, field[1]) as ReferencedFieldNode,
+				field[2],
+			];
 		} else {
 			return field;
 		}
 	};
-	return function (resourceAlias, fields, verb) {
+	return function (resourceAlias: string, fields: Fields, verb?: string) {
 		if (verb != null) {
 			verb = verb + '-';
 		} else {
@@ -336,7 +369,9 @@ export const aliasFields = (function () {
 	};
 })();
 
-export const pilotFields = [
+type Fields = Array<ReferencedFieldNode | AliasNode<ReferencedFieldNode>>;
+
+export const pilotFields: Fields = [
 	['Alias', ['ReferencedField', 'pilot', 'created at'], 'created_at'],
 	['Alias', ['ReferencedField', 'pilot', 'modified at'], 'modified_at'],
 	['ReferencedField', 'pilot', 'id'],
@@ -359,21 +394,21 @@ export const pilotFields = [
 	],
 ];
 
-export const licenceFields = [
+export const licenceFields: Fields = [
 	['Alias', ['ReferencedField', 'licence', 'created at'], 'created_at'],
 	['Alias', ['ReferencedField', 'licence', 'modified at'], 'modified_at'],
 	['ReferencedField', 'licence', 'id'],
 	['ReferencedField', 'licence', 'name'],
 ];
 
-export const planeFields = [
+export const planeFields: Fields = [
 	['Alias', ['ReferencedField', 'plane', 'created at'], 'created_at'],
 	['Alias', ['ReferencedField', 'plane', 'modified at'], 'modified_at'],
 	['ReferencedField', 'plane', 'id'],
 	['ReferencedField', 'plane', 'name'],
 ];
 
-export const pilotCanFlyPlaneFields = [
+export const pilotCanFlyPlaneFields: Fields = [
 	[
 		'Alias',
 		['ReferencedField', 'pilot-can fly-plane', 'created at'],
@@ -393,7 +428,7 @@ export const pilotCanFlyPlaneFields = [
 	['ReferencedField', 'pilot-can fly-plane', 'id'],
 ];
 
-export const teamFields = [
+export const teamFields: Fields = [
 	['Alias', ['ReferencedField', 'team', 'created at'], 'created_at'],
 	['Alias', ['ReferencedField', 'team', 'modified at'], 'modified_at'],
 	[
@@ -403,9 +438,11 @@ export const teamFields = [
 	],
 ];
 
-export const $count = [['Alias', ['Count', '*'], '$count']];
+export const $count: [AliasNode<CountNode>] = [
+	['Alias', ['Count', '*'], '$count'],
+];
 
-export const copilotFields = [
+export const copilotFields: Fields = [
 	['Alias', ['ReferencedField', 'copilot', 'created at'], 'created_at'],
 	['Alias', ['ReferencedField', 'copilot', 'modified at'], 'modified_at'],
 	['ReferencedField', 'copilot', 'id'],

package/test/{expand.js → expand.ts}

@@ -557,10 +557,6 @@ test('/pilot?$expand=licence/$count($top=5)', (result) => {
 // Alias tests
 (function () {
 	const remainingPilotFields = _.reject(pilotFields, function (field) {
-		if (field.length === 2) {
-			// @ts-expect-error Assign field with stil valid AbstractSql
-			field = field[1];
-		}
 		return field[2] === 'pilot';
 	});
 	const recursions = 9;

package/test/{filterby.js → filterby.ts}

@@ -16,11 +16,11 @@ let operandToAbstractSQLFactory = $operandToAbstractSQLFactory;
 import test from './test';
 import _ from 'lodash';
 
-let operandToAbstractSQL = null;
+let operandToAbstractSQL: ReturnType<typeof operandToAbstractSQLFactory>;
 
 const run = (function () {
 	let running = false;
-	return function (keyBinds, fn) {
+	return function (keyBinds, fn?) {
 		if (fn == null) {
 			fn = keyBinds;
 			keyBinds = [];
@@ -99,7 +99,7 @@ const createMethodCall = function (method, ...args) {
 			method +
 			'(' +
 			(() => {
-				const result = [];
+				const result: string[] = [];
 				for (arg of args) {
 					result.push(operandToOData(arg));
 				}
@@ -125,7 +125,7 @@ const createMethodCall = function (method, ...args) {
 	};
 };
 
-const operandTest = (lhs, op, rhs) =>
+const operandTest = (lhs, op?, rhs?) =>
 	run(function () {
 		const { odata, abstractsql } = createExpression(lhs, op, rhs);
 		test('/pilot?$filter=' + odata, (result) => {
@@ -230,7 +230,7 @@ test(`/pilot?$filter=startswith(p/name,'test1')`, (result) => {
 	});
 });
 
-const navigatedOperandTest = (lhs, op, rhs) => {
+const navigatedOperandTest = (lhs, op?, rhs?) => {
 	run(function () {
 		const { odata, abstractsql } = createExpression(lhs, op, rhs);
 		test('/pilot?$filter=' + odata, (result) => {
@@ -268,10 +268,10 @@ const navigatedOperandTest = (lhs, op, rhs) => {
 	});
 };
 
-const methodTest = (...args) =>
+const methodTest = (...args: Parameters<typeof createMethodCall>) =>
 	run(() => operandTest(createMethodCall(...args)));
 
-const navigatedMethodTest = (...args) =>
+const navigatedMethodTest = (...args: Parameters<typeof createMethodCall>) =>
 	run(() => {
 		navigatedOperandTest(createMethodCall(...args));
 	});

package/test/{select.js → select.ts}

@@ -9,8 +9,8 @@ import _ from 'lodash';
 
 const operandToAbstractSQL = operandToAbstractSQLFactory();
 
-const pilotName = _.filter(pilotFields, { 2: 'name' })[0];
-const pilotAge = _.filter(pilotFields, { 2: 'age' })[0];
+const pilotName = pilotFields.filter((field) => field[2] === 'name')[0];
+const pilotAge = pilotFields.filter((field) => field[2] === 'age')[0];
 test('/pilot?$select=name', (result) => {
 	it('should select name from pilot', () => {
 		expect(result).to.be.a.query.that.selects([pilotName]).from('pilot');

package/tsconfig.js.json

@@ -3,12 +3,11 @@
 	"compilerOptions": {
 		"noImplicitAny": false,
 		"noImplicitThis": false,
-		"strictFunctionTypes": false,
-		"checkJs": true
+		"strictFunctionTypes": false
 	},
 	"include": [
 		"*",
-		"src/*",
+		"src/**/*",
 		"test/**/*"
 	],
 }

package/tsconfig.json

@@ -11,8 +11,7 @@
 		"sourceMap": true,
 		"declaration": true,
 		"skipLibCheck": true,
-		"outDir": "out",
-		"allowJs": true
+		"outDir": "out"
 	},
 	"include": ["src/**/*"],
 	"exclude": ["node_modules"]