@membranehq/sdk 0.2.1 → 0.4.0

package/dist/dts/workspace-elements/base/app-data-schemas/types.d.ts

@@ -0,0 +1,7 @@
+import { BaseMembraneInterface } from '../../types';
+export interface BaseAppDataSchema extends BaseMembraneInterface {
+    schema: any;
+    code?: string;
+    archivedAt?: string;
+    revision?: string;
+}

package/dist/dts/workspace-elements/base/app-event-subscriptions/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/dts/workspace-elements/base/app-event-subscriptions/types.d.ts

@@ -0,0 +1,15 @@
+import { DataSchema } from '../../../data-schema';
+import { HttpRequestSpec } from '../../../http-requests';
+import { BaseMembraneInterface } from '../../types';
+export interface BaseAppEventSubscription extends BaseMembraneInterface {
+    revision: string;
+    appEventTypeId: string;
+    userId: string;
+    instanceKey?: string;
+    isSubscribed: boolean;
+    schema?: DataSchema;
+    webhookUri: string;
+    subscriptionRequest: HttpRequestSpec;
+    subscriptionResponse?: any;
+    archivedAt?: string;
+}

package/dist/dts/workspace-elements/base/app-event-types/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/dts/workspace-elements/base/app-event-types/types.d.ts

@@ -0,0 +1,12 @@
+import { DataSchema } from '../../../data-schema';
+import { HttpRequestSpec } from '../../../http-requests';
+import { BaseMembraneInterface } from '../../types';
+export interface BaseAppEventType extends BaseMembraneInterface {
+    revision: string;
+    archivedAt?: string;
+    subscribeRequest?: HttpRequestSpec;
+    example?: any;
+    schema?: DataSchema;
+    globalWebhookUri: string;
+    userIdFormula?: any;
+}

package/dist/dts/workspace-elements/base/connections/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/dts/{connections → workspace-elements/base/connections}/types.d.ts

