roicai 0.0.1 → 0.2.0

package/dist/generated/stockPrices/models.d.ts

@@ -0,0 +1,33 @@
+export interface V3HistoricalPriceList {
+    /**
+     * ISO 4217 code every quote in `data` is priced in, e.g. `USD`. A ticker is
+     * only ever quoted in one currency. Null when the page carries no priced
+     * quotes.
+     */
+    currency: string | null;
+    /**
+     * The historical prices in this page.
+     */
+    data: {
+        close: number;
+        date: string;
+        high: number | null;
+        low: number | null;
+        open: number | null;
+        volume: number | null;
+    }[];
+    /**
+     * URL for the next page, or null when this is the last page.
+     */
+    nextPageUrl: string | null;
+    /**
+     * URL for the previous page, or null when this is the first page.
+     */
+    previousPageUrl: string | null;
+    /**
+     * The qualified ticker symbol every quote in `data` belongs to, e.g.
+     * `NASDAQ:AAPL`. Present even when `data` is empty.
+     */
+    symbol: string;
+}
+export declare const V3HistoricalPriceListCodec: import("../_/codec.js").Codec;

package/dist/generated/stockPrices/models.js

@@ -0,0 +1,8 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { object } from "../_/index.js";
+export const V3HistoricalPriceListCodec = object([
+    ["next_page_url", "nextPageUrl"],
+    ["previous_page_url", "previousPageUrl"],
+]);
+//# sourceMappingURL=models.js.map

package/dist/generated/stockPrices/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/generated/stockPrices/models.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AA4BvC,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC;IAC/C,CAAC,eAAe,EAAE,aAAa,CAAC;IAChC,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;CACzC,CAAC,CAAC"}

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

