@xyo-network/module-model 3.9.3 → 3.9.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/neutral/index.d.ts +40 -0
  2. package/package.json +6 -6
  3. package/src/ModuleParams.ts +3 -0
package/dist/neutral/index.d.ts CHANGED
@@ -172,6 +172,8 @@ type ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> | void = void, T
172
172
  config: TConfig extends AnyConfigSchema<ModuleConfig> ? TConfig : AnyConfigSchema<ModuleConfig>;
173
173
  ephemeralQueryAccountEnabled?: boolean;
174
174
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
175
+ privateChildren?: ModuleInstance[];
176
+ publicChildren?: ModuleInstance[];
175
177
  }>, TAdditionalParams>;
176
178
 
177
179
  interface ModuleFields<TParams extends ModuleParams = ModuleParams> {
@@ -200,6 +202,8 @@ declare const asModule: {
200
202
  config: AnyConfigSchema<ModuleConfig>;
201
203
  ephemeralQueryAccountEnabled?: boolean;
202
204
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
205
+ privateChildren?: ModuleInstance[];
206
+ publicChildren?: ModuleInstance[];
203
207
  }, ModuleEventData<object>>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
204
208
  <TType extends Module<_xylabs_object.BaseParamsFields & {
205
209
  account?: _xyo_network_account_model.AccountInstance | "random";
@@ -209,6 +213,8 @@ declare const asModule: {
209
213
  config: AnyConfigSchema<ModuleConfig>;
210
214
  ephemeralQueryAccountEnabled?: boolean;
211
215
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
216
+ privateChildren?: ModuleInstance[];
217
+ publicChildren?: ModuleInstance[];
212
218
  }, ModuleEventData<object>>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<Module<_xylabs_object.BaseParamsFields & {
213
219
  account?: _xyo_network_account_model.AccountInstance | "random";
214
220
  addToResolvers?: boolean;
@@ -217,6 +223,8 @@ declare const asModule: {
217
223
  config: AnyConfigSchema<ModuleConfig>;
218
224
  ephemeralQueryAccountEnabled?: boolean;
219
225
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
226
+ privateChildren?: ModuleInstance[];
227
+ publicChildren?: ModuleInstance[];
220
228
  }, ModuleEventData<object>>>, config?: _xylabs_object.TypeCheckConfig): TType;
221
229
  };
222
230
 
@@ -229,6 +237,8 @@ declare const asModuleObject: {
229
237
  config: AnyConfigSchema<ModuleConfig>;
230
238
  ephemeralQueryAccountEnabled?: boolean;
231
239
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
240
+ privateChildren?: ModuleInstance[];
241
+ publicChildren?: ModuleInstance[];
232
242
  }, ModuleEventData<object>>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
233
243
  <TType extends Module<_xylabs_object.BaseParamsFields & {
234
244
  account?: _xyo_network_account_model.AccountInstance | "random";
@@ -238,6 +248,8 @@ declare const asModuleObject: {
238
248
  config: AnyConfigSchema<ModuleConfig>;
239
249
  ephemeralQueryAccountEnabled?: boolean;
240
250
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
251
+ privateChildren?: ModuleInstance[];
252
+ publicChildren?: ModuleInstance[];
241
253
  }, ModuleEventData<object>>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<Module<_xylabs_object.BaseParamsFields & {
242
254
  account?: _xyo_network_account_model.AccountInstance | "random";
243
255
  addToResolvers?: boolean;
@@ -246,6 +258,8 @@ declare const asModuleObject: {
246
258
  config: AnyConfigSchema<ModuleConfig>;
247
259
  ephemeralQueryAccountEnabled?: boolean;
248
260
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
261
+ privateChildren?: ModuleInstance[];
262
+ publicChildren?: ModuleInstance[];
249
263
  }, ModuleEventData<object>>>, config?: _xylabs_object.TypeCheckConfig): TType;
250
264
  };
251
265
 
@@ -266,6 +280,8 @@ declare const isModuleObject: _xylabs_object.TypeCheck<Module<_xylabs_object.Bas
266
280
  config: AnyConfigSchema<ModuleConfig>;
267
281
  ephemeralQueryAccountEnabled?: boolean;
268
282
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
283
+ privateChildren?: ModuleInstance[];
284
+ publicChildren?: ModuleInstance[];
269
285
  }, ModuleEventData<object>>>;
270
286
 
271
287
  declare const AddressSchema: "network.xyo.address";
