fast-uri 2.0.0 → 2.2.0

package/.github/workflows/ci.yml

@@ -13,3 +13,5 @@ on:
 jobs:
   test:
     uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
+    with:
+      license-check: true

package/.github/workflows/package-manager-ci.yml

@@ -5,6 +5,9 @@ on:
     branches:
       - master
 
+permissions:
+  contents: read
+
 jobs:
   pnpm:
     runs-on: ${{ matrix.os }}
@@ -12,26 +15,25 @@ jobs:
     strategy:
       matrix:
         # Maintenance and active LTS
-        node-version: [10, 12, 14, 16]
-        os: [ubuntu-latest]
+        node-version: [14, 16]
+        os: [ubuntu-18.04]
 
     steps:
       - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
 
       - name: Use Node.js
-        uses: actions/setup-node@v3.1.1
-        id: setup_node
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Install with pnpm
-        id: install_package_manager
         run: |
           curl -L https://unpkg.com/@pnpm/self-installer | node
           pnpm install
 
       - name: Run tests
-        id: test
         run: |
           pnpm run test
 
@@ -41,25 +43,24 @@ jobs:
     strategy:
       matrix:
         # Maintenance and active LTS
-        node-version: [10, 12, 14, 16]
-        os: [ubuntu-latest]
+        node-version: [14, 16]
+        os: [ubuntu-18.04]
 
     steps:
       - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
 
       - name: Use Node.js
-        id: setup_node
-        uses: actions/setup-node@v3.1.1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Install with yarn
-        id: install_package_manager
         run: |
           curl -o- -L https://yarnpkg.com/install.sh | bash
           yarn install --ignore-engines
 
       - name: Run tests
-        id: test
         run: |
           yarn run test

package/README.md

@@ -2,7 +2,7 @@
 
 <div align="center">
 
