@membranehq/sdk 0.2.1 → 0.3.0

package/dist/dts/api-client.d.ts

@@ -19,11 +19,11 @@ export declare class IntegrationAppApiClient {
     constructor({ uiUri, apiUri, accessToken, token, fetchToken, fetchCredentials, credentials, }?: IntegrationAppClientOptions);
     setCredentials(credentials: any): Promise<any>;
     getToken(): Promise<string>;
-    get(uri: string, queryParams?: Record<string, any>, options?: AxiosRequestConfig): Promise<any>;
-    post(uri: string, data?: any, options?: AxiosRequestConfig): Promise<any>;
-    put(uri: string, data?: any, options?: AxiosRequestConfig): Promise<any>;
-    patch(uri: string, data?: any, options?: AxiosRequestConfig): Promise<any>;
-    delete(uri: string, data?: any, options?: AxiosRequestConfig): Promise<any>;
+    get<T = any>(uri: string, queryParams?: Record<string, any>, options?: AxiosRequestConfig): Promise<T>;
+    post<T = any>(uri: string, data?: any, options?: AxiosRequestConfig): Promise<T>;
+    put<T = any>(uri: string, data?: any, options?: AxiosRequestConfig): Promise<T>;
+    patch<T = any>(uri: string, data?: any, options?: AxiosRequestConfig): Promise<T>;
+    delete<T = any>(uri: string, data?: any, options?: AxiosRequestConfig): Promise<T>;
     getEmbedUri(page: string, pageParams?: Record<string, any>, options?: {
         embedMode: 'isolated-embed' | 'popup-embed';
     }): Promise<string>;

package/dist/dts/connections/accessors.d.ts

@@ -2,7 +2,7 @@ import { CreateConnectionRequest, FindConnectionsQuery, UpdateConnectionRequest
 import { ElementInstanceListAccessor } from '../accessors';
 import { ConnectionLevelActionAccessor, ConnectionLevelActionsAccessor } from '../actions';
 import { IntegrationAppApiClient } from '../api-client';
-import { DataCollectionCreateRequest, DataCollectionCreateResponse, DataCollectionDeleteRequest, DataCollectionDeleteResponse, DataCollectionFindByIdRequest, DataCollectionFindByIdResponse, DataCollectionListRequest, DataCollectionListResponse, DataCollectionMatchRequest, DataCollectionMatchResponse, DataCollectionSearchRequest, DataCollectionSearchResponse, DataCollectionSpec, DataCollectionUpdateRequest, DataCollectionUpdateResponse, DataDirectoryListRequest, DataDirectoryListResponse } from '../connectors';
+import { DataCollectionCreateRequest, DataCollectionCreateResponse, DataCollectionDeleteRequest, DataCollectionDeleteResponse, DataCollectionFindByIdRequest, DataCollectionFindByIdResponse, DataCollectionListRequest, DataCollectionListResponse, DataCollectionMatchRequest, DataCollectionMatchResponse, DataCollectionSearchRequest, DataCollectionSearchResponse, DataCollectionSpec, DataCollectionUpdateRequest, DataCollectionUpdateResponse } from '../connectors';
 import { OperationRunRequest, OperationRunResponse, OperationSpec } from '../connectors/operations/types';
 import { ConnectionLevelDataSourceAccessor, ConnectionLevelDataSourcesAccessor } from '../data-sources';
 import { ConnectionLevelFieldMappingAccessor, ConnectionLevelFieldMappingsAccessor } from '../field-mappings';
@@ -36,7 +36,6 @@ export declare class ConnectionAccessor {
     get proxy(): ConnectionProxy;
     operation(key: string): ConnectionOperationAccessor;
     dataCollection(key: string, parameters?: Record<string, any>): ConnectionDataCollectionAccessor;
-    dataDirectory(key: string, parameters?: Record<string, any>): ConnectionDataDirectoryAccessor;
     reconnect({ parameters, authOptionKey, connectorParameters, }?: {
         parameters?: any;
         authOptionKey?: string;
@@ -54,14 +53,6 @@ export declare class ConnectionOperationAccessor {
     get(): Promise<OperationSpec>;
     run(request?: OperationRunRequest): Promise<OperationRunResponse>;
 }
-export declare class ConnectionDataDirectoryAccessor {
-    client: IntegrationAppApiClient;
-    connectionAccessor: ConnectionAccessor;
-    key: string;
-    parameters: Record<string, any>;
-    constructor(client: IntegrationAppApiClient, connectionAccessor: ConnectionAccessor, key: string, parameters: Record<string, any>);
-    list(request?: DataDirectoryListRequest): Promise<DataDirectoryListResponse>;
-}
 export declare class ConnectionDataCollectionAccessor {
     client: IntegrationAppApiClient;
     connectionAccessor: ConnectionAccessor;

package/dist/dts/connections/types.d.ts

@@ -1,4 +1,4 @@
-import { ConnectorUiSpec, ConnectorDataUdmSpec, ConnectorDataSpec, ConnectorSpec } from '../connectors/types';
+import { ConnectorUiSpec, ConnectorSpec } from '../connectors/types';
 import { ErrorData } from '../errors';
 import { Integration } from '../integrations/types';
 import { User } from '../users';
@@ -31,8 +31,6 @@ export declare class Connection {
 export interface ConnectionSpec extends ConnectorSpec {
 }
 export type ConnectionUiSpec = ConnectorUiSpec;
-export type ConnectionUdmSpec = ConnectorDataUdmSpec;
-export type ConnectionDataSpec = ConnectorDataSpec;
 export declare class ConnectionSpec {
     constructor(opts: ConnectionSpec);
 }

package/dist/dts/connectors/auth.d.ts

@@ -1,7 +1,7 @@
 import { ConnectorSpec } from './types';
 import { DataSchema } from '../data-schema';
 import { ConnectorMethodImplementation, ConnectorMethodImplementationBase, ConnectorMethodImplementationType } from './methods';
-export declare const CONNECTOR_AUTH_TYPES: readonly ["integration-app-token", "oauth2", "oauth1", "client-credentials", "proxy"];
+export declare const CONNECTOR_AUTH_TYPES: readonly ["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"];
 export type ConnectorAuthType = (typeof CONNECTOR_AUTH_TYPES)[number];
 export type ConnectorAuthSpec = {
     title?: string;
@@ -58,9 +58,12 @@ export interface ConnectorAuthProxy extends ConnectorAuthHandlerBase {
 export interface ConnectorAuthIntegrationAppToken extends ConnectorAuthHandlerBase {
     type: 'integration-app-token';
 }
-export type ConnectorAuth = (ConnectorAuthOAuth2 | ConnectorAuthOAuth1 | ConnectorAuthClientCredentials | ConnectorAuthIntegrationAppToken | ConnectorAuthProxy) & {
+export interface ConnectorAuthMembraneToken extends ConnectorAuthHandlerBase {
+    type: 'membrane-token';
+}
+export type ConnectorAuth = (ConnectorAuthOAuth2 | ConnectorAuthOAuth1 | ConnectorAuthClientCredentials | ConnectorAuthIntegrationAppToken | ConnectorAuthMembraneToken | ConnectorAuthProxy) & {
     options?: {
-        [key: string]: ConnectorAuthOAuth2 | ConnectorAuthOAuth1 | ConnectorAuthClientCredentials | ConnectorAuthIntegrationAppToken | ConnectorAuthProxy;
+        [key: string]: ConnectorAuthOAuth2 | ConnectorAuthOAuth1 | ConnectorAuthClientCredentials | ConnectorAuthIntegrationAppToken | ConnectorAuthMembraneToken | ConnectorAuthProxy;
     };
 };
 export interface ConnectorAuthOAuth2Config {

package/dist/dts/connectors/data-locations/base.d.ts

@@ -1,10 +1,10 @@
-import { DataLocationMixin } from './types';
+import { DataCollectionMixin } from './schemas';
 import { DataSchema } from '../../data-schema';
-export interface ConnectorDataLocationBase {
+export interface ConnectorDataCollectionBase {
     type: 'collection' | 'directory';
     key: string;
     name: string;
     parametersSchema?: DataSchema;
-    extends?: DataLocationMixin[];
+    extends?: DataCollectionMixin[];
     relatedOperationKeys?: string[];
 }

package/dist/dts/connectors/data-locations/collections/events/implementation-types/connector-event.d.ts

@@ -1,10 +1,10 @@
 import { DataSchema } from '../../../../../data-schema';
-import { ConnectorDataLocationMethod } from '../../../methods';
+import { ConnectorDataCollectionMethod } from '../../../methods';
 import { ConnectorDataCollectionEventMethodType } from '../methods';
 export interface ConnectorEventImplementationFields {
     implementationType: 'connector-event';
     stateSchema?: DataSchema;
-    methods: Record<keyof typeof ConnectorEventImplementationType.methods, ConnectorDataLocationMethod>;
+    methods: Record<keyof typeof ConnectorEventImplementationType.methods, ConnectorDataCollectionMethod>;
 }
 export declare const ConnectorEventImplementationType: {
     methods: {

package/dist/dts/connectors/data-locations/collections/events/implementation-types/custom-pull.d.ts

@@ -1,10 +1,10 @@
 import { DataSchema } from '../../../../../data-schema';
-import { ConnectorDataLocationMethod } from '../../../methods';
+import { ConnectorDataCollectionMethod } from '../../../methods';
 import { ConnectorDataCollectionEventMethodType } from '../methods';
 export interface CustomPullEventImplementationFields {
     implementationType: 'custom-pull';
     stateSchema?: DataSchema;
-    methods: Record<keyof typeof CustomPullEventImplementationType.methods, ConnectorDataLocationMethod>;
+    methods: Record<keyof typeof CustomPullEventImplementationType.methods, ConnectorDataCollectionMethod>;
 }
 export declare const CustomPullEventImplementationType: {
     methods: {

package/dist/dts/connectors/data-locations/collections/events/implementation-types/pull-latest-records.d.ts

@@ -1,9 +1,9 @@
 import { DataRecord } from '../../../../../data-collections';
-import { ConnectorDataLocationMethod } from '../../../methods';
+import { ConnectorDataCollectionMethod } from '../../../methods';
 import { ConnectorDataCollectionEventMethodType } from '../methods';
 export interface PullLatestRecordsEventImplementationFields {
     implementationType: 'pull-latest-records';
-    methods: Record<keyof typeof PullLatestRecordsEventImplementationType.methods, ConnectorDataLocationMethod>;
+    methods: Record<keyof typeof PullLatestRecordsEventImplementationType.methods, ConnectorDataCollectionMethod>;
 }
 export interface PullLatestRecordsEventOutput {
     records: DataRecord[];

package/dist/dts/connectors/data-locations/collections/events/implementation-types/webhook.d.ts

@@ -1,12 +1,12 @@
 import { DataSchema } from '../../../../../data-schema';
-import { ConnectorDataLocationMethod } from '../../../methods';
+import { ConnectorDataCollectionMethod } from '../../../methods';
 import { ConnectorDataCollectionEventMethodType } from '../methods';
 export interface WebhookEventImplementationFields {
     implementationType: 'webhook';
     querySchema?: DataSchema;
     dataSchema?: DataSchema;
     stateSchema?: DataSchema;
-    methods: Record<keyof typeof WebhookEventImplementationType.methods, ConnectorDataLocationMethod>;
+    methods: Record<keyof typeof WebhookEventImplementationType.methods, ConnectorDataCollectionMethod>;
 }
 export declare const WebhookEventImplementationType: {
     methods: {

package/dist/dts/connectors/data-locations/collections/index.d.ts

@@ -1,6 +1,6 @@
 import { DataSchema } from '../../../data-schema';
-import { ConnectorDataLocationBase } from '../base';
-import { ConnectorDataLocationMethod } from '../methods';
+import { ConnectorDataCollectionBase } from '../base';
+import { ConnectorDataCollectionMethod } from '../methods';
 import { ConnectorDataCollectionEvent } from './events';
 import { ConnectorDataCollectionMethodType } from './methods/base';
 import { DataCollectionCreateConfigType } from './methods/create';
@@ -33,38 +33,38 @@ export declare const DataLocationTypeCollection: {
     fieldsToApiMapping: ConnectorDataCollectionMethodType<unknown>;
     fieldsToApiCode: ConnectorDataCollectionMethodType<unknown>;
 };
-export interface ConnectorDataCollection extends ConnectorDataLocationBase {
+export interface ConnectorDataCollection extends ConnectorDataCollectionBase {
     type: 'collection';
     fieldsSchema?: DataSchema;
     isHidden?: boolean;
     customFields?: boolean;
-    customFieldsSchema?: ConnectorDataLocationMethod;
-    spec?: ConnectorDataLocationMethod;
-    recordFromFields?: ConnectorDataLocationMethod;
-    fieldsFromApi?: ConnectorDataLocationMethod;
-    recordFromApi?: ConnectorDataLocationMethod;
-    recordFromApiCode?: ConnectorDataLocationMethod;
-    recordFromApiMapping?: ConnectorDataLocationMethod;
-    recordToApi?: ConnectorDataLocationMethod;
-    fieldsToApi?: ConnectorDataLocationMethod;
-    fieldsToApiCode?: ConnectorDataLocationMethod;
-    fieldsToApiMapping?: ConnectorDataLocationMethod;
+    customFieldsSchema?: ConnectorDataCollectionMethod;
+    spec?: ConnectorDataCollectionMethod;
+    recordFromFields?: ConnectorDataCollectionMethod;
+    fieldsFromApi?: ConnectorDataCollectionMethod;
+    recordFromApi?: ConnectorDataCollectionMethod;
+    recordFromApiCode?: ConnectorDataCollectionMethod;
+    recordFromApiMapping?: ConnectorDataCollectionMethod;
+    recordToApi?: ConnectorDataCollectionMethod;
+    fieldsToApi?: ConnectorDataCollectionMethod;
+    fieldsToApiCode?: ConnectorDataCollectionMethod;
+    fieldsToApiMapping?: ConnectorDataCollectionMethod;
     methods?: {
-        list?: ConnectorDataLocationMethod<DataCollectionListConfigType>;
-        findById?: ConnectorDataLocationMethod;
-        match?: ConnectorDataLocationMethod<DataCollectionMatchConfigType>;
-        search?: ConnectorDataLocationMethod;
-        create?: ConnectorDataLocationMethod<DataCollectionCreateConfigType>;
-        update?: ConnectorDataLocationMethod<DataCollectionUpdateConfigType>;
-        delete?: ConnectorDataLocationMethod;
-        find?: ConnectorDataLocationMethod<{
+        list?: ConnectorDataCollectionMethod<DataCollectionListConfigType>;
+        findById?: ConnectorDataCollectionMethod;
+        match?: ConnectorDataCollectionMethod<DataCollectionMatchConfigType>;
+        search?: ConnectorDataCollectionMethod;
+        create?: ConnectorDataCollectionMethod<DataCollectionCreateConfigType>;
+        update?: ConnectorDataCollectionMethod<DataCollectionUpdateConfigType>;
+        delete?: ConnectorDataCollectionMethod;
+        find?: ConnectorDataCollectionMethod<{
             queryFields?: string[];
         }>;
     };
     events?: Partial<Record<'created' | 'updated' | 'deleted', ConnectorDataCollectionEvent>>;
     udm?: Partial<Record<string, {
-        extract?: ConnectorDataLocationMethod;
-        parse?: ConnectorDataLocationMethod;
+        extract?: ConnectorDataCollectionMethod;
+        parse?: ConnectorDataCollectionMethod;
     }>>;
 }
 export declare const ConnectorDataCollectionMethodKeys: Array<keyof typeof DataLocationTypeCollection.methods>;

package/dist/dts/connectors/data-locations/collections/methods/base.d.ts

@@ -1,9 +1,9 @@
 import { ConnectorDataCollection } from '..';
+import { DataCollectionSpec } from '../..';
 import { DataSchema } from '../../../../data-schema';
 import { ConnectorMethodImplementationType } from '../../../methods';
 import { ConnectorSpec } from '../../../types';
-import { ConnectorDataLocationMethod } from '../../methods';
-import { DataCollectionSpec } from '../../types';
+import { ConnectorDataCollectionMethod } from '../../methods';
 export interface ConnectorDataCollectionMethodType<ConfigFields = unknown> {
     name?: string;
     description?: string;
@@ -15,7 +15,7 @@ export interface ConnectorDataCollectionMethodType<ConfigFields = unknown> {
     isDeprecated?: boolean;
 }
 interface ConnectorDataCollectionMethodTypeArgs<ConfigFields = unknown> {
-    method?: ConnectorDataLocationMethod<ConfigFields>;
+    method?: ConnectorDataCollectionMethod<ConfigFields>;
     collectionHandler?: ConnectorDataCollection;
     collectionSpec?: DataCollectionSpec;
     connectorSpec?: ConnectorSpec;

package/dist/dts/connectors/data-locations/index.d.ts

@@ -1,6 +1,5 @@
 export * from './base';
 export * from './collections';
-export * from './directories';
 export * from './methods';
-export * from './types';
+export * from './schemas';
 export * from './utils';

package/dist/dts/connectors/data-locations/methods.d.ts

@@ -1,6 +1,6 @@
 import { ConnectorMethodImplementation, ConnectorMethodImplementationBase, ConnectorMethodImplementationType } from '../methods';
-import { ApiRequestSpec } from './types';
-export type ConnectorDataLocationMethod<ConfigFields = unknown, ImplementationFields extends ConnectorMethodImplementation | ConnectorMethodImplementationBase = ConnectorMethodImplementationBase> = {
+import { ApiRequestSpec } from './schemas';
+export type ConnectorDataCollectionMethod<ConfigFields = unknown, ImplementationFields extends ConnectorMethodImplementation | ConnectorMethodImplementationBase = ConnectorMethodImplementationBase> = {
     apiRequests?: ApiRequestSpec[];
 } & ImplementationFields & ConfigFields;
 export declare const DataLocationMethodImplementationTypes: ConnectorMethodImplementationType[];