@travetto/model-query 8.0.0-alpha.11 → 8.0.0-alpha.13

package/package.json

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

package/src/model/indexes.ts

@@ -10,33 +10,28 @@ type IndexClauseRaw<T> = {
 
 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> {
+export interface QueryIndexConfig<T extends ModelType> extends IndexConfig<'query'> {
   /**
    * Fields and sort order
    */
   fields: IndexClauseRaw<RetainPrimitiveFields<T>>[];
-};
+  /**
+   * Is this a unique index
+   */
+  unique?: boolean;
+}
 
-/**
- * Defines an index on a model
- * @kind decorator
- */
-export function QueryIndex<T extends ModelType>(index: Omit<QueryIndexConfig<T>, 'class'>) {
+export function QueryIndex<T extends ModelType>(index: Omit<QueryIndexConfig<T>, 'class' | 'type'>) {
   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 } } });
+    ModelRegistryIndex.getForRegister(cls).register({ indices: { [index.name]: { ...index, type: 'query', 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:');
+  typeof idx === 'object' && idx !== null && 'type' in idx && typeof idx.type === 'string' && idx.type === 'query';

package/support/test/crud.ts

@@ -1,15 +1,39 @@
 import assert from 'node:assert';
 
 import { Suite, Test } from '@travetto/test';
-import { type ModelCrudSupport, NotFoundError } from '@travetto/model';
+import { ExistsError, Model, type ModelCrudSupport, NotFoundError } from '@travetto/model';
+import { castTo } from '@travetto/runtime';
 
 import { BaseModelSuite } from '@travetto/model/support/test/base.ts';
 
 import { Address, Person, Todo, BigIntModel } from './model.ts';
 import type { ModelQueryCrudSupport } from '../../src/types/crud.ts';
+import { QueryIndex } from '../../__index__.ts';
+
+
+@Model()
+@QueryIndex({
+  name: 'uniqueUser2',
+  fields: [{ name: true }],
+  unique: true
+})
+class UniqueUser2 {
+  id: string;
+  name: string;
+}
 
 @Suite()
 export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudSupport & ModelCrudSupport> {
+
+  supportsUniqueIndexes = true;
+
+  @Test({ skip: (self) => !castTo<ModelQueryCrudSuite>(self).supportsUniqueIndexes })
+  async testUnique() {
+    const svc = await this.service;
+    await svc.create(UniqueUser2, UniqueUser2.from({ name: 'bob' }));
+    await assert.rejects(() => svc.create(UniqueUser2, UniqueUser2.from({ name: 'bob' })), ExistsError);
+  }
+
   @Test()
   async testUpdateOneWithQuery() {
     const svc = await this.service;