-[![CI](https://github.com/fastify/fastify/workflows/ci/badge.svg)](https://github.com/fastify/fast-uri/actions/workflows/ci.yml)
+[![CI](https://github.com/fastify/fast-uri/actions/workflows/ci.yml/badge.svg)](https://github.com/fastify/fast-uri/actions/workflows/ci.yml)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
 
 </div>
@@ -122,4 +122,4 @@ urijs: resolve x 225,759 ops/sec ±0.37% (95 runs sampled)
 
 - [ ] Support MailTo
 - [ ] Be 100% iso compatible with uri-js
-- [ ] Add browser test stack
+- [ ] Add browser test stack

package/index.js

@@ -126,6 +126,10 @@ function serialize (cmpts, opts) {
   if (components.path !== undefined) {
     if (!options.skipEscape) {
       components.path = escape(components.path)
+
+      if (components.scheme !== undefined) {
+        components.path = components.path.split('%3A').join(':')
+      }
     } else {
       components.path = unescape(components.path)
     }
@@ -175,7 +179,6 @@ function serialize (cmpts, opts) {
 }
 
 const URI_PARSE = /^(?:([^:/?#]+):)?(?:\/\/((?:([^/?#@]*)@)?(\[[^/?#\]]+\]|[^/?#:]*)(?::(\d*))?))?([^?#]*)(?:\?([^#]*))?(?:#((?:.|\n|\r)*))?/i
-const NO_MATCH_IS_UNDEFINED = ('').match(/(){0}/)[1] === undefined
 
 function parse (uri, opts) {
   const options = Object.assign({}, opts)
@@ -194,34 +197,18 @@ function parse (uri, opts) {
   const matches = uri.match(URI_PARSE)
 
   if (matches) {
-    if (NO_MATCH_IS_UNDEFINED) {
-      // store each component
-      parsed.scheme = matches[1]
-      parsed.userinfo = matches[3]
-      parsed.host = matches[4]
-      parsed.port = parseInt(matches[5], 10)
-      parsed.path = matches[6] || ''
-      parsed.query = matches[7]
-      parsed.fragment = matches[8]
-
-      // fix port number
-      if (isNaN(parsed.port)) {
-        parsed.port = matches[5]
-      }
-    } else { // IE FIX for improper RegExp matching
-      // store each component
-      parsed.scheme = matches[1] || undefined
-      parsed.userinfo = (uri.indexOf('@') !== -1 ? matches[3] : undefined)
-      parsed.host = (uri.indexOf('//') !== -1 ? matches[4] : undefined)
-      parsed.port = parseInt(matches[5], 10)
-      parsed.path = matches[6] || ''
-      parsed.query = (uri.indexOf('?') !== -1 ? matches[7] : undefined)
-      parsed.fragment = (uri.indexOf('#') !== -1 ? matches[8] : undefined)
-
-      // fix port number
-      if (isNaN(parsed.port)) {
-        parsed.port = (uri.match(/\/\/(?:.|\n)*:(?:\/|\?|#|$)/) ? matches[4] : undefined)
-      }
+    // store each component
+    parsed.scheme = matches[1]
+    parsed.userinfo = matches[3]
+    parsed.host = matches[4]
+    parsed.port = parseInt(matches[5], 10)
+    parsed.path = matches[6] || ''
+    parsed.query = matches[7]
+    parsed.fragment = matches[8]
+
+    // fix port number
+    if (isNaN(parsed.port)) {
+      parsed.port = matches[5]
     }
     if (parsed.host) {
       const ipv4result = normalizeIPv4(parsed.host)
@@ -291,7 +278,7 @@ function parse (uri, opts) {
   return parsed
 }
 
-module.exports = {
+const fastUri = {
   normalize,
   resolve,
   resolveComponents,
@@ -299,3 +286,7 @@ module.exports = {
   serialize,
   parse
 }
+
+module.exports = fastUri
+module.exports.default = fastUri
+module.exports.fastUri = fastUri

package/lib/utils.js

@@ -7,7 +7,7 @@ function normalizeIPv4 (host) {
   const matches = host.match(/^(\b25[0-5]|\b2[0-4][0-9]|\b[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/) || []
   const [address] = matches
   if (address) {
-    return { host: stripLeadingZeros(address, '.', false), isIPV4: true }
+    return { host: stripLeadingZeros(address, '.'), isIPV4: true }
   } else {
     return { host, isIPV4: false }
   }
@@ -92,7 +92,7 @@ function getIPV6 (input) {
 
 function normalizeIPv6 (host, opts = {}) {
   if (findToken(host, ':') < 2) { return { host, isIPV6: false } }
-  const ipv6 = getIPV6(host, opts.isIPV4)
+  const ipv6 = getIPV6(host)
 
   if (!ipv6.error) {
     let newHost = ipv6.address

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "fast-uri",
   "description": "Dependency free RFC 3986 URI toolbox",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "main": "index.js",
   "type": "commonjs",
-  "types": "index.d.ts",
+  "types": "types/index.d.ts",
   "license": "MIT",
   "author": "Vincent Le Goff <vince.legoff@gmail.com> (https://github.com/zekth)",
   "repository": {
@@ -31,8 +31,7 @@
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
     "tap": "^16.0.0",
-    "tsd": "^0.20.0",
-    "typescript": "^4.4.4",
+    "tsd": "^0.24.1",
     "uri-js": "^4.4.1"
   },
   "dependencies": {},

package/test/compatibility.test.js

@@ -111,6 +111,10 @@ test('compatibility serialize', (t) => {
       host: 'example.com',
       resourceName: '/foo?bar',
       secure: true
+    },
+    {
+      scheme: 'scheme',
+      path: 'with:colon'
     }
   ]
   toSerialize.forEach((x) => {

package/test/equal.test.js

@@ -4,12 +4,21 @@ const tap = require('tap')
 const test = tap.test
 const URI = require('../')
 
-test('URI Equals', (t) => {
-  // test from RFC 3986
-  t.equal(URI.equal('example://a/b/c/%7Bfoo%7D', 'eXAMPLE://a/./b/../b/%63/%7bfoo%7d'), true)
+const fn = URI.equal
+const runTest = (t, suite) => {
+  suite.forEach(s => {
+    const operator = s.result ? '==' : '!='
+    t.equal(fn(s.pair[0], s.pair[1]), s.result, `${s.pair[0]} ${operator} ${s.pair[1]}`)
+    t.equal(fn(s.pair[1], s.pair[0]), s.result, `${s.pair[1]} ${operator} ${s.pair[0]}`)
+  })
+}
 
-  // test from RFC 3987
-  t.equal(URI.equal('http://example.org/~user', 'http://example.org/%7euser'), true)
+test('URI Equals', (t) => {
+  const suite = [
+    { pair: ['example://a/b/c/%7Bfoo%7D', 'eXAMPLE://a/./b/../b/%63/%7bfoo%7d'], result: true }, // test from RFC 3986
+    { pair: ['http://example.org/~user', 'http://example.org/%7euser'], result: true } // test from RFC 3987
+  ]
+  runTest(t, suite)
   t.end()
 })
 
@@ -20,39 +29,55 @@ test('URI Equals', (t) => {
 //   })
 
 test('HTTP Equals', (t) => {
-  // test from RFC 2616
-  t.equal(URI.equal('http://abc.com:80/~smith/home.html', 'http://abc.com/~smith/home.html'), true)
-  t.equal(URI.equal({ scheme: 'http', host: 'abc.com', port: 80, path: '/~smith/home.html' }, 'http://abc.com/~smith/home.html'), true)
-  t.equal(URI.equal('http://ABC.com/%7Esmith/home.html', 'http://abc.com/~smith/home.html'), true)
-  t.equal(URI.equal('http://ABC.com:/%7esmith/home.html', 'http://abc.com/~smith/home.html'), true)
-  t.equal(URI.equal('HTTP://ABC.COM', 'http://abc.com/'), true)
-  // test from RFC 3986
-  t.equal(URI.equal('http://example.com:/', 'http://example.com:80/'), true)
+  const suite = [
+    // test from RFC 2616
+    { pair: ['http://abc.com:80/~smith/home.html', 'http://abc.com/~smith/home.html'], result: true },
+    { pair: [{ scheme: 'http', host: 'abc.com', port: 80, path: '/~smith/home.html' }, 'http://abc.com/~smith/home.html'], result: true },
+    { pair: ['http://ABC.com/%7Esmith/home.html', 'http://abc.com/~smith/home.html'], result: true },
+    { pair: ['http://ABC.com:/%7esmith/home.html', 'http://abc.com/~smith/home.html'], result: true },
+    { pair: ['HTTP://ABC.COM', 'http://abc.com/'], result: true },
+    // test from RFC 3986
+    { pair: ['http://example.com:/', 'http://example.com:80/'], result: true }
+  ]
+  runTest(t, suite)
   t.end()
 })
 
 test('HTTPS Equals', (t) => {
-  t.equal(URI.equal('https://example.com', 'https://example.com:443/'), true)
-  t.equal(URI.equal('https://example.com:/', 'https://example.com:443/'), true)
+  const suite = [
+    { pair: ['https://example.com', 'https://example.com:443/'], result: true },
+    { pair: ['https://example.com:/', 'https://example.com:443/'], result: true }
+  ]
+  runTest(t, suite)
   t.end()
 })
 
 test('URN Equals', (t) => {
-  // test from RFC 2141
-  t.equal(URI.equal('urn:foo:a123,456', 'urn:foo:a123,456'), true)
-  t.equal(URI.equal('urn:foo:a123,456', 'URN:foo:a123,456'), true)
-  t.equal(URI.equal('urn:foo:a123,456', 'urn:FOO:a123,456'), true)
+  const suite = [
+    // test from RFC 2141
+    { pair: ['urn:foo:a123,456', 'urn:foo:a123,456'], result: true },
+    { pair: ['urn:foo:a123,456', 'URN:foo:a123,456'], result: true },
+    { pair: ['urn:foo:a123,456', 'urn:FOO:a123,456'], result: true }
+  ]
 
   // Disabling for now as the whole equal logic might need
   // to be refactored
   // t.equal(URI.equal('urn:foo:a123,456', 'urn:foo:A123,456'), false)
   // t.equal(URI.equal('urn:foo:a123%2C456', 'URN:FOO:a123%2c456'), true)
+
+  runTest(t, suite)
   t.end()
 })
+
 test('UUID Equals', (t) => {
-  t.equal(URI.equal('URN:UUID:F81D4FAE-7DEC-11D0-A765-00A0C91E6BF6', 'urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6'), true)
+  const suite = [
+    { pair: ['URN:UUID:F81D4FAE-7DEC-11D0-A765-00A0C91E6BF6', 'urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6'], result: true }
+  ]
+
+  runTest(t, suite)
   t.end()
 })
+
 // test('Mailto Equals', (t) => {
 //   // tests from RFC 6068
 //   t.equal(URI.equal('mailto:addr1@an.example,addr2@an.example', 'mailto:?to=addr1@an.example,addr2@an.example'), true)
@@ -61,11 +86,19 @@ test('UUID Equals', (t) => {
 // })
 
 test('WS Equal', (t) => {
-  t.equal(URI.equal('WS://ABC.COM:80/chat#one', 'ws://abc.com/chat'), true)
+  const suite = [
+    { pair: ['WS://ABC.COM:80/chat#one', 'ws://abc.com/chat'], result: true }
+  ]
+
+  runTest(t, suite)
   t.end()
 })
 
 test('WSS Equal', (t) => {
-  t.equal(URI.equal('WSS://ABC.COM:443/chat#one', 'wss://abc.com/chat'), true)
+  const suite = [
+    { pair: ['WSS://ABC.COM:443/chat#one', 'wss://abc.com/chat'], result: true }
+  ]
+
+  runTest(t, suite)
   t.end()
 })

package/types/index.d.ts

@@ -0,0 +1,53 @@
+type FastUri = typeof fastUri
+
+declare namespace fastUri {
+  export interface URIComponent {
+    scheme?: string;
+    userinfo?: string;
+    host?: string;
+    port?: number | string;
+    path?: string;
+    query?: string;
+    fragment?: string;
+    reference?: string;
+    error?: string;
+  }
+  export interface Options {
+    scheme?: string;
+    reference?: string;
+    unicodeSupport?: boolean;
+    domainHost?: boolean;
+    absolutePath?: boolean;
+    tolerant?: boolean;
+  }
+
+  /**
+   * @deprecated Use Options instead
+   */
+  export type options = Options
+  /**
+   * @deprecated Use URIComponent instead
+   */
+  export type URIComponents = URIComponent
+
+  export function normalize(uri: string, opts?: Options): string;
+  export function normalize(uri: URIComponent, opts?: Options): URIComponent;
+  export function normalize(uri: any, opts?: Options): any;
+
+  export function resolve(baseURI: string, relativeURI: string, options?: Options): string
+
+  export function resolveComponent(base: URIComponent, relative: URIComponent, options?: Options, skipNormalization?: boolean): URIComponent
+
+  export function parse(uri: string, opts?: Options): URIComponent;
+
+  export function serialize(component: URIComponent, opts?: Options): string;
+
+  export function equal(uriA: string, uriB: string): boolean;
+
+  export function resolve(base: string, path: string): string;
+
+  export const fastUri: FastUri
+  export { fastUri as default }
+}
+
+export = fastUri

package/types/index.test-d.ts

@@ -0,0 +1,17 @@
+import uri, { URIComponents, URIComponent, Options, options } from "..";
+import { expectDeprecated, expectType } from "tsd";
+
+const parsed = uri.parse("foo");
+expectType<URIComponents>(parsed);
+const parsed2 = uri.parse("foo", {
+    domainHost: true,
+    scheme: 'https',
+    unicodeSupport: false
+})
+expectType<URIComponents>(parsed2);
+
+expectType<URIComponent>({} as URIComponents)
+expectDeprecated({} as URIComponents)
+
+expectType<Options>({} as options)
+expectDeprecated({} as options)

package/index.d.ts

@@ -1,27 +0,0 @@
-export interface URIComponents {
-  scheme?: string;
-  userinfo?: string;
-  host?: string;
-  port?: number | string;
-  path?: string;
-  query?: string;
-  fragment?: string;
-  reference?: string;
-  error?: string;
-}
-export interface options {
-  scheme?: string;
-  reference?: string;
-  unicodeSupport?: boolean;
-  domainHost?: boolean;
-  absolutePath?: boolean;
-  tolerant?:boolean;
-}
-
-export function parse(uri: string, opts?: options): URIComponents;
-
-export function serialize(component: URIComponents, opts?: options): string;
-
-export function equal(uriA: string, uriB:string): boolean;
-
-export function resolve(base:string, path:string): string;

package/index.test-d.ts

@@ -1,11 +0,0 @@
-import uri, { URIComponents } from ".";
-import { expectType } from "tsd";
-
-const parsed = uri.parse("foo");
-expectType<URIComponents>(parsed);
-const parsed2 = uri.parse("foo", {
-    domainHost: true,
-    scheme: 'https',
-    unicodeSupport: false
-})
-expectType<URIComponents>(parsed2);