@membranehq/sdk 0.9.6 → 0.9.8

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.
@@ -3908,16 +3908,22 @@ const ConnectorAuthMethodTypes = {
3908
3908
  },
3909
3909
  getCredentialsFromAccessTokenResponse: {
3910
3910
  authTypes: ['oauth2'],
3911
- supportedImplementationTypes: [exports.ConnectorMethodImplementationType.javascript],
3911
+ supportedImplementationTypes: [
3912
+ exports.ConnectorMethodImplementationType.mapping,
3913
+ exports.ConnectorMethodImplementationType.javascript,
3914
+ ],
3912
3915
  isRequired: false,
3913
3916
  },
3914
3917
  getCredentialsFromRefreshTokenResponse: {
3915
3918
  authTypes: ['oauth2'],
3916
- supportedImplementationTypes: [exports.ConnectorMethodImplementationType.javascript],
3919
+ supportedImplementationTypes: [
3920
+ exports.ConnectorMethodImplementationType.mapping,
3921
+ exports.ConnectorMethodImplementationType.javascript,
3922
+ ],
3917
3923
  isRequired: false,
3918
3924
  },
3919
3925
  getCredentialsFromConnectionParameters: {
3920
- authTypes: ['client-credentials'],
3926
+ authTypes: ['client-credentials', 'oauth2'],
3921
3927
  getInputSchema: getDefaultAuthInputSchema,
3922
3928
  getOutputSchema: ({ connectorSpec, authOptionKey }) => {
3923
3929
  var _a;
@@ -4157,6 +4163,97 @@ const ConnectorOperationMethodImplementationTypes = [
4157
4163
  exports.ConnectorMethodImplementationType.javascript,
4158
4164
  ];
4159
4165
 
4166
+ exports.FunctionType = void 0;
4167
+ (function (FunctionType) {
4168
+ FunctionType["mapping"] = "mapping";
4169
+ FunctionType["operationMapping"] = "operation-mapping";
4170
+ FunctionType["restApiMapping"] = "rest-api-mapping";
4171
+ FunctionType["graphqlApiMapping"] = "graphql-api-mapping";
4172
+ FunctionType["javascript"] = "javascript";
4173
+ })(exports.FunctionType || (exports.FunctionType = {}));
4174
+ const BaseFunctionDefinition = z.z.object({
4175
+ type: z.z.enum([
4176
+ exports.FunctionType.mapping,
4177
+ exports.FunctionType.operationMapping,
4178
+ exports.FunctionType.restApiMapping,
4179
+ exports.FunctionType.graphqlApiMapping,
4180
+ exports.FunctionType.javascript,
4181
+ ]),
4182
+ });
4183
+ const GenericFunctionDefinition = z.z
4184
+ .object({
4185
+ type: z.z.enum(['mapping', 'operation-mapping', 'rest-api-mapping', 'graphql-api-mapping', 'javascript']),
4186
+ })
4187
+ .loose();
4188
+
4189
+ const GraphQLFieldMappingSchema = z.z.lazy(() => z.z.object({
4190
+ field: z.z.string(),
4191
+ args: z.z.record(z.z.string(), z.z.any()).optional(),
4192
+ subFields: z.z.array(GraphQLFieldMappingSchema).optional(),
4193
+ }));
4194
+ const GraphQLApiMappingSchema = z.z.object({
4195
+ path: z.z.string(),
4196
+ operationType: z.z.enum(['query', 'mutation']),
4197
+ requestMapping: z.z.array(GraphQLFieldMappingSchema),
4198
+ responseMapping: z.z.any().optional(),
4199
+ });
4200
+ const GraphqlApiMappingFunction = z.z.object({
4201
+ type: z.z.literal(exports.FunctionType.graphqlApiMapping),
4202
+ mapping: GraphQLApiMappingSchema,
4203
+ });
4204
+
4205
+ const JavascriptFunction = z.z.object({
4206
+ type: z.z.literal(exports.FunctionType.javascript),
4207
+ code: z.z.string(),
4208
+ });
4209
+
4210
+ const MappingSchema = z.z.any();
4211
+ const MappingFunction = z.z.object({
4212
+ type: z.z.literal(exports.FunctionType.mapping),
4213
+ mapping: MappingSchema,
4214
+ });
4215
+
4216
+ const OperationMappingSchema = z.z.object({
4217
+ operationKey: z.z.string(),
4218
+ inputMapping: z.z.any().optional(),
4219
+ outputMapping: z.z.any().optional(),
4220
+ });
4221
+ const OperationMappingFunction = z.z.object({
4222
+ type: z.z.literal(exports.FunctionType.operationMapping),
4223
+ mapping: OperationMappingSchema,
4224
+ });
4225
+
4226
+ const RequestMappingSchema = z.z.object({
4227
+ pathParameters: z.z.any().optional(),
4228
+ query: z.z.any().optional(),
4229
+ data: z.z.any().optional(),
4230
+ headers: z.z.any().optional(),
4231
+ });
4232
+ const RestApiMappingSchema = z.z.object({
4233
+ path: z.z.string(),
4234
+ method: z.z.string(),
4235
+ requestMapping: RequestMappingSchema,
4236
+ responseMapping: z.z.any().optional(),
4237
+ });
4238
+ const OpenapiMappingSchema = z.z.object({
4239
+ path: z.z.string(),
4240
+ method: z.z.string(),
4241
+ requestMapping: RequestMappingSchema,
4242
+ responseMapping: z.z.any().optional(),
4243
+ });
4244
+ const RestApiMappingFunction = z.z.object({
4245
+ type: z.z.literal(exports.FunctionType.restApiMapping),
4246
+ mapping: RestApiMappingSchema,
4247
+ });
4248
+
4249
+ const FunctionDefinition = z.z.union([
4250
+ MappingFunction,
4251
+ OperationMappingFunction,
4252
+ RestApiMappingFunction,
4253
+ GraphqlApiMappingFunction,
4254
+ JavascriptFunction,
4255
+ ]);
4256
+
4160
4257
  const CONNECTOR_VERSION_DEVELOPMENT = 'dev';
4161
4258
  const CONNECTOR_VERSION_LATEST = 'latest';
4162
4259
  const CONNECTOR_CATEGORIES = [
@@ -4217,7 +4314,40 @@ exports.ConnectorStatus = void 0;
4217
4314
  ConnectorStatus["beta"] = "beta";
4218
4315
  ConnectorStatus["planned"] = "planned";
4219
4316
  })(exports.ConnectorStatus || (exports.ConnectorStatus = {}));
4220
- const ConnectorVersionData = z.z.object({
4317
+ const ConnectorAuthWithFunctions = z.z.object({
4318
+ type: z.z
4319
+ .enum(['integration-app-token', 'membrane-token', 'oauth2', 'oauth1', 'client-credentials', 'proxy'])
4320
+ .optional(),
4321
+ customCredentialsSchema: DataSchema.optional(),
4322
+ ui: z.z
4323
+ .object({
4324
+ schema: DataSchema.optional(),
4325
+ description: z.z.string().optional(),
4326
+ helpUri: z.z.string().optional(),
4327
+ })
4328
+ .optional(),
4329
+ getCredentialsFromConnectionParameters: GenericFunctionDefinition.optional(),
4330
+ refreshCredentials: GenericFunctionDefinition.optional(),
4331
+ makeApiClient: GenericFunctionDefinition.optional(),
4332
+ getOAuthConfig: GenericFunctionDefinition.optional(),
4333
+ getTokenData: GenericFunctionDefinition.optional(),
4334
+ getCredentialsFromAccessTokenResponse: GenericFunctionDefinition.optional(),
4335
+ getCredentialsFromRefreshTokenResponse: GenericFunctionDefinition.optional(),
4336
+ proxyKey: z.z.string().optional(),
4337
+ });
4338
+ const ConnectorOption = ConnectorAuthWithFunctions.extend({
4339
+ title: z.z.string().optional(),
4340
+ description: z.z.string().optional(),
4341
+ enabled: z.z.any().optional(),
4342
+ });
4343
+ const ConnectorOptions = z.z.record(z.z.string(), ConnectorOption);
4344
+ const WritableConnectorVersionData = ConnectorAuthWithFunctions.extend({
4345
+ parametersSchema: DataSchema.optional(),
4346
+ test: GenericFunctionDefinition.optional(),
4347
+ options: ConnectorOptions.optional(),
4348
+ });
4349
+ const ConnectorVersionData = z.z
4350
+ .object({
4221
4351
  baseUri: z.z.string(),
4222
4352
  revision: z.z.string().optional(),
4223
4353
  dataCollectionsCount: z.z.number().optional(),
@@ -4230,12 +4360,28 @@ const ConnectorVersionData = z.z.object({
4230
4360
  hasData: z.z.boolean().optional(),
4231
4361
  isReadOnly: z.z.boolean().optional(),
4232
4362
  version: z.z.string(),
4233
- });
4363
+ credentialsSchema: DataSchema.optional(),
4364
+ })
4365
+ .extend(WritableConnectorVersionData.shape);
4234
4366
  const ConnectorVersion = ConnectorVersionData.extend({
4235
4367
  id: z.z.string(),
4236
4368
  connectorId: z.z.string(),
4237
4369
  changelog: z.z.string(),
4238
4370
  });
4371
+ const WriteableConnectorFields = z.z
4372
+ .object({
4373
+ key: z.z.string().optional(),
4374
+ name: z.z.string().optional(),
4375
+ logoUri: z.z.string().optional(),
4376
+ appUuid: z.z.string().optional(),
4377
+ categories: z.z.array(z.z.string()).optional(),
4378
+ })
4379
+ .extend(WritableConnectorVersionData.shape);
4380
+ const UpdateConnectorRequest = WriteableConnectorFields;
4381
+ const CreateConnectorRequest = WriteableConnectorFields.extend({
4382
+ name: z.z.string(),
4383
+ uuid: z.z.string().optional(),
4384
+ });
4239
4385
  const BaseConnector = z.z.object({
4240
4386
  id: z.z.string(),
4241
4387
  key: z.z.string(),
@@ -10385,6 +10531,7 @@ function getMembraneElementPath(elementType, elementKey, integrationKey) {
10385
10531
  return `${integrationTypePath}/${integrationKey}/${elementTypePath}/${elementKey}/${MEMBRANE_ELEMENT_CONFIG_FILE_NAME}`;
10386
10532
  }
10387
10533
  function parseMembraneElementPath(relativePath) {
10534
+ const normalizedPath = relativePath.split(/[\\/]/).join('/');
10388
10535
  const typeByApiPath = new Map();
10389
10536
  for (const spec of Object.values(WorkspaceElementSpecs)) {
10390
10537
  typeByApiPath.set(spec.apiPath, spec.type);
@@ -10393,7 +10540,7 @@ function parseMembraneElementPath(relativePath) {
10393
10540
  .map((spec) => spec.apiPath)
10394
10541
  .join('|');
10395
10542
  const universalPattern = new RegExp(`^(?<elementType>${elementTypes})/(?<elementKey>[^/]+)/${MEMBRANE_ELEMENT_CONFIG_FILE_NAME}$`);
10396
- const universalMatch = relativePath.match(universalPattern);
10543
+ const universalMatch = normalizedPath.match(universalPattern);
10397
10544
  if (universalMatch === null || universalMatch === void 0 ? void 0 : universalMatch.groups) {
10398
10545
  const { elementType: elementTypePath, elementKey } = universalMatch.groups;
10399
10546
  const elementType = typeByApiPath.get(elementTypePath);
@@ -10401,8 +10548,12 @@ function parseMembraneElementPath(relativePath) {
10401
10548
  return { type: elementType, key: elementKey };
10402
10549
  }
10403
10550
  }
10404
- const integrationLevelPattern = new RegExp(`^integrations/(?<integrationKey>[^/]+)/(?<elementType>${elementTypes})/(?<elementKey>[^/]+)/${MEMBRANE_ELEMENT_CONFIG_FILE_NAME}$`);
10405
- const integrationLevelMatch = relativePath.match(integrationLevelPattern);
10551
+ const integrationLevelElementTypes = Object.values(WorkspaceElementSpecs)
10552
+ .filter((spec) => spec.isIntegrationLevel)
10553
+ .map((spec) => spec.apiPath)
10554
+ .join('|');
10555
+ const integrationLevelPattern = new RegExp(`^integrations/(?<integrationKey>[^/]+)/(?<elementType>${integrationLevelElementTypes})/(?<elementKey>[^/]+)/${MEMBRANE_ELEMENT_CONFIG_FILE_NAME}$`);
10556
+ const integrationLevelMatch = normalizedPath.match(integrationLevelPattern);
10406
10557
  if (integrationLevelMatch === null || integrationLevelMatch === void 0 ? void 0 : integrationLevelMatch.groups) {
10407
10558
  const { integrationKey, elementType: elementTypePath, elementKey } = integrationLevelMatch.groups;
10408
10559
  const elementType = typeByApiPath.get(elementTypePath);
@@ -12922,9 +13073,15 @@ exports.AgentSessionStatus = void 0;
12922
13073
  AgentSessionStatus["FAILED"] = "failed";
12923
13074
  AgentSessionStatus["CANCELLED"] = "cancelled";
12924
13075
  })(exports.AgentSessionStatus || (exports.AgentSessionStatus = {}));
13076
+ exports.AgentSessionState = void 0;
13077
+ (function (AgentSessionState) {
13078
+ AgentSessionState["BUSY"] = "busy";
13079
+ AgentSessionState["IDLE"] = "idle";
13080
+ })(exports.AgentSessionState || (exports.AgentSessionState = {}));
12925
13081
  const AgentSession = z.z.object({
12926
13082
  id: z.z.string(),
12927
13083
  workspaceId: z.z.string(),
13084
+ userId: z.z.string().optional(),
12928
13085
  workspaceElementType: z.z.enum(exports.WorkspaceElementType),
12929
13086
  workspaceElementId: z.z.string(),
12930
13087
  type: z.z.string(),
@@ -12942,17 +13099,25 @@ const AgentSession = z.z.object({
12942
13099
  logs: z.z.array(z.z.any()).optional(),
12943
13100
  usage: z.z.number().optional(),
12944
13101
  summary: z.z.string().optional(),
13102
+ state: z.z.enum(exports.AgentSessionState).default(exports.AgentSessionState.IDLE),
12945
13103
  });
12946
13104
  const CreateAgentSession = z.z.object({
12947
13105
  workspaceElementType: z.z.enum(exports.WorkspaceElementType).optional(),
12948
13106
  workspaceElementId: z.z.string().min(1).optional(),
12949
13107
  prompt: z.z.string().min(1),
12950
13108
  testCustomerId: z.z.string().optional(),
13109
+ isExternal: z.z.boolean().optional(),
12951
13110
  });
12952
13111
  const AgentSessionInputSchema = z.z.object({
12953
13112
  input: z.z.string().min(1),
12954
13113
  synthetic: z.z.boolean().optional(),
12955
13114
  });
13115
+ const PatchAgentSessionSchema = z.z.object({
13116
+ state: z.z.enum(exports.AgentSessionState).optional(),
13117
+ lastActivityAt: z.z.iso.datetime().optional(),
13118
+ summary: z.z.string().optional(),
13119
+ status: z.z.enum(exports.AgentSessionStatus).optional(),
13120
+ });
12956
13121
 
12957
13122
  const API_VERSIONS = {
12958
13123
  LEGACY: 'legacy',
@@ -13326,6 +13491,7 @@ exports.BaseFieldMappingInstance = BaseFieldMappingInstance;
13326
13491
  exports.BaseFlow = BaseFlow;
13327
13492
  exports.BaseFlowInstance = BaseFlowInstance;
13328
13493
  exports.BaseFlowRun = BaseFlowRun;
13494
+ exports.BaseFunctionDefinition = BaseFunctionDefinition;
13329
13495
  exports.BaseIntegration = BaseIntegration;
13330
13496
  exports.BaseIntegrationLevelMembraneInterface = BaseIntegrationLevelMembraneInterface;
13331
13497
  exports.BaseIntegrationLevelMembraneInterfaceEditableProperties = BaseIntegrationLevelMembraneInterfaceEditableProperties;
@@ -13383,6 +13549,7 @@ exports.ConnectorAuthOAuth1 = ConnectorAuthOAuth1;
13383
13549
  exports.ConnectorAuthOAuth2 = ConnectorAuthOAuth2;
13384
13550
  exports.ConnectorAuthProxy = ConnectorAuthProxy;
13385
13551
  exports.ConnectorAuthSpec = ConnectorAuthSpec;
13552
+ exports.ConnectorAuthWithFunctions = ConnectorAuthWithFunctions;
13386
13553
  exports.ConnectorDataCollectionEventImplementationType = ConnectorDataCollectionEventImplementationType;
13387
13554
  exports.ConnectorDataCollectionMethodKeys = ConnectorDataCollectionMethodKeys;
13388
13555
  exports.ConnectorDataLocationTypes = ConnectorDataLocationTypes;
@@ -13396,6 +13563,8 @@ exports.ConnectorMethodImplementationNotSupported = ConnectorMethodImplementatio
13396
13563
  exports.ConnectorMethodImplementationOperationMapping = ConnectorMethodImplementationOperationMapping;
13397
13564
  exports.ConnectorMethodImplementationRestApiMapping = ConnectorMethodImplementationRestApiMapping;
13398
13565
  exports.ConnectorOperationMethodImplementationTypes = ConnectorOperationMethodImplementationTypes;
13566
+ exports.ConnectorOption = ConnectorOption;
13567
+ exports.ConnectorOptions = ConnectorOptions;
13399
13568
  exports.ConnectorSpec = ConnectorSpec;
13400
13569
  exports.ConnectorStatusValues = ConnectorStatusValues;
13401
13570
  exports.ConnectorUdmCollectionMapping = ConnectorUdmCollectionMapping;
@@ -13408,6 +13577,7 @@ exports.CreateActionInstanceRequest = CreateActionInstanceRequest;
13408
13577
  exports.CreateActionRequest = CreateActionRequest;
13409
13578
  exports.CreateAgentSession = CreateAgentSession;
13410
13579
  exports.CreateConnectionRequest = CreateConnectionRequest;
13580
+ exports.CreateConnectorRequest = CreateConnectorRequest;
13411
13581
  exports.CreateCustomerRequest = CreateCustomerRequest;
13412
13582
  exports.CreateDataLinkTableRequest = CreateDataLinkTableRequest;
13413
13583
  exports.CreateDataSourceInstanceRequest = CreateDataSourceInstanceRequest;
@@ -13564,6 +13734,11 @@ exports.FlowRunsAccessor = FlowRunsAccessor;
13564
13734
  exports.FlowsAccessor = FlowsAccessor;
13565
13735
  exports.Formula = Formula;
13566
13736
  exports.FullPlatformUser = FullPlatformUser;
13737
+ exports.FunctionDefinition = FunctionDefinition;
13738
+ exports.GenericFunctionDefinition = GenericFunctionDefinition;
13739
+ exports.GraphQLApiMappingSchema = GraphQLApiMappingSchema;
13740
+ exports.GraphQLFieldMappingSchema = GraphQLFieldMappingSchema;
13741
+ exports.GraphqlApiMappingFunction = GraphqlApiMappingFunction;
13567
13742
  exports.HTTP_REQUEST_SCHEMA = HTTP_REQUEST_SCHEMA;
13568
13743
  exports.HandyScenarioTemplateElement = HandyScenarioTemplateElement;
13569
13744
  exports.HttpRequestSpec = HttpRequestSpec;
@@ -13588,6 +13763,7 @@ exports.IntegrationLevelMembraneInterfaceSelectorQuery = IntegrationLevelMembran
13588
13763
  exports.IntegrationsAccessor = IntegrationsAccessor;
13589
13764
  exports.InternalError = InternalError;
13590
13765
  exports.InvalidLocatorError = InvalidLocatorError;
13766
+ exports.JavascriptFunction = JavascriptFunction;
13591
13767
  exports.ListActionInstancesForConnectionQuery = ListActionInstancesForConnectionQuery;
13592
13768
  exports.ListDataSourceInstancesForConnectionQuery = ListDataSourceInstancesForConnectionQuery;
13593
13769
  exports.ListExternalEventLogRecordsQuery = ListExternalEventLogRecordsQuery;
@@ -13597,6 +13773,8 @@ exports.ListFlowInstancesForConnectionQuery = ListFlowInstancesForConnectionQuer
13597
13773
  exports.MEMBRANE_ELEMENT_CONFIG_FILE_NAME = MEMBRANE_ELEMENT_CONFIG_FILE_NAME;
13598
13774
  exports.MIN_FULL_SYNC_INTERVAL_SECONDS = MIN_FULL_SYNC_INTERVAL_SECONDS;
13599
13775
  exports.MIN_PULL_UPDATES_INTERVAL_SECONDS = MIN_PULL_UPDATES_INTERVAL_SECONDS;
13776
+ exports.MappingFunction = MappingFunction;
13777
+ exports.MappingSchema = MappingSchema;
13600
13778
  exports.MembraneAgentKey = MembraneAgentKey;
13601
13779
  exports.MembraneAxiosInstance = axios;
13602
13780
  exports.MembraneClient = MembraneClient;
@@ -13606,6 +13784,9 @@ exports.NotAuthenticatedError = NotAuthenticatedError;
13606
13784
  exports.NotFoundError = NotFoundError;
13607
13785
  exports.OAUTH1_CONFIG_SCHEMA = OAUTH1_CONFIG_SCHEMA;
13608
13786
  exports.OAUTH_CONFIG_SCHEMA = OAUTH_CONFIG_SCHEMA;
13787
+ exports.OpenapiMappingSchema = OpenapiMappingSchema;
13788
+ exports.OperationMappingFunction = OperationMappingFunction;
13789
+ exports.OperationMappingSchema = OperationMappingSchema;
13609
13790
  exports.OrgLimits = OrgLimits;
13610
13791
  exports.OrgSchema = OrgSchema;
13611
13792
  exports.OrgWorkspaceSchema = OrgWorkspaceSchema;
@@ -13622,10 +13803,14 @@ exports.PackageExportProperties = PackageExportProperties;
13622
13803
  exports.PackagesAccessor = PackagesAccessor;
13623
13804
  exports.PaginationQuery = PaginationQuery;
13624
13805
  exports.PaginationResponse = PaginationResponse;
13806
+ exports.PatchAgentSessionSchema = PatchAgentSessionSchema;
13625
13807
  exports.PlatformUserSchema = PlatformUserSchema;
13626
13808
  exports.RATE_LIMITS = RATE_LIMITS;
13627
13809
  exports.RateLimitExceededError = RateLimitExceededError;
13810
+ exports.RequestMappingSchema = RequestMappingSchema;
13628
13811
  exports.ResetFlowInstanceOptions = ResetFlowInstanceOptions;
13812
+ exports.RestApiMappingFunction = RestApiMappingFunction;
13813
+ exports.RestApiMappingSchema = RestApiMappingSchema;
13629
13814
  exports.RunActionRequest = RunActionRequest;
13630
13815
  exports.RunFlowApiRequest = RunFlowApiRequest;
13631
13816
  exports.ScenarioAccessor = ScenarioAccessor;
@@ -13643,6 +13828,7 @@ exports.UnitRunError = UnitRunError;
13643
13828
  exports.UpdateActionInstanceRequest = UpdateActionInstanceRequest;
13644
13829
  exports.UpdateActionRequest = UpdateActionRequest;
13645
13830
  exports.UpdateConnectionRequest = UpdateConnectionRequest;
13831
+ exports.UpdateConnectorRequest = UpdateConnectorRequest;
13646
13832
  exports.UpdateCustomerRequest = UpdateCustomerRequest;
13647
13833
  exports.UpdateDataLinkTableRequest = UpdateDataLinkTableRequest;
13648
13834
  exports.UpdateDataSourceInstanceRequest = UpdateDataSourceInstanceRequest;
@@ -13658,6 +13844,8 @@ exports.WORKSPACE_SIZE_LIMITS = WORKSPACE_SIZE_LIMITS;
13658
13844
  exports.WorkspaceElementSpecs = WorkspaceElementSpecs;
13659
13845
  exports.WorkspaceLimitsSchema = WorkspaceLimitsSchema;
13660
13846
  exports.WorkspacePublicKey = WorkspacePublicKey;
13847
+ exports.WritableConnectorVersionData = WritableConnectorVersionData;
13848
+ exports.WriteableConnectorFields = WriteableConnectorFields;
13661
13849
  exports.__resolveValue = __resolveValue;
13662
13850
  exports.addRequiredFieldsToSchema = addRequiredFieldsToSchema;
13663
13851
  exports.addUdmFallbackFields = addUdmFallbackFields;