@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
@@ -3383,7 +3383,7 @@ exports.WorkspaceElementType = void 0;
3383
3383
  WorkspaceElementType["FlowInstance"] = "flow-instance";
3384
3384
  WorkspaceElementType["FlowRun"] = "flow-run";
3385
3385
  WorkspaceElementType["Action"] = "action";
3386
- WorkspaceElementType["Scenario"] = "scenario";
3386
+ WorkspaceElementType["Package"] = "package";
3387
3387
  WorkspaceElementType["ActionInstance"] = "action-instance";
3388
3388
  WorkspaceElementType["Connection"] = "connection";
3389
3389
  WorkspaceElementType["FieldMapping"] = "field-mapping";
@@ -3456,6 +3456,11 @@ const BaseIntegrationLevelMembraneInterfaceEditableProperties = BaseMembraneInte
3456
3456
  const BaseIntegrationLevelMembraneInterfaceReadOnlyProperties = BaseMembraneInterfaceReadOnlyProperties.extend({
3457
3457
  isCustomized: zod.z.boolean().optional(),
3458
3458
  });
3459
+ const IntegrationLevelMembraneInterfaceSelectorQuery = zod.z.object({
3460
+ integrationKey: zod.z.string().optional(),
3461
+ connectionId: zod.z.string().optional(),
3462
+ instanceKey: zod.z.string().optional(),
3463
+ });
3459
3464
  const BaseIntegrationLevelMembraneInterface = BaseMembraneInterface.merge(BaseIntegrationLevelMembraneInterfaceEditableProperties).merge(BaseIntegrationLevelMembraneInterfaceReadOnlyProperties);
3460
3465
 
3461
3466
  function mergeWithFormulas(a, b) {
@@ -3623,17 +3628,34 @@ const ACTIONS = {
3623
3628
  },
3624
3629
  };
3625
3630
 
3631
+ exports.ActionDependencyType = void 0;
3632
+ (function (ActionDependencyType) {
3633
+ ActionDependencyType["FieldMapping"] = "FieldMapping";
3634
+ ActionDependencyType["DataSource"] = "DataSource";
3635
+ })(exports.ActionDependencyType || (exports.ActionDependencyType = {}));
3636
+ const ActionDependency = zod.z.object({
3637
+ type: zod.z.enum(exports.ActionDependencyType),
3638
+ key: zod.z.string(),
3639
+ element: zod.z.any().optional(),
3640
+ });
3626
3641
  const ActionEditableProperties = BaseIntegrationLevelMembraneInterfaceEditableProperties.extend({
3627
3642
  integrationId: zod.z.string().optional(),
3643
+ connectionId: zod.z.string().optional(),
3628
3644
  parentId: zod.z.string().optional(),
3645
+ instanceKey: zod.z.string().optional(),
3629
3646
  inputSchema: DataSchema.optional(),
3630
3647
  type: zod.z.enum(exports.ActionType).optional(),
3631
3648
  config: zod.z.any().optional(),
3632
3649
  outputMapping: zod.z.any().optional(),
3633
3650
  customOutputSchema: DataSchema.optional(),
3634
3651
  });
3635
- const ActionReadOnlyProperties = BaseIntegrationLevelMembraneInterfaceReadOnlyProperties;
3652
+ const ActionReadOnlyProperties = BaseIntegrationLevelMembraneInterfaceReadOnlyProperties.extend({
3653
+ universalParentId: zod.z.string().optional(),
3654
+ userId: zod.z.string().optional(),
3655
+ outputSchema: zod.z.any().optional(),
3656
+ });
3636
3657
  const BaseAction = BaseMembraneInterface.merge(ActionEditableProperties).merge(ActionReadOnlyProperties);
3658
+ const BaseActionInstance = BaseAction;
3637
3659
 
