@readme/data-urls 1.0.1 → 2.0.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.
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Determine if a given data URL is valid or not.
3
+ *
4
+ * @see {@link https://developer.mozilla.org/en-US/docs/data_URIs}
5
+ * @see {@link http://tools.ietf.org/html/rfc2397}
6
+ * @see {@link http://tools.ietf.org/html/rfc2396#section2}
7
+ */
8
+ declare function validate(str: string): boolean;
9
+ interface DataURL {
10
+ [k: string]: any;
11
+ base64: boolean;
12
+ contentType?: string;
13
+ data: string;
14
+ mediaType?: string;
15
+ name?: string;
16
+ toBuffer: () => Buffer;
17
+ }
18
+ /**
19
+ * Parse a given data URL into its individual parts.
20
+ *
21
+ */
22
+ declare function parse(str: string): false | DataURL;
23
+
24
+ export { DataURL, parse, validate };
package/dist/index.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="node" />
2
1
  /**
3
2
  * Determine if a given data URL is valid or not.
4
3
  *
@@ -7,18 +6,19 @@
7
6
  * @see {@link http://tools.ietf.org/html/rfc2396#section2}
8
7
  */
9
8
  declare function validate(str: string): boolean;
10
- export declare type DataURL = {
11
- mediaType?: string;
12
- contentType?: string;
13
- name?: string;
9
+ interface DataURL {
10
+ [k: string]: any;
14
11
  base64: boolean;
12
+ contentType?: string;
15
13
  data: string;
14
+ mediaType?: string;
15
+ name?: string;
16
16
  toBuffer: () => Buffer;
17
- [k: string]: any;
18
- };
17
+ }
19
18
  /**
20
19
  * Parse a given data URL into its individual parts.
21
20
  *
22
21
  */
23
22
  declare function parse(str: string): false | DataURL;
24
- export { parse, validate };
23
+
24
+ export { DataURL, parse, validate };
package/dist/index.js CHANGED
@@ -1,52 +1,40 @@
1
- "use strict";
2
- exports.__esModule = true;
3
- exports.validate = exports.parse = void 0;
4
- var DATA_URL_REGEX =
5
- // eslint-disable-next-line unicorn/no-unsafe-regex
6
- /^data:([a-z]+\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\-._~:@/?%\s<>]*?)$/i;
7
- /**
8
- * Determine if a given data URL is valid or not.
9
- *
10
- * @see {@link https://developer.mozilla.org/en-US/docs/data_URIs}
11
- * @see {@link http://tools.ietf.org/html/rfc2397}
12
- * @see {@link http://tools.ietf.org/html/rfc2396#section2}
13
- */
1
+ 'use strict';
2
+
3
+ // src/index.ts
4
+ var DATA_URL_REGEX = /^data:([a-z]+\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\-._~:@/?%\s<>]*?)$/i;
14
5
  function validate(str) {
15
- return DATA_URL_REGEX.test((str || '').trim());
6
+ return DATA_URL_REGEX.test((str || "").trim());
16
7
  }
17
- exports.validate = validate;
18
- /**
19
- * Parse a given data URL into its individual parts.
20
- *
21
- */
22
8
  function parse(str) {
23
- if (!validate(str)) {
24
- return false;
25
- }
26
- var parts = str.trim().match(DATA_URL_REGEX);
27
- var parsed = {};
28
- if (parts[1]) {
29
- parsed.mediaType = parts[1].toLowerCase();
30
- var mediaTypeParts = parts[1].split(';').map(function (x) {
31
- // `name` attributes are for filenames so we shouldn't lowercase them as some filesystems are
32
- // case-sensitive.
33
- if (x.startsWith('name=')) {
34
- return x;
35
- }
36
- return x.toLowerCase();
37
- });
38
- parsed.contentType = mediaTypeParts[0];
39
- mediaTypeParts.slice(1).forEach(function (attribute) {
40
- var p = attribute.split('=');
41
- parsed[p[0]] = p[1];
42
- });
43
- }
44
- parsed.base64 = !!parts[parts.length - 2];
45
- parsed.data = parts[parts.length - 1] || '';
46
- parsed.toBuffer = function () {
47
- var encoding = parsed.base64 ? 'base64' : 'utf8';
48
- return Buffer.from(parsed.data, encoding);
49
- };
50
- return parsed;
9
+ if (!validate(str)) {
10
+ return false;
11
+ }
12
+ const parts = str.trim().match(DATA_URL_REGEX);
13
+ const parsed = {};
14
+ if (parts[1]) {
15
+ parsed.mediaType = parts[1].toLowerCase();
16
+ const mediaTypeParts = parts[1].split(";").map((x) => {
17
+ if (x.startsWith("name=")) {
18
+ return x;
19
+ }
20
+ return x.toLowerCase();
21
+ });
22
+ parsed.contentType = mediaTypeParts[0];
23
+ mediaTypeParts.slice(1).forEach((attribute) => {
24
+ const p = attribute.split("=");
25
+ parsed[p[0]] = p[1];
26
+ });
27
+ }
28
+ parsed.base64 = !!parts[parts.length - 2];
29
+ parsed.data = parts[parts.length - 1] || "";
30
+ parsed.toBuffer = () => {
31
+ const encoding = parsed.base64 ? "base64" : "utf8";
32
+ return Buffer.from(parsed.data, encoding);
33
+ };
34
+ return parsed;
51
35
  }
36
+
52
37
  exports.parse = parse;
38
+ exports.validate = validate;
39
+ //# sourceMappingURL=out.js.map
40
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAAA,IAAM,iBACJ;AASF,SAAS,SAAS,KAAa;AAC7B,SAAO,eAAe,MAAM,OAAO,IAAI,KAAK,CAAC;AAC/C;AAiBA,SAAS,MAAM,KAAa;AAC1B,MAAI,CAAC,SAAS,GAAG,GAAG;AAClB,WAAO;AAAA,EACT;AAEA,QAAM,QAAQ,IAAI,KAAK,EAAE,MAAM,cAAc;AAC7C,QAAM,SAAS,CAAC;AAEhB,MAAI,MAAM,CAAC,GAAG;AACZ,WAAO,YAAY,MAAM,CAAC,EAAE,YAAY;AAExC,UAAM,iBAAiB,MAAM,CAAC,EAAE,MAAM,GAAG,EAAE,IAAI,OAAK;AAGlD,UAAI,EAAE,WAAW,OAAO,GAAG;AACzB,eAAO;AAAA,MACT;AAEA,aAAO,EAAE,YAAY;AAAA,IACvB,CAAC;AAED,WAAO,cAAc,eAAe,CAAC;AAErC,mBAAe,MAAM,CAAC,EAAE,QAAQ,eAAa;AAC3C,YAAM,IAAI,UAAU,MAAM,GAAG;AAC7B,aAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAAA,IACpB,CAAC;AAAA,EACH;AAEA,SAAO,SAAS,CAAC,CAAC,MAAM,MAAM,SAAS,CAAC;AACxC,SAAO,OAAO,MAAM,MAAM,SAAS,CAAC,KAAK;AAEzC,SAAO,WAAW,MAAM;AACtB,UAAM,WAAW,OAAO,SAAS,WAAW;AAE5C,WAAO,OAAO,KAAK,OAAO,MAAM,QAAQ;AAAA,EAC1C;AAEA,SAAO;AACT","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 // eslint-disable-next-line @typescript-eslint/no-explicit-any\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"]}
package/dist/index.mjs ADDED
@@ -0,0 +1,37 @@
1
+ // src/index.ts
2
+ var DATA_URL_REGEX = /^data:([a-z]+\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\-._~:@/?%\s<>]*?)$/i;
3
+ function validate(str) {
4
+ return DATA_URL_REGEX.test((str || "").trim());
5
+ }
6
+ function parse(str) {
7
+ if (!validate(str)) {
8
+ return false;
9
+ }
10
+ const parts = str.trim().match(DATA_URL_REGEX);
11
+ const parsed = {};
12
+ if (parts[1]) {
13
+ parsed.mediaType = parts[1].toLowerCase();
14
+ const mediaTypeParts = parts[1].split(";").map((x) => {
15
+ if (x.startsWith("name=")) {
16
+ return x;
17
+ }
18
+ return x.toLowerCase();
19
+ });
20
+ parsed.contentType = mediaTypeParts[0];
21
+ mediaTypeParts.slice(1).forEach((attribute) => {
22
+ const p = attribute.split("=");
23
+ parsed[p[0]] = p[1];
24
+ });
25
+ }
26
+ parsed.base64 = !!parts[parts.length - 2];
27
+ parsed.data = parts[parts.length - 1] || "";
28
+ parsed.toBuffer = () => {
29
+ const encoding = parsed.base64 ? "base64" : "utf8";
30
+ return Buffer.from(parsed.data, encoding);
31
+ };
32
+ return parsed;
33
+ }
34
+
35
+ export { parse, validate };
36
+ //# sourceMappingURL=out.js.map
37
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAAA,IAAM,iBACJ;AASF,SAAS,SAAS,KAAa;AAC7B,SAAO,eAAe,MAAM,OAAO,IAAI,KAAK,CAAC;AAC/C;AAiBA,SAAS,MAAM,KAAa;AAC1B,MAAI,CAAC,SAAS,GAAG,GAAG;AAClB,WAAO;AAAA,EACT;AAEA,QAAM,QAAQ,IAAI,KAAK,EAAE,MAAM,cAAc;AAC7C,QAAM,SAAS,CAAC;AAEhB,MAAI,MAAM,CAAC,GAAG;AACZ,WAAO,YAAY,MAAM,CAAC,EAAE,YAAY;AAExC,UAAM,iBAAiB,MAAM,CAAC,EAAE,MAAM,GAAG,EAAE,IAAI,OAAK;AAGlD,UAAI,EAAE,WAAW,OAAO,GAAG;AACzB,eAAO;AAAA,MACT;AAEA,aAAO,EAAE,YAAY;AAAA,IACvB,CAAC;AAED,WAAO,cAAc,eAAe,CAAC;AAErC,mBAAe,MAAM,CAAC,EAAE,QAAQ,eAAa;AAC3C,YAAM,IAAI,UAAU,MAAM,GAAG;AAC7B,aAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAAA,IACpB,CAAC;AAAA,EACH;AAEA,SAAO,SAAS,CAAC,CAAC,MAAM,MAAM,SAAS,CAAC;AACxC,SAAO,OAAO,MAAM,MAAM,SAAS,CAAC,KAAK;AAEzC,SAAO,WAAW,MAAM;AACtB,UAAM,WAAW,OAAO,SAAS,WAAW;AAE5C,WAAO,OAAO,KAAK,OAAO,MAAM,QAAQ;AAAA,EAC1C;AAEA,SAAO;AACT","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 // eslint-disable-next-line @typescript-eslint/no-explicit-any\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"]}
package/package.json CHANGED
@@ -1,50 +1,50 @@
1
1
  {
2
2
  "name": "@readme/data-urls",
3
- "version": "1.0.1",
3
+ "version": "2.0.0",
4
4
  "description": "A utility for parsing and validating data URLs.",
5
+ "license": "ISC",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git@github.com:readmeio/data-urls.git"
9
+ },
10
+ "bugs": {
11
+ "url": "https://github.com/readmeio/data-urls/issues"
12
+ },
13
+ "homepage": "https://github.com/readmeio/data-urls#readme",
14
+ "exports": {
15
+ ".": {
16
+ "types": "./dist/index.d.ts",
17
+ "require": "./dist/index.js",
18
+ "import": "./dist/index.mjs"
19
+ },
20
+ "./package.json": "./package.json"
21
+ },
5
22
  "main": "dist/index.js",
