@travetto/model-query 8.0.0-alpha.0 → 8.0.0-alpha.10

package/__index__.ts

@@ -1,5 +1,6 @@
 export * from './src/model/query.ts';
 export * from './src/model/where-clause.ts';
+export * from './src/model/indexes.ts';
 export * from './src/types/crud.ts';
 export * from './src/types/query.ts';
 export * from './src/types/facet.ts';
@@ -10,4 +11,5 @@ export * from './src/util/suggest.ts';
 export * from './src/util/facet.ts';
 export * from './src/util/crud.ts';
 
+
 export * from './src/verifier.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-query",
-  "version": "8.0.0-alpha.0",
+  "version": "8.0.0-alpha.10",
   "type": "module",
   "description": "Datastore abstraction for advanced query support.",
   "keywords": [
@@ -27,12 +27,12 @@
     "directory": "module/model-query"
   },
   "dependencies": {
-    "@travetto/di": "^8.0.0-alpha.0",
-    "@travetto/model": "^8.0.0-alpha.0",
-    "@travetto/schema": "^8.0.0-alpha.0"
+    "@travetto/di": "^8.0.0-alpha.10",
+    "@travetto/model": "^8.0.0-alpha.10",
+    "@travetto/schema": "^8.0.0-alpha.10"
   },
   "peerDependencies": {
-    "@travetto/test": "^8.0.0-alpha.0"
+    "@travetto/test": "^8.0.0-alpha.10"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/model/indexes.ts

@@ -0,0 +1,42 @@
+import { ModelRegistryIndex, type IndexConfig, type ModelType } from '@travetto/model';
+import { RuntimeError, type Class, type Primitive, type ValidFields } from '@travetto/runtime';
+
+type RetainPrimitiveFields<T> = Pick<T, ValidFields<T, Primitive | Date>>;
+
+type IndexClauseRaw<T> = {
+  [P in keyof T]?:
+  T[P] extends object ? IndexClauseRaw<RetainPrimitiveFields<T[P]>> : 1 | -1 | true;
+};
+
+export type IndexField<T extends ModelType> = IndexClauseRaw<RetainPrimitiveFields<T>>;
+
+/**
+ * Supported index types
+ */
+export type QueryIndexType = 'query:unique' | 'query:unsorted' | 'query:sorted';
+
+/**
+ * Index options
+ */
+export interface QueryIndexConfig<T extends ModelType> extends IndexConfig<QueryIndexType> {
+  /**
+   * Fields and sort order
+   */
+  fields: IndexClauseRaw<RetainPrimitiveFields<T>>[];
+};
+
+/**
+ * Defines an index on a model
+ * @kind decorator
+ */
+export function QueryIndex<T extends ModelType>(index: Omit<QueryIndexConfig<T>, 'class'>) {
+  if (index.fields.some(field => field === 'id')) {
+    throw new RuntimeError('Cannot create an index with the id field');
+  }
+  return function (cls: Class<T>): void {
+    ModelRegistryIndex.getForRegister(cls).register({ indices: { [index.name]: { ...index, class: cls } } });
+  };
+}
+
+export const isModelQueryIndex = (idx: unknown): idx is QueryIndexConfig<ModelType> =>
+  typeof idx === 'object' && idx !== null && 'type' in idx && typeof idx.type === 'string' && idx.type.startsWith('query:');