@xyo-network/archivist-model 3.8.4 → 3.9.0

package/dist/neutral/index.d.ts

@@ -12,6 +12,7 @@ import * as _xyo_network_account_model from '@xyo-network/account-model';
 import { AccountInstance } from '@xyo-network/account-model';
 import * as _xylabs_logger from '@xylabs/logger';
 import { ObjectTypeShape } from '@xylabs/typeof';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
 
 interface NextOptions<TId = Hex> {
     cursor?: TId;
@@ -64,10 +65,14 @@ interface AllArchivist<TReadResponse extends Payload = Payload> extends AllArchi
 }
 interface ReadArchivist<TReadResponse extends Payload = Payload, TId = Hash> extends ReadArchivistFunctions<WithStorageMeta<TReadResponse>, TId> {
 }
-interface WriteArchivist<TReadResponse extends Payload = Payload, TWriteResponse = TReadResponse, TWrite = TReadResponse, TId = Hash> extends WriteArchivistFunctions<WithStorageMeta<TReadResponse>, TWriteResponse, TWrite, TId> {
+interface WriteArchivist<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = TReadResponse, TWrite extends Payload = TReadResponse, TId = Hash> extends WriteArchivistFunctions<WithStorageMeta<TReadResponse>, TWriteResponse, TWrite, TId> {
+}
+interface ReadWriteArchivist<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = TReadResponse, TWrite extends Payload = TReadResponse, TId = Hash> extends WriteArchivist<TReadResponse, TWriteResponse, TWrite, TId>, ReadArchivist<TReadResponse, TId> {
 }
 interface StashArchivist<TWriteResponse extends Payload = Payload> extends StashArchivistFunctions<WithStorageMeta<TWriteResponse>> {
 }
+interface FullArchivist<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = TReadResponse, TWrite extends Payload = TReadResponse, TId = Hash> extends ReadWriteArchivist<TReadResponse, TWriteResponse, TWrite, TId>, StashArchivist<TWriteResponse> {
+}
 interface Archivist<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = Payload, TWrite extends Payload = TReadResponse & Payload, TId = Hash> extends ReadArchivist<WithStorageMeta<TReadResponse>, TId>, AllArchivist<WithStorageMeta<TReadResponse>>, WriteArchivist<WithStorageMeta<TReadResponse>, WithStorageMeta<TWriteResponse>, TWrite, TId>, StashArchivistFunctions<TWriteResponse> {
 }
 
@@ -324,6 +329,18 @@ interface ArchivistLabels extends Labels {
     'network.xyo.archivist.persistence.scope': 'memory' | 'thread' | 'process' | 'device' | 'network';
 }
 
+type IdentityFunction<T> = (value: unknown) => value is T;
+
+declare const tryGetTypedBoundWitness: <T extends BoundWitness>(archivist: ReadArchivist, hash: Hash, identity: IdentityFunction<WithStorageMeta<T>>) => Promise<WithStorageMeta<T> | undefined>;
+declare const getTypedBoundWitness: <T extends BoundWitness>(archivist: ReadArchivist, hash: Hash, identity: IdentityFunction<WithStorageMeta<T>>) => Promise<WithStorageMeta<T>>;
+declare const getBoundWitness: (archivist: ReadArchivist, hash: Hash) => Promise<WithStorageMeta<BoundWitness>>;
+
+type HydratedBoundWitness<T extends BoundWitness = BoundWitness, P extends Payload = Payload> = [WithStorageMeta<T>, WithStorageMeta<P>[]];
+
+declare const tryHydrateTypedBoundWitness: <T extends BoundWitness>(archivist: ReadArchivist, hashOrBw: Hash | WithStorageMeta<T>, identity: IdentityFunction<WithStorageMeta<T>>) => Promise<HydratedBoundWitness<T> | undefined>;
+declare const hydrateTypedBoundWitness: <T extends BoundWitness>(archivist: ReadArchivist, hashOrBw: Hash | WithStorageMeta<T>, identity: IdentityFunction<WithStorageMeta<T>>) => Promise<HydratedBoundWitness<T>>;
+declare const hydrateBoundWitness: (archivist: ReadArchivist, hashOrBw: Hash | WithStorageMeta<BoundWitness>) => Promise<HydratedBoundWitness<BoundWitness>>;
+
 declare const ArchivistAllQuerySchema: "network.xyo.query.archivist.all";
 type ArchivistAllQuerySchema = typeof ArchivistAllQuerySchema;
 type ArchivistAllQuery = Query<{
@@ -992,4 +1009,4 @@ declare const withArchivistInstance: <R>(mod: any, closure: (mod: ArchivistInsta
     schema: _xyo_network_payload_model.Schema;
 }>>) => R) => R | undefined;
 
-export { type AllArchivist, type AllArchivistFunctions, type Archivist, type ArchivistAllQuery, ArchivistAllQuerySchema, type ArchivistClearQuery, ArchivistClearQuerySchema, type ArchivistCommitQuery, ArchivistCommitQuerySchema, type ArchivistConfig, ArchivistConfigSchema, type ArchivistDeleteQuery, ArchivistDeleteQuerySchema, type ArchivistGetQuery, ArchivistGetQuerySchema, type ArchivistInsertQuery, ArchivistInsertQuerySchema, type ArchivistInstance, type ArchivistLabels, type ArchivistModuleEventData, type ArchivistModuleInstance, type ArchivistModuleQueries, type ArchivistNextOptions, type ArchivistNextQuery, ArchivistNextQuerySchema, type ArchivistParams, type ArchivistParents, type ArchivistQueries, type ArchivistRawQueryFunctions, type ArchivistStorage, type AttachableArchivistInstance, type AttachableArchivistInstanceTypeCheck, type IndexDescription, type IndexDirection, IndexSeparator, IsAttachableArchivistInstanceFactory, type NextOptions, type ReadArchivist, type ReadArchivistFunctions, type StashArchivist, type StashArchivistFunctions, type WriteArchivist, type WriteArchivistFunctions, asArchivistInstance, asArchivistModule, asAttachableArchivistInstance, buildStandardIndexName, isArchivistInstance, isArchivistModule, isAttachableArchivistInstance, requiredAttachableArchivistInstanceFunctions, withArchivistInstance, withArchivistModule };
+export { type AllArchivist, type AllArchivistFunctions, type Archivist, type ArchivistAllQuery, ArchivistAllQuerySchema, type ArchivistClearQuery, ArchivistClearQuerySchema, type ArchivistCommitQuery, ArchivistCommitQuerySchema, type ArchivistConfig, ArchivistConfigSchema, type ArchivistDeleteQuery, ArchivistDeleteQuerySchema, type ArchivistGetQuery, ArchivistGetQuerySchema, type ArchivistInsertQuery, ArchivistInsertQuerySchema, type ArchivistInstance, type ArchivistLabels, type ArchivistModuleEventData, type ArchivistModuleInstance, type ArchivistModuleQueries, type ArchivistNextOptions, type ArchivistNextQuery, ArchivistNextQuerySchema, type ArchivistParams, type ArchivistParents, type ArchivistQueries, type ArchivistRawQueryFunctions, type ArchivistStorage, type AttachableArchivistInstance, type AttachableArchivistInstanceTypeCheck, type FullArchivist, type HydratedBoundWitness, type IdentityFunction, type IndexDescription, type IndexDirection, IndexSeparator, IsAttachableArchivistInstanceFactory, type NextOptions, type ReadArchivist, type ReadArchivistFunctions, type ReadWriteArchivist, type StashArchivist, type StashArchivistFunctions, type WriteArchivist, type WriteArchivistFunctions, asArchivistInstance, asArchivistModule, asAttachableArchivistInstance, buildStandardIndexName, getBoundWitness, getTypedBoundWitness, hydrateBoundWitness, hydrateTypedBoundWitness, isArchivistInstance, isArchivistModule, isAttachableArchivistInstance, requiredAttachableArchivistInstanceFunctions, tryGetTypedBoundWitness, tryHydrateTypedBoundWitness, withArchivistInstance, withArchivistModule };

package/dist/neutral/index.mjs

@@ -70,6 +70,37 @@ var buildStandardIndexName = (index) => {
   const indexKeys = Object.keys(key);
   return `${prefix}_${indexKeys.join(IndexSeparator)}`;
 };
+
+// src/lib/getBoundWitness.ts
+import { assertEx } from "@xylabs/assert";
+import { isBoundWitnessWithStorageMeta } from "@xyo-network/boundwitness-model";
+var tryGetTypedBoundWitness = async (archivist, hash, identity) => {
+  const payload = (await archivist.get([hash])).at(0);
+  return identity(payload) ? payload : void 0;
+};
+var getTypedBoundWitness = async (archivist, hash, identity) => {
+  const payload = assertEx((await archivist.get([hash])).at(0), () => `failed to locate bound witness: ${hash}`);
+  return assertEx(identity(payload) ? payload : void 0, () => `located payload failed identity check: ${hash}`);
+};
+var getBoundWitness = (archivist, hash) => {
+  return getTypedBoundWitness(archivist, hash, isBoundWitnessWithStorageMeta);
+};
+
+// src/lib/hydrateBoundWitness.ts
+import { exists } from "@xylabs/exists";
+import { isHash } from "@xylabs/hex";
+import { isBoundWitnessWithStorageMeta as isBoundWitnessWithStorageMeta2 } from "@xyo-network/boundwitness-model";
+var tryHydrateTypedBoundWitness = async (archivist, hashOrBw, identity) => {
+  const bw = isHash(hashOrBw) ? await tryGetTypedBoundWitness(archivist, hashOrBw, identity) : hashOrBw;
+  return bw ? [bw, (await archivist.get(bw?.payload_hashes)).filter(exists)] : void 0;
+};
+var hydrateTypedBoundWitness = async (archivist, hashOrBw, identity) => {
+  const bw = isHash(hashOrBw) ? await getTypedBoundWitness(archivist, hashOrBw, identity) : hashOrBw;
+  return [bw, (await archivist.get(bw?.payload_hashes)).filter(exists)];
+};
+var hydrateBoundWitness = (archivist, hashOrBw) => {
+  return hydrateTypedBoundWitness(archivist, hashOrBw, isBoundWitnessWithStorageMeta2);
+};
 export {
   ArchivistAllQuerySchema,
   ArchivistClearQuerySchema,
@@ -85,10 +116,16 @@ export {
   asArchivistModule,
   asAttachableArchivistInstance,
   buildStandardIndexName,
+  getBoundWitness,
+  getTypedBoundWitness,
+  hydrateBoundWitness,
+  hydrateTypedBoundWitness,
   isArchivistInstance,
   isArchivistModule,
   isAttachableArchivistInstance,
   requiredAttachableArchivistInstanceFunctions,
+  tryGetTypedBoundWitness,
+  tryHydrateTypedBoundWitness,
   withArchivistInstance,
   withArchivistModule
 };

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/attachable/asAttachableInstance.ts","../../src/attachable/isAttachableInstance.ts","../../src/typeChecks.ts","../../src/Queries/All.ts","../../src/Queries/Clear.ts","../../src/Queries/Commit.ts","../../src/Queries/Delete.ts","../../src/Queries/Get.ts","../../src/Queries/Insert.ts","../../src/Queries/Next.ts","../../src/attachable/AttachableInstance.ts","../../src/Config.ts","../../src/IndexDescription.ts"],"sourcesContent":["import { AsObjectFactory } from '@xylabs/object'\n\nimport { isAttachableArchivistInstance } from './isAttachableInstance.ts'\n\nexport const asAttachableArchivistInstance = AsObjectFactory.create(isAttachableArchivistInstance)\n","import type { TypeCheck } from '@xylabs/object'\nimport { IsObjectFactory } from '@xylabs/object'\nimport type { ObjectTypeShape } from '@xylabs/typeof'\nimport { isAttachableModuleInstance } from '@xyo-network/module-model'\n\nimport { isArchivistInstance } from '../typeChecks.ts'\nimport type { AttachableArchivistInstance } from './AttachableInstance.ts'\n\nexport const requiredAttachableArchivistInstanceFunctions: ObjectTypeShape = {}\n\n// we do not use IsInstanceFactory here to prevent a cycle\nconst factory = new IsObjectFactory<AttachableArchivistInstance>()\n\nexport const isAttachableArchivistInstance: TypeCheck<AttachableArchivistInstance> = factory.create(requiredAttachableArchivistInstanceFunctions, [\n  isArchivistInstance,\n  isAttachableModuleInstance,\n])\n","import { AsObjectFactory } from '@xylabs/object'\nimport {\n  IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory,\n} from '@xyo-network/module-model'\n\nimport type { ArchivistInstance } from './Instance.ts'\nimport type { ArchivistModuleInstance } from './ModuleInstance.ts'\nimport { ArchivistGetQuerySchema } from './Queries/index.ts'\n\nexport const isArchivistInstance = new IsInstanceFactory<ArchivistInstance>().create({ get: 'function' }, [isModuleInstance])\nexport const isArchivistModule = new IsModuleFactory<ArchivistModuleInstance>().create([ArchivistGetQuerySchema])\n\nexport const asArchivistModule = AsObjectFactory.create(isArchivistModule)\nexport const asArchivistInstance = AsObjectFactory.create(isArchivistInstance)\nexport const withArchivistModule = WithFactory.create(isArchivistModule)\nexport const withArchivistInstance = WithFactory.create(isArchivistInstance)\n","import type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistAllQuerySchema = 'network.xyo.query.archivist.all' as const\nexport type ArchivistAllQuerySchema = typeof ArchivistAllQuerySchema\n\nexport type ArchivistAllQuery = Query<{\n  schema: ArchivistAllQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistClearQuerySchema = 'network.xyo.query.archivist.clear' as const\nexport type ArchivistClearQuerySchema = typeof ArchivistClearQuerySchema\n\nexport type ArchivistClearQuery = Query<{\n  schema: ArchivistClearQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistCommitQuerySchema = 'network.xyo.query.archivist.commit' as const\nexport type ArchivistCommitQuerySchema = typeof ArchivistCommitQuerySchema\n\nexport type ArchivistCommitQuery = Query<{\n  schema: ArchivistCommitQuerySchema\n}>\n","import type { Hash } from '@xylabs/hex'\nimport type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistDeleteQuerySchema = 'network.xyo.query.archivist.delete' as const\nexport type ArchivistDeleteQuerySchema = typeof ArchivistDeleteQuerySchema\n\nexport type ArchivistDeleteQuery = Query<{\n  hashes: Hash[]\n  schema: ArchivistDeleteQuerySchema\n}>\n","import type { Hash } from '@xylabs/hex'\nimport type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistGetQuerySchema = 'network.xyo.query.archivist.get' as const\nexport type ArchivistGetQuerySchema = typeof ArchivistGetQuerySchema\n\nexport type ArchivistGetQuery = Query<{\n  hashes: Hash[]\n  schema: ArchivistGetQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistInsertQuerySchema = 'network.xyo.query.archivist.insert' as const\nexport type ArchivistInsertQuerySchema = typeof ArchivistInsertQuerySchema\n\nexport type ArchivistInsertQuery = Query<{\n  schema: ArchivistInsertQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nimport type { ArchivistNextOptions } from '../NextOptions.ts'\n\nexport const ArchivistNextQuerySchema = 'network.xyo.query.archivist.next' as const\nexport type ArchivistNextQuerySchema = typeof ArchivistNextQuerySchema\n\nexport type ArchivistNextQuery = Query<ArchivistNextOptions, ArchivistNextQuerySchema>\n","import type { TypeCheck } from '@xylabs/object'\nimport { IsObjectFactory } from '@xylabs/object'\nimport type { AttachableModuleInstance } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\n\nimport type { ArchivistModuleEventData } from '../EventData.ts'\nimport type { ArchivistInstance } from '../Instance.ts'\nimport type { ArchivistModuleInstance } from '../ModuleInstance.ts'\nimport type { ArchivistParams } from '../Params.ts'\n\nexport interface AttachableArchivistInstance<\n  TParams extends ArchivistParams = ArchivistParams,\n  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n  TPayload extends Payload = Payload,\n> extends ArchivistModuleInstance<TParams, TEventData>,\n  AttachableModuleInstance<TParams, TEventData>,\n  ArchivistInstance<TParams, TEventData, TPayload> {}\n\nexport type AttachableArchivistInstanceTypeCheck<T extends AttachableArchivistInstance = AttachableArchivistInstance> = TypeCheck<T>\n\nexport class IsAttachableArchivistInstanceFactory<T extends AttachableArchivistInstance = AttachableArchivistInstance> extends IsObjectFactory<T> {}\n","import type { EmptyObject, WithAdditional } from '@xylabs/object'\nimport type { ModuleConfig, ModuleIdentifier } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\n\nimport type { IndexDescription } from './IndexDescription.ts'\n\nexport interface ArchivistParents {\n  commit?: ModuleIdentifier[]\n  read?: ModuleIdentifier[]\n  write?: ModuleIdentifier[]\n}\n\nexport interface ArchivistStorage {\n  /** The indexes to create on the object store */\n  indexes?: IndexDescription[]\n}\n\nexport const ArchivistConfigSchema = 'network.xyo.archivist.config' as const\nexport type ArchivistConfigSchema = typeof ArchivistConfigSchema\n\nexport type ArchivistConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void> = ModuleConfig<\n  WithAdditional<\n    {\n      /** @field address of one or more parent archivists to read from */\n      parents?: ArchivistParents\n      /** @field fail if some parents can not be resolved (true if unspecified) */\n      requireAllParents?: boolean\n      schema: TConfig extends Payload ? TConfig['schema'] : ArchivistConfigSchema\n      /** @field storage configuration */\n      storage?: ArchivistStorage\n      /** @field should child store all reads from parents? */\n      storeParentReads?: boolean\n    },\n    TConfig\n  >,\n  TSchema\n>\n","/**\n * The index direction (1 for ascending, -1 for descending)\n */\nexport type IndexDirection = -1 | 1\n\n/**\n * Description of index(es) to be created on a store\n */\nexport type IndexDescription = {\n  /**\n   * The key(s) to index\n   */\n  key: Record<string, IndexDirection>\n  /**\n   * Is the indexed value an array\n   */\n  multiEntry?: boolean\n  /**\n   * The name of the index\n   */\n  name?: string\n  /**\n   * If true, the index must enforce uniqueness on the key\n   */\n  unique?: boolean\n}\n\nexport const IndexSeparator = '-'\n\n/**\n * Given an index description, this will build the index\n * name in standard form\n * @param index The index description\n * @returns The index name in standard form\n */\nexport const buildStandardIndexName = (index: IndexDescription) => {\n  const { key, unique } = index\n  const prefix = unique ? 'UX' : 'IX'\n  const indexKeys = Object.keys(key)\n  return `${prefix}_${indexKeys.join(IndexSeparator)}`\n}\n"],"mappings":";AAAA,SAAS,mBAAAA,wBAAuB;;;ACChC,SAAS,uBAAuB;AAEhC,SAAS,kCAAkC;;;ACH3C,SAAS,uBAAuB;AAChC;AAAA,EACE;AAAA,EAAmB;AAAA,EAAiB;AAAA,EAAkB;AAAA,OACjD;;;ACDA,IAAM,0BAA0B;;;ACAhC,IAAM,4BAA4B;;;ACAlC,IAAM,6BAA6B;;;ACCnC,IAAM,6BAA6B;;;ACAnC,IAAM,0BAA0B;;;ACDhC,IAAM,6BAA6B;;;ACEnC,IAAM,2BAA2B;;;APKjC,IAAM,sBAAsB,IAAI,kBAAqC,EAAE,OAAO,EAAE,KAAK,WAAW,GAAG,CAAC,gBAAgB,CAAC;AACrH,IAAM,oBAAoB,IAAI,gBAAyC,EAAE,OAAO,CAAC,uBAAuB,CAAC;AAEzG,IAAM,oBAAoB,gBAAgB,OAAO,iBAAiB;AAClE,IAAM,sBAAsB,gBAAgB,OAAO,mBAAmB;AACtE,IAAM,sBAAsB,YAAY,OAAO,iBAAiB;AAChE,IAAM,wBAAwB,YAAY,OAAO,mBAAmB;;;ADPpE,IAAM,+CAAgE,CAAC;AAG9E,IAAM,UAAU,IAAI,gBAA6C;AAE1D,IAAM,gCAAwE,QAAQ,OAAO,8CAA8C;AAAA,EAChJ;AAAA,EACA;AACF,CAAC;;;ADZM,IAAM,gCAAgCC,iBAAgB,OAAO,6BAA6B;;;AUHjG,SAAS,mBAAAC,wBAAuB;AAmBzB,IAAM,uCAAN,cAAwHA,iBAAmB;AAAC;;;ACH5I,IAAM,wBAAwB;;;ACU9B,IAAM,iBAAiB;AAQvB,IAAM,yBAAyB,CAAC,UAA4B;AACjE,QAAM,EAAE,KAAK,OAAO,IAAI;AACxB,QAAM,SAAS,SAAS,OAAO;AAC/B,QAAM,YAAY,OAAO,KAAK,GAAG;AACjC,SAAO,GAAG,MAAM,IAAI,UAAU,KAAK,cAAc,CAAC;AACpD;","names":["AsObjectFactory","AsObjectFactory","IsObjectFactory"]}
+{"version":3,"sources":["../../src/attachable/asAttachableInstance.ts","../../src/attachable/isAttachableInstance.ts","../../src/typeChecks.ts","../../src/Queries/All.ts","../../src/Queries/Clear.ts","../../src/Queries/Commit.ts","../../src/Queries/Delete.ts","../../src/Queries/Get.ts","../../src/Queries/Insert.ts","../../src/Queries/Next.ts","../../src/attachable/AttachableInstance.ts","../../src/Config.ts","../../src/IndexDescription.ts","../../src/lib/getBoundWitness.ts","../../src/lib/hydrateBoundWitness.ts"],"sourcesContent":["import { AsObjectFactory } from '@xylabs/object'\n\nimport { isAttachableArchivistInstance } from './isAttachableInstance.ts'\n\nexport const asAttachableArchivistInstance = AsObjectFactory.create(isAttachableArchivistInstance)\n","import type { TypeCheck } from '@xylabs/object'\nimport { IsObjectFactory } from '@xylabs/object'\nimport type { ObjectTypeShape } from '@xylabs/typeof'\nimport { isAttachableModuleInstance } from '@xyo-network/module-model'\n\nimport { isArchivistInstance } from '../typeChecks.ts'\nimport type { AttachableArchivistInstance } from './AttachableInstance.ts'\n\nexport const requiredAttachableArchivistInstanceFunctions: ObjectTypeShape = {}\n\n// we do not use IsInstanceFactory here to prevent a cycle\nconst factory = new IsObjectFactory<AttachableArchivistInstance>()\n\nexport const isAttachableArchivistInstance: TypeCheck<AttachableArchivistInstance> = factory.create(requiredAttachableArchivistInstanceFunctions, [\n  isArchivistInstance,\n  isAttachableModuleInstance,\n])\n","import { AsObjectFactory } from '@xylabs/object'\nimport {\n  IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory,\n} from '@xyo-network/module-model'\n\nimport type { ArchivistInstance } from './Instance.ts'\nimport type { ArchivistModuleInstance } from './ModuleInstance.ts'\nimport { ArchivistGetQuerySchema } from './Queries/index.ts'\n\nexport const isArchivistInstance = new IsInstanceFactory<ArchivistInstance>().create({ get: 'function' }, [isModuleInstance])\nexport const isArchivistModule = new IsModuleFactory<ArchivistModuleInstance>().create([ArchivistGetQuerySchema])\n\nexport const asArchivistModule = AsObjectFactory.create(isArchivistModule)\nexport const asArchivistInstance = AsObjectFactory.create(isArchivistInstance)\nexport const withArchivistModule = WithFactory.create(isArchivistModule)\nexport const withArchivistInstance = WithFactory.create(isArchivistInstance)\n","import type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistAllQuerySchema = 'network.xyo.query.archivist.all' as const\nexport type ArchivistAllQuerySchema = typeof ArchivistAllQuerySchema\n\nexport type ArchivistAllQuery = Query<{\n  schema: ArchivistAllQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistClearQuerySchema = 'network.xyo.query.archivist.clear' as const\nexport type ArchivistClearQuerySchema = typeof ArchivistClearQuerySchema\n\nexport type ArchivistClearQuery = Query<{\n  schema: ArchivistClearQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistCommitQuerySchema = 'network.xyo.query.archivist.commit' as const\nexport type ArchivistCommitQuerySchema = typeof ArchivistCommitQuerySchema\n\nexport type ArchivistCommitQuery = Query<{\n  schema: ArchivistCommitQuerySchema\n}>\n","import type { Hash } from '@xylabs/hex'\nimport type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistDeleteQuerySchema = 'network.xyo.query.archivist.delete' as const\nexport type ArchivistDeleteQuerySchema = typeof ArchivistDeleteQuerySchema\n\nexport type ArchivistDeleteQuery = Query<{\n  hashes: Hash[]\n  schema: ArchivistDeleteQuerySchema\n}>\n","import type { Hash } from '@xylabs/hex'\nimport type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistGetQuerySchema = 'network.xyo.query.archivist.get' as const\nexport type ArchivistGetQuerySchema = typeof ArchivistGetQuerySchema\n\nexport type ArchivistGetQuery = Query<{\n  hashes: Hash[]\n  schema: ArchivistGetQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistInsertQuerySchema = 'network.xyo.query.archivist.insert' as const\nexport type ArchivistInsertQuerySchema = typeof ArchivistInsertQuerySchema\n\nexport type ArchivistInsertQuery = Query<{\n  schema: ArchivistInsertQuerySchema\n}>\n","import type { Query } from '@xyo-network/payload-model'\n\nimport type { ArchivistNextOptions } from '../NextOptions.ts'\n\nexport const ArchivistNextQuerySchema = 'network.xyo.query.archivist.next' as const\nexport type ArchivistNextQuerySchema = typeof ArchivistNextQuerySchema\n\nexport type ArchivistNextQuery = Query<ArchivistNextOptions, ArchivistNextQuerySchema>\n","import type { TypeCheck } from '@xylabs/object'\nimport { IsObjectFactory } from '@xylabs/object'\nimport type { AttachableModuleInstance } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\n\nimport type { ArchivistModuleEventData } from '../EventData.ts'\nimport type { ArchivistInstance } from '../Instance.ts'\nimport type { ArchivistModuleInstance } from '../ModuleInstance.ts'\nimport type { ArchivistParams } from '../Params.ts'\n\nexport interface AttachableArchivistInstance<\n  TParams extends ArchivistParams = ArchivistParams,\n  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n  TPayload extends Payload = Payload,\n> extends ArchivistModuleInstance<TParams, TEventData>,\n  AttachableModuleInstance<TParams, TEventData>,\n  ArchivistInstance<TParams, TEventData, TPayload> {}\n\nexport type AttachableArchivistInstanceTypeCheck<T extends AttachableArchivistInstance = AttachableArchivistInstance> = TypeCheck<T>\n\nexport class IsAttachableArchivistInstanceFactory<T extends AttachableArchivistInstance = AttachableArchivistInstance> extends IsObjectFactory<T> {}\n","import type { EmptyObject, WithAdditional } from '@xylabs/object'\nimport type { ModuleConfig, ModuleIdentifier } from '@xyo-network/module-model'\nimport type { Payload } from '@xyo-network/payload-model'\n\nimport type { IndexDescription } from './IndexDescription.ts'\n\nexport interface ArchivistParents {\n  commit?: ModuleIdentifier[]\n  read?: ModuleIdentifier[]\n  write?: ModuleIdentifier[]\n}\n\nexport interface ArchivistStorage {\n  /** The indexes to create on the object store */\n  indexes?: IndexDescription[]\n}\n\nexport const ArchivistConfigSchema = 'network.xyo.archivist.config' as const\nexport type ArchivistConfigSchema = typeof ArchivistConfigSchema\n\nexport type ArchivistConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void> = ModuleConfig<\n  WithAdditional<\n    {\n      /** @field address of one or more parent archivists to read from */\n      parents?: ArchivistParents\n      /** @field fail if some parents can not be resolved (true if unspecified) */\n      requireAllParents?: boolean\n      schema: TConfig extends Payload ? TConfig['schema'] : ArchivistConfigSchema\n      /** @field storage configuration */\n      storage?: ArchivistStorage\n      /** @field should child store all reads from parents? */\n      storeParentReads?: boolean\n    },\n    TConfig\n  >,\n  TSchema\n>\n","/**\n * The index direction (1 for ascending, -1 for descending)\n */\nexport type IndexDirection = -1 | 1\n\n/**\n * Description of index(es) to be created on a store\n */\nexport type IndexDescription = {\n  /**\n   * The key(s) to index\n   */\n  key: Record<string, IndexDirection>\n  /**\n   * Is the indexed value an array\n   */\n  multiEntry?: boolean\n  /**\n   * The name of the index\n   */\n  name?: string\n  /**\n   * If true, the index must enforce uniqueness on the key\n   */\n  unique?: boolean\n}\n\nexport const IndexSeparator = '-'\n\n/**\n * Given an index description, this will build the index\n * name in standard form\n * @param index The index description\n * @returns The index name in standard form\n */\nexport const buildStandardIndexName = (index: IndexDescription) => {\n  const { key, unique } = index\n  const prefix = unique ? 'UX' : 'IX'\n  const indexKeys = Object.keys(key)\n  return `${prefix}_${indexKeys.join(IndexSeparator)}`\n}\n","import { assertEx } from '@xylabs/assert'\nimport type { Hash } from '@xylabs/hex'\nimport type { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { isBoundWitnessWithStorageMeta } from '@xyo-network/boundwitness-model'\nimport type { WithStorageMeta } from '@xyo-network/payload-model'\n\nimport type { ReadArchivist } from '../PayloadArchivist.ts'\nimport type { IdentityFunction } from './IdentityFunction.ts'\n\nexport const tryGetTypedBoundWitness = async <T extends BoundWitness>(archivist: ReadArchivist, hash: Hash,\n  identity: IdentityFunction<WithStorageMeta<T>>): Promise<WithStorageMeta<T> | undefined> => {\n  const payload = (await archivist.get([hash])).at(0)\n  return identity(payload) ? payload : undefined\n}\n\nexport const getTypedBoundWitness = async <T extends BoundWitness>(archivist: ReadArchivist, hash: Hash,\n  identity: IdentityFunction<WithStorageMeta<T>>): Promise<WithStorageMeta<T>> => {\n  const payload = assertEx((await archivist.get([hash])).at(0), () => `failed to locate bound witness: ${hash}`)\n  return assertEx(identity(payload) ? payload : undefined, () => `located payload failed identity check: ${hash}`)\n}\n\nexport const getBoundWitness = (archivist: ReadArchivist, hash: Hash): Promise<WithStorageMeta<BoundWitness>> => {\n  return getTypedBoundWitness<BoundWitness>(archivist, hash, isBoundWitnessWithStorageMeta)\n}\n","import { exists } from '@xylabs/exists'\nimport { type Hash, isHash } from '@xylabs/hex'\nimport { type BoundWitness, isBoundWitnessWithStorageMeta } from '@xyo-network/boundwitness-model'\nimport type { WithStorageMeta } from '@xyo-network/payload-model'\n\nimport type { ReadArchivist } from '../PayloadArchivist.ts'\nimport { getTypedBoundWitness, tryGetTypedBoundWitness } from './getBoundWitness.ts'\nimport type { HydratedBoundWitness } from './HydratedBoundWitness.ts'\nimport type { IdentityFunction } from './IdentityFunction.ts'\n\nexport const tryHydrateTypedBoundWitness = async <T extends BoundWitness>(archivist: ReadArchivist, hashOrBw: Hash | WithStorageMeta<T>,\n  identity: IdentityFunction<WithStorageMeta<T>>): Promise<HydratedBoundWitness<T> | undefined> => {\n  const bw = isHash(hashOrBw) ? await tryGetTypedBoundWitness(archivist, hashOrBw, identity) : hashOrBw\n  return bw ? [bw, (await archivist.get(bw?.payload_hashes)).filter(exists)] : undefined\n}\n\nexport const hydrateTypedBoundWitness = async <T extends BoundWitness>(archivist: ReadArchivist, hashOrBw: Hash | WithStorageMeta<T>,\n  identity: IdentityFunction<WithStorageMeta<T>>): Promise<HydratedBoundWitness<T>> => {\n  const bw = isHash(hashOrBw) ? await getTypedBoundWitness(archivist, hashOrBw, identity) : hashOrBw\n  return [bw, (await archivist.get(bw?.payload_hashes)).filter(exists)]\n}\n\nexport const hydrateBoundWitness = (\n  archivist: ReadArchivist,\n  hashOrBw: Hash | WithStorageMeta<BoundWitness>,\n): Promise<HydratedBoundWitness<BoundWitness>> => {\n  return hydrateTypedBoundWitness<BoundWitness>(archivist, hashOrBw, isBoundWitnessWithStorageMeta)\n}\n"],"mappings":";AAAA,SAAS,mBAAAA,wBAAuB;;;ACChC,SAAS,uBAAuB;AAEhC,SAAS,kCAAkC;;;ACH3C,SAAS,uBAAuB;AAChC;AAAA,EACE;AAAA,EAAmB;AAAA,EAAiB;AAAA,EAAkB;AAAA,OACjD;;;ACDA,IAAM,0BAA0B;;;ACAhC,IAAM,4BAA4B;;;ACAlC,IAAM,6BAA6B;;;ACCnC,IAAM,6BAA6B;;;ACAnC,IAAM,0BAA0B;;;ACDhC,IAAM,6BAA6B;;;ACEnC,IAAM,2BAA2B;;;APKjC,IAAM,sBAAsB,IAAI,kBAAqC,EAAE,OAAO,EAAE,KAAK,WAAW,GAAG,CAAC,gBAAgB,CAAC;AACrH,IAAM,oBAAoB,IAAI,gBAAyC,EAAE,OAAO,CAAC,uBAAuB,CAAC;AAEzG,IAAM,oBAAoB,gBAAgB,OAAO,iBAAiB;AAClE,IAAM,sBAAsB,gBAAgB,OAAO,mBAAmB;AACtE,IAAM,sBAAsB,YAAY,OAAO,iBAAiB;AAChE,IAAM,wBAAwB,YAAY,OAAO,mBAAmB;;;ADPpE,IAAM,+CAAgE,CAAC;AAG9E,IAAM,UAAU,IAAI,gBAA6C;AAE1D,IAAM,gCAAwE,QAAQ,OAAO,8CAA8C;AAAA,EAChJ;AAAA,EACA;AACF,CAAC;;;ADZM,IAAM,gCAAgCC,iBAAgB,OAAO,6BAA6B;;;AUHjG,SAAS,mBAAAC,wBAAuB;AAmBzB,IAAM,uCAAN,cAAwHA,iBAAmB;AAAC;;;ACH5I,IAAM,wBAAwB;;;ACU9B,IAAM,iBAAiB;AAQvB,IAAM,yBAAyB,CAAC,UAA4B;AACjE,QAAM,EAAE,KAAK,OAAO,IAAI;AACxB,QAAM,SAAS,SAAS,OAAO;AAC/B,QAAM,YAAY,OAAO,KAAK,GAAG;AACjC,SAAO,GAAG,MAAM,IAAI,UAAU,KAAK,cAAc,CAAC;AACpD;;;ACxCA,SAAS,gBAAgB;AAGzB,SAAS,qCAAqC;AAMvC,IAAM,0BAA0B,OAA+B,WAA0B,MAC9F,aAA4F;AAC5F,QAAM,WAAW,MAAM,UAAU,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;AAClD,SAAO,SAAS,OAAO,IAAI,UAAU;AACvC;AAEO,IAAM,uBAAuB,OAA+B,WAA0B,MAC3F,aAAgF;AAChF,QAAM,UAAU,UAAU,MAAM,UAAU,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,GAAG,MAAM,mCAAmC,IAAI,EAAE;AAC7G,SAAO,SAAS,SAAS,OAAO,IAAI,UAAU,QAAW,MAAM,0CAA0C,IAAI,EAAE;AACjH;AAEO,IAAM,kBAAkB,CAAC,WAA0B,SAAuD;AAC/G,SAAO,qBAAmC,WAAW,MAAM,6BAA6B;AAC1F;;;ACvBA,SAAS,cAAc;AACvB,SAAoB,cAAc;AAClC,SAA4B,iCAAAC,sCAAqC;AAQ1D,IAAM,8BAA8B,OAA+B,WAA0B,UAClG,aAAiG;AACjG,QAAM,KAAK,OAAO,QAAQ,IAAI,MAAM,wBAAwB,WAAW,UAAU,QAAQ,IAAI;AAC7F,SAAO,KAAK,CAAC,KAAK,MAAM,UAAU,IAAI,IAAI,cAAc,GAAG,OAAO,MAAM,CAAC,IAAI;AAC/E;AAEO,IAAM,2BAA2B,OAA+B,WAA0B,UAC/F,aAAqF;AACrF,QAAM,KAAK,OAAO,QAAQ,IAAI,MAAM,qBAAqB,WAAW,UAAU,QAAQ,IAAI;AAC1F,SAAO,CAAC,KAAK,MAAM,UAAU,IAAI,IAAI,cAAc,GAAG,OAAO,MAAM,CAAC;AACtE;AAEO,IAAM,sBAAsB,CACjC,WACA,aACgD;AAChD,SAAO,yBAAuC,WAAW,UAAUC,8BAA6B;AAClG;","names":["AsObjectFactory","AsObjectFactory","IsObjectFactory","isBoundWitnessWithStorageMeta","isBoundWitnessWithStorageMeta"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-model",
-  "version": "3.8.4",
+  "version": "3.9.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,18 +29,21 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
+    "@xylabs/assert": "^4.5.1",
+    "@xylabs/exists": "^4.5.1",
     "@xylabs/hex": "^4.5.1",
     "@xylabs/object": "^4.5.1",
     "@xylabs/promise": "^4.5.1",
     "@xylabs/typeof": "^4.5.1",
-    "@xyo-network/account-model": "^3.8.4",
-    "@xyo-network/module-events": "^3.8.4",
-    "@xyo-network/module-model": "^3.8.4",
-    "@xyo-network/payload-model": "^3.8.4"
+    "@xyo-network/account-model": "^3.9.0",
+    "@xyo-network/boundwitness-model": "^3.9.0",
+    "@xyo-network/module-events": "^3.9.0",
+    "@xyo-network/module-model": "^3.9.0",
+    "@xyo-network/payload-model": "^3.9.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^5.0.22",
-    "@xylabs/tsconfig": "^5.0.22",
+    "@xylabs/ts-scripts-yarn3": "^5.0.23",
+    "@xylabs/tsconfig": "^5.0.23",
     "typescript": "^5.7.3"
   },
   "publishConfig": {

package/src/PayloadArchivist.ts

@@ -16,15 +16,29 @@ export interface ReadArchivist<
 
 export interface WriteArchivist<
   TReadResponse extends Payload = Payload,
-  TWriteResponse = TReadResponse,
-  TWrite = TReadResponse,
+  TWriteResponse extends Payload = TReadResponse,
+  TWrite extends Payload = TReadResponse,
   TId = Hash,
 > extends WriteArchivistFunctions<WithStorageMeta<TReadResponse>, TWriteResponse, TWrite, TId> {}
 
+export interface ReadWriteArchivist<
+  TReadResponse extends Payload = Payload,
+  TWriteResponse extends Payload = TReadResponse,
+  TWrite extends Payload = TReadResponse,
+  TId = Hash,
+> extends WriteArchivist<TReadResponse, TWriteResponse, TWrite, TId>, ReadArchivist<TReadResponse, TId> {}
+
 export interface StashArchivist<
   TWriteResponse extends Payload = Payload,
 > extends StashArchivistFunctions<WithStorageMeta<TWriteResponse>> {}
 
+export interface FullArchivist<
+  TReadResponse extends Payload = Payload,
+  TWriteResponse extends Payload = TReadResponse,
+  TWrite extends Payload = TReadResponse,
+  TId = Hash,
+> extends ReadWriteArchivist<TReadResponse, TWriteResponse, TWrite, TId>, StashArchivist<TWriteResponse> {}
+
 export interface Archivist<
   TReadResponse extends Payload = Payload,
   TWriteResponse extends Payload = Payload,

package/src/index.ts

@@ -5,6 +5,7 @@ export * from './EventData.ts'
 export * from './IndexDescription.ts'
 export * from './Instance.ts'
 export * from './Labels.ts'
+export * from './lib/index.ts'
 export * from './ModuleInstance.ts'
 export * from './NextOptions.ts'
 export * from './Params.ts'

package/src/lib/HydratedBoundWitness.ts

@@ -0,0 +1,4 @@
+import type { BoundWitness } from '@xyo-network/boundwitness-model'
+import type { Payload, WithStorageMeta } from '@xyo-network/payload-model'
+
+export type HydratedBoundWitness<T extends BoundWitness = BoundWitness, P extends Payload = Payload> = [WithStorageMeta<T>, WithStorageMeta<P>[]]

package/src/lib/IdentityFunction.ts

@@ -0,0 +1 @@
+export type IdentityFunction<T> = (value: unknown) => value is T

package/src/lib/getBoundWitness.ts

@@ -0,0 +1,24 @@
+import { assertEx } from '@xylabs/assert'
+import type { Hash } from '@xylabs/hex'
+import type { BoundWitness } from '@xyo-network/boundwitness-model'
+import { isBoundWitnessWithStorageMeta } from '@xyo-network/boundwitness-model'
+import type { WithStorageMeta } from '@xyo-network/payload-model'
+
+import type { ReadArchivist } from '../PayloadArchivist.ts'
+import type { IdentityFunction } from './IdentityFunction.ts'
+
+export const tryGetTypedBoundWitness = async <T extends BoundWitness>(archivist: ReadArchivist, hash: Hash,
+  identity: IdentityFunction<WithStorageMeta<T>>): Promise<WithStorageMeta<T> | undefined> => {
+  const payload = (await archivist.get([hash])).at(0)
+  return identity(payload) ? payload : undefined
+}
+
+export const getTypedBoundWitness = async <T extends BoundWitness>(archivist: ReadArchivist, hash: Hash,
+  identity: IdentityFunction<WithStorageMeta<T>>): Promise<WithStorageMeta<T>> => {
+  const payload = assertEx((await archivist.get([hash])).at(0), () => `failed to locate bound witness: ${hash}`)
+  return assertEx(identity(payload) ? payload : undefined, () => `located payload failed identity check: ${hash}`)
+}
+
+export const getBoundWitness = (archivist: ReadArchivist, hash: Hash): Promise<WithStorageMeta<BoundWitness>> => {
+  return getTypedBoundWitness<BoundWitness>(archivist, hash, isBoundWitnessWithStorageMeta)
+}

package/src/lib/hydrateBoundWitness.ts

@@ -0,0 +1,28 @@
+import { exists } from '@xylabs/exists'
+import { type Hash, isHash } from '@xylabs/hex'
+import { type BoundWitness, isBoundWitnessWithStorageMeta } from '@xyo-network/boundwitness-model'
+import type { WithStorageMeta } from '@xyo-network/payload-model'
+
+import type { ReadArchivist } from '../PayloadArchivist.ts'
+import { getTypedBoundWitness, tryGetTypedBoundWitness } from './getBoundWitness.ts'
+import type { HydratedBoundWitness } from './HydratedBoundWitness.ts'
+import type { IdentityFunction } from './IdentityFunction.ts'
+
+export const tryHydrateTypedBoundWitness = async <T extends BoundWitness>(archivist: ReadArchivist, hashOrBw: Hash | WithStorageMeta<T>,
+  identity: IdentityFunction<WithStorageMeta<T>>): Promise<HydratedBoundWitness<T> | undefined> => {
+  const bw = isHash(hashOrBw) ? await tryGetTypedBoundWitness(archivist, hashOrBw, identity) : hashOrBw
+  return bw ? [bw, (await archivist.get(bw?.payload_hashes)).filter(exists)] : undefined
+}
+
+export const hydrateTypedBoundWitness = async <T extends BoundWitness>(archivist: ReadArchivist, hashOrBw: Hash | WithStorageMeta<T>,
+  identity: IdentityFunction<WithStorageMeta<T>>): Promise<HydratedBoundWitness<T>> => {
+  const bw = isHash(hashOrBw) ? await getTypedBoundWitness(archivist, hashOrBw, identity) : hashOrBw
+  return [bw, (await archivist.get(bw?.payload_hashes)).filter(exists)]
+}
+
+export const hydrateBoundWitness = (
+  archivist: ReadArchivist,
+  hashOrBw: Hash | WithStorageMeta<BoundWitness>,
+): Promise<HydratedBoundWitness<BoundWitness>> => {
+  return hydrateTypedBoundWitness<BoundWitness>(archivist, hashOrBw, isBoundWitnessWithStorageMeta)
+}

package/src/lib/index.ts

@@ -0,0 +1,4 @@
+export * from './getBoundWitness.ts'
+export * from './hydrateBoundWitness.ts'
+export * from './HydratedBoundWitness.ts'
+export * from './IdentityFunction.ts'