interscript 2.4.5 → 3.0.0

package/package.json

@@ -1,27 +1,87 @@
 {
   "name": "interscript",
-  "version": "2.4.5",
-  "description": "Interscript JS bindings",
-  "main": "./src/stdlib.js",
-  "repository": "git@github.com:interscript/interscript.git",
-  "author": "Ribose Inc. <open.source@ribose.com>",
+  "version": "3.0.0",
+  "description": "Interscript TypeScript runtime — interoperable script conversion",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./ml": {
+      "types": "./dist/ml/index.d.ts",
+      "import": "./dist/ml/index.js"
+    },
+    "./loaders.node": {
+      "types": "./dist/loaders.node.d.ts",
+      "import": "./dist/loaders.node.js"
+    },
+    "./cli": "./dist/cli.js",
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "interscript": "./dist/cli.js"
+  },
+  "sideEffects": [
+    "dist/ml/models/**/*.js"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
-    "test": "mocha",
-    "prepareMaps": "cd ../ruby; bundle install --without=\"secryst jsexec\"; bundle exec rake compile[javascript,../js/src/maps];"
+    "build": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:parity": "vitest run test/parity",
+    "test:coverage": "vitest run --coverage",
+    "test:bench": "vitest bench",
+    "lint": "eslint src test",
+    "format": "prettier --write 'src/**/*.ts' 'test/**/*.ts'",
+    "format:check": "prettier --check 'src/**/*.ts' 'test/**/*.ts'",
+    "gen:parity": "ruby scripts/gen-parity-fixtures.rb > test/fixtures/parity.json",
+    "prepublishOnly": "npm run build"
   },
-  "license": "BSD-2-Clause",
-  "dependencies": {
-    "xregexp": "^5.0.1"
+  "keywords": [
+    "transliteration",
+    "romanization",
+    "script-conversion",
+    "i18n",
+    "interscript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/interscript/interscript-ts.git"
   },
-  "directories": {
-    "test": "test"
+  "author": "Ribose Inc. <open.source@ribose.com>",
+  "license": "BSD-2-Clause",
+  "bugs": {
+    "url": "https://github.com/interscript/interscript-ts/issues"
   },
+  "homepage": "https://github.com/interscript/interscript-ts#readme",
   "devDependencies": {
-    "mocha": "^8.1.3"
+    "@eslint/js": "^10.0.1",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^4.1.10",
+    "eslint": "^10.8.0",
+    "eslint-config-prettier": "^10.1.0",
+    "onnxruntime-node": "^1.27.0",
+    "playwright": "^1.62.0",
+    "prettier": "^3.9.0",
+    "typescript": "^5.6.0",
+    "typescript-eslint": "^8.65.0",
+    "vitest": "^4.1.0"
   },
-  "files": [
-    "/src",
-    "/test",
-    "/README.adoc"
-  ]
+  "dependencies": {
+    "fflate": "^0.8.3",
+    "js-yaml": "^5.3.0"
+  }
 }

package/LICENSE.md

@@ -1,31 +0,0 @@
-# Licenses & Copyright
-
-This license file adheres to the formatting guidelines of
-https://github.com/nevir/readable-licenses[readable-licenses].
-
-
-## Ribose BSD 2-Clause License
-
-Copyright (c) 2019-, https://www.ribose.com[Ribose Inc].
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
-1.  Redistributions of source code must retain the above copyright notice,
-    this list of conditions and the following disclaimer.
-
-2.  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.
-
-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 OWNER OR 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.

package/README.adoc

@@ -1,78 +0,0 @@
-= Interscript-JS: Interoperable Script Conversion Systems for JavaScript
-
-== Purpose
-
-This repository contains code for the Interscript JavaScript runtime ("Interscript-JS").
-
-This software allows performing script conversions by using the
-https://github.com/interscript/maps[default set of Interscript maps]
-hosted at GitHub.
-
-Interscript is a project for interoperable script conversion systems
-and provides executable runtimes for multiple platforms.
-Full documentation available https://github.com/interscript/interscript/[here].
-
-
-== Integration
-
-This section provides instructions on how to utilize Interscript-JS
-with your application.
-
-Interscript-JS can be used as a JS NPM library and integrated with
-other JS applications.
-
-=== Configuration for NPM
-
-[source,shell]
-----
-$ npm install interscript
-----
-
-== Usage
-
-=== Usage in Node.js
-
-[source,javascript]
------
-var Interscript = require('interscript');
-Interscript.load_map('bgnpcgn-ukr-Cyrl-Latn-2019').then(function() {
-  alert(Interscript.transliterate('bgnpcgn-ukr-Cyrl-Latn-2019', prompt()));
-});
------
-
-
-=== Usage in web browsers
-
-Please consult `js/index.html`.
-
-
-=== Usage in Webpack
-
-This library should be mostly compatible with webpack. It may be necessary to
-supply a path to the maps, as those are not bundled by default.
-
-To do so, you need to do something like:
-
-[source,javascript]
------
-Interscript.map_path = "/node_modules/interscript/src/maps/";
------
-
-
-=== Getting a list of available maps
-
-The following code retrieves the full list of maps available.
-
-[source,javascript]
------
-Interscript.load_map_list().then(function() {
-  var list = Interscript.map_list();
-});
------
-
-
-== Copyright & license
-
-This is a Ribose project. Copyright Ribose.
-
-License: BSD 2-clause