@membranehq/sdk 0.8.4 → 0.9.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 (91) hide show
  1. package/dist/bundle.d.ts +423 -293
  2. package/dist/bundle.js +142 -103
  3. package/dist/bundle.js.map +1 -1
  4. package/dist/dts/accessors/action-instances-accessors.d.ts +1 -16
  5. package/dist/dts/accessors/actions-accessors.d.ts +26 -7
  6. package/dist/dts/accessors/actions-accessors.test.d.ts +1 -0
  7. package/dist/dts/accessors/connections-accessors.d.ts +7 -5
  8. package/dist/dts/accessors/integrations-accessors.d.ts +7 -5
  9. package/dist/dts/agent/index.d.ts +2 -0
  10. package/dist/dts/agent/mcp.d.ts +6 -0
  11. package/dist/dts/agent/session.d.ts +4 -1
  12. package/dist/dts/alerts/types.d.ts +2 -1
  13. package/dist/dts/api-version.generated.d.ts +10 -0
  14. package/dist/dts/apps/types.d.ts +371 -0
  15. package/dist/dts/entity-repository.d.ts +0 -1
  16. package/dist/dts/errors/index.d.ts +5 -1
  17. package/dist/dts/formulas/dataSchemaRef.d.ts +3 -3
  18. package/dist/dts/index.browser.d.ts +4 -2
  19. package/dist/dts/orgs/types.d.ts +342 -3
  20. package/dist/dts/platform-users.d.ts +24 -0
  21. package/dist/dts/usage/types.d.ts +4 -2
  22. package/dist/dts/validation/types.d.ts +2 -0
  23. package/dist/dts/workspace-elements/api/action-run-log-records-api.d.ts +15 -11
  24. package/dist/dts/workspace-elements/api/actions-api.d.ts +57 -55
  25. package/dist/dts/workspace-elements/api/app-data-schema-instances-api.d.ts +5 -5
  26. package/dist/dts/workspace-elements/api/app-data-schemas-api.d.ts +2 -2
  27. package/dist/dts/workspace-elements/api/app-event-log-records-api.d.ts +9 -8
  28. package/dist/dts/workspace-elements/api/app-event-subscriptions-api.d.ts +9 -8
  29. package/dist/dts/workspace-elements/api/app-event-types-api.d.ts +3 -2
  30. package/dist/dts/workspace-elements/api/connections-api.d.ts +9 -3
  31. package/dist/dts/workspace-elements/api/data-link-table-instances-api.d.ts +9 -7
  32. package/dist/dts/workspace-elements/api/data-link-tables-api.d.ts +2 -2
  33. package/dist/dts/workspace-elements/api/data-source-instances-api.d.ts +11 -8
  34. package/dist/dts/workspace-elements/api/data-sources-api.d.ts +10 -6
  35. package/dist/dts/workspace-elements/api/external-event-log-records-api.d.ts +10 -7
  36. package/dist/dts/workspace-elements/api/external-event-pulls-api.d.ts +10 -7
  37. package/dist/dts/workspace-elements/api/external-event-subscriptions-api.d.ts +9 -6
  38. package/dist/dts/workspace-elements/api/external-events-api.d.ts +8 -6
  39. package/dist/dts/workspace-elements/api/field-mapping-instances-api.d.ts +24 -19
  40. package/dist/dts/workspace-elements/api/field-mappings-api.d.ts +14 -14
  41. package/dist/dts/workspace-elements/api/flow-runs-api.d.ts +18 -14
  42. package/dist/dts/workspace-elements/api/flows-api.d.ts +133 -29
  43. package/dist/dts/workspace-elements/api/integrations-api.d.ts +5 -3
  44. package/dist/dts/workspace-elements/api/packages-api.d.ts +30 -18
  45. package/dist/dts/workspace-elements/base/action-instances/types.d.ts +7 -7
  46. package/dist/dts/workspace-elements/base/action-run-log-records/types.d.ts +2 -0
  47. package/dist/dts/workspace-elements/base/actions/index.d.ts +30 -14
  48. package/dist/dts/workspace-elements/base/app-data-schema-instances/types.d.ts +1 -1
  49. package/dist/dts/workspace-elements/base/app-data-schemas/types.d.ts +2 -2
  50. package/dist/dts/workspace-elements/base/app-event-subscriptions/types.d.ts +2 -2
  51. package/dist/dts/workspace-elements/base/app-event-types/types.d.ts +3 -2
  52. package/dist/dts/workspace-elements/base/connections/types.d.ts +2 -0
  53. package/dist/dts/workspace-elements/base/connectors/types.d.ts +2 -0
  54. package/dist/dts/workspace-elements/base/data-link-table-instances/types.d.ts +2 -2
  55. package/dist/dts/workspace-elements/base/data-link-tables/types.d.ts +2 -2
  56. package/dist/dts/workspace-elements/base/data-source-instances/types.d.ts +3 -3
  57. package/dist/dts/workspace-elements/base/data-sources/index.d.ts +22 -3
  58. package/dist/dts/workspace-elements/base/external-event-subscriptions/types.d.ts +6 -4
  59. package/dist/dts/workspace-elements/base/external-events/types.d.ts +6 -4
  60. package/dist/dts/workspace-elements/base/field-mapping-instances/types.d.ts +1 -1
  61. package/dist/dts/workspace-elements/base/field-mappings/index.d.ts +23 -3
  62. package/dist/dts/workspace-elements/base/flow-instances/types.d.ts +1 -1
  63. package/dist/dts/workspace-elements/base/flows/index.d.ts +45 -3
  64. package/dist/dts/workspace-elements/base/integrations/types.d.ts +18 -4
  65. package/dist/dts/workspace-elements/base/packages/index.d.ts +35 -8
  66. package/dist/dts/workspace-elements/compare.d.ts +16 -0
  67. package/dist/dts/workspace-elements/compare.test.d.ts +1 -0
  68. package/dist/dts/workspace-elements/index.d.ts +1 -0
  69. package/dist/dts/workspace-elements/paths.d.ts +8 -0
  70. package/dist/dts/workspace-elements/paths.test.d.ts +1 -0
  71. package/dist/dts/workspace-elements/types.d.ts +21 -9
  72. package/dist/dts/workspace-elements-catalog/index.d.ts +1 -0
  73. package/dist/dts/workspaces/index.d.ts +1 -0
  74. package/dist/dts/workspaces/schemas.d.ts +24 -0
  75. package/dist/dts/workspaces/types.d.ts +3 -9
  76. package/dist/index.browser.d.mts +9626 -8664
  77. package/dist/index.browser.d.ts +9626 -8664
  78. package/dist/index.browser.js +526 -273
  79. package/dist/index.browser.js.map +1 -1
  80. package/dist/index.browser.mjs +502 -273
  81. package/dist/index.browser.mjs.map +1 -1
  82. package/dist/index.node.d.mts +9647 -8685
  83. package/dist/index.node.d.ts +9647 -8685
  84. package/dist/index.node.js +526 -273
  85. package/dist/index.node.js.map +1 -1
  86. package/dist/index.node.mjs +502 -273
  87. package/dist/index.node.mjs.map +1 -1
  88. package/package.json +2 -1
  89. package/dist/dts/connector-copilot/types.d.ts +0 -160
  90. package/dist/dts/index.d.ts +0 -34
  91. /package/dist/dts/{connector-copilot → validation}/index.d.ts +0 -0
