@common.js/ip-regex 5.0.0

package/README.md

@@ -0,0 +1,5 @@
+# @common.js/ip-regex
+
+The [ip-regex](https://www.npmjs.com/package/ip-regex) package exported as CommonJS modules.
+
+Exported from [ip-regex@5.0.0](https://www.npmjs.com/package/ip-regex/v/5.0.0) using https://github.com/etienne-martin/common.js.

package/index.d.ts

@@ -0,0 +1,68 @@
+export interface Options {
+	/**
+	Only match an exact string. Useful with `RegExp#test()` to check if a string is an IP address. *(`false` matches any IP address in a string)*
+
+	@default false
+	*/
+	readonly exact?: boolean;
+
+	/**
+	Include boundaries in the regex. When `true`, `192.168.0.2000000000` will report as an invalid IPv4 address. If this option is not set, the mentioned IPv4 address would report as valid (ignoring the trailing zeros).
+
+	@default false
+	*/
+	readonly includeBoundaries?: boolean;
+}
+
+declare const ipRegex: {
+	/**
+	Regular expression for matching IP addresses.
+
+	@returns A regex for matching both IPv4 and IPv6.
+
+	@example
+	```
+	import ipRegex from 'ip-regex';
+
+	// Contains an IP address?
+	ipRegex().test('unicorn 192.168.0.1');
+	//=> true
+
+	// Is an IP address?
+	ipRegex({exact: true}).test('unicorn 192.168.0.1');
+	//=> false
+
+	'unicorn 192.168.0.1 cake 1:2:3:4:5:6:7:8 rainbow'.match(ipRegex());
+	//=> ['192.168.0.1', '1:2:3:4:5:6:7:8']
+
+	// Contains an IP address?
+	ipRegex({includeBoundaries: true}).test('192.168.0.2000000000');
+	//=> false
+
+	// Matches an IP address?
+	'192.168.0.2000000000'.match(ipRegex({includeBoundaries: true}));
+	//=> null
+	```
+	*/
+	(options?: Options): RegExp;
+
+	/**
+	@returns A regex for matching IPv4.
+	*/
+	v4(options?: Options): RegExp;
+
+	/**
+	@returns A regex for matching IPv6.
+
+	@example
+	```
+	import ipRegex from 'ip-regex';
+
+	ipRegex.v6({exact: true}).test('1:2:3:4:5:6:7:8');
+	//=> true
+	```
+	*/
+	v6(options?: Options): RegExp;
+};
+
+export default ipRegex;

package/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+var word = "[a-fA-F\\d:]";
+var boundry = function(options) {
+    return options && options.includeBoundaries ? "(?:(?<=\\s|^)(?=".concat(word, ")|(?<=").concat(word, ")(?=\\s|$))") : "";
+};
+var v4 = "(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}";
+var v6segment = "[a-fA-F\\d]{1,4}";
+var v6 = "\n(?:\n(?:".concat(v6segment, ":){7}(?:").concat(v6segment, "|:)|                                    // 1:2:3:4:5:6:7::  1:2:3:4:5:6:7:8\n(?:").concat(v6segment, ":){6}(?:").concat(v4, "|:").concat(v6segment, "|:)|                             // 1:2:3:4:5:6::    1:2:3:4:5:6::8   1:2:3:4:5:6::8  1:2:3:4:5:6::1.2.3.4\n(?:").concat(v6segment, ":){5}(?::").concat(v4, "|(?::").concat(v6segment, "){1,2}|:)|                   // 1:2:3:4:5::      1:2:3:4:5::7:8   1:2:3:4:5::8    1:2:3:4:5::7:1.2.3.4\n(?:").concat(v6segment, ":){4}(?:(?::").concat(v6segment, "){0,1}:").concat(v4, "|(?::").concat(v6segment, "){1,3}|:)| // 1:2:3:4::        1:2:3:4::6:7:8   1:2:3:4::8      1:2:3:4::6:7:1.2.3.4\n(?:").concat(v6segment, ":){3}(?:(?::").concat(v6segment, "){0,2}:").concat(v4, "|(?::").concat(v6segment, "){1,4}|:)| // 1:2:3::          1:2:3::5:6:7:8   1:2:3::8        1:2:3::5:6:7:1.2.3.4\n(?:").concat(v6segment, ":){2}(?:(?::").concat(v6segment, "){0,3}:").concat(v4, "|(?::").concat(v6segment, "){1,5}|:)| // 1:2::            1:2::4:5:6:7:8   1:2::8          1:2::4:5:6:7:1.2.3.4\n(?:").concat(v6segment, ":){1}(?:(?::").concat(v6segment, "){0,4}:").concat(v4, "|(?::").concat(v6segment, "){1,6}|:)| // 1::              1::3:4:5:6:7:8   1::8            1::3:4:5:6:7:1.2.3.4\n(?::(?:(?::").concat(v6segment, "){0,5}:").concat(v4, "|(?::").concat(v6segment, "){1,7}|:))             // ::2:3:4:5:6:7:8  ::2:3:4:5:6:7:8  ::8             ::1.2.3.4\n)(?:%[0-9a-zA-Z]{1,})?                                             // %eth0            %1\n").replace(/\s*\/\/.*$/gm, "").replace(/\n/g, "").trim();
+// Pre-compile only the exact regexes because adding a global flag make regexes stateful
+var v46Exact = new RegExp("(?:^".concat(v4, "$)|(?:^").concat(v6, "$)"));
+var v4exact = new RegExp("^".concat(v4, "$"));
+var v6exact = new RegExp("^".concat(v6, "$"));
+var ipRegex = function(options) {
+    return options && options.exact ? v46Exact : new RegExp("(?:".concat(boundry(options)).concat(v4).concat(boundry(options), ")|(?:").concat(boundry(options)).concat(v6).concat(boundry(options), ")"), "g");
+};
+ipRegex.v4 = function(options) {
+    return options && options.exact ? v4exact : new RegExp("".concat(boundry(options)).concat(v4).concat(boundry(options)), "g");
+};
+ipRegex.v6 = function(options) {
+    return options && options.exact ? v6exact : new RegExp("".concat(boundry(options)).concat(v6).concat(boundry(options)), "g");
+};
+var _default = ipRegex;

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+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/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@common.js/ip-regex",
+  "version": "5.0.0",
+  "description": "Regular expression for matching IP addresses (IPv4 & IPv6)",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "type": "commonjs",
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "devDependencies": {
+    "ava": "^3.15.0",
+    "tsd": "^0.19.1",
+    "xo": "^0.47.0"
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "dependencies": {},
+  "main": "./index.js"
+}

package/readme.md

@@ -0,0 +1,77 @@
+# ip-regex
+
+> Regular expression for matching IP addresses
+
+## Install
+
+```sh
+$ npm install ip-regex
+```
+
+This module targets Node.js 12 or later and the latest version of Chrome, Firefox, and Safari. If you want support for older browsers, use version 2.1.0: `npm install ip-regex@2.1.0`
+
+## Usage
+
+```js
+import ipRegex from 'ip-regex';
+
+// Contains an IP address?
+ipRegex().test('unicorn 192.168.0.1');
+//=> true
+
+// Is an IP address?
+ipRegex({exact: true}).test('unicorn 192.168.0.1');
+//=> false
+
+ipRegex.v6({exact: true}).test('1:2:3:4:5:6:7:8');
+//=> true
+
+'unicorn 192.168.0.1 cake 1:2:3:4:5:6:7:8 rainbow'.match(ipRegex());
+//=> ['192.168.0.1', '1:2:3:4:5:6:7:8']
+
+// Contains an IP address?
+ipRegex({includeBoundaries: true}).test('192.168.0.2000000000');
+//=> false
+
+// Matches an IP address?
+'192.168.0.2000000000'.match(ipRegex({includeBoundaries: true}));
+//=> null
+```
+
+## API
+
+### ipRegex(options?)
+
+Returns a regex for matching both IPv4 and IPv6.
+
+### ipRegex.v4(options?)
+
+Returns a regex for matching IPv4.
+
+### ipRegex.v6(options?)
+
+Returns a regex for matching IPv6.
+
+#### options
+
+Type: `object`
+
+##### exact
+
+Type: `boolean`\
+Default: `false` *(Matches any IP address in a string)*
+
+Only match an exact string. Useful with `RegExp#test()` to check if a string is an IP address.
+
+##### includeBoundaries
+
+Type: `boolean`\
+Default: `false`
+
+Include boundaries in the regex. When `true`, `192.168.0.2000000000` will report as an invalid IPv4 address. If this option is not set, the mentioned IPv4 address would report as valid (ignoring the trailing zeros).
+
+## Related
+
+- [is-ip](https://github.com/sindresorhus/is-ip) - Check if a string is an IP address
+- [is-cidr](https://github.com/silverwind/is-cidr) - Check if a string is an IP address in CIDR notation
+- [cidr-regex](https://github.com/silverwind/cidr-regex) - Regular expression for matching IP addresses in CIDR notation