@membranehq/sdk 0.28.2 → 0.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/dist/bundle.d.ts +49 -2
  2. package/dist/bundle.js +1899 -1388
  3. package/dist/bundle.js.map +1 -1
  4. package/dist/dts/accessors/connection-events-listener.d.ts +14 -0
  5. package/dist/dts/accessors/connection-events-listener.test.d.ts +1 -0
  6. package/dist/dts/accessors/connections-accessors.d.ts +6 -1
  7. package/dist/dts/accessors/integrations-accessors.d.ts +3 -0
  8. package/dist/dts/agent/session.d.ts +1 -0
  9. package/dist/dts/agent/worker-contracts.d.ts +2 -1
  10. package/dist/dts/ai-gateway/models.d.ts +4 -0
  11. package/dist/dts/api-version.generated.d.ts +1 -1
  12. package/dist/dts/async-requests/types.d.ts +50 -0
  13. package/dist/dts/deprecation.d.ts +1 -0
  14. package/dist/dts/errors/index.d.ts +5 -1
  15. package/dist/dts/index.browser.d.ts +2 -1
  16. package/dist/dts/membrane-instances/types.d.ts +4 -0
  17. package/dist/dts/oauth/types.d.ts +14 -5
  18. package/dist/dts/orgs/types.d.ts +682 -50
  19. package/dist/dts/orgs/types.test.d.ts +1 -0
  20. package/dist/dts/platform-user-tokens/types.d.ts +42 -0
  21. package/dist/dts/workspace-elements/api/action-run-log-records-api.d.ts +32 -72
  22. package/dist/dts/workspace-elements/api/checkpoints-api.d.ts +0 -1
  23. package/dist/dts/workspace-elements/api/connections-api.d.ts +30 -3
  24. package/dist/dts/workspace-elements/api/connectors-api.d.ts +10 -0
  25. package/dist/dts/workspace-elements/api/data-link-table-instances-api.d.ts +1 -0
  26. package/dist/dts/workspace-elements/api/data-sources-api.d.ts +2 -0
  27. package/dist/dts/workspace-elements/api/external-api-logs-api.d.ts +1 -0
  28. package/dist/dts/workspace-elements/api/external-apps-api.d.ts +28 -0
  29. package/dist/dts/workspace-elements/api/external-event-log-records-api.d.ts +5 -0
  30. package/dist/dts/workspace-elements/api/external-event-pulls-api.d.ts +3 -0
  31. package/dist/dts/workspace-elements/api/external-event-subscriptions-api.d.ts +13 -0
  32. package/dist/dts/workspace-elements/api/external-event-types-api.d.ts +331 -0
  33. package/dist/dts/workspace-elements/api/field-mappings-api.d.ts +2 -0
  34. package/dist/dts/workspace-elements/api/flow-runs-api.d.ts +2 -0
  35. package/dist/dts/workspace-elements/api/flows-api.d.ts +2 -0
  36. package/dist/dts/workspace-elements/api/incoming-webhooks-api.d.ts +4 -0
  37. package/dist/dts/workspace-elements/api/index.d.ts +1 -0
  38. package/dist/dts/workspace-elements/api/integrations-api.d.ts +14 -7
  39. package/dist/dts/workspace-elements/base/action-run-log-records/index.d.ts +19 -0
  40. package/dist/dts/workspace-elements/base/actions/action-payload.d.ts +46 -0
  41. package/dist/dts/workspace-elements/base/actions/action-payload.test.d.ts +1 -0
  42. package/dist/dts/workspace-elements/base/actions/index.d.ts +3 -2
  43. package/dist/dts/workspace-elements/base/app-data-schemas/index.d.ts +2 -2
  44. package/dist/dts/workspace-elements/base/app-event-types/index.d.ts +2 -2
  45. package/dist/dts/workspace-elements/base/connection-requests/index.d.ts +4 -0
  46. package/dist/dts/workspace-elements/base/connections/index.d.ts +2 -0
  47. package/dist/dts/workspace-elements/base/connectors/index.d.ts +5 -5
  48. package/dist/dts/workspace-elements/base/data-link-tables/index.d.ts +2 -2
  49. package/dist/dts/workspace-elements/base/data-sources/index.d.ts +2 -2
  50. package/dist/dts/workspace-elements/base/external-event-log-records/index.d.ts +1 -0
  51. package/dist/dts/workspace-elements/base/external-event-subscriptions/index.d.ts +2 -0
  52. package/dist/dts/workspace-elements/base/external-event-types/index.d.ts +190 -0
  53. package/dist/dts/workspace-elements/base/field-mappings/index.d.ts +2 -2
  54. package/dist/dts/workspace-elements/base/flows/index.d.ts +2 -2
  55. package/dist/dts/workspace-elements/base/index.d.ts +1 -0
  56. package/dist/dts/workspace-elements/base/integrations/index.d.ts +2 -2
  57. package/dist/dts/workspace-elements/base/packages/index.d.ts +2 -2
  58. package/dist/dts/workspace-elements/types.d.ts +11 -2
  59. package/dist/dts/workspace-tokens/index.d.ts +1 -0
  60. package/dist/dts/{client-tokens → workspace-tokens}/types.d.ts +35 -22
  61. package/dist/dts/workspaces/api.d.ts +0 -6
  62. package/dist/dts/workspaces/compare.d.ts +4 -1
  63. package/dist/index.browser.d.mts +2279 -847
  64. package/dist/index.browser.d.ts +2279 -847
  65. package/dist/index.browser.js +692 -196
  66. package/dist/index.browser.js.map +1 -1
  67. package/dist/index.browser.mjs +653 -190
  68. package/dist/index.browser.mjs.map +1 -1
  69. package/dist/index.node.d.mts +2279 -847
  70. package/dist/index.node.d.ts +2279 -847
  71. package/dist/index.node.js +692 -196
  72. package/dist/index.node.js.map +1 -1
  73. package/dist/index.node.mjs +653 -190
  74. package/dist/index.node.mjs.map +1 -1
  75. package/package.json +2 -2
  76. /package/dist/dts/{client-tokens → platform-user-tokens}/index.d.ts +0 -0