@@ -6,23 +6,47 @@ export declare const PackageElement: z.ZodObject<{
6
6
  element: z.ZodOptional<z.ZodAny>;
7
7
  }, z.core.$strip>;
8
8
  export type PackageElement = z.infer<typeof PackageElement>;
9
+ export declare const PackageElementExport: z.ZodObject<{
10
+ uuid: z.ZodString;
11
+ type: z.ZodEnum<typeof IntegrationElementType>;
12
+ element: z.ZodOptional<z.ZodAny>;
13
+ }, z.core.$strip>;
14
+ export type PackageElementExport = z.infer<typeof PackageElementExport>;
9
15
  export declare const PackageEditableProperties: z.ZodObject<{
16
+ uuid: z.ZodOptional<z.ZodString>;
10
17
  key: z.ZodOptional<z.ZodString>;
11
18
  name: z.ZodOptional<z.ZodString>;
12
- uuid: z.ZodOptional<z.ZodString>;
13
19
  description: z.ZodOptional<z.ZodString>;
14
20
  meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
21
+ integrationId: z.ZodOptional<z.ZodString>;
22
+ integrationUuid: z.ZodOptional<z.ZodString>;
23
+ parentId: z.ZodOptional<z.ZodString>;
24
+ parentUuid: z.ZodOptional<z.ZodString>;
25
+ connectionId: z.ZodOptional<z.ZodString>;
26
+ instanceKey: z.ZodOptional<z.ZodString>;
15
27
  scenarioTemplateId: z.ZodOptional<z.ZodString>;
16
28
  elements: z.ZodOptional<z.ZodArray<z.ZodObject<{
17
29
  id: z.ZodString;
18
30
  type: z.ZodEnum<typeof IntegrationElementType>;
19
31
  element: z.ZodOptional<z.ZodAny>;
20
32
  }, z.core.$strip>>>;
21
- integrationId: z.ZodOptional<z.ZodString>;
22
- parentUuid: z.ZodOptional<z.ZodString>;
23
- parentId: z.ZodOptional<z.ZodString>;
24
33
  }, z.core.$strip>;