@@ -415,6 +431,8 @@ declare const asModuleInstance: {
415
431
  config: AnyConfigSchema<ModuleConfig>;
416
432
  ephemeralQueryAccountEnabled?: boolean;
417
433
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
434
+ privateChildren?: ModuleInstance[];
435
+ publicChildren?: ModuleInstance[];
418
436
  }, ModuleEventData<object>>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
419
437
  <TType extends ModuleInstance<_xylabs_object.BaseParamsFields & {
420
438
  account?: _xyo_network_account_model.AccountInstance | "random";
@@ -424,6 +442,8 @@ declare const asModuleInstance: {
424
442
  config: AnyConfigSchema<ModuleConfig>;
425
443
  ephemeralQueryAccountEnabled?: boolean;
426
444
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
445
+ privateChildren?: ModuleInstance[];
446
+ publicChildren?: ModuleInstance[];
427
447
  }, ModuleEventData<object>>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<ModuleInstance<_xylabs_object.BaseParamsFields & {
428
448
  account?: _xyo_network_account_model.AccountInstance | "random";
429
449
  addToResolvers?: boolean;
@@ -432,6 +452,8 @@ declare const asModuleInstance: {
432
452
  config: AnyConfigSchema<ModuleConfig>;
433
453
  ephemeralQueryAccountEnabled?: boolean;
434
454
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
455
+ privateChildren?: ModuleInstance[];
456
+ publicChildren?: ModuleInstance[];
435
457
  }, ModuleEventData<object>>>, config?: _xylabs_object.TypeCheckConfig): TType;
436
458
  };
437
459
 
@@ -443,6 +465,8 @@ declare const isModuleResolver: (value?: unknown) => value is ObjectResolver<Mod
443
465
  config: AnyConfigSchema<ModuleConfig>;
444
466
  ephemeralQueryAccountEnabled?: boolean;
445
467
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
468
+ privateChildren?: ModuleInstance[];
469
+ publicChildren?: ModuleInstance[];
446
470
  }, ModuleEventData<object>>>;
447
471
  interface ModuleResolver<TResult extends ModuleInstance = ModuleInstance> extends ObjectResolver<TResult> {
448
472
  }
@@ -473,6 +497,8 @@ declare const asAttachableModuleInstance: {
473
497
  config: AnyConfigSchema<ModuleConfig>;
474
498
  ephemeralQueryAccountEnabled?: boolean;
475
499
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
500
+ privateChildren?: ModuleInstance[];
501
+ publicChildren?: ModuleInstance[];
476
502
  }, ModuleEventData<object>>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
477
503
  <TType extends AttachableModuleInstance<_xylabs_object.BaseParamsFields & {
478
504
  account?: _xyo_network_account_model.AccountInstance | "random";
@@ -482,6 +508,8 @@ declare const asAttachableModuleInstance: {
482
508
  config: AnyConfigSchema<ModuleConfig>;
483
509
  ephemeralQueryAccountEnabled?: boolean;
484
510
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
511
+ privateChildren?: ModuleInstance[];
512
+ publicChildren?: ModuleInstance[];
485
513
  }, ModuleEventData<object>>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<AttachableModuleInstance<_xylabs_object.BaseParamsFields & {
486
514
  account?: _xyo_network_account_model.AccountInstance | "random";
487
515
  addToResolvers?: boolean;
@@ -490,6 +518,8 @@ declare const asAttachableModuleInstance: {
490
518
  config: AnyConfigSchema<ModuleConfig>;
491
519
  ephemeralQueryAccountEnabled?: boolean;
492
520
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
521
+ privateChildren?: ModuleInstance[];
522
+ publicChildren?: ModuleInstance[];
493
523
  }, ModuleEventData<object>>>, config?: _xylabs_object.TypeCheckConfig): TType;
494
524
  };
495
525
 
@@ -509,6 +539,8 @@ declare const isAddressModuleFilter: (value: unknown) => value is AddressObjectF
509
539
  config: AnyConfigSchema<ModuleConfig>;
510
540
  ephemeralQueryAccountEnabled?: boolean;
511
541
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
542
+ privateChildren?: ModuleInstance[];
543
+ publicChildren?: ModuleInstance[];
512
544
  }, ModuleEventData<object>>>;
513
545
  declare const isNameModuleFilter: (value: unknown) => value is NameObjectFilter<ModuleInstance<_xylabs_object.BaseParamsFields & {
514
546
  account?: _xyo_network_account_model.AccountInstance | "random";
@@ -518,6 +550,8 @@ declare const isNameModuleFilter: (value: unknown) => value is NameObjectFilter<
518
550
  config: AnyConfigSchema<ModuleConfig>;
519
551
  ephemeralQueryAccountEnabled?: boolean;
520
552
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
553
+ privateChildren?: ModuleInstance[];
554
+ publicChildren?: ModuleInstance[];
521
555
  }, ModuleEventData<object>>>;
