node-api-dotnet 0.7.18 → 0.7.26

package/README.md

@@ -110,7 +110,7 @@ dotnet.ExampleNamespace.ExampleClass.ExampleMethod(...args); // This call is typ
 
 (CommonJS modules must use `require()` instead of `import`.)
 
-For reference, there is a [list of C# type projections to TypeScript](/Docs/typescript.md).
+For reference, there is a [list of C# type projections to TypeScript](/docs/typescript.md).
 
 ### Full async support
 JavaScript code can `await` a call to a .NET method that returns a `Task`. The marshaller
@@ -282,12 +282,12 @@ For details, see [Using .NET Generics in JavaScript](./docs/generics.md).
 
 #### Instructions
 For calling .NET from JS, choose between one of the following scenarios:
- - [Dynamically invoke .NET APIs from JavaScript](./Docs/dynamic-invoke.md)<br/>
+ - [Dynamically invoke .NET APIs from JavaScript](./docs/dynamic-invoke.md)<br/>
    Dynamic invocation is simpler to set up: all you need is the `node-api-dotnet` npm package and
    the path to a .NET assembly you want to call. But it has some limitations (not all kinds of APIs
    are supported), and is not quite as fast as a C# module, because marshalling code must be
    generated at runtime.
- - [Develop a Node module in C#](./Docs/node-module.md)<br/>
+ - [Develop a Node module in C#](./docs/node-module.md)<br/>
    A C# Node module is appropriate for an application that has more advanced interop needs. It can
    be faster because marshalling code can be generated at compile time, and the shape of the APIs
    exposed to JavaScript can be adapted with JS interop in mind.
@@ -330,4 +330,4 @@ third-party's policies.
 <br/>
 <br/>
 
-![.NET + JS scene](./Docs/images/dotnet-bot_scene_coffee-shop.png)
+![.NET + JS scene](./docs/images/dotnet-bot_scene_coffee-shop.png)

package/index.d.ts

@@ -1,10 +1,38 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-// APIs defined here are implemented by Microsoft.JavaScript.NodeApi.DotNetHost.
-
-// This explicit module declaration enables module members to be merged with imported namespaces.
+/**
+ * Use the `node-api-dotnet` package to load .NET assemblies into a Node.js application and
+ * call public APIs defined in the assemblies.
+ * ::: code-group
+ * ```JavaScript [ES (TS or JS)]
+ * import dotnet from 'node-api-dotnet';
+ * ```
+ * ```TypeScript [CommonJS (TS)]
+ * import * as dotnet from 'node-api-dotnet';
+ * ```
+ * ```JavaScript [CommonJS (JS)]
+ * const dotnet = require('node-api-dotnet');
+ * ```
+ * :::
+ * To load a specific version of .NET, append the target framework moniker to the package name:
+ * ::: code-group
+ * ```JavaScript [ES (TS or JS)]
+ * import dotnet from 'node-api-dotnet/net6.0';
+ * ```
+ * ```TypeScript [CommonJS (TS)]
+ * import * as dotnet from 'node-api-dotnet/net6.0';
+ * ```
+ * ```JavaScript [CommonJS (JS)]
+ * const dotnet = require('node-api-dotnet/net6.0');
+ * ```
+ * :::
+ * Currently the supported target frameworks are `net472`, `net6.0`, and `net8.0`.
+ * @module node-api-dotnet
+ */
 declare module 'node-api-dotnet' {
+// APIs defined here are implemented by Microsoft.JavaScript.NodeApi.DotNetHost.
+// The explicit module declaration enables module members to be merged with imported namespaces.
 
 /**
  * Gets the current .NET runtime version, for example "8.0.1".
@@ -23,6 +51,8 @@ export const frameworkMoniker: string;
  * @param dotnetAssemblyFilePath Path to the .NET assembly DLL file.
  * @returns The JavaScript module exported by the assembly. (Type information for the module
  * may be available in a separate generated type-definitions file.)
+ * @description The .NET assembly must use `[JSExport]` attributes to export selected types
+ * and/or members to JavaScript. These exports _do not_ use .NET namespaces.
  */
 export function require(dotnetAssemblyFilePath: string): any;
 
@@ -31,6 +61,11 @@ export function require(dotnetAssemblyFilePath: string): any;
  * dynamic invocation of any APIs in the assembly. After loading, types from the assembly are
  * available via namespaces on the main dotnet module.
  * @param assemblyNameOrFilePath Path to the .NET assembly DLL file, or name of a system assembly.
+ * @description After loading an assembly, types in the assembly are merged into the .NET
+ * namespace hierarchy, with top-level namespaces available as properties on the .NET module.
+ * For example, if the assembly defines a type `Contoso.Business.Component`, it can be accessed as
+ * `dotnet.Contoso.Business.Component`. (.NET core library types can be accessed the same way, for
+ * example `dotnet.System.Console`.)
  */
 export function load(assemblyNameOrFilePath: string): void;
 

package/net472/Microsoft.JavaScript.NodeApi.runtimeconfig.json

@@ -2,9 +2,7 @@
   "runtimeOptions": {
     "tfm": "net472",
     "configProperties": {
-      "System.Globalization.Invariant": true,
       "System.Reflection.Metadata.MetadataUpdater.IsSupported": false,
-      "System.Resources.UseSystemResourceKeys": true,
       "System.Runtime.InteropServices.EnableConsumingManagedCodeFromNativeHosting": true
     }
   }

package/net6.0/Microsoft.JavaScript.NodeApi.runtimeconfig.json

@@ -6,10 +6,7 @@
       "version": "6.0.0"
     },
     "configProperties": {
-      "System.Globalization.Invariant": true,
-      "System.Globalization.PredefinedCulturesOnly": true,
       "System.Reflection.Metadata.MetadataUpdater.IsSupported": false,
-      "System.Resources.UseSystemResourceKeys": true,
       "System.Runtime.InteropServices.EnableConsumingManagedCodeFromNativeHosting": true
     }
   }

package/net8.0/Microsoft.JavaScript.NodeApi.runtimeconfig.json

@@ -6,10 +6,7 @@
       "version": "8.0.0"
     },
     "configProperties": {
-      "System.Globalization.Invariant": true,
-      "System.Globalization.PredefinedCulturesOnly": true,
       "System.Reflection.Metadata.MetadataUpdater.IsSupported": false,
-      "System.Resources.UseSystemResourceKeys": true,
       "System.Runtime.Serialization.EnableUnsafeBinaryFormatterSerialization": false,
       "System.Runtime.InteropServices.EnableConsumingManagedCodeFromNativeHosting": true
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-api-dotnet",
-  "version": "0.7.18",
+  "version": "0.7.26",
   "description": "Node-API bindings for .Net",
   "license": "MIT",
   "author": "Microsoft",