@permute/sdk 0.1.1 → 0.1.2

package/README.md

@@ -80,6 +80,26 @@ Blobs. REST callers provide `sizeBytes`, then send a raw `PUT` to the returned
 `client.datasets.get(result.id)` for processing status; there is no completion
 API call.
 
+CSV, TSV, JSON, NDJSON, and Parquet files can be up to 1 GiB (1,073,741,824
+bytes). Other supported file types can be up to 100 MiB (104,857,600 bytes).
+Permute selects the limit from the submitted `contentType` and rejects an
+oversized file before issuing its signed upload target.
+
+Request a signed URL for the original uploaded file, or delete one file or custom
+dataset when the API key has dataset admin access:
+
+```ts
+const downloadUrl = await client.datasets.download(uploaded.id);
+const response = await fetch(downloadUrl);
+const bytes = await response.arrayBuffer();
+console.log(response.headers.get('content-type'), bytes.byteLength);
+
+await client.datasets.delete(uploaded.id);
+```
+
+For large files, consume `response.body` as a stream instead of buffering the full
+response. Signed download URLs expire after 15 minutes.
+
 ## Manage Custom Datasets
 
 Create a custom dataset by a stable workspace key when one logical source
@@ -176,7 +196,10 @@ console.log(evidence.items);
 
 Use SQL only when table names are known and exact rows matter. SQL requests must
 include `sourceIds`; call `client.sources.get()` first when table names are not
