@atom.io/spa 0.0.1 → 0.0.2

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 (112) hide show
  1. package/README.md +201 -6
  2. package/README.mdx +62 -1
  3. package/dist/astro-application.d.ts +1 -1
  4. package/dist/astro-client.d.ts +1 -1
  5. package/dist/astro-client.js +6 -3
  6. package/dist/astro-client.js.map +1 -1
  7. package/dist/astro-server.js +2 -1
  8. package/dist/astro-server.js.map +1 -1
  9. package/dist/astro-shared-BT45auwR.js.map +1 -1
  10. package/dist/{astro-shared-DkZaqX7L.d.ts → astro-shared-DyzbUi6c.d.ts} +4 -2
  11. package/dist/astro-shared-DyzbUi6c.d.ts.map +1 -0
  12. package/dist/astro.d.ts +1 -1
  13. package/dist/astro.js +1 -1
  14. package/dist/{core-Dvqm7w2y.js → capabilities-BuZUQpiD.js} +64 -2
  15. package/dist/capabilities-BuZUQpiD.js.map +1 -0
  16. package/dist/{core-BhiA9fFi.d.ts → capabilities-yC9TsHDI.d.ts} +20 -2
  17. package/dist/capabilities-yC9TsHDI.d.ts.map +1 -0
  18. package/dist/client.min.js +1 -1
  19. package/dist/development/astro-client.js +6 -3
  20. package/dist/development/astro-client.js.map +1 -1
  21. package/dist/development/astro-server.js +2 -1
  22. package/dist/development/astro-server.js.map +1 -1
  23. package/dist/development/astro-shared-BT45auwR.js.map +1 -1
  24. package/dist/development/astro.js +1 -1
  25. package/dist/development/{core-DB3sQz4h.js → capabilities-DhOJmeoJ.js} +64 -2
  26. package/dist/development/capabilities-DhOJmeoJ.js.map +1 -0
  27. package/dist/development/{dom-D9cY6l1R.js → dom-BKc6V_Kz.js} +8 -3
  28. package/dist/development/dom-BKc6V_Kz.js.map +1 -0
  29. package/dist/development/index.js +3 -38
  30. package/dist/development/jsx-runtime.js.map +1 -1
  31. package/dist/development/konva.js +121 -0
  32. package/dist/development/konva.js.map +1 -0
  33. package/dist/development/motion.js +217 -0
  34. package/dist/development/motion.js.map +1 -0
  35. package/dist/development/renderer.js +177 -0
  36. package/dist/development/renderer.js.map +1 -0
  37. package/dist/development/server.js +3 -2
  38. package/dist/development/server.js.map +1 -1
  39. package/dist/development/src-Dh-d6w4y.js +38 -0
  40. package/dist/development/src-Dh-d6w4y.js.map +1 -0
  41. package/dist/development/three.js +438 -0
  42. package/dist/development/three.js.map +1 -0
  43. package/dist/development/vite-CSHoxzXU.js +240 -0
  44. package/dist/development/vite-CSHoxzXU.js.map +1 -0
  45. package/dist/development/vite.js +1 -1
  46. package/dist/{dom-BR9o9wZW.js → dom-B2rm8o2L.js} +8 -3
  47. package/dist/dom-B2rm8o2L.js.map +1 -0
  48. package/dist/index-BdwxmSKg.d.ts +24 -0
  49. package/dist/index-BdwxmSKg.d.ts.map +1 -0
  50. package/dist/index.d.ts +4 -24
  51. package/dist/index.js +3 -38
  52. package/dist/{jsx-runtime-BzGV18VO.d.ts → jsx-runtime-CZU7F8Qz.d.ts} +6 -4
  53. package/dist/jsx-runtime-CZU7F8Qz.d.ts.map +1 -0
  54. package/dist/jsx-runtime.d.ts +2 -2
  55. package/dist/jsx-runtime.js.map +1 -1
  56. package/dist/konva.d.ts +32 -0
  57. package/dist/konva.d.ts.map +1 -0
  58. package/dist/konva.js +121 -0
  59. package/dist/konva.js.map +1 -0
  60. package/dist/motion.d.ts +44 -0
  61. package/dist/motion.d.ts.map +1 -0
  62. package/dist/motion.js +217 -0
  63. package/dist/motion.js.map +1 -0
  64. package/dist/renderer.d.ts +24 -0
  65. package/dist/renderer.d.ts.map +1 -0
  66. package/dist/renderer.js +177 -0
  67. package/dist/renderer.js.map +1 -0
  68. package/dist/server.d.ts +1 -1
  69. package/dist/server.d.ts.map +1 -1
  70. package/dist/server.js +3 -2
  71. package/dist/server.js.map +1 -1
  72. package/dist/size.json +16 -16
  73. package/dist/src-BZxX4xbU.js +38 -0
  74. package/dist/src-BZxX4xbU.js.map +1 -0
  75. package/dist/three.d.ts +110 -0
  76. package/dist/three.d.ts.map +1 -0
  77. package/dist/three.js +438 -0
  78. package/dist/three.js.map +1 -0
  79. package/dist/vite-CSHoxzXU.js +240 -0
  80. package/dist/vite-CSHoxzXU.js.map +1 -0
  81. package/dist/vite.js +1 -1
  82. package/package.json +56 -11
  83. package/src/astro-client.ts +1 -0
  84. package/src/astro-server.ts +1 -0
  85. package/src/astro-shared.ts +3 -0
  86. package/src/capabilities.ts +88 -0
  87. package/src/compiler.ts +251 -178
  88. package/src/core.ts +11 -0
  89. package/src/dom.ts +4 -1
  90. package/src/index.ts +5 -0
  91. package/src/jsx-runtime.ts +4 -0
  92. package/src/jsx-types.d.ts +3 -1
  93. package/src/konva.ts +159 -0
  94. package/src/motion.ts +406 -0
  95. package/src/renderer.ts +241 -0
  96. package/src/server.ts +3 -0
  97. package/src/three-events.ts +330 -0
  98. package/src/three.ts +350 -0
  99. package/dist/astro-shared-DkZaqX7L.d.ts.map +0 -1
  100. package/dist/core-BhiA9fFi.d.ts.map +0 -1
  101. package/dist/core-Dvqm7w2y.js.map +0 -1
  102. package/dist/development/core-DB3sQz4h.js.map +0 -1
  103. package/dist/development/dom-D9cY6l1R.js.map +0 -1
  104. package/dist/development/index.js.map +0 -1
  105. package/dist/development/vite-CQchIQ_-.js +0 -126
  106. package/dist/development/vite-CQchIQ_-.js.map +0 -1
  107. package/dist/dom-BR9o9wZW.js.map +0 -1
  108. package/dist/index.d.ts.map +0 -1
  109. package/dist/index.js.map +0 -1
  110. package/dist/jsx-runtime-BzGV18VO.d.ts.map +0 -1
  111. package/dist/vite-CQchIQ_-.js +0 -126
  112. package/dist/vite-CQchIQ_-.js.map +0 -1
