[js/common] allow import onnxruntime-common as ESM and CJS (microsoft…

…#15772) ### Description allow import onnxruntime-common as ESM and CJS.
siweic0 · Jun 12, 2023 · b678ba1 · b678ba1
1 parent 0a585c0
commit b678ba1
Show file tree

Hide file tree

Showing 24 changed files with 222 additions and 127 deletions.
diff --git a/common/.npmignore b/common/.npmignore
@@ -1,5 +1,6 @@
 /.vscode/
 
+build.js
 webpack.config.js
 typedoc.json
 tsconfig.json

diff --git a/common/build.js b/common/build.js
@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import {execSync} from 'node:child_process';
+import {writeFileSync} from 'node:fs';
+import {resolve, dirname} from 'node:path';
+import {fileURLToPath} from 'node:url';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+// build the following folders:
+// - dist/cjs
+// - dist/esm
+execSync('npm run build:cjs', {shell: true, stdio: 'inherit', cwd: __dirname});
+execSync('npm run build:esm', {shell: true, stdio: 'inherit', cwd: __dirname});
+
+// generate package.json files under each of the dist folders for commonJS and ESModule
+// this trick allows typescript to import this package as different module type
+// see also: https://evertpot.com/universal-commonjs-esm-typescript-packages/
+writeFileSync(resolve(__dirname, './dist/cjs', 'package.json'), '{"type": "commonjs"}');
+writeFileSync(resolve(__dirname, './dist/esm', 'package.json'), '{"type": "module"}');
+
+// launch webpack to generate bundles
+execSync('npm run build:bundles', {shell: true, stdio: 'inherit', cwd: __dirname});
diff --git a/common/lib/backend-impl.ts b/common/lib/backend-impl.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {Backend} from './backend';
+import {Backend} from './backend.js';
 
 interface BackendInfo {
   backend: Backend;

diff --git a/common/lib/backend.ts b/common/lib/backend.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {InferenceSession} from './inference-session';
-import {OnnxValue} from './onnx-value';
+import {InferenceSession} from './inference-session.js';
+import {OnnxValue} from './onnx-value.js';
 
 /**
  * @internal
@@ -46,4 +46,4 @@ export interface Backend {
       Promise<SessionHandler>;
 }
 
-export {registerBackend} from './backend-impl';
+export {registerBackend} from './backend-impl.js';
diff --git a/common/lib/env-impl.ts b/common/lib/env-impl.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {Env} from './env';
-import {version} from './version';
+import {Env} from './env.js';
+import {version} from './version.js';
 
 type LogLevelType = Env['logLevel'];
 

diff --git a/common/lib/env.ts b/common/lib/env.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {env as envImpl} from './env-impl';
+import {env as envImpl} from './env-impl.js';
 
 export declare namespace Env {
   export type WasmPrefixOrFilePaths = string|{

diff --git a/common/lib/index.ts b/common/lib/index.ts
@@ -17,8 +17,8 @@
  * @packageDocumentation
  */
 
-export * from './backend';
-export * from './env';
-export * from './inference-session';
-export * from './tensor';
-export * from './onnx-value';
+export * from './backend.js';
+export * from './env.js';
+export * from './inference-session.js';
+export * from './tensor.js';
+export * from './onnx-value.js';
diff --git a/common/lib/inference-session-impl.ts b/common/lib/inference-session-impl.ts
@@ -1,11 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {SessionHandler} from './backend';
-import {resolveBackend} from './backend-impl';
-import {InferenceSession as InferenceSessionInterface} from './inference-session';
-import {OnnxValue} from './onnx-value';
-import {Tensor} from './tensor';
+import {resolveBackend} from './backend-impl.js';
+import {SessionHandler} from './backend.js';
+import {InferenceSession as InferenceSessionInterface} from './inference-session.js';
+import {OnnxValue} from './onnx-value.js';
+import {Tensor} from './tensor.js';
 
 type SessionOptions = InferenceSessionInterface.SessionOptions;
 type RunOptions = InferenceSessionInterface.RunOptions;

diff --git a/common/lib/inference-session.ts b/common/lib/inference-session.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {InferenceSession as InferenceSessionImpl} from './inference-session-impl';
-import {OnnxValue} from './onnx-value';
+import {InferenceSession as InferenceSessionImpl} from './inference-session-impl.js';
+import {OnnxValue} from './onnx-value.js';
 
 /* eslint-disable @typescript-eslint/no-redeclare */
 

diff --git a/common/lib/onnx-value.ts b/common/lib/onnx-value.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {Tensor} from './tensor';
+import {Tensor} from './tensor.js';
 
 type NonTensorType = never;
 

diff --git a/common/lib/tensor-conversion-impl.ts b/common/lib/tensor-conversion-impl.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {Tensor} from './tensor';
-import {TensorToDataUrlOptions, TensorToImageDataOptions} from './tensor-conversion';
+import {TensorToDataUrlOptions, TensorToImageDataOptions} from './tensor-conversion.js';
+import {Tensor} from './tensor.js';
 
 /**
  * implementation of Tensor.toDataURL()

diff --git a/common/lib/tensor-conversion.ts b/common/lib/tensor-conversion.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {OptionsFormat, OptionsNormalizationParameters, OptionsTensorLayout} from './tensor-factory';
+import {OptionsFormat, OptionsNormalizationParameters, OptionsTensorLayout} from './tensor-factory.js';
 
 export interface TensorToDataUrlOptions extends OptionsTensorLayout, OptionsFormat, OptionsNormalizationParameters {}
 

diff --git a/common/lib/tensor-factory-impl.ts b/common/lib/tensor-factory-impl.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {Tensor, TypedTensor} from './tensor';
-import {OptionsDimensions, OptionsFormat, OptionsNormalizationParameters, OptionsTensorFormat, OptionsTensorLayout, TensorFromImageBitmapOptions, TensorFromImageDataOptions, TensorFromImageElementOptions, TensorFromUrlOptions} from './tensor-factory';
+import {OptionsDimensions, OptionsFormat, OptionsNormalizationParameters, OptionsTensorFormat, OptionsTensorLayout, TensorFromImageBitmapOptions, TensorFromImageDataOptions, TensorFromImageElementOptions, TensorFromUrlOptions} from './tensor-factory.js';
+import {Tensor, TypedTensor} from './tensor.js';
 
 interface BufferToTensorOptions extends OptionsDimensions, OptionsTensorLayout, OptionsNormalizationParameters,
                                         OptionsFormat, OptionsTensorFormat {}

diff --git a/common/lib/tensor-factory.ts b/common/lib/tensor-factory.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {TypedTensor} from './tensor';
+import {TypedTensor} from './tensor.js';
 
 export type ImageFormat = 'RGB'|'RGBA'|'BGR'|'RBG';
 export type ImageTensorLayout = 'NHWC'|'NCHW';

diff --git a/common/lib/tensor-impl.ts b/common/lib/tensor-impl.ts
@@ -1,12 +1,12 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {Tensor as TensorInterface} from './tensor';
-import {TensorToDataUrlOptions, TensorToImageDataOptions} from './tensor-conversion';
-import {tensorToDataURL, tensorToImageData} from './tensor-conversion-impl';
-import {TensorFromImageBitmapOptions, TensorFromImageDataOptions, TensorFromImageElementOptions, TensorFromUrlOptions} from './tensor-factory';
-import {tensorFromImage} from './tensor-factory-impl';
-import {calculateSize, tensorReshape} from './tensor-utils-impl';
+import {tensorToDataURL, tensorToImageData} from './tensor-conversion-impl.js';
+import {TensorToDataUrlOptions, TensorToImageDataOptions} from './tensor-conversion.js';
+import {tensorFromImage} from './tensor-factory-impl.js';
+import {TensorFromImageBitmapOptions, TensorFromImageDataOptions, TensorFromImageElementOptions, TensorFromUrlOptions} from './tensor-factory.js';
+import {calculateSize, tensorReshape} from './tensor-utils-impl.js';
+import {Tensor as TensorInterface} from './tensor.js';
 
 type TensorType = TensorInterface.Type;
 type TensorDataType = TensorInterface.DataType;

diff --git a/common/lib/tensor-utils-impl.ts b/common/lib/tensor-utils-impl.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {Tensor} from './tensor';
+import {Tensor} from './tensor.js';
 
 /**
  * calculate size from dims.

diff --git a/common/lib/tensor-utils.ts b/common/lib/tensor-utils.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {Tensor, TypedTensor} from './tensor';
-import {ConversionUtils} from './tensor-conversion';
+import {ConversionUtils} from './tensor-conversion.js';
+import {Tensor, TypedTensor} from './tensor.js';
 
 interface Properties {
   /**

diff --git a/common/lib/tensor.ts b/common/lib/tensor.ts
@@ -1,9 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {TensorFactory} from './tensor-factory';
-import {Tensor as TensorImpl} from './tensor-impl';
-import {TypedTensorUtils} from './tensor-utils';
+import {TensorFactory} from './tensor-factory.js';
+import {Tensor as TensorImpl} from './tensor-impl.js';
+import {TypedTensorUtils} from './tensor-utils.js';
 
 /* eslint-disable @typescript-eslint/no-redeclare */
 

diff --git a/common/package.json b/common/package.json
@@ -1,27 +1,32 @@
 {
   "license": "MIT",
-  "unpkg": "dist/ort-common.min.js",
+  "type": "module",
   "name": "onnxruntime-common",
+  "version": "1.16.0",
   "repository": {
     "url": "https://github.com/Microsoft/onnxruntime.git",
     "type": "git"
   },
   "author": "fs-eire",
-  "module": "dist/lib/index.js",
-  "version": "1.16.0",
-  "jsdelivr": "dist/ort-common.min.js",
   "scripts": {
-    "prepare": "tsc && webpack"
+    "build:cjs": "npx tsc --module commonjs --outDir ./dist/cjs",
+    "build:esm": "npx tsc",
+    "build:bundles": "webpack",
+    "build": "node ./build.js",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typedoc": "^0.23.22"
+  },
+  "main": "dist/cjs/index.js",
+  "exports": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js"
   },
   "keywords": [
     "ONNX",
     "ONNXRuntime",
     "ONNX Runtime"
   ],
-  "devDependencies": {
-    "typedoc": "^0.23.22"
-  },
-  "main": "dist/ort-common.node.js",
-  "types": "dist/lib/index.d.ts",
   "description": "ONNXRuntime JavaScript API library"
 }
diff --git a/common/tsconfig.json b/common/tsconfig.json
@@ -1,7 +1,9 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "dist/lib",
+    "outDir": "./dist/esm",
+    "declaration": true,
+    "declarationMap": true,
     "esModuleInterop": false,
     "noUnusedParameters": true,
   },