@@ -0,0 +1,64 @@
+import { type BaseClientOptions, type RequestOptions, Transport } from "../_/index.js";
+import { type V3StockSplitList } from "./models.js";
+export interface ClientOptions extends BaseClientOptions {
+    /**
+     * The URL the paths of the API are relative to.
+     */
+    baseUrl: string;
+}
+export interface Client {
+    /**
+     * List stock splits
+     *
+     * Returns a page of per-ticker stock-split events across all tickers, or one
+     * ticker via the identifier filter.
+     */
+    list(request?: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+}
+export declare function createClient(options: ClientOptions): Client;
+export declare function bind(transport: Transport): Client;
+export interface ListRequest {
+    /**
+     * Browser-friendly alternative to Bearer authentication. Use either this
+     * parameter or the Authorization header, never both.
+     */
+    apikey?: string;
+    /**
+     * Restrict results to a single ticker. Accepts an exchange and symbol
+     * separated by a colon (e.g. `NASDAQ:AAPL`), a ticker ID, or a FIGI. Stock
+     * splits are per ticker, so results are the split events for that exact
+     * listing. Omit to list splits across all tickers.
+     */
+    identifier?: string;
+    /**
+     * Return splits executed on exactly this date.
+     */
+    date?: string;
+    /**
+     * Return splits whose execution date is on or after this date.
+     */
+    dateGte?: string;
+    /**
+     * Return splits whose execution date is strictly after this date.
+     */
+    dateGt?: string;
+    /**
+     * Return splits whose execution date is on or before this date.
+     */
+    dateLte?: string;
+    /**
+     * Return splits whose execution date is strictly before this date.
+     */
+    dateLt?: string;
+    order?: "asc" | "desc";
+    /**
+     * Maximum number of resources to return. Defaults to 100.
+     */
+    limit?: string | number;
+    /**
+     * Opaque page token from a previous response. Prefer following the returned
+     * page URLs directly.
+     */
+    page?: string;
+}
+export type ListResponse = V3StockSplitList;

package/dist/generated/stockSplits/client.js

@@ -0,0 +1,21 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { Transport, } from "../_/index.js";
+import { V3ErrorCodec } from "../models.js";
+import { V3StockSplitListCodec } from "./models.js";
+export function createClient(options) {
+    return bind(new Transport(options));
+}
+export function bind(transport) {
+    return {
+        list: (request, options) => transport.send(ListOperation, request, options),
+    };
+}
+const ListOperation = {
+    method: "GET",
+    route: "/v3.0.0/stock-splits",
+    query: { apikey: "apikey", identifier: "identifier", date: "date", dateGte: "date.gte", dateGt: "date.gt", dateLte: "date.lte", dateLt: "date.lt", order: "order", limit: "limit", page: "page" },
+    response: V3StockSplitListCodec,
+    errors: { "400": V3ErrorCodec, "401": V3ErrorCodec, "402": V3ErrorCodec, "429": V3ErrorCodec, "500": V3ErrorCodec, "503": V3ErrorCodec },
+};
+//# sourceMappingURL=client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/generated/stockSplits/client.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAIL,SAAS,GACV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAyB,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAmB3E,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,OAAO,IAAI,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,SAAoB;IACvC,OAAO;QACL,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;KAC5E,CAAC;AACJ,CAAC;AAiDD,MAAM,aAAa,GAAc;IAC/B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,sBAAsB;IAC7B,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IACjM,QAAQ,EAAE,qBAAqB;IAC/B,MAAM,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;CACzI,CAAC"}

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

@@ -0,0 +1,5 @@
+export { ApiError } from "../_/index.js";
+export type { RequestOptions } from "../_/index.js";
+export { createClient } from "./client.js";
+export type { Client, ClientOptions, ListRequest, ListResponse, } from "./client.js";
+export type { V3StockSplitList } from "./models.js";

package/dist/generated/stockSplits/index.js

@@ -0,0 +1,5 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+export { ApiError } from "../_/index.js";
+export { createClient } from "./client.js";
+//# sourceMappingURL=index.js.map

package/dist/generated/stockSplits/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generated/stockSplits/index.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/generated/stockSplits/models.d.ts

@@ -0,0 +1,23 @@
+export interface V3StockSplitList {
+    data: {
+        currency: string | null;
+        exchange: string;
+        executionDate: string;
+        factor: number;
+        id: string;
+        isReverse: boolean;
+        mic: string | null;
+        object: "v3.market_data.stock_split";
+        postSplitPrice: number | null;
+        postSplitShares: number | null;
+        preSplitPrice: number | null;
+        preSplitShares: number | null;
+        splitFrom: string | number | null;
+        splitTo: string | number | null;
+        symbol: string;
+        updatedAt: string;
+    }[];
+    nextPageUrl: string | null;
+    previousPageUrl: string | null;
+}
+export declare const V3StockSplitListCodec: import("../_/codec.js").Codec;

package/dist/generated/stockSplits/models.js

@@ -0,0 +1,9 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { array, object } from "../_/index.js";
+export const V3StockSplitListCodec = object([
+    ["data", null, array(object([["execution_date", "executionDate"], ["is_reverse", "isReverse"], ["post_split_price", "postSplitPrice"], ["post_split_shares", "postSplitShares"], ["pre_split_price", "preSplitPrice"], ["pre_split_shares", "preSplitShares"], ["split_from", "splitFrom"], ["split_to", "splitTo"], ["updated_at", "updatedAt"]]))],
+    ["next_page_url", "nextPageUrl"],
+    ["previous_page_url", "previousPageUrl"],
+]);
+//# sourceMappingURL=models.js.map

package/dist/generated/stockSplits/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/generated/stockSplits/models.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAQ9C,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC;IAC1C,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,EAAE,eAAe,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,EAAE,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,EAAE,CAAC,iBAAiB,EAAE,eAAe,CAAC,EAAE,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACpV,CAAC,eAAe,EAAE,aAAa,CAAC;IAChC,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;CACzC,CAAC,CAAC"}

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

@@ -0,0 +1,94 @@
+import { type BaseClientOptions, type RequestOptions, Transport } from "../_/index.js";
+import { type V3Ticker, type V3TickerList } from "./models.js";
+export interface ClientOptions extends BaseClientOptions {
+    /**
+     * The URL the paths of the API are relative to.
+     */
+    baseUrl: string;
+}
+export interface Client {
+    /**
+     * List all tickers
+     *
+     * Returns a filtered page of ticker resources.
+     */
+    list(request?: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+    /**
+     * Retrieve a ticker
+     *
+     * Retrieves one ticker by public ID or supported market identifier.
+     */
+    retrieve(request: RetrieveRequest, options?: RequestOptions): Promise<RetrieveResponse>;
+    /**
+     * Search tickers
+     *
+     * Ranks ticker codes and qualified symbols with typo-tolerant ranking by
+     * default. Set 'search_by' to 'name' to rank company names, or to another
+     * ticker field (such as 'isin' or 'figi') to match that field exactly.
+     */
+    search(request: SearchRequest, options?: RequestOptions): Promise<SearchResponse>;
+}
+export declare function createClient(options: ClientOptions): Client;
+export declare function bind(transport: Transport): Client;
+export interface ListRequest {
+    /**
+     * Browser-friendly alternative to Bearer authentication. Use either this
+     * parameter or the Authorization header, never both.
+     */
+    apikey?: string;
+    exchange?: string;
+    /**
+     * Filter by exact security type: 'dr', 'fund', or 'stock'.
+     */
+    type?: string;
+    isPrimary?: boolean | string;
+    status?: "listed" | "delisted";
+    /**
+     * Filter by two-letter listing country code: the country of the exchange
+     * where the ticker trades, not the company's domicile, e.g. 'US' or 'JP'.
+     */
+    listingCountryCode?: string;
+    order?: "asc" | "desc";
+    /**
+     * Maximum number of resources to return. Defaults to 500.
+     */
+    limit?: string | number;
+    /**
+     * Opaque page token from a previous response. Prefer following the returned
+     * page URLs directly.
+     */
+    page?: string;
+}
+export type ListResponse = V3TickerList;
+export interface RetrieveRequest {
+    /**
+     * A ticker ID, an exchange and symbol separated by a colon (e.g.
+     * `NASDAQ:AAPL`), or a FIGI.
+     */
+    identifier: string;
+}
+export type RetrieveResponse = V3Ticker;
+export interface SearchRequest {
+    /**
+     * Browser-friendly alternative to Bearer authentication. Use either this
+     * parameter or the Authorization header, never both.
+     */
+    apikey?: string;
+    query: string;
+    /**
+     * Fields used for matching. 'symbol' (the default) ranks ticker codes and
+     * qualified symbols; 'name' ranks company names. Any other value matches that
+     * exact ticker field.
+     */
+    searchBy?: "symbol" | "name" | "exchange" | "mic" | "type" | "primary_symbol" | "market" | "listing_country_code" | "trading_currency" | "fundamental_currency" | "cik" | "cusip" | "isin" | "figi" | "figi_composite" | "figi_share_class";
+    /**
+     * Maximum number of resources to return. Defaults to 500.
+     */
+    limit?: string | number;
+    /**
+     * Opaque page token from a previous response. Prefer following the returned
+     * page URLs directly.
+     */
+    page?: string;
+}
+export type SearchResponse = V3TickerList;

package/dist/generated/tickers/client.js

@@ -0,0 +1,36 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { Transport, } from "../_/index.js";
+import { V3ErrorCodec } from "../models.js";
+import { V3TickerCodec, V3TickerListCodec, } from "./models.js";
+export function createClient(options) {
+    return bind(new Transport(options));
+}
+export function bind(transport) {
+    return {
+        list: (request, options) => transport.send(ListOperation, request, options),
+        retrieve: (request, options) => transport.send(RetrieveOperation, request, options),
+        search: (request, options) => transport.send(SearchOperation, request, options),
+    };
+}
+const ListOperation = {
+    method: "GET",
+    route: "/v3.0.0/tickers",
+    query: { apikey: "apikey", exchange: "exchange", type: "type", isPrimary: "is_primary", status: "status", listingCountryCode: "listing_country_code", order: "order", limit: "limit", page: "page" },
+    response: V3TickerListCodec,
+    errors: { "400": V3ErrorCodec, "401": V3ErrorCodec, "429": V3ErrorCodec, "500": V3ErrorCodec, "503": V3ErrorCodec },
+};
+const RetrieveOperation = {
+    method: "GET",
+    route: "/v3.0.0/tickers/{identifier}",
+    response: V3TickerCodec,
+    errors: { "400": V3ErrorCodec, "401": V3ErrorCodec, "404": V3ErrorCodec, "429": V3ErrorCodec, "500": V3ErrorCodec, "503": V3ErrorCodec },
+};
+const SearchOperation = {
+    method: "GET",
+    route: "/v3.0.0/tickers/search",
+    query: { apikey: "apikey", query: "query", searchBy: "search_by", limit: "limit", page: "page" },
+    response: V3TickerListCodec,
+    errors: { "400": V3ErrorCodec, "401": V3ErrorCodec, "429": V3ErrorCodec, "500": V3ErrorCodec, "503": V3ErrorCodec },
+};
+//# sourceMappingURL=client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/generated/tickers/client.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAIL,SAAS,GACV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAEL,aAAa,EAEb,iBAAiB,GAClB,MAAM,aAAa,CAAC;AAgCrB,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,OAAO,IAAI,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,SAAoB;IACvC,OAAO;QACL,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;QAC3E,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,EAAE,OAAO,EAAE,OAAO,CAAC;QACnF,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,EAAE,OAAO,CAAC;KAChF,CAAC;AACJ,CAAC;AAsED,MAAM,aAAa,GAAc;IAC/B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,iBAAiB;IACxB,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IACpM,QAAQ,EAAE,iBAAiB;IAC3B,MAAM,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;CACpH,CAAC;AAEF,MAAM,iBAAiB,GAAc;IACnC,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,8BAA8B;IACrC,QAAQ,EAAE,aAAa;IACvB,MAAM,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;CACzI,CAAC;AAEF,MAAM,eAAe,GAAc;IACjC,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,wBAAwB;IAC/B,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IAChG,QAAQ,EAAE,iBAAiB;IAC3B,MAAM,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;CACpH,CAAC"}

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

@@ -0,0 +1,5 @@
+export { ApiError } from "../_/index.js";
+export type { RequestOptions } from "../_/index.js";
+export { createClient } from "./client.js";
+export type { Client, ClientOptions, ListRequest, ListResponse, RetrieveRequest, RetrieveResponse, SearchRequest, SearchResponse, } from "./client.js";
+export type { V3Ticker, V3TickerList, } from "./models.js";

package/dist/generated/tickers/index.js

@@ -0,0 +1,5 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+export { ApiError } from "../_/index.js";
+export { createClient } from "./client.js";
+//# sourceMappingURL=index.js.map

package/dist/generated/tickers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generated/tickers/index.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/generated/tickers/models.d.ts

@@ -0,0 +1,55 @@
+export interface V3Ticker {
+    cik: string | null;
+    cusip: string | null;
+    exchange: string;
+    figi: string | null;
+    figiComposite: string | null;
+    figiShareClass: string | null;
+    fundamentalCurrency: string | null;
+    id: string;
+    isPrimary: boolean | null;
+    isin: string | null;
+    listingCountryCode: string | null;
+    market: string | null;
+    mic: string | null;
+    name: string | null;
+    object: "v3.reference.ticker";
+    primarySymbol: string | null;
+    /**
+     * Listing status: 'listed' while actively trading, 'delisted' after removal.
+     */
+    status: "listed" | "delisted" | null;
+    symbol: string;
+    tradingCurrency: string | null;
+    type: string | null;
+    typeSpecifications: string[] | null;
+}
+export interface V3TickerList {
+    data: {
+        cik: string | null;
+        cusip: string | null;
+        exchange: string;
+        figi: string | null;
+        figiComposite: string | null;
+        figiShareClass: string | null;
+        fundamentalCurrency: string | null;
+        id: string;
+        isPrimary: boolean | null;
+        isin: string | null;
+        listingCountryCode: string | null;
+        market: string | null;
+        mic: string | null;
+        name: string | null;
+        object: "v3.reference.ticker";
+        primarySymbol: string | null;
+        status: "listed" | "delisted" | null;
+        symbol: string;
+        tradingCurrency: string | null;
+        type: string | null;
+        typeSpecifications: string[] | null;
+    }[];
+    nextPageUrl: string | null;
+    previousPageUrl: string | null;
+}
+export declare const V3TickerCodec: import("../_/codec.js").Codec;
+export declare const V3TickerListCodec: import("../_/codec.js").Codec;

package/dist/generated/tickers/models.js

@@ -0,0 +1,19 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { array, object } from "../_/index.js";
+export const V3TickerCodec = object([
+    ["figi_composite", "figiComposite"],
+    ["figi_share_class", "figiShareClass"],
+    ["fundamental_currency", "fundamentalCurrency"],
+    ["is_primary", "isPrimary"],
+    ["listing_country_code", "listingCountryCode"],
+    ["primary_symbol", "primarySymbol"],
+    ["trading_currency", "tradingCurrency"],
+    ["type_specifications", "typeSpecifications"],
+]);
+export const V3TickerListCodec = object([
+    ["data", null, array(object([["figi_composite", "figiComposite"], ["figi_share_class", "figiShareClass"], ["fundamental_currency", "fundamentalCurrency"], ["is_primary", "isPrimary"], ["listing_country_code", "listingCountryCode"], ["primary_symbol", "primarySymbol"], ["trading_currency", "tradingCurrency"], ["type_specifications", "typeSpecifications"]]))],
+    ["next_page_url", "nextPageUrl"],
+    ["previous_page_url", "previousPageUrl"],
+]);
+//# sourceMappingURL=models.js.map

package/dist/generated/tickers/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/generated/tickers/models.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAmC9C,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC;IAClC,CAAC,gBAAgB,EAAE,eAAe,CAAC;IACnC,CAAC,kBAAkB,EAAE,gBAAgB,CAAC;IACtC,CAAC,sBAAsB,EAAE,qBAAqB,CAAC;IAC/C,CAAC,YAAY,EAAE,WAAW,CAAC;IAC3B,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAC9C,CAAC,gBAAgB,EAAE,eAAe,CAAC;IACnC,CAAC,kBAAkB,EAAE,iBAAiB,CAAC;IACvC,CAAC,qBAAqB,EAAE,oBAAoB,CAAC;CAC9C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;IACtC,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,EAAE,eAAe,CAAC,EAAE,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,EAAE,CAAC,sBAAsB,EAAE,qBAAqB,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,EAAE,CAAC,gBAAgB,EAAE,eAAe,CAAC,EAAE,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAAE,CAAC,qBAAqB,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;IACvW,CAAC,eAAe,EAAE,aAAa,CAAC;IAChC,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;CACzC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import { type Client as GeneratedClient, type ClientOptions as GeneratedClientOptions } from './generated/index.js';
+import { type Paginated } from './pagination.js';
+export * from './generated/index.js';
+export type { Page, PagePromise, Paginated } from './pagination.js';
+/**
+ * The URL of the ROIC.ai API.
+ */
+export declare const DEFAULT_BASE_URL = "https://api.roic.ai";
+/**
+ * The options of a client: your API key as `token`, and optionally a `baseUrl`,
+ * `fetch`, `headers` or `query` to send with every request.
+ */
+export interface ClientOptions extends Omit<GeneratedClientOptions, 'baseUrl'> {
+    /**
+     * The URL the paths of the API are relative to. Defaults to {@link DEFAULT_BASE_URL}.
+     */
+    baseUrl?: string;
+}
+/**
+ * A client of the ROIC.ai API. Its list methods return a {@link PagePromise}:
+ * await it for the first page, or iterate it with `for await` for every item.
+ */
+export type Client = Paginated<GeneratedClient>;
+/**
+ * Returns a client of the ROIC.ai API.
+ *
+ * ```ts
+ * const roicai = createClient({ token: process.env.ROICAI_API_KEY! });
+ * const ticker = await roicai.tickers.retrieve({ identifier: 'NASDAQ:AAPL' });
+ * for await (const price of roicai.stockPrices.list({ identifier: 'NASDAQ:AAPL', dateGte: '2025-01-01' })) {
+ *   console.log(price.date, price.close);
+ * }
+ * ```
+ */
+export declare function createClient(options: ClientOptions): Client;

package/dist/index.js

@@ -0,0 +1,22 @@
+import { createClient as createGeneratedClient, } from './generated/index.js';
+import { paginate } from './pagination.js';
+export * from './generated/index.js';
+/**
+ * The URL of the ROIC.ai API.
+ */
+export const DEFAULT_BASE_URL = 'https://api.roic.ai';
+/**
+ * Returns a client of the ROIC.ai API.
+ *
+ * ```ts
+ * const roicai = createClient({ token: process.env.ROICAI_API_KEY! });
+ * const ticker = await roicai.tickers.retrieve({ identifier: 'NASDAQ:AAPL' });
+ * for await (const price of roicai.stockPrices.list({ identifier: 'NASDAQ:AAPL', dateGte: '2025-01-01' })) {
+ *   console.log(price.date, price.close);
+ * }
+ * ```
+ */
+export function createClient(options) {
+    return paginate(createGeneratedClient({ ...options, baseUrl: options.baseUrl ?? DEFAULT_BASE_URL }));
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,IAAI,qBAAqB,GACtC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAkB,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3D,cAAc,sBAAsB,CAAC;AAGrC;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,qBAAqB,CAAC;AAmBtD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,OAAO,QAAQ,CAAC,qBAAqB,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,gBAAgB,EAAE,CAAC,CAAC,CAAC;AACvG,CAAC"}

package/dist/pagination.d.ts

@@ -0,0 +1,42 @@
+/**
+ * A page of a list: its items in `data`, and the URL of the next page, or
+ * `null` on the last page.
+ */
+export interface Page<T> {
+    data: T[];
+    nextPageUrl: string | null;
+}
+/**
+ * The result of a method that lists: await it for the first page, or iterate
+ * it with `for await` for every item of every page, fetching each page as it
+ * is reached.
+ */
+export interface PagePromise<P extends Page<T>, T> extends Promise<P>, AsyncIterable<T> {
+    /**
+     * Calls `onItem` with every item of every page, in order, and waits for
+     * any promise it returns. Stops early when `onItem` returns `false`.
+     */
+    autoPagingEach(onItem: (item: T) => boolean | void | Promise<boolean | void>): Promise<void>;
+    /**
+     * Returns the items of every page, up to `limit` of them. `limit` is
+     * required and at most 10,000, so a long list can't use up memory; iterate
+     * longer lists with `for await` or {@link autoPagingEach}.
+     */
+    autoPagingToArray(options: {
+        limit: number;
+    }): Promise<T[]>;
+}
+/**
+ * The client `C`, with each method that returns a {@link Page} returning a
+ * {@link PagePromise} instead.
+ */
+export type Paginated<C> = {
+    [K in keyof C]: C[K] extends (...args: infer A) => Promise<infer P> ? P extends Page<infer T> ? (...args: A) => PagePromise<P, T> : C[K] : C[K] extends object ? Paginated<C[K]> : C[K];
+};
+/**
+ * Returns `client` with its list methods returning {@link PagePromise}s. Each
+ * next page is the same request with the `page` token of the previous page's
+ * `nextPageUrl`, since the API only accepts a token with the filters it was
+ * issued for.
+ */
+export declare function paginate<C extends object>(client: C): Paginated<C>;

package/dist/pagination.js

@@ -0,0 +1,92 @@
+const MAX_TO_ARRAY = 10_000;
+// The methods whose responses can be pages.
+const LIST_METHODS = new Set(['list', 'search']);
+/**
+ * Returns `client` with its list methods returning {@link PagePromise}s. Each
+ * next page is the same request with the `page` token of the previous page's
+ * `nextPageUrl`, since the API only accepts a token with the filters it was
+ * issued for.
+ */
+export function paginate(client) {
+    return wrap(client, new WeakMap());
+}
+function wrap(target, cache) {
+    const cached = cache.get(target);
+    if (cached)
+        return cached;
+    const proxy = new Proxy(target, {
+        get(obj, key, receiver) {
+            const value = Reflect.get(obj, key, receiver);
+            if (typeof value === 'function' && typeof key === 'string' && LIST_METHODS.has(key)) {
+                return (request, options) => {
+                    const fetchPage = (page) => value.call(obj, page === undefined ? request : { ...request, page }, options);
+                    return pagePromise(fetchPage(), fetchPage);
+                };
+            }
+            if (typeof value === 'object' && value !== null) {
+                return wrap(value, cache);
+            }
+            return value;
+        },
+    });
+    cache.set(target, proxy);
+    return proxy;
+}
+function pagePromise(first, fetchPage) {
+    async function* items() {
+        let page = await first;
+        const seen = new Set();
+        for (;;) {
+            if (!isPage(page)) {
+                throw new TypeError('The response is not a page of a list, so it cannot be iterated.');
+            }
+            yield* page.data;
+            const token = nextToken(page.nextPageUrl);
+            // A token already followed would loop forever.
+            if (token === null || seen.has(token))
+                return;
+            seen.add(token);
+            page = await fetchPage(token);
+        }
+    }
+    async function autoPagingEach(onItem) {
+        for await (const item of items()) {
+            if ((await onItem(item)) === false)
+                return;
+        }
+    }
+    async function autoPagingToArray(options) {
+        const limit = options?.limit;
+        if (!Number.isInteger(limit) || limit < 1) {
+            throw new TypeError('autoPagingToArray needs a positive integer limit, such as { limit: 1000 }.');
+        }
+        if (limit > MAX_TO_ARRAY) {
+            throw new TypeError(`autoPagingToArray takes a limit of at most ${MAX_TO_ARRAY}; iterate longer lists with for await or autoPagingEach.`);
+        }
+        const result = [];
+        for await (const item of items()) {
+            result.push(item);
+            if (result.length >= limit)
+                break;
+        }
+        return result;
+    }
+    return Object.assign(first, {
+        [Symbol.asyncIterator]: items,
+        autoPagingEach,
+        autoPagingToArray,
+    });
+}
+function isPage(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        Array.isArray(value.data) &&
+        'nextPageUrl' in value);
+}
+function nextToken(nextPageUrl) {
+    if (!nextPageUrl)
+        return null;
+    // The URL may be relative; the base only lets it parse.
+    return new URL(nextPageUrl, 'https://api.roic.ai').searchParams.get('page');
+}
+//# sourceMappingURL=pagination.js.map

package/dist/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AA0CA,MAAM,YAAY,GAAG,MAAM,CAAC;AAE5B,4CAA4C;AAC5C,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAmB,MAAS;IAClD,OAAO,IAAI,CAAC,MAAM,EAAE,IAAI,OAAO,EAAE,CAAiB,CAAC;AACrD,CAAC;AAED,SAAS,IAAI,CAAC,MAAc,EAAE,KAA8B;IAC1D,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAC1B,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE;QAC9B,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ;YACpB,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;YACvD,IAAI,OAAO,KAAK,KAAK,UAAU,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpF,OAAO,CAAC,OAAgB,EAAE,OAAiB,EAAE,EAAE;oBAC7C,MAAM,SAAS,GAAG,CAAC,IAAa,EAAE,EAAE,CAClC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,EAAE,OAAO,CAAqB,CAAC;oBACpG,OAAO,WAAW,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,CAAC;gBAC7C,CAAC,CAAC;YACJ,CAAC;YACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAChD,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAC5B,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC,CAAC;IACH,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACzB,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,WAAW,CAClB,KAAuB,EACvB,SAA6C;IAE7C,KAAK,SAAS,CAAC,CAAC,KAAK;QACnB,IAAI,IAAI,GAAG,MAAM,KAAK,CAAC;QACvB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAC/B,SAAS,CAAC;YACR,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,SAAS,CAAC,iEAAiE,CAAC,CAAC;YACzF,CAAC;YACD,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACjB,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC1C,+CAA+C;YAC/C,IAAI,KAAK,KAAK,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;gBAAE,OAAO;YAC9C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAChB,IAAI,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,KAAK,UAAU,cAAc,CAAC,MAAmE;QAC/F,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK;gBAAE,OAAO;QAC7C,CAAC;IACH,CAAC;IAED,KAAK,UAAU,iBAAiB,CAAC,OAA0B;QACzD,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,SAAS,CAAC,4EAA4E,CAAC,CAAC;QACpG,CAAC;QACD,IAAI,KAAK,GAAG,YAAY,EAAE,CAAC;YACzB,MAAM,IAAI,SAAS,CACjB,8CAA8C,YAAY,0DAA0D,CACrH,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAc,EAAE,CAAC;QAC7B,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClB,IAAI,MAAM,CAAC,MAAM,IAAI,KAAK;gBAAE,MAAM;QACpC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;QAC1B,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,KAAK;QAC7B,cAAc;QACd,iBAAiB;KAClB,CAAwC,CAAC;AAC5C,CAAC;AAED,SAAS,MAAM,CAAC,KAAc;IAC5B,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,KAAK,CAAC,OAAO,CAAE,KAAuB,CAAC,IAAI,CAAC;QAC5C,aAAa,IAAI,KAAK,CACvB,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,WAA0B;IAC3C,IAAI,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAC9B,wDAAwD;IACxD,OAAO,IAAI,GAAG,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAC9E,CAAC"}