@cardanvil/frame-kit 0.2.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 (69) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +137 -0
  3. package/dist/authoring/index.d.ts +2 -0
  4. package/dist/authoring/index.js +2 -0
  5. package/dist/authoring/layoutDefaults.d.ts +6 -0
  6. package/dist/authoring/layoutDefaults.js +80 -0
  7. package/dist/authoring/omit.d.ts +2 -0
  8. package/dist/authoring/omit.js +14 -0
  9. package/dist/cli/api.d.ts +34 -0
  10. package/dist/cli/api.js +188 -0
  11. package/dist/cli/build.d.ts +36 -0
  12. package/dist/cli/build.js +222 -0
  13. package/dist/cli/bundle.d.ts +23 -0
  14. package/dist/cli/bundle.js +58 -0
  15. package/dist/cli/devUrl.d.ts +10 -0
  16. package/dist/cli/devUrl.js +41 -0
  17. package/dist/cli/discover.d.ts +25 -0
  18. package/dist/cli/discover.js +116 -0
  19. package/dist/cli/emitSchemas.d.ts +2 -0
  20. package/dist/cli/emitSchemas.js +13 -0
  21. package/dist/cli/errors.d.ts +8 -0
  22. package/dist/cli/errors.js +11 -0
  23. package/dist/cli/frameIndex.d.ts +115 -0
  24. package/dist/cli/frameIndex.js +104 -0
  25. package/dist/cli/hash.d.ts +14 -0
  26. package/dist/cli/hash.js +32 -0
  27. package/dist/cli/imageSize.d.ts +13 -0
  28. package/dist/cli/imageSize.js +72 -0
  29. package/dist/cli/index.d.ts +18 -0
  30. package/dist/cli/index.js +18 -0
  31. package/dist/cli/loadFrame.d.ts +24 -0
  32. package/dist/cli/loadFrame.js +90 -0
  33. package/dist/cli/main.d.ts +2 -0
  34. package/dist/cli/main.js +228 -0
  35. package/dist/cli/report.d.ts +35 -0
  36. package/dist/cli/report.js +74 -0
  37. package/dist/cli/schema.d.ts +33 -0
  38. package/dist/cli/schema.js +51 -0
  39. package/dist/cli/stableJson.d.ts +11 -0
  40. package/dist/cli/stableJson.js +27 -0
  41. package/dist/index.d.ts +2 -0
  42. package/dist/index.js +2 -0
  43. package/dist/manifest/contract.d.ts +10503 -0
  44. package/dist/manifest/contract.js +87 -0
  45. package/dist/manifest/deserialize.d.ts +19 -0
  46. package/dist/manifest/deserialize.js +23 -0
  47. package/dist/manifest/index.d.ts +4 -0
  48. package/dist/manifest/index.js +4 -0
  49. package/dist/manifest/serialize.d.ts +35 -0
  50. package/dist/manifest/serialize.js +44 -0
  51. package/dist/manifest/testFrame.d.ts +9 -0
  52. package/dist/manifest/testFrame.js +53 -0
  53. package/dist/manifest/walk.d.ts +21 -0
  54. package/dist/manifest/walk.js +111 -0
  55. package/dist/schema/assetUrl.d.ts +27 -0
  56. package/dist/schema/assetUrl.js +28 -0
  57. package/dist/schema/frame.d.ts +26467 -0
  58. package/dist/schema/frame.js +312 -0
  59. package/dist/schema/frameAssets.d.ts +539 -0
  60. package/dist/schema/frameAssets.js +183 -0
  61. package/dist/schema/frameMeta.d.ts +24 -0
  62. package/dist/schema/frameMeta.js +48 -0
  63. package/dist/schema/index.d.ts +5 -0
  64. package/dist/schema/index.js +5 -0
  65. package/dist/schema/layout.d.ts +101 -0
  66. package/dist/schema/layout.js +59 -0
  67. package/package.json +62 -0
  68. package/schema/frame-index.schema.json +233 -0
  69. package/schema/frame-meta.schema.json +54 -0
