@permute/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+export * from './types.js';
+export * from './client.js';
+export declare const CONTEXT: {
+    readonly QuickBooks: "quickbooks";
+    readonly HubSpot: "hubspot";
+    readonly Attio: "attio";
+    readonly BigQuery: "bigquery";
+    readonly Billcom: "billcom";
+    readonly Brex: "brex";
+    readonly Double: "double";
+    readonly Fireflies: "fireflies";
+    readonly Klaviyo: "klaviyo";
+    readonly Mercury: "mercury";
+    readonly Monday: "monday";
+    readonly Stripe: "stripe";
+    readonly Xero: "xero";
+};

package/dist/index.js

@@ -0,0 +1,17 @@
+export * from './types.js';
+export * from './client.js';
+export const CONTEXT = {
+    QuickBooks: 'quickbooks',
+    HubSpot: 'hubspot',
+    Attio: 'attio',
+    BigQuery: 'bigquery',
+    Billcom: 'billcom',
+    Brex: 'brex',
+    Double: 'double',
+    Fireflies: 'fireflies',
+    Klaviyo: 'klaviyo',
+    Mercury: 'mercury',
+    Monday: 'monday',
+    Stripe: 'stripe',
+    Xero: 'xero',
+};

package/dist/types.d.ts

@@ -0,0 +1,56 @@
+import type { components } from './generated/openapi.js';
+type PublicApiSchema<Name extends keyof components['schemas']> = components['schemas'][Name];
+export type Workspace = PublicApiSchema<'Workspace'>;
+export type WorkspaceList = PublicApiSchema<'WorkspaceList'>;
+export type WorkspaceCreateRequest = PublicApiSchema<'WorkspaceCreateRequest'>;
+export type WorkspaceUpdateRequest = PublicApiSchema<'WorkspaceUpdateRequest'>;
+export type WorkspaceDeleteResponse = PublicApiSchema<'WorkspaceDeleteResponse'>;
+export type Source = PublicApiSchema<'Source'>;
+export type SourceList = PublicApiSchema<'SourceList'>;
+export type SourceDetail = PublicApiSchema<'SourceDetail'>;
+export type CatalogField = PublicApiSchema<'CatalogField'>;
+export type CatalogTable = PublicApiSchema<'CatalogTable'>;
+type DatasetApiCreateRequest = PublicApiSchema<'DatasetCreateRequest'>;
+export type DatasetResponse = PublicApiSchema<'DatasetResponse'>;
+export type CustomDatasetResponse = PublicApiSchema<'CustomDatasetResponse'>;
+export type FileDatasetResponse = PublicApiSchema<'FileDatasetResponse'>;
+export type DatasetUploadBody = string | Blob | ArrayBuffer | ArrayBufferView;
+export type CustomDatasetCreateRequest = Extract<DatasetApiCreateRequest, {
+    type: 'custom';
+}>;
+export type FileDatasetCreateRequest = Omit<Extract<DatasetApiCreateRequest, {
+    type: 'file';
+}>, 'sizeBytes'> & {
+    data: DatasetUploadBody;
+    sizeBytes?: number;
+    headers?: Record<string, string>;
+};
+export type DatasetCreateRequest = CustomDatasetCreateRequest | FileDatasetCreateRequest;
+export type DatasetWriteTablesRequest = PublicApiSchema<'DatasetWriteTablesRequest'>;
+export type DatasetWriteTablesResponse = PublicApiSchema<'DatasetWriteTablesResponse'>;
+export type DatasetRows = Record<string, unknown>[];
+export type SearchRequest = PublicApiSchema<'SearchRequest'>;
+export type SearchResult = PublicApiSchema<'SearchResult'>;
+export type SearchResponse = PublicApiSchema<'SearchResponse'>;
+export type AnswerRequest = PublicApiSchema<'AnswerRequest'>;
+export type AnswerCitation = PublicApiSchema<'AnswerCitation'>;
+export type AnswerConfidence = PublicApiSchema<'AnswerConfidence'>;
+export type AnswerResponse = PublicApiSchema<'AnswerResponse'>;
+export type AnswerJobResponse = PublicApiSchema<'AnswerJobResponse'>;
+export type QueryRequest = PublicApiSchema<'QueryRequest'>;
+export type QueryResponse = PublicApiSchema<'QueryResponse'>;
+export interface PermuteRequestOptions {
+    workspaceId?: string;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+    /** Maximum time to wait for a durable operation. Defaults to 20 minutes. */
+    pollTimeoutMs?: number;
+}
+export interface PermuteClientOptions {
+    apiKey: string;
+    baseUrl?: string;
+    workspaceId?: string;
+    fetch?: typeof fetch;
+    headers?: Record<string, string>;
+}
+export {};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@permute/sdk",
+  "version": "0.1.0",
+  "description": "TypeScript client for the Permute public API",
+  "type": "module",
+  "license": "Apache-2.0",
+  "author": "Permute, Inc. <info@permute.ai>",
+  "homepage": "https://permute.ai",
+  "keywords": [
+    "permute",
+    "analytics",
+    "data",
+    "sdk"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "bun run scripts/build.ts",
+    "generate": "bun run scripts/generate-contract.ts",
+    "prepack": "bun run build",
+    "prepublishOnly": "bun run verify:package",
+    "verify:package": "bun run scripts/verify-package.ts",
+    "test": "bun run generate && vitest --run",
+    "test:live": "bun run scripts/run-live-scope-test.ts",
+    "typecheck": "bun run scripts/typecheck.ts"
+  },
+  "dependencies": {
+    "ajv": "^8.20.0"
+  },
+  "devDependencies": {
+    "@types/bun": "1.3.13",
+    "@types/node": "^24",
+    "openapi-typescript": "^7.13.0",
+    "prettier": "3.6.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.6"
+  }
+}