Class WrappedIndexedStorage<T>

An IndexedStorage that makes use of 2 KeyValueStorages to implement the interface. Due to being limited by key/value storages, there are some restrictions on the allowed type definitions:

There needs to be exactly 1 type with no references to other types.
All other types need to have exactly 1 reference to another type.
Types can't reference each other to create a cycle of references.

All of the above to create a tree-like structure of references. Such a tree is then stored in one of the storages. The other storage is used to store all indexes that are used to find the correct tree object when solving queries.

Type Parameters

T extends IndexTypeCollection<T>

Implements

IndexedStorage<T>

Constructors

constructor

new WrappedIndexedStorage<T>(valueStorage, indexStorage): WrappedIndexedStorage<T>
Type Parameters
- T extends IndexTypeCollection<T>
Parameters
- valueStorage: KeyValueStorage<string, VirtualObject>
- indexStorage: KeyValueStorage<string, string[]>
Returns WrappedIndexedStorage<T>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:84

Properties

`Protected` `Readonly`logger

logger: Logger = ...

Accessors

`Protected`rootType

get rootType(): string
The root type for this storage. Use this instead of rootTypeVar to prevent having to check for undefined. This value will always be defined if the type definitions have been validated.

Returns string
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:279

Methods

create

create<TType>(type, value): Promise<TypeObject<T[TType]>>
Creates an object of the given type. The storage will generate an identifier for the newly created object.
Type Parameters
- TType extends string
Parameters
- type: TType
  The type to create.
- value: CreateTypeObject<T[TType]>
  The value to set for the created object.
Returns Promise<TypeObject<T[TType]>>
A representation of the newly created object, including its new identifier.
Implementation of IndexedStorage.create
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:151

createIndex

createIndex<TType>(type, key): Promise<void>
Creates an index on a key of the given type, to allow for better queries involving those keys. Similar to IndexedStorage.defineType these calls need to happen first.
Type Parameters
- TType extends string
Parameters
- type: TType
  The type to create an index on.
- key: StringKey<T[TType]>
  The key of that type to create an index on.
Returns Promise<void>
Implementation of IndexedStorage.createIndex
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:119

defineType

defineType<TType>(type, description): Promise<void>
Informs the storage of the definition of a specific type. A definition is a key/value object with the values being a valid ValueTypeDescription. Generally, this call needs to happen for every type of this storage, and before any calls are made to interact with the data.
Type Parameters
- TType extends string
Parameters
- type: TType
  The type to define.
- description: T[TType]
  A description of the values stored in objects of that type.
Returns Promise<void>
Implementation of IndexedStorage.defineType
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:94

delete

delete<TType>(type, id): Promise<void>
Deletes the given object. This will also delete all objects that reference that object if the corresponding key is not optional.
Type Parameters
- TType extends string
Parameters
- type: TType
  The type of the object to delete.
- id: string
  The identifier of the object.
Returns Promise<void>
Implementation of IndexedStorage.delete
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:206

entries

entries<TType>(type): AsyncIterableIterator<TypeObject<T[TType]>>
Returns an iterator over all objects of the given type.
Type Parameters
- TType extends string
Parameters
- type: TType
  The type to iterate over.
Returns AsyncIterableIterator<TypeObject<T[TType]>>
Implementation of IndexedStorage.entries
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:249

find

find<TType>(type, query): Promise<TypeObject<T[TType]>[]>
Finds all objects matching a specific IndexedQuery.
Type Parameters
- TType extends string
Parameters
- type: TType
  The type of objects to find.
- query: {
      [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
          ? {
              [K in string | number | symbol]?: (ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined)
          }
          : never)
  }
  The query to execute.
Returns Promise<TypeObject<T[TType]>[]>
A list of objects matching the query.
Implementation of IndexedStorage.find
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:243

findIds

findIds<TType>(type, query): Promise<string[]>
Similar to IndexedStorage.find, but only returns the identifiers of the found objects.
Type Parameters
- TType extends string
Parameters
- type: TType
  The type of objects to find.
- query: {
      [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
          ? {
              [K in string | number | symbol]?: (ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined)
          }
          : never)
  }
  The query to execute.
Returns Promise<string[]>
A list of identifiers of the matching objects.
Implementation of IndexedStorage.findIds
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:228

`Protected`findIndexedRoots

findIndexedRoots<TType>(type, match, rootIds?): Promise<undefined | string[]>
Finds the IDs of all root objects that contain objects of the given type matching the given query by making use of the indexes applicable to the keys in the query. This function only looks at the keys in the query with primitive values, object values in the query referencing parent objects are not considered. Similarly, only indexes are used, keys without index are also ignored.

