fix: Remove v1+v2, defaulting to v1, and expand table interface

Author: dawsontoth

config-root.schema.json

@@ -288,7 +288,7 @@
 					"type": "boolean",
 					"description": "Attempt fail-over to different node when unreachable. Default: true"
 				},
-				"shard": { "type": "integer", "description": "Shard id for this instance." },
+				"shard": { "type": ["integer", "null"], "description": "Shard id for this instance." },
 				"logging": { "$ref": "#/definitions/loggerConfig" }
 			}
 		},

index.d.ts

@@ -1,11 +1,12 @@
 export { Resource } from './resources/Resource.ts';
 import { Resource as ResourceImport } from './resources/Resource.ts';
 export type {
-	Query,
 	Context,
+	Query,
+	RequestTargetOrId,
+	Session,
 	SourceContext,
 	SubscriptionRequest,
-	RequestTargetOrId,
 } from './resources/ResourceInterface.ts';
 export { ResourceInterface } from './resources/ResourceInterface.ts';
 export type { User } from './security/user.ts';

package.json

@@ -22,6 +22,9 @@
 	"bin": {
 		"harper": "./dist/bin/harper.js"
 	},
+	"exports": {
+		".": "./index.js"
+	},
 	"files": [
 		"dist",
 		"static",
@@ -94,9 +97,6 @@
 			"onFail": "error"
 		}
 	},
