@membranehq/sdk 0.8.0 → 0.8.1

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 (31) hide show
  1. package/dist/bundle.d.ts +314 -104
  2. package/dist/bundle.js +344 -229
  3. package/dist/bundle.js.map +1 -1
  4. package/dist/dts/accessors/action-instances-accessors.d.ts +1 -2
  5. package/dist/dts/accessors/scenarios-accessors.d.ts +6 -4
  6. package/dist/dts/alerts/types.d.ts +3 -1
  7. package/dist/dts/client.d.ts +3 -3
  8. package/dist/dts/webhooks/types.d.ts +5 -2
  9. package/dist/dts/workspace-elements/api/action-run-log-records-api.d.ts +5 -0
  10. package/dist/dts/workspace-elements/api/actions-api.d.ts +309 -1
  11. package/dist/dts/workspace-elements/api/index.d.ts +1 -2
  12. package/dist/dts/workspace-elements/api/{scenarios-api.d.ts → packages-api.d.ts} +8 -7
  13. package/dist/dts/workspace-elements/base/action-instances/types.d.ts +14 -9
  14. package/dist/dts/workspace-elements/base/actions/index.d.ts +46 -0
  15. package/dist/dts/workspace-elements/base/index.d.ts +1 -2
  16. package/dist/dts/workspace-elements/base/{scenarios → packages}/index.d.ts +8 -8
  17. package/dist/dts/workspace-elements/types.d.ts +7 -1
  18. package/dist/index.browser.d.mts +889 -644
  19. package/dist/index.browser.d.ts +889 -644
  20. package/dist/index.browser.js +85 -80
  21. package/dist/index.browser.js.map +1 -1
  22. package/dist/index.browser.mjs +75 -74
  23. package/dist/index.browser.mjs.map +1 -1
  24. package/dist/index.node.d.mts +889 -644
  25. package/dist/index.node.d.ts +889 -644
  26. package/dist/index.node.js +85 -80
  27. package/dist/index.node.js.map +1 -1
  28. package/dist/index.node.mjs +75 -74
  29. package/dist/index.node.mjs.map +1 -1
  30. package/package.json +2 -2
  31. package/dist/dts/workspace-elements/api/action-instances-api.d.ts +0 -94
@@ -3407,7 +3407,7 @@ exports.WorkspaceElementType = void 0;
3407
3407
  WorkspaceElementType["FlowInstance"] = "flow-instance";
3408
3408
  WorkspaceElementType["FlowRun"] = "flow-run";
3409
3409
  WorkspaceElementType["Action"] = "action";
3410
- WorkspaceElementType["Scenario"] = "scenario";
3410
+ WorkspaceElementType["Package"] = "package";
3411
3411
  WorkspaceElementType["ActionInstance"] = "action-instance";
3412
3412
  WorkspaceElementType["Connection"] = "connection";
3413
3413
  WorkspaceElementType["FieldMapping"] = "field-mapping";
@@ -3480,6 +3480,11 @@ const BaseIntegrationLevelMembraneInterfaceEditableProperties = BaseMembraneInte
3480
3480
  const BaseIntegrationLevelMembraneInterfaceReadOnlyProperties = BaseMembraneInterfaceReadOnlyProperties.extend({
3481
3481
  isCustomized: zod.z.boolean().optional(),
3482
3482
  });
3483
+ const IntegrationLevelMembraneInterfaceSelectorQuery = zod.z.object({
3484
+ integrationKey: zod.z.string().optional(),
3485
+ connectionId: zod.z.string().optional(),
3486
+ instanceKey: zod.z.string().optional(),
3487
+ });
3483
3488
  const BaseIntegrationLevelMembraneInterface = BaseMembraneInterface.merge(BaseIntegrationLevelMembraneInterfaceEditableProperties).merge(BaseIntegrationLevelMembraneInterfaceReadOnlyProperties);
3484
3489
 
3485
3490
  function mergeWithFormulas(a, b) {
@@ -3647,17 +3652,34 @@ const ACTIONS = {
3647
3652
  },
3648
3653
  };
3649
3654
 
