@mywebapi.com/sdk 0.2.1 → 0.3.0

package/dist/request-timeout.d.ts

@@ -0,0 +1,56 @@
+import { REQUEST_TIMEOUT_MAX_SECONDS, REQUEST_TIMEOUT_MIN_SECONDS } from './request-timeouts.generated';
+export { REQUEST_TIMEOUT_MAX_SECONDS, REQUEST_TIMEOUT_MIN_SECONDS };
+export declare const REQUEST_TIMEOUT_HEADER = "X-Request-Timeout";
+export declare const REQUEST_TIMEOUT_QUERY = "requestTimeout";
+export declare const REQUEST_TIMEOUT_APPLIED_HEADER = "X-Request-Timeout-Applied";
+export declare const REQUEST_OUTCOME_HEADER = "X-Request-Outcome";
+/**
+ * Time the client waits beyond the server timeout for the server's answer to arrive.
+ *
+ * ! The server extends its own deadline by the time it spends opening the trading
+ *   platform connection for this very request, up to 20 s (cold start); the remaining
+ *   10 s cover response transfer and queueing in front of the API. Same margin as the
+ *   other CPlugin WebAPI SDKs.
+ */
+export declare const SERVER_ANSWER_MARGIN_MS = 30000;
+/** Per-call options accepted by every generated endpoint method as its last argument. */
+export interface RequestOptions extends RequestInit {
+    /**
+     * How long the server waits for the trading platform, in seconds
+     * (1–300, fractions allowed). Sent as the `X-Request-Timeout` header and overrides
+     * the client-wide `requestTimeout`. Omit to use the operation's server default.
+     * The client deadline is extended automatically so the server's answer is received.
+     */
+    requestTimeout?: number;
+}
+/** Throws a TypeError unless `seconds` is a value the server accepts. */
+export declare function validateRequestTimeout(seconds: unknown, name?: string): number;
+/**
+ * Server default timeout, in seconds, of the operation addressed by `method` + `pathname`,
+ * or `undefined` when the operation is not guarded by a server timeout.
+ */
+export declare function operationDefaultTimeout(method: string, pathname: string): number | undefined;
+export interface TimeoutPlan {
+    /** Value to send as X-Request-Timeout, or undefined to leave the headers as they are. */
+    send: number | undefined;
+    /** Client deadline for the whole operation, in milliseconds. */
+    deadlineMs: number;
+}
+/**
+ * Decides which X-Request-Timeout to send and how long the client waits.
+ *
+ * Precedence of the server timeout: per-call `requestTimeout` → an `X-Request-Timeout`
+ * header or `requestTimeout` query value the caller set by hand → the client-wide
+ * default (only for operations that accept it) → the operation's server default.
+ * The deadline is `max(timeoutMs, serverTimeout + SERVER_ANSWER_MARGIN_MS)`.
+ */
+export declare function planRequestTimeout(args: {
+    method: string;
+    url: URL;
+    headers: Record<string, string>;
+    perCall: number | undefined;
+    clientDefault: number | undefined;
+    timeoutMs: number;
+}): TimeoutPlan;
+/** Replaces any case variant of X-Request-Timeout in `headers` with `seconds`. */
+export declare function setTimeoutHeader(headers: Record<string, string>, seconds: number): void;

package/dist/request-timeouts.generated.d.ts

@@ -0,0 +1,6 @@
+/** Smallest X-Request-Timeout the server accepts, in seconds. */
+export declare const REQUEST_TIMEOUT_MIN_SECONDS = 1;
+/** Largest X-Request-Timeout the server accepts, in seconds. */
+export declare const REQUEST_TIMEOUT_MAX_SECONDS = 300;
+/** [HTTP method, OpenAPI path template, default timeout in seconds]. */
+export declare const OPERATION_TIMEOUTS: ReadonlyArray<readonly [method: string, path: string, seconds: number]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mywebapi.com/sdk",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "license": "MIT",
   "description": "Typed TypeScript SDK for the CPlugin WebAPI v2 — manage trading-platform servers from Node.js and browsers. OAuth2, retries, pagination and SignalR real-time included; types regenerated from the OpenAPI spec so they never drift.",
   "type": "module",
@@ -48,7 +48,7 @@
     "url": "https://github.com/CPlugin/mywebapi.com-sdk-js/issues"
   },
   "scripts": {
-    "generate": "orval --config orval.config.ts",
+    "generate": "orval --config orval.config.ts && bun scripts/generate-request-timeouts.ts",
     "build": "rm -rf dist && mkdir -p dist/node dist/browser && bun build src/index.ts --outdir dist/node --target node --format esm --external @microsoft/signalr && bun build src/index.ts --outdir dist/browser --target browser --format esm --external @microsoft/signalr && tsc -p tsconfig.build.json --emitDeclarationOnly --declaration",
     "test": "bun test",
     "test:e2e": "WEBAPI_E2E=1 bun test e2e",
@@ -57,7 +57,7 @@
   },
   "devDependencies": {
     "@types/bun": "latest",
-    "orval": "8.19.0",
+    "orval": "8.38.0",
     "typedoc": "^0.28.19",
     "typescript": "^5.4.0"
   },