23
+ "module": "dist/index.mjs",
6
24
  "types": "dist/index.d.ts",
25
+ "sideEffects": false,
7
26
  "engines": {
8
27
  "node": ">=14"
9
28
  },
10
29
  "scripts": {
11
- "build": "tsc",
30
+ "build": "tsup",
12
31
  "lint": "eslint . --ext .js,.ts",
13
32
  "prebuild": "rm -rf dist/",
14
33
  "prepack": "npm run build",
15
34
  "pretest": "npm run lint",
16
35
  "prettier": "prettier --list-different --write \"./**/**.{js,ts}\"",
17
- "release": "npx conventional-changelog-cli -i CHANGELOG.md -s",
18
- "test:browser": "karma start --single-run",
19
- "test:browser:chrome": "karma start --browsers=Chrome --single-run=false",
20
- "test:browser:debug": "karma start --single-run=false",
21
- "test": "nyc mocha \"test/**/*.test.ts\""
36
+ "test": "vitest --coverage",
37
+ "test:browser": "vitest --browser.name=chrome --browser.headless"
22
38
  },
23
- "repository": {
24
- "type": "git",
25
- "url": "git@github.com:readmeio/data-urls.git"
26
- },
27
- "license": "ISC",
28
- "bugs": {
29
- "url": "https://github.com/readmeio/data-urls/issues"
30
- },
31
- "homepage": "https://github.com/readmeio/data-urls#readme",
32
39
  "devDependencies": {
33
- "@jsdevtools/host-environment": "^2.1.2",
34
- "@jsdevtools/karma-config": "^3.1.7",
35
- "@readme/eslint-config": "^9.0.0",
36
- "@types/chai": "^4.3.1",
37
- "@types/mocha": "^9.1.1",
38
- "@types/node": "^18.0.0",
39
- "chai": "^4.3.4",
40
- "eslint": "^8.14.0",
41
- "mocha": "^10.0.0",
42
- "nyc": "^15.1.0",
43
- "prettier": "^2.6.2",
44
- "ts-loader": "^8.4.0",
45
- "ts-node": "^10.7.0",
46
- "typescript": "^4.6.3",
47
- "webpack": "^4.46.0"
40
+ "@readme/eslint-config": "^12.2.0",
41
+ "@types/node": "^20.3.3",
42
+ "@vitest/browser": "^0.34.3",
43
+ "@vitest/coverage-v8": "^0.34.3",
44
+ "eslint": "^8.44.0",
45
+ "prettier": "^3.0.3",
46
+ "tsup": "^7.2.0",
47
+ "typescript": "^5.1.6"
48
48
  },
