@urnetwork/sdk 2026.9.17-1048676710

package/README.md

@@ -0,0 +1,106 @@
+# URnetwork JavaScript SDK
+
+The Go/WASM SDK runs in modern browsers and Node 24+. It controls a native
+Device through `DeviceRemote`, using either a configured hosted device or an
+extension/companion transport. The canonical npm name is `@urnetwork/sdk`;
+its first publication is pending. `@urnetwork/sdk-js` is the compatibility
+import.
+
+## Install
+
+```sh
+npm install @urnetwork/sdk
+```
+
+The unqualified command selects `latest`. Preview builds use
+`npm install @urnetwork/sdk@nightly`. ESM, CommonJS, TypeScript declarations,
+React bindings, WASM and its matching Go runtime glue are included.
+
+## Sockets and Direct Sockets
+
+An initialized Device exposes `dial`, `dialTls` and `directSockets`. Conn has
+async reads/writes, deadlines, close, and Web Streams adapters. TCP/UDP support
+IPv4, IPv6 and hostname Happy Eyeballs. Plain UDP races the initial datagram
+and selects the first reply; that datagram may be delivered to both addresses.
+
+Use the Direct Sockets constructor signatures with a UR Device:
+
+```js
+const {TCPSocket, UDPSocket} = device.directSockets;
+const socket = new TCPSocket("echo.example", 9000);
+const {readable, writable} = await socket.opened;
+const writer = writable.getWriter();
+await writer.write(new TextEncoder().encode("hello"));
+await writer.close();
+writer.releaseLock();
+const reader = readable.getReader({mode: "byob"});
+console.log(await reader.read(new Uint8Array(1024)));
+await reader.cancel();
+reader.releaseLock();
+await socket.close();
+await socket.closed;
+```
+
+`createDirectSockets(device)` also returns bound constructors. TCP accepts
+`BufferSource` writes and supports default/BYOB readers; connected UDP uses
+`UDPMessage` objects (`{data}`). Both offer `opened`, `closed`, and asynchronous
+`close()`. Release reader/writer locks before calling `close()`.
+
+The SDK implementation runs in ordinary browsers and Node over the Device's
+packet path; it does not use or replace browser globals. Chrome's native API
+is restricted to [Isolated Web Apps](https://developer.chrome.com/docs/iwa/direct-sockets).
+This client profile supports `dnsQueryType` and rejects bound UDP, multicast,
+and per-socket buffer/no-delay/keep-alive tuning with `NotSupportedError`.
+Listener sockets remain future work. Use `dialTls` for TLS/DTLS. See the
+[socket design and support profile](https://github.com/urnetwork/sdk/blob/main/SOCKET.md).
+
+Full programs and run guides are in the
+[Node and browser socket examples](https://github.com/urnetwork/examples/tree/main/javascript/socket).
+They include hosted Device setup, Undici/Axios socket integration for Node,
+a browser Axios request adapter, and Direct Sockets TCP/UDP echo. Browser fetch and XHR
+do not expose a custom socket factory.
+
+## Peer messages
+
+A provider-capable native Device can expose raw application subprotocols to
+JavaScript through an extension/companion `DeviceRemote`:
+
+```js
+const messages = await device.enableSubprotocol(4097, async message => {
+  console.log(message.sourceClientId, message.bytes);
+});
+const supported = await messages.querySubprotocols(peerClientId, 10_000);
+if (supported?.includes(4097)) {
+  await messages.send(peerClientId, new TextEncoder().encode("hello"));
+}
+await messages.close();
+await messages.closed;
+```
+
+Each callback receives one complete owned `Uint8Array` and the authenticated
+source client ID. `send()` reports local queue acceptance, so application
+protocols should acknowledge delivery when needed. A subscription is bound to
+one RPC connection and closes on reconnect. Hosted proxy devices reject this
+API because they do not have a visible peer identity. The executable
+[JavaScript messages example](https://github.com/urnetwork/examples/tree/main/javascript/messages)
+includes live peer updates, support queries, TEXT/ACK framing, and an
+authenticated numeric-loopback native companion.
+
+## Build, check and publish
+
+From this directory:
+
+```sh
+make package check-package
+```
+
+This builds paired WASM/glue and JS/types, creates canonical and compatibility
+tarballs in `release/artifacts`, and tests real Node runtime initialization,
+ESM/CommonJS imports and TypeScript consumption. Install the canonical tarball
+locally before the first registry publication.
+
+`make publish` uses the Go publisher to upload the checked artifacts; it skips
+when npm credentials are absent. Set `SDK_PACKAGE_VERSION` for the release
+identity and `SDK_PACKAGE_CHANNEL` for its npm tag (default `nightly`). The
+release pipeline calls these targets. See the
+[package-manager plan](https://github.com/urnetwork/sdk/blob/main/PACKAGEMANAGERS.md).

package/dist/api.d.ts

@@ -0,0 +1,23 @@
+import { AuthCodeLoginArgs, AuthCodeLoginResult, AuthLoginArgs, AuthLoginResult, AuthLoginWithPasswordArgs, AuthLoginWithPasswordResult, AuthNetworkClientArgs, AuthNetworkClientResult, AuthVerifyArgs, AuthVerifyResult, CreateApiKeyArgs, CreateApiKeyResult, DeleteApiKeyArgs, DeleteApiKeyResult, FindLocationsArgs, FindLocationsResult, ListApiKeysResult, NetworkCheckArgs, NetworkCheckResult, NetworkCreateArgs, NetworkCreateResult, RemoveNetworkClientArgs, RemoveNetworkClientResult } from "./generated/index.js";
+export declare class URNetworkAPI {
+    private baseURL;
+    constructor(config?: {
+        baseURL?: string;
+        token?: string;
+    });
+    private safeJsonParse;
+    authLogin(params: AuthLoginArgs): Promise<AuthLoginResult>;
+    authLoginWithPassword(params: AuthLoginWithPasswordArgs): Promise<AuthLoginWithPasswordResult>;
+    networkCheck(params: NetworkCheckArgs): Promise<NetworkCheckResult | undefined>;
+    networkCreate(params: NetworkCreateArgs): Promise<NetworkCreateResult>;
+    authCodeLogin(params: AuthCodeLoginArgs): Promise<AuthCodeLoginResult>;
+    networkProviderLocations(): Promise<FindLocationsResult>;
+    searchProviderLocations(params: FindLocationsArgs): Promise<FindLocationsResult>;
+    verifyUserAuth(params: AuthVerifyArgs, adminToken: string): Promise<AuthVerifyResult>;
+    authNetworkClient(params: AuthNetworkClientArgs, token: string, signal?: AbortSignal): Promise<AuthNetworkClientResult>;
+    removeNetworkClient(params: RemoveNetworkClientArgs, token: string): Promise<RemoveNetworkClientResult>;
+    createApiKey(params: CreateApiKeyArgs, token: string): Promise<CreateApiKeyResult>;
+    listApiKeys(token: string): Promise<ListApiKeysResult>;
+    deleteApiKey(params: DeleteApiKeyArgs, token: string): Promise<DeleteApiKeyResult>;
+}
+//# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,aAAa,EACb,eAAe,EACf,yBAAyB,EACzB,2BAA2B,EAC3B,qBAAqB,EACrB,uBAAuB,EACvB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,yBAAyB,EAC1B,MAAM,aAAa,CAAC;AAGrB,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE;YAQ3C,aAAa;IAsCrB,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC;IAgD1D,qBAAqB,CACzB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,2BAA2B,CAAC;IAmDjC,YAAY,CAChB,MAAM,EAAE,gBAAgB,GACvB,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAkCpC,aAAa,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAsEtE,aAAa,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA2CtE,wBAAwB,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAqCxD,uBAAuB,CAC3B,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,mBAAmB,CAAC;IA0CzB,cAAc,CAClB,MAAM,EAAE,cAAc,EACtB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,gBAAgB,CAAC;IA4CtB,iBAAiB,CACrB,MAAM,EAAE,qBAAqB,EAC7B,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,uBAAuB,CAAC;IAoD7B,mBAAmB,CACvB,MAAM,EAAE,uBAAuB,EAC/B,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,yBAAyB,CAAC;IA4C/B,YAAY,CAChB,MAAM,EAAE,gBAAgB,EACxB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,kBAAkB,CAAC;IAuCxB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAwCtD,YAAY,CAChB,MAAM,EAAE,gBAAgB,EACxB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,kBAAkB,CAAC;CAsC/B"}

package/dist/generated/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/generated/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC"}