@xyo-network/archivist-model 4.0.3 → 4.1.0

package/{dist/types → build/neutral}/typeChecks.d.ts

@@ -1,7 +1,8 @@
+import type { TypeCheck } from '@xylabs/object';
 import type { ArchivistInstance } from './Instance.ts';
 import type { ArchivistModuleInstance } from './ModuleInstance.ts';
-export declare const isArchivistInstance: import("@xylabs/object").TypeCheck<ArchivistInstance<import("./Params.ts").ArchivistParams<import("@xyo-network/module-model").AnyConfigSchema<import("./Config.ts").ArchivistConfig>>, import("./EventData.ts").ArchivistModuleEventData, import("@xyo-network/payload-model").Payload>>;
-export declare const isArchivistModule: import("@xyo-network/module-model").ModuleTypeCheck<ArchivistModuleInstance<import("@xyo-network/module-model").ModuleParams<import("@xyo-network/module-model").AnyConfigSchema<import("./Config.ts").ArchivistConfig>>, import("./EventData.ts").ArchivistModuleEventData>>;
+export declare const isArchivistInstance: TypeCheck<ArchivistInstance>;
+export declare const isArchivistModule: TypeCheck<ArchivistModuleInstance>;
 export declare const asArchivistModule: import("@xylabs/object").AsTypeFunction<ArchivistModuleInstance<import("@xyo-network/module-model").ModuleParams<import("@xyo-network/module-model").AnyConfigSchema<import("./Config.ts").ArchivistConfig>>, import("./EventData.ts").ArchivistModuleEventData>>;
 export declare const asArchivistInstance: import("@xylabs/object").AsTypeFunction<ArchivistInstance<import("./Params.ts").ArchivistParams<import("@xyo-network/module-model").AnyConfigSchema<import("./Config.ts").ArchivistConfig>>, import("./EventData.ts").ArchivistModuleEventData, import("@xyo-network/payload-model").Payload>>;
 export declare const withArchivistModule: <R>(mod: any, closure: (mod: ArchivistModuleInstance<import("@xyo-network/module-model").ModuleParams<import("@xyo-network/module-model").AnyConfigSchema<import("./Config.ts").ArchivistConfig>>, import("./EventData.ts").ArchivistModuleEventData>) => R) => R | undefined;

package/build/neutral/typeChecks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeChecks.d.ts","sourceRoot":"","sources":["../../src/typeChecks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAM/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAGlE,eAAO,MAAM,mBAAmB,EAAE,SAAS,CAAC,iBAAiB,CAA8F,CAAA;AAC3J,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC,uBAAuB,CAAoF,CAAA;AAErJ,eAAO,MAAM,iBAAiB,mQAA4C,CAAA;AAC1E,eAAO,MAAM,mBAAmB,gSAA8C,CAAA;AAC9E,eAAO,MAAM,mBAAmB,+QAAwC,CAAA;AACxE,eAAO,MAAM,qBAAqB,4SAA0C,CAAA"}

package/dist/neutral/index.d.ts

