@xyo-network/archivist-model 4.1.1 → 4.1.3

package/dist/neutral/index.d.ts

@@ -1,282 +1,19 @@
-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 };
+export * from './ArchivistDriver.ts';
+export * from './ArchivistFunctions.ts';
+export * from './ArchivistSnapshot.ts';
+export * from './ArchivistStats.ts';
+export * from './attachable/index.ts';
+export * from './Config.ts';
+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';
+export * from './PayloadArchivist.ts';
+export * from './Queries/index.ts';
+export * from './RawQueryFunctions.ts';
+export * from './typeChecks.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-model",
-  "version": "4.1.1",
+  "version": "4.1.3",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,21 +29,21 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@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.1",
-    "@xyo-network/boundwitness-model": "^4.1.1",
-    "@xyo-network/module-model": "^4.1.1",
-    "@xyo-network/payload-model": "^4.1.1"
+    "@xylabs/assert": "^4.13.16",
+    "@xylabs/events": "^4.13.16",
+    "@xylabs/exists": "^4.13.16",
+    "@xylabs/hex": "^4.13.16",
+    "@xylabs/object": "^4.13.16",
+    "@xylabs/promise": "^4.13.16",
+    "@xylabs/typeof": "^4.13.16",
+    "@xyo-network/account-model": "^4.1.3",
+    "@xyo-network/boundwitness-model": "^4.1.3",
+    "@xyo-network/module-model": "^4.1.3",
+    "@xyo-network/payload-model": "^4.1.3"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
-    "@xylabs/tsconfig": "^7.0.0-rc.23",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
     "typescript": "^5.8.3"
   },
   "publishConfig": {