@deeptable/deeptable 0.1.0-beta.2 → 0.1.0-beta.4

package/resources/structured-sheets/tables.mjs

@@ -3,6 +3,9 @@ import { APIResource } from "../../core/resource.mjs";
 import { CursorIDPage } from "../../core/pagination.mjs";
 import { buildHeaders } from "../../internal/headers.mjs";
 import { path } from "../../internal/utils/path.mjs";
+/**
+ * Convert uploaded spreadsheets into structured data. Creates relational tables from messy spreadsheet data.
+ */
 export class Tables extends APIResource {
     /**
      * Get details of a specific table extracted from the structured sheet. Only

package/resources/structured-sheets/tables.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"tables.mjs","sourceRoot":"","sources":["../../src/resources/structured-sheets/tables.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAwC;OACtD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,mBAAmB,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,iBAAyB,EACzB,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,yBAAyB,iBAAiB,SAAS,EACvD,CAAA,YAA2B,CAAA,EAC3B,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,OAAe,EAAE,MAA2B,EAAE,OAAwB;QAC7E,MAAM,EAAE,mBAAmB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,mBAAmB,WAAW,OAAO,WAAW,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,gCAAgC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YACvF,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"tables.mjs","sourceRoot":"","sources":["../../src/resources/structured-sheets/tables.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAwC;OACtD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,mBAAmB,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,iBAAyB,EACzB,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,yBAAyB,iBAAiB,SAAS,EACvD,CAAA,YAA2B,CAAA,EAC3B,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,OAAe,EAAE,MAA2B,EAAE,OAAwB;QAC7E,MAAM,EAAE,mBAAmB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,mBAAmB,WAAW,OAAO,WAAW,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,gCAAgC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YACvF,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/client.ts

@@ -11,6 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Pagination from './core/pagination';
@@ -231,21 +232,8 @@ export class DeepTable {
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.DeepTableError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -277,12 +265,13 @@ export class DeepTable {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -466,7 +455,7 @@ export class DeepTable {
       loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
 
       const errText = await response.text().catch((err: any) => castToError(err).message);
-      const errJSON = safeJSON(errText);
+      const errJSON = safeJSON(errText) as any;
       const errMessage = errJSON ? undefined : errText;
 
       loggerFor(this).debug(
@@ -503,9 +492,14 @@ export class DeepTable {
   getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
     path: string,
     Page: new (...args: any[]) => PageClass,
-    opts?: RequestOptions,
+    opts?: PromiseOrValue<RequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
-    return this.requestAPIList(Page, { method: 'get', path, ...opts });
+    return this.requestAPIList(
+      Page,
+      opts && 'then' in opts ?
+        opts.then((opts) => ({ method: 'get', path, ...opts }))
+      : { method: 'get', path, ...opts },
+    );
   }
 
   requestAPIList<
@@ -513,7 +507,7 @@ export class DeepTable {
     PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
   >(
     Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
-    options: FinalRequestOptions,
+    options: PromiseOrValue<FinalRequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
     const request = this.makeRequest(options, null, undefined);
     return new Pagination.PagePromise<PageClass, Item>(this as any as DeepTable, request, Page);
@@ -526,9 +520,10 @@ export class DeepTable {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    if (signal) signal.addEventListener('abort', () => controller.abort());
+    const abort = this._makeAbort(controller);
+    if (signal) signal.addEventListener('abort', abort, { once: true });
 
-    const timeout = setTimeout(() => controller.abort(), ms);
+    const timeout = setTimeout(abort, ms);
 
     const isReadableBody =
       ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
@@ -605,9 +600,9 @@ export class DeepTable {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -695,6 +690,12 @@ export class DeepTable {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -727,6 +728,14 @@ export class DeepTable {
         (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
     ) {
       return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body),
+      };
     } else {
       return this.#encoder({ body, headers });
     }
@@ -751,7 +760,13 @@ export class DeepTable {
 
   static toFile = Uploads.toFile;
 
+  /**
+   * Upload and manage spreadsheet files. Files must be Excel (.xlsx) format.
+   */
   files: API.Files = new API.Files(this);
+  /**
+   * Convert uploaded spreadsheets into structured data. Creates relational tables from messy spreadsheet data.
+   */
   structuredSheets: API.StructuredSheets = new API.StructuredSheets(this);
 }
 

package/src/internal/parse.ts

@@ -29,6 +29,12 @@ export async function defaultParseResponse<T>(client: DeepTable, props: APIRespo
     const mediaType = contentType?.split(';')[0]?.trim();
     const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
     if (isJSON) {
+      const contentLength = response.headers.get('content-length');
+      if (contentLength === '0') {
+        // if there is no content we can't do anything
+        return undefined as T;
+      }
+
       const json = await response.json();
       return json as T;
     }

package/src/internal/utils/query.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { DeepTableError } from '../../core/error';
+
+/**
+ * Basic re-implementation of `qs.stringify` for primitive types.
+ */
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return Object.entries(query)
+    .filter(([_, value]) => typeof value !== 'undefined')
+    .map(([key, value]) => {
+      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+      }
+      if (value === null) {
+        return `${encodeURIComponent(key)}=`;
+      }
+      throw new DeepTableError(
+        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
+      );
+    })
+    .join('&');
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/files.ts