-known.
+known, and use the returned table names exactly. Warehouse-backed sources use
+DuckDB SQL and can be queried together. Live remote database connectors use
+their native dialect—GoogleSQL for BigQuery and PostgreSQL for Supabase—and
+must be queried one at a time without other sources.
 
 ```ts
 const details = await client.sources.get(sourceIds[0]);
@@ -201,6 +224,7 @@ try {
   });
 } catch (error) {
   if (error instanceof PermuteApiError) {
+    // Invalid SQL returns status 400 with an actionable message when available.
     console.error(error.status, error.code, error.message, error.requestId);
   }
   throw error;

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { Workspace, WorkspaceCreateRequest, WorkspaceDeleteResponse, WorkspaceList, WorkspaceUpdateRequest, AnswerRequest, AnswerJobResponse, AnswerResponse, PermuteClientOptions, PermuteRequestOptions, QueryRequest, QueryResponse, SearchRequest, SearchResponse, SourceDetail, SourceList, CustomDatasetCreateRequest, DatasetResponse, FileDatasetCreateRequest, FileDatasetResponse, DatasetRows, CustomDatasetResponse } from './types.js';
+import type { Workspace, WorkspaceCreateRequest, WorkspaceDeleteResponse, WorkspaceList, WorkspaceUpdateRequest, AnswerRequest, AnswerJobResponse, AnswerResponse, PermuteClientOptions, PermuteRequestOptions, QueryRequest, QueryResponse, SearchRequest, SearchResponse, SourceDetail, SourceList, CustomDatasetCreateRequest, DatasetDeleteResponse, DatasetResponse, FileDatasetCreateRequest, FileDatasetResponse, DatasetRows, CustomDatasetResponse } from './types.js';
 export declare class PermuteApiError extends Error {
     readonly status: number;
     readonly code: string;
@@ -79,6 +79,8 @@ export declare class PermuteClient {
         };
         getByKey: (key: string, options?: PermuteRequestOptions) => Promise<PermuteDataset | PermuteFileDataset>;
         get: (datasetId: string, options?: PermuteRequestOptions) => Promise<PermuteDataset | PermuteFileDataset>;
+        download: (datasetId: string, options?: PermuteRequestOptions) => Promise<string>;
+        delete: (datasetId: string, options?: PermuteRequestOptions) => Promise<DatasetDeleteResponse>;
     };
     private readonly apiKey;
     private readonly baseUrl;

package/dist/client.js

@@ -428,6 +428,11 @@ export class PermuteClient {
                 const dataset = await readDataset(datasetId, requestOptions);
                 return wrapDataset(dataset);
             },
+            download: async (datasetId, requestOptions) => {
+                const { url } = await this.request('datasetsDownload', { pathParams: { datasetId } }, requestOptions);
+                return url;
+            },
+            delete: (datasetId, requestOptions) => this.request('datasetsDelete', { pathParams: { datasetId } }, requestOptions),
         };
     }
     async search(request, options) {

package/dist/generated/openapi.d.ts

@@ -164,6 +164,15 @@ export interface components {
             /** @enum {string} */
             type: 'file';
         };
+        DatasetDeleteResponse: {
+            /** @enum {boolean} */
+            deleted: true;
+            id: string;
+        };
+        DatasetDownloadResponse: {
+            /** Format: uri */
+            url: string;
+        };
         DatasetIdParams: {
             datasetId: string;
         };
@@ -413,6 +422,14 @@ export interface components {
             type: 'record' | 'document' | 'table' | 'text_block' | 'unknown';
         };
         Source: {
+            availability: {
+                /** Format: date-time */
+                lastSuccessfulAt?: string;
+                reason?: string;
+                /** @enum {string} */
+                status: 'ready' | 'refreshing' | 'degraded' | 'preparing' | 'failed';
+            };
+            capabilities: 'query'[];
             context?: string[];
             fileType?: string;
             id: string;
@@ -420,13 +437,21 @@ export interface components {
             provider?: string;
             summary?: string | null;
             /** @enum {string} */
-            type: 'dataset' | 'connector';
+            type: 'dataset' | 'connector' | 'report' | 'dashboard' | 'dataTable';
         };
         SourceDetail: {
             metadata?: {
                 [key: string]: unknown;
             };
             source: {
+                availability: {
+                    /** Format: date-time */
+                    lastSuccessfulAt?: string;
+                    reason?: string;
+                    /** @enum {string} */
+                    status: 'ready' | 'refreshing' | 'degraded' | 'preparing' | 'failed';
+                };
+                capabilities: 'query'[];
                 context?: string[];
                 fileType?: string;
                 id: string;
@@ -434,7 +459,7 @@ export interface components {
                 provider?: string;
                 summary?: string | null;
                 /** @enum {string} */
-                type: 'dataset' | 'connector';
+                type: 'dataset' | 'connector' | 'report' | 'dashboard' | 'dataTable';
             };
             tables: {
                 fieldCount?: number;
@@ -456,6 +481,14 @@ export interface components {
         };
         SourceList: {
             items: {
+                availability: {
+                    /** Format: date-time */
+                    lastSuccessfulAt?: string;
+                    reason?: string;
+                    /** @enum {string} */
+                    status: 'ready' | 'refreshing' | 'degraded' | 'preparing' | 'failed';
+                };
+                capabilities: 'query'[];
                 context?: string[];
                 fileType?: string;
                 id: string;
@@ -463,7 +496,7 @@ export interface components {
                 provider?: string;
                 summary?: string | null;
                 /** @enum {string} */
-                type: 'dataset' | 'connector';
+                type: 'dataset' | 'connector' | 'report' | 'dashboard' | 'dataTable';
             }[];
         };
         UploadProgress: {

package/dist/generated/runtime-contract.d.ts

@@ -8,5 +8,5 @@ export interface RuntimeRoute {
     querySchema: JsonSchema | null;
     responseSchema: JsonSchema;
 }
-export type PublicApiOperationId = 'workspacesList' | 'workspacesCreate' | 'workspacesGet' | 'workspacesUpdate' | 'workspacesDelete' | 'sourcesList' | 'sourcesGet' | 'datasetsCreate' | 'datasetsGetByKey' | 'datasetsGet' | 'datasetsWriteTables' | 'searchCreate' | 'answerJobsCreate' | 'answerJobsGet' | 'queriesCreate';
+export type PublicApiOperationId = 'workspacesList' | 'workspacesCreate' | 'workspacesGet' | 'workspacesUpdate' | 'workspacesDelete' | 'sourcesList' | 'sourcesGet' | 'datasetsCreate' | 'datasetsGetByKey' | 'datasetsGet' | 'datasetsDelete' | 'datasetsDownload' | 'datasetsWriteTables' | 'searchCreate' | 'answerJobsCreate' | 'answerJobsGet' | 'queriesCreate';
 export declare const publicApiRoutes: Record<PublicApiOperationId, RuntimeRoute>;

package/dist/generated/runtime-contract.js

@@ -237,7 +237,7 @@ export const publicApiRoutes = {
                             },
                             type: {
                                 type: 'string',
-                                enum: ['dataset', 'connector'],
+                                enum: ['dataset', 'connector', 'report', 'dashboard', 'dataTable'],
                             },
                             name: {
                                 type: 'string',
@@ -258,8 +258,33 @@ export const publicApiRoutes = {
                             fileType: {
                                 type: 'string',
                             },
+                            capabilities: {
+                                type: 'array',
+                                items: {
+                                    type: 'string',
+                                    enum: ['query'],
+                                },
+                            },
+                            availability: {
+                                type: 'object',
+                                properties: {
+                                    status: {
+                                        type: 'string',
+                                        enum: ['ready', 'refreshing', 'degraded', 'preparing', 'failed'],
+                                    },
+                                    lastSuccessfulAt: {
+                                        type: 'string',
+                                        format: 'date-time',
+                                    },
+                                    reason: {
+                                        type: 'string',
+                                    },
+                                },
+                                required: ['status'],
+                                additionalProperties: false,
+                            },
                         },
-                        required: ['id', 'type', 'name'],
+                        required: ['id', 'type', 'name', 'capabilities', 'availability'],
                         additionalProperties: false,
                     },
                 },
@@ -286,7 +311,7 @@ export const publicApiRoutes = {
                         },
                         type: {
                             type: 'string',
-                            enum: ['dataset', 'connector'],
+                            enum: ['dataset', 'connector', 'report', 'dashboard', 'dataTable'],
                         },
                         name: {
                             type: 'string',
@@ -307,8 +332,33 @@ export const publicApiRoutes = {
                         fileType: {
                             type: 'string',
                         },
+                        capabilities: {
+                            type: 'array',
+                            items: {
+                                type: 'string',
+                                enum: ['query'],
+                            },
+                        },
+                        availability: {
+                            type: 'object',
+                            properties: {
+                                status: {
+                                    type: 'string',
+                                    enum: ['ready', 'refreshing', 'degraded', 'preparing', 'failed'],
+                                },
+                                lastSuccessfulAt: {
+                                    type: 'string',
+                                    format: 'date-time',
+                                },
+                                reason: {
+                                    type: 'string',
+                                },
+                            },
+                            required: ['status'],
+                            additionalProperties: false,
+                        },
                     },
-                    required: ['id', 'type', 'name'],
+                    required: ['id', 'type', 'name', 'capabilities', 'availability'],
                     additionalProperties: false,
                 },
                 metadata: {
@@ -1031,6 +1081,47 @@ export const publicApiRoutes = {
             ],
         },
     },
+    datasetsDelete: {
+        operationId: 'datasetsDelete',
+        method: 'DELETE',
+        path: '/v1/datasets/{datasetId}',
+        scope: 'workspace',
+        bodySchema: null,
+        querySchema: null,
+        responseSchema: {
+            type: 'object',
+            properties: {
+                id: {
+                    type: 'string',
+                },
+                deleted: {
+                    type: 'boolean',
+                    enum: [true],
+                },
+            },
+            required: ['id', 'deleted'],
+            additionalProperties: false,
+        },
+    },
+    datasetsDownload: {
+        operationId: 'datasetsDownload',
+        method: 'GET',
+        path: '/v1/datasets/{datasetId}/download',
+        scope: 'workspace',
+        bodySchema: null,
+        querySchema: null,
+        responseSchema: {
+            type: 'object',
+            properties: {
+                url: {
+                    type: 'string',
+                    format: 'uri',
+                },
+            },
+            required: ['url'],
+            additionalProperties: false,
+        },
+    },
     datasetsWriteTables: {
         operationId: 'datasetsWriteTables',
         method: 'POST',

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './types.js';
 export * from './client.js';
 export declare const CONTEXT: {
+    readonly Acumatica: "acumatica";
     readonly QuickBooks: "quickbooks";
     readonly HubSpot: "hubspot";
     readonly Attio: "attio";
@@ -12,6 +13,7 @@ export declare const CONTEXT: {
     readonly Klaviyo: "klaviyo";
     readonly Mercury: "mercury";
     readonly Monday: "monday";
+    readonly Shopify: "shopify";
     readonly Stripe: "stripe";
     readonly Xero: "xero";
 };

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from './types.js';
 export * from './client.js';
 export const CONTEXT = {
+    Acumatica: 'acumatica',
     QuickBooks: 'quickbooks',
     HubSpot: 'hubspot',
     Attio: 'attio',
@@ -12,6 +13,7 @@ export const CONTEXT = {
     Klaviyo: 'klaviyo',
     Mercury: 'mercury',
     Monday: 'monday',
+    Shopify: 'shopify',
     Stripe: 'stripe',
     Xero: 'xero',
 };

package/dist/types.d.ts

@@ -12,6 +12,8 @@ export type CatalogField = PublicApiSchema<'CatalogField'>;
 export type CatalogTable = PublicApiSchema<'CatalogTable'>;
 type DatasetApiCreateRequest = PublicApiSchema<'DatasetCreateRequest'>;
 export type DatasetResponse = PublicApiSchema<'DatasetResponse'>;
+export type DatasetDownloadResponse = PublicApiSchema<'DatasetDownloadResponse'>;
+export type DatasetDeleteResponse = PublicApiSchema<'DatasetDeleteResponse'>;
 export type CustomDatasetResponse = PublicApiSchema<'CustomDatasetResponse'>;
 export type FileDatasetResponse = PublicApiSchema<'FileDatasetResponse'>;
 export type DatasetUploadBody = string | Blob | ArrayBuffer | ArrayBufferView;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@permute/sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "TypeScript client for the Permute public API",
   "type": "module",
   "license": "Apache-2.0",