@xyo-network/archivist 2.38.15 → 2.38.17

package/src/Config.ts

@@ -2,16 +2,17 @@ import { AddressString, XyoModuleConfig } from '@xyo-network/module'
 import { XyoPayload } from '@xyo-network/payload'
 
 export interface XyoArchivistParents {
+  commit?: AddressString[]
   read?: AddressString[]
   write?: AddressString[]
-  commit?: AddressString[]
 }
 
 export type XyoArchivistConfig<TConfig extends XyoPayload = XyoPayload> = XyoModuleConfig<
   {
+    cacheParentReads?: boolean
     /** @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
   } & TConfig

package/src/Queries/Delete.ts

@@ -4,6 +4,6 @@ export type XyoArchivistDeleteQuerySchema = 'network.xyo.query.archivist.delete'
 export const XyoArchivistDeleteQuerySchema: XyoArchivistDeleteQuerySchema = 'network.xyo.query.archivist.delete'
 
 export type XyoArchivistDeleteQuery = XyoQuery<{
-  schema: XyoArchivistDeleteQuerySchema
   hashes: string[]
+  schema: XyoArchivistDeleteQuerySchema
 }>

package/src/Queries/Find.ts

@@ -5,6 +5,6 @@ export type XyoArchivistFindQuerySchema = 'network.xyo.query.archivist.find'
 export const XyoArchivistFindQuerySchema: XyoArchivistFindQuerySchema = 'network.xyo.query.archivist.find'
 
 export type XyoArchivistFindQuery = XyoQuery<{
-  schema: XyoArchivistFindQuerySchema
   filter?: XyoPayloadFindFilter
+  schema: XyoArchivistFindQuerySchema
 }>

package/src/Queries/Get.ts

@@ -4,6 +4,6 @@ export type XyoArchivistGetQuerySchema = 'network.xyo.query.archivist.get'
 export const XyoArchivistGetQuerySchema: XyoArchivistGetQuerySchema = 'network.xyo.query.archivist.get'
 
 export type XyoArchivistGetQuery = XyoQuery<{
-  schema: XyoArchivistGetQuerySchema
   hashes: string[]
+  schema: XyoArchivistGetQuerySchema
 }>

package/src/Queries/Insert.ts

@@ -4,6 +4,6 @@ export type XyoArchivistInsertQuerySchema = 'network.xyo.query.archivist.insert'
 export const XyoArchivistInsertQuerySchema: XyoArchivistInsertQuerySchema = 'network.xyo.query.archivist.insert'
 
 export type XyoArchivistInsertQuery = XyoQuery<{
-  schema: XyoArchivistInsertQuerySchema
   payloads: string[]
+  schema: XyoArchivistInsertQuerySchema
 }>

package/src/XyoArchivist.ts

@@ -22,20 +22,27 @@ import {
 import { XyoArchivistWrapper } from './XyoArchivistWrapper'
 
 export interface XyoArchivistParentWrappers {
+  commit?: Record<string, XyoArchivistWrapper>
   read?: Record<string, XyoArchivistWrapper>
   write?: Record<string, XyoArchivistWrapper>
-  commit?: Record<string, XyoArchivistWrapper>
 }
 
 export abstract class XyoArchivist<TConfig extends XyoArchivistConfig = XyoArchivistConfig> extends XyoModule<TConfig> implements PayloadArchivist {
-  public override queries() {
-    return [XyoArchivistGetQuerySchema, XyoArchivistInsertQuerySchema, ...super.queries()]
-  }
+  private _parents?: XyoArchivistParentWrappers
 
   protected get cacheParentReads() {
     return !!this.config?.cacheParentReads
   }
 
+  protected get parents() {
+    this._parents = this._parents ?? {
+      commit: this.resolveArchivists(this.config?.parents?.commit),
+      read: this.resolveArchivists(this.config?.parents?.read),
+      write: this.resolveArchivists(this.config?.parents?.write),
+    }
+    return assertEx(this._parents)
+  }
+
   protected get writeThrough() {
     return !!this.config?.writeThrough
   }
@@ -66,9 +73,9 @@ export abstract class XyoArchivist<TConfig extends XyoArchivistConfig = XyoArchi
     }
   }
 
-  abstract get(hashes: string[]): PromisableArray<XyoPayload>
-
-  abstract insert(item: XyoPayload[]): PromisableArray<XyoBoundWitness>
+  public override queries() {
+    return [XyoArchivistGetQuerySchema, XyoArchivistInsertQuerySchema, ...super.queries()]
+  }
 
   override async query<T extends XyoQueryBoundWitness = XyoQueryBoundWitness>(
     query: T,
@@ -119,21 +126,6 @@ export abstract class XyoArchivist<TConfig extends XyoArchivistConfig = XyoArchi
     return this.bindResult(resultPayloads, queryAccount)
   }
 
-  private resolveArchivists(archivists?: string[]) {
-    const resolvedWrappers: Record<string, XyoArchivistWrapper> = {}
-    if (archivists) {
-      archivists.map((archivist) => {
-        if (resolvedWrappers[archivist] === undefined) {
-          const module = this.resolver?.fromAddress([archivist]).shift()
-          if (module) {
-            resolvedWrappers[archivist] = new XyoArchivistWrapper(module)
-          }
-        }
-      })
-    }
-    return resolvedWrappers
-  }
-
   protected async getFromParents(hash: string) {
     return compact(
       await Promise.all(
@@ -168,13 +160,22 @@ export abstract class XyoArchivist<TConfig extends XyoArchivistConfig = XyoArchi
     ).flat()
   }
 
-  private _parents?: XyoArchivistParentWrappers
-  protected get parents() {
-    this._parents = this._parents ?? {
-      commit: this.resolveArchivists(this.config?.parents?.commit),
-      read: this.resolveArchivists(this.config?.parents?.read),
-      write: this.resolveArchivists(this.config?.parents?.write),
+  private resolveArchivists(archivists?: string[]) {
+    const resolvedWrappers: Record<string, XyoArchivistWrapper> = {}
+    if (archivists) {
+      archivists.map((archivist) => {
+        if (resolvedWrappers[archivist] === undefined) {
+          const module = this.resolver?.fromAddress([archivist]).shift()
+          if (module) {
+            resolvedWrappers[archivist] = new XyoArchivistWrapper(module)
+          }
+        }
+      })
     }
-    return assertEx(this._parents)
+    return resolvedWrappers
   }
+
+  abstract get(hashes: string[]): PromisableArray<XyoPayload>
+
+  abstract insert(item: XyoPayload[]): PromisableArray<XyoBoundWitness>
 }

package/src/XyoArchivistWrapper.ts

@@ -22,12 +22,12 @@ import {
 } from './Queries'
 
 export class XyoArchivistWrapper extends XyoModuleWrapper implements PayloadArchivist {
-  public async delete(hashes: string[]) {
-    const queryPayload = PayloadWrapper.parse<XyoArchivistDeleteQuery>({ hashes, schema: XyoArchivistDeleteQuerySchema })
+  public async all(): Promise<XyoPayload[]> {
+    const queryPayload = PayloadWrapper.parse<XyoArchivistAllQuery>({ schema: XyoArchivistAllQuerySchema })
     const query = await this.bindQuery(queryPayload)
     const result = await this.module.query(query[0], query[1])
     this.throwErrors(query, result)
-    return result[0].payload_hashes.map(() => true)
+    return compact(result[1])
   }
 
   public async clear(): Promise<void> {
@@ -37,25 +37,20 @@ export class XyoArchivistWrapper extends XyoModuleWrapper implements PayloadArch
     this.throwErrors(query, result)
   }
 
-  public async get(hashes: string[]): Promise<XyoPayload[]> {
-    const queryPayload = PayloadWrapper.parse<XyoArchivistGetQuery>({ hashes, schema: XyoArchivistGetQuerySchema })
+  public async commit(): Promise<XyoBoundWitness[]> {
+    const queryPayload = PayloadWrapper.parse<XyoArchivistCommitQuery>({ schema: XyoArchivistCommitQuerySchema })
     const query = await this.bindQuery(queryPayload)
     const result = await this.module.query(query[0], query[1])
     this.throwErrors(query, result)
-    return result[1]
+    return result[1].filter(isXyoBoundWitnessPayload)
   }
 
-  public async insert(payloads: XyoPayload[]): Promise<XyoBoundWitness[]> {
-    const queryPayload = PayloadWrapper.parse<XyoArchivistInsertQuery>({
-      payloads: payloads.map((payload) => PayloadWrapper.hash(payload)),
-      schema: XyoArchivistInsertQuerySchema,
-    })
-    const query = await this.bindQuery(queryPayload, payloads)
-    const result = await this.module.query(query[0], [queryPayload.payload, ...payloads])
-    const innerBoundWitnesses =
-      result[1]?.filter<XyoBoundWitness>((payload): payload is XyoBoundWitness => payload?.schema === XyoBoundWitnessSchema) ?? []
+  public async delete(hashes: string[]) {
+    const queryPayload = PayloadWrapper.parse<XyoArchivistDeleteQuery>({ hashes, schema: XyoArchivistDeleteQuerySchema })
+    const query = await this.bindQuery(queryPayload)
+    const result = await this.module.query(query[0], query[1])
     this.throwErrors(query, result)
-    return [result[0], ...innerBoundWitnesses]
+    return result[0].payload_hashes.map(() => true)
   }
 
   public async find(filter?: XyoPayloadFindFilter): Promise<XyoPayload[]> {
@@ -66,19 +61,24 @@ export class XyoArchivistWrapper extends XyoModuleWrapper implements PayloadArch
     return compact(result[1])
   }
 
-  public async all(): Promise<XyoPayload[]> {
-    const queryPayload = PayloadWrapper.parse<XyoArchivistAllQuery>({ schema: XyoArchivistAllQuerySchema })
+  public async get(hashes: string[]): Promise<XyoPayload[]> {
+    const queryPayload = PayloadWrapper.parse<XyoArchivistGetQuery>({ hashes, schema: XyoArchivistGetQuerySchema })
     const query = await this.bindQuery(queryPayload)
     const result = await this.module.query(query[0], query[1])
     this.throwErrors(query, result)
-    return compact(result[1])
+    return result[1]
   }
 
-  public async commit(): Promise<XyoBoundWitness[]> {
-    const queryPayload = PayloadWrapper.parse<XyoArchivistCommitQuery>({ schema: XyoArchivistCommitQuerySchema })
-    const query = await this.bindQuery(queryPayload)
-    const result = await this.module.query(query[0], query[1])
+  public async insert(payloads: XyoPayload[]): Promise<XyoBoundWitness[]> {
+    const queryPayload = PayloadWrapper.parse<XyoArchivistInsertQuery>({
+      payloads: payloads.map((payload) => PayloadWrapper.hash(payload)),
+      schema: XyoArchivistInsertQuerySchema,
+    })
+    const query = await this.bindQuery(queryPayload, payloads)
+    const result = await this.module.query(query[0], [queryPayload.payload, ...payloads])
+    const innerBoundWitnesses =
+      result[1]?.filter<XyoBoundWitness>((payload): payload is XyoBoundWitness => payload?.schema === XyoBoundWitnessSchema) ?? []
     this.throwErrors(query, result)
-    return result[1].filter(isXyoBoundWitnessPayload)
+    return [result[0], ...innerBoundWitnesses]
   }
 }

package/src/XyoCookieArchivist.ts

@@ -22,26 +22,20 @@ export type XyoCookieArchivistConfigSchema = 'network.xyo.module.config.archivis
 export const XyoCookieArchivistConfigSchema: XyoCookieArchivistConfigSchema = 'network.xyo.module.config.archivist.cookie'
 
 export type XyoCookieArchivistConfig = XyoArchivistConfig<{
-  schema: XyoCookieArchivistConfigSchema
   domain?: string
   maxEntries?: number
   maxEntrySize?: number
   namespace?: string
+  schema: XyoCookieArchivistConfigSchema
 }>
 
 export class XyoCookieArchivist extends XyoArchivist<XyoCookieArchivistConfig> {
-  static override async create(params?: XyoModuleParams<XyoCookieArchivistConfig>): Promise<XyoCookieArchivist> {
-    return (await super.create(params)) as XyoCookieArchivist
-  }
+  static override configSchema = XyoCookieArchivistConfigSchema
 
   public get domain() {
     return this.config?.domain
   }
 
-  public get namespace() {
-    return this.config?.namespace ?? 'xyoarch'
-  }
-
   public get maxEntries() {
     //all browsers support at least 60 cookies
     return this.config?.maxEntries ?? 60
@@ -52,27 +46,19 @@ export class XyoCookieArchivist extends XyoArchivist<XyoCookieArchivistConfig> {
     return this.config?.maxEntrySize ?? 4000
   }
 
-  public override queries() {
-    return [
-      XyoArchivistAllQuerySchema,
-      XyoArchivistDeleteQuerySchema,
-      XyoArchivistClearQuerySchema,
-      XyoArchivistFindQuerySchema,
-      XyoArchivistCommitQuerySchema,
-      ...super.queries(),
-    ]
+  public get namespace() {
+    return this.config?.namespace ?? 'xyoarch'
   }
 
-  private keyFromHash(hash: string) {
-    return `${this.namespace}-${hash}`
+  static override async create(params?: XyoModuleParams<XyoCookieArchivistConfig>): Promise<XyoCookieArchivist> {
+    return (await super.create(params)) as XyoCookieArchivist
   }
 
-  public override delete(hashes: string[]): PromisableArray<boolean> {
+  public override all(): PromisableArray<XyoPayload> {
     try {
-      return hashes.map((hash) => {
-        Cookies.remove(this.keyFromHash(hash))
-        return true
-      })
+      return Object.entries(Cookies.get())
+        .filter(([key]) => key.startsWith(`${this.namespace}-`))
+        .map(([, value]) => JSON.parse(value))
     } catch (ex) {
       console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
       throw ex
@@ -92,6 +78,46 @@ export class XyoCookieArchivist extends XyoArchivist<XyoCookieArchivistConfig> {
     }
   }
 
+  public override async commit(): Promise<XyoBoundWitness[]> {
+    try {
+      const payloads = await this.all()
+      assertEx(payloads.length > 0, 'Nothing to commit')
+      const settled = await Promise.allSettled(
+        compact(
+          Object.values(this.parents?.commit ?? [])?.map(async (parent) => {
+            const queryPayload = PayloadWrapper.parse<XyoArchivistInsertQuery>({
+              payloads: payloads.map((payload) => PayloadWrapper.hash(payload)),
+              schema: XyoArchivistInsertQuerySchema,
+            })
+            const query = await this.bindQuery(queryPayload)
+            return (await parent?.query(query[0], query[1]))?.[0]
+          }),
+        ),
+      )
+      await this.clear()
+      return compact(
+        settled.map((result) => {
+          return result.status === 'fulfilled' ? result.value : null
+        }),
+      )
+    } catch (ex) {
+      console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
+      throw ex
+    }
+  }
+
+  public override delete(hashes: string[]): PromisableArray<boolean> {
+    try {
+      return hashes.map((hash) => {
+        Cookies.remove(this.keyFromHash(hash))
+        return true
+      })
+    } catch (ex) {
+      console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
+      throw ex
+    }
+  }
+
   public async get(hashes: string[]): Promise<XyoPayload[]> {
     try {
       return await Promise.all(
@@ -129,44 +155,18 @@ export class XyoCookieArchivist extends XyoArchivist<XyoCookieArchivistConfig> {
     }
   }
 
-  public override all(): PromisableArray<XyoPayload> {
-    try {
-      return Object.entries(Cookies.get())
-        .filter(([key]) => key.startsWith(`${this.namespace}-`))
-        .map(([, value]) => JSON.parse(value))
-    } catch (ex) {
-      console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
-      throw ex
-    }
+  public override queries() {
+    return [
+      XyoArchivistAllQuerySchema,
+      XyoArchivistDeleteQuerySchema,
+      XyoArchivistClearQuerySchema,
+      XyoArchivistFindQuerySchema,
+      XyoArchivistCommitQuerySchema,
+      ...super.queries(),
+    ]
   }
 
-  public override async commit(): Promise<XyoBoundWitness[]> {
-    try {
-      const payloads = await this.all()
-      assertEx(payloads.length > 0, 'Nothing to commit')
-      const settled = await Promise.allSettled(
-        compact(
-          Object.values(this.parents?.commit ?? [])?.map(async (parent) => {
-            const queryPayload = PayloadWrapper.parse<XyoArchivistInsertQuery>({
-              payloads: payloads.map((payload) => PayloadWrapper.hash(payload)),
-              schema: XyoArchivistInsertQuerySchema,
-            })
-            const query = await this.bindQuery(queryPayload)
-            return (await parent?.query(query[0], query[1]))?.[0]
-          }),
-        ),
-      )
-      await this.clear()
-      return compact(
-        settled.map((result) => {
-          return result.status === 'fulfilled' ? result.value : null
-        }),
-      )
-    } catch (ex) {
-      console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
-      throw ex
-    }
+  private keyFromHash(hash: string) {
+    return `${this.namespace}-${hash}`
   }
-
-  static override configSchema = XyoCookieArchivistConfigSchema
 }

package/src/XyoMemoryArchivist.ts

@@ -22,51 +22,78 @@ export type XyoMemoryArchivistConfigSchema = 'network.xyo.module.config.archivis
 export const XyoMemoryArchivistConfigSchema: XyoMemoryArchivistConfigSchema = 'network.xyo.module.config.archivist.memory'
 
 export type XyoMemoryArchivistConfig = XyoArchivistConfig<{
-  schema: XyoMemoryArchivistConfigSchema
   max?: number
+  schema: XyoMemoryArchivistConfigSchema
 }>
 
 export class XyoMemoryArchivist<TConfig extends XyoMemoryArchivistConfig = XyoMemoryArchivistConfig> extends XyoArchivist<TConfig> {
-  static override async create(params?: XyoModuleParams<XyoMemoryArchivistConfig>): Promise<XyoMemoryArchivist> {
-    return (await super.create(params)) as XyoMemoryArchivist
+  static override configSchema = XyoMemoryArchivistConfigSchema
+
+  private cache: LruCache<string, XyoPayload>
+
+  protected constructor(params?: XyoModuleParams<TConfig>) {
+    super(params)
+    this.cache = new LruCache<string, XyoPayload>({ max: this.max })
   }
 
   public get max() {
     return this.config?.max ?? 10000
   }
 
-  private cache: LruCache<string, XyoPayload>
+  static override async create(params?: XyoModuleParams<XyoMemoryArchivistConfig>): Promise<XyoMemoryArchivist> {
+    return (await super.create(params)) as XyoMemoryArchivist
+  }
 
-  public override queries() {
-    return [
-      XyoArchivistAllQuerySchema,
-      XyoArchivistDeleteQuerySchema,
-      XyoArchivistClearQuerySchema,
-      XyoArchivistFindQuerySchema,
-      XyoArchivistCommitQuerySchema,
-      ...super.queries(),
-    ]
+  public override all(): PromisableArray<XyoPayload> {
+    try {
+      return this.cache.dump().map((value) => value[1].value)
+    } catch (ex) {
+      console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
+      throw ex
+    }
   }
 
-  protected constructor(params?: XyoModuleParams<TConfig>) {
-    super(params)
-    this.cache = new LruCache<string, XyoPayload>({ max: this.max })
+  public override clear(): void | Promise<void> {
+    try {
+      this.cache.clear()
+    } catch (ex) {
+      console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
+      throw ex
+    }
   }
 
-  public override delete(hashes: string[]): PromisableArray<boolean> {
+  public override async commit(): Promise<XyoBoundWitness[]> {
     try {
-      return hashes.map((hash) => {
-        return this.cache.delete(hash)
-      })
+      const payloads = assertEx(await this.all(), 'Nothing to commit')
+      const settled = await Promise.allSettled(
+        compact(
+          Object.values(this.parents?.commit ?? [])?.map(async (parent) => {
+            const queryPayload = PayloadWrapper.parse<XyoArchivistInsertQuery>({
+              payloads: payloads.map((payload) => PayloadWrapper.hash(payload)),
+              schema: XyoArchivistInsertQuerySchema,
+            })
+            const query = await this.bindQuery(queryPayload)
+            return (await parent?.query(query[0], query[1]))?.[0]
+          }),
+        ),
+      )
+      await this.clear()
+      return compact(
+        settled.map((result) => {
+          return result.status === 'fulfilled' ? result.value : null
+        }),
+      )
     } catch (ex) {
       console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
       throw ex
     }
   }
 
-  public override clear(): void | Promise<void> {
+  public override delete(hashes: string[]): PromisableArray<boolean> {
     try {
-      this.cache.clear()
+      return hashes.map((hash) => {
+        return this.cache.delete(hash)
+      })
     } catch (ex) {
       console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
       throw ex
@@ -112,40 +139,14 @@ export class XyoMemoryArchivist<TConfig extends XyoMemoryArchivistConfig = XyoMe
     }
   }
 
-  public override all(): PromisableArray<XyoPayload> {
-    try {
-      return this.cache.dump().map((value) => value[1].value)
-    } catch (ex) {
-      console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
-      throw ex
-    }
-  }
-
-  public override async commit(): Promise<XyoBoundWitness[]> {
-    try {
-      const payloads = assertEx(await this.all(), 'Nothing to commit')
-      const settled = await Promise.allSettled(
-        compact(
-          Object.values(this.parents?.commit ?? [])?.map(async (parent) => {
-            const queryPayload = PayloadWrapper.parse<XyoArchivistInsertQuery>({
-              payloads: payloads.map((payload) => PayloadWrapper.hash(payload)),
-              schema: XyoArchivistInsertQuerySchema,
-            })
-            const query = await this.bindQuery(queryPayload)
-            return (await parent?.query(query[0], query[1]))?.[0]
-          }),
-        ),
-      )
-      await this.clear()
-      return compact(
-        settled.map((result) => {
-          return result.status === 'fulfilled' ? result.value : null
-        }),
-      )
-    } catch (ex) {
-      console.error(`Error: ${JSON.stringify(ex, null, 2)}`)
-      throw ex
-    }
+  public override queries() {
+    return [
+      XyoArchivistAllQuerySchema,
+      XyoArchivistDeleteQuerySchema,
+      XyoArchivistClearQuerySchema,
+      XyoArchivistFindQuerySchema,
+      XyoArchivistCommitQuerySchema,
+      ...super.queries(),
+    ]
   }
-  static override configSchema = XyoMemoryArchivistConfigSchema
 }