@xyo-network/archivist 2.33.0-rc.8 → 2.33.0

package/src/Queries/{Payload.ts → types.ts}

@@ -1,4 +1,4 @@
-import { XyoModuleQuery } from '@xyo-network/module'
+import { XyoModuleQuery, XyoQuery } from '@xyo-network/module'
 
 import { XyoArchivistAllQuery } from './All'
 import { XyoArchivistClearQuery } from './Clear'
@@ -8,7 +8,7 @@ import { XyoArchivistFindQuery } from './Find'
 import { XyoArchivistGetQuery } from './Get'
 import { XyoArchivistInsertQuery } from './Insert'
 
-export type XyoArchivistQuery =
+type XyoArchivistQueryRoot =
   | XyoModuleQuery
   | XyoArchivistAllQuery
   | XyoArchivistClearQuery
@@ -17,3 +17,9 @@ export type XyoArchivistQuery =
   | XyoArchivistFindQuery
   | XyoArchivistGetQuery
   | XyoArchivistInsertQuery
+
+type XyoArchivistQueryRootSchema = XyoArchivistQueryRoot['schema']
+
+export type XyoArchivistQuerySchema<T extends string | void = void> = T extends string ? XyoArchivistQueryRootSchema | T : XyoArchivistQueryRootSchema
+
+export type XyoArchivistQuery<T extends XyoQuery | void = void> = T extends XyoQuery ? XyoArchivistQueryRoot | T : XyoArchivistQueryRoot

package/src/XyoArchivist.ts

@@ -1,12 +1,12 @@
 import { assertEx } from '@xylabs/sdk-js'
 import { XyoAccount } from '@xyo-network/account'
 import { XyoBoundWitness } from '@xyo-network/boundwitness'
-import { Module, XyoModule, XyoModuleInitializeQuerySchema, XyoModuleQueryResult, XyoModuleShutdownQuerySchema } from '@xyo-network/module'
-import { XyoPayload, XyoPayloadWrapper } from '@xyo-network/payload'
+import { XyoModule, XyoModuleInitializeQuerySchema, XyoModuleQueryResult, XyoModuleShutdownQuerySchema } from '@xyo-network/module'
+import { PayloadWrapper, XyoPayload } from '@xyo-network/payload'
 import { NullablePromisableArray, Promisable, PromisableArray } from '@xyo-network/promise'
 import compact from 'lodash/compact'
 