49
49
  "browserslist": [
50
50
  "last 2 versions"
package/src/index.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  const DATA_URL_REGEX =
2
- // eslint-disable-next-line unicorn/no-unsafe-regex
3
2
  /^data:([a-z]+\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\-._~:@/?%\s<>]*?)$/i;
4
3
 
5
4
  /**
@@ -13,15 +12,16 @@ function validate(str: string) {
13
12
  return DATA_URL_REGEX.test((str || '').trim());
14
13
  }
15
14
 
16
- export type DataURL = {
17
- mediaType?: string;
18
- contentType?: string;
19
- name?: string;
15
+ export interface DataURL {
16
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
17
+ [k: string]: any;
20
18
  base64: boolean;
19
+ contentType?: string;
21
20
  data: string;
21
+ mediaType?: string;
22
+ name?: string;
22
23
  toBuffer: () => Buffer;
23
- [k: string]: any;
24
- };
24
+ }
25
25
 
26
26
  /**
27
27
  * Parse a given data URL into its individual parts.
package/tsconfig.json CHANGED
@@ -4,9 +4,11 @@
4
4
  "baseUrl": "./src",
5
5
  "declaration": true,
6
6
  "esModuleInterop": true,
7
- "lib": ["dom", "es2020"],
7
+ "lib": ["DOM", "ES2020"],
8
+ "moduleResolution": "node",
8
9
  "noImplicitAny": true,
9
- "outDir": "dist/"
10
+ "outDir": "dist/",
11
+ "target": "ES2020"
10
12
  },
11
13
  "include": ["./src/**/*"]