25
34
  export type PackageEditableProperties = z.infer<typeof PackageEditableProperties>;
35
+ export declare const PackageExportProperties: z.ZodObject<{
36
+ uuid: z.ZodOptional<z.ZodString>;
37
+ key: z.ZodOptional<z.ZodString>;
38
+ name: z.ZodOptional<z.ZodString>;
39
+ description: z.ZodOptional<z.ZodString>;
40
+ meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
41
+ integrationUuid: z.ZodOptional<z.ZodString>;
42
+ parentUuid: z.ZodOptional<z.ZodString>;
43
+ elements: z.ZodOptional<z.ZodArray<z.ZodObject<{
44
+ uuid: z.ZodString;
45
+ type: z.ZodEnum<typeof IntegrationElementType>;
46
+ element: z.ZodOptional<z.ZodAny>;
47
+ }, z.core.$strip>>>;
48
+ }, z.core.$strip>;
49
+ export type PackageExportProperties = z.infer<typeof PackageExportProperties>;
26
50
  export declare const PackageCalculatedProperties: z.ZodObject<{
27
51
  key: z.ZodString;
28
52
  name: z.ZodString;
@@ -32,7 +56,7 @@ export type PackageCalculatedProperties = z.infer<typeof PackageCalculatedProper
32
56
  export declare const BasePackage: z.ZodObject<{
33
57
  id: z.ZodString;
34
58
  state: z.ZodOptional<z.ZodEnum<typeof import("../../types").WorkspaceElementState>>;
35
- errors: z.ZodOptional<z.ZodArray<z.ZodType<import("../../..").ErrorDataSchema, unknown, z.core.$ZodTypeInternals<import("../../..").ErrorDataSchema, unknown>>>>;
59
+ errors: z.ZodOptional<z.ZodArray<z.ZodType<import("../../../errors").ErrorDataSchema, unknown, z.core.$ZodTypeInternals<import("../../../errors").ErrorDataSchema, unknown>>>>;
36
60
  revision: z.ZodOptional<z.ZodString>;
37
61
  createdAt: z.ZodOptional<z.ZodString>;
38
62
  updatedAt: z.ZodOptional<z.ZodString>;
@@ -41,15 +65,18 @@ export declare const BasePackage: z.ZodObject<{
41
65
  uuid: z.ZodOptional<z.ZodString>;
42
66
  description: z.ZodOptional<z.ZodString>;
43
67
  meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
68
+ integrationId: z.ZodOptional<z.ZodString>;
69
+ integrationUuid: z.ZodOptional<z.ZodString>;
70
+ parentId: z.ZodOptional<z.ZodString>;
71
+ parentUuid: z.ZodOptional<z.ZodString>;
72
+ connectionId: z.ZodOptional<z.ZodString>;
73
+ instanceKey: z.ZodOptional<z.ZodString>;
44
74
  scenarioTemplateId: z.ZodOptional<z.ZodString>;
45
75
  elements: z.ZodOptional<z.ZodArray<z.ZodObject<{
46
76
  id: z.ZodString;
47
77
  type: z.ZodEnum<typeof IntegrationElementType>;
48
78
  element: z.ZodOptional<z.ZodAny>;
49
79
  }, z.core.$strip>>>;
50
- integrationId: z.ZodOptional<z.ZodString>;
51
- parentUuid: z.ZodOptional<z.ZodString>;
52
- parentId: z.ZodOptional<z.ZodString>;
53
80
  key: z.ZodString;
54
81
  name: z.ZodString;
55
82
  isCustomized: z.ZodOptional<z.ZodBoolean>;
@@ -0,0 +1,16 @@
1
+ import { WorkspaceElementType } from './types';
2
+ export declare enum WorkspaceElementChangeType {
3
+ CREATE = "create",
4
+ UPDATE = "update",
5
+ DELETE = "delete"
6
+ }
7
+ export interface WorkspaceElementChange {
8
+ type: WorkspaceElementChangeType;
9
+ uuid: string;
10
+ }
11
+ export interface WorkspaceExportComparison {
12
+ [WorkspaceElementChangeType.CREATE]: Set<string>;
13
+ [WorkspaceElementChangeType.UPDATE]: Set<string>;
14
+ [WorkspaceElementChangeType.DELETE]: Set<string>;
15
+ }
16
+ export declare function compareWorkspaceExports(primaryExport: Partial<Record<WorkspaceElementType, any[]>>, targetExport: Partial<Record<WorkspaceElementType, any[]>>): WorkspaceExportComparison;
@@ -0,0 +1 @@
1
+ export {};
@@ -3,3 +3,4 @@ export * from './types';
3
3
  export * from './api';
4
4
  export * from './errors';
5
5
  export * from './utils';
6
+ export * from './compare';
@@ -0,0 +1,8 @@
1
+ import { WorkspaceElementType } from './types';
2
+ export declare const MEMBRANE_ELEMENT_CONFIG_FILE_NAME = "spec.yaml";
3
+ export declare function getMembraneElementPath(elementType: WorkspaceElementType, elementKey: string, integrationKey?: string | undefined): string;
4
+ export declare function parseMembraneElementPath(relativePath: string): {
5
+ type: WorkspaceElementType;
6
+ key: string;
7
+ integrationKey?: string;
8
+ } | undefined;
@@ -0,0 +1 @@
1
+ export {};
@@ -34,7 +34,6 @@ export declare enum WorkspaceElementType {
34
34
  ExternalEventSubscription = "external-event-subscription",
35
35
  ExternalEventLogRecord = "external-event-log-record",
36
36
  ExternalEventPull = "external-event-pull",
37
- DataCollection = "data-collection",
38
37
  Screen = "screen",
39
38
  ActionRunLogRecord = "action-run-log-record"
40
39
  }
@@ -68,9 +67,9 @@ export declare const BaseWorkspaceElement: z.ZodObject<{
68
67
  }, z.core.$strip>;
69
68
  export type BaseWorkspaceElement = z.infer<typeof BaseWorkspaceElement>;
70
69
  export declare const BaseMembraneInterfaceEditableProperties: z.ZodObject<{
70
+ uuid: z.ZodOptional<z.ZodString>;
71
71
  key: z.ZodOptional<z.ZodString>;
72
72
  name: z.ZodOptional<z.ZodString>;
73
- uuid: z.ZodOptional<z.ZodString>;
74
73
  description: z.ZodOptional<z.ZodString>;
75
74
  meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
76
75
  }, z.core.$strip>;
@@ -86,8 +85,8 @@ export declare const BaseMembraneInterfaceReadOnlyProperties: z.ZodObject<{
86
85
  }, z.core.$strip>;
87
86
  export declare const BaseMembraneInterface: z.ZodObject<{
88
87
  id: z.ZodString;
89
- key: z.ZodOptional<z.ZodString>;
90
88
  uuid: z.ZodOptional<z.ZodString>;
89
+ key: z.ZodOptional<z.ZodString>;
91
90
  description: z.ZodOptional<z.ZodString>;
92
91
  meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
93
92
  name: z.ZodString;
@@ -101,15 +100,17 @@ export declare const BaseMembraneInterface: z.ZodObject<{
101
100
  }, z.core.$strip>;
102
101
  export type BaseMembraneInterface = z.infer<typeof BaseMembraneInterface>;
103
102
  export declare const BaseIntegrationLevelMembraneInterfaceEditableProperties: z.ZodObject<{
103
+ uuid: z.ZodOptional<z.ZodString>;
104
104
  key: z.ZodOptional<z.ZodString>;
105
105
  name: z.ZodOptional<z.ZodString>;
106
- uuid: z.ZodOptional<z.ZodString>;
107
106
  description: z.ZodOptional<z.ZodString>;
108
107
  meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
109
- integrationUuid: z.ZodOptional<z.ZodString>;
110
- parentUuid: z.ZodOptional<z.ZodString>;
111
108
  integrationId: z.ZodOptional<z.ZodString>;
109
+ integrationUuid: z.ZodOptional<z.ZodString>;
112
110
  parentId: z.ZodOptional<z.ZodString>;
111
+ parentUuid: z.ZodOptional<z.ZodString>;
112
+ connectionId: z.ZodOptional<z.ZodString>;
113
+ instanceKey: z.ZodOptional<z.ZodString>;
113
114
  }, z.core.$strip>;
114
115
  export declare const BaseIntegrationLevelMembraneInterfaceReadOnlyProperties: z.ZodObject<{
115
116
  name: z.ZodString;
@@ -122,6 +123,15 @@ export declare const BaseIntegrationLevelMembraneInterfaceReadOnlyProperties: z.
122
123
  isDeactivated: z.ZodOptional<z.ZodBoolean>;
123
124
  isCustomized: z.ZodOptional<z.ZodBoolean>;
124
125
  }, z.core.$strip>;
126
+ export declare const BaseIntegrationLevelMembraneInterfaceExportProperties: z.ZodObject<{
127
+ uuid: z.ZodOptional<z.ZodString>;
128
+ key: z.ZodOptional<z.ZodString>;
129
+ name: z.ZodOptional<z.ZodString>;
130
+ description: z.ZodOptional<z.ZodString>;
131
+ meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
132
+ integrationUuid: z.ZodOptional<z.ZodString>;
133
+ parentUuid: z.ZodOptional<z.ZodString>;
134
+ }, z.core.$strip>;
125
135
  export declare const IntegrationLevelMembraneInterfaceSelectorQuery: z.ZodObject<{
126
136
  layer: z.ZodOptional<z.ZodEnum<{
127
137
  connection: "connection";
@@ -155,14 +165,16 @@ export declare const FindIntegrationLevelMembraneInterfaceQuery: z.ZodObject<{
155
165
  export type FindIntegrationLevelMembraneInterfaceQuery = z.infer<typeof FindIntegrationLevelMembraneInterfaceQuery>;
156
166
  export declare const BaseIntegrationLevelMembraneInterface: z.ZodObject<{
157
167
  id: z.ZodString;
158
- key: z.ZodOptional<z.ZodString>;
159
168
  uuid: z.ZodOptional<z.ZodString>;
169
+ key: z.ZodOptional<z.ZodString>;
160
170
  description: z.ZodOptional<z.ZodString>;
161
171
  meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
162
- integrationUuid: z.ZodOptional<z.ZodString>;
163
- parentUuid: z.ZodOptional<z.ZodString>;
164
172
  integrationId: z.ZodOptional<z.ZodString>;
173
+ integrationUuid: z.ZodOptional<z.ZodString>;
165
174
  parentId: z.ZodOptional<z.ZodString>;
175
+ parentUuid: z.ZodOptional<z.ZodString>;
176
+ connectionId: z.ZodOptional<z.ZodString>;
177
+ instanceKey: z.ZodOptional<z.ZodString>;
166
178
  name: z.ZodString;
167
179
  state: z.ZodOptional<z.ZodEnum<typeof WorkspaceElementState>>;
168
180
  errors: z.ZodOptional<z.ZodArray<z.ZodType<ErrorDataSchema, unknown, z.core.$ZodTypeInternals<ErrorDataSchema, unknown>>>>;
@@ -10,6 +10,7 @@ export interface WorkspaceElementSpec {
10
10
  createSchema?: z.ZodObject<any>;
11
11
  updateSchema?: z.ZodObject<any>;
12
12
  editablePropertiesSchema?: z.ZodObject<any>;
13
+ exportPropertiesSchema?: z.ZodObject<any>;
13
14
  apiResponseSchema?: z.ZodObject<any>;
14
15
  findQuerySchema?: z.ZodObject<any>;
15
16
  isMembraneInterface?: boolean;
@@ -1,3 +1,4 @@
1
1
  export * from './api';
2
2
  export * from './types';
3
3
  export * from './constants';
4
+ export * from './schemas';
@@ -0,0 +1,24 @@
1
+ import { z } from 'zod';
2
+ import { WorkspaceOnboardingStep } from './types';
3
+ export declare const OrgWorkspaceSchema: z.ZodObject<{
4
+ id: z.ZodString;
5
+ name: z.ZodString;
6
+ orgId: z.ZodString;
7
+ apiBaseUri: z.ZodOptional<z.ZodString>;
8
+ key: z.ZodString;
9
+ secret: z.ZodString;
10
+ createdAt: z.ZodCoercedDate<unknown>;
11
+ updatedAt: z.ZodCoercedDate<unknown>;
12
+ engineAccessToken: z.ZodOptional<z.ZodString>;
13
+ onboardingStep: z.ZodOptional<z.ZodEnum<typeof WorkspaceOnboardingStep>>;
14
+ trialEndDate: z.ZodOptional<z.ZodString>;
15
+ featureFlags: z.ZodOptional<z.ZodArray<z.ZodString>>;
16
+ logoUri: z.ZodOptional<z.ZodString>;
17
+ }, z.core.$strip>;
18
+ export declare const OrgWorkspaceUser: z.ZodObject<{
19
+ id: z.ZodString;
20
+ workspaceId: z.ZodString;
21
+ testCustomerId: z.ZodString;
22
+ userId: z.ZodString;
23
+ role: z.ZodString;
24
+ }, z.core.$strip>;
@@ -1,5 +1,6 @@
1
+ import z from 'zod';
2
+ import { EngineWorkspaceSettingsSchema } from '../apps';
1
3
  import { DataSchema } from '../data-schema';
2
- import { User } from '../workspace-elements/api/customers-api';
3
4
  import { ConnectorAuth, RestApiClientOptions } from '../workspace-elements/base/connectors';
4
5
  export declare enum WorkspaceOnboardingStep {
5
6
  AddConnectors = "add-connectors",
@@ -17,15 +18,9 @@ export interface Workspace {
17
18
  createdAt: Date;
18
19
  updatedAt: Date;
19
20
  onboardingStep?: WorkspaceOnboardingStep;
20
- isGettingStartedCompleted?: boolean;
21
21
  trialEndDate?: string;
22
22
  }
23
- export interface EngineWorkspaceSettings {
24
- enableApiLogs?: boolean;
25
- enableWebhookLogs?: boolean;
26
- enableActionRunLogs?: boolean;
27
- disableSecretKeyAuth?: boolean;
28
- }
23
+ export type EngineWorkspaceSettings = z.Infer<typeof EngineWorkspaceSettingsSchema>;
29
24
  export interface EngineWorkspace {
30
25
  id: string;
31
26
  key: string;
@@ -56,7 +51,6 @@ export interface WorkspaceUser {
56
51
  workspaceId: string;
57
52
  testCustomerId: string;
58
53
  userId: string;
59
- user: User;
60
54
  role: string;
61
55
  }
62
56
  export interface UserWorkspaceSettings {