-	"exports": {
-		".": "./dist/index.js"
-	},
 	"devDependencies": {
 		"@harperdb/code-guidelines": "^0.0.6",
 		"@types/gunzip-maybe": "^1.4.3",

resources/ResourceInterface.ts

@@ -30,7 +30,7 @@ export interface ResourceInterface<Record extends object = any>
 	allowUpdate(user: User, record: Promise<Record & RecordObject>, context: Context): boolean | Promise<boolean>;
 	put?(
 		record: Record & RecordObject,
-		target: RequestTargetOrId
+		target?: RequestTargetOrId
 	): void | (Record & Partial<RecordObject>) | Promise<void | (Record & Partial<RecordObject>)>;
 	patch?(
 		record: Partial<Record & RecordObject>,

resources/ResourceInterfaceV2.ts

@@ -5,12 +5,10 @@
  */
 
 import { CONFIG_PARAMS, OPERATIONS_ENUM, SYSTEM_TABLE_NAMES, SYSTEM_SCHEMA_NAME } from '../utility/hdbTerms.ts';
-import { type Database } from 'lmdb';
 import { getIndexedValues } from '../utility/lmdb/commonUtility.js';
 import lodash from 'lodash';
 import { ExtendedIterable, SKIP } from '@harperfast/extended-iterable';
 import type {
-	ResourceInterface,
 	SubscriptionRequest,
 	Id,
 	Context,
@@ -19,6 +17,7 @@ import type {
 	SubSelect,
 	RequestTargetOrId,
 } from './ResourceInterface.ts';
+import { Table as TableType, TableInterface, TableStaticInterface, Attribute } from './TableInterface.ts';
 import type { User } from '../security/user.ts';
 import lmdbProcessRows from '../dataLayer/harperBridge/lmdbBridge/lmdbUtility/lmdbProcessRows.js';
 import { Resource, transformForSelect } from './Resource.ts';
@@ -69,15 +68,6 @@ import { contentTypes } from '../server/serverHelpers/contentTypes';
 const { sortBy } = lodash;
 const { validateAttribute } = lmdbProcessRows;
 
-export type Attribute = {
-	name: string;
-	type: string;
-	assignCreatedTime?: boolean;
-	assignUpdatedTime?: boolean;
-	expiresAt?: boolean;
-	isPrimaryKey?: boolean;
-};
-
 type MaybePromise<T> = T | Promise<T>;
 
 const NULL_WITH_TIMESTAMP = new Uint8Array(9);
@@ -99,31 +89,15 @@ const FULL_PERMISSIONS = {
 	delete: true,
 	isSuperUser: true,
 };
-export interface Table {
-	primaryStore: Database;
-	auditStore: Database;
-	indices: {};
-	databasePath: string;
-	tableName: string;
-	databaseName: string;
-	attributes: any[];
-	primaryKey: string;
-	splitSegments?: boolean;
-	replicate?: boolean;
-	subscriptions: Map<any, Function[]>;
-	expirationMS: number;
-	indexingOperations?: Promise<void>;
-	source?: new () => ResourceInterface;
-	Transaction: ReturnType<typeof makeTable>;
-}
+export { TableType, TableInterface, TableStaticInterface, Attribute };
 type ResidencyDefinition = number | string[] | void;
 
 /**
  * This returns a Table class for the given table settings (determined from the metadata table)
  * Instances of the returned class are Resource instances, intended to provide a consistent view or transaction of the table
  * @param options
  */
-export function makeTable(options) {
+export function makeTable(options): TableStaticInterface {
 	const {
 		primaryKey,
 		indices,
@@ -206,7 +180,7 @@ export function makeTable(options) {
 			return this.addTo(property, -value);
 		}
 	}
-	class TableResource<Record extends object = any> extends Resource<Record> {
+	class TableResource<Record extends object = any> extends Resource<Record> implements TableInterface<Record> {
 		#record: any; // the stored/frozen record from the database and stored in the cache (should not be modified directly)
 		#changes: any; // the changes to the record that have been made (should not be modified directly)
 		#version?: number; // version of the record

resources/ResourceV2.ts

@@ -0,0 +1,80 @@
+import { Database } from 'lmdb';
+import { ResourceInterface, Id, Context } from './ResourceInterface.ts';
+
+export interface Attribute {
+	name: string;
+	type: string;
+	assignCreatedTime?: boolean;
+	assignUpdatedTime?: boolean;
+	expiresAt?: boolean;
+	isPrimaryKey?: boolean;
+}
+
+export interface Table<Record extends object = any> extends TableInterface<Record> {
+	primaryStore: Database;
+	auditStore: Database;
+	indices: {};
+	databasePath: string;
+	tableName: string;
+	databaseName: string;
+	attributes: Attribute[];
+	primaryKey: string;
+	splitSegments?: boolean;
+	replicate?: boolean;
+	subscriptions: Map<any, Function[]>;
+	expirationMS: number;
+	indexingOperations?: Promise<void>;
+	source?: new () => ResourceInterface;
+	Transaction: Table;
+	origin?: string;
+	schemaVersion?: number;
+}
+
+export interface TableInterface<Record extends object = any> extends ResourceInterface<Record> {
+	getUpdatedTime(): number;
+	getExpiresAt(): number;
+}
+
+export interface TableStaticInterface {
+	new <Record extends object = any>(identifier?: Id, source?: any): TableInterface<Record>;
+
+	primaryStore: Database;
+	auditStore: Database;
+	primaryKey: string;
+	tableName: string;
+	tableId: number;
+	indices: any;
+	audit: any;
+	databasePath: string;
+	databaseName: string;
+	attributes: Attribute[];
+	replicate: boolean;
+	sealed: boolean;
+	splitSegments: boolean;
+	createdTimeProperty: Attribute;
+	updatedTimeProperty: Attribute;
+	propertyResolvers: any;
+	userResolvers: any;
+	source?: any;
+	sourceOptions: any;
+	intermediateSource: boolean;
+	getResidencyById: (id: Id) => number | void;
+	expirationMS: number;
+	dbisDB: any;
+	schemaDefined: boolean;
+	indexingOperation?: Promise<void>;
+	origin?: string;
+	schemaVersion?: number;
+
+	addAttributes(attributesToAdd: Attribute[]): Promise<void>;
+	removeAttributes(names: string[]): Promise<void>;
+	getSize(): number;
+	getAuditSize(): number;
+	getStorageStats(): { available: number; free: number; size: number };
+	getRecordCount(options?: {
+		exactCount?: boolean;
+	}): Promise<number | { recordCount: number; estimatedRange: number[] }>;
+	setTTLExpiration(expiration: any): void;
+	sourcedFrom(source: any, options: any): void;
+	getResource(target: any, request: Context, resourceOptions: any): Promise<TableInterface>;
+}

resources/Table.ts

@@ -6,7 +6,7 @@ import { getWorkerIndex } from '../server/threads/manageThreads';
 import { HTTP_STATUS_CODES } from '../utility/errors/commonErrors.js';
 import { ClientError } from '../utility/errors/hdbError.js';
 import harperLogger from '../utility/logging/harper_logger.js';
-import { Attribute } from './Table.ts';
+import { type Attribute, type Table } from './TableInterface.ts';
 import { FileEntry } from '../components/EntryHandler.ts';
 
 const dataLoaderLogger = harperLogger.forComponent('dataLoader');
@@ -15,7 +15,7 @@ const dataLoaderLogger = harperLogger.forComponent('dataLoader');
 const DATA_LOADER_HASH_TABLE = 'hdb_dataloader_hash';
 
 /** Lazy-initialized cache for the hash tracking table */
-let _hashTrackingTable: ReturnType<typeof table>;
+let _hashTrackingTable: Table;
 
 /**
  * Computes a deterministic hash of a record's content for tracking data file changes.
@@ -42,7 +42,7 @@ export function computeRecordHash(record: Record<string, any>): string {
  * Gets or creates the hash tracking table in the system database.
  * Lazy-initializes the table on first access.
  */
-function getHashTrackingTable(databasesRef: Databases) {
+function getHashTrackingTable(databasesRef: Databases): Table {
 	// Always check databasesRef first (important for testing with mocks)
 	if (databasesRef.system && databasesRef.system[DATA_LOADER_HASH_TABLE]) {
 		return databasesRef.system[DATA_LOADER_HASH_TABLE];