roicai 0.0.1 → 0.1.0

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,25 @@
+import { type ClientOptions as GeneratedClientOptions } from './generated/index.js';
+export * from './generated/index.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;
+}
+/**
+ * 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' });
+ * ```
+ */
+export declare function createClient(options: ClientOptions): import("./generated/client.js").Client;

package/dist/index.js

@@ -0,0 +1,18 @@
+import { createClient as createGeneratedClient } from './generated/index.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' });
+ * ```
+ */
+export function createClient(options) {
+    return 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,EAAE,YAAY,IAAI,qBAAqB,EAAgD,MAAM,sBAAsB,CAAC;AAE3H,cAAc,sBAAsB,CAAC;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,qBAAqB,CAAC;AAatD;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,OAAO,qBAAqB,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,gBAAgB,EAAE,CAAC,CAAC;AAC7F,CAAC"}

package/package.json

@@ -1,9 +1,46 @@
 {
   "name": "roicai",
-  "version": "0.0.1",
-  "description": "Official Node.js SDK for the ROIC.ai financial data API. Coming soon.",
-  "homepage": "https://roic.ai",
-  "license": "UNLICENSED",
-  "keywords": ["roicai", "roic", "financial data", "stocks", "fundamentals", "api", "sdk"],
-  "files": ["README.md"]
+  "version": "0.1.0",
+  "description": "TypeScript and JavaScript client for the ROIC.ai financial data API",
+  "license": "MIT",
+  "author": "ROIC.ai",
+  "homepage": "https://github.com/roicai/roicai-node#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/roicai/roicai-node.git"
+  },
+  "bugs": {
+    "url": "https://github.com/roicai/roicai-node/issues"
+  },
+  "keywords": [
+    "roicai",
+    "roic",
+    "financial data",
+    "stocks",
+    "fundamentals",
+    "earnings calls",
+    "api",
+    "sdk"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "generate": "scripts/generate.sh",
+    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "test": "node --test test/client.test.mjs test/live.test.mjs",
+    "prepublishOnly": "npm run build && npm test"
+  },
+  "devDependencies": {
+    "typescript": "7.0.2"
+  }
 }