@harperfast/schema-codegen 1.0.2 → 1.0.5

package/README.md

@@ -75,11 +75,11 @@ import type { Track } from './types.ts';
 
 declare module 'harperdb' {
 	export const tables: {
-		Tracks: { new(...args: any[]): Table<Track> };
+		Tracks: { new (...args: any[]): Table<Track> };
 	};
 	export const databases: {
 		data: {
-			Tracks: { new(...args: any[]): Table<Track> };
+			Tracks: { new (...args: any[]): Table<Track> };
 		};
 	};
 }

package/extensionModule.js

@@ -1,7 +1,7 @@
 /** @typedef {import('harperdb').Scope} Scope */
+import { setTimeout as delay } from 'node:timers/promises';
 import { setLogger } from './utils/logger.js';
 import { regenerateAll } from './utils/regenerateAll.js';
-import { sleep } from './utils/sleep.js';
 
 export const suppressHandleApplicationWarning = true;
 
@@ -18,8 +18,10 @@ export async function handleApplication(scope) {
 
 	const watchConfig = scope.options.get(['watch']);
 	const shouldWatch = watchConfig === true || watchConfig === undefined;
-	const globalTypes = /** @type {string} */ (scope.options.get(['globalTypes'])) || './schema.globalTypes.d.ts';
-	const schemaTypes = /** @type {string} */ (scope.options.get(['schemaTypes'])) || './schema.types.ts';
+	const globalTypes = /** @type {string} */ (scope.options.get(['globalTypes'])) ||
+	'./schema.globalTypes.d.ts';
+	const schemaTypes = /** @type {string} */ (scope.options.get(['schemaTypes'])) ||
+	'./schema.types.ts';
 	const jsdoc = /** @type {string | undefined} */ (scope.options.get(['jsdoc']));
 
 	if (shouldWatch) {
@@ -27,18 +29,17 @@ export async function handleApplication(scope) {
 	}
 
 	// Do not await this.
-	sleep(500)
-		.then(() => {
-			// Initial generation
-			regenerateAll(globalTypes, schemaTypes, jsdoc);
-
-			if (shouldWatch) {
-				// Watch for schema/database changes via events
-				scope.databaseEvents.on('updateTable', updateTable);
-				scope.databaseEvents.on('dropTable', dropTable);
-				scope.databaseEvents.on('dropDatabase', dropDatabase);
-			}
-		});
+	delay(500).then(() => {
+		// Initial generation
+		regenerateAll(globalTypes, schemaTypes, jsdoc);
+
+		if (shouldWatch) {
+			// Watch for schema/database changes via events
+			scope.databaseEvents.on('updateTable', updateTable);
+			scope.databaseEvents.on('dropTable', dropTable);
+			scope.databaseEvents.on('dropDatabase', dropDatabase);
+		}
+	});
 
 	function updateTable() {
 		regenerateAll(globalTypes, schemaTypes, jsdoc);

package/package.json

@@ -1,24 +1,36 @@
 {
 	"name": "@harperfast/schema-codegen",
-	"version": "1.0.2",
+	"version": "1.0.5",
+	"description": "Generate useful types from your Harper database schemas",
+	"keywords": [],
+	"homepage": "https://github.com/harperfast",
+	"bugs": {
+		"url": "https://github.com/harperfast/schema-codegen/issues"
+	},
+	"license": "Apache-2.0",
+	"author": {
+		"name": "Harper",
+		"email": "support@harperdb.io"
+	},
+	"repository": "github:HarperFast/schema-codegen",
+	"files": [
+		"extensionModule.js",
+		"config.yaml",
+		"utils/",
+		"!utils/**/*.test.js"
+	],
 	"type": "module",
 	"scripts": {
 		"commitlint": "commitlint --edit",
-		"format:check": "dprint check",
-		"format:fix": "dprint fmt",
-		"format:staged": "dprint check --staged --allow-no-files",
+		"format:check": "oxfmt --check",
+		"format:fix": "oxfmt --write",
+		"format:staged": "oxfmt --check --list-different",
 		"lint:check": "oxlint .",
 		"lint:fix": "oxlint . --fix",
 		"test": "vitest run",
 		"test:coverage": "vitest run --coverage",
 		"test:watch": "vitest"
 	},
-	"files": [
-		"extensionModule.js",
-		"config.yaml",
-		"utils/",
-		"!utils/**/*.test.js"
-	],
 	"devDependencies": {
 		"@commitlint/cli": "^20.0.0",
 		"@commitlint/config-conventional": "^20.0.0",
@@ -31,8 +43,8 @@
 		"@types/react": "^19.2.10",
 		"@vitest/coverage-v8": "^4.0.18",
 		"conventional-changelog-conventionalcommits": "^9.1.0",
-		"dprint": "^0.52.0",
 		"harperdb": "^4.7.20",
+		"oxfmt": "^0.36.0",
 		"oxlint": "^1.51.0",
 		"semantic-release": "^25.0.2",
 		"vitest": "^4.0.18"

package/utils/collectTables.js

@@ -1,5 +1,4 @@
 /** @typedef {import('harperdb').Table} Table */
-import { databases as hdbDatabases } from 'harperdb';
 
 /**
  * @returns {(Table & { databaseName: string })[]}
@@ -7,13 +6,14 @@ import { databases as hdbDatabases } from 'harperdb';
 export function collectTables() {
 	/** @type {(Table & { databaseName: string })[]} */
 	const tablesList = [];
-	for (const dbName of Object.keys(hdbDatabases || {})) {
-		const tables = hdbDatabases[dbName];
+	for (const databaseName of Object.keys(databases || {})) {
+		const tables = databases[databaseName];
 		for (const tableName of Object.keys(tables || {})) {
 			const TableClass = tables[tableName];
-			if (!TableClass?.attributes) { continue; }
-			TableClass.databaseName = dbName;
-			tablesList.push(/** @type {Table & { databaseName: string }} */ (TableClass));
+			if (!TableClass?.attributes) {
+				continue;
+			}
+			tablesList.push(TableClass);
 		}
 	}
 	return tablesList;

package/utils/generateInterface.js

@@ -9,7 +9,8 @@ import { singularize } from './singularize.js';
 export function generateInterface(table) {
 	const pluralRaw = table.tableName;
 	const singularRaw = singularize(pluralRaw);
-	const dbPrefix = table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
+	const dbPrefix =
+		table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
 	const plural = `${dbPrefix}${pluralRaw}`;
 	const singular = `${dbPrefix}${singularRaw}`;
 	const isDifferent = plural !== singular;

package/utils/generateJSDoc.js

@@ -19,7 +19,8 @@ import { singularize } from './singularize.js';
 export function generateJSDoc(table) {
 	const pluralRaw = table.tableName;
 	const singularRaw = singularize(pluralRaw);
-	const dbPrefix = table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
+	const dbPrefix =
+		table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
 	const plural = `${dbPrefix}${pluralRaw}`;
 	const singular = `${dbPrefix}${singularRaw}`;
 	const isDifferent = plural !== singular;

package/utils/generateJSDocFromTables.js

@@ -7,10 +7,7 @@ import { singularize } from './singularize.js';
  * @param {(Table & { databaseName: string })[]} tablesInput
  * @param {string} label
  */
-export function generateJSDocFromTables(
-	tablesInput,
-	label = 'HarperDB schemas',
-) {
+export function generateJSDocFromTables(tablesInput, label = 'HarperDB schemas') {
 	let jsCode = `/**
  Generated from ${label}
  Manual changes will be lost!
@@ -21,7 +18,8 @@ export function generateJSDocFromTables(
 
 	for (const table of tablesInput) {
 		jsCode += generateJSDoc(table);
-		const dbPrefix = table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
+		const dbPrefix =
+			table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
 		const plural = `${dbPrefix}${table.tableName}`;
 		const singular = `${dbPrefix}${singularize(table.tableName)}`;
 		tables.push({ plural, singular, databaseName: table.databaseName });

package/utils/generateTS.js

@@ -8,10 +8,7 @@ import { singularize } from './singularize.js';
  * @param {string} label
  * @returns {{ tsCode: string, tables: TableMeta[] }}
  */
-export function generateTSFromTables(
-	tablesInput,
-	label = 'HarperDB schemas',
-) {
+export function generateTSFromTables(tablesInput, label = 'HarperDB schemas') {
 	let tsCode = `/**
  Generated from ${label}
  Manual changes will be lost!
@@ -22,7 +19,8 @@ export function generateTSFromTables(
 
 	for (const table of tablesInput) {
 		tsCode += generateInterface(table);
-		const dbPrefix = table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
+		const dbPrefix =
+			table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
 		const plural = `${dbPrefix}${table.tableName}`;
 		const singular = `${dbPrefix}${singularize(table.tableName)}`;
 		tables.push({ plural, singular, databaseName: table.databaseName });

package/utils/generateTablesDTS.js

@@ -1,6 +1,6 @@
 /** @import { TableMeta } from './tableMeta.js' */
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 import { getLogger } from './logger.js';
 
 /**
@@ -54,7 +54,9 @@ export function generateTablesDTS(globalTypesPath, schemaTypesPath, tables) {
 	for (const [dbName, dbTables] of dbMap.entries()) {
 		content += `\t\t${dbName}: {\n`;
 		for (const table of dbTables) {
-			const pluralRaw = table.plural.startsWith(`${dbName}_`) ? table.plural.slice(dbName.length + 1) : table.plural;
+			const pluralRaw = table.plural.startsWith(`${dbName}_`)
+				? table.plural.slice(dbName.length + 1)
+				: table.plural;
 			content += `\t\t\t${pluralRaw}: { new(...args: any[]): Table<${table.singular}> };\n`;
 		}
 		content += `\t\t};\n`;
@@ -64,7 +66,7 @@ export function generateTablesDTS(globalTypesPath, schemaTypesPath, tables) {
 	content += `}\n`;
 	const outPath = globalTypesPath;
 	const dir = path.dirname(outPath);
-	if (!fs.existsSync(dir)) { fs.mkdirSync(dir, { recursive: true }); }
+	fs.mkdirSync(dir, { recursive: true });
 	const existingContent = fs.existsSync(outPath) && fs.readFileSync(outPath, 'utf8');
 	if (existingContent !== content) {
 		fs.writeFileSync(outPath, content, 'utf8');

package/utils/isNullable.js

@@ -5,6 +5,8 @@
  */
 export function isNullable(attribute) {
 	// Primary keys are always required
-	if (attribute.isPrimaryKey) { return false; }
+	if (attribute.isPrimaryKey) {
+		return false;
+	}
 	return !!attribute.nullable || attribute.nullable === undefined;
 }

package/utils/mapType.js

@@ -6,7 +6,9 @@ import { singularize } from './singularize.js';
  * @returns {string}
  */
 function mapObjectType(properties) {
-	if (!properties || properties.length === 0) { return 'Record<string, any>'; }
+	if (!properties?.length) {
+		return 'Record<string, any>';
+	}
 	const fields = properties
 		.map((prop) => {
 			const optional = prop.isPrimaryKey ? false : !!prop.nullable;
@@ -21,7 +23,8 @@ function mapObjectType(properties) {
  * @returns {string}
  */
 export function mapType(attribute) {
-	const name = attribute?.type || 'Any';
+	if (!attribute) return 'any';
+	const name = attribute.type || 'Any';
 	switch (name) {
 		case 'String':
 		case 'ID':

package/utils/regenerateAll.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import { collectTables } from './collectTables.js';
 import { generateJSDocFromTables } from './generateJSDocFromTables.js';
 import { generateTablesDTS } from './generateTablesDTS.js';

package/utils/singularize.js

@@ -55,7 +55,12 @@ export function singularize(word) {
 		return word.slice(0, -3) + 'y';
 	}
 	if (word.endsWith('es')) {
-		if (word.endsWith('xes') || word.endsWith('ses') || word.endsWith('ches') || word.endsWith('shes')) {
+		if (
+			word.endsWith('xes') ||
+			word.endsWith('ses') ||
+			word.endsWith('ches') ||
+			word.endsWith('shes')
+		) {
 			return word.slice(0, -2);
 		}
 	}

package/utils/writeIfChanged.js

@@ -1,5 +1,5 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 import { getLogger } from './logger.js';
 
 /**
@@ -8,7 +8,7 @@ import { getLogger } from './logger.js';
  */
 export function writeIfChanged(filePath, content) {
 	const dir = path.dirname(filePath);
-	if (!fs.existsSync(dir)) { fs.mkdirSync(dir, { recursive: true }); }
+	fs.mkdirSync(dir, { recursive: true });
 	const existing = fs.existsSync(filePath) ? fs.readFileSync(filePath, 'utf8') : undefined;
 	if (existing !== content) {
 		fs.writeFileSync(filePath, content, 'utf8');

package/utils/sleep.js

@@ -1,6 +0,0 @@
-/**
- * @param {number} ms
- */
-export function sleep(ms) {
-	return new Promise(resolve => setTimeout(resolve, ms));
-}