@xyo-network/bridge-model 4.0.2 → 4.1.0

package/dist/neutral/index.d.ts

@@ -0,0 +1,166 @@
+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, ModuleInstance, ModuleQueryResult, ModuleEventData, ModuleConfig, CacheConfig, AnyConfigSchema, ModuleParams, ModuleResolverInstance, ModuleIdentifier, ModuleQueries, AttachableModuleInstance } from '@xyo-network/module-model';
+import { EventData } from '@xylabs/events';
+import { QueryBoundWitness } from '@xyo-network/boundwitness-model';
+import { Payload, Query } from '@xyo-network/payload-model';
+import { Address } from '@xylabs/hex';
+import { Promisable } from '@xylabs/promise';
+import { ObjectTypeShape } from '@xylabs/typeof';
+
+type ExposedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    modules: ModuleInstance[];
+}>;
+interface ExposedEventData<T extends Module = Module> extends EventData {
+    exposed: ExposedEventArgs<T>;
+}
+
+type QueryFulfillFinishedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    payloads?: Payload[];
+    query: QueryBoundWitness;
+    result?: ModuleQueryResult;
+    status: 'success' | 'failure';
+}>;
+interface QueryFulfillFinishedEventData<T extends Module = Module> extends EventData {
+    queryFulfillFinished: QueryFulfillFinishedEventArgs<T>;
+}
+
+type QueryFulfillStartedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    payloads?: Payload[];
+    query: QueryBoundWitness;
+}>;
+interface QueryFulfillStartedEventData<T extends Module = Module> extends EventData {
+    queryFulfillStarted: QueryFulfillStartedEventArgs<T>;
+}
+
+type QuerySendFinishedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    payloads?: Payload[];
+    query: QueryBoundWitness;
+    result?: ModuleQueryResult;
+    status: 'success' | 'failure';
+}>;
+interface QuerySendFinishedEventData<T extends Module = Module> extends EventData {
+    querySendFinished: QuerySendFinishedEventArgs<T>;
+}
+
+type QuerySendStartedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    payloads?: Payload[];
+    query: QueryBoundWitness;
+}>;
+interface QuerySendStartedEventData<T extends Module = Module> extends EventData {
+    querySendStarted: QuerySendStartedEventArgs<T>;
+}
+
+type UnexposedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    modules: ModuleInstance[];
+}>;
+interface UnexposedEventData<T extends Module = Module> extends EventData {
+    unexposed: UnexposedEventArgs<T>;
+}
+
+interface BridgeModuleEventData extends QuerySendFinishedEventData, QuerySendStartedEventData, QueryFulfillFinishedEventData, QueryFulfillStartedEventData, ExposedEventData, UnexposedEventData, ModuleEventData {
+}
+
+declare const BridgeConfigSchema: "network.xyo.bridge.config";
+type BridgeConfigSchema = typeof BridgeConfigSchema;
+type BridgeClientConfig = {
+    cache?: CacheConfig | true;
+    discoverRoots?: 'start' | 'lazy';
+    maxDepth?: number;
+};
+type BridgeHostConfig = {
+    cache?: CacheConfig | true;
+    maxDepth?: number;
+};
+type BridgeConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void, TClient extends EmptyObject | void = void, THost extends EmptyObject | void = void> = ModuleConfig<WithAdditional<{
+    client?: WithAdditional<BridgeClientConfig, TClient>;
+    /** @deprecated use client.discoverRoots instead */
+    discoverRoots?: 'start' | 'lazy';
+    host?: WithAdditional<BridgeHostConfig, THost>;
+    schema: TConfig extends Payload ? TConfig['schema'] : BridgeConfigSchema;
+}, TConfig>, TSchema>;
+
+interface BridgeParams<TConfig extends AnyConfigSchema<BridgeConfig> = AnyConfigSchema<BridgeConfig>> extends ModuleParams<TConfig>, ModuleParams<TConfig> {
+    resolver?: ModuleResolverInstance;
+}
+
+interface BridgeModule<TParams extends BridgeParams = BridgeParams, TEventData extends BridgeModuleEventData = BridgeModuleEventData> extends Module<TParams, TEventData> {
+}
+
+declare const BridgeConnectQuerySchema: "network.xyo.query.bridge.connect";
+type BridgeConnectQuerySchema = typeof BridgeConnectQuerySchema;
+type BridgeConnectQuery = Query<{
+    id?: ModuleIdentifier;
+    maxDepth?: number;
+    schema: BridgeConnectQuerySchema;
+}>;
+
+type BridgeDisconnectQuerySchema = 'network.xyo.query.bridge.disconnect';
+declare const BridgeDisconnectQuerySchema: BridgeDisconnectQuerySchema;
+type BridgeDisconnectQuery = Query<{
+    id?: ModuleIdentifier;
+    maxDepth?: number;
+    schema: BridgeDisconnectQuerySchema;
+}>;
+
+declare const BridgeExposeQuerySchema: "network.xyo.query.bridge.expose";
+type BridgeExposeQuerySchema = typeof BridgeExposeQuerySchema;
+interface BridgeExposeOptions {
+    maxDepth?: number;
+    required?: boolean;
+}
+declare const ModuleFilterPayloadSchema = "network.xyo.module.filter";
+type ModuleFilterPayloadSchema = typeof ModuleFilterPayloadSchema;
+type ModuleFilterPayload = Payload<{
+    id: ModuleIdentifier;
+} & BridgeExposeOptions, ModuleFilterPayloadSchema>;
+type BridgeExposeQuery = Query<void, BridgeExposeQuerySchema>;
+
+declare const BridgeUnexposeQuerySchema: "network.xyo.query.bridge.unexpose";
+type BridgeUnexposeQuerySchema = typeof BridgeUnexposeQuerySchema;
+interface BridgeUnexposeOptions extends BridgeExposeOptions {
+}
+type BridgeUnexposeQuery = Query<void, BridgeUnexposeQuerySchema>;
+
+type BridgeQueries = BridgeConnectQuery | BridgeDisconnectQuery | BridgeExposeQuery | BridgeUnexposeQuery;
+type BridgeModuleQueries = ModuleQueries | BridgeQueries;
+
+interface BridgeQueryFunctions {
+    connect?: (id: ModuleIdentifier, maxDepth?: number) => Promisable<Address | undefined>;
+    disconnect?: (id: ModuleIdentifier, maxDepth?: number) => Promisable<Address | undefined>;
+    expose: (id: ModuleIdentifier, options?: BridgeExposeOptions) => Promisable<ModuleInstance[]>;
+    unexpose?: (id: ModuleIdentifier, options?: BridgeUnexposeOptions) => Promisable<Address[]>;
+}
+
+interface BridgeInstance<TParams extends BridgeParams = BridgeParams, TEventData extends BridgeModuleEventData = BridgeModuleEventData> extends BridgeModule<TParams, TEventData>, BridgeQueryFunctions, ModuleInstance<TParams, TEventData> {
+    exposed?: () => Promisable<Address[]>;
+}
+
+interface AttachableBridgeInstance<TParams extends BridgeParams = BridgeParams, TEventData extends BridgeModuleEventData = BridgeModuleEventData> extends BridgeModule<TParams, TEventData>, AttachableModuleInstance<TParams, TEventData>, BridgeInstance<TParams, TEventData> {
+}
+type AttachableBridgeInstanceTypeCheck<T extends AttachableBridgeInstance = AttachableBridgeInstance> = TypeCheck<T>;
+declare class IsAttachableBridgeInstanceFactory<T extends AttachableBridgeInstance = AttachableBridgeInstance> extends IsObjectFactory<T> {
+}
+
+declare const asAttachableBridgeInstance: _xylabs_object.AsTypeFunction<AttachableBridgeInstance<BridgeParams<_xyo_network_module_model.AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
+
+declare const requiredAttachableBridgeInstanceFunctions: ObjectTypeShape;
+declare const isAttachableBridgeInstance: TypeCheck<AttachableBridgeInstance>;
+
+interface BridgeRawQueryFunctions {
+    connectQuery?: (id: ModuleIdentifier, maxDepth?: number) => Promisable<ModuleQueryResult>;
+    disconnectQuery?: (id: ModuleIdentifier, maxDepth?: number) => Promisable<ModuleQueryResult>;
+    exposeQuery: (id: ModuleIdentifier, options?: BridgeExposeOptions) => Promisable<ModuleQueryResult>;
+    unexposeQuery?: (id: ModuleIdentifier, options?: BridgeUnexposeOptions) => Promisable<ModuleQueryResult>;
+}
+
+declare const isBridgeInstance: _xylabs_object.TypeCheck<BridgeInstance<BridgeParams<_xyo_network_module_model.AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
+declare const isBridgeModule: _xyo_network_module_model.ModuleTypeCheck<BridgeModule<BridgeParams<_xyo_network_module_model.AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
+declare const asBridgeModule: _xylabs_object.AsTypeFunction<BridgeModule<BridgeParams<_xyo_network_module_model.AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
+declare const asBridgeInstance: _xylabs_object.AsTypeFunction<BridgeInstance<BridgeParams<_xyo_network_module_model.AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
+declare const withBridgeModule: <R>(mod: any, closure: (mod: BridgeModule<BridgeParams<_xyo_network_module_model.AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>) => R) => R | undefined;
+declare const withBridgeInstance: <R>(mod: any, closure: (mod: BridgeInstance<BridgeParams<_xyo_network_module_model.AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>) => R) => R | undefined;
+
+export { BridgeConfigSchema, BridgeConnectQuerySchema, BridgeDisconnectQuerySchema, BridgeExposeQuerySchema, BridgeUnexposeQuerySchema, IsAttachableBridgeInstanceFactory, ModuleFilterPayloadSchema, asAttachableBridgeInstance, asBridgeInstance, asBridgeModule, isAttachableBridgeInstance, isBridgeInstance, isBridgeModule, requiredAttachableBridgeInstanceFunctions, withBridgeInstance, withBridgeModule };
+export type { AttachableBridgeInstance, AttachableBridgeInstanceTypeCheck, BridgeClientConfig, BridgeConfig, BridgeConnectQuery, BridgeDisconnectQuery, BridgeExposeOptions, BridgeExposeQuery, BridgeHostConfig, BridgeInstance, BridgeModule, BridgeModuleEventData, BridgeModuleQueries, BridgeParams, BridgeQueries, BridgeQueryFunctions, BridgeRawQueryFunctions, BridgeUnexposeOptions, BridgeUnexposeQuery, ExposedEventArgs, ExposedEventData, ModuleFilterPayload, QueryFulfillFinishedEventArgs, QueryFulfillFinishedEventData, QueryFulfillStartedEventArgs, QueryFulfillStartedEventData, QuerySendFinishedEventArgs, QuerySendFinishedEventData, QuerySendStartedEventArgs, QuerySendStartedEventData, UnexposedEventArgs, UnexposedEventData };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/bridge-model",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,26 +21,26 @@
   "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/events": "^4.12.33",
-    "@xylabs/hex": "^4.12.33",
-    "@xylabs/object": "^4.12.33",
-    "@xylabs/promise": "^4.12.33",
-    "@xylabs/typeof": "^4.12.33",
-    "@xyo-network/boundwitness-model": "^4.0.2",
-    "@xyo-network/module-model": "^4.0.2",
-    "@xyo-network/payload-model": "^4.0.2"
+    "@xylabs/events": "^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/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.12",
-    "@xylabs/tsconfig": "^6.5.12",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
     "typescript": "^5.8.3"
   },
   "publishConfig": {