@readme/data-urls 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 1.0.0 (2022-07-27)
+
+* docs: adding some demos to the readme ([dd6316f](https://github.com/readmeio/data-urls/commit/dd6316f))
+* feat: initial commit ([afa3344](https://github.com/readmeio/data-urls/commit/afa3344))
+
+
+

package/LICENSE

@@ -0,0 +1,67 @@
+Copyright (c) 2022, ReadMe
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
+
+---
+
+## parse-data-url
+https://github.com/killmenot/parse-data-url
+
+The MIT License (MIT)
+
+Copyright (c) Alexey Kucherenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+## valid-data-url
+https://github.com/killmenot/valid-data-url
+
+The MIT License (MIT)
+
+Copyright (c) Alexey Kucherenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# @readme/data-urls
+A utility for parsing and validating [data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
+
+[![CI](https://github.com/readmeio/data-urls/workflows/CI/badge.svg)](https://github.com/readmeio/data-urls/)
+[![](https://img.shields.io/npm/v/@readme/data-urls)](https://npm.im/@readme/data-urls)
+[![License](https://img.shields.io/npm/l/@readme/data-urls.svg)](LICENSE)
+
+[![](https://d3vv6lp55qjaqc.cloudfront.net/items/1M3C3j0I0s0j3T362344/Untitled-2.png)](https://readme.io)
+
+This library is a loose fork of [parse-data-url](https://npm.im/parse-data-url) and [valid-data-url](https://npm.im/valid-data-url).
+
+## Installation
+
+```
+npm install --save @readme/data-urls
+```
+
+## Usage
+```js
+import { parse, validate } from '@readme/data-urls';
+
+const url = '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==';
+
+console.log(validate(url)); // true
+console.log(parse(url));
+```
+
+```js
+{
+  mediaType: 'image/png;name=owlbert-shrub.png',
+  contentType: 'image/png',
+  name: 'owlbert-shrub.png',
+  base64: true,
+  data: 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAACNUlEQVR4AWJkIA2wCQHqJgcouZ0ADv+SmayR28PibPOP2jafzdp6Lh/v2bVt2+1zbdvtbtbMpGfmvmD8jStc9uB3v75gdNmqtJqsa6qCDEBPRVH7XpKk1P9yHLZv3mG6keV9BIsWGqNuvNaiy+YoARFIXFXwf6Frjz/X9oS4LNRkty4QH/0MSnnWDHORHV3pJsiozRk0zWW/9MEi0A9ffqOhf5RRDW6SGLT/ZXcT8C1hWvao8iF1c4ecKx5eejW1bii1y1asW14P5XsUNkogmvVQg2aPLOnrqss9qE81OYlAucRrN/LrqlBSWYufv34jq7gKseA7MCr0IOhffForGsTWDBJnqE2/B0H+hKRRG3DtxEGk6QBZQ9UFClMSnTJe/cCVI5uQJJpx+8AyOBUPPv+JIpJjgJqCZzKT0AGdAgT/1OLtSzsKI2/gspnxvGExZYFADcoSsqM10SADF4jC4TCCUDN8nih+eoIgPAdGeajBNxyMH20JwsPNMwSicUjBCAwmAZ6GkCmA7I+qCxTGRHSkVzZiCRmKAsRkuVmWiENrt6gL5Di7iw4oogFSINIkCTU09hNAP64CREPUBbzAx9ABrc2I3w2NeY5DMByHu8AGY3YyeoKIuSmBWCD6OuqLPJXe/Dpvkb3FuoDbdENKuBVJ4nxZJpKgWoUXCMcYUwBwDfR8FxZPN4wfWK2Zunq7tGLmZMOc7x7ZUn/RuDmrX0H/4FffQ2teylCecuWmDNsTnainfwFPuNZTR3MemwAAAABJRU5ErkJggg==',
+  toBuffer: [Function (anonymous)]
+}
+```

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+/**
+ * Determine if a given data URL is valid or not.
+ *
+ * @see {@link https://developer.mozilla.org/en-US/docs/data_URIs}
+ * @see {@link http://tools.ietf.org/html/rfc2397}
+ * @see {@link http://tools.ietf.org/html/rfc2396#section2}
+ */
+declare function validate(str: string): boolean;
+export declare type DataURL = {
+    mediaType?: string;
+    contentType?: string;
+    base64: boolean;
+    data: string;
+    toBuffer: () => Buffer;
+    [k: string]: any;
+};
+/**
+ * Parse a given data URL into its individual parts.
+ *
+ */
+declare function parse(str: string): false | DataURL;
+export { parse, validate };

package/dist/index.js

@@ -0,0 +1,45 @@
+"use strict";
+exports.__esModule = true;
+exports.validate = exports.parse = void 0;
+var DATA_URL_REGEX = 
+// eslint-disable-next-line unicorn/no-unsafe-regex
+/^data:([a-z]+\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\-._~:@/?%\s<>]*?)$/i;
+/**
+ * Determine if a given data URL is valid or not.
+ *
+ * @see {@link https://developer.mozilla.org/en-US/docs/data_URIs}
+ * @see {@link http://tools.ietf.org/html/rfc2397}
+ * @see {@link http://tools.ietf.org/html/rfc2396#section2}
+ */
+function validate(str) {
+    return DATA_URL_REGEX.test((str || '').trim());
+}
+exports.validate = validate;
+/**
+ * Parse a given data URL into its individual parts.
+ *
+ */
+function parse(str) {
+    if (!validate(str)) {
+        return false;
+    }
+    var parts = str.trim().match(DATA_URL_REGEX);
+    var parsed = {};
+    if (parts[1]) {
+        parsed.mediaType = parts[1].toLowerCase();
+        var mediaTypeParts = parts[1].split(';').map(function (x) { return x.toLowerCase(); });
+        parsed.contentType = mediaTypeParts[0];
+        mediaTypeParts.slice(1).forEach(function (attribute) {
+            var p = attribute.split('=');
+            parsed[p[0]] = p[1];
+        });
+    }
+    parsed.base64 = !!parts[parts.length - 2];
+    parsed.data = parts[parts.length - 1] || '';
+    parsed.toBuffer = function () {
+        var encoding = parsed.base64 ? 'base64' : 'utf8';
+        return Buffer.from(parsed.data, encoding);
+    };
+    return parsed;
+}
+exports.parse = parse;

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@readme/data-urls",
+  "version": "1.0.0",
+  "description": "A utility for parsing and validating data URLs.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "engines": {
+    "node": ">=14"
+  },
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint . --ext .js,.ts",
+    "prebuild": "rm -rf dist/",
+    "prepack": "npm run build",
+    "pretest": "npm run lint",
+    "prettier": "prettier --list-different --write \"./**/**.{js,ts}\"",
+    "release": "npx conventional-changelog-cli -i CHANGELOG.md -s",
+    "test:browser": "karma start --single-run",
+    "test:browser:chrome": "karma start --browsers=Chrome --single-run=false",
+    "test:browser:debug": "karma start --single-run=false",
+    "test": "nyc mocha \"test/**/*.test.ts\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:readmeio/data-urls.git"
+  },
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/readmeio/data-urls/issues"
+  },
+  "homepage": "https://github.com/readmeio/data-urls#readme",
+  "devDependencies": {
+    "@jsdevtools/host-environment": "^2.1.2",
+    "@jsdevtools/karma-config": "^3.1.7",
+    "@readme/eslint-config": "^9.0.0",
+    "@types/chai": "^4.3.1",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.0.0",
+    "chai": "^4.3.4",
+    "eslint": "^8.14.0",
+    "mocha": "^10.0.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.6.2",
+    "ts-loader": "^8.4.0",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.3",
+    "webpack": "^4.46.0"
+  },
+  "browserslist": [
+    "last 2 versions"
+  ],
+  "prettier": "@readme/eslint-config/prettier"
+}

package/src/index.ts

@@ -0,0 +1,62 @@
+const DATA_URL_REGEX =
+  // eslint-disable-next-line unicorn/no-unsafe-regex
+  /^data:([a-z]+\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\-._~:@/?%\s<>]*?)$/i;
+
+/**
+ * Determine if a given data URL is valid or not.
+ *
+ * @see {@link https://developer.mozilla.org/en-US/docs/data_URIs}
+ * @see {@link http://tools.ietf.org/html/rfc2397}
+ * @see {@link http://tools.ietf.org/html/rfc2396#section2}
+ */
+function validate(str: string) {
+  return DATA_URL_REGEX.test((str || '').trim());
+}
+
+export type DataURL = {
+  mediaType?: string;
+  contentType?: string;
+  base64: boolean;
+  data: string;
+  toBuffer: () => Buffer;
+  [k: string]: any;
+};
+
+/**
+ * Parse a given data URL into its individual parts.
+ *
+ */
+function parse(str: string) {
+  if (!validate(str)) {
+    return false;
+  }
+
+  const parts = str.trim().match(DATA_URL_REGEX);
+  const parsed = {} as DataURL;
+
+  if (parts[1]) {
+    parsed.mediaType = parts[1].toLowerCase();
+
+    const mediaTypeParts = parts[1].split(';').map(x => x.toLowerCase());
+
+    parsed.contentType = mediaTypeParts[0];
+
+    mediaTypeParts.slice(1).forEach(attribute => {
+      const p = attribute.split('=');
+      parsed[p[0]] = p[1];
+    });
+  }
+
+  parsed.base64 = !!parts[parts.length - 2];
+  parsed.data = parts[parts.length - 1] || '';
+
+  parsed.toBuffer = () => {
+    const encoding = parsed.base64 ? 'base64' : 'utf8';
+
+    return Buffer.from(parsed.data, encoding);
+  };
+
+  return parsed;
+}
+
+export { parse, validate };

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "baseUrl": "./src",
+    "declaration": true,
+    "esModuleInterop": true,
+    "lib": ["dom", "es2020"],
+    "noImplicitAny": true,
+    "outDir": "dist/"
+  },
+  "include": ["./src/**/*"]
+}