@xyo-network/module-model 2.92.7 → 2.92.9

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 (57) hide show
  1. package/dist/browser/Config/Fields.d.cts +3 -0
  2. package/dist/browser/Config/Fields.d.cts.map +1 -1
  3. package/dist/browser/Config/Fields.d.mts +3 -0
  4. package/dist/browser/Config/Fields.d.mts.map +1 -1
  5. package/dist/browser/Config/Fields.d.ts +3 -0
  6. package/dist/browser/Config/Fields.d.ts.map +1 -1
  7. package/dist/browser/ModuleIdentifier.d.cts +1 -1
  8. package/dist/browser/ModuleIdentifier.d.cts.map +1 -1
  9. package/dist/browser/ModuleIdentifier.d.mts +1 -1
  10. package/dist/browser/ModuleIdentifier.d.mts.map +1 -1
  11. package/dist/browser/ModuleIdentifier.d.ts +1 -1
  12. package/dist/browser/ModuleIdentifier.d.ts.map +1 -1
  13. package/dist/browser/index.cjs.map +1 -1
  14. package/dist/browser/index.js.map +1 -1
  15. package/dist/browser/instance/ObjectResolver.d.cts +7 -2
  16. package/dist/browser/instance/ObjectResolver.d.cts.map +1 -1
  17. package/dist/browser/instance/ObjectResolver.d.mts +7 -2
  18. package/dist/browser/instance/ObjectResolver.d.mts.map +1 -1
  19. package/dist/browser/instance/ObjectResolver.d.ts +7 -2
  20. package/dist/browser/instance/ObjectResolver.d.ts.map +1 -1
  21. package/dist/browser/module/ModuleQueryFunctions.d.cts +2 -1
  22. package/dist/browser/module/ModuleQueryFunctions.d.cts.map +1 -1
  23. package/dist/browser/module/ModuleQueryFunctions.d.mts +2 -1
  24. package/dist/browser/module/ModuleQueryFunctions.d.mts.map +1 -1
  25. package/dist/browser/module/ModuleQueryFunctions.d.ts +2 -1
  26. package/dist/browser/module/ModuleQueryFunctions.d.ts.map +1 -1
  27. package/dist/node/Config/Fields.d.cts +3 -0
  28. package/dist/node/Config/Fields.d.cts.map +1 -1
  29. package/dist/node/Config/Fields.d.mts +3 -0
  30. package/dist/node/Config/Fields.d.mts.map +1 -1
  31. package/dist/node/Config/Fields.d.ts +3 -0
  32. package/dist/node/Config/Fields.d.ts.map +1 -1
  33. package/dist/node/ModuleIdentifier.d.cts +1 -1
  34. package/dist/node/ModuleIdentifier.d.cts.map +1 -1
  35. package/dist/node/ModuleIdentifier.d.mts +1 -1
  36. package/dist/node/ModuleIdentifier.d.mts.map +1 -1
  37. package/dist/node/ModuleIdentifier.d.ts +1 -1
  38. package/dist/node/ModuleIdentifier.d.ts.map +1 -1
  39. package/dist/node/index.cjs.map +1 -1
  40. package/dist/node/index.js.map +1 -1
  41. package/dist/node/instance/ObjectResolver.d.cts +7 -2
  42. package/dist/node/instance/ObjectResolver.d.cts.map +1 -1
  43. package/dist/node/instance/ObjectResolver.d.mts +7 -2
  44. package/dist/node/instance/ObjectResolver.d.mts.map +1 -1
  45. package/dist/node/instance/ObjectResolver.d.ts +7 -2
  46. package/dist/node/instance/ObjectResolver.d.ts.map +1 -1
  47. package/dist/node/module/ModuleQueryFunctions.d.cts +2 -1
  48. package/dist/node/module/ModuleQueryFunctions.d.cts.map +1 -1
  49. package/dist/node/module/ModuleQueryFunctions.d.mts +2 -1
  50. package/dist/node/module/ModuleQueryFunctions.d.mts.map +1 -1
  51. package/dist/node/module/ModuleQueryFunctions.d.ts +2 -1
  52. package/dist/node/module/ModuleQueryFunctions.d.ts.map +1 -1
  53. package/package.json +14 -14
  54. package/src/Config/Fields.ts +4 -0
  55. package/src/ModuleIdentifier.ts +1 -1
  56. package/src/instance/ObjectResolver.ts +8 -2
  57. package/src/module/ModuleQueryFunctions.ts +2 -1
@@ -1,3 +1,4 @@
1
+ import { Address } from '@xylabs/hex';
1
2
  import { Promisable } from '@xylabs/promise';
2
3
  import { ModuleManifestPayload } from '@xyo-network/manifest-model';
3
4
  import { Payload } from '@xyo-network/payload-model';