@@ -0,0 +1,14 @@
1
+ import { MembraneError } from '../errors';
2
+ import { ConnectionApiResponse } from '../workspace-elements/api';
3
+ export interface ConnectionEventHandlers {
4
+ onSuccess?: (connection: ConnectionApiResponse) => void;
5
+ onFailure?: (error: MembraneError) => void;
6
+ onTerminal?: () => void;
7
+ }
8
+ export declare function routeConnectionEventMessage(message: unknown, requestId: string, handlers: ConnectionEventHandlers): void;
9
+ export declare function createConnectionEventsSubscription(options: {
10
+ apiUri: string;
11
+ getToken: () => Promise<string> | string;
12
+ requestId: string;
13
+ handlers: ConnectionEventHandlers;
14
+ }): () => void;
@@ -1,7 +1,7 @@
1
1
  import { MembraneApiClient } from '../api-client';
2
2
  import { OpenConfigurationOptions } from '../iframe';
3
3
  import { InstanceKeyQuery } from '../integration-elements/common';
4
- import { ConnectionApiResponse, CreateConnectionRequest, FindConnectionsQuery, UpdateConnectionRequest } from '../workspace-elements/api/connections-api';
4
+ import { ConnectionApiResponse, CreateConnectionRequest, FindConnectionsQuery, LateConnectionEvents, UpdateConnectionRequest } from '../workspace-elements/api/connections-api';
5
5
  import { OperationRunRequest, OperationRunResponse, OperationSpec } from '../workspace-elements/base/connectors/operations';
6
6
  import { DataCollectionSpec, DataCollectionCreateRequest, DataCollectionCreateResponse, DataCollectionDeleteRequest, DataCollectionDeleteResponse, DataCollectionFindByIdRequest, DataCollectionFindByIdResponse, DataCollectionListRequest, DataCollectionListResponse, DataCollectionMatchRequest, DataCollectionMatchResponse, DataCollectionSearchRequest, DataCollectionSearchResponse, DataCollectionUpdateRequest, DataCollectionUpdateResponse } from '../workspace-elements/base/data-collections';
7
7
  import { ConnectionLevelActionAccessor, ConnectionLevelActionsAccessor } from './actions-accessors';