@@ -1,7 +1,6 @@
-import { ConnectorUiSpec, ConnectorDataUdmSpec, ConnectorDataSpec, ConnectorSpec } from '../connectors/types';
-import { ErrorData } from '../errors';
-import { Integration } from '../integrations/types';
-import { User } from '../users';
+import { ErrorData } from '../../../errors';
+import { BaseWorkspaceElement, WorkspaceElementState } from '../../types';
+import { ConnectorUiSpec, ConnectorSpec } from '../connectors/types';
 export interface ConnectionRequest {
     path: any;
     method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
@@ -10,15 +9,12 @@ export interface ConnectionRequest {
     query?: Record<string, string>;
     data?: any;
 }
-export declare class Connection {
-    id: string;
+export interface BaseConnection extends BaseWorkspaceElement {
     name: string;
     userId: string;
-    user?: User;
     disconnected?: boolean;
     error?: ErrorData;
     integrationId: string;
-    integration?: Integration;
     credentials?: unknown;
     parameters?: unknown;
     connectorParameters?: unknown;
@@ -26,27 +22,15 @@ export declare class Connection {
     refreshToken?: string;
     createdAt: string;
     updatedAt: string;
+    lastActiveAt?: string;
+    nextCredentialsRefreshAt?: string;
     archivedAt?: string;
+    state?: WorkspaceElementState;
+    errors?: ErrorData[];
 }
 export interface ConnectionSpec extends ConnectorSpec {
 }
 export type ConnectionUiSpec = ConnectorUiSpec;
-export type ConnectionUdmSpec = ConnectorDataUdmSpec;
-export type ConnectionDataSpec = ConnectorDataSpec;
 export declare class ConnectionSpec {
     constructor(opts: ConnectionSpec);
 }
-export type ConnectionMessagePayload = {
-    source: string;
-    requestId: string;
-} & ({
-    type: 'newConnectionCreated';
-    connection: Connection;
-    error?: never;
-    errorData?: never;
-} | {
-    type: 'newConnectionFailure';
-    connection?: never;
-    error: string;
-    errorData?: ErrorData;
-});

package/dist/dts/{connectors → workspace-elements/base/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"];
+import { ConnectorSpec } from './types';
+import { DataSchema } from '../../../data-schema';
+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/workspace-elements/base/connectors/events/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/dts/{connectors → workspace-elements/base/connectors}/events/types.d.ts

@@ -1,4 +1,4 @@
-import { DataSchema } from '../../data-schema';
+import { DataSchema } from '../../../../data-schema';
 import { ConnectorMethodImplementation, ConnectorMethodImplementationType } from '../methods';
 export declare enum ConnectorEventImplementationType {
     GlobalWebhook = "global-webhook",

package/dist/dts/workspace-elements/base/connectors/global-webhooks/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/dts/{connectors → workspace-elements/base/connectors}/graphql-api.d.ts

@@ -1,4 +1,4 @@
-import { HttpRequestMethod } from '../http-requests';
+import { HttpRequestMethod } from '../../../http-requests';
 export interface GraphqlApiClientInput {
     path: string;
     method: HttpRequestMethod;

package/dist/dts/{connectors → workspace-elements/base/connectors}/index.d.ts

@@ -1,7 +1,5 @@
 export * from './auth';
 export * from './constants';
-export * from './data-locations';
-export * from './data-records';
 export * from './methods';
 export * from './openapi';
 export * from './operations';

package/dist/dts/{connectors → workspace-elements/base/connectors}/methods.d.ts

@@ -1,7 +1,7 @@
 import { GraphQLApiMapping } from './graphql-api';
 import { OperationMapping } from './operations';
 import { RestApiMapping } from './rest-api';
-import { DataSchema } from '../data-schema';
+import { DataSchema } from '../../../data-schema';
 export declare enum ConnectorMethodImplementationType {
     mapping = "mapping",
     operationMapping = "operation-mapping",

package/dist/dts/{connectors → workspace-elements/base/connectors}/rest-api.d.ts

@@ -1,5 +1,5 @@
 import https from 'https';
-import { HttpRequestMethod } from '../http-requests';
+import { HttpRequestMethod } from '../../../http-requests';
 export interface RestApiClientInput {
     path: string;
     method: HttpRequestMethod;

package/dist/dts/{connectors → workspace-elements/base/connectors}/types.d.ts

@@ -1,12 +1,10 @@
-import { DataSchema } from '../data-schema';
-import { UDM } from '../udm';
 import { ConnectorAuth } from './auth';
-import { DataLocation, DataLocationSpec } from './data-locations';
 import { ConnectorMethodImplementation } from './methods';
 import { ConnectorOperationHandler } from './operations';
 import { ConnectorUdmSpec } from './udm';
+import { DataSchema } from '../../../data-schema';
 export declare const CONNECTOR_CATEGORIES: readonly ["Accounting", "Ads", "Analytics", "ATS", "Communication", "CRM", "Customer Success", "Document Management", "E-Commerce", "E-Signature", "ERP", "File Storage", "HRIS", "Legal", "Marketing Automation", "Payments", "Project Management", "Sales", "Ticketing"];
-export type Connector = ConnectorSpec & {
+export type BaseConnector = ConnectorSpec & {
     id: string;
     uuid: string;
     key: string;
@@ -35,15 +33,6 @@ export interface ConnectorUiSpec {
     helpUri?: string;
     test?: boolean;
 }
-export type ConnectorDataUdmSpec = {
-    rootLocation: DataLocation;
-};
-export type ConnectorDataSpec = {
-    rootLocation?: DataLocation;
-    locations?: DataLocationSpec[];
-    udm?: Partial<Record<UDM, ConnectorDataUdmSpec>>;
-    root?: DataLocation;
-} & Partial<Record<UDM, DataLocation>>;
 export type ConnectorApiType = 'openapi' | 'graphql';
 export interface ConnectorSpec {
     key?: string;
@@ -57,7 +46,6 @@ export interface ConnectorSpec {
     ui?: ConnectorUiSpec;
     auth?: ConnectorAuth;
     parametersSchema?: DataSchema;
-    data?: ConnectorDataSpec;
     udms?: string[];
     udm?: Record<string, ConnectorUdmSpec>;
     operations?: ConnectorOperationHandler[];
@@ -66,6 +54,7 @@ export interface ConnectorSpec {
     appUuid?: string;
     knowledgeBaseUuid?: string;
     workspaceId?: string;
+    data?: any;
 }
 export type MinimalConnector = {
     id: string;

package/dist/dts/{connectors → workspace-elements/base/connectors}/udm.d.ts

@@ -1,4 +1,4 @@
-import { DataLocationPointer } from './data-locations';
+import { DataLocationPointer } from '../data-collections';
 export interface ConnectorUdmListLitem {
     key: string;
 }

package/dist/dts/{users → workspace-elements/base/customers}/index.d.ts

@@ -1,6 +1,4 @@
-export * from './accessors';
-export * from './api';
-export type Customer = {
+export type BaseCustomer = {
     id: string;
     name: string;
     internalId: string;
@@ -10,4 +8,3 @@ export type Customer = {
     isTest?: boolean;
     isBillable?: boolean;
 };
-export type User = Customer;

package/dist/dts/workspace-elements/base/data-collections/data-locations/base.d.ts

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

package/dist/dts/{connectors → workspace-elements/base/data-collections}/data-locations/collections/events/implementation-types/connector-event.d.ts

@@ -1,10 +1,10 @@
-import { DataSchema } from '../../../../../data-schema';
-import { ConnectorDataLocationMethod } from '../../../methods';
+import { DataSchema } from '../../../../../../../data-schema';
+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 → workspace-elements/base/data-collections}/data-locations/collections/events/implementation-types/custom-pull.d.ts

@@ -1,10 +1,10 @@
-import { DataSchema } from '../../../../../data-schema';
-import { ConnectorDataLocationMethod } from '../../../methods';
+import { DataSchema } from '../../../../../../../data-schema';
+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 → workspace-elements/base/data-collections}/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 { DataRecord } from '../../../..';
+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 → workspace-elements/base/data-collections}/data-locations/collections/events/implementation-types/webhook.d.ts

@@ -1,12 +1,12 @@
-import { DataSchema } from '../../../../../data-schema';
-import { ConnectorDataLocationMethod } from '../../../methods';
+import { DataSchema } from '../../../../../../../data-schema';
+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 → workspace-elements/base/data-collections}/data-locations/collections/events/methods.d.ts

@@ -1,6 +1,6 @@
 import { ConnectorDataCollection } from '..';
-import { DataSchema } from '../../../../data-schema';
-import { ConnectorMethodImplementationType } from '../../../methods';
+import { DataSchema } from '../../../../../../data-schema';
+import { ConnectorMethodImplementationType } from '../../../../connectors/methods';
 import { ConnectorDataCollectionEvent } from '.';
 interface ConnectorDataCollectionEventMethodTypeArgs<ImplementationFields = unknown> {
     event: ConnectorDataCollectionEvent<ImplementationFields>;

package/dist/dts/{connectors → workspace-elements/base/data-collections}/data-locations/collections/index.d.ts

@@ -1,6 +1,6 @@
-import { DataSchema } from '../../../data-schema';
-import { ConnectorDataLocationBase } from '../base';
-import { ConnectorDataLocationMethod } from '../methods';
+import { DataSchema } from '../../../../../data-schema';
+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 → workspace-elements/base/data-collections}/data-locations/collections/methods/base.d.ts

@@ -1,9 +1,9 @@
 import { ConnectorDataCollection } from '..';
-import { DataSchema } from '../../../../data-schema';
-import { ConnectorMethodImplementationType } from '../../../methods';
-import { ConnectorSpec } from '../../../types';
-import { ConnectorDataLocationMethod } from '../../methods';
-import { DataCollectionSpec } from '../../types';
+import { DataSchema } from '../../../../../../data-schema';
+import { ConnectorMethodImplementationType } from '../../../../connectors/methods';
+import { ConnectorSpec } from '../../../../connectors/types';
+import { DataCollectionSpec } from '../../../schemas';
+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 → workspace-elements/base/data-collections}/data-locations/index.d.ts

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

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

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

package/dist/dts/{connectors → workspace-elements/base/data-collections}/data-records.d.ts

@@ -1,4 +1,4 @@
-import { DataSchema } from '../data-schema';
+import { DataSchema } from '../../../data-schema';
 export declare const DATA_RECORD_SCHEMA: DataSchema;
 export declare function makeDataRecordSchema({ fieldsSchema, udm, rawFieldsSchema, }: {
     fieldsSchema?: DataSchema;

package/dist/dts/workspace-elements/base/data-collections/index.d.ts

@@ -0,0 +1,6 @@
+export * from './types';
+export * from './schemas';
+export * from './udm';
+export * from './data-records';
+export * from './data-locations';
+export * from './utils';