fast-uri 0.0.1

package/.github/.stale.yml

@@ -0,0 +1,21 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 15
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - "discussion"
+  - "feature request"
+  - "bug"
+  - "help wanted"
+  - "plugin suggestion"
+  - "good first issue"
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

package/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: '/'
+    ignore:
+      - dependency-name: "actions/*"
+        update-types:
+            ["version-update:semver-minor", "version-update:semver-patch"]
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10

package/.github/tests_checker.yml

@@ -0,0 +1,8 @@
+comment: |
+  Hello! Thank you for contributing!
+  It appears that you have changed the code, but the tests that verify your change are missing. Could you please add them?
+fileExtensions:
+  - '.ts'
+  - '.js'
+
+testDir: 'test'

package/.github/workflows/ci.yml

@@ -0,0 +1,84 @@
+name: CI
+
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
+
+env:
+  CI: true
+  COVERALLS: 0
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        # Maintenance and active LTS
+        node-version: [10, 12, 14, 16]
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+    name: Node ${{ matrix.node-version }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js
+        id: setup_node
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install Dependencies
+        id: install
+        run: npm install --ignore-scripts
+
+      - name: Check licenses
+        id: license_check
+        run: |
+          npm run license-checker --if-present
+
+      # Unit and lint tests
+      - name: Tests
+        id: test
+        run: npm run test:ci
+
+      - name: Coveralls Parallel
+        id: coveralls-parallel
+        continue-on-error: true
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          parallel: true
+          flag-name: run-${{ matrix.node-version }}-${{ matrix.os }}
+
+      - name: Should Trigger coverallsapp/github-action@master
+        id: coveralls-trigger
+        # https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context
+        # when continue-on-error failed, outcome is failure and conclusion is success
+        if: steps.coveralls-parallel.conclusion == 'success' && steps.coveralls-parallel.outcome != 'success'
+        run: |
+          echo "::set-output name=COVERALLS_TRIGGER::failure"
+          
+  coverage:
+    needs: test
+    runs-on: ubuntu-latest
+    if: needs.test.outputs.COVERALLS != 'failure'
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true
+
+  automerge:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: fastify/github-action-merge-dependabot@v2.7.1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

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

@@ -0,0 +1,65 @@
+name: package-manager-ci
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  pnpm:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        # Maintenance and active LTS
+        node-version: [10, 12, 14, 16]
+        os: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js
+        uses: actions/setup-node@v2
+        id: setup_node
+        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
+
+  yarn:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        # Maintenance and active LTS
+        node-version: [10, 12, 14, 16]
+        os: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js
+        id: setup_node
+        uses: actions/setup-node@v2
+        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/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2021 The Fastify Team
+Copyright (c) 2011-2021, Gary Court until https://github.com/garycourt/uri-js/commit/a1acf730b4bba3f1097c9f52e7d9d3aba8cdcaae
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * The names of any contributors may not be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+                                  *   *   *
+
+The complete list of contributors can be found at:
+- https://github.com/garycourt/uri-js/graphs/contributors

package/README.md

@@ -0,0 +1,121 @@
+# fast-uri
+
+<div align="center">
+
+[![CI](https://github.com/fastify/fastify/workflows/ci/badge.svg)](https://github.com/fastify/fast-uri/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/fastify/fast-uri/badge.svg?branch=add_coveralls)](https://coveralls.io/github/fastify/fast-uri?branch=main)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
+
+</div>
+
+Dependency free RFC 3986 URI toolbox.
+
+## Usage
+
+## Options
+
+All of the above functions can accept an additional options argument that is an object that can contain one or more of the following properties:
+
+*	`scheme` (string)
+	Indicates the scheme that the URI should be treated as, overriding the URI's normal scheme parsing behavior.
+
+*	`reference` (string)
+	If set to `"suffix"`, it indicates that the URI is in the suffix format and the parser will use the option's `scheme` property to determine the URI's scheme.
+
+*	`tolerant` (boolean, false)
+	If set to `true`, the parser will relax URI resolving rules.
+
+*	`absolutePath` (boolean, false)
+	If set to `true`, the serializer will not resolve a relative `path` component.
+
+*	`unicodeSupport` (boolean, false)
+	If set to `true`, the parser will unescape non-ASCII characters in the parsed output as per [RFC 3987](http://www.ietf.org/rfc/rfc3987.txt).
+
+*	`domainHost` (boolean, false)
+	If set to `true`, the library will treat the `host` component as a domain name, and convert IDNs (International Domain Names) as per [RFC 5891](http://www.ietf.org/rfc/rfc5891.txt).
+
+### Parse
+
+```js
+const uri = require('fast-uri')
+uri.parse('uri://user:pass@example.com:123/one/two.three?q1=a1&q2=a2#body')
+// Output
+{
+  scheme : "uri",
+  userinfo : "user:pass",
+  host : "example.com",
+  port : 123,
+  path : "/one/two.three",
+  query : "q1=a1&q2=a2",
+  fragment : "body"
+}
+```
+
+### Serialize
+
+```js
+const uri = require('fast-uri')
+uri.serialize({scheme : "http", host : "example.com", fragment : "footer"})
+// Output
+"http://example.com/#footer"
+
+```
+
+### Resolve
+
+```js
+const uri = require('fast-uri')
+uri.resolve("uri://a/b/c/d?q", "../../g") 
+// Output
+"uri://a/g"
+```
+
+### Equal
+
+```js
+const uri = require('fast-uri')
+uri.equal("example://a/b/c/%7Bfoo%7D", "eXAMPLE://a/./b/../b/%63/%7bfoo%7d")
+// Output
+true
+```
+
+## Scheme supports
+
+fast-uri supports inserting custom [scheme](http://en.wikipedia.org/wiki/URI_scheme) dependent processing rules. Currently, fast-uri has built in support for the following schemes:
+
+*	http \[[RFC 2616](http://www.ietf.org/rfc/rfc2616.txt)\]
+*	https \[[RFC 2818](http://www.ietf.org/rfc/rfc2818.txt)\]
+*	ws \[[RFC 6455](http://www.ietf.org/rfc/rfc6455.txt)\]
+*	wss \[[RFC 6455](http://www.ietf.org/rfc/rfc6455.txt)\]
+*	urn \[[RFC 2141](http://www.ietf.org/rfc/rfc2141.txt)\]
+*	urn:uuid \[[RFC 4122](http://www.ietf.org/rfc/rfc4122.txt)\]
+
+
+## Benchmarks
+
+```
+fast-uri: parse domain x 1,344,963 ops/sec ±0.31% (99 runs sampled)
+urijs: parse domain x 485,273 ops/sec ±0.20% (98 runs sampled)
+fast-uri: parse IPv4 x 2,429,284 ops/sec ±0.18% (98 runs sampled)
+urijs: parse IPv4 x 391,142 ops/sec ±0.11% (99 runs sampled)
+fast-uri: parse IPv6 x 948,434 ops/sec ±0.35% (100 runs sampled)
+urijs: parse IPv6 x 293,538 ops/sec ±0.09% (97 runs sampled)
+fast-uri: parse URN x 2,639,216 ops/sec ±0.10% (99 runs sampled)
+urijs: parse URN x 1,175,357 ops/sec ±0.36% (95 runs sampled)
+fast-uri: parse URN uuid x 1,654,986 ops/sec ±0.15% (97 runs sampled)
+urijs: parse URN uuid x 870,033 ops/sec ±0.43% (96 runs sampled)
+fast-uri: serialize uri x 1,804,227 ops/sec ±0.26% (100 runs sampled)
+urijs: serialize uri x 394,736 ops/sec ±0.21% (99 runs sampled)
+fast-uri: serialize IPv6 x 451,489 ops/sec ±0.11% (100 runs sampled)
+urijs: serialize IPv6 x 263,908 ops/sec ±0.13% (99 runs sampled)
+fast-uri: serialize ws x 1,412,927 ops/sec ±0.49% (96 runs sampled)
+urijs: serialize ws x 353,774 ops/sec ±0.17% (99 runs sampled)
+fast-uri: resolve x 350,311 ops/sec ±0.96% (97 runs sampled)
+urijs: resolve x 228,281 ops/sec ±0.18% (100 runs sampled)
+```
+
+## TODO
+
+- [ ] Support MailTo
+- [ ] Be 100% iso compatible with uri-js
+- [ ] Add browser test stack

package/benchmark.js

@@ -0,0 +1,88 @@
+const benchmark = require('benchmark')
+const suite = new benchmark.Suite()
+const fasturi = require('./')
+const urijs = require('uri-js')
+
+const base = 'uri://a/b/c/d;p?q'
+// Initialization as there is a lot to parse at first
+// eg: regexes
+fasturi.parse('https://example.com')
+urijs.parse('https://example.com')
+
+suite.add('fast-uri: parse domain', function () {
+  fasturi.parse('https://example.com')
+})
+suite.add('urijs: parse domain', function () {
+  urijs.parse('https://example.com')
+})
+suite.add('fast-uri: parse IPv4', function () {
+  fasturi.parse('//10.10.10.10')
+})
+suite.add('urijs: parse IPv4', function () {
+  urijs.parse('//10.10.10.10')
+})
+suite.add('fast-uri: parse IPv6', function () {
+  fasturi.parse('//[2001:db8::7]')
+})
+suite.add('urijs: parse IPv6', function () {
+  urijs.parse('//[2001:db8::7]')
+})
+suite.add('fast-uri: parse URN', function () {
+  fasturi.parse('urn:foo:a123,456')
+})
+suite.add('urijs: parse URN', function () {
+  urijs.parse('urn:foo:a123,456')
+})
+suite.add('fast-uri: parse URN uuid', function () {
+  fasturi.parse('urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6')
+})
+suite.add('urijs: parse URN uuid', function () {
+  urijs.parse('urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6')
+})
+suite.add('fast-uri: serialize uri', function () {
+  fasturi.serialize({
+    scheme: 'uri',
+    userinfo: 'foo:bar',
+    host: 'example.com',
+    port: 1,
+    path: 'path',
+    query: 'query',
+    fragment: 'fragment'
+  })
+})
+suite.add('urijs: serialize uri', function () {
+  urijs.serialize({
+    scheme: 'uri',
+    userinfo: 'foo:bar',
+    host: 'example.com',
+    port: 1,
+    path: 'path',
+    query: 'query',
+    fragment: 'fragment'
+  })
+})
+suite.add('fast-uri: serialize IPv6', function () {
+  fasturi.serialize({ host: '2606:2800:220:1:248:1893:25c8:1946' })
+})
+suite.add('urijs: serialize IPv6', function () {
+  urijs.serialize({ host: '2606:2800:220:1:248:1893:25c8:1946' })
+})
+suite.add('fast-uri: serialize ws', function () {
+  fasturi.serialize({ scheme: 'ws', host: 'example.com', resourceName: '/foo?bar', secure: true })
+})
+suite.add('urijs: serialize ws', function () {
+  urijs.serialize({ scheme: 'ws', host: 'example.com', resourceName: '/foo?bar', secure: true })
+})
+suite.add('fast-uri: resolve', function () {
+  fasturi.resolve(base, '../../../g')
+})
+suite.add('urijs: resolve', function () {
+  urijs.resolve(base, '../../../g')
+})
+suite.on('cycle', cycle)
+
+suite.run()
+
+function cycle (e) {
+  console.log(e.target.toString())
+}

package/index.d.ts

@@ -0,0 +1,26 @@
+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;
+}
+
+export function parse(uri: string, opts?: options): URIComponents;
+
+export function serialize(component: URIComponents): string;
+
+export function equal(uriA: string, uriB:string): boolean;
+
+export function resolve(base:string, path:string): string;