@@ -31,6 +31,7 @@ export declare class ConnectionAccessor {
31
31
  patch(data: UpdateConnectionRequest): Promise<ConnectionApiResponse>;
32
32
  put(data: UpdateConnectionRequest): Promise<ConnectionApiResponse>;
33
33
  archive(): Promise<void>;
34
+ restore(): Promise<ConnectionApiResponse>;
34
35
  request(path: string, data?: any): Promise<any>;
35
36
  get proxy(): ConnectionProxy;
36
37
  operation(key: string): ConnectionOperationAccessor;
@@ -75,6 +76,7 @@ export declare class ConnectionAccessor {
75
76
  description: string;
76
77
  uiUrl?: string | undefined;
77
78
  agentInstructions?: string | undefined;
79
+ handoffAgentInstructions?: string | undefined;
78
80
  } | undefined;
79
81
  tenantId?: string | undefined;
80
82
  user?: {
@@ -131,6 +133,8 @@ export declare class ConnectionAccessor {
131
133
  parameters?: Record<string, any> | undefined;
132
134
  }> | undefined;
133
135
  } | undefined;
136
+ connectorParameters?: unknown;
137
+ input?: unknown;
134
138
  } | null>;
135
139
  openReconnectUI(_options?: OpenConfigurationOptions): Promise<ConnectionApiResponse | null>;
136
140
  refreshCredentials(): Promise<void>;
@@ -186,4 +190,5 @@ export declare function createOrUpdateConnection(options: {
186
190
  apiUri: string;
187
191
  redirectUri?: string;
188
192
  onPopupClosed?: () => void;
193
+ lateEvents?: LateConnectionEvents;
189
194
  }): Promise<ConnectionApiResponse | null>;
@@ -82,6 +82,7 @@ export declare class IntegrationAccessor extends ElementAccessor<IntegrationApiR
82
82
  description: string;
83
83
  uiUrl?: string | undefined;
84
84
  agentInstructions?: string | undefined;
85
+ handoffAgentInstructions?: string | undefined;
85
86
  } | undefined;
86
87
  tenantId?: string | undefined;
87
88
  user?: {
@@ -138,6 +139,8 @@ export declare class IntegrationAccessor extends ElementAccessor<IntegrationApiR
138
139
  parameters?: Record<string, any> | undefined;
139
140
  }> | undefined;
140
141
  } | undefined;
142
+ connectorParameters?: unknown;
143
+ input?: unknown;
141
144
  } | null>;
