Improve module typedefs and loader generation (#265)

Author: jasongin

Docs/dynamic-invoke.md

@@ -11,11 +11,10 @@ For examples of this scenario, see
      <PropertyGroup>
        <TargetFramework>net6.0</TargetFramework>
        <OutDir>bin</OutDir>
-       <NodeApiAssemblyJSModuleType>commonjs</NodeApiAssemblyJSModuleType>
        <GenerateNodeApiTypeDefinitionsForReferences>true</GenerateNodeApiTypeDefinitionsForReferences>
      </PropertyGroup>
      <ItemGroup>
-       <PackageReference Include="Microsoft.JavaScript.NodeApi.Generator" Version="0.5.*" />
+       <PackageReference Include="Microsoft.JavaScript.NodeApi.Generator" Version="0.7.*" />
        <PackageReference Include="Example.Package" Version="1.2.3" />
        <PackageReference Include="Example.Package.Two" Version="2.3.4" />
      </ItemGroup>
@@ -27,15 +26,15 @@ For examples of this scenario, see
      will be placed there.
    - The `Microsoft.JavaScript.NodeApi.Generator` package reference enables automatic generation
      of TS type-definitions for the referenced assemblies.
-   - Change `NodeApiAssemblyJSModuleType` to `esm` if using ES modules.
 
    Build the project to restore the packages, place assemblies in the `bin` directory, and generate
    type definitions:
    ```
    dotnet build
    ```
 
-2. Add a dependency on the `node-api-dotnet` npm package to your JavaScript project:
+2. Create a `package.json` file for the project, if you haven't already. Then add a dependency on
+the `node-api-dotnet` npm package to your JavaScript project:
     ```
     npm install node-api-dotnet
     ```

Docs/node-module.md

@@ -23,8 +23,8 @@ For a minimal example of this scenario, see
     Afterward you should have the two references in your project file:
     ```xml
     <ItemGroup>
-      <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.4.*-*" />
-      <PackageReference Include="Microsoft.JavaScript.NodeApi.Generator" Version="0.4.*-*" />
+      <PackageReference Include="Microsoft.JavaScript.NodeApi" Version="0.7.*-*" />
+      <PackageReference Include="Microsoft.JavaScript.NodeApi.Generator" Version="0.7.*-*" />
     </ItemGroup>
     ```
 

examples/aot-module/example.js

@@ -1,10 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-const Example = require('./bin/aot-module').Example;
+import { Example } from './bin/aot-module.js';
 
 // Call a method exported by the .NET module.
 const result = Example.hello('.NET AOT');
 
-const assert = require('assert');
+import assert from 'assert';
 assert.strictEqual(result, 'Hello .NET AOT!');

examples/aot-module/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "node-api-dotnet-examples-aot-module",
+  "type": "module"
+}

examples/aot-npm-package/app/example.js

@@ -1,10 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-const Example = require('aot-npm-package').Example;
+import { Example } from 'aot-npm-package';
 
 // Call a method exported by the .NET module.
 const result = Example.hello('.NET AOT');
 
-const assert = require('assert');
+import assert from 'node:assert';
 assert.strictEqual(result, 'Hello .NET AOT!');

examples/aot-npm-package/app/package.json

@@ -7,9 +7,10 @@
   "author": "Microsoft",
   "repository": "github:microsoft/node-api-dotnet",
   "main": "./example.js",
+  "type": "module",
   "scripts": {
   },
   "dependencies": {
-    "aot-npm-package": "file:../lib/pkg/aot-npm-package-0.1.6.tgz"
+    "aot-npm-package": "file:../lib"
   }
 }

examples/aot-npm-package/lib/aot-npm-package.csproj

@@ -6,11 +6,14 @@
     <!-- The C# xmldoc file is converted to comments in the generated TS type definitions. -->
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
 
-    <!-- `dotnet publish` will produce node module files in $(PublishDir), with
-      .node native AOT binary files under $(RuntimeIdentifier) subdirectories. -->
+    <!-- `dotnet publish` will produce node module files in $(PublishDir) -->
     <PublishAot>true</PublishAot>
     <PublishNodeModule>true</PublishNodeModule>
     <PublishDir>bin</PublishDir>
+
+    <!-- Place .node native AOT binary files under $(RuntimeIdentifier) subdirectories.
+         This could support packaging multiple platform-specific binaries in a single npm package
+         (though that would require building them each separately then merging the results). -->
     <PublishMultiPlatformNodeModule>true</PublishMultiPlatformNodeModule>
 
     <!-- `dotnet publish` will produce an npm package in the $(PackageOutputPath) directory. -->

examples/aot-npm-package/lib/package.json

@@ -1,12 +1,13 @@
 {
   "name": "aot-npm-package",
   "private": true,
-  "version": "0.1.6",
+  "version": "0.2",
   "description": "Example npm-packaged C# Native AOT node module",
   "license": "MIT",
   "author": "Microsoft",
   "repository": "github:microsoft/node-api-dotnet",
-  "main": "./bin/aot-npm-package",
+  "type": "module",
+  "main": "./bin/aot-npm-package.js",
   "scripts": {
   }
 }

examples/dotnet-module/example.js

@@ -1,10 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-const dotnet = require('node-api-dotnet');
-
-/** @type {import('./bin/dotnet-module').Example} */
-const Example = dotnet.require('./bin/dotnet-module').Example;
+const Example = require('./bin/dotnet-module').Example;
 
 // Call a method exported by the .NET module.
 const result = Example.hello('.NET');

examples/dotnet-module/package.json

@@ -1,5 +1,6 @@
 {
   "name": "node-api-dotnet-examples-dotnet-module",
+  "type": "commonjs",
   "dependencies": {
     "node-api-dotnet": "file:../../out/pkg/node-api-dotnet"
   }