package/src/compiler.ts CHANGED
@@ -1,190 +1,263 @@
1
- import type { PluginObject } from "@babel/core"
2
- import { transformSync, types as t } from "@babel/core"
1
+ import { decode } from "html-entities"
2
+ import type { SourceMap } from "magic-string"
3
+ import MagicString from "magic-string"
4
+ import type {
5
+ Expression,
6
+ JSXElement,
7
+ JSXElementName,
8
+ JSXFragment,
9
+ Node,
10
+ } from "oxc-parser"
11
+ import { parseSync, visitorKeys } from "oxc-parser"
12
+
13
+ type Part = string | Node
14
+
15
+ const decodeJsx = (value: string): string =>
16
+ decode(value, { level: `html4`, scope: `strict` })
17
+
18
+ /** Match JSX's multiline whitespace rules without reprinting JavaScript. */
19
+ function text(value: string): string {
20
+ const lines = value.split(/\r\n|\n|\r/)
21
+ let last = 0
22
+ for (let i = 0; i < lines.length; i++) if (/[^ \t]/.test(lines[i])) last = i
23
+ return lines
24
+ .map((line, i) => {
25
+ line = line.replace(/\t/g, ` `)
26
+ if (i > 0) line = line.replace(/^ +/, ``)
27
+ if (i < lines.length - 1) line = line.replace(/ +$/, ``)
28
+ return line && i < last ? `${line} ` : line
29
+ })
30
+ .join(``)
31
+ }
32
+
33
+ function eager(node: Node, allowJsx = false): boolean {
34
+ if (node.type === `ParenthesizedExpression`)
35
+ return eager(node.expression, allowJsx)
36
+ return (
37
+ node.type === `Literal` ||
38
+ node.type === `FunctionExpression` ||
39
+ node.type === `ArrowFunctionExpression` ||
40
+ (allowJsx && (node.type === `JSXElement` || node.type === `JSXFragment`)) ||
41
+ (node.type === `TemplateLiteral` && node.expressions.length === 0)
42
+ )
43
+ }
3
44
 