142
145
  createConnection({ parameters, name, }: {
143
146
  parameters?: any;
@@ -63,6 +63,7 @@ export declare const CreateAgentSession: z.ZodObject<{
63
63
  "anthropic/claude-opus-4.6": "anthropic/claude-opus-4.6";
64
64
  "anthropic/claude-sonnet-4.5": "anthropic/claude-sonnet-4.5";
65
65
  "anthropic/claude-opus-4.5": "anthropic/claude-opus-4.5";
66
+ "anthropic/claude-haiku-4.5": "anthropic/claude-haiku-4.5";
66
67
  "openai/gpt-5.2": "openai/gpt-5.2";
67
68
  "openai/gpt-5-nano": "openai/gpt-5-nano";
68
69
  "google/gemini-3-pro-preview": "google/gemini-3-pro-preview";
@@ -1,4 +1,5 @@
1
1
  import { z } from 'zod';
2
+ import { WorkspaceElementType } from '../workspace-elements';
2
3
  import { AgentName } from './session';
3
4
  export declare const SessionCredentials: z.ZodObject<{
4
5
  accessKeyId: z.ZodString;
@@ -15,7 +16,7 @@ export declare const SessionParameters: z.ZodObject<{
15
16
  }, z.core.$strip>>;
16
17
  apiUri: z.ZodOptional<z.ZodString>;
17
18
  prompt: z.ZodOptional<z.ZodString>;
18
- elementType: z.ZodOptional<z.ZodString>;
19
+ elementType: z.ZodOptional<z.ZodEnum<typeof WorkspaceElementType>>;
19
20
  elementId: z.ZodOptional<z.ZodString>;
20
21
  customerId: z.ZodOptional<z.ZodString>;
21
22
  opencodeSessionUuid: z.ZodOptional<z.ZodString>;
@@ -11,6 +11,9 @@ export declare const AI_GATEWAY_SUPPORTED_MODELS: readonly [{
11
11
  }, {
12
12
  readonly id: "anthropic/claude-opus-4.5";
13
13
  readonly name: "Claude Opus 4.5";
14
+ }, {
15
+ readonly id: "anthropic/claude-haiku-4.5";
16
+ readonly name: "Claude Haiku 4.5";
14
17
  }, {
15
18
  readonly id: "openai/gpt-5.2";
16
19
  readonly name: "GPT-5.2";
@@ -30,6 +33,7 @@ export declare const AIGatewaySupportedModelIdSchema: z.ZodEnum<{
30
33
  "anthropic/claude-opus-4.6": "anthropic/claude-opus-4.6";
31
34
  "anthropic/claude-sonnet-4.5": "anthropic/claude-sonnet-4.5";
32
35
  "anthropic/claude-opus-4.5": "anthropic/claude-opus-4.5";
36
+ "anthropic/claude-haiku-4.5": "anthropic/claude-haiku-4.5";
33
37
  "openai/gpt-5.2": "openai/gpt-5.2";
34
38
  "openai/gpt-5-nano": "openai/gpt-5-nano";
35
39
  "google/gemini-3-pro-preview": "google/gemini-3-pro-preview";
@@ -1,4 +1,4 @@
1
- export declare const API_CONTRACT_VERSION = "1.11";
1
+ export declare const API_CONTRACT_VERSION = "1.12";
2
2
  export declare const API_VERSIONS: {
3
3
  readonly LEGACY: "legacy";
4
4
  readonly '2025-10-21': "2025-10-21";
@@ -19,3 +19,53 @@ export declare const AsyncRequestTriggerResponse: z.ZodObject<{
19
19
  accessKey: z.ZodString;
20
20
  }, z.core.$strip>;
21
21
  export type AsyncRequestTriggerResponse = z.infer<typeof AsyncRequestTriggerResponse>;
22
+ export declare const ListableAsyncRequestType: z.ZodEnum<{
23
+ "export-workspace": "export-workspace";
24
+ "import-workspace": "import-workspace";
25
+ }>;
26
+ export type ListableAsyncRequestType = z.infer<typeof ListableAsyncRequestType>;
27
+ export declare const AsyncRequestStatusSchema: z.ZodEnum<typeof AsyncRequestStatus>;
28
+ export declare const AsyncRequest: z.ZodObject<{
29
+ id: z.ZodString;
30
+ requestType: z.ZodEnum<{
31
+ "export-workspace": "export-workspace";
32
+ "import-workspace": "import-workspace";
33
+ }>;
34
+ status: z.ZodEnum<typeof AsyncRequestStatus>;
35
+ progress: z.ZodOptional<z.ZodNumber>;
36
+ result: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
37
+ error: z.ZodOptional<z.ZodType<ErrorDataSchema, unknown, z.core.$ZodTypeInternals<ErrorDataSchema, unknown>>>;
38
+ meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
39
+ createdAt: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>;
40
+ startedAt: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>>;
41
+ completedAt: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>>;
42
+ }, z.core.$strip>;
43
+ export type AsyncRequest = z.infer<typeof AsyncRequest>;
44
+ export declare const ListAsyncRequestsQuery: z.ZodObject<{
45
+ requestType: z.ZodEnum<{
46
+ "export-workspace": "export-workspace";
47
+ "import-workspace": "import-workspace";
48
+ }>;
49
+ status: z.ZodOptional<z.ZodEnum<typeof AsyncRequestStatus>>;
50
+ limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
51
+ cursor: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
52
+ }, z.core.$strip>;
53
+ export type ListAsyncRequestsQuery = z.infer<typeof ListAsyncRequestsQuery>;
54
+ export declare const ListAsyncRequestsResponse: z.ZodObject<{
55
+ items: z.ZodArray<z.ZodObject<{
56
+ id: z.ZodString;
57
+ requestType: z.ZodEnum<{
58
+ "export-workspace": "export-workspace";
59
+ "import-workspace": "import-workspace";
60
+ }>;
61
+ status: z.ZodEnum<typeof AsyncRequestStatus>;
62
+ progress: z.ZodOptional<z.ZodNumber>;
63
+ result: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
64
+ error: z.ZodOptional<z.ZodType<ErrorDataSchema, unknown, z.core.$ZodTypeInternals<ErrorDataSchema, unknown>>>;
65
+ meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
66
+ createdAt: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>;
67
+ startedAt: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>>;
68
+ completedAt: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>>;
69
+ }, z.core.$strip>>;
70
+ }, z.core.$strip>;
71
+ export type ListAsyncRequestsResponse = z.infer<typeof ListAsyncRequestsResponse>;
@@ -0,0 +1 @@
1
+ export declare function warnDeprecatedOnce(key: string, message: string): void;
@@ -20,7 +20,8 @@ export declare enum BadRequestErrorKey {
20
20
  NOT_AUTHENTICATED = "not_authenticated",
21
21
  ACCESS_DENIED = "access_denied",
22
22
  ALREADY_EXISTS = "already_exists",
23
- RATE_LIMIT_EXCEEDED = "rate_limit_exceeded"
23
+ RATE_LIMIT_EXCEEDED = "rate_limit_exceeded",
24
+ WORKSPACE_TIER_GATED = "workspace_tier_gated"
24
25
  }
25
26
  export declare enum ConnectionErrorKey {
26
27
  CONNECTION_IS_DEFUNCT = "connection_is_defunct",
@@ -96,6 +97,9 @@ export declare class NotAuthenticatedError extends BadRequestError {
96
97
  export declare class AccessDeniedError extends BadRequestError {
97
98
  constructor(arg: ErrorConstructorArg);
98
99
  }
100
+ export declare class RemoteConnectorCodeUnavailableError extends BadRequestError {
101
+ constructor(arg?: ErrorConstructorArg);
102
+ }
99
103
  export declare class CustomCodeError extends MembraneError {
100
104
  constructor(arg: ErrorConstructorArg);
101
105
  }
@@ -36,7 +36,8 @@ export * from './functions';
36
36
  export * from './dto';
37
37
  export * from './async-requests';
38
38
  export * from './self-hosting-tokens';
39
- export * from './client-tokens';
39
+ export * from './platform-user-tokens';
40
+ export * from './workspace-tokens';
40
41
  export * from './oauth';
41
42
  export * from './console-paths';
42
43
  export * from './pending-tasks';
@@ -47,6 +47,8 @@ export declare const MembraneInstanceAdmin: z.ZodObject<{
47
47
  helmValuesPath: z.ZodOptional<z.ZodURL>;
48
48
  awsAccountName: z.ZodOptional<z.ZodString>;
49
49
  awsSsoUrl: z.ZodOptional<z.ZodURL>;
50
+ sentryConsoleProjectId: z.ZodOptional<z.ZodString>;
51
+ sentryApiProjectId: z.ZodOptional<z.ZodString>;
50
52
  }, z.core.$strip>;
51
53
  export type MembraneInstanceAdmin = z.infer<typeof MembraneInstanceAdmin>;
52
54
  export declare const CreateMembraneInstanceRequest: z.ZodObject<{
@@ -69,6 +71,8 @@ export declare const UpdateMembraneInstanceRequest: z.ZodObject<{
69
71
  helmValuesPath: z.ZodOptional<z.ZodNullable<z.ZodURL>>;
70
72
  awsAccountName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
71
73
  awsSsoUrl: z.ZodOptional<z.ZodNullable<z.ZodURL>>;
74
+ sentryConsoleProjectId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
75
+ sentryApiProjectId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
72
76
  }, z.core.$strict>;
73
77
  export type UpdateMembraneInstanceRequest = z.infer<typeof UpdateMembraneInstanceRequest>;
74
78
  export declare const ListMembraneInstancesQuery: z.ZodObject<{
@@ -5,11 +5,20 @@ export declare const OAUTH_TOKEN_TYPE_TENANT: "tenant";
5
5
  export declare const OAUTH_TOKEN_TYPE_CONNECTION: "connection";
6
6
  export declare const OAUTH_TOKEN_TYPES: readonly ["platform-user", "tenant", "connection"];
7
7
  export type OAuthTokenType = (typeof OAUTH_TOKEN_TYPES)[number];
8
- export interface AuthContextSettings {
9
- defaultWorkspaceKey?: string;
10
- defaultTenantKey?: string;
11
- connectionId?: string;
12
- }
8
+ export declare const AuthContextSettings: z.ZodObject<{
9
+ defaultWorkspaceKey: z.ZodOptional<z.ZodString>;
10
+ defaultTenantKey: z.ZodOptional<z.ZodString>;
11
+ connectionId: z.ZodOptional<z.ZodString>;
12
+ }, z.core.$strip>;
13
+ export type AuthContextSettings = z.infer<typeof AuthContextSettings>;
14
+ export declare const PatchTokenSettingsRequest: z.ZodObject<{
15
+ settings: z.ZodOptional<z.ZodObject<{
16
+ defaultWorkspaceKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
17
+ defaultTenantKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
18
+ connectionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
19
+ }, z.core.$strip>>;
20
+ }, z.core.$strip>;
21
+ export type PatchTokenSettingsRequest = z.infer<typeof PatchTokenSettingsRequest>;
13
22
  export declare const OAuthTokenResponse: z.ZodObject<{
14
23
  access_token: z.ZodString;
15
24
  token_type: z.ZodString;