@qtsurfer/api-client 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 QTSurfer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

package/README.md

@@ -0,0 +1,119 @@
+# @qtsurfer/api-client
+
+Auto-generated TypeScript API client for the [QTSurfer API](https://github.com/QTSurfer/qtsurfer-api), produced from the OpenAPI 3.1 spec with [`@hey-api/openapi-ts`](https://heyapi.dev/).
+
+This package is intentionally thin: one function per operation, 1:1 with the spec. For workflow orchestration (polling, retries, domain objects, unified errors), use [`@qtsurfer/sdk`](https://github.com/QTSurfer/sdk-ts).
+
+- Tree-shakeable standalone functions.
+- Full type safety for requests, responses, and error shapes.
+- Native `fetch` based client via `@hey-api/client-fetch`.
+- Works in Node.js `>=20`, modern browsers, Deno, and Bun.
+
+## Installation
+
+```bash
+pnpm add @qtsurfer/api-client
+# or
+npm install @qtsurfer/api-client
+```
+
+## Quick start
+
+```ts
+import { client, getExchanges, prepareBacktesting } from '@qtsurfer/api-client';
+
+client.setConfig({
+  baseUrl: 'https://api.qtsurfer.com/v1',
+  headers: {
+    Authorization: `Bearer ${process.env.QTSURFER_TOKEN}`,
+  },
+});
+
+const { data: exchanges, error } = await getExchanges();
+if (error) throw error;
+
+console.log(exchanges);
+```
+
+## API surface
+
+All operations are exported as standalone functions; every operation accepts an `Options` object and returns `{ data, error, response }`.
+
+| Function | Method | Path | Purpose |
+| -------- | ------ | ---- | ------- |
+| `getExchanges` | GET | `/exchanges` | List available exchanges |
+| `getInstruments` | GET | `/exchange/{exchangeId}/instruments` | List instruments for an exchange |
+| `postStrategy` | POST | `/strategy` | Compile a strategy |
+| `getStrategyStatus` | GET | `/strategy/{strategyId}` | Poll strategy compilation status |
+| `prepareBacktesting` | POST | `/backtesting/prepare` | Start a data preparation job |
+| `getPreparationStatus` | GET | `/backtesting/prepare/{jobId}` | Poll preparation status |
+| `executeBacktesting` | POST | `/backtesting/execute` | Start a backtest execution |
+| `cancelExecution` | POST | `/backtesting/execute/{jobId}/cancel` | Cancel a running execution |
+| `getExecutionResult` | GET | `/backtesting/execute/{jobId}` | Poll or fetch execution results |
+
+All generated types (`Exchange`, `InstrumentDetail`, `BacktestJobResult`, `ResultMap`, etc.) are re-exported from the root.
+
+## Configuring the client
+
+The default client points to the staging server. Override via `setConfig` or by passing options inline:
+
+```ts
+import { client, getExchanges } from '@qtsurfer/api-client';
+
+// Global
+client.setConfig({
+  baseUrl: 'https://api.qtsurfer.com/v1',
+});
+
+// Per-call
+await getExchanges({
+  baseUrl: 'https://api.qtsurfer.com/v1',
+  headers: { 'X-Request-Id': '...' },
+});
+```
+
+To build your own isolated client (e.g. per-tenant), use `createClient` from `@hey-api/client-fetch`.
+
+## Error handling
+
+Each function returns a discriminated union. Narrow via `error` before using `data`:
+
+```ts
+const { data, error } = await prepareBacktesting({
+  body: {
+    /* PrepareBacktestingRequest */
+  },
+});
+
+if (error) {
+  console.error(error.code, error.message);
+  return;
+}
+
+console.log(data.jobId);
+```
+
+## Regenerating the client
+
+The `src/generated/` directory is a committed artifact produced from the OpenAPI spec hosted at [`QTSurfer/qtsurfer-api`](https://github.com/QTSurfer/qtsurfer-api/blob/main/openapi.yaml).
+
+```bash
+pnpm install
+pnpm generate   # runs @hey-api/openapi-ts against the remote spec
+pnpm lint       # tsc --noEmit
+pnpm build      # emits dist/ with .js + .d.ts
+```
+
+Configuration lives in `openapi-ts.config.ts`. To generate against a local checkout instead, change `input` to a relative path (e.g. `../qtsurfer-api/openapi.yaml`).
+
+## Development
+
+| Script | Description |
+| ------ | ----------- |
+| `pnpm generate` | Regenerate the client from the OpenAPI spec |
+| `pnpm lint` | Type-check without emitting |
+| `pnpm build` | Compile to `dist/` |
+
+## License
+
+Apache-2.0 — see [LICENSE](./LICENSE).

package/dist/generated/client.gen.d.ts

@@ -0,0 +1,13 @@
+import type { ClientOptions } from './types.gen';
+import { type Config, type ClientOptions as DefaultClientOptions } from '@hey-api/client-fetch';
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
+export declare const client: import("@hey-api/client-fetch").Client;
+//# sourceMappingURL=client.gen.d.ts.map

package/dist/generated/client.gen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.gen.d.ts","sourceRoot":"","sources":["../../src/generated/client.gen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,aAAa,IAAI,oBAAoB,EAA8B,MAAM,uBAAuB,CAAC;AAE5H;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,oBAAoB,GAAG,aAAa,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,CAAC,CAAC,KAAK,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC;AAE7K,eAAO,MAAM,MAAM,wCAEhB,CAAC"}

package/dist/generated/client.gen.js

@@ -0,0 +1,6 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { createClient, createConfig } from '@hey-api/client-fetch';
+export const client = createClient(createConfig({
+    baseUrl: 'https://api.staging.qtsurfer.com/v1'
+}));
+//# sourceMappingURL=client.gen.js.map

package/dist/generated/client.gen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.gen.js","sourceRoot":"","sources":["../../src/generated/client.gen.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAGrD,OAAO,EAA2D,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAY5H,MAAM,CAAC,MAAM,MAAM,GAAG,YAAY,CAAC,YAAY,CAAgB;IAC3D,OAAO,EAAE,qCAAqC;CACjD,CAAC,CAAC,CAAC"}

package/dist/generated/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.gen';
+export * from './sdk.gen';
+//# 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":"AACA,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC"}

package/dist/generated/index.js

@@ -0,0 +1,4 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
+export * from './sdk.gen';
+//# sourceMappingURL=index.js.map

package/dist/generated/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC"}

package/dist/generated/schemas.gen.d.ts

@@ -0,0 +1,284 @@
+export declare const ResponseErrorSchema: {
+    readonly description: "General response error";
+    readonly type: "object";
+    readonly required: readonly ["code", "message"];
+    readonly properties: {
+        readonly code: {
+            readonly description: "Status code";
+            readonly type: "integer";
+            readonly example: 400;
+        };
+        readonly message: {
+            readonly description: "Error description";
+            readonly type: "string";
+            readonly example: "Invalid request";
+        };
+    };
+};
+export declare const InstrumentSchema: {
+    readonly description: "Exchange instrument identifier (e.g. a currency pair)";
+    readonly type: "string";
+    readonly example: "BTC/USDT";
+};
+export declare const InstrumentDetailSchema: {
+    readonly description: "Exchange instrument with data availability and market info";
+    readonly type: "object";
+    readonly required: readonly ["id", "base", "quote"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly description: "Instrument identifier (e.g. currency pair)";
+            readonly example: "BTC/USDT";
+        };
+        readonly base: {
+            readonly type: "string";
+            readonly description: "Base currency";
+            readonly example: "BTC";
+        };
+        readonly quote: {
+            readonly type: "string";
+            readonly description: "Quote currency";
+            readonly example: "USDT";
+        };
+        readonly dataFrom: {
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly description: "Earliest timestamp with quality-verified data available for backtesting";
+            readonly example: "2026-03-17T00:00:00Z";
+        };
+        readonly dataTo: {
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly description: "Latest timestamp with quality-verified data available for backtesting";
+            readonly example: "2026-03-31T18:00:00Z";
+        };
+        readonly lastPrice: {
+            readonly type: "number";
+            readonly format: "double";
+            readonly description: "Last traded price";
+            readonly example: 84250.5;
+        };
+        readonly volume24h: {
+            readonly type: "number";
+            readonly format: "double";
+            readonly description: "Trading volume in the last 24 hours (in quote currency)";
+            readonly example: 1234567.89;
+        };
+    };
+};
+export declare const ExchangeSchema: {
+    readonly description: "Exchange service provider";
+    readonly type: "object";
+    readonly required: readonly ["id", "name"];
+    readonly properties: {
+        readonly id: {
+            readonly description: "Unique identifier for the exchange";
+            readonly type: "string";
+            readonly example: "binance";
+        };
+        readonly name: {
+            readonly description: "Name of the exchange";
+            readonly type: "string";
+            readonly example: "Binance";
+        };
+        readonly description: {
+            readonly description: "Description of the exchange";
+            readonly type: "string";
+            readonly example: "Binance cryptocurrency exchange";
+        };
+    };
+};
+export declare const DataSourceTypeSchema: {
+    readonly type: "string";
+    readonly description: "Managed exchange data sources available for backtesting. Currently only ticker is supported; kline and funding rate support is planned.";
+    readonly enum: readonly ["ticker"];
+    readonly example: "ticker";
+};
+export declare const JobStateSchema: {
+    readonly type: "object";
+    readonly description: "Information about a single job";
+    readonly required: readonly ["contextId", "status", "size", "completed"];
+    readonly properties: {
+        readonly contextId: {
+            readonly type: "string";
+            readonly description: "Unique context ID for the job";
+            readonly example: "jctx:ticker:4a627755-7f5a-4297-b647-8dddd8aee416:binance:1rabbrpk5r4kkegs83w6qr:btc/usdt:2o8heaioicr0edvx5ybcap";
+        };
+        readonly status: {
+            readonly type: "string";
+            readonly description: "Current status of the job";
+            readonly enum: readonly ["New", "Started", "Completed", "Aborted", "Failed"];
+            readonly example: "Completed";
+        };
+        readonly statusDetail: {
+            readonly type: readonly ["string", "null"];
+            readonly description: "Detailed status information, if available";
+            readonly example: "Job completed with error code 5001";
+        };
+        readonly size: {
+            readonly type: "integer";
+            readonly description: "Total size of the data being prepared";
+            readonly example: 100;
+        };
+        readonly completed: {
+            readonly type: "integer";
+            readonly description: "The amount of data processed so far";
+            readonly example: 50;
+        };
+        readonly startTime: {
+            readonly type: readonly ["string", "null"];
+            readonly format: "date-time";
+            readonly description: "Timestamp for when the preparation started";
+            readonly example: "2025-01-04T14:00:00Z";
+        };
+        readonly endTime: {
+            readonly type: readonly ["string", "null"];
+            readonly format: "date-time";
+            readonly description: "Timestamp for when the preparation finished";
+            readonly example: "2025-01-04T14:00:20Z";
+        };
+    };
+};
+export declare const AcceptedJobSchema: {
+    readonly type: "object";
+    readonly description: "Response returned by async endpoints (`202 Accepted`). The `jobId` is deterministic for the\nsame input parameters — repeated calls with identical params return the same id.\n";
+    readonly required: readonly ["jobId"];
+    readonly properties: {
+        readonly jobId: {
+            readonly type: "string";
+            readonly description: "Unique job identifier; use this to poll for completion.";
+            readonly example: "13RBLGQlPnfDjO6wyKSX8i";
+        };
+    };
+    readonly example: {
+        readonly jobId: "13RBLGQlPnfDjO6wyKSX8i";
+    };
+};
+export declare const BacktestJobResultSchema: {
+    readonly type: "object";
+    readonly description: "Backtest job result.";
+    readonly required: readonly ["results", "state"];
+    readonly properties: {
+        readonly results: {
+            readonly $ref: "#/components/schemas/ResultMap";
+        };
+        readonly state: {
+            readonly $ref: "#/components/schemas/JobState";
+        };
+    };
+};
+export declare const ResultMapSchema: {
+    readonly type: "object";
+    readonly description: "Execution result map. Always includes core fields (hostName, iops, strategyId, instrument). Yield metrics (pnlTotal, totalTrades, winRate, etc.) are present when the strategy emitted at least one trade. When signal storage is enabled, includes signal fields described below.";
+    readonly required: readonly ["strategyId", "instrument"];
+    readonly properties: {
+        readonly hostName: {
+            readonly type: "string";
+            readonly description: "Hostname of the worker node that executed the strategy";
+            readonly example: "backtesting-job-worker-84b569dff9-dr4lb";
+        };
+        readonly iops: {
+            readonly type: "number";
+            readonly format: "double";
+            readonly description: "Instrument operations per second throughput during execution";
+            readonly example: 123956.53;
+        };
+        readonly strategyId: {
+            readonly type: "string";
+            readonly description: "Redis key of the compiled strategy used for execution. Format: strategy:{userId}:ticker:{compilationId}";
+            readonly example: "strategy:4a627755-7f5a-4297-b647-8dddd8aee416:ticker:2iyvtenlzh9dabqtxn7nbv";
+        };
+        readonly instrument: {
+            readonly type: "string";
+            readonly description: "The instrument (currency pair) that was backtested";
+            readonly example: "BTC/USDT";
+        };
+        readonly pnlTotal: {
+            readonly type: "number";
+            readonly format: "double";
+            readonly description: "Total profit and loss in the output currency";
+            readonly example: 42.75;
+        };
+        readonly totalTrades: {
+            readonly type: "integer";
+            readonly format: "int64";
+            readonly description: "Total number of trades executed by the strategy";
+            readonly example: 156;
+        };
+        readonly winRate: {
+            readonly type: "number";
+            readonly format: "double";
+            readonly description: "Percentage of profitable trades (0-100)";
+            readonly example: 58.33;
+        };
+        readonly sharpeRatio: {
+            readonly type: "number";
+            readonly format: "double";
+            readonly description: "Risk-adjusted return ratio (mean return / standard deviation of returns)";
+            readonly example: 1.245;
+        };
+        readonly sortinoRatio: {
+            readonly type: "number";
+            readonly format: "double";
+            readonly description: "Downside risk-adjusted return ratio (mean return / downside deviation)";
+            readonly example: 1.872;
+        };
+        readonly cagr: {
+            readonly type: "number";
+            readonly format: "double";
+            readonly description: "Compound Annual Growth Rate";
+            readonly example: 0.1534;
+        };
+        readonly maxDrawdown: {
+            readonly type: "number";
+            readonly format: "double";
+            readonly description: "Maximum absolute drawdown in the output currency";
+            readonly example: 12.5;
+        };
+        readonly maxDrawdownPercent: {
+            readonly type: "number";
+            readonly format: "double";
+            readonly description: "Maximum percentage drawdown from peak equity";
+            readonly example: 8.75;
+        };
+        readonly signalCount: {
+            readonly type: "integer";
+            readonly description: "Number of signals emitted during strategy execution";
+            readonly example: 100000;
+        };
+        readonly signalsId: {
+            readonly type: "string";
+            readonly description: "Storage key for the signal Parquet file. Format: {userId}/exec/{exchange}/{jobId}";
+            readonly example: "4a627755-7f5a-4297-b647-8dddd8aee416/exec/binance/3vsndwikcuaatjmb83fjtl";
+        };
+        readonly signalsUrl: {
+            readonly type: "string";
+            readonly format: "uri";
+            readonly description: "Public HTTPS URL to the Parquet file. Computed at setup time from publicBaseUrl + signalsId + .parquet. Available even before upload completes.";
+            readonly example: "https://storage.qtsurfer.com/4a627755-7f5a-4297-b647-8dddd8aee416/exec/binance/3vsndwikcuaatjmb83fjtl.parquet";
+        };
+        readonly signalsUpload: {
+            readonly type: "string";
+            readonly enum: readonly ["Done", "Failed", "Skipped"];
+            readonly description: "Upload status. Done = file uploaded to R2. Failed = upload error (see signalsUploadReason). Skipped = no signals emitted or storage not configured.";
+            readonly example: "Done";
+        };
+        readonly signalsUploadedAt: {
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly description: "ISO 8601 timestamp of when the upload completed. Only present when signalsUpload is Done.";
+            readonly example: "2026-03-18T13:21:48.170Z";
+        };
+        readonly signalsUploadReason: {
+            readonly type: "string";
+            readonly description: "Human-readable reason when signalsUpload is Failed or Skipped.";
+            readonly example: "parquet file empty or missing after close";
+        };
+    };
+};
+export declare const strategyIdSchema: {
+    readonly description: "Unique identifier for a compiled strategy";
+    readonly type: "string";
+    readonly example: "6bsh31ikwkuivhtgcoa6s4";
+};
+//# sourceMappingURL=schemas.gen.d.ts.map

package/dist/generated/schemas.gen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.gen.d.ts","sourceRoot":"","sources":["../../src/generated/schemas.gen.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;CAgBtB,CAAC;AAEX,eAAO,MAAM,gBAAgB;;;;CAInB,CAAC;AAEX,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6CzB,CAAC;AAEX,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;CAqBjB,CAAC;AAEX,eAAO,MAAM,oBAAoB;;;;;CAKvB,CAAC;AAEX,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4CjB,CAAC;AAEX,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;CAgBpB,CAAC;AAEX,eAAO,MAAM,uBAAuB;;;;;;;;;;;;CAY1B,CAAC;AAEX,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4GlB,CAAC;AAEX,eAAO,MAAM,gBAAgB;;;;CAInB,CAAC"}