@@ -9,6 +9,9 @@ import { RequestOptions } from '../internal/request-options';
 import { multipartFormRequestOptions } from '../internal/uploads';
 import { path } from '../internal/utils/path';
 
+/**
+ * Upload and manage spreadsheet files. Files must be Excel (.xlsx) format.
+ */
 export class Files extends APIResource {
   /**
    * Get metadata for a specific file.
@@ -130,14 +133,14 @@ export interface File {
   file_name: string;
 
   /**
-   * The size of the file in bytes.
+   * The object type, which is always 'file'.
    */
-  size: number;
+  object: 'file';
 
   /**
-   * The object type, which is always 'file'.
+   * The size of the file in bytes.
    */
-  object?: 'file';
+  size: number;
 }
 
 /**
@@ -154,12 +157,12 @@ export interface FileDeleteResponse {
   /**
    * Whether the file was successfully deleted.
    */
-  deleted?: true;
+  deleted: true;
 
   /**
    * The object type, which is always 'file'.
    */
-  object?: 'file';
+  object: 'file';
 }
 
 export interface FileListParams extends CursorIDPageParams {}

package/src/resources/structured-sheets/structured-sheets.ts

@@ -16,6 +16,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Convert uploaded spreadsheets into structured data. Creates relational tables from messy spreadsheet data.
+ */
 export class StructuredSheets extends APIResource {
   tables: TablesAPI.Tables = new TablesAPI.Tables(this._client);
 
@@ -161,6 +164,11 @@ export interface StructuredSheetResponse {
    */
   file_id: string;
 
+  /**
+   * The object type, which is always 'structured_sheet'.
+   */
+  object: 'structured_sheet';
+
   /**
    * The current processing status.
    */
@@ -176,11 +184,6 @@ export interface StructuredSheetResponse {
    */
   last_error?: StructuredSheetResponse.LastError | null;
 
-  /**
-   * The object type, which is always 'structured_sheet'.
-   */
-  object?: 'structured_sheet';
-
   /**
    * List of sheet names included in this conversion.
    */
@@ -224,12 +227,12 @@ export interface StructuredSheetDeleteResponse {
   /**
    * Whether the structured sheet was successfully deleted.
    */
-  deleted?: true;
+  deleted: true;
 
   /**
    * The object type, which is always 'structured_sheet'.
    */
-  object?: 'structured_sheet';
+  object: 'structured_sheet';
 }
 
 export interface StructuredSheetCreateParams {

package/src/resources/structured-sheets/tables.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Convert uploaded spreadsheets into structured data. Creates relational tables from messy spreadsheet data.
+ */
 export class Tables extends APIResource {
   /**
    * Get details of a specific table extracted from the structured sheet. Only
@@ -113,11 +116,18 @@ export interface TableResponse {
 
   /**
    * Composite table name: {normalized_sheet_name}**{table_name}. Uses lowercase
-   * snake_case. Aggregation tables end with '**aggregations'. Example:
-   * 'staffing**head_count' or 'staffing**head_count\_\_aggregations'.
+   * snake_case. Aggregation tables end with '**aggregations'. Two special metadata
+   * tables exist per structured sheet: '**deeptable_workbook_metadata' (workbook
+   * provenance info) and '**deeptable_table_overview' (summary of all tables).
+   * Example: 'staffing**head_count' or 'staffing**head_count\_\_aggregations'.
    */
   name: string;
 
+  /**
+   * The object type, which is always 'table'.
+   */
+  object: 'table';
+
   /**
    * The original Excel sheet name this table came from.
    */
@@ -129,14 +139,9 @@ export interface TableResponse {
   structured_sheet_id: string;
 
   /**
-   * The type of table (relational, aggregation, or tableless).
+   * The type of table (relational, aggregation, tableless, or metadata).
    */
   type: 'relational' | 'aggregation' | 'tableless' | 'metadata';
-
-  /**
-   * The object type, which is always 'table'.
-   */
-  object?: 'table';
 }
 
 export interface TableRetrieveParams {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-beta.2'; // x-release-please-version
+export const VERSION = '0.1.0-beta.4'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.2";
+export declare const VERSION = "0.1.0-beta.4";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.2";
+export declare const VERSION = "0.1.0-beta.4";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0-beta.2'; // x-release-please-version
+exports.VERSION = '0.1.0-beta.4'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0-beta.2'; // x-release-please-version
+export const VERSION = '0.1.0-beta.4'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map