522
556
  declare const isQueryModuleFilter: (value: unknown) => value is QueryObjectFilter<ModuleInstance<_xylabs_object.BaseParamsFields & {
523
557
  account?: _xyo_network_account_model.AccountInstance | "random";
@@ -527,6 +561,8 @@ declare const isQueryModuleFilter: (value: unknown) => value is QueryObjectFilte
527
561
  config: AnyConfigSchema<ModuleConfig>;
528
562
  ephemeralQueryAccountEnabled?: boolean;
529
563
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
564
+ privateChildren?: ModuleInstance[];
565
+ publicChildren?: ModuleInstance[];
530
566
  }, ModuleEventData<object>>>;
531
567
  type AnyModuleFilter<T extends ModuleInstance = ModuleInstance> = AnyObjectFilter<T>;
532
568
  type AddressModuleFilter<T extends ModuleInstance = ModuleInstance> = AddressObjectFilter<T>;
@@ -693,6 +729,8 @@ declare const withModule: <R>(mod: any, closure: (mod: Module<_xylabs_object.Bas
693
729
  config: AnyConfigSchema<ModuleConfig>;
694
730
  ephemeralQueryAccountEnabled?: boolean;
695
731
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
732
+ privateChildren?: ModuleInstance[];
733
+ publicChildren?: ModuleInstance[];
696
734
  }, ModuleEventData<object>>) => R) => R | undefined;
