wirejs-resources 0.1.34-table-resource → 0.1.36-table-resource

package/dist/index.d.ts

@@ -6,6 +6,6 @@ export { withContext, requiresContext, Context, ContextWrapped } from './adapter
 export { Resource } from './resource.js';
 export { overrides } from './overrides.js';
 export { Secret } from './resources/secret.js';
-export { DistributedTable, DistributedTableOptions, Filter, FieldComparison, FieldComparisonOptions, FieldType, Parser, PassThruParser, RecordType, RecordKey, matchesFilter, } from './resources/distributed-table.js';
+export { AnyKeyFieldOption, DistributedTable, DistributedTableOptions, Filter, FieldComparison, FieldComparisonOptions, FieldType, KeyFieldDefinition, KeyFieldOptions, Parser, PassThruParser, PKFieldTypes, RecordType, RecordKey, matchesFilter, } from './resources/distributed-table.js';
 export * from './types.js';
 export * from './derived-types.js';

package/dist/resources/distributed-table.d.ts

@@ -1,14 +1,29 @@
 import { Resource } from '../resource.js';
+export type KindaPretty<T> = T extends object ? {
+    [K in keyof T]: KindaPretty<T[K]>;
+} : T;
+export type PKFieldTypes = 'string' | 'number';
 export type DistributedTableOptions<T> = {
     parse: Parser<T>;
     key: {
-        partition: keyof T & string;
-        sort?: (keyof T & string)[];
+        partition: AnyKeyFieldOption<T>;
+        sort?: AnyKeyFieldOption<T>;
     };
 };
+export type KeyFieldOptions<T> = {
+    [K in keyof T as K extends string ? K : never]: K extends string ? KeyFieldDefinition<T, K, T[K]> : never;
+};
+export type AnyKeyFieldOption<T> = KeyFieldOptions<T>[keyof KeyFieldOptions<T>];
+export type KeyFieldDefinition<T, FieldName extends string & keyof T, FieldType> = FieldType extends number ? {
+    field: FieldName & keyof T;
+    type: 'number';
+} : {
+    field: FieldName & keyof T;
+    type: 'string';
+};
 export type Parser<T> = (record: Record<string, any>) => T;
 export type RecordType<T extends DistributedTableOptions<any>> = T extends DistributedTableOptions<infer IT> ? IT : Record<string, any>;
-export type RecordKey<T, PK extends keyof T, SK extends (keyof T)[] | undefined> = Pick<T, PK | (SK extends string[] ? SK[number] : never)>;
+export type RecordKey<T, PK extends AnyKeyFieldOption<T>, SK extends AnyKeyFieldOption<T> | undefined> = Pick<T, PK['field'] | (SK extends Record<string, any> ? (SK extends undefined ? never : SK['field']) : never)>;
 export type FieldType<T> = undefined extends T ? (T | null) : T;
 export type FieldComparisonOptions<T> = {
     [K in keyof T & string]?: {
@@ -55,7 +70,7 @@ export declare function PassThruParser<T>(record: Record<string, any>): T;
  *
  * High cardinality, non-sequential partition keys allow for the best overall scaling.
  */
-export declare class DistributedTable<const P extends Parser<any>, const T extends ReturnType<P>, const PK extends keyof T & string, const SK extends (keyof T & string)[] | undefined> extends Resource {
+export declare class DistributedTable<const P extends Parser<any>, const T extends KindaPretty<ReturnType<P>>, const PK extends AnyKeyFieldOption<T>, const SK extends AnyKeyFieldOption<T> | undefined> extends Resource {
     #private;
     parse: P;
     partitionKey: PK;
@@ -67,15 +82,17 @@ export declare class DistributedTable<const P extends Parser<any>, const T exten
             sort?: SK;
         };
     });
+    get partitionKeyName(): PK['field'];
+    get sortKeyName(): 'field' extends (keyof SK) ? SK['field'] : undefined;
     save(item: T): Promise<void>;
     saveMany(items: T[]): Promise<void>;
-    delete(item: RecordKey<T, PK, SK>): Promise<void>;
-    deleteMany(items: (RecordKey<T, PK, SK>)[]): Promise<void>;
-    get(key: RecordKey<T, PK, SK>): Promise<T | undefined>;
+    delete(item: KindaPretty<RecordKey<T, PK, SK>>): Promise<void>;
+    deleteMany(items: (KindaPretty<RecordKey<T, PK, SK>>)[]): Promise<void>;
+    get(key: KindaPretty<RecordKey<T, PK, SK>>): Promise<KindaPretty<T> | undefined>;
     scan(options: {
         filter?: Filter<T>;
     }): AsyncGenerator<T>;
-    query(partition: Pick<T, PK>, options?: {
+    query(partition: KindaPretty<Pick<T, PK['field']>>, options?: {
         filter?: Filter<T>;
     }): AsyncGenerator<T>;
 }

package/dist/resources/distributed-table.js

@@ -64,12 +64,16 @@ export class DistributedTable extends Resource {
         this.sort = options.key.sort;
         this.#fileService = new (overrides.FileService || FileService)(this, 'files');
     }
+    get partitionKeyName() {
+        return this.partitionKey.field;
+    }
+    get sortKeyName() {
+        return this.sort?.field;
+    }
     #getFilename(key) {
-        const parts = [key[this.partitionKey]];
-        if (this.sort) {
-            for (const sk of this.sort) {
-                parts.push(key[sk]);
-            }
+        const parts = [key[this.partitionKeyName]];
+        if (this.sortKeyName) {
+            parts.push(key[this.sortKeyName]);
         }
         return parts.map(String).join('__') + '.json';
     }
@@ -117,14 +121,26 @@ export class DistributedTable extends Resource {
         }
     }
     async *query(partition, options = {}) {
-        const prefix = partition[this.partitionKey];
+        const prefix = partition[this.partitionKeyName];
         for await (const filename of this.#fileService.list({ prefix })) {
             const data = await this.#fileService.read(filename);
             const record = this.parse(JSON.parse(data));
-            if (record[this.partitionKey] === partition[this.partitionKey]
+            if (record[this.partitionKeyName] === partition[this.partitionKeyName]
                 && (!options.filter || matchesFilter(record, options.filter))) {
                 yield record;
             }
         }
     }
 }
+// export type Todo = {
+// 	id: string;
+// 	text: string;
+// 	order: number;
+// };
+// const userTodos = new DistributedTable('app', 'userTodos', {
+// 	parse: PassThruParser<Todo & { userId: string }>,
+// 	key: {
+// 		partition: { userId: 'string' },
+// 		sort: { id: 'string' }
+// 	}
+// });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wirejs-resources",
-	"version": "0.1.34-table-resource",
+	"version": "0.1.36-table-resource",
 	"description": "Basic services and server-side resources for wirejs apps",
 	"type": "module",
 	"main": "./dist/index.js",