@@ -6,7 +7,7 @@ import { AddressPreviousHashPayload } from '../Queries';
6
7
  export interface ModuleQueryFunctions {
7
8
  describe: () => Promise<ModuleDescription>;
8
9
  discover: () => Promisable<Payload[]>;
9
- manifest: (maxDepth?: number, ignoreAddresses?: string[]) => Promisable<ModuleManifestPayload>;
10
+ manifest: (maxDepth?: number, ignoreAddresses?: Address[]) => Promisable<ModuleManifestPayload>;
10
11
  moduleAddress: () => Promisable<AddressPreviousHashPayload[]>;
11
12
  state: () => Promisable<Payload[]>;
12
13
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ModuleQueryFunctions.d.ts","sourceRoot":"","sources":["../../../src/module/ModuleQueryFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAEvD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAC1C,QAAQ,EAAE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;IACrC,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,UAAU,CAAC,qBAAqB,CAAC,CAAA;IAC9F,aAAa,EAAE,MAAM,UAAU,CAAC,0BAA0B,EAAE,CAAC,CAAA;IAC7D,KAAK,EAAE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;CACnC"}
1
+ {"version":3,"file":"ModuleQueryFunctions.d.ts","sourceRoot":"","sources":["../../../src/module/ModuleQueryFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAEvD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAC1C,QAAQ,EAAE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;IACrC,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,OAAO,EAAE,KAAK,UAAU,CAAC,qBAAqB,CAAC,CAAA;IAC/F,aAAa,EAAE,MAAM,UAAU,CAAC,0BAA0B,EAAE,CAAC,CAAA;IAC7D,KAAK,EAAE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;CACnC"}
@@ -1,3 +1,4 @@
1
+ import { Address } from '@xylabs/hex';
1
2
  import { Promisable } from '@xylabs/promise';
2
3
  import { ModuleManifestPayload } from '@xyo-network/manifest-model';
3
4
  import { Payload } from '@xyo-network/payload-model';
@@ -6,7 +7,7 @@ import { AddressPreviousHashPayload } from '../Queries';
6
7
  export interface ModuleQueryFunctions {
7
8
  describe: () => Promise<ModuleDescription>;
8
9
  discover: () => Promisable<Payload[]>;
9
- manifest: (maxDepth?: number, ignoreAddresses?: string[]) => Promisable<ModuleManifestPayload>;
10
+ manifest: (maxDepth?: number, ignoreAddresses?: Address[]) => Promisable<ModuleManifestPayload>;
10
11
  moduleAddress: () => Promisable<AddressPreviousHashPayload[]>;
11
12
  state: () => Promisable<Payload[]>;
12
13
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ModuleQueryFunctions.d.ts","sourceRoot":"","sources":["../../../src/module/ModuleQueryFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAEvD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAC1C,QAAQ,EAAE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;IACrC,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,UAAU,CAAC,qBAAqB,CAAC,CAAA;IAC9F,aAAa,EAAE,MAAM,UAAU,CAAC,0BAA0B,EAAE,CAAC,CAAA;IAC7D,KAAK,EAAE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;CACnC"}
1
+ {"version":3,"file":"ModuleQueryFunctions.d.ts","sourceRoot":"","sources":["../../../src/module/ModuleQueryFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAEvD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAC1C,QAAQ,EAAE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;IACrC,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,OAAO,EAAE,KAAK,UAAU,CAAC,qBAAqB,CAAC,CAAA;IAC/F,aAAa,EAAE,MAAM,UAAU,CAAC,0BAA0B,EAAE,CAAC,CAAA;IAC7D,KAAK,EAAE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;CACnC"}
package/package.json CHANGED
@@ -10,19 +10,19 @@
10
10
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
11
11
  },
12
12
  "dependencies": {
13
- "@xylabs/assert": "^3.0.13",
14
- "@xylabs/hex": "^3.0.13",
15
- "@xylabs/lodash": "^3.0.13",
16
- "@xylabs/logger": "^3.0.13",
17
- "@xylabs/object": "^3.0.13",
18
- "@xylabs/promise": "^3.0.13",
19
- "@xylabs/retry": "^3.0.13",
20
- "@xyo-network/account-model": "~2.92.7",
21
- "@xyo-network/address-payload-plugin": "~2.92.7",
22
- "@xyo-network/boundwitness-model": "~2.92.7",
23
- "@xyo-network/manifest-model": "~2.92.7",
24
- "@xyo-network/module-events": "~2.92.7",
25
- "@xyo-network/payload-model": "~2.92.7"
13
+ "@xylabs/assert": "^3.0.15",
14
+ "@xylabs/hex": "^3.0.15",
15
+ "@xylabs/lodash": "^3.0.15",
16
+ "@xylabs/logger": "^3.0.15",
17
+ "@xylabs/object": "^3.0.15",
18
+ "@xylabs/promise": "^3.0.15",
19
+ "@xylabs/retry": "^3.0.15",
20
+ "@xyo-network/account-model": "~2.92.9",
21
+ "@xyo-network/address-payload-plugin": "~2.92.9",
22
+ "@xyo-network/boundwitness-model": "~2.92.9",
23
+ "@xyo-network/manifest-model": "~2.92.9",
24
+ "@xyo-network/module-events": "~2.92.9",
25
+ "@xyo-network/payload-model": "~2.92.9"
26
26
  },
27
27
  "devDependencies": {
28
28
  "@xylabs/ts-scripts-yarn3": "^3.5.2",
@@ -68,6 +68,6 @@
68
68
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
69
69
  },
70
70
  "sideEffects": false,
71
- "version": "2.92.7",
71
+ "version": "2.92.9",
72
72
  "type": "module"
73
73
  }
@@ -1,10 +1,14 @@
1
1
  import { RetryConfig } from '@xylabs/retry'
2
+ import { Schema } from '@xyo-network/payload-model'
2
3
 
3
4
  import { Labels } from '../Labels'
4
5
  import { ModuleIdentifier, ModuleName } from '../ModuleIdentifier'
5
6
  import { ModuleSecurityConfig } from './Security'
6
7
 
7
8
  export interface ModuleConfigFields {
9
+ /** Limit to only these allowed queries */
10
+ readonly allowedQueries?: Schema[] | undefined
11
+
8
12
  /** @field The name/address of the Archivist to use for this module */
9
13
  readonly archivist?: ModuleIdentifier
10
14
 
@@ -50,7 +50,7 @@ export type ModuleIdentifier =
50
50
 
51
51
  export type ColonPair<T extends string> = `${T}:${T}` | T
52
52
 
53
- export type ModuleIdentifierPart = Address | ModuleName
53
+ export type ModuleIdentifierPart = Exclude<Address | ModuleName, '*'>
54
54
 
55
55
  export const isModuleName = (value: unknown): value is ModuleName => {
56
56
  return typeof value === 'string' && !isAddress(value) && !includesReservedModuleIdentifierCharacter(value)
@@ -5,14 +5,20 @@ import { ModuleIdentifier } from '../ModuleIdentifier'
5
5
  import { ObjectFilter, ObjectFilterOptions } from './ObjectFilter'
6
6
 
7
7
  export const isObjectResolver = <T extends EmptyObject = AnyObject>(value?: unknown): value is ObjectResolver<T> => {
8
+ // eslint-disable-next-line deprecation/deprecation
8
9
  return typeof (value as Partial<ObjectResolver<T>>).resolve === 'function'
9
10
  }
10
11
 
11
12
  export interface ObjectResolver<TResult extends EmptyObject> {
13
+ /** @deprecated do not pass undefined. If trying to get all, pass '*' */
14
+ resolve<T extends TResult = TResult>(): Promisable<T | undefined>
15
+ resolve<T extends TResult = TResult>(all: '*', options?: ObjectFilterOptions<T>): Promisable<T[]>
16
+ resolve<T extends TResult = TResult>(id: ModuleIdentifier, options?: ObjectFilterOptions<T>): Promisable<T | undefined>
17
+ resolve<T extends TResult = TResult>(filter: ObjectFilter<T>, options?: ObjectFilterOptions<T>): Promisable<T[]>
18
+ /** @deprecated do not pass undefined. If trying to get all, pass '*' */
12
19
  resolve<T extends TResult = TResult>(filter?: ObjectFilter<T>, options?: ObjectFilterOptions<T>): Promisable<T[]>
13
- resolve<T extends TResult = TResult>(nameOrAddress: ModuleIdentifier, options?: ObjectFilterOptions<T>): Promisable<T | undefined>
14
20
  resolve<T extends TResult = TResult>(
15
- nameOrAddressOrFilter?: ObjectFilter<T> | ModuleIdentifier,
21
+ idOrFilter?: ObjectFilter<T> | ModuleIdentifier,
16
22
  options?: ObjectFilterOptions<T>,
17
23
  ): Promisable<T | T[] | undefined>
18
24
  }
@@ -1,3 +1,4 @@
1
+ import { Address } from '@xylabs/hex'
1
2
  import { Promisable } from '@xylabs/promise'
2
3
  import { ModuleManifestPayload } from '@xyo-network/manifest-model'
3
4
  import { Payload } from '@xyo-network/payload-model'
@@ -8,7 +9,7 @@ import { AddressPreviousHashPayload } from '../Queries'
8
9
  export interface ModuleQueryFunctions {
9
10
  describe: () => Promise<ModuleDescription>
10
11
  discover: () => Promisable<Payload[]>
11
- manifest: (maxDepth?: number, ignoreAddresses?: string[]) => Promisable<ModuleManifestPayload>
12
+ manifest: (maxDepth?: number, ignoreAddresses?: Address[]) => Promisable<ModuleManifestPayload>
12
13
  moduleAddress: () => Promisable<AddressPreviousHashPayload[]>
13
14
  state: () => Promisable<Payload[]>
14
15
  }