@hypercerts-org/lexicon 0.10.0 → 0.11.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 (168) hide show
  1. package/CHANGELOG.md +205 -0
  2. package/README.md +371 -388
  3. package/SCHEMAS.md +533 -75
  4. package/dist/exports.d.ts +900 -10
  5. package/dist/exports.d.ts.map +1 -1
  6. package/dist/generated/exports.d.ts +900 -10
  7. package/dist/generated/exports.d.ts.map +1 -1
  8. package/dist/generated/lexicons.d.ts +2683 -1093
  9. package/dist/generated/lexicons.d.ts.map +1 -1
  10. package/dist/generated/types/app/bsky/richtext/facet.d.ts +44 -7
  11. package/dist/generated/types/app/bsky/richtext/facet.d.ts.map +1 -1
  12. package/dist/generated/types/app/certified/badge/award.d.ts +2 -3
  13. package/dist/generated/types/app/certified/badge/award.d.ts.map +1 -1
  14. package/dist/generated/types/app/certified/badge/definition.d.ts +3 -3
  15. package/dist/generated/types/app/certified/badge/definition.d.ts.map +1 -1
  16. package/dist/generated/types/app/certified/badge/response.d.ts +2 -2
  17. package/dist/generated/types/app/certified/badge/response.d.ts.map +1 -1
  18. package/dist/generated/types/app/certified/link/evm.d.ts +45 -0
  19. package/dist/generated/types/app/certified/link/evm.d.ts.map +1 -0
  20. package/dist/generated/types/org/hypercerts/claim/activity.d.ts +6 -3
  21. package/dist/generated/types/org/hypercerts/claim/activity.d.ts.map +1 -1
  22. package/dist/generated/types/org/hypercerts/collection.d.ts +11 -5
  23. package/dist/generated/types/org/hypercerts/collection.d.ts.map +1 -1
  24. package/dist/generated/types/org/hypercerts/context/attachment.d.ts +5 -3
  25. package/dist/generated/types/org/hypercerts/context/attachment.d.ts.map +1 -1
  26. package/dist/generated/types/org/hypercerts/context/evaluation.d.ts +6 -6
  27. package/dist/generated/types/org/hypercerts/context/evaluation.d.ts.map +1 -1
  28. package/dist/generated/types/org/hypercerts/defs.d.ts +11 -0
  29. package/dist/generated/types/org/hypercerts/defs.d.ts.map +1 -1
  30. package/dist/generated/types/org/hypercerts/funding/receipt.d.ts +17 -5
  31. package/dist/generated/types/org/hypercerts/funding/receipt.d.ts.map +1 -1
  32. package/dist/generated/types/pub/leaflet/blocks/blockquote.d.ts +13 -0
  33. package/dist/generated/types/pub/leaflet/blocks/blockquote.d.ts.map +1 -0
  34. package/dist/generated/types/pub/leaflet/blocks/bskyPost.d.ts +13 -0
  35. package/dist/generated/types/pub/leaflet/blocks/bskyPost.d.ts.map +1 -0
  36. package/dist/generated/types/pub/leaflet/blocks/button.d.ts +12 -0
  37. package/dist/generated/types/pub/leaflet/blocks/button.d.ts.map +1 -0
  38. package/dist/generated/types/pub/leaflet/blocks/code.d.ts +13 -0
  39. package/dist/generated/types/pub/leaflet/blocks/code.d.ts.map +1 -0
  40. package/dist/generated/types/pub/leaflet/blocks/header.d.ts +14 -0
  41. package/dist/generated/types/pub/leaflet/blocks/header.d.ts.map +1 -0
  42. package/dist/generated/types/pub/leaflet/blocks/horizontalRule.d.ts +10 -0
  43. package/dist/generated/types/pub/leaflet/blocks/horizontalRule.d.ts.map +1 -0
  44. package/dist/generated/types/pub/leaflet/blocks/iframe.d.ts +12 -0
  45. package/dist/generated/types/pub/leaflet/blocks/iframe.d.ts.map +1 -0
  46. package/dist/generated/types/pub/leaflet/blocks/image.d.ts +21 -0
  47. package/dist/generated/types/pub/leaflet/blocks/image.d.ts.map +1 -0
  48. package/dist/generated/types/pub/leaflet/blocks/math.d.ts +11 -0
  49. package/dist/generated/types/pub/leaflet/blocks/math.d.ts.map +1 -0
  50. package/dist/generated/types/pub/leaflet/blocks/orderedList.d.ts +31 -0
  51. package/dist/generated/types/pub/leaflet/blocks/orderedList.d.ts.map +1 -0
  52. package/dist/generated/types/pub/leaflet/blocks/page.d.ts +11 -0
  53. package/dist/generated/types/pub/leaflet/blocks/page.d.ts.map +1 -0
  54. package/dist/generated/types/pub/leaflet/blocks/poll.d.ts +12 -0
  55. package/dist/generated/types/pub/leaflet/blocks/poll.d.ts.map +1 -0
  56. package/dist/generated/types/pub/leaflet/blocks/text.d.ts +14 -0
  57. package/dist/generated/types/pub/leaflet/blocks/text.d.ts.map +1 -0
  58. package/dist/generated/types/pub/leaflet/blocks/unorderedList.d.ts +29 -0
  59. package/dist/generated/types/pub/leaflet/blocks/unorderedList.d.ts.map +1 -0
  60. package/dist/generated/types/pub/leaflet/blocks/website.d.ts +14 -0
  61. package/dist/generated/types/pub/leaflet/blocks/website.d.ts.map +1 -0
  62. package/dist/generated/types/pub/leaflet/pages/linearDocument.d.ts +54 -1
  63. package/dist/generated/types/pub/leaflet/pages/linearDocument.d.ts.map +1 -1
  64. package/dist/generated/types/pub/leaflet/richtext/facet.d.ts +97 -0
  65. package/dist/generated/types/pub/leaflet/richtext/facet.d.ts.map +1 -0
  66. package/dist/index.cjs +4486 -1807
  67. package/dist/index.cjs.map +1 -1
  68. package/dist/index.mjs +4407 -1804
  69. package/dist/index.mjs.map +1 -1
  70. package/dist/lexicons.cjs +927 -35
  71. package/dist/lexicons.cjs.map +1 -1
  72. package/dist/lexicons.d.ts +2683 -1093
  73. package/dist/lexicons.d.ts.map +1 -1
  74. package/dist/lexicons.mjs +927 -35
  75. package/dist/lexicons.mjs.map +1 -1
  76. package/dist/tests/validate-external-lexicons.test.d.ts +2 -0
  77. package/dist/tests/validate-external-lexicons.test.d.ts.map +1 -0
  78. package/dist/tests/validate-funding-receipt.test.d.ts +2 -0
  79. package/dist/tests/validate-funding-receipt.test.d.ts.map +1 -0
  80. package/dist/tests/validate-link-evm.test.d.ts +2 -0
  81. package/dist/tests/validate-link-evm.test.d.ts.map +1 -0
  82. package/dist/tests/validate-rights.test.d.ts +2 -0
  83. package/dist/tests/validate-rights.test.d.ts.map +1 -0
  84. package/dist/types/app/bsky/richtext/facet.d.ts +44 -7
  85. package/dist/types/app/bsky/richtext/facet.d.ts.map +1 -1
  86. package/dist/types/app/certified/badge/award.d.ts +2 -3
  87. package/dist/types/app/certified/badge/award.d.ts.map +1 -1
  88. package/dist/types/app/certified/badge/definition.d.ts +3 -3
  89. package/dist/types/app/certified/badge/definition.d.ts.map +1 -1
  90. package/dist/types/app/certified/badge/response.d.ts +2 -2
  91. package/dist/types/app/certified/badge/response.d.ts.map +1 -1
  92. package/dist/types/app/certified/link/evm.d.ts +45 -0
  93. package/dist/types/app/certified/link/evm.d.ts.map +1 -0
  94. package/dist/types/org/hypercerts/claim/activity.d.ts +6 -3
  95. package/dist/types/org/hypercerts/claim/activity.d.ts.map +1 -1
  96. package/dist/types/org/hypercerts/collection.d.ts +11 -5
  97. package/dist/types/org/hypercerts/collection.d.ts.map +1 -1
  98. package/dist/types/org/hypercerts/context/attachment.d.ts +5 -3
  99. package/dist/types/org/hypercerts/context/attachment.d.ts.map +1 -1
  100. package/dist/types/org/hypercerts/context/evaluation.d.ts +6 -6
  101. package/dist/types/org/hypercerts/context/evaluation.d.ts.map +1 -1
  102. package/dist/types/org/hypercerts/defs.d.ts +11 -0
  103. package/dist/types/org/hypercerts/defs.d.ts.map +1 -1
  104. package/dist/types/org/hypercerts/funding/receipt.d.ts +17 -5
  105. package/dist/types/org/hypercerts/funding/receipt.d.ts.map +1 -1
  106. package/dist/types/pub/leaflet/blocks/blockquote.d.ts +13 -0
  107. package/dist/types/pub/leaflet/blocks/blockquote.d.ts.map +1 -0
  108. package/dist/types/pub/leaflet/blocks/bskyPost.d.ts +13 -0
  109. package/dist/types/pub/leaflet/blocks/bskyPost.d.ts.map +1 -0
  110. package/dist/types/pub/leaflet/blocks/button.d.ts +12 -0
  111. package/dist/types/pub/leaflet/blocks/button.d.ts.map +1 -0
  112. package/dist/types/pub/leaflet/blocks/code.d.ts +13 -0
  113. package/dist/types/pub/leaflet/blocks/code.d.ts.map +1 -0
  114. package/dist/types/pub/leaflet/blocks/header.d.ts +14 -0
  115. package/dist/types/pub/leaflet/blocks/header.d.ts.map +1 -0
  116. package/dist/types/pub/leaflet/blocks/horizontalRule.d.ts +10 -0
  117. package/dist/types/pub/leaflet/blocks/horizontalRule.d.ts.map +1 -0
  118. package/dist/types/pub/leaflet/blocks/iframe.d.ts +12 -0
  119. package/dist/types/pub/leaflet/blocks/iframe.d.ts.map +1 -0
  120. package/dist/types/pub/leaflet/blocks/image.d.ts +21 -0
  121. package/dist/types/pub/leaflet/blocks/image.d.ts.map +1 -0
  122. package/dist/types/pub/leaflet/blocks/math.d.ts +11 -0
  123. package/dist/types/pub/leaflet/blocks/math.d.ts.map +1 -0
  124. package/dist/types/pub/leaflet/blocks/orderedList.d.ts +31 -0
  125. package/dist/types/pub/leaflet/blocks/orderedList.d.ts.map +1 -0
  126. package/dist/types/pub/leaflet/blocks/page.d.ts +11 -0
  127. package/dist/types/pub/leaflet/blocks/page.d.ts.map +1 -0
  128. package/dist/types/pub/leaflet/blocks/poll.d.ts +12 -0
  129. package/dist/types/pub/leaflet/blocks/poll.d.ts.map +1 -0
  130. package/dist/types/pub/leaflet/blocks/text.d.ts +14 -0
  131. package/dist/types/pub/leaflet/blocks/text.d.ts.map +1 -0
  132. package/dist/types/pub/leaflet/blocks/unorderedList.d.ts +29 -0
  133. package/dist/types/pub/leaflet/blocks/unorderedList.d.ts.map +1 -0
  134. package/dist/types/pub/leaflet/blocks/website.d.ts +14 -0
  135. package/dist/types/pub/leaflet/blocks/website.d.ts.map +1 -0
  136. package/dist/types/pub/leaflet/pages/linearDocument.d.ts +54 -1
  137. package/dist/types/pub/leaflet/pages/linearDocument.d.ts.map +1 -1
  138. package/dist/types/pub/leaflet/richtext/facet.d.ts +97 -0
  139. package/dist/types/pub/leaflet/richtext/facet.d.ts.map +1 -0
  140. package/lexicons/app/bsky/richtext/facet.json +51 -0
  141. package/lexicons/app/certified/badge/award.json +2 -2
  142. package/lexicons/app/certified/badge/definition.json +10 -2
  143. package/lexicons/app/certified/badge/response.json +2 -2
  144. package/lexicons/app/certified/link/evm.json +88 -0
  145. package/lexicons/org/hypercerts/claim/activity.json +8 -4
  146. package/lexicons/org/hypercerts/collection.json +19 -5
  147. package/lexicons/org/hypercerts/context/attachment.json +16 -5
  148. package/lexicons/org/hypercerts/context/evaluation.json +9 -6
  149. package/lexicons/org/hypercerts/defs.json +21 -0
  150. package/lexicons/org/hypercerts/funding/receipt.json +30 -10
  151. package/lexicons/pub/leaflet/blocks/blockquote.json +22 -0
  152. package/lexicons/pub/leaflet/blocks/bskyPost.json +19 -0
  153. package/lexicons/pub/leaflet/blocks/button.json +19 -0
  154. package/lexicons/pub/leaflet/blocks/code.json +21 -0
  155. package/lexicons/pub/leaflet/blocks/header.json +27 -0
  156. package/lexicons/pub/leaflet/blocks/horizontalRule.json +11 -0
  157. package/lexicons/pub/leaflet/blocks/iframe.json +21 -0
  158. package/lexicons/pub/leaflet/blocks/image.json +37 -0
  159. package/lexicons/pub/leaflet/blocks/math.json +15 -0
  160. package/lexicons/pub/leaflet/blocks/orderedList.json +54 -0
  161. package/lexicons/pub/leaflet/blocks/page.json +15 -0
  162. package/lexicons/pub/leaflet/blocks/poll.json +16 -0
  163. package/lexicons/pub/leaflet/blocks/text.json +26 -0
  164. package/lexicons/pub/leaflet/blocks/unorderedList.json +50 -0
  165. package/lexicons/pub/leaflet/blocks/website.json +27 -0
  166. package/lexicons/pub/leaflet/pages/linearDocument.json +98 -0
  167. package/lexicons/pub/leaflet/richtext/facet.json +149 -0
  168. package/package.json +3 -4
