Prepare the NPM package for release (#6616)

Author: robertbastian

examples/npm/package-lock.json

@@ -6,7 +6,7 @@
 	  "start": "node dist/main.js"
 	},
 	"dependencies": {
-	  "icu4x": "file:../../ffi/npm"
+	  "icu": "file:../../ffi/npm"
 	},
 	"devDependencies": {
 	  "typescript": "^4.7.4"

examples/npm/package.json

@@ -1,8 +1,12 @@
-import { Decimal, DecimalFormatter, DecimalGroupingStrategy, Locale } from "icu4x";
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
 
-var locale = Locale.fromString("bn");
+import { Decimal, DecimalFormatter, DecimalGroupingStrategy, Locale } from 'icu';
+
+var locale = Locale.fromString('bn');
 var groupingStrategy = DecimalGroupingStrategy.Auto;
-var decimal = Decimal.fromString("123");
+var decimal = Decimal.fromString('123');
 
 var formatter = DecimalFormatter.createWithGroupingStrategy(
     locale,

examples/npm/src/main.ts

@@ -0,0 +1,46 @@
+UNICODE LICENSE V3
+
+COPYRIGHT AND PERMISSION NOTICE
+
+Copyright © 2020-2024 Unicode, Inc.
+
+NOTICE TO USER: Carefully read the following legal agreement. BY
+DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING DATA FILES, AND/OR
+SOFTWARE, YOU UNEQUIVOCALLY ACCEPT, AND AGREE TO BE BOUND BY, ALL OF THE
+TERMS AND CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE, DO NOT
+DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE THE DATA FILES OR SOFTWARE.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of data files and any associated documentation (the "Data Files") or
+software and any associated documentation (the "Software") to deal in the
+Data Files or Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, and/or sell
+copies of the Data Files or Software, and to permit persons to whom the
+Data Files or Software are furnished to do so, provided that either (a)
+this copyright and permission notice appear with all copies of the Data
+Files or Software, or (b) this copyright and permission notice appear in
+associated Documentation.
+
+THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
+THIRD PARTY RIGHTS.
+
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE
+BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES,
+OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE DATA
+FILES OR SOFTWARE.
+
+Except as contained in this notice, the name of a copyright holder shall
+not be used in advertising or otherwise to promote the sale, use or other
+dealings in these Data Files or Software without prior written
+authorization of the copyright holder.
+
+SPDX-License-Identifier: Unicode-3.0
+
+—
+
+Portions of ICU4X may have been adapted from ICU4C and/or ICU4J.
+ICU 1.8.1 to ICU 57.1 © 1995-2016 International Business Machines Corporation and others.

ffi/npm/LICENSE

@@ -1,2 +1,6 @@
-import "./fixed-decimal.mjs";
-import "./fixed-decimal-format.mjs";
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+import './decimal.mjs';
+import './decimal-format.mjs';

ffi/npm/README.md

@@ -0,0 +1,31 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+import Benchmark from 'benchmark';
+
+import { Decimal, Locale, DecimalFormatter, DecimalGroupingStrategy } from 'icu'
+
+const locale = Locale.fromString('bn');
+
+let suite = new Benchmark.Suite();
+
+suite = suite.add('DecimalFormatter.create', () => {
+  DecimalFormatter.createWithGroupingStrategy(locale, DecimalGroupingStrategy.Auto);
+});
+
+const format = DecimalFormatter.createWithGroupingStrategy(locale, DecimalGroupingStrategy.Auto);
+const decimal = Decimal.fromBigInt(BigInt(1234));
+decimal.multiplyPow10(-2);
+
+suite = suite.add('DecimalFormatter.format', () => {
+  format.format(decimal);
+});
+
+suite
+  .on('cycle', (event) => {
+    console.log(String(event.target));
+    console.log('μs/it:', event.target.stats.mean * 1000 * 1000);
+    console.log();
+  })
+  .run({ 'async': false });

ffi/npm/bench/all.mjs

@@ -0,0 +1,39 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+import Benchmark from 'benchmark';
+
+import { Decimal, DecimalSign } from 'icu'
+
+let suite = new Benchmark.Suite();
+
+suite = suite.add('Decimal.fromBigInt', () => {
+  (Decimal.fromBigInt(BigInt(1234))).underlying > 0;
+});
+
+const decimal = Decimal.fromBigInt(BigInt(1234));
+decimal.multiplyPow10(-2);
+
+suite = suite.add('Decimal.toString', () => {
+  decimal.toString();
+});
+
+suite = suite.add('Decimal.multiplyPow10', () => {
+  decimal.multiplyPow10(2);
+  decimal.multiplyPow10(-2);
+});
+
+suite = suite.add('Decimal.sign', () => {
+  decimal.sign = DecimalSign.Negative;
+  decimal.sign = new DecimalSign('Positive');
+  decimal.sign = null;
+});
+
+suite
+  .on('cycle', (event) => {
+    console.log(String(event.target));
+    console.log('μs/it:', event.target.stats.mean * 1000 * 1000);
+    console.log();
+  })
+  .run({ 'async': false });