yggdryl 0.1.0

package/README.md

@@ -0,0 +1,30 @@
+# yggdryl (Node.js)
+
+Node.js bindings for [**yggdryl**](https://github.com/Platob/yggdryl), backed by
+the Rust `yggdryl` core crate (via [napi-rs](https://napi.rs)).
+
+## Build
+
+```bash
+npm install
+npm run build            # napi build --platform --release
+npm test                 # node --test
+```
+
+## Usage
+
+```javascript
+const { Uri, Url } = require('yggdryl')
+
+const uri = new Uri('urn:isbn:0451450523')
+console.log(uri.scheme)        // urn
+console.log(uri.path)          // isbn:0451450523
+
+const url = new Url('https://user:pw@example.com:8443/api?v=1#top')
+console.log(url.host)          // example.com
+console.log(url.port)          // 8443
+console.log(url.username)      // user
+console.log(url.toString())    // https://user:pw@example.com:8443/api?v=1#top
+```
+
+Invalid input throws.

package/index.d.ts

@@ -0,0 +1,53 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+/** A generic RFC 3986 URI: `scheme:[//authority]path[?query][#fragment]`. */
+export declare class Uri {
+  /** Parse `value` into a `Uri`, throwing on failure. */
+  constructor(value: string)
+  /** Alias for the constructor. */
+  static parse(value: string): Uri
+  get scheme(): string
+  get authority(): string | null
+  get path(): string
+  get query(): string | null
+  get fragment(): string | null
+  toString(): string
+}
+/**
+ * A URL: a URI that always has an authority, split into `username`, `password`,
+ * `host` and `port`.
+ */
+export declare class Url {
+  /** Parse `value` into a `Url`, throwing on failure. */
+  constructor(value: string)
+  /** Alias for the constructor. */
+  static parse(value: string): Url
+  get scheme(): string
+  get username(): string | null
+  get password(): string | null
+  get host(): string
+  get port(): number | null
+  get path(): string
+  get query(): string | null
+  get fragment(): string | null
+  get authority(): string
+  toString(): string
+}
+/** A generic `major.minor.patch` version, ordered numerically. */
+export declare class Version {
+  /** Construct from components. */
+  constructor(major: number, minor: number, patch: number)
+  /** Parse a `major[.minor[.patch]]` string, throwing on failure. */
+  static parse(value: string): Version
+  get major(): number
+  get minor(): number
+  get patch(): number
+  /** Compare with another version: `-1`, `0` or `1`. */
+  compare(other: Version): number
+  /** `true` if the two versions are equal. */
+  equals(other: Version): boolean
+  toString(): string
+}

package/index.js

@@ -0,0 +1,317 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'yggdryl.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./yggdryl.android-arm64.node')
+          } else {
+            nativeBinding = require('yggdryl-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'yggdryl.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./yggdryl.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('yggdryl-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'yggdryl.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./yggdryl.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('yggdryl-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'yggdryl.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./yggdryl.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('yggdryl-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'yggdryl.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./yggdryl.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('yggdryl-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'yggdryl.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./yggdryl.darwin-universal.node')
+      } else {
+        nativeBinding = require('yggdryl-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'yggdryl.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./yggdryl.darwin-x64.node')
+          } else {
+            nativeBinding = require('yggdryl-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'yggdryl.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./yggdryl.darwin-arm64.node')
+          } else {
+            nativeBinding = require('yggdryl-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'yggdryl.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./yggdryl.freebsd-x64.node')
+      } else {
+        nativeBinding = require('yggdryl-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'yggdryl.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./yggdryl.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('yggdryl-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'yggdryl.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./yggdryl.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('yggdryl-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'yggdryl.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./yggdryl.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('yggdryl-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'yggdryl.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./yggdryl.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('yggdryl-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'yggdryl.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./yggdryl.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('yggdryl-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'yggdryl.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./yggdryl.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('yggdryl-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'yggdryl.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./yggdryl.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('yggdryl-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'yggdryl.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./yggdryl.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('yggdryl-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'yggdryl.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./yggdryl.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('yggdryl-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { Uri, Url, Version } = nativeBinding
+
+module.exports.Uri = Uri
+module.exports.Url = Url
+module.exports.Version = Version

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "yggdryl",
+  "version": "0.1.0",
+  "description": "yggdryl — a Rust-core URI/URL library, exposed to Node.js",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Platob/yggdryl.git"
+  },
+  "homepage": "https://github.com/Platob/yggdryl",
+  "keywords": ["uri", "url", "parser", "rust", "napi", "yggdryl"],
+  "napi": {
+    "name": "yggdryl",
+    "triples": {
+      "defaults": false,
+      "additional": ["x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc"]
+    }
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "test": "node --test"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.0"
+  },
+  "files": ["index.js", "index.d.ts", "*.node"]
+}