@@ -0,0 +1,98 @@
1
+ {
2
+ "lexicon": 1,
3
+ "id": "pub.leaflet.pages.linearDocument",
4
+ "defs": {
5
+ "main": {
6
+ "type": "object",
7
+ "required": ["blocks"],
8
+ "properties": {
9
+ "id": {
10
+ "type": "string"
11
+ },
12
+ "blocks": {
13
+ "type": "array",
14
+ "items": {
15
+ "type": "ref",
16
+ "ref": "#block"
17
+ }
18
+ }
19
+ }
20
+ },
21
+ "block": {
22
+ "type": "object",
23
+ "required": ["block"],
24
+ "properties": {
25
+ "block": {
26
+ "type": "union",
27
+ "refs": [
28
+ "pub.leaflet.blocks.iframe",
29
+ "pub.leaflet.blocks.text",
30
+ "pub.leaflet.blocks.blockquote",
31
+ "pub.leaflet.blocks.header",
32
+ "pub.leaflet.blocks.image",
33
+ "pub.leaflet.blocks.unorderedList",
34
+ "pub.leaflet.blocks.orderedList",
35
+ "pub.leaflet.blocks.website",
36
+ "pub.leaflet.blocks.math",
37
+ "pub.leaflet.blocks.code",
38
+ "pub.leaflet.blocks.horizontalRule",
39
+ "pub.leaflet.blocks.bskyPost",
40
+ "pub.leaflet.blocks.page",
41
+ "pub.leaflet.blocks.poll",
42
+ "pub.leaflet.blocks.button"
43
+ ]
44
+ },
45
+ "alignment": {
46
+ "type": "string",
47
+ "knownValues": [
48
+ "#textAlignLeft",
49
+ "#textAlignCenter",
50
+ "#textAlignRight",
51
+ "#textAlignJustify"
52
+ ]
53
+ }
54
+ }
55
+ },
56
+ "textAlignLeft": {
57
+ "type": "token"
58
+ },
59
+ "textAlignCenter": {
60
+ "type": "token"
61
+ },
62
+ "textAlignRight": {
63
+ "type": "token"
64
+ },
65
+ "textAlignJustify": {
66
+ "type": "token"
67
+ },
68
+ "quote": {
69
+ "type": "object",
70
+ "required": ["start", "end"],
71
+ "properties": {
72
+ "start": {
73
+ "type": "ref",
74
+ "ref": "#position"
75
+ },
76
+ "end": {
77
+ "type": "ref",
78
+ "ref": "#position"
79
+ }
80
+ }
81
+ },
82
+ "position": {
83
+ "type": "object",
84
+ "required": ["block", "offset"],
85
+ "properties": {
86
+ "block": {
87
+ "type": "array",
88
+ "items": {
89
+ "type": "integer"
90
+ }
91
+ },
92
+ "offset": {
93
+ "type": "integer"
94
+ }
95
+ }
96
+ }
97
+ }
98
+ }
@@ -0,0 +1,149 @@
1
+ {
2
+ "lexicon": 1,
3
+ "id": "pub.leaflet.richtext.facet",
4
+ "defs": {
5
+ "main": {
6
+ "type": "object",
7
+ "description": "Annotation of a sub-string within rich text.",
8
+ "required": ["index", "features"],
9
+ "properties": {
10
+ "index": {
11
+ "type": "ref",
12
+ "ref": "#byteSlice"
13
+ },
14
+ "features": {
15
+ "type": "array",
16
+ "items": {
17
+ "type": "union",
18
+ "refs": [
19
+ "#link",
20
+ "#didMention",
21
+ "#atMention",
22
+ "#code",
23
+ "#highlight",
24
+ "#underline",
25
+ "#strikethrough",
26
+ "#id",
27
+ "#bold",
28
+ "#italic",
29
+ "#footnote"
30
+ ]
31
+ }
32
+ }
33
+ }
34
+ },
35
+ "byteSlice": {
36
+ "type": "object",
37
+ "description": "Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets.",
38
+ "required": ["byteStart", "byteEnd"],
39
+ "properties": {
40
+ "byteStart": {
41
+ "type": "integer",
42
+ "minimum": 0
43
+ },
44
+ "byteEnd": {
45
+ "type": "integer",
46
+ "minimum": 0
47
+ }
48
+ }
49
+ },
50
+ "link": {
51
+ "type": "object",
52
+ "description": "Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.",
53
+ "required": ["uri"],
54
+ "properties": {
55
+ "uri": {
56
+ "type": "string"
57
+ }
58
+ }
59
+ },
60
+ "didMention": {
61
+ "type": "object",
62
+ "description": "Facet feature for mentioning a did.",
63
+ "required": ["did"],
64
+ "properties": {
65
+ "did": {
66
+ "type": "string",
67
+ "format": "did"
68
+ }
69
+ }
70
+ },
71
+ "atMention": {
72
+ "type": "object",
73
+ "description": "Facet feature for mentioning an AT URI.",
74
+ "required": ["atURI"],
75
+ "properties": {
76
+ "atURI": {
77
+ "type": "string",
78
+ "format": "uri"
79
+ }
80
+ }
81
+ },
82
+ "code": {
83
+ "type": "object",
84
+ "description": "Facet feature for inline code.",
85
+ "required": [],
86
+ "properties": {}
87
+ },
88
+ "highlight": {
89
+ "type": "object",
90
+ "description": "Facet feature for highlighted text.",
91
+ "required": [],
92
+ "properties": {}
93
+ },
94
+ "underline": {
95
+ "type": "object",
96
+ "description": "Facet feature for underline markup",
97
+ "required": [],
98
+ "properties": {}
99
+ },
100
+ "strikethrough": {
101
+ "type": "object",
102
+ "description": "Facet feature for strikethrough markup",
103
+ "required": [],
104
+ "properties": {}
105
+ },
106
+ "id": {
107
+ "type": "object",
108
+ "description": "Facet feature for an identifier. Used for linking to a segment",
109
+ "required": [],
110
+ "properties": {
111
+ "id": {
112
+ "type": "string"
113
+ }
114
+ }
115
+ },
116
+ "bold": {
117
+ "type": "object",
118
+ "description": "Facet feature for bold text",
119
+ "required": [],
120
+ "properties": {}
121
+ },
122
+ "italic": {
123
+ "type": "object",
124
+ "description": "Facet feature for italic text",
125
+ "required": [],
126
+ "properties": {}
127
+ },
128
+ "footnote": {
129
+ "type": "object",
130
+ "description": "Facet feature for a footnote reference",
131
+ "required": ["footnoteId", "contentPlaintext"],
132
+ "properties": {
133
+ "footnoteId": {
134
+ "type": "string"
135
+ },
136
+ "contentPlaintext": {
137
+ "type": "string"
138
+ },
139
+ "contentFacets": {
140
+ "type": "array",
141
+ "items": {
142
+ "type": "ref",
143
+ "ref": "#main"
144
+ }
145
+ }
146
+ }
147
+ }
148
+ }
149
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hypercerts-org/lexicon",
3
- "version": "0.10.0",
3
+ "version": "0.11.0",
4
4
  "description": "ATProto lexicon definitions and TypeScript types for the Hypercerts protocol",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -42,7 +42,7 @@
42
42
  "check": "npm run gen-api && npm run lint && npm run typecheck && npm run build && npm run test",
43
43
  "build": "rollup -c && npm run build:types",
44
44
  "build:types": "tsc --project tsconfig.build.json",
45
- "gen-api": "find ./lexicons -name '*.json' | xargs lex gen-api --yes ./generated && ./scripts/create-shims.sh && npm run gen-index",
45
+ "gen-api": "find ./lexicons -name '*.json' | xargs lex gen-api --yes ./generated && npm run gen-index",
46
46
  "gen-md": "find ./lexicons -name '*.json' | xargs lex gen-md --yes ./lexicons.md",
47
47
  "gen-schemas-md": "node ./scripts/generate-schemas.js",
48
48
  "//gen-ts": "UNUSED - use gen-api instead",
@@ -65,8 +65,6 @@
65
65
  "prepare": "husky && ./scripts/setup-merge-driver.sh"
66
66
  },
67
67
  "dependencies": {
68
- "@atcute/bluesky": "^3.2.15",
69
- "@atcute/leaflet": "^1.0.15",
70
68
  "@atproto/lexicon": "^0.6.0",
71
69
  "multiformats": "^13.3.6"
72
70
  },
@@ -89,6 +87,7 @@
89
87
  "tslib": "^2.8.1",
90
88
  "typescript": "^5.7.2",
91
89
  "typescript-eslint": "^8.51.0",
90
+ "viem": "^2.46.3",
92
91
  "vitest": "^4.0.16"
93
92
  },
94
93
  "peerDependencies": {