12
14
  }
package/tsup.config.ts ADDED
@@ -0,0 +1,20 @@
1
+ import type { Options } from 'tsup';
2
+
3
+ // eslint-disable-next-line import/no-extraneous-dependencies
4
+ import { defineConfig } from 'tsup';
5
+
6
+ export default defineConfig((options: Options) => ({
7
+ ...options,
8
+
9
+ cjsInterop: true,
10
+ clean: true,
11
+ dts: true,
12
+ entry: ['src/index.ts'],
13
+ format: ['esm', 'cjs'],
14
+ minify: false,
15
+ shims: true,
16
+ silent: !options.watch,
17
+ sourcemap: true,
18
+ splitting: true,
19
+ treeshake: true,
20
+ }));
package/CHANGELOG.md DELETED
@@ -1,14 +0,0 @@
1
- ## <small>1.0.1 (2022-07-27)</small>
2
-
3
- * fix: don't lowercase `name` attributes - some filesystems are case-sensitive ([7b43a4d](https://github.com/readmeio/data-urls/commit/7b43a4d))
4
- * docs: adding a changelog ([5218189](https://github.com/readmeio/data-urls/commit/5218189))
5
-
6
-
7
-
8
- ## 1.0.0 (2022-07-27)
9
-
10
- * docs: adding some demos to the readme ([dd6316f](https://github.com/readmeio/data-urls/commit/dd6316f))
11
- * feat: initial commit ([afa3344](https://github.com/readmeio/data-urls/commit/afa3344))
12
-
13
-
14
-