forked from kitajs/html
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
527 lines (436 loc) · 12.2 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
/// <reference path="./jsx.d.ts" />
const ESCAPED_REGEX = /[<"'&]/
const CAMEL_REGEX = /[a-z][A-Z]/
/**
* @type {typeof import('.').Fragment}
*/
const Fragment = Symbol.for('kHtmlFragment')
/**
* @type {import('.').isUpper}
*/
function isUpper (input, index) {
const code = input.charCodeAt(index)
return code >= 65 /* A */ && code <= 90 /* Z */
}
/**
* @type {import('.').toKebabCase}
*/
function toKebabCase (camel) {
// This is a optimization to avoid the whole conversion process when the
// string does not contain any uppercase characters.
if (!CAMEL_REGEX.test(camel)) {
return camel
}
const length = camel.length
let start = 0
let end = 0
let kebab = ''
let prev = true
let curr = isUpper(camel, 0)
let next
for (; end < length; end++) {
next = isUpper(camel, end + 1)
// detects the start of a new camel case word and avoid lowercasing abbreviations.
if (!prev && curr && !next) {
// @ts-expect-error - this indexing is safe.
kebab += camel.slice(start, end) + '-' + camel[end].toLowerCase()
start = end + 1
}
prev = curr
curr = next
}
// Appends the remaining string.
kebab += camel.slice(start, end)
return kebab
}
/**
* @type {import('.').escapeHtml}
*/
function escapeHtml (value) {
if (typeof value !== 'string') {
value = value.toString()
}
// This is a optimization to avoid the whole conversion process when the
// string does not contain any uppercase characters.
if (!ESCAPED_REGEX.test(value)) {
return value
}
const length = value.length
let escaped = ''
let start = 0
let end = 0
// Faster than using regex
// https://jsperf.app/kakihu
for (; end < length; end++) {
// https://wonko.com/post/html-escaping
switch (value[end]) {
case '&':
escaped += value.slice(start, end) + '&'
start = end + 1
continue
// We don't need to escape > because it is only used to close tags.
// https://stackoverflow.com/a/9189067
case '<':
escaped += value.slice(start, end) + '<'
start = end + 1
continue
case '"':
escaped += value.slice(start, end) + '"'
start = end + 1
continue
case "'":
escaped += value.slice(start, end) + '''
start = end + 1
continue
}
}
// Appends the remaining string.
escaped += value.slice(start, end)
return escaped
}
/**
* @type {import('.').isVoidElement}
*/
function isVoidElement (tag) {
// Ordered by most common to least common.
return (
tag === 'meta' ||
tag === 'link' ||
tag === 'img' ||
tag === 'br' ||
tag === 'input' ||
tag === 'hr' ||
tag === 'area' ||
tag === 'base' ||
tag === 'col' ||
tag === 'command' ||
tag === 'embed' ||
tag === 'keygen' ||
tag === 'param' ||
tag === 'source' ||
tag === 'track' ||
tag === 'wbr'
)
}
/**
* @type {import('.').styleToString}
*/
function styleToString (style) {
// Faster escaping process that only looks for the " character.
// As we use the " character to wrap the style string, we need to escape it.
if (typeof style === 'string') {
let end = style.indexOf('"')
// This is a optimization to avoid having to look twice for the " character.
// And make the loop already start in the middle
if (end === -1) {
return style
}
const length = style.length
let escaped = ''
let start = 0
// Faster than using regex
// https://jsperf.app/kakihu
for (; end < length; end++) {
if (style[end] === '"') {
escaped += style.slice(start, end) + '"'
start = end + 1
}
}
// Appends the remaining string.
escaped += style.slice(start, end)
return escaped
}
const keys = Object.keys(style)
const length = keys.length
let key
let value
let index = 0
let result = ''
for (; index < length; index++) {
key = keys[index]
// @ts-expect-error - this indexing is safe.
value = style[key]
if (value === null || value === undefined) {
continue
}
// @ts-expect-error - this indexing is safe.
result += toKebabCase(key) + ':'
// Only needs escaping when the value is a string.
if (typeof value !== 'string') {
result += value.toString() + ';'
continue
}
let end = value.indexOf('"')
// This is a optimization to avoid having to look twice for the " character.
// And make the loop already start in the middle
if (end === -1) {
result += value + ';'
continue
}
const length = value.length
let start = 0
// Faster than using regex
// https://jsperf.app/kakihu
for (; end < length; end++) {
if (value[end] === '"') {
result += value.slice(start, end) + '"'
start = end + 1
}
}
// Appends the remaining string.
result += value.slice(start, end) + ';'
}
return result
}
/**
* @type {import('.').attributesToString}
*/
function attributesToString (attributes) {
if (!attributes) {
return ''
}
const keys = Object.keys(attributes)
const length = keys.length
let key, value, type
let result = ''
let index = 0
for (; index < length; index++) {
key = keys[index]
// Skips all @kitajs/html specific attributes.
if (key === 'children' || key === 'safe') {
continue
}
// @ts-expect-error - this indexing is safe.
value = attributes[key]
// React className compatibility.
if (key === 'className') {
// @ts-expect-error - both were provided, so use the class attribute.
if (attributes.class !== undefined) {
continue
}
key = 'class'
}
if (key === 'style') {
result += ' style="' + styleToString(value) + '"'
continue
}
type = typeof value
if (type === 'boolean') {
// Only add the attribute if the value is true.
if (value) {
result += ' ' + key
}
continue
}
if (value === null || value === undefined) {
continue
}
result += ' ' + key
if (type !== 'string') {
// Non objects are
if (type !== 'object') {
result += '="' + value.toString() + '"'
continue
// Dates are always safe
} else if (value instanceof Date) {
result += '="' + value.toISOString() + '"'
continue
}
// The object may have a overridden toString method.
// Which results in a non escaped string.
value = value.toString()
}
let end = value.indexOf('"')
// This is a optimization to avoid having to look twice for the " character.
// And make the loop already start in the middle
if (end === -1) {
result += '="' + value + '"'
continue
}
result += '="'
const length = value.length
let start = 0
// Faster than using regex
// https://jsperf.app/kakihu
for (; end < length; end++) {
if (value[end] === '"') {
result += value.slice(start, end) + '"'
start = end + 1
}
}
// Appends the remaining string.
result += value.slice(start, end) + '"'
}
return result
}
/**
* @type {import('.').contentsToString}
*/
function contentsToString (contents, escape) {
const length = contents.length
if (length === 0) {
return ''
}
let result = ''
let content
let index = 0
for (; index < length; index++) {
content = contents[index]
// Ignores non 0 falsy values
if (!content && content !== 0) {
continue
}
if (Array.isArray(content)) {
result += contentsToString(content, escape)
} else if (escape === true) {
result += escapeHtml(content)
} else {
result += content
}
}
return result
}
/**
* Just to stop TS from complaining about the type.
* @param {any} name
*
* @type {import('.').createElement}
*/
function createElement (name, attrs, ...children) {
// Adds the children to the attributes if it is not present.
if (attrs === null) {
attrs = { children }
}
// Calls the element creator function if the name is a function
if (typeof name === 'function') {
// In case the children attributes is not present, add it as a property.
if (attrs.children === undefined) {
// When only a single child is present, unwrap it.
if (children.length > 1) {
attrs.children = children
} else {
attrs.children = children[0]
}
}
return name(attrs)
}
if (name === Fragment) {
return contentsToString(children)
}
// Switches the tag name when this custom `tag` is present.
if (name === 'tag') {
name = String(attrs.of)
delete attrs.of
}
if (children.length === 0 && isVoidElement(name)) {
return '<' + name + attributesToString(attrs) + '/>'
}
return (
'<' +
name +
attributesToString(attrs) +
'>' +
contentsToString(children, attrs.safe) +
'</' +
name +
'>'
)
}
/**
* Just to stop TS from complaining about the type.
* @returns {Function}
*
* @type {import('.').compile}
*/
function compile (htmlFn, strict = true, separator = '/*\x00*/') {
if (typeof htmlFn !== 'function') {
throw new Error('The first argument must be a function.')
}
const properties = new Set()
const html = htmlFn(
// @ts-expect-error - this proxy will meet the props with children requirements.
new Proxy(
{},
{
get (_, name) {
// Adds the property to the set of known properties.
properties.add(name)
const isChildren = name === 'children'
let access = `args[${separator}\`${name.toString()}\`${separator}]`
// Adds support to render multiple children
if (isChildren) {
access = `Array.isArray(${access}) ? ${access}.join(${separator}\`\`${separator}) : ${access}`
}
// Uses ` to avoid content being escaped.
return `\`${separator} + (${access} || ${
strict && !isChildren
? `throwPropertyNotFound(${separator}\`${name.toString()}\`${separator})`
: `${separator}\`\`${separator}`
}) + ${separator}\``
}
}
)
)
const sepLength = separator.length
const length = html.length
// Adds the throwPropertyNotFound function if strict
let body = ''
let nextStart = 0
let index = 0
// Escapes every ` without separator
for (; index < length; index++) {
// Escapes the backtick character because it will be used to wrap the string
// in a template literal.
if (
html[index] === '`' &&
html.slice(index - sepLength, index) !== separator &&
html.slice(index + 1, index + sepLength + 1) !== separator
) {
body += html.slice(nextStart, index) + '\\`'
nextStart = index + 1
continue
}
// Escapes the backslash character because it will be used to escape the
// backtick character.
if (html[index] === '\\') {
body += html.slice(nextStart, index) + '\\\\'
nextStart = index + 1
continue
}
}
// Adds the remaining string
body += html.slice(nextStart)
if (strict) {
// eslint-disable-next-line no-new-func
return Function(
'args',
// Checks for args presence
'if (args === undefined) { throw new Error("The arguments object was not provided.") };\n' +
// Function to throw when a property is not found
'function throwPropertyNotFound(name) { throw new Error("Property " + name + " was not provided.") };\n' +
// Concatenates the body
`return \`${body}\``
)
}
// eslint-disable-next-line no-new-func
return Function(
'args',
// Adds a empty args object when it is not present
'if (args === undefined) { args = Object.create(null) };\n' +
`return \`${body}\``
)
}
module.exports.escapeHtml = escapeHtml
module.exports.isVoidElement = isVoidElement
module.exports.attributesToString = attributesToString
module.exports.toKebabCase = toKebabCase
module.exports.isUpper = isUpper
module.exports.styleToString = styleToString
module.exports.createElement = createElement
module.exports.h = createElement
module.exports.contentsToString = contentsToString
module.exports.compile = compile
module.exports.Fragment = Fragment
// esModule interop
Object.defineProperty(exports, '__esModule', { value: true })
module.exports.default = Object.assign({}, module.exports)