If an array of root IDs is provided as input, the result will be an intersection of this array and the found identifiers.

If the result is an empty array, it means that there is no valid identifier matching the query, while an undefined result means there is no index matching any of the query keys, so a result can't be determined.
Type Parameters
- TType extends string
Parameters
- type: TType
- match: {
      [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
          ? {
              [K in string | number | symbol]?: (ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined)
          }
          : never)
  }
- OptionalrootIds: string[]
Returns Promise<undefined | string[]>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:496

get

get<TType>(type, id): Promise<undefined | TypeObject<T[TType]>>
Returns the object of the given type with the given identifier.
Type Parameters
- TType extends string
Parameters
- type: TType
  The type of object to get.
- id: string
  The identifier of that object.
Returns Promise<undefined | TypeObject<T[TType]>>
A representation of the object, or undefined if there is no object of that type with that identifier.
Implementation of IndexedStorage.get
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:142

`Protected`getChildObjects

getChildObjects(obj, path): VirtualObject[]
Finds all objects in the provided object that can be found by following the provided path of virtual keys.
Parameters
- obj: VirtualObject
- path: `**${string}**`[]
Returns VirtualObject[]
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:333

`Protected`getChildRelations

getChildRelations<TType>(type): IndexRelation<T>[]
Returns all relations where the given type is the parent.
Type Parameters
- TType extends string
Parameters
- type: TType
Returns IndexRelation<T>[]
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:416

`Protected`getContainingRecord

getContainingRecord<TType>(rootObj, type, id): Record<string, VirtualObject>
Finds the record in the given object that contains the given type/id combination. This function assumes it was already verified through an index that this object contains the given combination.
Type Parameters
- TType extends string
Parameters
- rootObj: VirtualObject
- type: TType
- id: string
Returns Record<string, VirtualObject>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:344

`Protected`getIndexKey

getIndexKey(type, key, value): string
Generate the key used to store the index in the index storage.
Parameters
- type: string
- key: string
- value: string | number
Returns string
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:602

`Protected`getParentRelation

getParentRelation<TType>(type): undefined | IndexRelation<T>
Returns the relation where the given type is the child. Will return undefined for the root type as that one doesn't have a parent.
Type Parameters
- TType extends string
Parameters
- type: TType
Returns undefined | IndexRelation<T>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:424

`Protected`getPathRecords

getPathRecords(obj, path): Record<string, VirtualObject>[]
Finds all records that can be found in the given object by following the given path of virtual keys.
Parameters
- obj: VirtualObject
- path: `**${string}**`[]
Returns Record<string, VirtualObject>[]
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:320

`Protected`getPathToType

getPathToType(type): `**${string}**`[]
Returns the sequence of virtual keys that need to be accessed to reach the given type, starting from the root.
Parameters
- type: string
Returns `**${string}**`[]
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:307

`Protected`getRoot

getRoot<TType>(type, id): Promise<undefined | VirtualObject>
Finds the root object that contains the requested type/id combination.
Type Parameters
- TType extends string
Parameters
- type: TType
- id: string
Returns Promise<undefined | VirtualObject>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:286

has

has<TType>(type, id): Promise<boolean>
Returns true if the object of the given type with the given identifier exists.
Type Parameters
- TType extends string
Parameters
- type: TType
  The type of object to get.
- id: string
  The identifier of that object.
Returns Promise<boolean>
Whether this object exists.
Implementation of IndexedStorage.has
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:133

set

set<TType>(type, value): Promise<void>
Sets the value of a specific object. The identifier in the object is used to identify the object.
Type Parameters
- TType extends string
Parameters
- type: TType
  The type of the object to set.
- value: TypeObject<T[TType]>
  The new value for the object.
Returns Promise<void>
Implementation of IndexedStorage.set
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:187

setField

setField<TType, TKey>(type, id, key, value): Promise<void>
Sets the value of one specific field in an object.
Type Parameters
- TType extends string
- TKey extends string
Parameters
- type: TType
  The type of the object to update.
- id: string
  The identifier of the object to update.
- key: TKey
  The key to update.
- value: ValueType<T[TType][TKey]>
  The new value for the given key.
Returns Promise<void>
Implementation of IndexedStorage.setField
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:192

`Protected`solveQuery

solveQuery<TType>(type, query, rootIds?): Promise<VirtualObject[]>
Finds all objects of the given type matching the query. The rootIds array can be used to restrict the IDs of root objects to look at, which is relevant for the recursive calls the function does.

Will throw an error if there is no index that can be used to solve the query.
Type Parameters
- TType extends string
Parameters
- type: TType
- query: {
      [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
          ? {
              [K in string | number | symbol]?: (ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined)
          }
          : never)
  }
