@xyo-network/payload-plugin 2.74.5 → 2.75.0

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 (76) hide show
  1. package/dist/browser/Plugin.cjs +19 -0
  2. package/dist/browser/Plugin.cjs.map +1 -0
  3. package/dist/browser/Plugin.d.mts.map +1 -0
  4. package/dist/browser/Plugin.d.ts.map +1 -0
  5. package/dist/browser/Plugin.js +1 -0
  6. package/dist/browser/Plugin.js.map +1 -0
  7. package/dist/browser/Resolver.cjs +95 -0
  8. package/dist/browser/Resolver.cjs.map +1 -0
  9. package/dist/browser/Resolver.d.mts.map +1 -0
  10. package/dist/browser/Resolver.d.ts.map +1 -0
  11. package/dist/browser/Resolver.js +74 -0
  12. package/dist/browser/Resolver.js.map +1 -0
  13. package/dist/browser/createPlugin.cjs +51 -0
  14. package/dist/browser/createPlugin.cjs.map +1 -0
  15. package/dist/browser/createPlugin.d.mts.map +1 -0
  16. package/dist/browser/createPlugin.d.ts.map +1 -0
  17. package/dist/browser/createPlugin.js +30 -0
  18. package/dist/browser/createPlugin.js.map +1 -0
  19. package/dist/{index.js → browser/index.cjs} +1 -7
  20. package/dist/browser/index.cjs.map +1 -0
  21. package/dist/browser/index.d.mts.map +1 -0
  22. package/dist/browser/index.d.ts.map +1 -0
  23. package/dist/{index.mjs → browser/index.js} +1 -1
  24. package/dist/browser/index.js.map +1 -0
  25. package/dist/node/Plugin.d.mts +14 -0
  26. package/dist/node/Plugin.d.mts.map +1 -0
  27. package/dist/node/Plugin.d.ts +14 -0
  28. package/dist/node/Plugin.d.ts.map +1 -0
  29. package/dist/node/Plugin.js +17 -0
  30. package/dist/node/Plugin.js.map +1 -0
  31. package/dist/node/Plugin.mjs +1 -0
  32. package/dist/node/Plugin.mjs.map +1 -0
  33. package/dist/node/Resolver.d.mts +26 -0
  34. package/dist/node/Resolver.d.mts.map +1 -0
  35. package/dist/node/Resolver.d.ts +26 -0
  36. package/dist/node/Resolver.d.ts.map +1 -0
  37. package/dist/node/Resolver.js +70 -0
  38. package/dist/node/Resolver.js.map +1 -0
  39. package/dist/node/Resolver.mjs +46 -0
  40. package/dist/node/Resolver.mjs.map +1 -0
  41. package/dist/node/createPlugin.d.mts +10 -0
  42. package/dist/node/createPlugin.d.mts.map +1 -0
  43. package/dist/node/createPlugin.d.ts +10 -0
  44. package/dist/node/createPlugin.d.ts.map +1 -0
  45. package/dist/node/createPlugin.js +54 -0
  46. package/dist/node/createPlugin.js.map +1 -0
  47. package/dist/node/createPlugin.mjs +29 -0
  48. package/dist/node/createPlugin.mjs.map +1 -0
  49. package/dist/node/index.d.mts +4 -0
  50. package/dist/node/index.d.mts.map +1 -0
  51. package/dist/node/index.d.ts +4 -0
  52. package/dist/node/index.d.ts.map +1 -0
  53. package/dist/node/index.js +27 -0
  54. package/dist/node/index.js.map +1 -0
  55. package/dist/node/index.mjs +4 -0
  56. package/dist/node/index.mjs.map +1 -0
  57. package/package.json +30 -27
  58. package/dist/Plugin.d.mts.map +0 -1
  59. package/dist/Plugin.d.ts.map +0 -1
  60. package/dist/Resolver.d.mts.map +0 -1
  61. package/dist/Resolver.d.ts.map +0 -1
  62. package/dist/createPlugin.d.mts.map +0 -1
  63. package/dist/createPlugin.d.ts.map +0 -1
  64. package/dist/docs.json +0 -2186
  65. package/dist/index.d.mts.map +0 -1
  66. package/dist/index.d.ts.map +0 -1
  67. package/dist/index.js.map +0 -1
  68. package/dist/index.mjs.map +0 -1
  69. /package/dist/{Plugin.d.mts → browser/Plugin.d.mts} +0 -0
  70. /package/dist/{Plugin.d.ts → browser/Plugin.d.ts} +0 -0
  71. /package/dist/{Resolver.d.mts → browser/Resolver.d.mts} +0 -0
  72. /package/dist/{Resolver.d.ts → browser/Resolver.d.ts} +0 -0
  73. /package/dist/{createPlugin.d.mts → browser/createPlugin.d.mts} +0 -0
  74. /package/dist/{createPlugin.d.ts → browser/createPlugin.d.ts} +0 -0
  75. /package/dist/{index.d.mts → browser/index.d.mts} +0 -0
  76. /package/dist/{index.d.ts → browser/index.d.ts} +0 -0
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA"}
package/dist/index.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/index.ts","../src/createPlugin.ts","../src/Resolver.ts"],"sourcesContent":["export * from './createPlugin'\nexport * from './Plugin'\nexport * from './Resolver'\n","import { assertEx } from '@xylabs/assert'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload } from '@xyo-network/payload-model'\nimport { PayloadValidator } from '@xyo-network/payload-validator'\nimport { PayloadWrapper } from '@xyo-network/payload-wrapper'\n\nimport { PayloadPlugin } from './Plugin'\n\nexport const defaultPayloadPluginFunctions = <T extends Payload>(schema: string): PayloadPlugin<T> => {\n return {\n build: (): PayloadBuilder<T> => {\n return new PayloadBuilder<T>({ schema })\n },\n schema,\n validate: (payload: Payload): PayloadValidator<T> => {\n return new PayloadValidator<T>(payload as T)\n },\n wrap: (payload: Payload): PayloadWrapper<T> => {\n return PayloadWrapper.wrap<T>(payload as T)\n },\n }\n}\n\nexport const createPayloadPlugin = <TPayload extends Payload = Payload>(plugin: PayloadPlugin<TPayload>): PayloadPlugin<TPayload> => {\n return {\n ...defaultPayloadPluginFunctions<TPayload>(assertEx(plugin.schema, 'schema field required to create plugin')),\n ...plugin,\n }\n}\n","import { Validator } from '@xyo-network/core'\nimport { Payload, PayloadSchema } from '@xyo-network/payload-model'\nimport { PayloadWrapper } from '@xyo-network/payload-wrapper'\n\nimport { createPayloadPlugin } from './createPlugin'\nimport { PayloadPlugin } from './Plugin'\n\nexport class PayloadPluginResolver {\n schema = PayloadSchema\n\n protected _plugins: Record<string, PayloadPlugin> = {}\n protected defaultPlugin: PayloadPlugin\n\n constructor(\n /** @param plugins The initial set of plugins */\n plugins?: PayloadPlugin<Payload>[],\n /** @param defaultPlugin Specifies the plugin to be used if no plugins resolve */\n defaultPlugin = createPayloadPlugin<Payload>({\n schema: PayloadSchema,\n }),\n ) {\n plugins?.forEach((plugin) => this.register(plugin))\n this.defaultPlugin = defaultPlugin\n }\n\n /** @description Create list of plugins, optionally filtered by ability to witness/divine */\n plugins() {\n const result: PayloadPlugin[] = []\n Object.values(this._plugins).forEach((value) => {\n result.push(value)\n })\n return result\n }\n\n register<TPlugin extends PayloadPlugin = PayloadPlugin>(plugin: TPlugin) {\n this._plugins[plugin.schema] = plugin\n\n return this\n }\n\n resolve(schema?: string): PayloadPlugin\n resolve(payload: Payload): PayloadPlugin\n resolve(value: Payload | string | undefined): PayloadPlugin {\n return value ? this._plugins[typeof value === 'string' ? value : value.schema] ?? this.defaultPlugin : this.defaultPlugin\n }\n\n /** @description Create list of schema, optionally filtered by ability to witness/divine */\n schemas() {\n const result: string[] = []\n Object.values(this._plugins).forEach((value) => {\n result.push(value.schema)\n })\n return result\n }\n\n validate(payload: Payload): Validator<Payload> | undefined {\n return this.resolve(payload).validate?.(payload)\n }\n\n wrap(payload: Payload): PayloadWrapper<Payload> | undefined {\n return this.resolve(payload).wrap?.(payload)\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAAyB;AACzB,6BAA+B;AAE/B,+BAAiC;AACjC,6BAA+B;AAIxB,IAAM,gCAAgC,CAAoB,WAAqC;AACpG,SAAO;AAAA,IACL,OAAO,MAAyB;AAC9B,aAAO,IAAI,sCAAkB,EAAE,OAAO,CAAC;AAAA,IACzC;AAAA,IACA;AAAA,IACA,UAAU,CAAC,YAA0C;AACnD,aAAO,IAAI,0CAAoB,OAAY;AAAA,IAC7C;AAAA,IACA,MAAM,CAAC,YAAwC;AAC7C,aAAO,sCAAe,KAAQ,OAAY;AAAA,IAC5C;AAAA,EACF;AACF;AAEO,IAAM,sBAAsB,CAAqC,WAA6D;AACnI,SAAO;AAAA,IACL,GAAG,kCAAwC,wBAAS,OAAO,QAAQ,wCAAwC,CAAC;AAAA,IAC5G,GAAG;AAAA,EACL;AACF;;;AC3BA,2BAAuC;AAMhC,IAAM,wBAAN,MAA4B;AAAA,EACjC,SAAS;AAAA,EAEC,WAA0C,CAAC;AAAA,EAC3C;AAAA,EAEV,YAEE,SAEA,gBAAgB,oBAA6B;AAAA,IAC3C,QAAQ;AAAA,EACV,CAAC,GACD;AACA,aAAS,QAAQ,CAAC,WAAW,KAAK,SAAS,MAAM,CAAC;AAClD,SAAK,gBAAgB;AAAA,EACvB;AAAA;AAAA,EAGA,UAAU;AACR,UAAM,SAA0B,CAAC;AACjC,WAAO,OAAO,KAAK,QAAQ,EAAE,QAAQ,CAAC,UAAU;AAC9C,aAAO,KAAK,KAAK;AAAA,IACnB,CAAC;AACD,WAAO;AAAA,EACT;AAAA,EAEA,SAAwD,QAAiB;AACvE,SAAK,SAAS,OAAO,MAAM,IAAI;AAE/B,WAAO;AAAA,EACT;AAAA,EAIA,QAAQ,OAAoD;AAC1D,WAAO,QAAQ,KAAK,SAAS,OAAO,UAAU,WAAW,QAAQ,MAAM,MAAM,KAAK,KAAK,gBAAgB,KAAK;AAAA,EAC9G;AAAA;AAAA,EAGA,UAAU;AACR,UAAM,SAAmB,CAAC;AAC1B,WAAO,OAAO,KAAK,QAAQ,EAAE,QAAQ,CAAC,UAAU;AAC9C,aAAO,KAAK,MAAM,MAAM;AAAA,IAC1B,CAAC;AACD,WAAO;AAAA,EACT;AAAA,EAEA,SAAS,SAAkD;AACzD,WAAO,KAAK,QAAQ,OAAO,EAAE,WAAW,OAAO;AAAA,EACjD;AAAA,EAEA,KAAK,SAAuD;AAC1D,WAAO,KAAK,QAAQ,OAAO,EAAE,OAAO,OAAO;AAAA,EAC7C;AACF;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/createPlugin.ts","../src/Resolver.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload } from '@xyo-network/payload-model'\nimport { PayloadValidator } from '@xyo-network/payload-validator'\nimport { PayloadWrapper } from '@xyo-network/payload-wrapper'\n\nimport { PayloadPlugin } from './Plugin'\n\nexport const defaultPayloadPluginFunctions = <T extends Payload>(schema: string): PayloadPlugin<T> => {\n return {\n build: (): PayloadBuilder<T> => {\n return new PayloadBuilder<T>({ schema })\n },\n schema,\n validate: (payload: Payload): PayloadValidator<T> => {\n return new PayloadValidator<T>(payload as T)\n },\n wrap: (payload: Payload): PayloadWrapper<T> => {\n return PayloadWrapper.wrap<T>(payload as T)\n },\n }\n}\n\nexport const createPayloadPlugin = <TPayload extends Payload = Payload>(plugin: PayloadPlugin<TPayload>): PayloadPlugin<TPayload> => {\n return {\n ...defaultPayloadPluginFunctions<TPayload>(assertEx(plugin.schema, 'schema field required to create plugin')),\n ...plugin,\n }\n}\n","import { Validator } from '@xyo-network/core'\nimport { Payload, PayloadSchema } from '@xyo-network/payload-model'\nimport { PayloadWrapper } from '@xyo-network/payload-wrapper'\n\nimport { createPayloadPlugin } from './createPlugin'\nimport { PayloadPlugin } from './Plugin'\n\nexport class PayloadPluginResolver {\n schema = PayloadSchema\n\n protected _plugins: Record<string, PayloadPlugin> = {}\n protected defaultPlugin: PayloadPlugin\n\n constructor(\n /** @param plugins The initial set of plugins */\n plugins?: PayloadPlugin<Payload>[],\n /** @param defaultPlugin Specifies the plugin to be used if no plugins resolve */\n defaultPlugin = createPayloadPlugin<Payload>({\n schema: PayloadSchema,\n }),\n ) {\n plugins?.forEach((plugin) => this.register(plugin))\n this.defaultPlugin = defaultPlugin\n }\n\n /** @description Create list of plugins, optionally filtered by ability to witness/divine */\n plugins() {\n const result: PayloadPlugin[] = []\n Object.values(this._plugins).forEach((value) => {\n result.push(value)\n })\n return result\n }\n\n register<TPlugin extends PayloadPlugin = PayloadPlugin>(plugin: TPlugin) {\n this._plugins[plugin.schema] = plugin\n\n return this\n }\n\n resolve(schema?: string): PayloadPlugin\n resolve(payload: Payload): PayloadPlugin\n resolve(value: Payload | string | undefined): PayloadPlugin {\n return value ? this._plugins[typeof value === 'string' ? value : value.schema] ?? this.defaultPlugin : this.defaultPlugin\n }\n\n /** @description Create list of schema, optionally filtered by ability to witness/divine */\n schemas() {\n const result: string[] = []\n Object.values(this._plugins).forEach((value) => {\n result.push(value.schema)\n })\n return result\n }\n\n validate(payload: Payload): Validator<Payload> | undefined {\n return this.resolve(payload).validate?.(payload)\n }\n\n wrap(payload: Payload): PayloadWrapper<Payload> | undefined {\n return this.resolve(payload).wrap?.(payload)\n }\n}\n"],"mappings":";AAAA,SAAS,gBAAgB;AACzB,SAAS,sBAAsB;AAE/B,SAAS,wBAAwB;AACjC,SAAS,sBAAsB;AAIxB,IAAM,gCAAgC,CAAoB,WAAqC;AACpG,SAAO;AAAA,IACL,OAAO,MAAyB;AAC9B,aAAO,IAAI,eAAkB,EAAE,OAAO,CAAC;AAAA,IACzC;AAAA,IACA;AAAA,IACA,UAAU,CAAC,YAA0C;AACnD,aAAO,IAAI,iBAAoB,OAAY;AAAA,IAC7C;AAAA,IACA,MAAM,CAAC,YAAwC;AAC7C,aAAO,eAAe,KAAQ,OAAY;AAAA,IAC5C;AAAA,EACF;AACF;AAEO,IAAM,sBAAsB,CAAqC,WAA6D;AACnI,SAAO;AAAA,IACL,GAAG,8BAAwC,SAAS,OAAO,QAAQ,wCAAwC,CAAC;AAAA,IAC5G,GAAG;AAAA,EACL;AACF;;;AC3BA,SAAkB,qBAAqB;AAMhC,IAAM,wBAAN,MAA4B;AAAA,EACjC,SAAS;AAAA,EAEC,WAA0C,CAAC;AAAA,EAC3C;AAAA,EAEV,YAEE,SAEA,gBAAgB,oBAA6B;AAAA,IAC3C,QAAQ;AAAA,EACV,CAAC,GACD;AACA,aAAS,QAAQ,CAAC,WAAW,KAAK,SAAS,MAAM,CAAC;AAClD,SAAK,gBAAgB;AAAA,EACvB;AAAA;AAAA,EAGA,UAAU;AACR,UAAM,SAA0B,CAAC;AACjC,WAAO,OAAO,KAAK,QAAQ,EAAE,QAAQ,CAAC,UAAU;AAC9C,aAAO,KAAK,KAAK;AAAA,IACnB,CAAC;AACD,WAAO;AAAA,EACT;AAAA,EAEA,SAAwD,QAAiB;AACvE,SAAK,SAAS,OAAO,MAAM,IAAI;AAE/B,WAAO;AAAA,EACT;AAAA,EAIA,QAAQ,OAAoD;AAC1D,WAAO,QAAQ,KAAK,SAAS,OAAO,UAAU,WAAW,QAAQ,MAAM,MAAM,KAAK,KAAK,gBAAgB,KAAK;AAAA,EAC9G;AAAA;AAAA,EAGA,UAAU;AACR,UAAM,SAAmB,CAAC;AAC1B,WAAO,OAAO,KAAK,QAAQ,EAAE,QAAQ,CAAC,UAAU;AAC9C,aAAO,KAAK,MAAM,MAAM;AAAA,IAC1B,CAAC;AACD,WAAO;AAAA,EACT;AAAA,EAEA,SAAS,SAAkD;AACzD,WAAO,KAAK,QAAQ,OAAO,EAAE,WAAW,OAAO;AAAA,EACjD;AAAA,EAEA,KAAK,SAAuD;AAC1D,WAAO,KAAK,QAAQ,OAAO,EAAE,OAAO,OAAO;AAAA,EAC7C;AACF;","names":[]}
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes