@ikonai/sdk 1.3.10 → 1.3.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ikonai/sdk",
3
- "version": "1.3.10",
3
+ "version": "1.3.11",
4
4
  "type": "module",
5
5
  "main": "./index.js",
6
6
  "types": "./index.d.ts",
@@ -6,7 +6,8 @@
6
6
  * (e.g., "ikon-proxy" and "ikon_proxy" both work).
7
7
  *
8
8
  * Supported parameters:
9
- * - ikon-proxy Force proxy mode on (true) or off (false)
9
+ * - ikon-proxy Pin the connect tier: false = direct, true = the on-host proxy on 443,
10
+ * lb (or stream) = the app's own origin through the fleet proxy gateway
10
11
  * - ikon-websocket Force WebSocket transport on (true) or off (false)
11
12
  * - ikon-webtransport Force WebTransport on (true); default is off. `false` is accepted for parity.
12
13
  * - ikon-debug Enable SDK debug logging (true)
@@ -48,6 +49,15 @@ export declare const IKON_PARAM_SESSION = "ikon-session";
48
49
  */
49
50
  export declare function setSdkUrlParam(canonicalName: string, value: string): void;
50
51
  export declare function getProxyParam(): boolean | null;
52
+ /**
53
+ * Which connect tier to pin, as an extension of the same parameter rather than a second one — there
54
+ * is one thing to remember and one thing to document.
55
+ *
56
+ * `lb` (and the friendlier alias `stream`) is what makes the same-origin stream tier testable at
57
+ * all: in `auto` mode a client only reaches it after failing the two above it, which is close to
58
+ * impossible to arrange deliberately.
59
+ */
60
+ export declare function getProxyTierParam(): 'direct' | 'proxy' | 'lb' | null;
51
61
  export declare function getWebSocketParam(): boolean | null;
52
62
  export declare function getWebTransportParam(): boolean | null;
53
63
  export declare function getDebugParam(): boolean;