This is an automated email from the ASF dual-hosted git repository.
chaokunyang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fory.git
The following commit(s) were added to refs/heads/main by this push:
new 72fd91cd1 chore(javascript): rename foryjs to apache-fory and remove
install docs (#2544)
72fd91cd1 is described below
commit 72fd91cd13bfbc282f240d9889d76c469b230de5
Author: Shawn Yang <[email protected]>
AuthorDate: Thu Aug 28 18:26:29 2025 +0800
chore(javascript): rename foryjs to apache-fory and remove install docs
(#2544)
<!--
**Thanks for contributing to Fory.**
**If this is your first time opening a PR on fory, you can refer to
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).**
Contribution Checklist
- The **Apache Fory** community has requirements on the naming of pr
titles. You can also find instructions in
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).
- Fory has a strong focus on performance. If the PR you submit will have
an impact on performance, please benchmark it first and provide the
benchmark result here.
-->
## Why?
<!-- Describe the purpose of this PR. -->
## What does this PR do?
<!-- Describe the details of this PR. -->
## Related issues
<!--
Is there any related issue? If this PR closes them you say say
fix/closes:
- #xxxx0
- #xxxx1
- Fixes #xxxx2
-->
## Does this PR introduce any user-facing change?
<!--
If any user-facing interface changes, please [open an
issue](https://github.com/apache/fory/issues/new/choose) describing the
need to do so and update the document if necessary.
Delete section if not applicable.
-->
- [ ] Does this PR introduce any public API change?
- [ ] Does this PR introduce any binary protocol compatibility change?
## Benchmark
<!--
When the PR has an impact on performance (if you don't know whether the
PR will have an impact on performance, you can submit the PR first, and
if it will have impact on performance, the code reviewer will explain
it), be sure to attach a benchmark data here.
Delete section if not applicable.
-->
---
README.md | 6 ------
docs/guide/xlang_serialization_guide.md | 18 +++++++++---------
javascript/README.md | 13 +++----------
javascript/benchmark/index.js | 6 +++---
javascript/benchmark/map.js | 4 ++--
javascript/benchmark/platform-buffer.js | 10 +++++-----
javascript/package-lock.json | 10 +++++-----
javascript/packages/fory/package.json | 2 +-
javascript/packages/hps/package.json | 2 +-
javascript/test/hps.test.ts | 2 +-
10 files changed, 30 insertions(+), 43 deletions(-)
diff --git a/README.md b/README.md
index cd38e3ea6..96d56e815 100644
--- a/README.md
+++ b/README.md
@@ -162,12 +162,6 @@ libraryDependencies += "org.apache.fory" % "fory-scala_3"
% "0.12.0"
pip install pyfory
```
-### JavaScript
-
-```bash
-npm install @foryjs/fory
-```
-
### Golang
```bash
diff --git a/docs/guide/xlang_serialization_guide.md
b/docs/guide/xlang_serialization_guide.md
index cb21f1f26..8ba8c379d 100644
--- a/docs/guide/xlang_serialization_guide.md
+++ b/docs/guide/xlang_serialization_guide.md
@@ -109,14 +109,14 @@ func main() {
**JavaScript**
```javascript
-import Fory from "@foryjs/fory";
+import Fory from "@apache-fory/fory";
/**
- * @foryjs/hps use v8's fast-calls-api that can be called directly by jit,
ensure that the version of Node is 20 or above.
+ * @apache-fory/hps use v8's fast-calls-api that can be called directly by
jit, ensure that the version of Node is 20 or above.
* Experimental feature, installation success cannot be guaranteed at this
moment
* If you are unable to install the module, replace it with `const hps = null;`
**/
-import hps from "@foryjs/hps";
+import hps from "@apache-fory/hps";
const fory = new Fory({ hps });
const input = fory.serialize("hello fory");
@@ -328,14 +328,14 @@ func main() {
**JavaScript**
```javascript
-import Fory, { Type, InternalSerializerType } from "@foryjs/fory";
+import Fory, { Type, InternalSerializerType } from "@apache-fory/fory";
/**
- * @foryjs/hps use v8's fast-calls-api that can be called directly by jit,
ensure that the version of Node is 20 or above.
+ * @apache-fory/hps use v8's fast-calls-api that can be called directly by
jit, ensure that the version of Node is 20 or above.
* Experimental feature, installation success cannot be guaranteed at this
moment
* If you are unable to install the module, replace it with `const hps = null;`
**/
-import hps from "@foryjs/hps";
+import hps from "@apache-fory/hps";
// Now we describe data structures using JSON, but in the future, we will use
more ways.
const description = Type.object("example.foo", {
@@ -502,13 +502,13 @@ func main() {
**JavaScript**
```javascript
-import Fory, { Type } from '@foryjs/fory';
+import Fory, { Type } from '@apache-fory/fory';
/**
- * @foryjs/hps use v8's fast-calls-api that can be called directly by jit,
ensure that the version of Node is 20 or above.
+ * @apache-fory/hps use v8's fast-calls-api that can be called directly by
jit, ensure that the version of Node is 20 or above.
* Experimental feature, installation success cannot be guaranteed at this
moment
* If you are unable to install the module, replace it with `const hps = null;`
**/
-import hps from '@foryjs/hps';
+import hps from '@apache-fory/hps';
const description = Type.object('example.foo', {
foo: Type.string(),
diff --git a/javascript/README.md b/javascript/README.md
index fe5b7fe4d..6ed9a8fa1 100644
--- a/javascript/README.md
+++ b/javascript/README.md
@@ -4,24 +4,17 @@ Javascript implementation for the Fory protocol.
The Cross-Language part of the protocol is not stable, so the output of this
library may change in the future. Please be cautious when using it in a
production environment.
-## Install
-
-```shell
-npm install @foryjs/fory
-npm install @foryjs/hps
-```
-
## Usage
```Javascript
-import Fory, { Type, InternalSerializerType } from '@foryjs/fory';
+import Fory, { Type, InternalSerializerType } from '@apache-fory/fory';
/**
- * @foryjs/hps use v8's fast-calls-api that can be called directly by jit,
ensure that the version of Node is 20 or above.
+ * @apache-fory/hps use v8's fast-calls-api that can be called directly by
jit, ensure that the version of Node is 20 or above.
* Experimental feature, installation success cannot be guaranteed at this
moment
* If you are unable to install the module, replace it with `const hps = null;`
**/
-import hps from '@foryjs/hps';
+import hps from '@apache-fory/hps';
// Now we describe data structures using JSON, but in the future, we will use
more ways.
const typeInfo = Type.struct('example.foo', {
diff --git a/javascript/benchmark/index.js b/javascript/benchmark/index.js
index 84d83d4ec..50d46726c 100644
--- a/javascript/benchmark/index.js
+++ b/javascript/benchmark/index.js
@@ -17,9 +17,9 @@
* under the License.
*/
-const Fory = require("@foryjs/fory");
-const utils = require("@foryjs/fory/dist/lib/util");
-const hps = require('@foryjs/hps').default;
+const Fory = require("@apache-fory/fory");
+const utils = require("@apache-fory/fory/dist/lib/util");
+const hps = require('@apache-fory/hps').default;
const fory = new Fory.default({ hps, refTracking: false, useSliceString: true
});
const Benchmark = require("benchmark");
const protobuf = require("protobufjs");
diff --git a/javascript/benchmark/map.js b/javascript/benchmark/map.js
index 8f8a0d18d..ddfa20946 100644
--- a/javascript/benchmark/map.js
+++ b/javascript/benchmark/map.js
@@ -17,9 +17,9 @@
* under the License.
*/
-const Fory = require("@foryjs/fory");
+const Fory = require("@apache-fory/fory");
const beautify = require("js-beautify");
-const hps = require('@foryjs/hps');
+const hps = require('@apache-fory/hps');
const fory = new Fory.default({
hps, refTracking: false, useSliceString: true, hooks: {
afterCodeGenerated: (code) => {
diff --git a/javascript/benchmark/platform-buffer.js
b/javascript/benchmark/platform-buffer.js
index 1cfd6eeee..f49718edd 100644
--- a/javascript/benchmark/platform-buffer.js
+++ b/javascript/benchmark/platform-buffer.js
@@ -17,7 +17,7 @@
* under the License.
*/
-const { BrowserBuffer } = require('@foryjs/fory/dist/lib/platformBuffer')
+const { BrowserBuffer } = require('@apache-fory/fory/dist/lib/platformBuffer')
const Benchmark = require("benchmark");
const { spawn } = require("child_process");
@@ -55,8 +55,8 @@ async function start() {
});
})
.run({ async: false });
- console.log("Write operation per second")
- console.table(result.writeComparison);
+ console.log("Write operation per second")
+ console.table(result.writeComparison);
}
{
@@ -79,8 +79,8 @@ async function start() {
});
})
.run({ async: false });
- console.log("toString operation per second")
- console.table(result.toStringComparison);
+ console.log("toString operation per second")
+ console.table(result.toStringComparison);
}
const args = ['platform-buffer-draw.py', result.writeComparison['browser
utf8Write'], result.writeComparison['browser write'],
result.writeComparison['native write'], result.toStringComparison['browser
toString'], result.toStringComparison['native toString']];
diff --git a/javascript/package-lock.json b/javascript/package-lock.json
index 545489598..908fc79a2 100644
--- a/javascript/package-lock.json
+++ b/javascript/package-lock.json
@@ -548,11 +548,11 @@
"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
}
},
- "node_modules/@foryjs/fory": {
+ "node_modules/@apache-fory/fory": {
"resolved": "packages/fory",
"link": true
},
- "node_modules/@foryjs/hps": {
+ "node_modules/@apache-fory/hps": {
"resolved": "packages/hps",
"link": true
},
@@ -6133,7 +6133,7 @@
}
},
"packages/fory": {
- "name": "@foryjs/fory",
+ "name": "@apache-fory/fory",
"version": "0.13.0.dev",
"license": "Apache-2.0",
"workspaces": [
@@ -6166,7 +6166,7 @@
"license": "MIT"
},
"packages/hps": {
- "name": "@foryjs/hps",
+ "name": "@apache-fory/hps",
"version": "0.13.0.dev",
"hasInstallScript": true,
"license": "Apache-2.0",
@@ -6470,4 +6470,4 @@
}
}
}
-}
+}
\ No newline at end of file
diff --git a/javascript/packages/fory/package.json
b/javascript/packages/fory/package.json
index e30e9f631..48e567e12 100644
--- a/javascript/packages/fory/package.json
+++ b/javascript/packages/fory/package.json
@@ -1,5 +1,5 @@
{
- "name": "@foryjs/fory",
+ "name": "@apache-fory/fory",
"version": "0.13.0.dev",
"description": "Apache Fory™ is a blazingly fast multi-language
serialization framework powered by jit and zero-copy",
"main": "dist/index.js",
diff --git a/javascript/packages/hps/package.json
b/javascript/packages/hps/package.json
index 03fa1d040..b4161e3b5 100644
--- a/javascript/packages/hps/package.json
+++ b/javascript/packages/hps/package.json
@@ -1,5 +1,5 @@
{
- "name": "@foryjs/hps",
+ "name": "@apache-fory/hps",
"version": "0.13.0.dev",
"description": "Apache Fory™ nodejs high-performance suite",
"main": "dist/index.js",
diff --git a/javascript/test/hps.test.ts b/javascript/test/hps.test.ts
index 6296fda89..cb040cebf 100644
--- a/javascript/test/hps.test.ts
+++ b/javascript/test/hps.test.ts
@@ -17,7 +17,7 @@
* under the License.
*/
-import { BinaryReader } from '@foryjs/fory';
+import { BinaryReader } from '@apache-fory/fory';
import hps from '../packages/hps/index';
import { describe, expect, test } from '@jest/globals';
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
