@harperfast/schema-codegen 1.0.10 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@harperfast/schema-codegen",
-	"version": "1.0.10",
+	"version": "1.1.0",
 	"description": "Generate useful types from your Harper database schemas",
 	"keywords": [],
 	"homepage": "https://github.com/harperfast",
@@ -35,8 +35,8 @@
 		"test:watch": "vitest"
 	},
 	"devDependencies": {
-		"@commitlint/cli": "^20.0.0",
-		"@commitlint/config-conventional": "^20.0.0",
+		"@commitlint/cli": "^21.0.0",
+		"@commitlint/config-conventional": "^21.0.0",
 		"@semantic-release/commit-analyzer": "^13.0.1",
 		"@semantic-release/git": "^10.0.1",
 		"@semantic-release/github": "^12.0.2",
@@ -46,8 +46,7 @@
 		"@types/react": "^19.2.10",
 		"@vitest/coverage-v8": "^4.0.18",
 		"conventional-changelog-conventionalcommits": "^9.1.0",
-		"harperdb": "^4.7.20",
-		"oxfmt": "^0.36.0",
+		"oxfmt": "^0.49.0",
 		"oxlint": "^1.51.0",
 		"semantic-release": "^25.0.2",
 		"vitest": "^4.0.18"

package/utils/generateInterface.js

@@ -2,13 +2,14 @@
 import { isNullable } from './isNullable.js';
 import { mapType } from './mapType.js';
 import { singularize } from './singularize.js';
+import { toIdentifier } from './toIdentifier.js';
 
 /**
  * @param {Table & { databaseName?: string }} table
  */
 export function generateInterface(table) {
-	const pluralRaw = table.tableName;
-	const singularRaw = singularize(pluralRaw);
+	const pluralRaw = toIdentifier(table.tableName);
+	const singularRaw = toIdentifier(singularize(table.tableName));
 	const dbPrefix =
 		table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
 	const plural = `${dbPrefix}${pluralRaw}`;

package/utils/generateJSDoc.js

@@ -2,6 +2,7 @@
 import { isNullable } from './isNullable.js';
 import { mapType } from './mapType.js';
 import { singularize } from './singularize.js';
+import { toIdentifier } from './toIdentifier.js';
 
 /**
  * Generates JSDoc types for a given HarperDB table.
@@ -17,8 +18,8 @@ import { singularize } from './singularize.js';
  * @param {Table & { databaseName?: string }} table
  */
 export function generateJSDoc(table) {
-	const pluralRaw = table.tableName;
-	const singularRaw = singularize(pluralRaw);
+	const pluralRaw = toIdentifier(table.tableName);
+	const singularRaw = toIdentifier(singularize(table.tableName));
 	const dbPrefix =
 		table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
 	const plural = `${dbPrefix}${pluralRaw}`;

package/utils/generateTS.js

@@ -2,6 +2,7 @@
 /** @import { TableMeta } from './tableMeta.js' */
 import { generateInterface } from './generateInterface.js';
 import { singularize } from './singularize.js';
+import { toIdentifier } from './toIdentifier.js';
 
 /**
  * @param {(Table & { databaseName: string })[]} tablesInput
@@ -22,7 +23,7 @@ export function generateTSFromTables(tablesInput, label = 'HarperDB schemas') {
 		const dbPrefix =
 			table.databaseName && table.databaseName !== 'data' ? `${table.databaseName}_` : '';
 		const plural = `${dbPrefix}${table.tableName}`;
-		const singular = `${dbPrefix}${singularize(table.tableName)}`;
+		const singular = `${dbPrefix}${toIdentifier(singularize(table.tableName))}`;
 		tables.push({ plural, singular, databaseName: table.databaseName });
 	}
 

package/utils/generateTablesDTS.js

@@ -8,6 +8,15 @@ import { getLogger } from './logger.js';
  * @param {string} schemaTypesPath
  * @param {TableMeta[]} tables
  */
+/**
+ * Wraps a property name in quotes if it contains characters that are not
+ * valid in an unquoted TypeScript identifier (anything other than word chars).
+ * @param {string} name
+ */
+function safeKey(name) {
+	return /[^\w]/.test(name) ? `'${name}'` : name;
+}
+
 export function generateTablesDTS(globalTypesPath, schemaTypesPath, tables) {
 	let content = `/**
  Generated from your schema files
@@ -45,19 +54,19 @@ export function generateTablesDTS(globalTypesPath, schemaTypesPath, tables) {
 	const dataTables = dbMap.get('data') || [];
 	content += `\texport const tables: {\n`;
 	for (const table of dataTables) {
-		content += `\t\t${table.plural}: { new(...args: any[]): Table<${table.singular}> };\n`;
+		content += `\t\t${safeKey(table.plural)}: { new(...args: any[]): Table<${table.singular}> };\n`;
 	}
 	content += `\t};\n\n`;
 
 	// Export namespaced databases
 	content += `\texport const databases: {\n`;
 	for (const [dbName, dbTables] of dbMap.entries()) {
-		content += `\t\t${dbName}: {\n`;
+		content += `\t\t${safeKey(dbName)}: {\n`;
 		for (const table of dbTables) {
 			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\t${safeKey(pluralRaw)}: { new(...args: any[]): Table<${table.singular}> };\n`;
 		}
 		content += `\t\t};\n`;
 	}

package/utils/toIdentifier.js

@@ -0,0 +1,11 @@
+/**
+ * Converts a name that may contain dashes into a valid TypeScript identifier
+ * by converting kebab-case to camelCase.
+ * e.g. "blog-posts" → "blogPosts", "my-table-name" → "myTableName"
+ * Names without dashes are returned unchanged.
+ * @param {string} name
+ * @returns {string}
+ */
+export function toIdentifier(name) {
+	return name.replace(/-([a-zA-Z0-9])/g, (_, c) => c.toUpperCase());
+}