@agntcy/slim-bindings 2.0.0-alpha.2 → 2.0.0-alpha.3

package/README.md

@@ -12,7 +12,7 @@ npm installs this package and, when published for your OS/arch, the matching opt
 
 ## Module shape
 
-The published entry loads the generated UniFFI/Node bindings (see `package.json` `main` / `types`). From TypeScript or ESM-aware tooling you typically import the default export from the package path your bundler resolves (examples in this repo import from `generated/slim-bindings-node.js` when running inside the bindings workspace).
+This package is **native ESM** (`require()` is not supported — use `import`). The published entry loads the generated UniFFI/Node bindings (see `package.json` `main` / `types`). Examples in this repo import from `generated/index.js` when running inside the bindings workspace.
 
 ```typescript
 import slimBindings from '@agntcy/slim-bindings';
@@ -45,7 +45,7 @@ Full TypeScript types ship under `types/` in the published package (`index.d.ts`
    `await service.connectAsync(config)`  
    Returns a connection id used for routing/subscriptions.
 
-6. **Subscribe** the app to receive traffic for its name (often passing `BigInt(connId)` if the generated API expects `bigint` — see note below).
+6. **Subscribe** the app to receive traffic for its name, passing the connection id as a real `bigint` (e.g. `await app.subscribeAsync(name, connId)` where `connId` is what `connectAsync` returned).
 
 7. **Server** — for a network node that accepts clients, initialize the same way, then build a server config (e.g. `newInsecureServerConfig('0.0.0.0:46357')`) and run:
 
@@ -54,15 +54,15 @@ Full TypeScript types ship under `types/` in the published package (`index.d.ts`
 
 ## Examples
 
-Runnable scripts live under `examples/` (from repo root, use the `Taskfile` targets `example:server`, `example:alice`, `example:bob`, or run them via npm from `examples/` as documented in [README_dev.md](./README_dev.md)).
+Runnable scripts live under `examples/` (from repo root, use the `Taskfile` targets `example:server`, `example:alice`, `example:bob`, `example:group`, or run them via npm from `examples/` as documented in [README_dev.md](./README_dev.md)). `example:group` demonstrates multicast (group) sessions — a moderator creates a channel and invites participants; see [README_dev.md](./README_dev.md#3-run-the-group-multicast-example) for usage.
 
-## `bigint` vs `number` (FFI)
+## Type notes
 
-Some APIs are typed with `bigint` for 64-bit values, but `connectAsync` may return a JavaScript `number` at runtime. When you pass that value into a method that expects `bigint` (for example `subscribeAsync`), wrap it: `BigInt(connId)`. See [README_dev.md](./README_dev.md#ffi-type-conversions) for details.
+64-bit values (like the connection id from `connectAsync`) are real `bigint` end to end — pass them through as-is rather than converting to `Number`. Enum-typed fields (like `SessionConfig.sessionType`) are real TypeScript enums (`SessionType.PointToPoint`), not string literals. See [README_dev.md](./README_dev.md#type-conversions-and-api-notes) for details.
 
 ## Building from source / contributing
 
-Generator setup, Task commands, publishing, and FFI patches are documented for maintainers in **[README_dev.md](./README_dev.md)**.
+Generator setup, Task commands, and publishing are documented for maintainers in **[README_dev.md](./README_dev.md)**.
 
 ## Links
 

package/binding.js

@@ -0,0 +1,64 @@
+// Copyright AGNTCY Contributors (https://github.com/agntcy)
+// SPDX-License-Identifier: Apache-2.0
+
+import { detectLinuxLibc } from './libc-linux.js';
+
+/**
+ * Resolves the platform id for the current Node process.
+ * Must match the optionalDependency package suffixes.
+ */
+function getCurrentPlatformId() {
+  const platform = process.platform;
+  const arch = process.arch;
+  if (platform === 'darwin') {
+    return arch === 'arm64' ? 'darwin-arm64' : 'darwin-x64';
+  }
+  if (platform === 'linux') {
+    const libc = detectLinuxLibc();
+    if (arch === 'arm64') {
+      return `linux-arm64-${libc}`;
+    }
+    if (arch === 'x64') {
+      return `linux-x64-${libc}`;
+    }
+  }
+  if (platform === 'win32') {
+    return arch === 'arm64' ? 'win32-arm64-msvc' : 'win32-x64-msvc';
+  }
+  throw new Error(`Unsupported platform: ${platform} ${arch}`);
+}
+
+const platformId = getCurrentPlatformId();
+const packageName = `@agntcy/slim-bindings-${platformId}`;
+
+// The generated bindings (uniffi-bindgen-react-native, napi target) are native ESM
+// (they use import.meta.url for colocated native-library resolution), so the
+// platform package must be loaded via dynamic import rather than require().
+// Importing it also runs its required one-time initialization side effect
+// (registering the UnaryUnaryHandler/etc. callback vtables), so this module
+// must be the sole entry point consumers use - do not import the platform
+// package's inner files directly.
+let bindings;
+try {
+  bindings = await import(packageName);
+} catch (err) {
+  if (err.code === 'ERR_MODULE_NOT_FOUND') {
+    throw new Error(
+      `Platform package ${packageName} is not installed. ` +
+        `Run: npm install @agntcy/slim-bindings (optional dependencies include linux-*-gnu, linux-*-musl, darwin-*, win32-*). ` +
+        `On Alpine or other musl Linux, ensure the linux-*-musl optional package is available for your Node arch.`
+    );
+  }
+  throw err;
+}
+
+/**
+ * The resolved platform-binding module namespace. Holds every named export of
+ * the generated bindings (Channel, Server, RpcError, ...). Because the platform
+ * package name is computed at runtime, ESM cannot statically `export *` from it;
+ * `named-exports.js` (generated) re-exports these names individually so that
+ * `import { Channel } from '@agntcy/slim-bindings'` works.
+ */
+export const ns = bindings;
+
+export default bindings;

package/index.d.ts

@@ -4,5 +4,13 @@
 /**
  * Type definitions for @agntcy/slim-bindings.
  * Full types are in types/ (generated from bindings before publish).
+ *
+ * Both import styles are supported:
+ *   - named:   `import { Channel, RpcError } from '@agntcy/slim-bindings';`
+ *              (runtime values come from ./named-exports.js; types from here)
+ *   - default: `import slimBindings from '@agntcy/slim-bindings';`
+ *              then access the API off it (`slimBindings.SessionType`).
  */
-export * from './types/slim-bindings-node';
+export * from './types/slim_bindings';
+import * as slimBindings from './types/slim_bindings';
+export default slimBindings;

package/index.js

@@ -1,50 +1,14 @@
 // Copyright AGNTCY Contributors (https://github.com/agntcy)
 // SPDX-License-Identifier: Apache-2.0
 
-'use strict';
-
-const { detectLinuxLibc } = require('./libc-linux.js');
-
-/**
- * Resolves the platform id for the current Node process.
- * Must match the optionalDependency package suffixes.
- */
-function getCurrentPlatformId() {
-  const platform = process.platform;
-  const arch = process.arch;
-  if (platform === 'darwin') {
-    return arch === 'arm64' ? 'darwin-arm64' : 'darwin-x64';
-  }
-  if (platform === 'linux') {
-    const libc = detectLinuxLibc();
-    if (arch === 'arm64') {
-      return `linux-arm64-${libc}`;
-    }
-    if (arch === 'x64') {
-      return `linux-x64-${libc}`;
-    }
-  }
-  if (platform === 'win32') {
-    return arch === 'arm64' ? 'win32-arm64-msvc' : 'win32-x64-msvc';
-  }
-  throw new Error(`Unsupported platform: ${platform} ${arch}`);
-}
-
-const platformId = getCurrentPlatformId();
-const packageName = `@agntcy/slim-bindings-${platformId}`;
-
-let bindings;
-try {
-  bindings = require(packageName);
-} catch (err) {
-  if (err.code === 'MODULE_NOT_FOUND') {
-    throw new Error(
-      `Platform package ${packageName} is not installed. ` +
-        `Run: npm install @agntcy/slim-bindings (optional dependencies include linux-*-gnu, linux-*-musl, darwin-*, win32-*). ` +
-        `On Alpine or other musl Linux, ensure the linux-*-musl optional package is available for your Node arch.`
-    );
-  }
-  throw err;
-}
-
-module.exports = bindings;
+// Main entry point for @agntcy/slim-bindings.
+//
+// Exposes the platform binding both ways:
+//   * named exports — `import { Channel, RpcError } from '@agntcy/slim-bindings'`
+//     (from the generated ./named-exports.js barrel), and
+//   * a default export — `import slim from '@agntcy/slim-bindings'` (the resolved
+//     platform-binding namespace), for backwards compatibility.
+//
+// The platform-specific package is selected and loaded in ./binding.js.
+export * from './named-exports.js';
+export { default } from './binding.js';

package/libc-linux.js

@@ -1,16 +1,14 @@
 // Copyright AGNTCY Contributors (https://github.com/agntcy)
 // SPDX-License-Identifier: Apache-2.0
 
-'use strict';
-
-const fs = require('fs');
-const { execFileSync } = require('child_process');
+import fs from 'fs';
+import { execFileSync } from 'child_process';
 
 /**
  * Best-effort libc family for Linux (gnu vs musl).
  * Used to pick the correct @agntcy/slim-bindings-linux-* optional package.
  */
-function detectLinuxLibc() {
+export function detectLinuxLibc() {
   try {
     const maps = fs.readFileSync('/proc/self/maps', 'utf8');
     if (maps.includes('ld-musl')) {
@@ -31,5 +29,3 @@ function detectLinuxLibc() {
   }
   return 'gnu';
 }
-
-module.exports = { detectLinuxLibc };

package/named-exports.js

@@ -0,0 +1,112 @@
+// AUTO-GENERATED by scripts/gen-named-exports.mjs — DO NOT EDIT.
+// Runtime named re-exports of the platform binding so that
+// `import { Channel, RpcError, ... } from '@agntcy/slim-bindings'` works.
+// The platform package is selected at runtime (see binding.js), so ESM's
+// `export *` cannot be used here; each value export is re-bound explicitly.
+import { ns } from './binding.js';
+
+export const App = ns.App;
+export const BackoffConfig = ns.BackoffConfig;
+export const BackoffConfig_Tags = ns.BackoffConfig_Tags;
+export const BasicAuth = ns.BasicAuth;
+export const BidiStreamHandler = ns.BidiStreamHandler;
+export const BuildInfo = ns.BuildInfo;
+export const CaSource = ns.CaSource;
+export const CaSource_Tags = ns.CaSource_Tags;
+export const Channel = ns.Channel;
+export const ClientAuthenticationConfig = ns.ClientAuthenticationConfig;
+export const ClientAuthenticationConfig_Tags = ns.ClientAuthenticationConfig_Tags;
+export const ClientConfig = ns.ClientConfig;
+export const ClientJwtAuth = ns.ClientJwtAuth;
+export const CompletionHandle = ns.CompletionHandle;
+export const CompressionType = ns.CompressionType;
+export const Context = ns.Context;
+export const DataplaneConfig = ns.DataplaneConfig;
+export const Direction = ns.Direction;
+export const ExponentialBackoff = ns.ExponentialBackoff;
+export const FixedIntervalBackoff = ns.FixedIntervalBackoff;
+export const IdentityProviderConfig = ns.IdentityProviderConfig;
+export const IdentityProviderConfig_Tags = ns.IdentityProviderConfig_Tags;
+export const IdentityVerifierConfig = ns.IdentityVerifierConfig;
+export const IdentityVerifierConfig_Tags = ns.IdentityVerifierConfig_Tags;
+export const JwtAlgorithm = ns.JwtAlgorithm;
+export const JwtAuth = ns.JwtAuth;
+export const JwtKeyConfig = ns.JwtKeyConfig;
+export const JwtKeyData = ns.JwtKeyData;
+export const JwtKeyData_Tags = ns.JwtKeyData_Tags;
+export const JwtKeyFormat = ns.JwtKeyFormat;
+export const JwtKeyType = ns.JwtKeyType;
+export const JwtKeyType_Tags = ns.JwtKeyType_Tags;
+export const KeepaliveConfig = ns.KeepaliveConfig;
+export const KeepaliveServerParameters = ns.KeepaliveServerParameters;
+export const MessageContext = ns.MessageContext;
+export const MlsSettings = ns.MlsSettings;
+export const MulticastBidiStreamHandler = ns.MulticastBidiStreamHandler;
+export const MulticastResponseReader = ns.MulticastResponseReader;
+export const MulticastStreamMessage = ns.MulticastStreamMessage;
+export const MulticastStreamMessage_Tags = ns.MulticastStreamMessage_Tags;
+export const Name = ns.Name;
+export const ProxyConfig = ns.ProxyConfig;
+export const ReceivedMessage = ns.ReceivedMessage;
+export const RequestStream = ns.RequestStream;
+export const RequestStreamWriter = ns.RequestStreamWriter;
+export const ResponseSink = ns.ResponseSink;
+export const ResponseStreamReader = ns.ResponseStreamReader;
+export const RpcCode = ns.RpcCode;
+export const RpcError = ns.RpcError;
+export const RpcError_Tags = ns.RpcError_Tags;
+export const RpcMessageContext = ns.RpcMessageContext;
+export const RpcMulticastItem = ns.RpcMulticastItem;
+export const RuntimeConfig = ns.RuntimeConfig;
+export const Server = ns.Server;
+export const ServerAuthenticationConfig = ns.ServerAuthenticationConfig;
+export const ServerAuthenticationConfig_Tags = ns.ServerAuthenticationConfig_Tags;
+export const ServerConfig = ns.ServerConfig;
+export const Service = ns.Service;
+export const ServiceConfig = ns.ServiceConfig;
+export const Session = ns.Session;
+export const SessionConfig = ns.SessionConfig;
+export const SessionType = ns.SessionType;
+export const SessionWithCompletion = ns.SessionWithCompletion;
+export const SlimError = ns.SlimError;
+export const SlimError_Tags = ns.SlimError_Tags;
+export const SpireConfig = ns.SpireConfig;
+export const StaticJwtAuth = ns.StaticJwtAuth;
+export const StreamMessage = ns.StreamMessage;
+export const StreamMessage_Tags = ns.StreamMessage_Tags;
+export const StreamStreamHandlerImpl = ns.StreamStreamHandlerImpl;
+export const StreamUnaryHandlerImpl = ns.StreamUnaryHandlerImpl;
+export const TlsClientConfig = ns.TlsClientConfig;
+export const TlsServerConfig = ns.TlsServerConfig;
+export const TlsSource = ns.TlsSource;
+export const TlsSource_Tags = ns.TlsSource_Tags;
+export const TracingConfig = ns.TracingConfig;
+export const TransportProtocol = ns.TransportProtocol;
+export const UnaryStreamHandlerImpl = ns.UnaryStreamHandlerImpl;
+export const UnaryUnaryHandlerImpl = ns.UnaryUnaryHandlerImpl;
+export const createService = ns.createService;
+export const createServiceWithConfig = ns.createServiceWithConfig;
+export const getBuildInfo = ns.getBuildInfo;
+export const getGlobalService = ns.getGlobalService;
+export const getServices = ns.getServices;
+export const getVersion = ns.getVersion;
+export const initializeFromConfig = ns.initializeFromConfig;
+export const initializeFromConfigWithError = ns.initializeFromConfigWithError;
+export const initializeWithConfigs = ns.initializeWithConfigs;
+export const initializeWithDefaults = ns.initializeWithDefaults;
+export const isInitialized = ns.isInitialized;
+export const newConfigFromJson = ns.newConfigFromJson;
+export const newDataplaneConfig = ns.newDataplaneConfig;
+export const newInsecureClientConfig = ns.newInsecureClientConfig;
+export const newInsecureServerConfig = ns.newInsecureServerConfig;
+export const newRuntimeConfig = ns.newRuntimeConfig;
+export const newRuntimeConfigWith = ns.newRuntimeConfigWith;
+export const newSecureClientConfig = ns.newSecureClientConfig;
+export const newSecureServerConfig = ns.newSecureServerConfig;
+export const newServerConfig = ns.newServerConfig;
+export const newServiceConfig = ns.newServiceConfig;
+export const newServiceConfigWith = ns.newServiceConfigWith;
+export const newServiceConfiguration = ns.newServiceConfiguration;
+export const newTracingConfig = ns.newTracingConfig;
+export const newTracingConfigWith = ns.newTracingConfigWith;
+export const shutdownBlocking = ns.shutdownBlocking;

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@agntcy/slim-bindings",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.3",
   "description": "SLIM Node.js bindings using UniFFI",
+  "type": "module",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
     "index.js",
+    "binding.js",
+    "named-exports.js",
     "libc-linux.js",
     "index.d.ts",
     "types/",
@@ -34,21 +37,24 @@
     "directory": "node"
   },
   "license": "Apache-2.0",
+  "dependencies": {
+    "@ubjs/core": "0.31.0-3",
+    "@ubjs/node": "0.31.0-3"
+  },
   "optionalDependencies": {
-    "@agntcy/slim-bindings-darwin-arm64": "2.0.0-alpha.2",
-    "@agntcy/slim-bindings-darwin-x64": "2.0.0-alpha.2",
-    "@agntcy/slim-bindings-linux-arm64-gnu": "2.0.0-alpha.2",
-    "@agntcy/slim-bindings-linux-arm64-musl": "2.0.0-alpha.2",
-    "@agntcy/slim-bindings-linux-x64-gnu": "2.0.0-alpha.2",
-    "@agntcy/slim-bindings-linux-x64-musl": "2.0.0-alpha.2",
-    "@agntcy/slim-bindings-win32-arm64-msvc": "2.0.0-alpha.2",
-    "@agntcy/slim-bindings-win32-x64-gnu": "2.0.0-alpha.2",
-    "@agntcy/slim-bindings-win32-x64-msvc": "2.0.0-alpha.2"
+    "@agntcy/slim-bindings-darwin-arm64": "2.0.0-alpha.3",
+    "@agntcy/slim-bindings-darwin-x64": "2.0.0-alpha.3",
+    "@agntcy/slim-bindings-linux-arm64-gnu": "2.0.0-alpha.3",
+    "@agntcy/slim-bindings-linux-arm64-musl": "2.0.0-alpha.3",
+    "@agntcy/slim-bindings-linux-x64-gnu": "2.0.0-alpha.3",
+    "@agntcy/slim-bindings-linux-x64-musl": "2.0.0-alpha.3",
+    "@agntcy/slim-bindings-win32-arm64-msvc": "2.0.0-alpha.3",
+    "@agntcy/slim-bindings-win32-x64-gnu": "2.0.0-alpha.3",
+    "@agntcy/slim-bindings-win32-x64-msvc": "2.0.0-alpha.3"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
-    "ffi-rs": "^1.3.0",
     "typescript": "^5.0.0",
-    "uniffi-bindgen-react-native": "^0.29.3-1"
+    "uniffi-bindgen-react-native": "0.31.0-3"
   }
 }

package/types/index.d.ts

@@ -1 +1,7 @@
-export * from './slim-bindings-node';
+export * from './slim_bindings';
+import * as slim_bindings from './slim_bindings';
+export declare function uniffiInitAsync(): Promise<void>;
+declare const _default: {
+    slim_bindings: typeof slim_bindings;
+};
+export default _default;