@readme/data-urls 4.0.2 → 4.0.3
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.
- package/README.md +4 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +25 -27
package/README.md
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
# @readme/data-urls
|
|
2
|
+
|
|
2
3
|
A utility for parsing and validating [data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
|
|
3
4
|
|
|
4
5
|
[](https://github.com/readmeio/data-urls/)
|
|
@@ -16,10 +17,12 @@ npm install --save @readme/data-urls
|
|
|
16
17
|
```
|
|
17
18
|
|
|
18
19
|
## Usage
|
|
20
|
+
|
|
19
21
|
```js
|
|
20
22
|
import { parse, validate } from '@readme/data-urls';
|
|
21
23
|
|
|
22
|
-
const url =
|
|
24
|
+
const url =
|
|
25
|
+
'data:image/png;name=owlbert-shrub.png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAACNUlEQVR4AWJkIA2wCQHqJgcouZ0ADv+SmayR28PibPOP2jafzdp6Lh/v2bVt2+1zbdvtbtbMpGfmvmD8jStc9uB3v75gdNmqtJqsa6qCDEBPRVH7XpKk1P9yHLZv3mG6keV9BIsWGqNuvNaiy+YoARFIXFXwf6Frjz/X9oS4LNRkty4QH/0MSnnWDHORHV3pJsiozRk0zWW/9MEi0A9ffqOhf5RRDW6SGLT/ZXcT8C1hWvao8iF1c4ecKx5eejW1bii1y1asW14P5XsUNkogmvVQg2aPLOnrqss9qE81OYlAucRrN/LrqlBSWYufv34jq7gKseA7MCr0IOhffForGsTWDBJnqE2/B0H+hKRRG3DtxEGk6QBZQ9UFClMSnTJe/cCVI5uQJJpx+8AyOBUPPv+JIpJjgJqCZzKT0AGdAgT/1OLtSzsKI2/gspnxvGExZYFADcoSsqM10SADF4jC4TCCUDN8nih+eoIgPAdGeajBNxyMH20JwsPNMwSicUjBCAwmAZ6GkCmA7I+qCxTGRHSkVzZiCRmKAsRkuVmWiENrt6gL5Di7iw4oogFSINIkCTU09hNAP64CREPUBbzAx9ABrc2I3w2NeY5DMByHu8AGY3YyeoKIuSmBWCD6OuqLPJXe/Dpvkb3FuoDbdENKuBVJ4nxZJpKgWoUXCMcYUwBwDfR8FxZPN4wfWK2Zunq7tGLmZMOc7x7ZUn/RuDmrX0H/4FffQ2teylCecuWmDNsTnainfwFPuNZTR3MemwAAAABJRU5ErkJggg==';
|
|
23
26
|
|
|
24
27
|
console.log(validate(url)); // true
|
|
25
28
|
console.log(parse(url));
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["const DATA_URL_REGEX =\n /^data:([a-z]+\\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\\-._~:@/?%\\s<>]*?)$/i;\n\n/**\n * Determine if a given data URL is valid or not.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/data_URIs}\n * @see {@link http://tools.ietf.org/html/rfc2397}\n * @see {@link http://tools.ietf.org/html/rfc2396#section2}\n */\nfunction validate(str: string) {\n return DATA_URL_REGEX.test((str || '').trim());\n}\n\nexport interface DataURL {\n // biome-ignore lint/suspicious/noExplicitAny: `additionalProperties: true`\n [k: string]: any;\n base64: boolean;\n contentType?: string;\n data: string;\n mediaType?: string;\n name?: string;\n toBuffer: () => Buffer;\n}\n\n/**\n * Parse a given data URL into its individual parts.\n *\n */\nfunction parse(str: string) {\n if (!validate(str)) {\n return false;\n }\n\n const parts = str.trim().match(DATA_URL_REGEX);\n const parsed = {} as DataURL;\n\n if (parts[1]) {\n parsed.mediaType = parts[1].toLowerCase();\n\n const mediaTypeParts = parts[1].split(';').map(x => {\n // `name` attributes are for filenames so we shouldn't lowercase them as some filesystems are\n // case-sensitive.\n if (x.startsWith('name=')) {\n return x;\n }\n\n return x.toLowerCase();\n });\n\n parsed.contentType = mediaTypeParts[0];\n\n mediaTypeParts.slice(1).forEach(attribute => {\n const p = attribute.split('=');\n parsed[p[0]] = p[1];\n });\n }\n\n parsed.base64 = !!parts[parts.length - 2];\n parsed.data = parts[parts.length - 1] || '';\n\n parsed.toBuffer = () => {\n const encoding = parsed.base64 ? 'base64' : 'utf8';\n\n return Buffer.from(parsed.data, encoding);\n };\n\n return parsed;\n}\n\nexport { parse, validate };\n"],"mappings":";;;AAAA,MAAM,iBACJ;;;;;;;;AASF,SAAS,SAAS,KAAa;
|
|
1
|
+
{"version":3,"file":"index.cjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["const DATA_URL_REGEX =\n /^data:([a-z]+\\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\\-._~:@/?%\\s<>]*?)$/i;\n\n/**\n * Determine if a given data URL is valid or not.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/data_URIs}\n * @see {@link http://tools.ietf.org/html/rfc2397}\n * @see {@link http://tools.ietf.org/html/rfc2396#section2}\n */\nfunction validate(str: string) {\n return DATA_URL_REGEX.test((str || '').trim());\n}\n\nexport interface DataURL {\n // biome-ignore lint/suspicious/noExplicitAny: `additionalProperties: true`\n [k: string]: any;\n base64: boolean;\n contentType?: string;\n data: string;\n mediaType?: string;\n name?: string;\n toBuffer: () => Buffer;\n}\n\n/**\n * Parse a given data URL into its individual parts.\n *\n */\nfunction parse(str: string) {\n if (!validate(str)) {\n return false;\n }\n\n const parts = str.trim().match(DATA_URL_REGEX);\n const parsed = {} as DataURL;\n\n if (parts[1]) {\n parsed.mediaType = parts[1].toLowerCase();\n\n const mediaTypeParts = parts[1].split(';').map(x => {\n // `name` attributes are for filenames so we shouldn't lowercase them as some filesystems are\n // case-sensitive.\n if (x.startsWith('name=')) {\n return x;\n }\n\n return x.toLowerCase();\n });\n\n parsed.contentType = mediaTypeParts[0];\n\n mediaTypeParts.slice(1).forEach(attribute => {\n const p = attribute.split('=');\n parsed[p[0]] = p[1];\n });\n }\n\n parsed.base64 = !!parts[parts.length - 2];\n parsed.data = parts[parts.length - 1] || '';\n\n parsed.toBuffer = () => {\n const encoding = parsed.base64 ? 'base64' : 'utf8';\n\n return Buffer.from(parsed.data, encoding);\n };\n\n return parsed;\n}\n\nexport { parse, validate };\n"],"mappings":";;;AAAA,MAAM,iBACJ;;;;;;;;AASF,SAAS,SAAS,KAAa;CAC7B,OAAO,eAAe,MAAM,OAAO,IAAI,KAAK,CAAC;AAC/C;;;;;AAiBA,SAAS,MAAM,KAAa;CAC1B,IAAI,CAAC,SAAS,GAAG,GACf,OAAO;CAGT,MAAM,QAAQ,IAAI,KAAK,EAAE,MAAM,cAAc;CAC7C,MAAM,SAAS,CAAC;CAEhB,IAAI,MAAM,IAAI;EACZ,OAAO,YAAY,MAAM,GAAG,YAAY;EAExC,MAAM,iBAAiB,MAAM,GAAG,MAAM,GAAG,EAAE,KAAI,MAAK;GAGlD,IAAI,EAAE,WAAW,OAAO,GACtB,OAAO;GAGT,OAAO,EAAE,YAAY;EACvB,CAAC;EAED,OAAO,cAAc,eAAe;EAEpC,eAAe,MAAM,CAAC,EAAE,SAAQ,cAAa;GAC3C,MAAM,IAAI,UAAU,MAAM,GAAG;GAC7B,OAAO,EAAE,MAAM,EAAE;EACnB,CAAC;CACH;CAEA,OAAO,SAAS,CAAC,CAAC,MAAM,MAAM,SAAS;CACvC,OAAO,OAAO,MAAM,MAAM,SAAS,MAAM;CAEzC,OAAO,iBAAiB;EACtB,MAAM,WAAW,OAAO,SAAS,WAAW;EAE5C,OAAO,OAAO,KAAK,OAAO,MAAM,QAAQ;CAC1C;CAEA,OAAO;AACT"}
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["const DATA_URL_REGEX =\n /^data:([a-z]+\\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\\-._~:@/?%\\s<>]*?)$/i;\n\n/**\n * Determine if a given data URL is valid or not.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/data_URIs}\n * @see {@link http://tools.ietf.org/html/rfc2397}\n * @see {@link http://tools.ietf.org/html/rfc2396#section2}\n */\nfunction validate(str: string) {\n return DATA_URL_REGEX.test((str || '').trim());\n}\n\nexport interface DataURL {\n // biome-ignore lint/suspicious/noExplicitAny: `additionalProperties: true`\n [k: string]: any;\n base64: boolean;\n contentType?: string;\n data: string;\n mediaType?: string;\n name?: string;\n toBuffer: () => Buffer;\n}\n\n/**\n * Parse a given data URL into its individual parts.\n *\n */\nfunction parse(str: string) {\n if (!validate(str)) {\n return false;\n }\n\n const parts = str.trim().match(DATA_URL_REGEX);\n const parsed = {} as DataURL;\n\n if (parts[1]) {\n parsed.mediaType = parts[1].toLowerCase();\n\n const mediaTypeParts = parts[1].split(';').map(x => {\n // `name` attributes are for filenames so we shouldn't lowercase them as some filesystems are\n // case-sensitive.\n if (x.startsWith('name=')) {\n return x;\n }\n\n return x.toLowerCase();\n });\n\n parsed.contentType = mediaTypeParts[0];\n\n mediaTypeParts.slice(1).forEach(attribute => {\n const p = attribute.split('=');\n parsed[p[0]] = p[1];\n });\n }\n\n parsed.base64 = !!parts[parts.length - 2];\n parsed.data = parts[parts.length - 1] || '';\n\n parsed.toBuffer = () => {\n const encoding = parsed.base64 ? 'base64' : 'utf8';\n\n return Buffer.from(parsed.data, encoding);\n };\n\n return parsed;\n}\n\nexport { parse, validate };\n"],"mappings":";AAAA,MAAM,iBACJ;;;;;;;;AASF,SAAS,SAAS,KAAa;
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["const DATA_URL_REGEX =\n /^data:([a-z]+\\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\\-._~:@/?%\\s<>]*?)$/i;\n\n/**\n * Determine if a given data URL is valid or not.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/data_URIs}\n * @see {@link http://tools.ietf.org/html/rfc2397}\n * @see {@link http://tools.ietf.org/html/rfc2396#section2}\n */\nfunction validate(str: string) {\n return DATA_URL_REGEX.test((str || '').trim());\n}\n\nexport interface DataURL {\n // biome-ignore lint/suspicious/noExplicitAny: `additionalProperties: true`\n [k: string]: any;\n base64: boolean;\n contentType?: string;\n data: string;\n mediaType?: string;\n name?: string;\n toBuffer: () => Buffer;\n}\n\n/**\n * Parse a given data URL into its individual parts.\n *\n */\nfunction parse(str: string) {\n if (!validate(str)) {\n return false;\n }\n\n const parts = str.trim().match(DATA_URL_REGEX);\n const parsed = {} as DataURL;\n\n if (parts[1]) {\n parsed.mediaType = parts[1].toLowerCase();\n\n const mediaTypeParts = parts[1].split(';').map(x => {\n // `name` attributes are for filenames so we shouldn't lowercase them as some filesystems are\n // case-sensitive.\n if (x.startsWith('name=')) {\n return x;\n }\n\n return x.toLowerCase();\n });\n\n parsed.contentType = mediaTypeParts[0];\n\n mediaTypeParts.slice(1).forEach(attribute => {\n const p = attribute.split('=');\n parsed[p[0]] = p[1];\n });\n }\n\n parsed.base64 = !!parts[parts.length - 2];\n parsed.data = parts[parts.length - 1] || '';\n\n parsed.toBuffer = () => {\n const encoding = parsed.base64 ? 'base64' : 'utf8';\n\n return Buffer.from(parsed.data, encoding);\n };\n\n return parsed;\n}\n\nexport { parse, validate };\n"],"mappings":";AAAA,MAAM,iBACJ;;;;;;;;AASF,SAAS,SAAS,KAAa;CAC7B,OAAO,eAAe,MAAM,OAAO,IAAI,KAAK,CAAC;AAC/C;;;;;AAiBA,SAAS,MAAM,KAAa;CAC1B,IAAI,CAAC,SAAS,GAAG,GACf,OAAO;CAGT,MAAM,QAAQ,IAAI,KAAK,EAAE,MAAM,cAAc;CAC7C,MAAM,SAAS,CAAC;CAEhB,IAAI,MAAM,IAAI;EACZ,OAAO,YAAY,MAAM,GAAG,YAAY;EAExC,MAAM,iBAAiB,MAAM,GAAG,MAAM,GAAG,EAAE,KAAI,MAAK;GAGlD,IAAI,EAAE,WAAW,OAAO,GACtB,OAAO;GAGT,OAAO,EAAE,YAAY;EACvB,CAAC;EAED,OAAO,cAAc,eAAe;EAEpC,eAAe,MAAM,CAAC,EAAE,SAAQ,cAAa;GAC3C,MAAM,IAAI,UAAU,MAAM,GAAG;GAC7B,OAAO,EAAE,MAAM,EAAE;EACnB,CAAC;CACH;CAEA,OAAO,SAAS,CAAC,CAAC,MAAM,MAAM,SAAS;CACvC,OAAO,OAAO,MAAM,MAAM,SAAS,MAAM;CAEzC,OAAO,iBAAiB;EACtB,MAAM,WAAW,OAAO,SAAS,WAAW;EAE5C,OAAO,OAAO,KAAK,OAAO,MAAM,QAAQ;CAC1C;CAEA,OAAO;AACT"}
|
package/package.json
CHANGED
|
@@ -1,10 +1,24 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@readme/data-urls",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.3",
|
|
4
4
|
"description": "A utility for parsing and validating data URLs.",
|
|
5
|
+
"homepage": "https://github.com/readmeio/data-urls#readme",
|
|
6
|
+
"bugs": {
|
|
7
|
+
"url": "https://github.com/readmeio/data-urls/issues"
|
|
8
|
+
},
|
|
5
9
|
"license": "ISC",
|
|
6
|
-
"
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "git@github.com:readmeio/data-urls.git"
|
|
13
|
+
},
|
|
14
|
+
"files": [
|
|
15
|
+
"dist"
|
|
16
|
+
],
|
|
7
17
|
"type": "module",
|
|
18
|
+
"sideEffects": false,
|
|
19
|
+
"main": "dist/index.cjs",
|
|
20
|
+
"module": "dist/index.mjs",
|
|
21
|
+
"types": "dist/index.d.cts",
|
|
8
22
|
"exports": {
|
|
9
23
|
".": {
|
|
10
24
|
"import": {
|
|
@@ -18,46 +32,30 @@
|
|
|
18
32
|
},
|
|
19
33
|
"./package.json": "./package.json"
|
|
20
34
|
},
|
|
21
|
-
"main": "dist/index.cjs",
|
|
22
|
-
"module": "dist/index.mjs",
|
|
23
|
-
"types": "dist/index.d.cts",
|
|
24
|
-
"engines": {
|
|
25
|
-
"node": ">=22"
|
|
26
|
-
},
|
|
27
|
-
"files": [
|
|
28
|
-
"dist"
|
|
29
|
-
],
|
|
30
|
-
"repository": {
|
|
31
|
-
"type": "git",
|
|
32
|
-
"url": "git@github.com:readmeio/data-urls.git"
|
|
33
|
-
},
|
|
34
|
-
"bugs": {
|
|
35
|
-
"url": "https://github.com/readmeio/data-urls/issues"
|
|
36
|
-
},
|
|
37
|
-
"homepage": "https://github.com/readmeio/data-urls#readme",
|
|
38
35
|
"scripts": {
|
|
39
36
|
"build": "tsdown",
|
|
40
|
-
"format": "
|
|
41
|
-
"lint": "
|
|
37
|
+
"format": "npx oxlint --fix && npx oxfmt --write",
|
|
38
|
+
"lint": "npx oxlint && npx oxfmt --check",
|
|
42
39
|
"prebuild": "rm -rf dist/",
|
|
43
40
|
"prepack": "npm run build",
|
|
44
41
|
"pretest": "npm run lint",
|
|
45
|
-
"prettier": "prettier --list-different --write \"./**/**.{js,ts}\"",
|
|
46
42
|
"test": "vitest --coverage"
|
|
47
43
|
},
|
|
48
44
|
"devDependencies": {
|
|
49
45
|
"@arethetypeswrong/core": "^0.18.2",
|
|
50
|
-
"@
|
|
51
|
-
"@readme/standards": "^2.4.1",
|
|
46
|
+
"@readme/oxlint-config": "^1.1.2",
|
|
52
47
|
"@types/node": "^25.5.2",
|
|
53
48
|
"@vitest/coverage-v8": "^4.1.2",
|
|
54
|
-
"
|
|
55
|
-
"
|
|
49
|
+
"oxfmt": "^0.52.0",
|
|
50
|
+
"oxlint": "^1.62.0",
|
|
51
|
+
"tsdown": "^0.22.1",
|
|
56
52
|
"typescript": "^6.0.2",
|
|
57
53
|
"vitest": "^4.1.2"
|
|
58
54
|
},
|
|
59
55
|
"browserslist": [
|
|
60
56
|
"last 2 versions"
|
|
61
57
|
],
|
|
62
|
-
"
|
|
58
|
+
"engines": {
|
|
59
|
+
"node": ">=22"
|
|
60
|
+
}
|
|
63
61
|
}
|