@permute/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,212 @@
+# @permute/sdk
+
+TypeScript client for the Permute public API.
+
+The SDK supports Node.js 20 and newer and includes TypeScript declarations.
+
+```sh
+npm install @permute/sdk
+```
+
+## Configure
+
+```ts
+import { PermuteClient } from '@permute/sdk';
+
+const orgClient = new PermuteClient({
+  apiKey: process.env.PERMUTE_API_KEY!,
+  baseUrl: process.env.PERMUTE_API_BASE_URL,
+});
+
+const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);
+```
+
+For an organization-scoped key, select a workspace before calling data APIs.
+For a workspace-scoped key, `workspaceId` is optional because the API can infer
+it from the key. Use `baseUrl` for custom API endpoints or tests.
+
+## Manage Workspaces
+
+Workspace routes use the same API-key permission system as other resources.
+Grant `workspace:*` write access to create workspaces; exact or wildcard
+workspace read/write/admin grants control list/get, update, and delete
+respectively. Lists only return readable workspaces. After creating one, derive
+a workspace client for its data operations.
+
+```ts
+const orgClient = new PermuteClient({
+  apiKey: process.env.PERMUTE_API_KEY!,
+});
+
+const workspace = await orgClient.workspaces.create({
+  name: 'Finance',
+  context: 'Revenue, customers, and operating performance', // Optional.
+});
+
+const client = orgClient.withWorkspace(workspace.id);
+```
+
+For a workspace-scoped key, the data client needs only the key:
+
+```ts
+const client = new PermuteClient({
+  apiKey: process.env.PERMUTE_API_KEY!,
+});
+```
+
+`withWorkspace()` selects request context for workspace data APIs; it does not
+grant access. The selected ID is available as `client.workspaceId`. Organization
+APIs such as `client.workspaces.list()` do not send a workspace header.
+
+## Upload Files
+
+Use the one-call helper when you have file bytes in process. It creates a file
+dataset and PUTs bytes to its signed S3 target. S3 starts processing automatically.
+
+```ts
+const uploaded = await client.datasets.create({
+  type: 'file',
+  fileName: 'Revenue.csv',
+  contentType: 'text/csv',
+  data: csvBytes,
+});
+
+console.log(uploaded.sourceId, uploaded.status);
+```
+
+The SDK infers `sizeBytes` for strings, buffers, typed arrays, ArrayBuffers, and
+Blobs. REST callers provide `sizeBytes`, then send a raw `PUT` to the returned
+`data.upload.url` with every header in `data.upload.headers`. Poll
+`client.datasets.get(result.id)` for processing status; there is no completion
+API call.
+
+## Manage Custom Datasets
+
+Create a custom dataset by a stable workspace key when one logical source
+contains multiple related tables. Calling `create()` again with the same custom
+key returns the same dataset, allowing later writes to append or replace its
+data. The SDK accepts JavaScript objects, encodes them as chunked NDJSON, and
+uploads the result to a signed S3 target; callers do not need temporary files.
+
+```ts
+import { CONTEXT, PermuteClient } from '@permute/sdk';
+
+const dataset = await client.datasets.create({
+  type: 'custom',
+  key: 'quickbooks',
+  name: 'QuickBooks',
+  context: [CONTEXT.QuickBooks],
+});
+
+await dataset.replace({
+  orders: [{ id: 1 }, { id: 2 }],
+  customers: [{ id: 10 }],
+});
+
+console.log(dataset.sourceId, dataset.version, dataset.data.tables);
+```
+
+`replace()` sends the complete dataset snapshot. Tables omitted from the call
+are removed, while tables with the same name keep their stable identity for
+reports and dashboards. Retrying an identical replacement is a no-op.
+
+Use `replaceTable()` when the supplied rows are the complete current contents
+of one table. Existing rows not supplied are removed; other tables are unchanged:
+
+```ts
+await dataset.replaceTable('orders', allOrders);
+```
+
+Use `appendTable()` only when every supplied row is new and previously written
+rows can never be updated or deleted:
+
+```ts
+await dataset.appendTable('events', newEvents, {
+  batchId: 'events-2026-07-15-page-2',
+});
+```
+
+`appendTable()` does not update, delete, merge, upsert, or deduplicate rows.
+`batchId` identifies one append operation: reuse it when retrying the same rows
+and use a new value for a new append. It prevents a retried request from being
+applied twice; reusing it with different rows fails. It does not remove duplicate
+rows sent in different batches.
+
+When source records can change or disappear, collect the source's current rows
+and use `replaceTable()` instead. The SDK serializes custom writes as chunked
+NDJSON, uploads them directly to a signed S3 target, and waits for processing;
+it does not build Parquet locally. The REST upload supports up to 50 tables and
+1 GB, but the current SDK object helper encodes the supplied rows in memory, so
+callers should stay comfortably within their process memory. `appendTable()`
+accepts up to 10,000 rows per batch. Durable SDK operations stop polling after
+20 minutes by default; pass `pollTimeoutMs` to set a different bound.
+
+## Recommended Flow
+
+Start with sources and ask Permute for an interpretation, then drop down to
+evidence or exact rows only when the caller needs them. `answer()` starts a
+durable analysis job and waits for its completed result.
+
+```ts
+const sources = await client.sources.list();
+const sourceIds = sources.items.slice(0, 2).map((source) => source.id);
+
+const answer = await client.answer({
+  question: 'What changed in revenue this quarter?',
+  sourceIds,
+});
+
+console.log(answer.answer);
+```
+
+Use `answerJobs()` and `getAnswerJob()` directly when the caller needs to
+persist the job ID and manage polling itself.
+
+Use search when the caller needs supporting records or citations instead of a
+new interpretation.
+
+```ts
+const evidence = await client.search({
+  query: 'Q4 revenue growth drivers',
+  limit: 5,
+});
+
+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.
+
+```ts
+const details = await client.sources.get(sourceIds[0]);
+
+const rows = await client.query({
+  sourceIds: [details.source.id],
+  sql: `SELECT * FROM "${details.tables[0].name}" LIMIT 10`,
+});
+
+console.log(rows.rows);
+```
+
+## Error Handling
+
+```ts
+import { PermuteApiError } from '@permute/sdk';
+
+try {
+  await client.query({
+    sourceIds: ['conn_hubspot123'],
+    sql: 'SELECT * FROM "deals" LIMIT 10',
+  });
+} catch (error) {
+  if (error instanceof PermuteApiError) {
+    console.error(error.status, error.code, error.message, error.requestId);
+  }
+  throw error;
+}
+```
+
+## License
+
+Apache-2.0. Copyright 2026 Permute, Inc.

package/dist/client.d.ts

@@ -0,0 +1,100 @@
+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';
+export declare class PermuteApiError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly details?: unknown;
+    readonly requestId?: string;
+    constructor(input: {
+        status: number;
+        code: string;
+        message: string;
+        details?: unknown;
+        requestId?: string;
+    });
+}
+type DatasetWriteInput = {
+    tables: Record<string, DatasetRows>;
+    mode: 'replace';
+} | {
+    tableName: string;
+    rows: DatasetRows;
+    mode: 'replaceTable';
+} | {
+    tableName: string;
+    rows: DatasetRows;
+    batchId: string;
+    mode: 'appendTable';
+};
+type DatasetWriter = (id: string, request: DatasetWriteInput, options?: PermuteRequestOptions) => Promise<CustomDatasetResponse>;
+type DatasetReader = (id: string, options?: PermuteRequestOptions) => Promise<DatasetResponse>;
+export declare class PermuteDataset {
+    private readonly writeTables;
+    private readonly readDataset;
+    readonly type: "custom";
+    private snapshot;
+    constructor(snapshot: CustomDatasetResponse, writeTables: DatasetWriter, readDataset: DatasetReader);
+    get data(): CustomDatasetResponse;
+    get id(): string;
+    get sourceId(): string;
+    get key(): string;
+    get name(): string;
+    get context(): string[];
+    get status(): CustomDatasetResponse['status'];
+    get version(): number;
+    replace(tables: Record<string, DatasetRows>, options?: PermuteRequestOptions): Promise<this>;
+    replaceTable(tableName: string, rows: DatasetRows, options?: PermuteRequestOptions): Promise<this>;
+    appendTable(tableName: string, rows: DatasetRows, options: {
+        batchId: string;
+    } & PermuteRequestOptions): Promise<this>;
+    refresh(options?: PermuteRequestOptions): Promise<this>;
+}
+export declare class PermuteFileDataset {
+    private readonly readDataset;
+    readonly type: "file";
+    private snapshot;
+    constructor(snapshot: FileDatasetResponse, readDataset: DatasetReader);
+    get data(): FileDatasetResponse;
+    get id(): string;
+    get sourceId(): string;
+    get name(): string;
+    get status(): FileDatasetResponse['status'];
+    refresh(options?: PermuteRequestOptions): Promise<this>;
+}
+export declare class PermuteClient {
+    readonly workspaces: {
+        list: (options?: PermuteRequestOptions) => Promise<WorkspaceList>;
+        create: (request: WorkspaceCreateRequest, options?: PermuteRequestOptions) => Promise<Workspace>;
+        get: (workspaceId: string, options?: PermuteRequestOptions) => Promise<Workspace>;
+        update: (workspaceId: string, request: WorkspaceUpdateRequest, options?: PermuteRequestOptions) => Promise<Workspace>;
+        delete: (workspaceId: string, options?: PermuteRequestOptions) => Promise<WorkspaceDeleteResponse>;
+    };
+    readonly sources: {
+        list: (options?: PermuteRequestOptions) => Promise<SourceList>;
+        get: (sourceId: string, options?: PermuteRequestOptions) => Promise<SourceDetail>;
+    };
+    readonly datasets: {
+        create: {
+            (request: CustomDatasetCreateRequest, options?: PermuteRequestOptions): Promise<PermuteDataset>;
+            (request: FileDatasetCreateRequest, options?: PermuteRequestOptions): Promise<PermuteFileDataset>;
+        };
+        getByKey: (key: string, options?: PermuteRequestOptions) => Promise<PermuteDataset | PermuteFileDataset>;
+        get: (datasetId: string, options?: PermuteRequestOptions) => Promise<PermuteDataset | PermuteFileDataset>;
+    };
+    private readonly apiKey;
+    private readonly baseUrl;
+    /** Workspace selected for workspace-scoped API operations. */
+    readonly workspaceId?: string;
+    private readonly defaultHeaders;
+    private readonly fetchImpl;
+    constructor(options: PermuteClientOptions);
+    search(request: SearchRequest, options?: PermuteRequestOptions): Promise<SearchResponse>;
+    answer(request: AnswerRequest, options?: PermuteRequestOptions): Promise<AnswerResponse>;
+    answerJobs(request: AnswerRequest, options?: PermuteRequestOptions): Promise<AnswerJobResponse>;
+    getAnswerJob(answerJobId: string, options?: PermuteRequestOptions): Promise<AnswerJobResponse>;
+    withWorkspace(workspaceId: string): PermuteClient;
+    query(request: QueryRequest, options?: PermuteRequestOptions): Promise<QueryResponse>;
+    private request;
+    private validateRequestBody;
+    private validateRequestQuery;
+}
+export {};