@@ -0,0 +1,282 @@
+import { Promisable, PromisableArray } from '@xylabs/promise';
+import { Hex, Hash } from '@xylabs/hex';
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import { Payload, PayloadHashMap, WithStorageMeta, Query } from '@xyo-network/payload-model';
+import * as _xylabs_object from '@xylabs/object';
+import { EmptyObject, WithAdditional, TypeCheck, IsObjectFactory } from '@xylabs/object';
+import * as _xyo_network_module_model from '@xyo-network/module-model';
+import { Module, ModuleEventArgs, ModuleEventData, ModuleQueryFunctions, ModuleConfig, ModuleIdentifier, ModuleParams, AnyConfigSchema, ModuleQueryResult, ModuleInstance, AttachableModuleInstance, Labels, ModuleQueries } from '@xyo-network/module-model';
+import { EventData, EventEmitter } from '@xylabs/events';
+import { AccountInstance } from '@xyo-network/account-model';
+import { ObjectTypeShape } from '@xylabs/typeof';
+import { BoundWitness, SignedBoundWitness } from '@xyo-network/boundwitness-model';
+
+interface NextOptions<TId = Hex> {
+    cursor?: TId;
+    limit?: number;
+    open?: boolean;
+    order?: 'asc' | 'desc';
+}
+interface ArchivistNextOptions extends NextOptions<Hash> {
+}
+
+interface ArchivistDriver<TId, TIn, TOut extends TIn> {
+    all(): Promisable<TOut[]>;
+    clear(): Promisable<void>;
+    count(): number;
+    delete(hashes: TId[]): Promise<TOut[]>;
+    get(hashes: TId[]): Promisable<TOut[]>;
+    insert(payloads: TIn[]): TOut[];
+    next(options?: NextOptions): Promisable<TOut[]>;
+}
+
+interface AllArchivistFunctions<TReadResponse, TSnapshotResponse> {
+    /** @deprecated use next or snapshot instead */
+    all(): PromisableArray<TReadResponse>;
+    snapshot(): PromisableArray<TSnapshotResponse>;
+}
+interface ReadArchivistFunctions<TReadResponse, TId = string> {
+    get(ids: TId[]): PromisableArray<TReadResponse>;
+    next(options?: NextOptions<TId>): PromisableArray<TReadResponse>;
+}
+interface WriteArchivistFunctions<TReadResponse, TWriteResponse = TReadResponse, TWrite = TReadResponse, TId = string> {
+    clear(): Promisable<void>;
+    delete(ids: TId[]): PromisableArray<TReadResponse>;
+    insert(item: TWrite[]): PromisableArray<TWriteResponse>;
+}
+interface StashArchivistFunctions<TWriteResponse> {
+    commit(): PromisableArray<TWriteResponse>;
+}
+
+declare const ArchivistSnapshotPayloadSchema: "network.xyo.archivist.snapshot";
+type ArchivistSnapshotPayloadSchema = typeof ArchivistSnapshotPayloadSchema;
+type ArchivistSnapshotPayload<TPayload extends Payload = Payload, TId extends string | number | symbol = Hash> = Payload<PayloadHashMap<TPayload, TId>, ArchivistSnapshotPayloadSchema>;
+
+declare const ArchivistStatsPayloadSchema: "network.xyo.archivist.stats";
+type ArchivistStatsPayloadSchema = typeof ArchivistStatsPayloadSchema;
+type ArchivistStatsPayload = Payload<{
+    payloadCount: number;
+}, ArchivistStatsPayloadSchema>;
+
+type ClearedEventArgs<T extends Module = Module> = ModuleEventArgs<T>;
+interface ClearedEventData<T extends Module = Module> extends EventData {
+    cleared: ClearedEventArgs<T>;
+}
+
+type DeletedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    hashes: Hash[];
+    payloads: Payload[];
+}>;
+interface DeletedEventData<T extends Module = Module> extends EventData {
+    deleted: DeletedEventArgs<T>;
+}
+
+type InsertedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    inPayloads: Payload[];
+    outPayloads: WithStorageMeta<Payload>[];
+    payloads: WithStorageMeta<Payload>[];
+}>;
+interface InsertedEventData<T extends Module = Module> extends EventData {
+    inserted: InsertedEventArgs<T>;
+}
+
+interface ArchivistModuleEventData extends InsertedEventData, DeletedEventData, ClearedEventData, ModuleEventData {
+}
+
+interface AllArchivist<TReadResponse extends Payload = Payload, TId extends string = Hash> extends AllArchivistFunctions<WithStorageMeta<TReadResponse>, PayloadHashMap<WithStorageMeta<TReadResponse>, TId>> {
+}
+interface ReadArchivist<TReadResponse extends Payload = Payload, TId extends string = Hash> extends ReadArchivistFunctions<WithStorageMeta<TReadResponse>, TId> {
+}
+interface WriteArchivist<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = TReadResponse, TWrite extends Payload = TReadResponse, TId extends string = Hash> extends WriteArchivistFunctions<WithStorageMeta<TReadResponse>, WithStorageMeta<TWriteResponse>, TWrite, TId> {
+}
+interface ReadWriteArchivist<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = TReadResponse, TWrite extends Payload = TReadResponse, TId extends string = 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 extends string = 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 extends string = Hash> extends ReadArchivist<WithStorageMeta<TReadResponse>, TId>, AllArchivist<WithStorageMeta<TReadResponse>, TId>, WriteArchivist<WithStorageMeta<TReadResponse>, WithStorageMeta<TWriteResponse>, TWrite, TId>, StashArchivistFunctions<TWriteResponse> {
+}
+
+interface ArchivistModule<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = Payload, TWrite extends Payload = TReadResponse & Payload, TId extends string = Hash> extends Archivist<TReadResponse, TWriteResponse, TWrite, TId>, ModuleQueryFunctions {
+}
+
+/**
+ * The index direction (1 for ascending, -1 for descending)
+ */
+type IndexDirection = -1 | 1;
+/**
+ * Description of index(es) to be created on a store
+ */
+type IndexDescription = {
+    /**
+     * The key(s) to index
+     */
+    key: Record<string, IndexDirection>;
+    /**
+     * Is the indexed value an array
+     */
+    multiEntry?: boolean;
+    /**
+     * The name of the index
+     */
+    name?: string;
+    /**
+     * If true, the index must enforce uniqueness on the key
+     */
+    unique?: boolean;
+};
+declare const IndexSeparator = "-";
+/**
+ * Given an index description, this will build the index
+ * name in standard form
+ * @param index The index description
+ * @returns The index name in standard form
+ */
+declare const buildStandardIndexName: (index: IndexDescription) => string;
+
+interface ArchivistParents {
+    commit?: ModuleIdentifier[];
+    read?: ModuleIdentifier[];
+    write?: ModuleIdentifier[];
+}
+interface ArchivistStorage {
+    /** The indexes to create on the object store */
+    indexes?: IndexDescription[];
+}
+interface ArchivistGetCache {
+    enabled?: boolean;
+    maxEntries?: number;
+}
+declare const ArchivistConfigSchema: "network.xyo.archivist.config";
+type ArchivistConfigSchema = typeof ArchivistConfigSchema;
+type ArchivistConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void> = ModuleConfig<WithAdditional<{
+    getCache?: ArchivistGetCache;
+    /** @field address of one or more parent archivists to read from */
+    parents?: ArchivistParents;
+    /** @field fail if some parents can not be resolved (true if unspecified) */
+    requireAllParents?: boolean;
+    schema: TConfig extends Payload ? TConfig['schema'] : ArchivistConfigSchema;
+    /** @field storage configuration */
+    storage?: ArchivistStorage;
+    /** @field should child store all reads from parents? */
+    storeParentReads?: boolean;
+}, TConfig>, TSchema>;
+
+interface ArchivistModuleInstance<TParams extends ModuleParams<AnyConfigSchema<ArchivistConfig>> = ModuleParams<AnyConfigSchema<ArchivistConfig>>, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends Module<TParams, TEventData> {
+}
+
+interface ArchivistParentInstances {
+    commit?: ArchivistInstance[];
+    read?: ArchivistInstance[];
+    write?: ArchivistInstance[];
+}
+interface ArchivistParamFields {
+    parents?: ArchivistParentInstances;
+}
+interface ArchivistParams<TConfig extends AnyConfigSchema<ArchivistConfig> = AnyConfigSchema<ArchivistConfig>> extends ModuleParams<TConfig>, ArchivistParamFields {
+}
+
+interface ArchivistRawQueryFunctions {
+    allQuery(account?: AccountInstance): Promisable<ModuleQueryResult>;
+    clearQuery(account?: AccountInstance): Promisable<ModuleQueryResult>;
+    commitQuery(account?: AccountInstance): Promisable<ModuleQueryResult>;
+    deleteQuery(hashes: Hash[], account?: AccountInstance): Promisable<ModuleQueryResult>;
+    getQuery(hashes: Hash[], account?: AccountInstance): Promisable<ModuleQueryResult>;
+    insertQuery(payloads: Payload[], account?: AccountInstance): Promisable<ModuleQueryResult>;
+    nextQuery(options?: ArchivistNextOptions, account?: AccountInstance): Promisable<ModuleQueryResult>;
+}
+
+interface ArchivistInstance<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData, TPayload extends Payload = Payload> extends ArchivistModuleInstance<TParams, TEventData>, ArchivistModule<TPayload, TPayload>, ModuleInstance<TParams, TEventData>, ArchivistRawQueryFunctions, EventEmitter<TEventData> {
+}
+
+interface AttachableArchivistInstance<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData, TPayload extends Payload = Payload> extends ArchivistModuleInstance<TParams, TEventData>, AttachableModuleInstance<TParams, TEventData>, ArchivistInstance<TParams, TEventData, TPayload> {
+}
+type AttachableArchivistInstanceTypeCheck<T extends AttachableArchivistInstance = AttachableArchivistInstance> = TypeCheck<T>;
+declare class IsAttachableArchivistInstanceFactory<T extends AttachableArchivistInstance = AttachableArchivistInstance> extends IsObjectFactory<T> {
+}
+
+declare const asAttachableArchivistInstance: _xylabs_object.AsTypeFunction<AttachableArchivistInstance<ArchivistParams<_xyo_network_module_model.AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, _xyo_network_payload_model.Payload>>;
+
+declare const requiredAttachableArchivistInstanceFunctions: ObjectTypeShape;
+declare const isAttachableArchivistInstance: TypeCheck<AttachableArchivistInstance>;
+
+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> = [T, P[]];
+type HydratedBoundWitnessWithStorageMeta<T extends BoundWitness = BoundWitness, P extends Payload = Payload> = [WithStorageMeta<T>, WithStorageMeta<P>[]];
+type SignedHydratedBoundWitness<T extends SignedBoundWitness = SignedBoundWitness, P extends Payload = Payload> = [T, P[]];
+type SignedHydratedBoundWitnessWithStorageMeta<T extends SignedBoundWitness = SignedBoundWitness, 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<{
+    schema: ArchivistAllQuerySchema;
+}>;
+
+declare const ArchivistClearQuerySchema: "network.xyo.query.archivist.clear";
+type ArchivistClearQuerySchema = typeof ArchivistClearQuerySchema;
+type ArchivistClearQuery = Query<{
+    schema: ArchivistClearQuerySchema;
+}>;
+
+declare const ArchivistCommitQuerySchema: "network.xyo.query.archivist.commit";
+type ArchivistCommitQuerySchema = typeof ArchivistCommitQuerySchema;
+type ArchivistCommitQuery = Query<{
+    schema: ArchivistCommitQuerySchema;
+}>;
+
+declare const ArchivistDeleteQuerySchema: "network.xyo.query.archivist.delete";
+type ArchivistDeleteQuerySchema = typeof ArchivistDeleteQuerySchema;
+type ArchivistDeleteQuery = Query<{
+    hashes: Hash[];
+    schema: ArchivistDeleteQuerySchema;
+}>;
+
+declare const ArchivistGetQuerySchema: "network.xyo.query.archivist.get";
+type ArchivistGetQuerySchema = typeof ArchivistGetQuerySchema;
+type ArchivistGetQuery = Query<{
+    hashes: Hash[];
+    schema: ArchivistGetQuerySchema;
+}>;
+
+declare const ArchivistInsertQuerySchema: "network.xyo.query.archivist.insert";
+type ArchivistInsertQuerySchema = typeof ArchivistInsertQuerySchema;
+type ArchivistInsertQuery = Query<{
+    schema: ArchivistInsertQuerySchema;
+}>;
+
+declare const ArchivistNextQuerySchema: "network.xyo.query.archivist.next";
+type ArchivistNextQuerySchema = typeof ArchivistNextQuerySchema;
+type ArchivistNextQuery = Query<ArchivistNextOptions, ArchivistNextQuerySchema>;
+
+declare const ArchivistSnapshotQuerySchema: "network.xyo.query.archivist.snapshot";
+type ArchivistSnapshotQuerySchema = typeof ArchivistSnapshotQuerySchema;
+type ArchivistSnapshotQuery = Query<{
+    schema: ArchivistSnapshotQuerySchema;
+}>;
+
+type ArchivistQueries = ArchivistAllQuery | ArchivistClearQuery | ArchivistCommitQuery | ArchivistDeleteQuery | ArchivistGetQuery | ArchivistInsertQuery | ArchivistNextQuery | ArchivistSnapshotQuery;
+type ArchivistModuleQueries = ModuleQueries | ArchivistQueries;
+
+declare const isArchivistInstance: TypeCheck<ArchivistInstance>;
+declare const isArchivistModule: TypeCheck<ArchivistModuleInstance>;
+declare const asArchivistModule: _xylabs_object.AsTypeFunction<ArchivistModuleInstance<_xyo_network_module_model.ModuleParams<_xyo_network_module_model.AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData>>;
+declare const asArchivistInstance: _xylabs_object.AsTypeFunction<ArchivistInstance<ArchivistParams<_xyo_network_module_model.AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, _xyo_network_payload_model.Payload>>;
+declare const withArchivistModule: <R>(mod: any, closure: (mod: ArchivistModuleInstance<_xyo_network_module_model.ModuleParams<_xyo_network_module_model.AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData>) => R) => R | undefined;
+declare const withArchivistInstance: <R>(mod: any, closure: (mod: ArchivistInstance<ArchivistParams<_xyo_network_module_model.AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, _xyo_network_payload_model.Payload>) => R) => R | undefined;
+
+export { ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistCommitQuerySchema, ArchivistConfigSchema, ArchivistDeleteQuerySchema, ArchivistGetQuerySchema, ArchivistInsertQuerySchema, ArchivistNextQuerySchema, ArchivistSnapshotPayloadSchema, ArchivistSnapshotQuerySchema, ArchivistStatsPayloadSchema, IndexSeparator, IsAttachableArchivistInstanceFactory, asArchivistInstance, asArchivistModule, asAttachableArchivistInstance, buildStandardIndexName, getBoundWitness, getTypedBoundWitness, hydrateBoundWitness, hydrateTypedBoundWitness, isArchivistInstance, isArchivistModule, isAttachableArchivistInstance, requiredAttachableArchivistInstanceFunctions, tryGetTypedBoundWitness, tryHydrateTypedBoundWitness, withArchivistInstance, withArchivistModule };
+export type { AllArchivist, AllArchivistFunctions, Archivist, ArchivistAllQuery, ArchivistClearQuery, ArchivistCommitQuery, ArchivistConfig, ArchivistDeleteQuery, ArchivistDriver, ArchivistGetCache, ArchivistGetQuery, ArchivistInsertQuery, ArchivistInstance, ArchivistLabels, ArchivistModuleEventData, ArchivistModuleInstance, ArchivistModuleQueries, ArchivistNextOptions, ArchivistNextQuery, ArchivistParamFields, ArchivistParams, ArchivistParentInstances, ArchivistParents, ArchivistQueries, ArchivistRawQueryFunctions, ArchivistSnapshotPayload, ArchivistSnapshotQuery, ArchivistStatsPayload, ArchivistStorage, AttachableArchivistInstance, AttachableArchivistInstanceTypeCheck, FullArchivist, HydratedBoundWitness, HydratedBoundWitnessWithStorageMeta, IdentityFunction, IndexDescription, IndexDirection, NextOptions, ReadArchivist, ReadArchivistFunctions, ReadWriteArchivist, SignedHydratedBoundWitness, SignedHydratedBoundWitnessWithStorageMeta, StashArchivist, StashArchivistFunctions, WriteArchivist, WriteArchivistFunctions };

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/ArchivistSnapshot.ts","../../src/ArchivistStats.ts","../../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/Queries/Snapshot.ts","../../src/attachable/AttachableInstance.ts","../../src/Config.ts","../../src/IndexDescription.ts","../../src/lib/getBoundWitness.ts","../../src/lib/hydrateBoundWitness.ts"],"sourcesContent":["import type { Hash } from '@xylabs/hex'\nimport type { Payload, PayloadHashMap } from '@xyo-network/payload-model'\n\nexport const ArchivistSnapshotPayloadSchema = 'network.xyo.archivist.snapshot' as const\nexport type ArchivistSnapshotPayloadSchema = typeof ArchivistSnapshotPayloadSchema\n\nexport type ArchivistSnapshotPayload<TPayload extends Payload = Payload, TId extends string | number | symbol = Hash>\n  = Payload<PayloadHashMap<TPayload, TId>, ArchivistSnapshotPayloadSchema>\n","import type { Payload } from '@xyo-network/payload-model'\n\nexport const ArchivistStatsPayloadSchema = 'network.xyo.archivist.stats' as const\nexport type ArchivistStatsPayloadSchema = typeof ArchivistStatsPayloadSchema\n\nexport type ArchivistStatsPayload\n  = Payload<{ payloadCount: number }, ArchivistStatsPayloadSchema>\n","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 { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistSnapshotQuerySchema = 'network.xyo.query.archivist.snapshot' as const\nexport type ArchivistSnapshotQuerySchema = typeof ArchivistSnapshotQuerySchema\n\nexport type ArchivistSnapshotQuery = Query<{\n  schema: ArchivistSnapshotQuerySchema\n}>\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 interface ArchivistGetCache {\n  enabled?: boolean\n  maxEntries?: number\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      getCache?: ArchivistGetCache\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 } from '@xylabs/hex'\nimport { isHash } 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 { 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  const payloads = (await archivist.get(bw?.payload_hashes)).filter(exists)\n  if (payloads.length !== bw.payload_hashes.length) {\n    throw new Error(`missing payloads for ${bw._hash}`)\n  }\n  return [bw, payloads]\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":";AAGO,IAAM,iCAAiC;;;ACDvC,IAAM,8BAA8B;;;ACF3C,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;;;ACFjC,IAAM,+BAA+B;;;AROrC,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;;;AWHjG,SAAS,mBAAAC,wBAAuB;AAmBzB,IAAM,uCAAN,cAAwHA,iBAAmB;AAAC;;;ACE5I,IAAM,wBAAwB;;;ACK9B,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;AAEvB,SAAS,cAAc;AAEvB,SAAS,iCAAAC,sCAAqC;AAQvC,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,QAAM,YAAY,MAAM,UAAU,IAAI,IAAI,cAAc,GAAG,OAAO,MAAM;AACxE,MAAI,SAAS,WAAW,GAAG,eAAe,QAAQ;AAChD,UAAM,IAAI,MAAM,wBAAwB,GAAG,KAAK,EAAE;AAAA,EACpD;AACA,SAAO,CAAC,IAAI,QAAQ;AACtB;AAEO,IAAM,sBAAsB,CACjC,WACA,aACgD;AAChD,SAAO,yBAAuC,WAAW,UAAUC,8BAA6B;AAClG;","names":["AsObjectFactory","AsObjectFactory","IsObjectFactory","isBoundWitnessWithStorageMeta","isBoundWitnessWithStorageMeta"]}
+{"version":3,"sources":["../../src/ArchivistSnapshot.ts","../../src/ArchivistStats.ts","../../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/Queries/Snapshot.ts","../../src/attachable/AttachableInstance.ts","../../src/Config.ts","../../src/IndexDescription.ts","../../src/lib/getBoundWitness.ts","../../src/lib/hydrateBoundWitness.ts"],"sourcesContent":["import type { Hash } from '@xylabs/hex'\nimport type { Payload, PayloadHashMap } from '@xyo-network/payload-model'\n\nexport const ArchivistSnapshotPayloadSchema = 'network.xyo.archivist.snapshot' as const\nexport type ArchivistSnapshotPayloadSchema = typeof ArchivistSnapshotPayloadSchema\n\nexport type ArchivistSnapshotPayload<TPayload extends Payload = Payload, TId extends string | number | symbol = Hash>\n  = Payload<PayloadHashMap<TPayload, TId>, ArchivistSnapshotPayloadSchema>\n","import type { Payload } from '@xyo-network/payload-model'\n\nexport const ArchivistStatsPayloadSchema = 'network.xyo.archivist.stats' as const\nexport type ArchivistStatsPayloadSchema = typeof ArchivistStatsPayloadSchema\n\nexport type ArchivistStatsPayload\n  = Payload<{ payloadCount: number }, ArchivistStatsPayloadSchema>\n","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 type { TypeCheck } from '@xylabs/object'\nimport { 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: TypeCheck<ArchivistInstance> = new IsInstanceFactory<ArchivistInstance>().create({ get: 'function' }, [isModuleInstance])\nexport const isArchivistModule: TypeCheck<ArchivistModuleInstance> = 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 { Query } from '@xyo-network/payload-model'\n\nexport const ArchivistSnapshotQuerySchema = 'network.xyo.query.archivist.snapshot' as const\nexport type ArchivistSnapshotQuerySchema = typeof ArchivistSnapshotQuerySchema\n\nexport type ArchivistSnapshotQuery = Query<{\n  schema: ArchivistSnapshotQuerySchema\n}>\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 interface ArchivistGetCache {\n  enabled?: boolean\n  maxEntries?: number\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      getCache?: ArchivistGetCache\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 } from '@xylabs/hex'\nimport { isHash } 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 { 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  const payloads = (await archivist.get(bw?.payload_hashes)).filter(exists)\n  if (payloads.length !== bw.payload_hashes.length) {\n    throw new Error(`missing payloads for ${bw._hash}`)\n  }\n  return [bw, payloads]\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":";AAGO,IAAM,iCAAiC;;;ACDvC,IAAM,8BAA8B;;;ACF3C,SAAS,mBAAAA,wBAAuB;;;ACChC,SAAS,uBAAuB;AAEhC,SAAS,kCAAkC;;;ACF3C,SAAS,uBAAuB;AAChC;AAAA,EACE;AAAA,EAAmB;AAAA,EAAiB;AAAA,EAAkB;AAAA,OACjD;;;ACFA,IAAM,0BAA0B;;;ACAhC,IAAM,4BAA4B;;;ACAlC,IAAM,6BAA6B;;;ACCnC,IAAM,6BAA6B;;;ACAnC,IAAM,0BAA0B;;;ACDhC,IAAM,6BAA6B;;;ACEnC,IAAM,2BAA2B;;;ACFjC,IAAM,+BAA+B;;;ARQrC,IAAM,sBAAoD,IAAI,kBAAqC,EAAE,OAAO,EAAE,KAAK,WAAW,GAAG,CAAC,gBAAgB,CAAC;AACnJ,IAAM,oBAAwD,IAAI,gBAAyC,EAAE,OAAO,CAAC,uBAAuB,CAAC;AAE7I,IAAM,oBAAoB,gBAAgB,OAAO,iBAAiB;AAClE,IAAM,sBAAsB,gBAAgB,OAAO,mBAAmB;AACtE,IAAM,sBAAsB,YAAY,OAAO,iBAAiB;AAChE,IAAM,wBAAwB,YAAY,OAAO,mBAAmB;;;ADRpE,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;;;AWHjG,SAAS,mBAAAC,wBAAuB;AAmBzB,IAAM,uCAAN,cAAwHA,iBAAmB;AAAC;;;ACE5I,IAAM,wBAAwB;;;ACK9B,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;AAEvB,SAAS,cAAc;AAEvB,SAAS,iCAAAC,sCAAqC;AAQvC,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,QAAM,YAAY,MAAM,UAAU,IAAI,IAAI,cAAc,GAAG,OAAO,MAAM;AACxE,MAAI,SAAS,WAAW,GAAG,eAAe,QAAQ;AAChD,UAAM,IAAI,MAAM,wBAAwB,GAAG,KAAK,EAAE;AAAA,EACpD;AACA,SAAO,CAAC,IAAI,QAAQ;AACtB;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": "4.0.3",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,29 +21,29 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.13.4",
-    "@xylabs/events": "^4.13.4",
-    "@xylabs/exists": "^4.13.4",
-    "@xylabs/hex": "^4.13.4",
-    "@xylabs/object": "^4.13.4",
-    "@xylabs/promise": "^4.13.4",
-    "@xylabs/typeof": "^4.13.4",
-    "@xyo-network/account-model": "^4.0.3",
-    "@xyo-network/boundwitness-model": "^4.0.3",
-    "@xyo-network/module-model": "^4.0.3",
-    "@xyo-network/payload-model": "^4.0.3"
+    "@xylabs/assert": "^4.13.15",
+    "@xylabs/events": "^4.13.15",
+    "@xylabs/exists": "^4.13.15",
+    "@xylabs/hex": "^4.13.15",
+    "@xylabs/object": "^4.13.15",
+    "@xylabs/promise": "^4.13.15",
+    "@xylabs/typeof": "^4.13.15",
+    "@xyo-network/account-model": "^4.1.0",
+    "@xyo-network/boundwitness-model": "^4.1.0",
+    "@xyo-network/module-model": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
     "typescript": "^5.8.3"
   },
   "publishConfig": {

package/src/typeChecks.ts

@@ -1,3 +1,4 @@
+import type { TypeCheck } from '@xylabs/object'
 import { AsObjectFactory } from '@xylabs/object'
 import {
   IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory,
@@ -7,8 +8,8 @@ import type { ArchivistInstance } from './Instance.ts'
 import type { ArchivistModuleInstance } from './ModuleInstance.ts'
 import { ArchivistGetQuerySchema } from './Queries/index.ts'
 
-export const isArchivistInstance = new IsInstanceFactory<ArchivistInstance>().create({ get: 'function' }, [isModuleInstance])
-export const isArchivistModule = new IsModuleFactory<ArchivistModuleInstance>().create([ArchivistGetQuerySchema])
+export const isArchivistInstance: TypeCheck<ArchivistInstance> = new IsInstanceFactory<ArchivistInstance>().create({ get: 'function' }, [isModuleInstance])
+export const isArchivistModule: TypeCheck<ArchivistModuleInstance> = new IsModuleFactory<ArchivistModuleInstance>().create([ArchivistGetQuerySchema])
 
 export const asArchivistModule = AsObjectFactory.create(isArchivistModule)
 export const asArchivistInstance = AsObjectFactory.create(isArchivistInstance)

package/dist/types/typeChecks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"typeChecks.d.ts","sourceRoot":"","sources":["../../src/typeChecks.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAGlE,eAAO,MAAM,mBAAmB,2RAA6F,CAAA;AAC7H,eAAO,MAAM,iBAAiB,+QAAmF,CAAA;AAEjH,eAAO,MAAM,iBAAiB,mQAA4C,CAAA;AAC1E,eAAO,MAAM,mBAAmB,gSAA8C,CAAA;AAC9E,eAAO,MAAM,mBAAmB,+QAAwC,CAAA;AACxE,eAAO,MAAM,qBAAqB,4SAA0C,CAAA"}