3655
+ exports.ActionDependencyType = void 0;
3656
+ (function (ActionDependencyType) {
3657
+ ActionDependencyType["FieldMapping"] = "FieldMapping";
3658
+ ActionDependencyType["DataSource"] = "DataSource";
3659
+ })(exports.ActionDependencyType || (exports.ActionDependencyType = {}));
3660
+ const ActionDependency = zod.z.object({
3661
+ type: zod.z.enum(exports.ActionDependencyType),
3662
+ key: zod.z.string(),
3663
+ element: zod.z.any().optional(),
3664
+ });
3650
3665
  const ActionEditableProperties = BaseIntegrationLevelMembraneInterfaceEditableProperties.extend({
3651
3666
  integrationId: zod.z.string().optional(),
3667
+ connectionId: zod.z.string().optional(),
3652
3668
  parentId: zod.z.string().optional(),
3669
+ instanceKey: zod.z.string().optional(),
3653
3670
  inputSchema: DataSchema.optional(),
3654
3671
  type: zod.z.enum(exports.ActionType).optional(),
3655
3672
  config: zod.z.any().optional(),
3656
3673
  outputMapping: zod.z.any().optional(),
3657
3674
  customOutputSchema: DataSchema.optional(),
3658
3675
  });
3659
- const ActionReadOnlyProperties = BaseIntegrationLevelMembraneInterfaceReadOnlyProperties;
3676
+ const ActionReadOnlyProperties = BaseIntegrationLevelMembraneInterfaceReadOnlyProperties.extend({
3677
+ universalParentId: zod.z.string().optional(),
3678
+ userId: zod.z.string().optional(),
3679
+ outputSchema: zod.z.any().optional(),
3680
+ });
3660
3681
  const BaseAction = BaseMembraneInterface.merge(ActionEditableProperties).merge(ActionReadOnlyProperties);
3682
+ const BaseActionInstance = BaseAction;
3661
3683
 
3662
3684
  const ConnectionRequest = zod.z.object({
3663
3685
  path: zod.z.any(),
@@ -8909,23 +8931,23 @@ exports.IntegrationElementType = void 0;
8909
8931
  IntegrationElementType["EXTERNAL_EVENT"] = "external-event";
8910
8932
  })(exports.IntegrationElementType || (exports.IntegrationElementType = {}));
8911
8933
 