package/schema/frame-index.schema.json ADDED
@@ -0,0 +1,233 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "properties": {
4
+ "app": {
5
+ "const": "card-anvil",
6
+ "type": "string"
7
+ },
8
+ "contractVersion": {
9
+ "type": "string"
10
+ },
11
+ "formatVersion": {
12
+ "exclusiveMinimum": 0,
13
+ "maximum": 9007199254740991,
14
+ "type": "integer"
15
+ },
16
+ "frames": {
17
+ "items": {
18
+ "properties": {
19
+ "assetCount": {
20
+ "maximum": 9007199254740991,
21
+ "minimum": 0,
22
+ "type": "integer"
23
+ },
24
+ "author": {
25
+ "properties": {
26
+ "name": {
27
+ "type": "string"
28
+ },
29
+ "url": {
30
+ "type": "string"
31
+ }
32
+ },
33
+ "required": [
34
+ "name"
35
+ ],
36
+ "type": "object"
37
+ },
38
+ "bundle": {
39
+ "properties": {
40
+ "bytes": {
41
+ "maximum": 9007199254740991,
42
+ "minimum": 0,
43
+ "type": "integer"
44
+ },
45
+ "file": {
46
+ "type": "string"
47
+ },
48
+ "sha256": {
49
+ "type": "string"
50
+ },
51
+ "url": {
52
+ "format": "uri",
53
+ "type": "string"
54
+ }
55
+ },
56
+ "required": [
57
+ "file",
58
+ "bytes",
59
+ "sha256"
60
+ ],
61
+ "type": "object"
62
+ },
63
+ "canvas": {
64
+ "properties": {
65
+ "height": {
66
+ "maximum": 9007199254740991,
67
+ "minimum": -9007199254740991,
68
+ "type": "integer"
69
+ },
70
+ "width": {
71
+ "maximum": 9007199254740991,
72
+ "minimum": -9007199254740991,
73
+ "type": "integer"
74
+ }
75
+ },
76
+ "required": [
77
+ "width",
78
+ "height"
79
+ ],
80
+ "type": "object"
81
+ },
82
+ "contractVersion": {
83
+ "type": "string"
84
+ },
85
+ "description": {
86
+ "type": "string"
87
+ },
88
+ "homepage": {
89
+ "type": "string"
90
+ },
91
+ "id": {
92
+ "type": "string"
93
+ },
94
+ "layouts": {
95
+ "items": {
96
+ "type": "string"
97
+ },
98
+ "type": "array"
99
+ },
100
+ "license": {
101
+ "type": "string"
102
+ },
103
+ "name": {
104
+ "type": "string"
105
+ },
106
+ "preview": {
107
+ "properties": {
108
+ "bytes": {
109
+ "maximum": 9007199254740991,
110
+ "minimum": 0,
111
+ "type": "integer"
112
+ },
113
+ "file": {
114
+ "type": "string"
115
+ },
116
+ "height": {
117
+ "exclusiveMinimum": 0,
118
+ "maximum": 9007199254740991,
119
+ "type": "integer"
120
+ },
121
+ "sha256": {
122
+ "type": "string"
123
+ },
124
+ "url": {
125
+ "format": "uri",
126
+ "type": "string"
127
+ },
128
+ "width": {
129
+ "exclusiveMinimum": 0,
130
+ "maximum": 9007199254740991,
131
+ "type": "integer"
132
+ }
133
+ },
134
+ "required": [
135
+ "file",
136
+ "bytes",
137
+ "sha256"
138
+ ],
139
+ "type": "object"
140
+ },
141
+ "slug": {
142
+ "type": "string"
143
+ },
144
+ "tags": {
145
+ "items": {
146
+ "type": "string"
147
+ },
148
+ "type": "array"
149
+ },
150
+ "version": {
151
+ "type": "string"
152
+ }
153
+ },
154
+ "required": [
155
+ "id",
156
+ "slug",
157
+ "name",
158
+ "description",
159
+ "version",
160
+ "tags",
161
+ "layouts",
162
+ "canvas",
163
+ "author",
164
+ "license",
165
+ "contractVersion",
166
+ "assetCount",
167
+ "bundle",
168
+ "preview"
169
+ ],
170
+ "type": "object"
171
+ },
172
+ "type": "array"
173
+ },
174
+ "generatedAt": {
175
+ "type": "string"
176
+ },
177
+ "generator": {
178
+ "type": "string"
179
+ },
180
+ "kind": {
181
+ "const": "frame-index",
182
+ "type": "string"
183
+ },
184
+ "source": {
185
+ "properties": {
186
+ "downloadBase": {
187
+ "format": "uri",
188
+ "type": "string"
189
+ },
190
+ "kind": {
191
+ "const": "github-release",
192
+ "type": "string"
193
+ },
194
+ "latestIndexUrl": {
195
+ "format": "uri",
196
+ "type": "string"
197
+ },
198
+ "repository": {
199
+ "type": "string"
200
+ },
201
+ "tag": {
202
+ "type": "string"
203
+ },
204
+ "url": {
205
+ "format": "uri",
206
+ "type": "string"
207
+ }
208
+ },
209
+ "required": [
210
+ "kind",
211
+ "repository",
212
+ "tag",
213
+ "url",
214
+ "downloadBase",
215
+ "latestIndexUrl"
216
+ ],
217
+ "type": "object"
218
+ },
219
+ "version": {
220
+ "type": "string"
221
+ }
222
+ },
223
+ "required": [
224
+ "app",
225
+ "kind",
226
+ "formatVersion",
227
+ "generatedAt",
228
+ "contractVersion",
229
+ "version",
230
+ "frames"
231
+ ],
232
+ "type": "object"
233
+ }
package/schema/frame-meta.schema.json ADDED
@@ -0,0 +1,54 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "properties": {
4
+ "$schema": {
5
+ "type": "string"
6
+ },
7
+ "author": {
8
+ "properties": {
9
+ "name": {
10
+ "minLength": 1,
11
+ "type": "string"
12
+ },
13
+ "url": {
14
+ "format": "uri",
15
+ "type": "string"
16
+ }
17
+ },
18
+ "required": [
19
+ "name"
20
+ ],
21
+ "type": "object"
22
+ },
23
+ "entry": {
24
+ "default": "./index.ts",
25
+ "type": "string"
26
+ },
27
+ "export": {
28
+ "default": "default",
29
+ "type": "string"
30
+ },
31
+ "homepage": {
32
+ "format": "uri",
33
+ "type": "string"
34
+ },
35
+ "id": {
36
+ "pattern": "^[a-z0-9]+(\\.[a-z0-9-]+)+$",
37
+ "type": "string"
38
+ },
39
+ "license": {
40
+ "minLength": 1,
41
+ "type": "string"
42
+ },
43
+ "slug": {
44
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$",
45
+ "type": "string"
46
+ }
47
+ },
48
+ "required": [
49
+ "id",
50
+ "author",
51
+ "license"
52
+ ],
53
+ "type": "object"
54
+ }