-import { Archivist } from './Archivist'
+import { PayloadArchivist } from './Archivist'
 import { XyoArchivistConfig, XyoArchivistParents } from './Config'
 import {
   XyoArchivistAllQuerySchema,
@@ -23,9 +23,9 @@ import {
 } from './Queries'
 import { XyoPayloadFindFilter } from './XyoPayloadFindFilter'
 
-export abstract class XyoArchivist<TConfig extends XyoPayload = XyoPayload>
-  extends XyoModule<XyoArchivistConfig<TConfig>, XyoArchivistQuery>
-  implements Archivist<XyoPayload, XyoPayload, XyoPayload, XyoPayload, XyoPayloadFindFilter>
+export abstract class XyoArchivist<TConfig extends XyoPayload = XyoPayload, TQuery extends XyoArchivistQuery = XyoArchivistQuery>
+  extends XyoModule<TQuery, XyoPayload, XyoArchivistConfig<TConfig>>
+  implements PayloadArchivist<TQuery>
 {
   public override queries(): XyoArchivistQuerySchema[] {
     return [
@@ -69,7 +69,7 @@ export abstract class XyoArchivist<TConfig extends XyoPayload = XyoPayload>
 
   abstract insert(item: XyoPayload[]): Promisable<XyoBoundWitness>
 
-  async query(query: XyoArchivistQuery): Promise<XyoModuleQueryResult> {
+  override async query(query: TQuery): Promise<XyoModuleQueryResult<XyoPayload>> {
     if (!this.queries().find((schema) => schema === query.schema)) {
       console.error(`Undeclared Module Query: ${query.schema}`)
     }
@@ -104,11 +104,11 @@ export abstract class XyoArchivist<TConfig extends XyoPayload = XyoPayload>
     return this.bindPayloads(payloads, queryAccount)
   }
 
-  private resolveArchivists(archivists?: Record<string, Module | null | undefined>) {
-    const resolved: Record<string, Module | null | undefined> = {}
+  private resolveArchivists(archivists?: Record<string, PayloadArchivist | null | undefined>) {
+    const resolved: Record<string, PayloadArchivist | null | undefined> = {}
     if (archivists) {
       Object.entries(archivists).forEach(([key, value]) => {
-        resolved[key] = value ?? this.resolver?.(key) ?? null
+        resolved[key] = value ?? (this.resolver?.(key) as unknown as PayloadArchivist) ?? null
       })
     }
     return resolved
@@ -120,7 +120,7 @@ export abstract class XyoArchivist<TConfig extends XyoPayload = XyoPayload>
         Object.values(this.parents?.read ?? {}).map(async (parent) => {
           const query: XyoArchivistGetQuery = { hashes: [hash], schema: XyoArchivistGetQuerySchema }
           const [, payloads] = (await parent?.query(query)) ?? []
-          const wrapper = payloads?.[0] ? new XyoPayloadWrapper(payloads?.[0]) : undefined
+          const wrapper = payloads?.[0] ? new PayloadWrapper(payloads?.[0]) : undefined
           if (wrapper && wrapper.hash !== hash) {
             console.warn(`Parent [${parent?.address}] returned payload with invalid hash [${hash} != ${wrapper.hash}]`)
             return null
@@ -131,7 +131,7 @@ export abstract class XyoArchivist<TConfig extends XyoPayload = XyoPayload>
     )[0]
   }
 
-  protected async writeToParent(parent: Module, payloads: XyoPayload[]) {
+  protected async writeToParent(parent: PayloadArchivist, payloads: XyoPayload[]) {
     const query: XyoArchivistInsertQuery = { payloads, schema: XyoArchivistInsertQuerySchema }
     const [, writtenPayloads] = (await parent?.query(query)) ?? []
     return writtenPayloads

package/src/XyoArchivistWrapper.ts

@@ -2,7 +2,7 @@ import { XyoBoundWitness } from '@xyo-network/boundwitness'
 import { XyoModuleWrapper } from '@xyo-network/module'
 import { XyoPayload } from '@xyo-network/payload'
 
-import { Archivist } from './Archivist'
+import { PayloadArchivist } from './Archivist'
 import {
   XyoArchivistAllQuery,
   XyoArchivistAllQuerySchema,
@@ -18,10 +18,14 @@ import {
   XyoArchivistGetQuerySchema,
   XyoArchivistInsertQuery,
   XyoArchivistInsertQuerySchema,
+  XyoArchivistQuery,
 } from './Queries'
 import { XyoPayloadFindFilter } from './XyoPayloadFindFilter'
 
-export class XyoArchivistWrapper extends XyoModuleWrapper implements Archivist {
+export class XyoArchivistWrapper<TQuery extends XyoArchivistQuery = XyoArchivistQuery, TQueryResult extends XyoPayload = XyoPayload>
+  extends XyoModuleWrapper<TQuery | XyoArchivistQuery, TQueryResult>
+  implements PayloadArchivist<TQuery | XyoArchivistQuery>
+{
   public async delete(hashes: string[]) {
     const query: XyoArchivistDeleteQuery = { hashes, schema: XyoArchivistDeleteQuerySchema }
     return (await this.module.query(query))[0].payload_hashes.map(() => true)

package/src/XyoCookieArchivist.ts

@@ -1,6 +1,6 @@
 import { assertEx } from '@xylabs/sdk-js'
 import { XyoBoundWitness } from '@xyo-network/boundwitness'
-import { XyoPayload, XyoPayloadWrapper } from '@xyo-network/payload'
+import { PayloadWrapper, XyoPayload } from '@xyo-network/payload'
 import { PromisableArray } from '@xyo-network/promise'
 import Cookies from 'js-cookie'
 import compact from 'lodash/compact'
@@ -116,7 +116,7 @@ export class XyoCookieArchivist extends XyoArchivist<XyoCookieArchivistConfig> {
   public async insert(payloads: XyoPayload[]): Promise<XyoBoundWitness> {
     try {
       const storedPayloads: XyoPayload[] = payloads.map((payload) => {
-        const wrapper = new XyoPayloadWrapper(payload)
+        const wrapper = new PayloadWrapper(payload)
         const key = this.keyFromHash(wrapper.hash)
         const value = JSON.stringify(wrapper.payload)
         assertEx(value.length < this.maxEntrySize, `Payload too large [${wrapper.hash}, ${value.length}]`)

package/src/XyoMemoryArchivist.ts

@@ -1,6 +1,6 @@
 import { assertEx } from '@xylabs/sdk-js'
 import { XyoBoundWitness } from '@xyo-network/boundwitness'
-import { XyoPayload, XyoPayloadWrapper } from '@xyo-network/payload'
+import { PayloadWrapper, XyoPayload } from '@xyo-network/payload'
 import { PromisableArray } from '@xyo-network/promise'
 import compact from 'lodash/compact'
 import LruCache from 'lru-cache'
@@ -100,7 +100,7 @@ export class XyoMemoryArchivist extends XyoArchivist<XyoMemoryArchivistConfig> {
   public async insert(payloads: XyoPayload[]): Promise<XyoBoundWitness> {
     try {
       payloads.map((payload) => {
-        const wrapper = new XyoPayloadWrapper(payload)
+        const wrapper = new PayloadWrapper(payload)
         const payloadWithmeta = { ...payload, _hash: wrapper.hash, _timestamp: Date.now() }
         this.cache.set(payloadWithmeta._hash, payloadWithmeta)
         return payloadWithmeta

package/src/XyoStorageArchivist.ts

@@ -1,6 +1,6 @@
 import { assertEx } from '@xylabs/sdk-js'
 import { XyoBoundWitness } from '@xyo-network/boundwitness'
-import { XyoPayload, XyoPayloadWrapper } from '@xyo-network/payload'
+import { PayloadWrapper, XyoPayload } from '@xyo-network/payload'
 import { PromisableArray } from '@xyo-network/promise'
 import compact from 'lodash/compact'
 import store, { StoreBase } from 'store2'
@@ -109,7 +109,7 @@ export class XyoStorageArchivist extends XyoArchivist<XyoStorageArchivistConfig>
   public async insert(payloads: XyoPayload[]): Promise<XyoBoundWitness> {
     try {
       const storedPayloads = payloads.map((payload) => {
-        const wrapper = new XyoPayloadWrapper(payload)
+        const wrapper = new PayloadWrapper(payload)
         const hash = wrapper.hash
         const value = JSON.stringify(wrapper.payload)
         assertEx(value.length < this.maxEntrySize, `Payload too large [${wrapper.hash}, ${value.length}]`)

package/src/test.spec.test/testArchivist.ts

@@ -3,7 +3,7 @@
  */
 
 import { delay } from '@xylabs/delay'
-import { XyoPayload, XyoPayloadWrapper } from '@xyo-network/payload'
+import { PayloadWrapper, XyoPayload } from '@xyo-network/payload'
 
 import { XyoArchivist } from '../XyoArchivist'
 import { XyoArchivistWrapper } from '../XyoArchivistWrapper'
@@ -14,7 +14,7 @@ export const testArchivistRoundTrip = (archivist: XyoArchivist, name: string) =>
       salt: 'test',
       schema: 'network.xyo.id',
     }
-    const payloadWrapper = new XyoPayloadWrapper(idPayload)
+    const payloadWrapper = new PayloadWrapper(idPayload)
     const archivistWrapper = new XyoArchivistWrapper(archivist)
     const insertResult = await archivistWrapper.insert([idPayload])
     expect(insertResult).toBeDefined()
@@ -24,7 +24,7 @@ export const testArchivistRoundTrip = (archivist: XyoArchivist, name: string) =>
     expect(getResult.length).toBe(1)
     const gottenPayload = getResult[0]
     if (gottenPayload) {
-      const gottenPayloadWrapper = new XyoPayloadWrapper(gottenPayload)
+      const gottenPayloadWrapper = new PayloadWrapper(gottenPayload)
       expect(gottenPayloadWrapper.hash).toBe(payloadWrapper.hash)
     }
   })

package/dist/cjs/Queries/Payload.d.ts

@@ -1,10 +0,0 @@
-import { XyoModuleQuery } from '@xyo-network/module';
-import { XyoArchivistAllQuery } from './All';
-import { XyoArchivistClearQuery } from './Clear';
-import { XyoArchivistCommitQuery } from './Commit';
-import { XyoArchivistDeleteQuery } from './Delete';
-import { XyoArchivistFindQuery } from './Find';
-import { XyoArchivistGetQuery } from './Get';
-import { XyoArchivistInsertQuery } from './Insert';
-export declare type XyoArchivistQuery = XyoModuleQuery | XyoArchivistAllQuery | XyoArchivistClearQuery | XyoArchivistCommitQuery | XyoArchivistDeleteQuery | XyoArchivistFindQuery | XyoArchivistGetQuery | XyoArchivistInsertQuery;
-//# sourceMappingURL=Payload.d.ts.map

package/dist/cjs/Queries/Payload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Queries/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAA;AAC5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,QAAQ,CAAA;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAA;AAC5C,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAElD,oBAAY,iBAAiB,GACzB,cAAc,GACd,oBAAoB,GACpB,sBAAsB,GACtB,uBAAuB,GACvB,uBAAuB,GACvB,qBAAqB,GACrB,oBAAoB,GACpB,uBAAuB,CAAA"}

package/dist/cjs/Queries/Payload.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Payload.js.map

package/dist/cjs/Queries/Payload.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Payload.js","sourceRoot":"","sources":["../../../src/Queries/Payload.ts"],"names":[],"mappings":""}

package/dist/cjs/Queries/Schema.d.ts

@@ -1,10 +0,0 @@
-import { XyoModuleQuerySchema } from '@xyo-network/module';
-import { XyoArchivistAllQuerySchema } from './All';
-import { XyoArchivistClearQuerySchema } from './Clear';
-import { XyoArchivistCommitQuerySchema } from './Commit';
-import { XyoArchivistDeleteQuerySchema } from './Delete';
-import { XyoArchivistFindQuerySchema } from './Find';
-import { XyoArchivistGetQuerySchema } from './Get';
-import { XyoArchivistInsertQuerySchema } from './Insert';
-export declare type XyoArchivistQuerySchema<T extends string = never> = XyoArchivistAllQuerySchema | XyoArchivistClearQuerySchema | XyoArchivistCommitQuerySchema | XyoArchivistDeleteQuerySchema | XyoArchivistFindQuerySchema | XyoArchivistGetQuerySchema | XyoArchivistInsertQuerySchema | XyoModuleQuerySchema | T;
-//# sourceMappingURL=Schema.d.ts.map

package/dist/cjs/Queries/Schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/Queries/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAA;AAE1D,OAAO,EAAE,0BAA0B,EAAE,MAAM,OAAO,CAAA;AAClD,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAA;AACtD,OAAO,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAA;AACxD,OAAO,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAA;AACxD,OAAO,EAAE,2BAA2B,EAAE,MAAM,QAAQ,CAAA;AACpD,OAAO,EAAE,0BAA0B,EAAE,MAAM,OAAO,CAAA;AAClD,OAAO,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAA;AAExD,oBAAY,uBAAuB,CAAC,CAAC,SAAS,MAAM,GAAG,KAAK,IACxD,0BAA0B,GAC1B,4BAA4B,GAC5B,6BAA6B,GAC7B,6BAA6B,GAC7B,2BAA2B,GAC3B,0BAA0B,GAC1B,6BAA6B,GAC7B,oBAAoB,GACpB,CAAC,CAAA"}

package/dist/cjs/Queries/Schema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../../src/Queries/Schema.ts"],"names":[],"mappings":""}

package/dist/esm/Queries/Payload.d.ts

@@ -1,10 +0,0 @@
-import { XyoModuleQuery } from '@xyo-network/module';
-import { XyoArchivistAllQuery } from './All';
-import { XyoArchivistClearQuery } from './Clear';
-import { XyoArchivistCommitQuery } from './Commit';
-import { XyoArchivistDeleteQuery } from './Delete';
-import { XyoArchivistFindQuery } from './Find';
-import { XyoArchivistGetQuery } from './Get';
-import { XyoArchivistInsertQuery } from './Insert';
-export declare type XyoArchivistQuery = XyoModuleQuery | XyoArchivistAllQuery | XyoArchivistClearQuery | XyoArchivistCommitQuery | XyoArchivistDeleteQuery | XyoArchivistFindQuery | XyoArchivistGetQuery | XyoArchivistInsertQuery;
-//# sourceMappingURL=Payload.d.ts.map

package/dist/esm/Queries/Payload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Queries/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAA;AAC5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,QAAQ,CAAA;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAA;AAC5C,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAElD,oBAAY,iBAAiB,GACzB,cAAc,GACd,oBAAoB,GACpB,sBAAsB,GACtB,uBAAuB,GACvB,uBAAuB,GACvB,qBAAqB,GACrB,oBAAoB,GACpB,uBAAuB,CAAA"}

package/dist/esm/Queries/Payload.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=Payload.js.map

package/dist/esm/Queries/Payload.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Payload.js","sourceRoot":"","sources":["../../../src/Queries/Payload.ts"],"names":[],"mappings":""}

package/dist/esm/Queries/Schema.d.ts

@@ -1,10 +0,0 @@
-import { XyoModuleQuerySchema } from '@xyo-network/module';
-import { XyoArchivistAllQuerySchema } from './All';
-import { XyoArchivistClearQuerySchema } from './Clear';
-import { XyoArchivistCommitQuerySchema } from './Commit';
-import { XyoArchivistDeleteQuerySchema } from './Delete';
-import { XyoArchivistFindQuerySchema } from './Find';
-import { XyoArchivistGetQuerySchema } from './Get';
-import { XyoArchivistInsertQuerySchema } from './Insert';
-export declare type XyoArchivistQuerySchema<T extends string = never> = XyoArchivistAllQuerySchema | XyoArchivistClearQuerySchema | XyoArchivistCommitQuerySchema | XyoArchivistDeleteQuerySchema | XyoArchivistFindQuerySchema | XyoArchivistGetQuerySchema | XyoArchivistInsertQuerySchema | XyoModuleQuerySchema | T;
-//# sourceMappingURL=Schema.d.ts.map

package/dist/esm/Queries/Schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/Queries/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAA;AAE1D,OAAO,EAAE,0BAA0B,EAAE,MAAM,OAAO,CAAA;AAClD,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAA;AACtD,OAAO,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAA;AACxD,OAAO,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAA;AACxD,OAAO,EAAE,2BAA2B,EAAE,MAAM,QAAQ,CAAA;AACpD,OAAO,EAAE,0BAA0B,EAAE,MAAM,OAAO,CAAA;AAClD,OAAO,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAA;AAExD,oBAAY,uBAAuB,CAAC,CAAC,SAAS,MAAM,GAAG,KAAK,IACxD,0BAA0B,GAC1B,4BAA4B,GAC5B,6BAA6B,GAC7B,6BAA6B,GAC7B,2BAA2B,GAC3B,0BAA0B,GAC1B,6BAA6B,GAC7B,oBAAoB,GACpB,CAAC,CAAA"}

package/dist/esm/Queries/Schema.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=Schema.js.map

package/dist/esm/Queries/Schema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../../src/Queries/Schema.ts"],"names":[],"mappings":""}

package/src/Queries/Schema.ts

@@ -1,20 +0,0 @@
-import { XyoModuleQuerySchema } from '@xyo-network/module'
-
-import { XyoArchivistAllQuerySchema } from './All'
-import { XyoArchivistClearQuerySchema } from './Clear'
-import { XyoArchivistCommitQuerySchema } from './Commit'
-import { XyoArchivistDeleteQuerySchema } from './Delete'
-import { XyoArchivistFindQuerySchema } from './Find'
-import { XyoArchivistGetQuerySchema } from './Get'
-import { XyoArchivistInsertQuerySchema } from './Insert'
-
-export type XyoArchivistQuerySchema<T extends string = never> =
-  | XyoArchivistAllQuerySchema
-  | XyoArchivistClearQuerySchema
-  | XyoArchivistCommitQuerySchema
-  | XyoArchivistDeleteQuerySchema
-  | XyoArchivistFindQuerySchema
-  | XyoArchivistGetQuerySchema
-  | XyoArchivistInsertQuerySchema
-  | XyoModuleQuerySchema
-  | T