@air/api-core 0.5.0 → 0.5.1

package/dist/index.cjs

@@ -360,7 +360,7 @@ var AirBase = class {
     const url = new URL(`${this.baseURL}${path}`);
     if (query) {
       for (const [key, value] of Object.entries(query)) {
-        if (value === void 0) continue;
+        if (value === void 0 || value === null) continue;
         if (Array.isArray(value)) {
           for (const v of value) {
             url.searchParams.append(key, v);

package/dist/index.d.cts

@@ -1,6 +1,13 @@
 interface CursorPageParams {
     limit?: number;
-    cursor?: string;
+    /**
+     * Cursor from a previous list response. `null` requests the first page and
+     * is omitted from the query string.
+     * When `pagination.cursor` is `null` there are no more pages. Stop, or use
+     * `hasNextPage()` / `for await`. Passing that `null` back in starts over
+     * at page 1.
+     */
+    cursor?: string | null;
 }
 interface CursorPageResponse<T> {
     data: T[];
@@ -34,10 +41,11 @@ declare class PagePromise<T> extends Promise<CursorPage<T>> implements AsyncIter
     [Symbol.asyncIterator](): AsyncIterator<T>;
 }
 
+type QueryParam = string | string[] | number | boolean | null | undefined;
 interface RequestOptions {
     method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
     path: string;
-    query?: Record<string, string | string[] | number | boolean | undefined>;
+    query?: Record<string, QueryParam>;
     body?: unknown;
     headers?: Record<string, string>;
     timeout?: number;
@@ -66,7 +74,7 @@ declare class AirBase {
     constructor(options?: AirBaseOptions);
     get fetchFn(): typeof globalThis.fetch;
     request<T>(options: RequestOptions): Promise<T>;
-    requestCursorPage<T>(options: RequestOptions, query?: Record<string, string | string[] | number | boolean | undefined>): PagePromise<T>;
+    requestCursorPage<T>(options: RequestOptions, query?: Record<string, QueryParam>): PagePromise<T>;
     private _executeRequest;
     private _buildURL;
 }
@@ -178,4 +186,4 @@ interface PKCEChallenge {
  */
 declare function generatePKCEChallenge(): PKCEChallenge;
 
-export { APIError, AirBase, type AirBaseOptions, AuthenticationError, BadRequestError, type BuildAuthorizationUrlOptions, ConnectionError, CursorPage, type CursorPageParams, type CursorPageResponse, type ExchangeAuthorizationCodeOptions, InternalServerError, NotFoundError, type OAuthAccessToken, type OAuthClientAuthMethod, type PKCEChallenge, PagePromise, PermissionError, RateLimitError, type RequestOptions, TimeoutError, VERSION, buildAuthorizationUrl, exchangeAuthorizationCode, generatePKCEChallenge, getRetryDelay, isRetryableError, retryWithBackoff };
+export { APIError, AirBase, type AirBaseOptions, AuthenticationError, BadRequestError, type BuildAuthorizationUrlOptions, ConnectionError, CursorPage, type CursorPageParams, type CursorPageResponse, type ExchangeAuthorizationCodeOptions, InternalServerError, NotFoundError, type OAuthAccessToken, type OAuthClientAuthMethod, type PKCEChallenge, PagePromise, PermissionError, type QueryParam, RateLimitError, type RequestOptions, TimeoutError, VERSION, buildAuthorizationUrl, exchangeAuthorizationCode, generatePKCEChallenge, getRetryDelay, isRetryableError, retryWithBackoff };

package/dist/index.d.ts

@@ -1,6 +1,13 @@
 interface CursorPageParams {
     limit?: number;
-    cursor?: string;
+    /**
+     * Cursor from a previous list response. `null` requests the first page and
+     * is omitted from the query string.
+     * When `pagination.cursor` is `null` there are no more pages. Stop, or use
+     * `hasNextPage()` / `for await`. Passing that `null` back in starts over
+     * at page 1.
+     */
+    cursor?: string | null;
 }
 interface CursorPageResponse<T> {
     data: T[];
@@ -34,10 +41,11 @@ declare class PagePromise<T> extends Promise<CursorPage<T>> implements AsyncIter
     [Symbol.asyncIterator](): AsyncIterator<T>;
 }
 
+type QueryParam = string | string[] | number | boolean | null | undefined;
 interface RequestOptions {
     method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
     path: string;
-    query?: Record<string, string | string[] | number | boolean | undefined>;
+    query?: Record<string, QueryParam>;
     body?: unknown;
     headers?: Record<string, string>;
     timeout?: number;
@@ -66,7 +74,7 @@ declare class AirBase {
     constructor(options?: AirBaseOptions);
     get fetchFn(): typeof globalThis.fetch;
     request<T>(options: RequestOptions): Promise<T>;
-    requestCursorPage<T>(options: RequestOptions, query?: Record<string, string | string[] | number | boolean | undefined>): PagePromise<T>;
+    requestCursorPage<T>(options: RequestOptions, query?: Record<string, QueryParam>): PagePromise<T>;
     private _executeRequest;
     private _buildURL;
 }
@@ -178,4 +186,4 @@ interface PKCEChallenge {
  */
 declare function generatePKCEChallenge(): PKCEChallenge;
 
-export { APIError, AirBase, type AirBaseOptions, AuthenticationError, BadRequestError, type BuildAuthorizationUrlOptions, ConnectionError, CursorPage, type CursorPageParams, type CursorPageResponse, type ExchangeAuthorizationCodeOptions, InternalServerError, NotFoundError, type OAuthAccessToken, type OAuthClientAuthMethod, type PKCEChallenge, PagePromise, PermissionError, RateLimitError, type RequestOptions, TimeoutError, VERSION, buildAuthorizationUrl, exchangeAuthorizationCode, generatePKCEChallenge, getRetryDelay, isRetryableError, retryWithBackoff };
+export { APIError, AirBase, type AirBaseOptions, AuthenticationError, BadRequestError, type BuildAuthorizationUrlOptions, ConnectionError, CursorPage, type CursorPageParams, type CursorPageResponse, type ExchangeAuthorizationCodeOptions, InternalServerError, NotFoundError, type OAuthAccessToken, type OAuthClientAuthMethod, type PKCEChallenge, PagePromise, PermissionError, type QueryParam, RateLimitError, type RequestOptions, TimeoutError, VERSION, buildAuthorizationUrl, exchangeAuthorizationCode, generatePKCEChallenge, getRetryDelay, isRetryableError, retryWithBackoff };

package/dist/index.js

@@ -316,7 +316,7 @@ var AirBase = class {
     const url = new URL(`${this.baseURL}${path}`);
     if (query) {
       for (const [key, value] of Object.entries(query)) {
-        if (value === void 0) continue;
+        if (value === void 0 || value === null) continue;
         if (Array.isArray(value)) {
           for (const v of value) {
             url.searchParams.append(key, v);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@air/api-core",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "type": "module",
   "description": "Core HTTP engine for Air API SDK",
   "main": "./dist/index.cjs",