697
735
  declare const withModuleInstance: <R>(mod: any, closure: (mod: ModuleInstance<_xylabs_object.BaseParamsFields & {
698
736
  account?: _xyo_network_account_model.AccountInstance | "random";
@@ -702,6 +740,8 @@ declare const withModuleInstance: <R>(mod: any, closure: (mod: ModuleInstance<_x
702
740
  config: AnyConfigSchema<ModuleConfig>;
703
741
  ephemeralQueryAccountEnabled?: boolean;
704
742
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
743
+ privateChildren?: ModuleInstance[];
744
+ publicChildren?: ModuleInstance[];
705
745
  }, ModuleEventData<object>>) => R) => R | undefined;
706
746
 
707
747
  export { type AddressChildFields, type AddressChildPayload, AddressChildSchema, type AddressFields, type AddressModuleFilter, type AddressObjectFilter, type AddressPayload, type AddressPreviousHashPayload, AddressPreviousHashSchema, AddressSchema, type AddressToWeakInstanceCache, type AnyConfigSchema, type AnyModuleConfig, type AnyModuleFilter, type AnyObjectFilter, type ArchivingModuleConfig, type AttachableModuleInstance, type AttachableModuleInstanceTypeCheck, type CacheConfig, type ColonPair, type CosigningAddressSet, type CreatableModule, type CreatableModuleFactory, type CreatableModuleRegistry, DeadModuleError, type Direction, DisallowedModuleIdentifierCharacters, type InstanceTypeCheck, IsAttachableModuleInstanceFactory, IsInstanceFactory, IsModuleFactory, type LabeledCreatableModuleFactory, type Labels, MODULE_PATH_SEPARATOR, type Module, type ModuleAddressQuery, ModuleAddressQuerySchema, type ModuleBusyEventArgs, type ModuleBusyEventData, type ModuleConfig, type ModuleConfigFields, ModuleConfigSchema, type ModuleDescription, type ModuleDescriptionPayload, ModuleDescriptionSchema, ModuleDetailsError, type ModuleErrorEventArgs, type ModuleErrorEventData, type ModuleEventArgs, type ModuleEventData, ModuleFactory, type ModuleFamilyFunctions, type ModuleFields, type ModuleFilter, type ModuleFilterOptions, type ModuleIdentifier, type ModuleIdentifierPart, type ModuleIdentifierTransformer, type ModuleIdentifierTransformerFunc, type ModuleInstance, ModuleLimitationLabelName, ModuleLimitationViewLabel, type ModuleManifestQuery, ModuleManifestQuerySchema, type ModuleName, type ModuleNameResolver, type ModuleParams, type ModulePipeLine, type ModuleQueriedEventArgs, type ModuleQueriedEventData, type ModuleQueries, type ModuleQueryFunctions, type ModuleQueryHandlerResult, type ModuleQueryResult, type ModuleRepository, type ModuleResolveDirection, type ModuleResolver, type ModuleResolverInstance, type ModuleSecurityConfig, type ModuleState, type ModuleStateQuery, ModuleStateQuerySchema, ModuleStateSchema, type ModuleStatus, type ModuleSubscribeFilter, type ModuleSubscribeQuery, ModuleSubscribeQuerySchema, type ModuleTypeCheck, type NameModuleFilter, type NameObjectFilter, type ObjectFilter, type ObjectFilterOptions, type ObjectResolver, type ObjectResolverInstance, ObjectResolverPriority, type OptionalConfigSchema, type QueryModuleFilter, type QueryObjectFilter, type ReservedModuleIdentifierCharacter, ReservedModuleIdentifierCharacters, ResolveHelper, type ResolveHelperConfig, type ResolveStrategy, type State, type StateDictionary, type Visibility, WithFactory, type WithLabels, type WithOptionalLabels, asAttachableModuleInstance, asModule, asModuleInstance, asModuleObject, asModuleState, assignCreatableModuleRegistry, creatableModule, creatableModuleFactory, duplicateModules, hasAllLabels, hasLabels, includesReservedModuleIdentifierCharacter, isAddressModuleFilter, isAddressObjectFilter, isAttachableModuleInstance, isModule, isModuleIdentifierPart, isModuleInstance, isModuleName, isModuleObject, isModuleResolver, isModuleState, isModuleStateWithSources, isNameModuleFilter, isNameObjectFilter, isObjectResolver, isQueryModuleFilter, isQueryObjectFilter, isSerializable, labeledCreatableModuleFactory, registerCreatableModuleFactories, registerCreatableModuleFactory, requiredAttachableModuleInstanceFunctions, requiredModuleInstanceFunctions, requiredModuleQueries, requiredModuleShape, resolveAddressToInstance, resolveAddressToInstanceAll, resolveAddressToInstanceDown, resolveAddressToInstanceSiblings, resolveAddressToInstanceUp, resolveAll, resolveAllDown, resolveAllUp, resolveLocalNameToAddress, resolveLocalNameToAddressAll, resolveLocalNameToAddressDown, resolveLocalNameToAddressUp, resolveLocalNameToInstance, resolveLocalNameToInstanceAll, resolveLocalNameToInstanceDown, resolveLocalNameToInstanceUp, resolvePathToAddress, resolvePathToInstance, transformModuleIdentifier, withModule, withModuleInstance };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/module-model",
3
- "version": "3.9.3",
3
+ "version": "3.9.5",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -37,11 +37,11 @@
37
37
  "@xylabs/promise": "^4.5.1",
38
38
  "@xylabs/retry": "^4.5.1",
39
39
  "@xylabs/typeof": "^4.5.1",
40
- "@xyo-network/account-model": "^3.9.3",
41
- "@xyo-network/boundwitness-model": "^3.9.3",
42
- "@xyo-network/manifest-model": "^3.9.3",
43
- "@xyo-network/module-events": "^3.9.3",
44
- "@xyo-network/payload-model": "^3.9.3"
40
+ "@xyo-network/account-model": "^3.9.5",
41
+ "@xyo-network/boundwitness-model": "^3.9.5",
42
+ "@xyo-network/manifest-model": "^3.9.5",
43
+ "@xyo-network/module-events": "^3.9.5",
44
+ "@xyo-network/payload-model": "^3.9.5"
45
45
  },
46
46
  "devDependencies": {
47
47
  "@xylabs/ts-scripts-yarn3": "^5.0.24",
package/src/ModuleParams.ts CHANGED
@@ -4,6 +4,7 @@ import type {
4
4
  import type { AccountInstance } from '@xyo-network/account-model'
5
5
 
6
6
  import type { AnyConfigSchema, ModuleConfig } from './Config/index.ts'
7
+ import type { ModuleInstance } from './instance/index.ts'
7
8
  import type { ModuleIdentifierTransformer } from './ModuleIdentifierTransformer.ts'
8
9
 
9
10
  export type ModuleParams<
@@ -18,6 +19,8 @@ export type ModuleParams<
18
19
  config: TConfig extends AnyConfigSchema<ModuleConfig> ? TConfig : AnyConfigSchema<ModuleConfig>
19
20
  ephemeralQueryAccountEnabled?: boolean
20
21
  moduleIdentifierTransformers?: ModuleIdentifierTransformer[]
22
+ privateChildren?: ModuleInstance[]
23
+ publicChildren?: ModuleInstance[]
21
24
  }>,
22
25
  TAdditionalParams
23
26
  >