4
45
  export function compile(
5
46
  code: string,
6
47
  filename: string,
7
- ): { code: string; map: any } {
8
- const plugin = (): PluginObject => {
9
- let create: t.Identifier
10
- let merge: t.Identifier
11
- const generated = new WeakSet<object>()
12
- const components = new Set<string>()
13
- function name(
14
- node: t.JSXIdentifier | t.JSXMemberExpression | t.JSXNamespacedName,
15
- ): t.Expression {
16
- if (t.isJSXMemberExpression(node))
17
- return t.memberExpression(
18
- t.isJSXIdentifier(node.object)
19
- ? node.object.name === `this`
20
- ? t.thisExpression()
21
- : t.identifier(node.object.name)
22
- : name(node.object),
23
- t.identifier(node.property.name),
48
+ ): { code: string; map: SourceMap } {
49
+ const parsed = parseSync(filename, code, {
50
+ lang: `tsx`,
51
+ preserveParens: true,
52
+ })
53
+ if (parsed.errors.length) {
54
+ const error = parsed.errors[0]
55
+ throw new SyntaxError(
56
+ [`${filename}: ${error.message}`, error.codeframe]
57
+ .filter(Boolean)
58
+ .join(`\n`),
59
+ )
60
+ }
61
+ const output = new MagicString(code)
62
+ const parents = new WeakMap<Node, Node>()
63
+ const identifiers = new Set<string>()
64
+ const elements: (JSXElement | JSXFragment)[] = []
65
+ const functions = new Set<Node>()
66
+ function walk(node: Node, parent?: Node, outerFunction?: Node): void {
67
+ if (parent) parents.set(node, parent)
68
+ output.addSourcemapLocation(node.start)
69
+ output.addSourcemapLocation(node.end)
70
+ if (node.type === `Identifier` || node.type === `JSXIdentifier`)
71
+ identifiers.add(node.name)
72
+ if (
73
+ !outerFunction &&
74
+ (node.type === `FunctionDeclaration` ||
75
+ node.type === `FunctionExpression` ||
76
+ node.type === `ArrowFunctionExpression`)
77
+ )
78
+ outerFunction = node
79
+ if (node.type === `JSXElement` || node.type === `JSXFragment`) {
80
+ elements.push(node)
81
+ if (outerFunction) functions.add(outerFunction)
82
+ }
83
+ for (const key of visitorKeys[node.type]) {
84
+ const value = (node as unknown as Record<string, unknown>)[key]
85
+ if (Array.isArray(value)) {
86
+ for (const child of value) if (child) walk(child, node, outerFunction)
87
+ } else if (value) walk(value as Node, node, outerFunction)
88
+ }
89
+ }
90
+ walk(parsed.program)
91
+ function uid(base: string): string {
92
+ let name = `_${base}`
93
+ let suffix = 1
94
+ while (identifiers.has(name)) name = `_${base}${++suffix}`
95
+ identifiers.add(name)
96
+ return name
97
+ }
98
+ const create = uid(`spa`)
99
+ const merge = uid(`props`)
100
+ const join = (parts: Part[][], separator: string): Part[] =>
101
+ parts.flatMap((part, i) => (i ? [separator, ...part] : part))
102
+ const expression = (node: Expression): Part[] =>
103
+ eager(node, true) ? [`(`, node, `)`] : [`() => (`, node, `)`]
104
+ function tag(node: JSXElementName): string {
105
+ if (node.type === `JSXNamespacedName`)
106
+ return JSON.stringify(`${node.namespace.name}:${node.name.name}`)
107
+ if (node.type === `JSXMemberExpression`)
108
+ return code.slice(node.start, node.end)
109
+ return /^[a-z]/.test(node.name) || node.name.includes(`-`)
110
+ ? JSON.stringify(node.name)
111
+ : node.name
112
+ }
113
+ /** Rewrite syntax around untouched expression spans, including nested JSX. */
114
+ function rewrite(node: JSXElement | JSXFragment, parts: Part[]): void {
115
+ let cursor = node.start
116
+ let replacement = ``
117
+ for (const part of parts) {
118
+ if (typeof part === `string`) {
119
+ replacement += part
120
+ continue
121
+ }
122
+ if (cursor < part.start) output.update(cursor, part.start, replacement)
123
+ else output.appendLeft(cursor, replacement)
124
+ cursor = part.end
125
+ replacement = ``
126
+ }
127
+ // Every JSX node ends with closing syntax after its last expression span.
128
+ output.update(cursor, node.end, replacement)
129
+ }
130
+ for (const node of elements) {
131
+ const chunks: Part[][] = []
132
+ let properties: Part[][] = []
133
+ const flush = () => {
134
+ if (properties.length) chunks.push([`{`, ...join(properties, `, `), `}`])
135
+ properties = []
136
+ }
137
+ if (node.type === `JSXElement`) {
138
+ for (const attribute of node.openingElement.attributes) {
139
+ if (attribute.type === `JSXSpreadAttribute`) {
140
+ flush()
141
+ chunks.push([`() => (`, attribute.argument, `)`])
142
+ continue
143
+ }
144
+ const key = JSON.stringify(
145
+ attribute.name.type === `JSXNamespacedName`
146
+ ? `${attribute.name.namespace.name}:${attribute.name.name.name}`
147
+ : attribute.name.name,
24
148
  )
25
- if (t.isJSXNamespacedName(node))
26
- return t.stringLiteral(`${node.namespace.name}:${node.name.name}`)
27
- return /^[a-z]/.test(node.name) || node.name.includes(`-`)
28
- ? t.stringLiteral(node.name)
29
- : t.identifier(node.name)
149
+ const value = attribute.value
150
+ if (!value) properties.push([`${key}: true`])
151
+ else if (value.type === `Literal`)
152
+ properties.push([`${key}: ${JSON.stringify(decodeJsx(value.value))}`])
153
+ else {
154
+ const expr =
155
+ value.type === `JSXExpressionContainer` ? value.expression : value
156
+ properties.push(
157
+ key === `"key"` || eager(expr)
158
+ ? [`${key}: (`, expr, `)`]
159
+ : [`get ${key}(){ return (`, expr, `); }`],
160
+ )
161
+ }
162
+ }
30
163
  }
31
- function literal(node: t.Node): boolean {
32
- return (
33
- t.isLiteral(node) &&
34
- (!t.isTemplateLiteral(node) || node.expressions.length === 0)
164
+ const children: Part[][] = []
165
+ for (const child of node.children) {
166
+ if (child.type === `JSXText`) {
167
+ const value = text(decodeJsx(child.value))
168
+ if (value) children.push([JSON.stringify(value)])
169
+ } else if (child.type === `JSXElement` || child.type === `JSXFragment`)
170
+ children.push([child])
171
+ else if (child.type === `JSXExpressionContainer`) {
172
+ if (child.expression.type !== `JSXEmptyExpression`)
173
+ children.push(expression(child.expression))
174
+ } else
175
+ throw new SyntaxError(`${filename}: JSX spread children are unsupported`)
176
+ }
177
+ if (children.length)
178
+ properties.push([
179
+ `children: `,
180
+ ...(children.length === 1
181
+ ? children[0]
182
+ : [`[`, ...join(children, `, `), `]`]),
183
+ ])
184
+ flush()
185
+ const spreads =
186
+ node.type === `JSXElement` &&
187
+ node.openingElement.attributes.some(
188
+ (attr) => attr.type === `JSXSpreadAttribute`,
35
189
  )
190
+ const props = spreads
191
+ ? [`${merge}(`, ...join(chunks, `, `), `)`]
192
+ : (chunks[0] ?? [`{}`])
193
+ rewrite(node, [
194
+ `${create}(${node.type === `JSXElement` ? tag(node.openingElement.name) : `null`}, `,
195
+ ...props,
196
+ `)`,
197
+ ])
198
+ }
199
+ const components = new Set<string>()
200
+ for (const fn of functions) {
201
+ let node = fn
202
+ let parent = parents.get(node)
203
+ while (parent?.type === `ParenthesizedExpression`) {
204
+ node = parent
205
+ parent = parents.get(node)
36
206
  }
37
- function child(node: t.Expression): t.Expression {
38
- return generated.has(node) || literal(node) || t.isFunction(node)
39
- ? node
40
- : t.arrowFunctionExpression([], node)
207
+ if (fn.type === `FunctionDeclaration` && fn.id) components.add(fn.id.name)
208
+ else if (
209
+ parent?.type === `VariableDeclarator` &&
210
+ parent.id.type === `Identifier`
211
+ )
212
+ components.add(parent.id.name)
213
+ else if (parent?.type === `ExportDefaultDeclaration`) {
214
+ const name = uid(`Component`)
215
+ if (fn.type === `FunctionDeclaration`) {
216
+ // Keep anonymous default function declarations hoisted.
217
+ const token = [
218
+ ...code
219
+ .slice(fn.start, fn.body!.start)
220
+ .matchAll(/\/\*[\s\S]*?\*\/|\/\/[^\r\n]*|\bfunction\b|\*/g),
221
+ ].find((match) => match[0] === (fn.generator ? `*` : `function`))!
222
+ output.appendLeft(fn.start + token.index + token[0].length, ` ${name}`)
223
+ } else {
224
+ // Replace only keywords so intervening comments and annotations survive.
225
+ const prefix = code.slice(parent.start, node.start)
226
+ for (const token of prefix.matchAll(
227
+ /\/\*[\s\S]*?\*\/|\/\/[^\r\n]*|\b(?:export|default)\b/g,
228
+ )) {
229
+ if (token[0] !== `export` && token[0] !== `default`) continue
230
+ output.update(
231
+ parent.start + token.index,
232
+ parent.start + token.index + token[0].length,
233
+ token[0] === `export` ? `const ${name} =` : ``,
234
+ )
235
+ }
236
+ output.appendLeft(parent.end, `;\nexport default ${name};`)
237
+ }
238
+ components.add(name)
41
239
  }
42
- return {
43
- visitor: {
44
- ExportDefaultDeclaration(path) {
45
- if (
46
- t.isArrowFunctionExpression(path.node.declaration) ||
47
- t.isFunctionExpression(path.node.declaration)
48
- ) {
49
- const id = path.scope.generateUidIdentifier(`Component`)
50
- path.replaceWithMultiple([
51
- t.variableDeclaration(`const`, [
52
- t.variableDeclarator(id, path.node.declaration),
53
- ]),
54
- t.exportDefaultDeclaration(id),
55
- ])
56
- }
57
- },
58
- Program: {
59
- enter(path) {
60
- create = path.scope.generateUidIdentifier(`spa`)
61
- merge = path.scope.generateUidIdentifier(`props`)
62
- },
63
- exit(path) {
64
- path.unshiftContainer(
65
- `body`,
66
- t.importDeclaration(
67
- [
68
- t.importSpecifier(create, t.identifier(`jsx`)),
69
- t.importSpecifier(merge, t.identifier(`merge`)),
70
- ],
71
- t.stringLiteral(`@atom.io/spa/jsx-runtime`),
72
- ),
73
- )
74
- for (const component of components)
75
- path.pushContainer(
76
- `body`,
77
- t.expressionStatement(
78
- t.assignmentExpression(
79
- `=`,
80
- t.memberExpression(
81
- t.identifier(component),
82
- t.identifier(`spa`),
83
- ),
84
- t.booleanLiteral(true),
85
- ),
86
- ),
87
- )
88
- },
89
- },
90
- "JSXElement|JSXFragment": {
91
- exit(path: any) {
92
- const node = path.node as t.JSXElement | t.JSXFragment
93
- const chunks: t.Expression[] = []
94
- let properties: (t.ObjectProperty | t.ObjectMethod)[] = []
95
- const flush = () => {
96
- if (properties.length) {
97
- chunks.push(t.objectExpression(properties))
98
- properties = []
99
- }
100
- }
101
- if (t.isJSXElement(node))
102
- for (const attribute of node.openingElement.attributes) {
103
- if (t.isJSXSpreadAttribute(attribute)) {
104
- flush()
105
- chunks.push(t.arrowFunctionExpression([], attribute.argument))
106
- continue
107
- }
108
- const key = t.isJSXNamespacedName(attribute.name)
109
- ? `${attribute.name.namespace.name}:${attribute.name.name.name}`
110
- : attribute.name.name
111
- const value =
112
- attribute.value == null
113
- ? t.booleanLiteral(true)
114
- : t.isJSXExpressionContainer(attribute.value)
115
- ? attribute.value.expression
116
- : attribute.value
117
- // The parser rejects empty attribute expressions.
118
- const expression = value as t.Expression
119
- properties.push(
120
- key === `key` ||
121
- literal(expression) ||
122
- t.isFunction(expression)
123
- ? t.objectProperty(t.stringLiteral(key), expression)
124
- : t.objectMethod(
125
- `get`,
126
- t.stringLiteral(key),
127
- [],
128
- t.blockStatement([t.returnStatement(expression)]),
129
- ),
130
- )
131
- }
132
- const children = t.react
133
- .buildChildren(node)
134
- .map((value) => child(value as t.Expression))
135
- if (children.length)
136
- properties.push(
137
- t.objectProperty(
138
- t.identifier(`children`),
139
- children.length === 1
140
- ? children[0]
141
- : t.arrayExpression(children),
142
- ),
143
- )
144
- flush()
145
- const props =
146
- chunks.length > 1 || t.isArrowFunctionExpression(chunks[0])
147
- ? t.callExpression(merge, chunks)
148
- : (chunks[0] ?? t.objectExpression([]))
149
- const result = t.callExpression(create, [
150
- t.isJSXElement(node)
151
- ? name(node.openingElement.name)
152
- : t.nullLiteral(),
153
- props,
154
- ])
155
- generated.add(result)
156
- let fn = path.findParent((parent: any) => parent.isFunction())
157
- while (fn?.findParent((parent: any) => parent.isFunction()))
158
- fn = fn.findParent((parent: any) => parent.isFunction())
159
- if (fn) {
160
- if (fn.isFunctionDeclaration() && fn.node.id)
161
- components.add(fn.node.id.name)
162
- else if (
163
- fn.parentPath.isVariableDeclarator() &&
164
- t.isIdentifier(fn.parentPath.node.id)
165
- )
166
- components.add(fn.parentPath.node.id.name)
167
- else if (
168
- fn.parentPath.isExportDefaultDeclaration() &&
169
- t.isFunctionDeclaration(fn.node)
170
- ) {
171
- fn.node.id = path.scope.generateUidIdentifier(`Component`)
172
- components.add(fn.node.id.name)
173
- }
174
- }
175
- path.replaceWith(result)
176
- },
177
- },
178
- },
240
+ }
241
+ if (elements.length) {
242
+ // Keep hashbangs and directive prologues ahead of generated imports.
243
+ let position = parsed.program.hashbang?.end ?? 0
244
+ for (const statement of parsed.program.body) {
245
+ if (statement.type !== `ExpressionStatement` || !statement.directive) break
246
+ position = statement.end
179
247
  }
248
+ output.appendLeft(
249
+ position,
250
+ `\nimport { jsx as ${create}, merge as ${merge} } from "@atom.io/spa/jsx-runtime";\n`,
251
+ )
252
+ for (const component of components)
253
+ output.append(`\n;${component}.spa = true;`)
254
+ }
255
+ return {
256
+ code: output.toString(),
257
+ map: output.generateMap({
258
+ source: filename,
259
+ includeContent: true,
260
+ hires: true,
261
+ }),
180
262
  }
181
- const result = transformSync(code, {
182
- filename,
183
- babelrc: false,
184
- configFile: false,
185
- sourceMaps: true,
186
- parserOpts: { plugins: [`jsx`, `typescript`] },
187
- plugins: [plugin],
188
- })!
189
- return { code: result.code!, map: result.map }
190
263
  }
package/src/core.ts CHANGED
@@ -30,6 +30,8 @@ import {
30
30
  timeTravelTransactionGroupInStore,
31
31
  } from "atom.io/internal"
32
32
 
33
+ import type { Capability } from "./capabilities.ts"
34
+
33
35
  export type Cleanup = () => void
34
36
  // A callable interface permits the recursive Child union. A type alias does not.
35
37
  /* oxlint-disable typescript/prefer-function-type -- A callable interface is required for recursive Child. */
@@ -53,6 +55,7 @@ export type Child =
53
55
  | readonly Child[]
54
56
  | Accessor<Child>
55
57
  export interface RootOptions {
58
+ capabilities?: readonly Capability[]
56
59
  store?: RootStore
57
60
  idPrefix?: string
58
61
  onError?: (error: unknown) => void
@@ -65,6 +68,7 @@ export interface Scope {
65
68
  _dead: boolean
66
69
  }
67
70
  export interface Root extends Scope {
71
+ _capabilities: Map<string, Capability>
68
72
  _store: RootStore
69
73
  _prefix: string
70
74
  _id: number
@@ -151,7 +155,14 @@ function enqueue(scope: Scope, run: Cleanup): void {
151
155
  root._queue.add(run)
152
156
  }
153
157
  export function createRoot(options: RootOptions = {}, server = false): Root {
158
+ const capabilities = new Map<string, Capability>()
159
+ for (const capability of options.capabilities ?? []) {
160
+ if (capabilities.has(capability.namespace))
161
+ throw new Error(`spa: duplicate capability ${capability.namespace}`)
162
+ capabilities.set(capability.namespace, capability)
163
+ }
154
164
  const root = {
165
+ _capabilities: capabilities,
155
166
  _store: options.store ?? IMPLICIT.STORE,
156
167
  _prefix: options.idPrefix ?? `w${serial++}`,
157
168
  _id: 0,
package/src/dom.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import { capabilityProps } from "./capabilities.ts"
1
2
  import type { Accessor, Child, RootOptions, Scope, VNode } from "./core.ts"
2
3
  import {
3
4
  createRoot,
@@ -290,6 +291,7 @@ function mount(
290
291
  import.meta.env.DEV ? `spa: hydration mismatch` : undefined,
291
292
  )
292
293
  }
294
+ const nativeProps = capabilityProps(owner, { kind: `dom`, node: element })
293
295
  let previous: Record<string, any> = {}
294
296
  owner._cleanups.add(() => {
295
297
  for (const key in previous)
@@ -298,7 +300,8 @@ function mount(
298
300
  observe(
299
301
  owner,
300
302
  () => ({ ...props }),
301
- (next) => {
303
+ (all) => {
304
+ const next = nativeProps(all)
302
305
  for (const key in { ...previous, ...next })
303
306
  if (
304
307
  !Object.is(previous[key], next[key]) ||
package/src/index.ts CHANGED
@@ -1,3 +1,8 @@
1
+ export type {
2
+ Capability,
3
+ CapabilityBinding,
4
+ CapabilityTarget,
5
+ } from "./capabilities.ts"
1
6
  export type {
2
7
  Accessor,
3
8
  Child,
@@ -12,6 +12,10 @@ export type {
12
12
  TargetedEvent,
13
13
  } from "./jsx-types.d.ts"
14
14
 
15
+ /** Optional integrations augment attributes without changing element identity. */
16
+ // oxlint-disable-next-line typescript/no-empty-interface -- Optional integrations augment this declaration.
17
+ export interface CapabilityAttributes<Kind extends string = string> {}
18
+
15
19
  export const Fragment = (props: { children?: Child }): Child => props.children
16
20
  export function jsx(
17
21
  type: VNode[`type`],
@@ -1,4 +1,5 @@
1
1
  import type { Child } from "./core.ts"
2
+ import type { CapabilityAttributes } from "./jsx-runtime.ts"
2
3
 
3
4
  /** Native events retain their target; only currentTarget is the attached element. */
4
5
  export type TargetedEvent<E extends Element, T extends Event = Event> = Omit<
@@ -195,7 +196,8 @@ export type AriaAttributes = Attributes<{
195
196
  [`aria-valuetext`]: string
196
197
  }>
197
198
 
198
- export type DOMAttributes<E extends Element> = EventAttributes<E> &
199
+ export type DOMAttributes<E extends Element> = CapabilityAttributes<`dom`> &
200
+ EventAttributes<E> &
199
201
  AriaAttributes &
200
202
  Attributes<{
201
203
  children: Child
package/src/konva.ts ADDED
@@ -0,0 +1,159 @@
1
+ import Konva from "konva"
2
+
3
+ import { capabilityProps } from "./capabilities.ts"
4
+ import { owner } from "./core.ts"
5
+ import type { Child, VNode } from "./index.ts"
6
+ import { onCleanup, onMount } from "./index.ts"
7
+ import type { CapabilityAttributes } from "./jsx-runtime.ts"
8
+ import { jsx } from "./jsx-runtime.ts"
9
+ import { bindScene, createSceneRenderer, sceneComponent } from "./renderer.ts"
10
+
11
+ type Props<C, N> = C &
12
+ CapabilityAttributes<`konva`> & {
13
+ children?: Child
14
+ ref?: (node: N | null) => void
15
+ onClick?: (event: Konva.KonvaEventObject<MouseEvent>) => void
16
+ onPointerDown?: (event: Konva.KonvaEventObject<PointerEvent>) => void
17
+ onDragMove?: (event: Konva.KonvaEventObject<DragEvent>) => void
18
+ onDragEnd?: (event: Konva.KonvaEventObject<DragEvent>) => void
19
+ }
20
+ const constructors = {
21
+ Layer: Konva.Layer,
22
+ Group: Konva.Group,
23
+ Rect: Konva.Rect,
24
+ Circle: Konva.Circle,
25
+ Ellipse: Konva.Ellipse,
26
+ Line: Konva.Line,
27
+ Text: Konva.Text,
28
+ Image: Konva.Image,
29
+ Path: Konva.Path,
30
+ Star: Konva.Star,
31
+ Transformer: Konva.Transformer,
32
+ }
33
+ function updateNode(
34
+ node: Konva.Node,
35
+ props: Record<string, any>,
36
+ previous: Record<string, any>,
37
+ ): void {
38
+ for (const key of new Set([...Object.keys(previous), ...Object.keys(props)])) {
39
+ if (/^(key|children|ref)$/.test(key) || Object.is(props[key], previous[key]))
40
+ continue
41
+ if (key.startsWith(`on`)) {
42
+ const event = key.slice(2).toLowerCase()
43
+ if (previous[key]) node.off(event, previous[key])
44
+ if (props[key]) node.on(event, props[key])
45
+ } else node.setAttr(key, props[key])
46
+ }
47
+ }
48
+ const renderer = createSceneRenderer<Konva.Node>({
49
+ target(node) {
50
+ return {
51
+ kind: `konva`,
52
+ node,
53
+ read: (key) => node.getAttr(key),
54
+ write: (key, value) => {
55
+ node.setAttr(key, value)
56
+ },
57
+ listen(event, listener) {
58
+ node.on(event, listener)
59
+ return () => {
60
+ node.off(event, listener)
61
+ }
62
+ },
63
+ }
64
+ },
65
+ create(type) {
66
+ const Constructor = constructors[type as keyof typeof constructors]
67
+ if (!Constructor) throw new Error(`spa/konva: unknown node ${type}`)
68
+ return new Constructor({} as any)
69
+ },
70
+ update: updateNode,
71
+ children(parent, children) {
72
+ if (children.length && !(parent instanceof Konva.Container))
73
+ throw new Error(`spa/konva: shapes cannot contain children`)
74
+ if (parent instanceof Konva.Container) {
75
+ for (const child of [...parent.getChildren()])
76
+ if (!children.includes(child)) child.remove()
77
+ children.forEach((child, index) => {
78
+ if (child.getParent() !== parent) parent.add(child as any)
79
+ child.zIndex(index)
80
+ })
81
+ }
82
+ },
83
+ destroy(node) {
84
+ node.off()
85
+ node.destroy()
86
+ },
87
+ })
88
+
89
+ /** A DOM boundary owning a Konva stage and its scene subtree. */
90
+ export function Stage(
91
+ props: Props<Omit<Konva.StageConfig, `container`>, Konva.Stage> & {
92
+ width?: number
93
+ height?: number
94
+ },
95
+ ): VNode {
96
+ let container: HTMLDivElement | null = null
97
+ onMount(() => {
98
+ const stage = new Konva.Stage({
99
+ container: container!,
100
+ width: props.width ?? 300,
101
+ height: props.height ?? 150,
102
+ })
103
+ onCleanup(() => {
104
+ stage.off()
105
+ stage.destroy()
106
+ })
107
+ const nativeProps = capabilityProps(owner!, {
108
+ kind: `konva`,
109
+ node: stage,
110
+ listen(event, listener) {
111
+ stage.on(event, listener)
112
+ return () => {
113
+ stage.off(event, listener)
114
+ }
115
+ },
116
+ read: (key) => stage.getAttr(key),
117
+ write: (key, value) => {
118
+ stage.setAttr(key, value)
119
+ },
120
+ })
121
+ let previous: Record<string, any> = {}
122
+ bindScene(
123
+ () => ({ ...props }),
124
+ (all) => {
125
+ const next = nativeProps(all)
126
+ updateNode(stage, next, previous)
127
+ previous = next
128
+ },
129
+ )
130
+ props.ref?.(stage)
131
+ onCleanup(() => props.ref?.(null))
132
+ renderer.mount(() => props.children, stage)
133
+ })
134
+ return jsx(`div`, {
135
+ ref: (element: HTMLDivElement | null) => {
136
+ container = element
137
+ },
138
+ })
139
+ }
140
+ export const Layer =
141
+ sceneComponent<Props<Konva.LayerConfig, Konva.Layer>>(`Layer`)
142
+ export const Group =
143
+ sceneComponent<Props<Konva.ContainerConfig, Konva.Group>>(`Group`)
144
+ export const Rect = sceneComponent<Props<Konva.RectConfig, Konva.Rect>>(`Rect`)
145
+ export const Circle =
146
+ sceneComponent<Props<Konva.CircleConfig, Konva.Circle>>(`Circle`)
147
+ export const Ellipse =
148
+ sceneComponent<Props<Konva.EllipseConfig, Konva.Ellipse>>(`Ellipse`)
149
+ export const Line = sceneComponent<Props<Konva.LineConfig, Konva.Line>>(`Line`)
150
+ export const Text = sceneComponent<Props<Konva.TextConfig, Konva.Text>>(`Text`)
151
+ export const Image =
152
+ sceneComponent<Props<Konva.ImageConfig, Konva.Image>>(`Image`)
153
+ export const Path = sceneComponent<Props<Konva.PathConfig, Konva.Path>>(`Path`)
154
+ export const Star = sceneComponent<Props<Konva.StarConfig, Konva.Star>>(`Star`)
155
+ export const Transformer =
156
+ sceneComponent<Props<Konva.TransformerConfig, Konva.Transformer>>(
157
+ `Transformer`,
158
+ )
159
+ export { renderer as konvaRenderer }