@xyo-network/url-payload-plugin 2.57.6

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 (51) hide show
  1. package/LICENSE +165 -0
  2. package/README.md +13 -0
  3. package/dist/cjs/Payload.js +3 -0
  4. package/dist/cjs/Payload.js.map +1 -0
  5. package/dist/cjs/Plugin.js +12 -0
  6. package/dist/cjs/Plugin.js.map +1 -0
  7. package/dist/cjs/Schema.js +5 -0
  8. package/dist/cjs/Schema.js.map +1 -0
  9. package/dist/cjs/Template.js +10 -0
  10. package/dist/cjs/Template.js.map +1 -0
  11. package/dist/cjs/index.js +12 -0
  12. package/dist/cjs/index.js.map +1 -0
  13. package/dist/docs.json +542 -0
  14. package/dist/esm/Payload.js +2 -0
  15. package/dist/esm/Payload.js.map +1 -0
  16. package/dist/esm/Plugin.js +8 -0
  17. package/dist/esm/Plugin.js.map +1 -0
  18. package/dist/esm/Schema.js +2 -0
  19. package/dist/esm/Schema.js.map +1 -0
  20. package/dist/esm/Template.js +6 -0
  21. package/dist/esm/Template.js.map +1 -0
  22. package/dist/esm/index.js +8 -0
  23. package/dist/esm/index.js.map +1 -0
  24. package/dist/types/Payload.d.ts +7 -0
  25. package/dist/types/Payload.d.ts.map +1 -0
  26. package/dist/types/Plugin.d.ts +5 -0
  27. package/dist/types/Plugin.d.ts.map +1 -0
  28. package/dist/types/Schema.d.ts +3 -0
  29. package/dist/types/Schema.d.ts.map +1 -0
  30. package/dist/types/Template.d.ts +3 -0
  31. package/dist/types/Template.d.ts.map +1 -0
  32. package/dist/types/index.d.ts +7 -0
  33. package/dist/types/index.d.ts.map +1 -0
  34. package/docs/assets/highlight.css +22 -0
  35. package/docs/assets/main.js +58 -0
  36. package/docs/assets/search.js +1 -0
  37. package/docs/assets/style.css +1367 -0
  38. package/docs/functions/UrlPayloadPlugin.html +50 -0
  39. package/docs/functions/urlPayloadTemplate.html +50 -0
  40. package/docs/index.html +57 -0
  41. package/docs/modules.html +72 -0
  42. package/docs/types/UrlPayload.html +46 -0
  43. package/docs/types/UrlSchema.html +47 -0
  44. package/docs/variables/UrlSchema-1.html +47 -0
  45. package/package.json +55 -0
  46. package/src/Payload.ts +8 -0
  47. package/src/Plugin.ts +11 -0
  48. package/src/Schema.ts +2 -0
  49. package/src/Template.ts +7 -0
  50. package/src/index.ts +10 -0
  51. package/typedoc.json +5 -0
package/package.json ADDED
@@ -0,0 +1,55 @@
1
+ {
2
+ "name": "@xyo-network/url-payload-plugin",
3
+ "author": {
4
+ "email": "support@xyo.network",
5
+ "name": "XYO Development Team",
6
+ "url": "https://xyo.network"
7
+ },
8
+ "bugs": {
9
+ "email": "support@xyo.network",
10
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
11
+ },
12
+ "dependencies": {
13
+ "@xyo-network/payload-model": "^2.57.6",
14
+ "@xyo-network/payload-plugin": "^2.57.6"
15
+ },
16
+ "devDependencies": {
17
+ "@xylabs/ts-scripts-yarn3": "^2.17.13",
18
+ "@xylabs/tsconfig": "^2.17.13",
19
+ "typescript": "^5.0.4"
20
+ },
21
+ "description": "Primary SDK for using XYO Protocol 2.0",
22
+ "browser": "dist/esm/index.js",
23
+ "docs": "dist/docs.json",
24
+ "exports": {
25
+ ".": {
26
+ "node": {
27
+ "import": "./dist/esm/index.js",
28
+ "require": "./dist/cjs/index.js"
29
+ },
30
+ "browser": {
31
+ "import": "./dist/esm/index.js",
32
+ "require": "./dist/cjs/index.js"
33
+ },
34
+ "default": "./dist/esm/index.js"
35
+ },
36
+ "./dist/docs.json": {
37
+ "default": "./dist/docs.json"
38
+ },
39
+ "./package.json": "./package.json"
40
+ },
41
+ "main": "dist/cjs/index.js",
42
+ "module": "dist/esm/index.js",
43
+ "homepage": "https://xyo.network",
44
+ "license": "LGPL-3.0",
45
+ "publishConfig": {
46
+ "access": "public"
47
+ },
48
+ "repository": {
49
+ "type": "git",
50
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
51
+ },
52
+ "sideEffects": false,
53
+ "types": "dist/types/index.d.ts",
54
+ "version": "2.57.6"
55
+ }
package/src/Payload.ts ADDED
@@ -0,0 +1,8 @@
1
+ import { Payload } from '@xyo-network/payload-model'
2
+
3
+ import { UrlSchema } from './Schema'
4
+
5
+ export type UrlPayload = Payload<{
6
+ schema: UrlSchema
7
+ url: string
8
+ }>
package/src/Plugin.ts ADDED
@@ -0,0 +1,11 @@
1
+ import { createPayloadPlugin } from '@xyo-network/payload-plugin'
2
+
3
+ import { UrlPayload } from './Payload'
4
+ import { UrlSchema } from './Schema'
5
+ import { urlPayloadTemplate } from './Template'
6
+
7
+ export const UrlPayloadPlugin = () =>
8
+ createPayloadPlugin<UrlPayload>({
9
+ schema: UrlSchema,
10
+ template: urlPayloadTemplate,
11
+ })
package/src/Schema.ts ADDED
@@ -0,0 +1,2 @@
1
+ export const UrlSchema = 'network.xyo.url' as const
2
+ export type UrlSchema = typeof UrlSchema
@@ -0,0 +1,7 @@
1
+ import { UrlPayload } from './Payload'
2
+ import { UrlSchema } from './Schema'
3
+
4
+ export const urlPayloadTemplate = (): UrlPayload => ({
5
+ schema: UrlSchema,
6
+ url: '',
7
+ })
package/src/index.ts ADDED
@@ -0,0 +1,10 @@
1
+ import { UrlPayloadPlugin } from './Plugin'
2
+
3
+ export * from './Payload'
4
+ export * from './Schema'
5
+ export * from './Template'
6
+
7
+ export { UrlPayloadPlugin }
8
+
9
+ // eslint-disable-next-line import/no-default-export
10
+ export default UrlPayloadPlugin
package/typedoc.json ADDED
@@ -0,0 +1,5 @@
1
+ {
2
+ "$schema": "https://typedoc.org/schema.json",
3
+ "entryPoints": ["./src/index.ts"],
4
+ "tsconfig": "./tsconfig.typedoc.json"
5
+ }