roicai 0.1.0 → 0.2.0

package/dist/generated/fundamentals/ratios/yieldAnalysis/client.js

@@ -14,7 +14,7 @@ export function bind(transport) {
 const ListOperation = {
     method: "GET",
     route: "/v3.0.0/fundamental/ratios/yield-analysis/{identifier}",
-    query: { apikey: "apikey", periodType: "period_type", periodLabel: "period_label", date: "date", order: "order", limit: "limit", page: "page" },
+    query: { apikey: "apikey", periodType: "period_type", periodLabel: "period_label", date: "date", dateGte: "date.gte", dateGt: "date.gt", dateLte: "date.lte", dateLt: "date.lt", fiscalYearGte: "fiscal_year.gte", fiscalYearGt: "fiscal_year.gt", fiscalYearLte: "fiscal_year.lte", fiscalYearLt: "fiscal_year.lt", order: "order", limit: "limit", page: "page" },
     response: V3YieldAnalysisFinancialPeriodListCodec,
     errors: { "400": V3ErrorCodec, "401": V3ErrorCodec, "402": V3ErrorCodec, "404": V3ErrorCodec, "429": V3ErrorCodec, "500": V3ErrorCodec, "503": V3ErrorCodec },
 };

package/dist/generated/fundamentals/ratios/yieldAnalysis/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/yieldAnalysis/client.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAIL,SAAS,GACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,uCAAuC,GACxC,MAAM,aAAa,CAAC;AAkBrB,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;AAiCD,MAAM,aAAa,GAAc;IAC/B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,wDAAwD;IAC/D,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IAC/I,QAAQ,EAAE,uCAAuC;IACjD,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,KAAK,EAAE,YAAY,EAAE;CAC9J,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/yieldAnalysis/client.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAIL,SAAS,GACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,uCAAuC,GACxC,MAAM,aAAa,CAAC;AAkBrB,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;AAiED,MAAM,aAAa,GAAc;IAC/B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,wDAAwD;IAC/D,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IACnW,QAAQ,EAAE,uCAAuC;IACjD,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,KAAK,EAAE,YAAY,EAAE;CAC9J,CAAC"}

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

@@ -36,6 +36,22 @@ export interface ListRequest {
      * Return prices from exactly this date.
      */
     date?: string;
+    /**
+     * Return prices whose date is on or after this date.
+     */
+    dateGte?: string;
+    /**
+     * Return prices whose date is strictly after this date.
+     */
+    dateGt?: string;
+    /**
+     * Return prices whose date is on or before this date.
+     */
+    dateLte?: string;
+    /**
+     * Return prices whose date is strictly before this date.
+     */
+    dateLt?: string;
     adjustment?: "none" | "splits" | "total_return";
     adjusted?: "true" | "false";
     order?: "asc" | "desc";

package/dist/generated/stockPrices/client.js

@@ -24,7 +24,7 @@ export function bind(transport) {
 const ListOperation = {
     method: "GET",
     route: "/v3.0.0/stock-prices/{identifier}",
-    query: { apikey: "apikey", date: "date", adjustment: "adjustment", adjusted: "adjusted", order: "order", limit: "limit", page: "page" },
+    query: { apikey: "apikey", date: "date", dateGte: "date.gte", dateGt: "date.gt", dateLte: "date.lte", dateLt: "date.lt", adjustment: "adjustment", adjusted: "adjusted", order: "order", limit: "limit", page: "page" },
     response: V3HistoricalPriceListCodec,
     errors: { "400": V3ErrorCodec, "401": V3ErrorCodec, "402": V3ErrorCodec, "404": V3ErrorCodec, "429": V3ErrorCodec, "500": V3ErrorCodec, "503": V3ErrorCodec },
 };

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

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/generated/stockPrices/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,EAA6B,IAAI,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAEL,IAAI,IAAI,UAAU,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAEL,0BAA0B,GAC3B,MAAM,aAAa,CAAC;AAqBrB,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,IAAI,UAAkC,CAAC;IACvC,IAAI,YAAsC,CAAC;IAC3C,OAAO;QACL,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;QAC3E,IAAI,IAAI;YACN,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,MAAM;YACR,OAAO,CAAC,YAAY,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;QAClD,CAAC;KACF,CAAC;AACJ,CAAC;AAiCD,MAAM,aAAa,GAAc;IAC/B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,mCAAmC;IAC1C,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IACvI,QAAQ,EAAE,0BAA0B;IACpC,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,KAAK,EAAE,YAAY,EAAE;CAC9J,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/generated/stockPrices/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,EAA6B,IAAI,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAEL,IAAI,IAAI,UAAU,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAEL,0BAA0B,GAC3B,MAAM,aAAa,CAAC;AAqBrB,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,IAAI,UAAkC,CAAC;IACvC,IAAI,YAAsC,CAAC;IAC3C,OAAO;QACL,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;QAC3E,IAAI,IAAI;YACN,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,MAAM;YACR,OAAO,CAAC,YAAY,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;QAClD,CAAC;KACF,CAAC;AACJ,CAAC;AAiDD,MAAM,aAAa,GAAc;IAC/B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,mCAAmC;IAC1C,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IACvN,QAAQ,EAAE,0BAA0B;IACpC,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,KAAK,EAAE,YAAY,EAAE;CAC9J,CAAC"}

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

@@ -34,6 +34,22 @@ export interface ListRequest {
      * 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.

package/dist/generated/stockSplits/client.js

@@ -14,7 +14,7 @@ export function bind(transport) {
 const ListOperation = {
     method: "GET",
     route: "/v3.0.0/stock-splits",
-    query: { apikey: "apikey", identifier: "identifier", date: "date", order: "order", limit: "limit", page: "page" },
+    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 },
 };

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

@@ -1 +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;AAiCD,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,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IACjH,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"}
+{"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/index.d.ts

@@ -1,5 +1,7 @@
-import { type ClientOptions as GeneratedClientOptions } from './generated/index.js';
+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.
  */
@@ -14,12 +16,20 @@ export interface ClientOptions extends Omit<GeneratedClientOptions, 'baseUrl'> {
      */
     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): import("./generated/client.js").Client;
+export declare function createClient(options: ClientOptions): Client;

package/dist/index.js

@@ -1,4 +1,5 @@
-import { createClient as createGeneratedClient } from './generated/index.js';
+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.
@@ -10,9 +11,12 @@ export const DEFAULT_BASE_URL = 'https://api.roic.ai';
  * ```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 createGeneratedClient({ ...options, baseUrl: options.baseUrl ?? DEFAULT_BASE_URL });
+    return paginate(createGeneratedClient({ ...options, baseUrl: options.baseUrl ?? DEFAULT_BASE_URL }));
 }
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +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"}
+{"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"}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "roicai",
-  "version": "0.1.0",
-  "description": "TypeScript and JavaScript client for the ROIC.ai financial data API",
+  "version": "0.2.0",
+  "description": "Official Node.js and TypeScript client for the ROIC.ai financial data and stock API: fundamentals, earnings calls, prices",
   "license": "MIT",
   "author": "ROIC.ai",
-  "homepage": "https://github.com/roicai/roicai-node#readme",
+  "homepage": "https://www.roic.ai/api",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/roicai/roicai-node.git"
@@ -14,12 +14,19 @@
   },
   "keywords": [
     "roicai",
-    "roic",
-    "financial data",
-    "stocks",
+    "stock api",
+    "financial data api",
+    "stock market api",
+    "market data api",
+    "stock price api",
+    "historical stock data",
     "fundamentals",
-    "earnings calls",
-    "api",
+    "financial statements",
+    "financial ratios",
+    "earnings call transcripts",
+    "sec filings",
+    "typescript",
+    "nodejs",
     "sdk"
   ],
   "type": "module",
@@ -37,7 +44,7 @@
   "scripts": {
     "generate": "scripts/generate.sh",
     "build": "rm -rf dist && tsc -p tsconfig.json",
-    "test": "node --test test/client.test.mjs test/live.test.mjs",
+    "test": "tsc -p test/tsconfig.json && node --test test/client.test.mjs test/live.test.mjs",
     "prepublishOnly": "npm run build && npm test"
   },
   "devDependencies": {