broken

documentation/user-preference.md

@@ -1,3 +1,4 @@
 # User preference encodings
 
 ### One-for-all
+

src/interfaces/data/ICursor.ts

@@ -0,0 +1,16 @@
+// import {
+//     PersistenceError,
+//     VersionedObject,
+//     VolatileStorageMetadata,
+//   } from "@snickerdoodlelabs/objects";
+  import { DataObject, PersistenceError } from "crunchDB/objects";
+import { ResultAsync } from "neverthrow";
+
+  export interface IVolatileCursor<T extends DataObject> {
+    nextValue(): ResultAsync<T | null, PersistenceError>;
+    allValues(): ResultAsync<T[] | null, PersistenceError>;
+
+    _next(): ResultAsync<VolatileStorageMetadata<T> | null, PersistenceError>;
+    _all(): ResultAsync<VolatileStorageMetadata<T>[], PersistenceError>;
+  }
+

src/interfaces/data/IPersistence.ts

@@ -0,0 +1,52 @@
+  import { ResultAsync } from "neverthrow";
+  import { ECollectionName, DataObject, PersistenceError } from "crunchDB/objects";
+
+  import { IVolatileCursor } from "@persistence/volatile/IVolatileCursor.js";
+import { CollectionKeys } from "crunchDB/objects/primitive/CollectionKey";
+
+  export interface IPersistence {
+    getObject<T extends DataObject>(
+      recordKey: ECollectionName,
+      key: CollectionKeys,
+    ): ResultAsync<T | null, PersistenceError>;
+    getCursor<T extends DataObject>(
+      recordKey: ECollectionName,
+      indexName?: string,
+      query?: IDBValidKey | IDBKeyRange,
+      direction?: IDBCursorDirection | undefined,
+      mode?: IDBTransactionMode,
+    ): ResultAsync<IVolatileCursor<T>, PersistenceError>;
+    getAll<T extends DataObject>(
+      recordKey: ECollectionName,
+      indexName?: string,
+    ): ResultAsync<T[], PersistenceError>;
+    getAllByIndex<T extends DataObject>(
+      recordKey: ECollectionName,
+      indexName: string,
+      query: IDBValidKey | IDBKeyRange,
+    ): ResultAsync<T[], PersistenceError>;
+    getAllByMultiIndex<T extends DataObject>(
+      recordKey: ECollectionName,
+      indices: string[],
+      values: IDBValidKey | IDBKeyRange,
+    ): ResultAsync<T[], PersistenceError>;
+    getAllKeys<T extends DataObject>(
+      recordKey: ECollectionName,
+      indexName?: string,
+      query?: IDBValidKey | IDBKeyRange,
+      count?: number | undefined,
+    ): ResultAsync<T[], PersistenceError>;
+    updateRecord<T extends DataObject>(
+      recordKey: ECollectionName,
+      value: T,
+    ): ResultAsync<void, PersistenceError>;
+    deleteRecord(
+      recordKey: ECollectionName,
+      key: CollectionKeys,
+    ): ResultAsync<void, PersistenceError>;
+    // #endregion
+
+  }
+
+  export const IPersistenceType = Symbol.for("IPersistence");
+

src/objects/business/SimpleObject.ts → src/objects/business/DataObject.ts

@@ -1,6 +1,4 @@
 //@TODO add properties and rename the file to VolatileObject.ts
-export interface SimpleObject {
+export interface DataObject {
   id: number;
-  name: string;
-  value: string;
 }

src/objects/business/index.ts

@@ -1,3 +1,4 @@
 export * from './nlp';
 export * from './ranking';
-export * from './vectorDB';
+export * from './vectorDB';
+export * from './DataObject';

src/objects/enum/ECollectionName.ts

@@ -0,0 +1,4 @@
+export enum ECollectionName {
+    Vector = "Vector",
+    VectorMeta = "VectorMeta",    
+}

src/objects/enum/index.ts

@@ -1 +1,2 @@
 export * from "./ELanguageCode";
+export * from "./ECollectionName";

src/objects/error/PersistenceError.ts

@@ -0,0 +1,12 @@
+import { BaseError } from "./BaseError";
+import errorCodes from "./errorCodes";
+
+export class PersistenceError extends BaseError {
+    protected errorCode: string = errorCodes[PersistenceError.name];
+    constructor(
+      message: string,
+      public src?: unknown,
+    ) {
+      super(message, errorCodes[PersistenceError.name], src);
+    }
+}

src/objects/error/errorCodes.ts

@@ -4,5 +4,6 @@ const errorCodes: {[Key: string]: string} = {
     NLPError: "ERR_NLPError",
     DuplicateWordError: "ERR_DuplicateWordError",
     EigenJSNotReadyError: "ERR_EigenJSNotReadyError",
+    PersistenceError: "ERR_PersistenceError",
 }
 export default errorCodes;

src/objects/error/index.ts

@@ -5,3 +5,4 @@ export * from './NLPError';
 export * from './MatrixErrors';
 export * from './MatrixOperatorsError';
 export * from './EigenJSNotReadyError';
+export * from './PersistenceError';

src/objects/primitive/CollectionKey.ts

@@ -0,0 +1,2 @@
+export type CollectionKey = string | number;
+export type CollectionKeys = CollectionKey[];