@xyo-network/archivist 2.26.11 → 2.26.14

package/src/Abstract.ts

@@ -1,28 +1,71 @@
 import { assertEx } from '@xylabs/sdk-js'
-import { XyoBoundWitness } from '@xyo-network/boundwitness'
-import { XyoAbstractModule } from '@xyo-network/module'
+import { XyoAbstractModule, XyoModuleQueryResult } from '@xyo-network/module'
 import { XyoPayload } from '@xyo-network/payload'
 import { NullablePromisableArray, Promisable, PromisableArray } from '@xyo-network/promisable'
 
 import { Archivist } from './Archivist'
-import { XyoArchivist, XyoArchivistQueryPayload } from './XyoArchivist'
+import { XyoArchivistFindQueryPayloadSchema, XyoArchivistGetQueryPayloadSchema, XyoArchivistQueryPayload } from './Query'
+import { XyoArchivist } from './XyoArchivist'
 import { XyoArchivistConfig, XyoArchivistParents } from './XyoArchivistConfig'
 import { XyoPayloadFindFilter } from './XyoPayloadFindFilter'
 
-export abstract class XyoAbstractArchivist<
-    Q extends XyoArchivistQueryPayload = XyoArchivistQueryPayload,
-    C extends XyoArchivistConfig = XyoArchivistConfig,
-  >
-  extends XyoAbstractModule<Q, C>
+export abstract class XyoAbstractArchivist<TConfig extends XyoPayload = XyoPayload>
+  extends XyoAbstractModule<XyoArchivistQueryPayload, XyoArchivistConfig<TConfig>>
   implements XyoArchivist<XyoArchivistQueryPayload>, Archivist<XyoPayload, XyoPayload, XyoPayload, XyoPayload, XyoPayloadFindFilter>
 {
-  abstract get(ids: string[]): NullablePromisableArray<XyoPayload<{ schema: string }>>
+  public override get queries() {
+    return [XyoArchivistGetQueryPayloadSchema, XyoArchivistFindQueryPayloadSchema]
+  }
+
+  abstract get(hashes: string[]): NullablePromisableArray<XyoPayload>
+
+  public all(): PromisableArray<XyoPayload> {
+    throw Error('Not implemented')
+  }
+
+  public clear(): Promisable<void> {
+    throw Error('Not implemented')
+  }
 
-  abstract find(filter: XyoPayloadFindFilter): PromisableArray<XyoPayload<{ schema: string }>>
+  public commit(): PromisableArray<XyoPayload> {
+    throw Error('Not implemented')
+  }
+
+  public delete(_hashes: string[]): PromisableArray<boolean> {
+    throw Error('Not implemented')
+  }
 
-  abstract insert(item: XyoPayload<{ schema: string }>[]): PromisableArray<XyoPayload<{ schema: string }>>
+  abstract find(filter: XyoPayloadFindFilter): PromisableArray<XyoPayload>
 
-  abstract override query<Q>(query: Q): Promisable<[XyoBoundWitness, XyoPayload[]]>
+  abstract insert(item: XyoPayload[]): PromisableArray<XyoPayload>
+
+  async query(query: XyoArchivistQueryPayload): Promise<XyoModuleQueryResult> {
+    const payloads: (XyoPayload | null)[] = []
+    switch (query.schema) {
+      case 'network.xyo.query.archivist.all':
+        payloads.concat(await this.all())
+        break
+      case 'network.xyo.query.archivist.clear':
+        await this.clear()
+        break
+      case 'network.xyo.query.archivist.commit':
+        payloads.concat(await this.commit())
+        break
+      case 'network.xyo.query.archivist.delete':
+        await this.delete(query.hashes)
+        break
+      case 'network.xyo.query.archivist.find':
+        payloads.concat(await this.find(query.filter))
+        break
+      case 'network.xyo.query.archivist.get':
+        payloads.concat(await this.get(query.hashes))
+        break
+      case 'network.xyo.query.archivist.insert':
+        payloads.concat(await this.insert(query.payloads))
+        break
+    }
+    return [this.bindPayloads(payloads), payloads]
+  }
 
   get resolver() {
     return this.config.resolver

package/src/Archivist.ts

@@ -1,4 +1,4 @@
-import { NullablePromisableArray, PromisableArray } from '@xyo-network/promisable'
+import { NullablePromisableArray, Promisable, PromisableArray } from '@xyo-network/promisable'
 
 export interface ReadArchivist<TReadResponse, TId = string> {
   get(ids: TId[]): NullablePromisableArray<TReadResponse>
@@ -8,7 +8,7 @@ export interface ReadArchivist<TReadResponse, TId = string> {
 export interface WriteArchivist<TReadResponse, TWriteResponse = TReadResponse, TWrite = TReadResponse, TId = string> {
   insert(item: TWrite[]): PromisableArray<TWriteResponse>
   delete?(ids: TId[]): PromisableArray<boolean>
-  clear?(): void
+  clear?(): Promisable<void>
 }
 
 export interface FindArchivist<TReadResponse, TFindResponse = TReadResponse, TFindFilter = unknown> {

package/src/Query/All.ts

@@ -1,8 +1,8 @@
-import { XyoArchivistQueryPayload } from '../XyoArchivist'
+import { XyoQueryPayload } from '@xyo-network/payload'
 
-export type XyoArchvistAllQueryPayloadSchema = 'network.xyo.query.archivist.all'
-export const XyoArchvistAllQueryPayloadSchema = 'network.xyo.query.archivist.all'
+export type XyoArchivistAllQueryPayloadSchema = 'network.xyo.query.archivist.all'
+export const XyoArchivistAllQueryPayloadSchema = 'network.xyo.query.archivist.all'
 
-export type XyoArchvistAllQueryPayload = XyoArchivistQueryPayload<{
-  schema: XyoArchvistAllQueryPayloadSchema
+export type XyoArchivistAllQueryPayload = XyoQueryPayload<{
+  schema: XyoArchivistAllQueryPayloadSchema
 }>

package/src/Query/Clear.ts

@@ -0,0 +1,8 @@
+import { XyoQueryPayload } from '@xyo-network/payload'
+
+export type XyoArchivistClearQueryPayloadSchema = 'network.xyo.query.archivist.clear'
+export const XyoArchivistClearQueryPayloadSchema = 'network.xyo.query.archivist.clear'
+
+export type XyoArchivistClearQueryPayload = XyoQueryPayload<{
+  schema: XyoArchivistClearQueryPayloadSchema
+}>

package/src/Query/Commit.ts

@@ -0,0 +1,8 @@
+import { XyoQueryPayload } from '@xyo-network/payload'
+
+export type XyoArchivistCommitQueryPayloadSchema = 'network.xyo.query.archivist.commit'
+export const XyoArchivistCommitQueryPayloadSchema = 'network.xyo.query.archivist.commit'
+
+export type XyoArchivistCommitQueryPayload = XyoQueryPayload<{
+  schema: XyoArchivistCommitQueryPayloadSchema
+}>

package/src/Query/Delete.ts

@@ -0,0 +1,9 @@
+import { XyoQueryPayload } from '@xyo-network/payload'
+
+export type XyoArchivistDeleteQueryPayloadSchema = 'network.xyo.query.archivist.delete'
+export const XyoArchivistDeleteQueryPayloadSchema = 'network.xyo.query.archivist.delete'
+
+export type XyoArchivistDeleteQueryPayload = XyoQueryPayload<{
+  schema: XyoArchivistDeleteQueryPayloadSchema
+  hashes: string[]
+}>

package/src/Query/Find.ts

@@ -0,0 +1,11 @@
+import { XyoQueryPayload } from '@xyo-network/payload'
+
+import { XyoPayloadFindFilter } from '../XyoPayloadFindFilter'
+
+export type XyoArchivistFindQueryPayloadSchema = 'network.xyo.query.archivist.find'
+export const XyoArchivistFindQueryPayloadSchema = 'network.xyo.query.archivist.find'
+
+export type XyoArchivistFindQueryPayload = XyoQueryPayload<{
+  schema: XyoArchivistFindQueryPayloadSchema
+  filter: XyoPayloadFindFilter
+}>

package/src/Query/Get.ts

@@ -1,9 +1,9 @@
-import { XyoArchivistQueryPayload } from '../XyoArchivist'
+import { XyoQueryPayload } from '@xyo-network/payload'
 
-export type XyoArchvistGetQueryPayloadSchema = 'network.xyo.query.archivist.get'
-export const XyoArchvistGetQueryPayloadSchema = 'network.xyo.query.archivist.get'
+export type XyoArchivistGetQueryPayloadSchema = 'network.xyo.query.archivist.get'
+export const XyoArchivistGetQueryPayloadSchema = 'network.xyo.query.archivist.get'
 
-export type XyoArchvistGetQueryPayload = XyoArchivistQueryPayload<{
-  schema: XyoArchvistGetQueryPayloadSchema
+export type XyoArchivistGetQueryPayload = XyoQueryPayload<{
+  schema: XyoArchivistGetQueryPayloadSchema
   hashes: string[]
 }>

package/src/Query/Insert.ts

@@ -0,0 +1,9 @@
+import { XyoPayload, XyoQueryPayload } from '@xyo-network/payload'
+
+export type XyoArchivistInsertQueryPayloadSchema = 'network.xyo.query.archivist.insert'
+export const XyoArchivistInsertQueryPayloadSchema = 'network.xyo.query.archivist.insert'
+
+export type XyoArchivistInsertQueryPayload = XyoQueryPayload<{
+  schema: XyoArchivistInsertQueryPayloadSchema
+  payloads: XyoPayload[]
+}>

package/src/Query/index.ts

@@ -1 +1,33 @@
+import { XyoArchivistAllQueryPayload, XyoArchivistAllQueryPayloadSchema } from './All'
+import { XyoArchivistClearQueryPayload, XyoArchivistClearQueryPayloadSchema } from './Clear'
+import { XyoArchivistCommitQueryPayload, XyoArchivistCommitQueryPayloadSchema } from './Commit'
+import { XyoArchivistDeleteQueryPayload, XyoArchivistDeleteQueryPayloadSchema } from './Delete'
+import { XyoArchivistFindQueryPayload, XyoArchivistFindQueryPayloadSchema } from './Find'
+import { XyoArchivistGetQueryPayload, XyoArchivistGetQueryPayloadSchema } from './Get'
+import { XyoArchivistInsertQueryPayload, XyoArchivistInsertQueryPayloadSchema } from './Insert'
+
+export * from './All'
+export * from './Clear'
+export * from './Commit'
+export * from './Delete'
+export * from './Find'
 export * from './Get'
+export * from './Insert'
+
+export type XyoArchivistQueryPayloadSchema =
+  | XyoArchivistAllQueryPayloadSchema
+  | XyoArchivistClearQueryPayloadSchema
+  | XyoArchivistCommitQueryPayloadSchema
+  | XyoArchivistDeleteQueryPayloadSchema
+  | XyoArchivistFindQueryPayloadSchema
+  | XyoArchivistGetQueryPayloadSchema
+  | XyoArchivistInsertQueryPayloadSchema
+
+export type XyoArchivistQueryPayload =
+  | XyoArchivistAllQueryPayload
+  | XyoArchivistClearQueryPayload
+  | XyoArchivistCommitQueryPayload
+  | XyoArchivistDeleteQueryPayload
+  | XyoArchivistFindQueryPayload
+  | XyoArchivistGetQueryPayload
+  | XyoArchivistInsertQueryPayload

package/src/XyoArchivist.ts

@@ -1,23 +1,5 @@
-import { XyoBoundWitness } from '@xyo-network/boundwitness'
-import { XyoModule, XyoQueryPayload } from '@xyo-network/module'
-import { XyoPayload } from '@xyo-network/payload'
-import { Promisable } from '@xyo-network/promisable'
+import { XyoModule } from '@xyo-network/module'
 
-import { Archivist } from './Archivist'
-import { XyoPayloadFindFilter } from './XyoPayloadFindFilter'
+import { XyoArchivistQueryPayload } from './Query'
 
-export type XyoArchivistQueryPayloadGetSchema = 'network.xyo.query.archivist.get'
-export const XyoArchivistQueryPayloadGetSchema = 'network.xyo.query.archivist.get'
-
-export type XyoArchivistQueryPayloadAllSchema = 'network.xyo.query.archivist.all'
-export const XyoArchivistQueryPayloadAllSchema = 'network.xyo.query.archivist.all'
-
-export type XyoArchivistQueryPayloadSchema = XyoArchivistQueryPayloadGetSchema | XyoArchivistQueryPayloadAllSchema
-
-export type XyoArchivistQueryPayload<T extends XyoPayload = XyoPayload> = XyoQueryPayload<T>
-
-export interface XyoArchivist<Q extends XyoArchivistQueryPayload = XyoArchivistQueryPayload>
-  extends XyoModule<Q>,
-    Archivist<XyoPayload, XyoPayload, XyoPayload, XyoPayload, XyoPayloadFindFilter> {
-  query<T extends Q>(query: T): Promisable<[XyoBoundWitness, XyoPayload[]]>
-}
+export type XyoArchivist<Q extends XyoArchivistQueryPayload = XyoArchivistQueryPayload> = XyoModule<Q>

package/src/XyoArchivistConfig.ts

@@ -1,7 +1,7 @@
 import { XyoModuleConfig } from '@xyo-network/module'
 import { XyoPayload } from '@xyo-network/payload'
 
-import { XyoArchivist, XyoArchivistQueryPayload } from './XyoArchivist'
+import { XyoArchivist } from './XyoArchivist'
 
 export interface XyoArchivistParents {
   read?: Record<string, XyoArchivist | null | undefined>
@@ -9,18 +9,15 @@ export interface XyoArchivistParents {
   commit?: Record<string, XyoArchivist | null | undefined>
 }
 
-export type XyoArchivistConfig<
-  T extends XyoPayload = XyoPayload,
-  M extends XyoArchivist = XyoArchivist<XyoArchivistQueryPayload<T>>,
-> = XyoModuleConfig<
+export type XyoArchivistConfig<TConfig extends XyoPayload = XyoPayload, TQuery extends XyoPayload = XyoPayload> = XyoModuleConfig<
   {
     /** @field address of one or more parent archivists to read from */
     parents?: XyoArchivistParents
     cacheParentReads?: boolean
     /** @field address of archivist to write through to */
     writeThrough?: string
-  } & T,
-  M
+  } & TConfig,
+  TQuery
 >
 
 export class XyoArchivistConfigWrapper<C extends XyoArchivistConfig = XyoArchivistConfig> {

package/src/XyoMemoryArchivist.ts

@@ -1,30 +1,47 @@
 import { assertEx } from '@xylabs/sdk-js'
 import { XyoBoundWitness, XyoBoundWitnessBuilder } from '@xyo-network/boundwitness'
 import { XyoPayload, XyoPayloadWrapper } from '@xyo-network/payload'
-import { Promisable, PromisableArray } from '@xyo-network/promisable'
+import { PromisableArray } from '@xyo-network/promisable'
 import compact from 'lodash/compact'
 import LruCache from 'lru-cache'
 
 import { XyoAbstractArchivist } from './Abstract'
-import { XyoArchivistQueryPayload } from './XyoArchivist'
+import {
+  XyoArchivistAllQueryPayloadSchema,
+  XyoArchivistClearQueryPayloadSchema,
+  XyoArchivistCommitQueryPayloadSchema,
+  XyoArchivistDeleteQueryPayloadSchema,
+  XyoArchivistFindQueryPayloadSchema,
+} from './Query'
 import { XyoArchivistConfig } from './XyoArchivistConfig'
 import { XyoPayloadFindFilter } from './XyoPayloadFindFilter'
 
+export type XyoMemoryArchivistConfigSchema = 'network.xyo.module.config.archivist.memory'
+export const XyoMemoryArchivistConfigSchema = 'network.xyo.module.config.archivist.memory'
+
 export type XyoMemoryArchivistConfig = XyoArchivistConfig<{
-  schema: 'network.xyo.module.config.archivist.memory'
+  schema: XyoMemoryArchivistConfigSchema
   max?: number
 }>
 
-export class XyoMemoryArchivist extends XyoAbstractArchivist<XyoArchivistQueryPayload, XyoMemoryArchivistConfig> {
-  query<Q>(_query: Q): Promisable<[XyoBoundWitness, XyoPayload<{ schema: string }>[]]> {
-    throw new Error('Method not implemented.')
-  }
+export class XyoMemoryArchivist extends XyoAbstractArchivist<XyoMemoryArchivistConfig> {
   public get max() {
     return this.config?.max ?? 10000
   }
 
   private cache: LruCache<string, XyoPayload>
 
+  public override get queries() {
+    return [
+      ...super.queries,
+      XyoArchivistAllQueryPayloadSchema,
+      XyoArchivistDeleteQueryPayloadSchema,
+      XyoArchivistClearQueryPayloadSchema,
+      XyoArchivistFindQueryPayloadSchema,
+      XyoArchivistCommitQueryPayloadSchema,
+    ]
+  }
+
   constructor(config: XyoMemoryArchivistConfig) {
     super(config)
     this.cache = new LruCache<string, XyoPayload>({ max: this.max })
@@ -36,7 +53,7 @@ export class XyoMemoryArchivist extends XyoAbstractArchivist<XyoArchivistQueryPa
     })
   }
 
-  public clear(): void | Promise<void> {
+  public override clear(): void | Promise<void> {
     this.cache.clear()
   }
 
@@ -45,7 +62,8 @@ export class XyoMemoryArchivist extends XyoAbstractArchivist<XyoArchivistQueryPa
       await Promise.all(
         compact(
           Object.values(this.parents?.read ?? {}).map(async (parent) => {
-            return (await parent?.get([hash]))?.[0] ?? null
+            const [, payloads] = (await parent?.query({ hashes: [hash], schema: 'network.xyo.query.archivist.get' })) ?? []
+            return payloads?.[0]
           }),
         ),
       ),
@@ -89,7 +107,11 @@ export class XyoMemoryArchivist extends XyoAbstractArchivist<XyoArchivistQueryPa
     const builder = new XyoBoundWitnessBuilder<XyoBoundWitness, XyoPayload>()
     const block = builder.payloads(payloads).witness(account).build()
     await Promise.allSettled(
-      compact(Object.values(this.parents?.commit ?? [])?.map(async (parent) => await parent?.insert?.(payloads.concat([block])))),
+      compact(
+        Object.values(this.parents?.commit ?? [])?.map(
+          async (parent) => await parent?.query({ payloads: [block, ...payloads], schema: 'network.xyo.query.archivist.insert' }),
+        ),
+      ),
     )
     await this.clear()
     return payloads

package/src/index.ts

@@ -1,5 +1,6 @@
 export * from './Abstract'
 export * from './Archivist'
+export * from './Query'
 export * from './XyoArchivist'
 export * from './XyoArchivistConfig'
 export * from './XyoMemoryArchivist'