8912
- const ScenarioElement = zod.z.object({
8934
+ const PackageElement = zod.z.object({
8913
8935
  id: zod.z.string(),
8914
8936
  type: zod.z.enum(exports.IntegrationElementType),
8915
8937
  element: zod.z.any().optional(),
8916
8938
  });
8917
- const ScenarioEditableProperties = BaseMembraneInterfaceEditableProperties.extend({
8939
+ const PackageEditableProperties = BaseMembraneInterfaceEditableProperties.extend({
8918
8940
  scenarioTemplateId: zod.z.string().optional(),
8919
- elements: zod.z.array(ScenarioElement).optional(),
8941
+ elements: zod.z.array(PackageElement).optional(),
8920
8942
  integrationId: zod.z.string().optional(),
8921
8943
  parentId: zod.z.string().optional(),
8922
8944
  });
8923
- const ScenarioCalculatedProperties = zod.z.object({
8945
+ const PackageCalculatedProperties = zod.z.object({
8924
8946
  key: zod.z.string(),
8925
8947
  name: zod.z.string(),
8926
8948
  isCustomized: zod.z.boolean().optional(),
8927
8949
  });
8928
- const BaseScenario = BaseMembraneInterface.merge(ScenarioEditableProperties).merge(ScenarioCalculatedProperties);
8950
+ const BasePackage = BaseMembraneInterface.merge(PackageEditableProperties).merge(PackageCalculatedProperties);
8929
8951
 
8930
8952
  exports.ScreenType = void 0;
8931
8953
  (function (ScreenType) {
@@ -9055,27 +9077,6 @@ const updateFlowInstanceSchema = zod.z.object({
9055
9077
  .optional(),
9056
9078
  });
9057
9079
 
9058
- exports.ActionDependencyType = void 0;
9059
- (function (ActionDependencyType) {
9060
- ActionDependencyType["FieldMapping"] = "FieldMapping";
9061
- ActionDependencyType["DataSource"] = "DataSource";
9062
- })(exports.ActionDependencyType || (exports.ActionDependencyType = {}));
9063
- const ActionDependency = zod.z.object({
9064
- type: zod.z.enum(exports.ActionDependencyType),
9065
- key: zod.z.string(),
9066
- element: zod.z.any().optional(),
9067
- });
9068
- const BaseActionInstance = BaseMembraneInterface.extend({
9069
- parentId: zod.z.string().optional(),
9070
- universalParentId: zod.z.string().optional(),
9071
- userId: zod.z.string(),
9072
- instanceKey: zod.z.string().optional(),
9073
- type: zod.z.enum(exports.ActionType).optional(),
9074
- inputSchema: zod.z.any().optional(),
9075
- config: zod.z.any().optional(),
9076
- outputSchema: zod.z.any().optional(),
9077
- });
9078
-
9079
9080
  const BaseFieldMappingInstance = BaseMembraneInterface.extend({
9080
9081
  userId: zod.z.string(),
9081
9082
  revision: zod.z.string(),
@@ -9347,6 +9348,8 @@ class PaginationResponse {
9347
9348
 
9348
9349
  const ActionApiResponse = BaseAction.extend({
9349
9350
  integration: BaseIntegration.optional(),
9351
+ user: BaseCustomer.optional(),
9352
+ parent: BaseAction.optional(),
9350
9353
  appliedToIntegrations: AppliedToIntegrations(BaseAction).optional(),
9351
9354
  defaultOutputSchema: DataSchema.optional(),
9352
9355
  transformedOutputSchema: DataSchema.optional(),
@@ -9356,41 +9359,27 @@ const ActionApiResponse = BaseAction.extend({
9356
9359
  const FindActionsQuery = PaginationQuery.extend({
9357
9360
  integrationId: zod.z.string().optional(),
9358
9361
  parentId: zod.z.string().optional(),
9362
+ universalParentId: zod.z.string().optional(),
9359
9363
  integrationKey: zod.z.string().optional(),
9360
9364
  search: zod.z.string().optional(),
9361
9365
  includeArchived: zodBooleanCoercion().optional(),
9366
+ userId: zod.z.string().optional(),
9367
+ connectionId: zod.z.string().optional(),
9362
9368
  });
9363
9369
  const CreateActionRequest = ActionEditableProperties;
9364
9370
  const UpdateActionRequest = CreateActionRequest.extend({}).partial();
9371
+ const CreateActionInstanceRequest = CreateActionRequest;
9372
+ const UpdateActionInstanceRequest = UpdateActionRequest;
9373
+ const RunActionRequest = zod.z.object({
9374
+ input: zod.z.any().optional(),
9375
+ });
9365
9376
  const ActionRunResponse = zod.z.object({
9366
9377
  output: zod.z.any().optional(),
9367
9378
  logs: zod.z.array(zod.z.any()).optional(),
9368
9379
  });
9369
-
9370
- const ActionInstanceApiResponse = BaseActionInstance.extend({
9371
- user: BaseCustomer.optional(),
9372
- parent: BaseAction.optional(),
9373
- });
9374
- const ListActionInstancesForConnectionQuery = zod.z
9375
- .object({
9376
- parentId: zod.z.string().optional(),
9377
- universalParentId: zod.z.string().optional(),
9378
- })
9379
- .merge(PaginationQuery);
9380
- const FindActionInstancesQuery = ListActionInstancesForConnectionQuery.extend({
9381
- integrationKey: zod.z.string().optional(),
9382
- integrationId: zod.z.string().optional(),
9383
- userId: zod.z.string().optional(),
9384
- connectionId: zod.z.string().optional(),
9385
- });
9386
- const CreateActionInstanceRequest = zod.z.object({
9387
- parentId: zod.z.string(),
9388
- connectionId: zod.z.string(),
9389
- config: zod.z.any().optional(),
9390
- });
9391
- const UpdateActionInstanceRequest = zod.z.object({
9392
- config: zod.z.any().optional(),
9393
- });
9380
+ const ActionInstanceApiResponse = ActionApiResponse;
9381
+ const ListActionInstancesForConnectionQuery = FindActionsQuery;
9382
+ const FindActionInstancesQuery = FindActionsQuery;
9394
9383
 
9395
9384
  const ActionRunLogRecordApiResponse = BaseActionRunLogRecord.extend({
9396
9385
  action: BaseAction.optional(),
@@ -9642,12 +9631,12 @@ const IntegrationApiResponse = BaseIntegration.extend({
9642
9631
  parametersSchema: DataSchema.optional(),
9643
9632
  });
9644
9633
 
9645
- const ScenarioElementApi = zod.z.object({
9634
+ const PackageElementApi = zod.z.object({
9646
9635
  id: zod.z.string(),
9647
9636
  type: zod.z.enum(exports.IntegrationElementType),
9648
9637
  element: zod.z.any().optional(),
9649
9638
  });
9650
- const FindScenariosQuery = zod.z
9639
+ const FindPackagesQuery = zod.z
9651
9640
  .object({
9652
9641
  integrationId: zod.z.string().optional(),
9653
9642
  integrationKey: zod.z.string().optional(),
@@ -9656,8 +9645,8 @@ const FindScenariosQuery = zod.z
9656
9645
  .extend(SearchQuery.shape)
9657
9646
  .extend(PaginationQuery.shape)
9658
9647
  .extend(IncludeArchivedQuery.shape);
9659
- const ScenarioApiResponse = BaseScenario.extend({
9660
- appliedToIntegrations: AppliedToIntegrations(BaseScenario).optional(),
9648
+ const PackageApiResponse = BasePackage.extend({
9649
+ appliedToIntegrations: AppliedToIntegrations(BasePackage).optional(),
9661
9650
  });
9662
9651
 
9663
9652
  const ScreenApiResponse = BaseScreen;
@@ -9938,14 +9927,14 @@ const WorkspaceElementSpecs = {
9938
9927
  name: 'Connection',
9939
9928
  namePlural: 'Connections',
9940
9929
  },
9941
- [exports.WorkspaceElementType.Scenario]: {
9942
- type: exports.WorkspaceElementType.Scenario,
9943
- apiPath: 'scenarios',
9944
- name: 'Scenario',
9945
- namePlural: 'Scenarios',
9946
- editablePropertiesSchema: ScenarioEditableProperties,
9947
- apiResponseSchema: ScenarioApiResponse,
9948
- findQuerySchema: FindScenariosQuery,
9930
+ [exports.WorkspaceElementType.Package]: {
9931
+ type: exports.WorkspaceElementType.Package,
9932
+ apiPath: 'packages',
9933
+ name: 'Package',
9934
+ namePlural: 'Packages',
9935
+ editablePropertiesSchema: PackageEditableProperties,
9936
+ apiResponseSchema: PackageApiResponse,
9937
+ findQuerySchema: FindPackagesQuery,
9949
9938
  isMembraneInterface: true,
9950
9939
  isIntegrationLevel: true,
9951
9940
  },
@@ -9989,6 +9978,7 @@ const WorkspaceElementSpecs = {
9989
9978
  updateSchema: updateFlowInstanceSchema,
9990
9979
  name: 'Flow',
9991
9980
  namePlural: 'Flows',
9981
+ parentFieldKey: 'flowId',
9992
9982
  isMembraneInterface: true,
9993
9983
  },
9994
9984
  [exports.WorkspaceElementType.FlowRun]: {
@@ -10011,6 +10001,7 @@ const WorkspaceElementSpecs = {
10011
10001
  apiPath: 'field-mapping-instances',
10012
10002
  name: 'Field Mapping Instance',
10013
10003
  namePlural: 'Field Mapping Instances',
10004
+ parentFieldKey: 'fieldMappingId',
10014
10005
  isMembraneInterface: true,
10015
10006
  },
10016
10007
  [exports.WorkspaceElementType.DataCollection]: {
@@ -10033,6 +10024,7 @@ const WorkspaceElementSpecs = {
10033
10024
  apiPath: 'data-source-instances',
10034
10025
  name: 'Data Source Instance',
10035
10026
  namePlural: 'Data Source Instances',
10027
+ parentFieldKey: 'dataSourceId',
10036
10028
  isMembraneInterface: true,
10037
10029
  },
10038
10030
  [exports.WorkspaceElementType.DataLinkTable]: {
@@ -10047,6 +10039,7 @@ const WorkspaceElementSpecs = {
10047
10039
  apiPath: 'data-link-table-instances',
10048
10040
  name: 'Data Link Table Instance',
10049
10041
  namePlural: 'Data Link Table Instances',
10042
+ parentFieldKey: 'dataLinkTableId',
10050
10043
  isMembraneInterface: true,
10051
10044
  },
10052
10045
  [exports.WorkspaceElementType.AppEventType]: {
@@ -10081,6 +10074,7 @@ const WorkspaceElementSpecs = {
10081
10074
  apiPath: 'app-data-schema-instances',
10082
10075
  name: 'App Data Schema Instance',
10083
10076
  namePlural: 'App Data Schema Instances',
10077
+ parentFieldKey: 'appDataSchemaId',
10084
10078
  isMembraneInterface: true,
10085
10079
  },
10086
10080
  [exports.WorkspaceElementType.ExternalEventSubscription]: {
@@ -10722,6 +10716,9 @@ exports.WebhookTypeEnum = void 0;
10722
10716
  WebhookTypeEnum["USER_INVITED_TO_ORG"] = "user-invited-to-org";
10723
10717
  WebhookTypeEnum["ORG_ACCESS_REQUESTED"] = "org-access-requested";
10724
10718
  WebhookTypeEnum["ORG_CREATED"] = "org-created";
10719
+ WebhookTypeEnum["TASK_CREATED"] = "task-created";
10720
+ WebhookTypeEnum["TASK_UPDATED"] = "task-updated";
10721
+ WebhookTypeEnum["TASK_ACTIVITY_CREATED"] = "task-activity-created";
10725
10722
  })(exports.WebhookTypeEnum || (exports.WebhookTypeEnum = {}));
10726
10723
 
10727
10724
  exports.AlertStatus = void 0;
@@ -10737,6 +10734,8 @@ exports.AlertSeverity = void 0;
10737
10734
  exports.AlertType = void 0;
10738
10735
  (function (AlertType) {
10739
10736
  AlertType["externalEventsPerCustomerPerDay"] = "externalEventsPerCustomerPerDay";
10737
+ AlertType["totalUsagePerDay"] = "totalUsagePerDay";
10738
+ AlertType["totalUsagePer30Days"] = "totalUsagePer30Days";
10740
10739
  })(exports.AlertType || (exports.AlertType = {}));
10741
10740
 
10742
10741
  class ElementAccessor {
@@ -12180,20 +12179,22 @@ class IntegrationAccessor extends ElementAccessor {
12180
12179
  }
12181
12180
  }
12182
12181
 
12183
- class ScenariosAccessor extends ElementListAccessor {
12182
+ class PackagesAccessor extends ElementListAccessor {
12184
12183
  constructor(client) {
12185
- super(client, 'scenarios');
12184
+ super(client, 'packages');
12186
12185
  }
12187
12186
  }
12188
- class ScenarioAccessor extends ElementAccessor {
12187
+ class PackageAccessor extends ElementAccessor {
12189
12188
  constructor(client, selector) {
12190
12189
  super({
12191
12190
  client,
12192
12191
  selector,
12193
- path: 'scenario',
12192
+ path: 'package',
12194
12193
  });
12195
12194
  }
12196
12195
  }
12196
+ const ScenariosAccessor = PackagesAccessor;
12197
+ const ScenarioAccessor = PackageAccessor;
12197
12198
 
12198
12199
  class ScreensAccessor extends ElementListAccessor {
12199
12200
  constructor(client) {
@@ -12703,11 +12704,11 @@ class MembraneClient extends MembraneApiClient {
12703
12704
  get customers() {
12704
12705
  return new CustomersAccessor(this);
12705
12706
  }
12706
- scenario(selector) {
12707
- return new ScenarioAccessor(this, selector);
12707
+ package(selector) {
12708
+ return new PackageAccessor(this, selector);
12708
12709
  }
12709
- get scenarios() {
12710
- return new ScenariosAccessor(this);
12710
+ get packages() {
12711
+ return new PackagesAccessor(this);
12711
12712
  }
12712
12713
  async createEventSource(uri, queryParams) {
12713
12714
  return super.createEventSource(uri, queryParams);
@@ -12947,7 +12948,7 @@ exports.BaseIntegrationLevelMembraneInterfaceReadOnlyProperties = BaseIntegratio
12947
12948
  exports.BaseMembraneInterface = BaseMembraneInterface;
12948
12949
  exports.BaseMembraneInterfaceEditableProperties = BaseMembraneInterfaceEditableProperties;
12949
12950
  exports.BaseMembraneInterfaceReadOnlyProperties = BaseMembraneInterfaceReadOnlyProperties;
12950
- exports.BaseScenario = BaseScenario;
12951
+ exports.BasePackage = BasePackage;
12951
12952
  exports.BaseScreen = BaseScreen;
12952
12953
  exports.BaseWorkspaceElement = BaseWorkspaceElement;
12953
12954
  exports.CONFIG_FILE_NAME = CONFIG_FILE_NAME;
@@ -13110,7 +13111,7 @@ exports.FindFlowRunsQuery = FindFlowRunsQuery;
13110
13111
  exports.FindFlowRunsResponse = FindFlowRunsResponse;
13111
13112
  exports.FindFlowsQuery = FindFlowsQuery;
13112
13113
  exports.FindIntegrationsQuery = FindIntegrationsQuery;
13113
- exports.FindScenariosQuery = FindScenariosQuery;
13114
+ exports.FindPackagesQuery = FindPackagesQuery;
13114
13115
  exports.FlowAccessor = FlowAccessor;
13115
13116
  exports.FlowApiResponse = FlowApiResponse;
13116
13117
  exports.FlowEditableProperties = FlowEditableProperties;
@@ -13155,6 +13156,7 @@ exports.IntegrationLevelFieldMappingAccessor = IntegrationLevelFieldMappingAcces
13155
13156
  exports.IntegrationLevelFieldMappingsListAccessor = IntegrationLevelFieldMappingsListAccessor;
13156
13157
  exports.IntegrationLevelFlowAccessor = IntegrationLevelFlowAccessor;
13157
13158
  exports.IntegrationLevelFlowsListAccessor = IntegrationLevelFlowsListAccessor;
13159
+ exports.IntegrationLevelMembraneInterfaceSelectorQuery = IntegrationLevelMembraneInterfaceSelectorQuery;
13158
13160
  exports.IntegrationsAccessor = IntegrationsAccessor;
13159
13161
  exports.InternalError = InternalError;
13160
13162
  exports.InvalidLocatorError = InvalidLocatorError;
@@ -13174,17 +13176,20 @@ exports.NotFoundError = NotFoundError;
13174
13176
  exports.OAUTH1_CONFIG_SCHEMA = OAUTH1_CONFIG_SCHEMA;
13175
13177
  exports.OAUTH_CONFIG_SCHEMA = OAUTH_CONFIG_SCHEMA;
13176
13178
  exports.PARALLEL_EXECUTION_LIMITS = PARALLEL_EXECUTION_LIMITS;
13179
+ exports.PackageAccessor = PackageAccessor;
13180
+ exports.PackageApiResponse = PackageApiResponse;
13181
+ exports.PackageCalculatedProperties = PackageCalculatedProperties;
13182
+ exports.PackageEditableProperties = PackageEditableProperties;
13183
+ exports.PackageElement = PackageElement;
13184
+ exports.PackageElementApi = PackageElementApi;
13185
+ exports.PackagesAccessor = PackagesAccessor;
13177
13186
  exports.PaginationQuery = PaginationQuery;
13178
13187
  exports.PaginationResponse = PaginationResponse;
13179
13188
  exports.RATE_LIMITS = RATE_LIMITS;
13180
13189
  exports.RateLimitExceededError = RateLimitExceededError;
13181
13190
  exports.ResetFlowInstanceOptions = ResetFlowInstanceOptions;
13191
+ exports.RunActionRequest = RunActionRequest;
13182
13192
  exports.ScenarioAccessor = ScenarioAccessor;
13183
- exports.ScenarioApiResponse = ScenarioApiResponse;
13184
- exports.ScenarioCalculatedProperties = ScenarioCalculatedProperties;
13185
- exports.ScenarioEditableProperties = ScenarioEditableProperties;
13186
- exports.ScenarioElement = ScenarioElement;
13187
- exports.ScenarioElementApi = ScenarioElementApi;
13188
13193
  exports.ScenarioTemplate = ScenarioTemplate;
13189
13194
  exports.ScenarioTemplateElements = ScenarioTemplateElements;
13190
13195
  exports.ScenariosAccessor = ScenariosAccessor;