3638
3660
  const ConnectionRequest = zod.z.object({
3639
3661
  path: zod.z.any(),
@@ -8885,23 +8907,23 @@ exports.IntegrationElementType = void 0;
8885
8907
  IntegrationElementType["EXTERNAL_EVENT"] = "external-event";
8886
8908
  })(exports.IntegrationElementType || (exports.IntegrationElementType = {}));
8887
8909
 
8888
- const ScenarioElement = zod.z.object({
8910
+ const PackageElement = zod.z.object({
8889
8911
  id: zod.z.string(),
8890
8912
  type: zod.z.enum(exports.IntegrationElementType),
8891
8913
  element: zod.z.any().optional(),
8892
8914
  });
8893
- const ScenarioEditableProperties = BaseMembraneInterfaceEditableProperties.extend({
8915
+ const PackageEditableProperties = BaseMembraneInterfaceEditableProperties.extend({
8894
8916
  scenarioTemplateId: zod.z.string().optional(),
8895
- elements: zod.z.array(ScenarioElement).optional(),
8917
+ elements: zod.z.array(PackageElement).optional(),
8896
8918
  integrationId: zod.z.string().optional(),
8897
8919
  parentId: zod.z.string().optional(),
8898
8920
  });
8899
- const ScenarioCalculatedProperties = zod.z.object({
8921
+ const PackageCalculatedProperties = zod.z.object({
8900
8922
  key: zod.z.string(),
8901
8923
  name: zod.z.string(),
8902
8924
  isCustomized: zod.z.boolean().optional(),
8903
8925
  });
8904
- const BaseScenario = BaseMembraneInterface.merge(ScenarioEditableProperties).merge(ScenarioCalculatedProperties);
8926
+ const BasePackage = BaseMembraneInterface.merge(PackageEditableProperties).merge(PackageCalculatedProperties);
8905
8927
 
8906
8928
  exports.ScreenType = void 0;
8907
8929
  (function (ScreenType) {
@@ -9031,27 +9053,6 @@ const updateFlowInstanceSchema = zod.z.object({
9031
9053
  .optional(),
9032
9054
  });
9033
9055
 
9034
- exports.ActionDependencyType = void 0;
9035
- (function (ActionDependencyType) {
9036
- ActionDependencyType["FieldMapping"] = "FieldMapping";
9037
- ActionDependencyType["DataSource"] = "DataSource";
9038
- })(exports.ActionDependencyType || (exports.ActionDependencyType = {}));
9039
- const ActionDependency = zod.z.object({
9040
- type: zod.z.enum(exports.ActionDependencyType),
9041
- key: zod.z.string(),
9042
- element: zod.z.any().optional(),
9043
- });
9044
- const BaseActionInstance = BaseMembraneInterface.extend({
9045
- parentId: zod.z.string().optional(),
9046
- universalParentId: zod.z.string().optional(),
9047
- userId: zod.z.string(),
9048
- instanceKey: zod.z.string().optional(),
9049
- type: zod.z.enum(exports.ActionType).optional(),
9050
- inputSchema: zod.z.any().optional(),
9051
- config: zod.z.any().optional(),
9052
- outputSchema: zod.z.any().optional(),
9053
- });
9054
-
9055
9056
  const BaseFieldMappingInstance = BaseMembraneInterface.extend({
9056
9057
  userId: zod.z.string(),
9057
9058
  revision: zod.z.string(),
@@ -9323,6 +9324,8 @@ class PaginationResponse {
9323
9324
 
9324
9325
  const ActionApiResponse = BaseAction.extend({
9325
9326
  integration: BaseIntegration.optional(),
9327
+ user: BaseCustomer.optional(),
9328
+ parent: BaseAction.optional(),
9326
9329
  appliedToIntegrations: AppliedToIntegrations(BaseAction).optional(),
9327
9330
  defaultOutputSchema: DataSchema.optional(),
9328
9331
  transformedOutputSchema: DataSchema.optional(),
@@ -9332,41 +9335,27 @@ const ActionApiResponse = BaseAction.extend({
9332
9335
  const FindActionsQuery = PaginationQuery.extend({
9333
9336
  integrationId: zod.z.string().optional(),
9334
9337
  parentId: zod.z.string().optional(),
9338
+ universalParentId: zod.z.string().optional(),
9335
9339
  integrationKey: zod.z.string().optional(),
9336
9340
  search: zod.z.string().optional(),
9337
9341
  includeArchived: zodBooleanCoercion().optional(),
9342
+ userId: zod.z.string().optional(),
9343
+ connectionId: zod.z.string().optional(),
9338
9344
  });
9339
9345
  const CreateActionRequest = ActionEditableProperties;
9340
9346
  const UpdateActionRequest = CreateActionRequest.extend({}).partial();
9347
+ const CreateActionInstanceRequest = CreateActionRequest;
9348
+ const UpdateActionInstanceRequest = UpdateActionRequest;
9349
+ const RunActionRequest = zod.z.object({
9350
+ input: zod.z.any().optional(),
9351
+ });
9341
9352
  const ActionRunResponse = zod.z.object({
9342
9353
  output: zod.z.any().optional(),
9343
9354
  logs: zod.z.array(zod.z.any()).optional(),
9344
9355
  });
9345
-
9346
- const ActionInstanceApiResponse = BaseActionInstance.extend({
9347
- user: BaseCustomer.optional(),
9348
- parent: BaseAction.optional(),
9349
- });
9350
- const ListActionInstancesForConnectionQuery = zod.z
9351
- .object({
9352
- parentId: zod.z.string().optional(),
9353
- universalParentId: zod.z.string().optional(),
9354
- })
9355
- .merge(PaginationQuery);
9356
- const FindActionInstancesQuery = ListActionInstancesForConnectionQuery.extend({
9357
- integrationKey: zod.z.string().optional(),
9358
- integrationId: zod.z.string().optional(),
9359
- userId: zod.z.string().optional(),
9360
- connectionId: zod.z.string().optional(),
9361
- });
9362
- const CreateActionInstanceRequest = zod.z.object({
9363
- parentId: zod.z.string(),
9364
- connectionId: zod.z.string(),
9365
- config: zod.z.any().optional(),
9366
- });
9367
- const UpdateActionInstanceRequest = zod.z.object({
9368
- config: zod.z.any().optional(),
9369
- });
9356
+ const ActionInstanceApiResponse = ActionApiResponse;
9357
+ const ListActionInstancesForConnectionQuery = FindActionsQuery;
9358
+ const FindActionInstancesQuery = FindActionsQuery;
9370
9359
 
9371
9360
  const ActionRunLogRecordApiResponse = BaseActionRunLogRecord.extend({
9372
9361
  action: BaseAction.optional(),
@@ -9618,12 +9607,12 @@ const IntegrationApiResponse = BaseIntegration.extend({
9618
9607
  parametersSchema: DataSchema.optional(),
9619
9608
  });
9620
9609
 
9621
- const ScenarioElementApi = zod.z.object({
9610
+ const PackageElementApi = zod.z.object({
9622
9611
  id: zod.z.string(),
9623
9612
  type: zod.z.enum(exports.IntegrationElementType),
9624
9613
  element: zod.z.any().optional(),
9625
9614
  });
9626
- const FindScenariosQuery = zod.z
9615
+ const FindPackagesQuery = zod.z
9627
9616
  .object({
9628
9617
  integrationId: zod.z.string().optional(),
9629
9618
  integrationKey: zod.z.string().optional(),
@@ -9632,8 +9621,8 @@ const FindScenariosQuery = zod.z
9632
9621
  .extend(SearchQuery.shape)
9633
9622
  .extend(PaginationQuery.shape)
9634
9623
  .extend(IncludeArchivedQuery.shape);
9635
- const ScenarioApiResponse = BaseScenario.extend({
9636
- appliedToIntegrations: AppliedToIntegrations(BaseScenario).optional(),
9624
+ const PackageApiResponse = BasePackage.extend({
9625
+ appliedToIntegrations: AppliedToIntegrations(BasePackage).optional(),
9637
9626
  });
9638
9627
 
9639
9628
  const ScreenApiResponse = BaseScreen;
@@ -9914,14 +9903,14 @@ const WorkspaceElementSpecs = {
9914
9903
  name: 'Connection',
9915
9904
  namePlural: 'Connections',
9916
9905
  },
9917
- [exports.WorkspaceElementType.Scenario]: {
9918
- type: exports.WorkspaceElementType.Scenario,
9919
- apiPath: 'scenarios',
9920
- name: 'Scenario',
9921
- namePlural: 'Scenarios',
9922
- editablePropertiesSchema: ScenarioEditableProperties,
9923
- apiResponseSchema: ScenarioApiResponse,
9924
- findQuerySchema: FindScenariosQuery,
9906
+ [exports.WorkspaceElementType.Package]: {
9907
+ type: exports.WorkspaceElementType.Package,
9908
+ apiPath: 'packages',
9909
+ name: 'Package',
9910
+ namePlural: 'Packages',
9911
+ editablePropertiesSchema: PackageEditableProperties,
9912
+ apiResponseSchema: PackageApiResponse,
9913
+ findQuerySchema: FindPackagesQuery,
9925
9914
  isMembraneInterface: true,
9926
9915
  isIntegrationLevel: true,
9927
9916
  },
@@ -9965,6 +9954,7 @@ const WorkspaceElementSpecs = {
9965
9954
  updateSchema: updateFlowInstanceSchema,
9966
9955
  name: 'Flow',
9967
9956
  namePlural: 'Flows',
9957
+ parentFieldKey: 'flowId',
9968
9958
  isMembraneInterface: true,
9969
9959
  },
9970
9960
  [exports.WorkspaceElementType.FlowRun]: {
@@ -9987,6 +9977,7 @@ const WorkspaceElementSpecs = {
9987
9977
  apiPath: 'field-mapping-instances',
9988
9978
  name: 'Field Mapping Instance',
9989
9979
  namePlural: 'Field Mapping Instances',
9980
+ parentFieldKey: 'fieldMappingId',
9990
9981
  isMembraneInterface: true,
9991
9982
  },
9992
9983
  [exports.WorkspaceElementType.DataCollection]: {
@@ -10009,6 +10000,7 @@ const WorkspaceElementSpecs = {
10009
10000
  apiPath: 'data-source-instances',
10010
10001
  name: 'Data Source Instance',
10011
10002
  namePlural: 'Data Source Instances',
10003
+ parentFieldKey: 'dataSourceId',
10012
10004
  isMembraneInterface: true,
10013
10005
  },
10014
10006
  [exports.WorkspaceElementType.DataLinkTable]: {
@@ -10023,6 +10015,7 @@ const WorkspaceElementSpecs = {
10023
10015
  apiPath: 'data-link-table-instances',
10024
10016
  name: 'Data Link Table Instance',
10025
10017
  namePlural: 'Data Link Table Instances',
10018
+ parentFieldKey: 'dataLinkTableId',
10026
10019
  isMembraneInterface: true,
10027
10020
  },
10028
10021
  [exports.WorkspaceElementType.AppEventType]: {
@@ -10057,6 +10050,7 @@ const WorkspaceElementSpecs = {
10057
10050
  apiPath: 'app-data-schema-instances',
10058
10051
  name: 'App Data Schema Instance',
10059
10052
  namePlural: 'App Data Schema Instances',
10053
+ parentFieldKey: 'appDataSchemaId',
10060
10054
  isMembraneInterface: true,
10061
10055
  },
10062
10056
  [exports.WorkspaceElementType.ExternalEventSubscription]: {
@@ -10698,6 +10692,9 @@ exports.WebhookTypeEnum = void 0;
10698
10692
  WebhookTypeEnum["USER_INVITED_TO_ORG"] = "user-invited-to-org";
10699
10693
  WebhookTypeEnum["ORG_ACCESS_REQUESTED"] = "org-access-requested";
10700
10694
  WebhookTypeEnum["ORG_CREATED"] = "org-created";
10695
+ WebhookTypeEnum["TASK_CREATED"] = "task-created";
10696
+ WebhookTypeEnum["TASK_UPDATED"] = "task-updated";
10697
+ WebhookTypeEnum["TASK_ACTIVITY_CREATED"] = "task-activity-created";
10701
10698
  })(exports.WebhookTypeEnum || (exports.WebhookTypeEnum = {}));
10702
10699
 
10703
10700
  exports.AlertStatus = void 0;
@@ -10713,6 +10710,8 @@ exports.AlertSeverity = void 0;
10713
10710
  exports.AlertType = void 0;
10714
10711
  (function (AlertType) {
10715
10712
  AlertType["externalEventsPerCustomerPerDay"] = "externalEventsPerCustomerPerDay";
10713
+ AlertType["totalUsagePerDay"] = "totalUsagePerDay";
10714
+ AlertType["totalUsagePer30Days"] = "totalUsagePer30Days";
10716
10715
  })(exports.AlertType || (exports.AlertType = {}));
10717
10716
 
10718
10717
  class ElementAccessor {
@@ -12156,20 +12155,22 @@ class IntegrationAccessor extends ElementAccessor {
12156
12155
  }
12157
12156
  }
12158
12157
 
12159
- class ScenariosAccessor extends ElementListAccessor {
12158
+ class PackagesAccessor extends ElementListAccessor {
12160
12159
  constructor(client) {
12161
- super(client, 'scenarios');
12160
+ super(client, 'packages');
12162
12161
  }
12163
12162
  }
12164
- class ScenarioAccessor extends ElementAccessor {
12163
+ class PackageAccessor extends ElementAccessor {
12165
12164
  constructor(client, selector) {
12166
12165
  super({
12167
12166
  client,
12168
12167
  selector,
12169
- path: 'scenario',
12168
+ path: 'package',
12170
12169
  });
12171
12170
  }
12172
12171
  }
12172
+ const ScenariosAccessor = PackagesAccessor;
12173
+ const ScenarioAccessor = PackageAccessor;
12173
12174
 
12174
12175
  class ScreensAccessor extends ElementListAccessor {
12175
12176
  constructor(client) {
@@ -12679,11 +12680,11 @@ class MembraneClient extends MembraneApiClient {
12679
12680
  get customers() {
12680
12681
  return new CustomersAccessor(this);
12681
12682
  }
12682
- scenario(selector) {
12683
- return new ScenarioAccessor(this, selector);
12683
+ package(selector) {
12684
+ return new PackageAccessor(this, selector);
12684
12685
  }
12685
- get scenarios() {
12686
- return new ScenariosAccessor(this);
12686
+ get packages() {
12687
+ return new PackagesAccessor(this);
12687
12688
  }
12688
12689
  async createEventSource(uri, queryParams) {
12689
12690
  return super.createEventSource(uri, queryParams);
@@ -12757,7 +12758,7 @@ exports.BaseIntegrationLevelMembraneInterfaceReadOnlyProperties = BaseIntegratio
12757
12758
  exports.BaseMembraneInterface = BaseMembraneInterface;
12758
12759
  exports.BaseMembraneInterfaceEditableProperties = BaseMembraneInterfaceEditableProperties;
12759
12760
  exports.BaseMembraneInterfaceReadOnlyProperties = BaseMembraneInterfaceReadOnlyProperties;
12760
- exports.BaseScenario = BaseScenario;
12761
+ exports.BasePackage = BasePackage;
12761
12762
  exports.BaseScreen = BaseScreen;
12762
12763
  exports.BaseWorkspaceElement = BaseWorkspaceElement;
12763
12764
  exports.CONNECTOR_AUTH_TYPES = CONNECTOR_AUTH_TYPES;
@@ -12919,7 +12920,7 @@ exports.FindFlowRunsQuery = FindFlowRunsQuery;
12919
12920
  exports.FindFlowRunsResponse = FindFlowRunsResponse;
12920
12921
  exports.FindFlowsQuery = FindFlowsQuery;
12921
12922
  exports.FindIntegrationsQuery = FindIntegrationsQuery;
12922
- exports.FindScenariosQuery = FindScenariosQuery;
12923
+ exports.FindPackagesQuery = FindPackagesQuery;
12923
12924
  exports.FlowAccessor = FlowAccessor;
12924
12925
  exports.FlowApiResponse = FlowApiResponse;
12925
12926
  exports.FlowEditableProperties = FlowEditableProperties;
@@ -12964,6 +12965,7 @@ exports.IntegrationLevelFieldMappingAccessor = IntegrationLevelFieldMappingAcces
12964
12965
  exports.IntegrationLevelFieldMappingsListAccessor = IntegrationLevelFieldMappingsListAccessor;
12965
12966
  exports.IntegrationLevelFlowAccessor = IntegrationLevelFlowAccessor;
12966
12967
  exports.IntegrationLevelFlowsListAccessor = IntegrationLevelFlowsListAccessor;
12968
+ exports.IntegrationLevelMembraneInterfaceSelectorQuery = IntegrationLevelMembraneInterfaceSelectorQuery;
12967
12969
  exports.IntegrationsAccessor = IntegrationsAccessor;
12968
12970
  exports.InternalError = InternalError;
12969
12971
  exports.InvalidLocatorError = InvalidLocatorError;
@@ -12982,17 +12984,20 @@ exports.NotFoundError = NotFoundError;
12982
12984
  exports.OAUTH1_CONFIG_SCHEMA = OAUTH1_CONFIG_SCHEMA;
12983
12985
  exports.OAUTH_CONFIG_SCHEMA = OAUTH_CONFIG_SCHEMA;
12984
12986
  exports.PARALLEL_EXECUTION_LIMITS = PARALLEL_EXECUTION_LIMITS;
12987
+ exports.PackageAccessor = PackageAccessor;
12988
+ exports.PackageApiResponse = PackageApiResponse;
12989
+ exports.PackageCalculatedProperties = PackageCalculatedProperties;
12990
+ exports.PackageEditableProperties = PackageEditableProperties;
12991
+ exports.PackageElement = PackageElement;
12992
+ exports.PackageElementApi = PackageElementApi;
12993
+ exports.PackagesAccessor = PackagesAccessor;
12985
12994
  exports.PaginationQuery = PaginationQuery;
12986
12995
  exports.PaginationResponse = PaginationResponse;
12987
12996
  exports.RATE_LIMITS = RATE_LIMITS;
12988
12997
  exports.RateLimitExceededError = RateLimitExceededError;
12989
12998
  exports.ResetFlowInstanceOptions = ResetFlowInstanceOptions;
12999
+ exports.RunActionRequest = RunActionRequest;
12990
13000
  exports.ScenarioAccessor = ScenarioAccessor;
12991
- exports.ScenarioApiResponse = ScenarioApiResponse;
12992
- exports.ScenarioCalculatedProperties = ScenarioCalculatedProperties;
12993
- exports.ScenarioEditableProperties = ScenarioEditableProperties;
12994
- exports.ScenarioElement = ScenarioElement;
12995
- exports.ScenarioElementApi = ScenarioElementApi;
12996
13001
  exports.ScenarioTemplate = ScenarioTemplate;
12997
13002
  exports.ScenarioTemplateElements = ScenarioTemplateElements;
12998
13003
  exports.ScenariosAccessor = ScenariosAccessor;