- OptionalrootIds: string[]
Returns Promise<VirtualObject[]>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:544

`Protected`toTypeObject

toTypeObject<TType>(type, obj): TypeObject<T[TType]>
Converts a VirtualObject into a TypeObject. To be used when outputting results.
Type Parameters
- TType extends string
Parameters
- type: TType
- obj: VirtualObject
Returns TypeObject<T[TType]>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:264

`Protected`updateDeepTypeIndex

updateDeepTypeIndex<TType>(type, rootId, oldObj, newObj?): Promise<void>
Update all indexes for an object of the given type, and all its children.
Type Parameters
- TType extends string
Parameters
- type: TType
- rootId: string
- oldObj: VirtualObject
- OptionalnewObj: VirtualObject
Returns Promise<void>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:609

`Protected`updateKeyIndex

updateKeyIndex(type, key, value, rootId, add): Promise<void>
Updates the index for a specific key of an object of the given type.
Parameters
- type: string
- key: string
- value: string
- rootId: string
- add: boolean
Returns Promise<void>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:664

`Protected`updateTypeIndex

updateTypeIndex<TType>(type, rootId, oldObj?, newObj?): Promise<void>
Updates all indexes for an object of the given type.
Type Parameters
- TType extends string
Parameters
- type: TType
- rootId: string
- OptionaloldObj: VirtualObject
- OptionalnewObj: VirtualObject
Returns Promise<void>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:633

`Protected`updateValue

updateValue<TType>(type, value, replace): Promise<void>
Replaces an object of the given type. The identifier in the value is used to determine which object.
Type Parameters
- TType extends string
Parameters
- type: TType
- value: TypeObject<T[TType]>
- replace: true
Returns Promise<void>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:362
updateValue<TType>(type, partial, replace): Promise<void>
Replaces part of an object of the given type with the given partial value. The identifier in the value is used to determine which object.
Type Parameters
- TType extends string
Parameters
- type: TType
- partial: Partial<TypeObject<T[TType]>> & {
  id: string;
  }
- replace: false
Returns Promise<void>
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:369

`Protected`validateDefinition

validateDefinition(type): void
Makes sure the defined types fulfill all the requirements necessary for types on this storage. Will throw an error if this is not the case. This should be called before doing any data interactions. Stores success in a variable so future calls are instantaneous.
Parameters
- type: string
Returns void
- Defined in src/storage/keyvalue/WrappedIndexedStorage.ts:434

Class WrappedIndexedStorage<T>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WrappedIndexedStorage<T>

Properties

Protected Readonlylogger

Accessors

ProtectedrootType

Returns string

Methods

create

Type Parameters

Parameters

Returns Promise<TypeObject<T[TType]>>

createIndex

Type Parameters

Parameters

Returns Promise<void>

defineType

Type Parameters

Parameters

Returns Promise<void>

delete

Type Parameters

Parameters

Returns Promise<void>

entries

Type Parameters

Parameters

Returns AsyncIterableIterator<TypeObject<T[TType]>>

find

Type Parameters

Parameters

Returns Promise<TypeObject<T[TType]>[]>

findIds

Type Parameters

Parameters

Returns Promise<string[]>

ProtectedfindIndexedRoots

Type Parameters

Parameters

Returns Promise<undefined | string[]>

get

Type Parameters

Parameters

Returns Promise<undefined | TypeObject<T[TType]>>

ProtectedgetChildObjects

Parameters

Returns VirtualObject[]

ProtectedgetChildRelations

Type Parameters

Parameters

Returns IndexRelation<T>[]

ProtectedgetContainingRecord

Type Parameters

Parameters

Returns Record<string, VirtualObject>

ProtectedgetIndexKey

Parameters

Returns string

ProtectedgetParentRelation

Type Parameters

Parameters

Returns undefined | IndexRelation<T>

ProtectedgetPathRecords

Parameters

Returns Record<string, VirtualObject>[]

ProtectedgetPathToType

Parameters

Returns `**${string}**`[]

ProtectedgetRoot

`Protected` `Readonly`logger

`Protected`rootType

`Protected`findIndexedRoots

`Protected`getChildObjects

`Protected`getChildRelations

`Protected`getContainingRecord

`Protected`getIndexKey

`Protected`getParentRelation

`Protected`getPathRecords

`Protected`getPathToType

Returns `${string}`[]

`Protected`getRoot

`Protected`solveQuery

`Protected`toTypeObject

`Protected`updateDeepTypeIndex

`Protected`updateKeyIndex

`Protected`updateTypeIndex

`Protected`updateValue

`Protected`validateDefinition