@travetto/model-indexed 8.0.0-alpha.13 → 8.0.0-alpha.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-indexed",
-  "version": "8.0.0-alpha.13",
+  "version": "8.0.0-alpha.14",
   "type": "module",
   "description": "Basic indexing support for model sources that support it.",
   "keywords": [

package/src/indexes.ts

@@ -1,5 +1,5 @@
-import { type ModelType, ModelRegistryIndex } from '@travetto/model';
-import { type Class, type Any, castTo } from '@travetto/runtime';
+import { type IndexConfig, type ModelType, ModelRegistryIndex } from '@travetto/model';
+import { type Class, type Any, castTo, type ClassInstance } from '@travetto/runtime';
 
 import {
   type AllIndexes, type KeyedIndexSelection, type KeyedIndex,
@@ -81,3 +81,26 @@ export function sortedIndex<
 
 export const isModelIndexedIndex = <T extends ModelType>(idx: Any): idx is AllIndexes<T> =>
   typeof idx === 'object' && idx !== null && 'type' in idx && typeof idx.type === 'string' && idx.type.startsWith('indexed:');
+
+
+export const warnIfIndexedUniqueIndex = (service: ClassInstance, cls: Class<ModelType>, indexes: IndexConfig[]): boolean => {
+  let warned = false;
+  for (const idx of indexes) {
+    if (isModelIndexedIndex(idx) && 'unique' in idx && idx.unique) {
+      console.debug('Unique indices are not supported', { cls: cls.Ⲑid, idx: idx.name, service: service.constructor.Ⲑid });
+      warned = true;
+    }
+  }
+  return warned;
+};
+
+export const warnIfNonIndexedIndex = (service: ClassInstance, cls: Class<ModelType>, indexes: IndexConfig[]): boolean => {
+  let warned = false;
+  for (const idx of indexes) {
+    if (!isModelIndexedIndex(idx)) {
+      console.debug('Non-indexed indices are not supported', { cls: cls.Ⲑid, idx: idx.name, service: service.constructor.Ⲑid });
+      warned = true;
+    }
+  }
+  return warned;
+};

package/support/test/indexed.ts

@@ -4,11 +4,11 @@ import timers from 'node:timers/promises';
 import { Suite, Test } from '@travetto/test';
 import { Schema } from '@travetto/schema';
 import { castTo, TimeUtil } from '@travetto/runtime';
-import { Model, NotFoundError } from '@travetto/model';
+import { ExistsError, Model, NotFoundError } from '@travetto/model';
 import { BaseModelSuite } from '@travetto/model/support/test/base.ts';
 
 import type { ModelIndexedSupport } from '../../src/types/service.ts';
-import { keyedIndex, sortedIndex } from '../../src/indexes.ts';
+import { keyedIndex, sortedIndex, uniqueIndex } from '../../src/indexes.ts';
 import { IndexedFieldError } from '../../src/types/error.ts';
 
 @Model('index_user')
@@ -22,6 +22,17 @@ const userNameIndex = keyedIndex(User, {
   key: { name: true }
 });
 
+@Model('index_unique_user')
+class UniqueUser {
+  id: string;
+  name: string;
+}
+
+const userUniqueNameIndex = uniqueIndex(UniqueUser, {
+  name: 'userUniqueName',
+  key: { name: true }
+});
+
 @Model('index_user_2')
 class User2 {
   id: string;
@@ -82,6 +93,7 @@ export abstract class ModelIndexedSuite extends BaseModelSuite<ModelIndexedSuppo
 
   indexLimitSkew = 0;
   supportsDeepIndexes = true;
+  supportsUniqueIndexes = true;
 
   @Test()
   async writeAndRead() {
@@ -103,6 +115,22 @@ export abstract class ModelIndexedSuite extends BaseModelSuite<ModelIndexedSuppo
     assert(found2.name === 'bob2');
   }
 
+  @Test({ skip: (self) => !castTo<ModelIndexedSuite>(self).supportsUniqueIndexes })
+  async writeRejectsDuplicateUniqueIndex() {
+    const service = await this.service;
+
+    const created = await service.create(UniqueUser, UniqueUser.from({ name: 'sam' }));
+
+    await assert.rejects(
+      () => service.create(UniqueUser, UniqueUser.from({ name: 'sam' })),
+      err => err instanceof ExistsError
+    );
+
+    const found = await service.getByIndex(UniqueUser, userUniqueNameIndex, { name: 'sam' });
+    assert(found.id === created.id);
+    assert(found.name === 'sam');
+  }
+
   @Test()
   async readByKeyedIndexUsingId() {
     const service = await this.service;