@membranehq/sdk 0.3.0 → 0.5.0

package/dist/dts/data-sources/types.d.ts

@@ -1,63 +0,0 @@
-import { IntegrationSpecificElementSelector } from '../accessors';
-import { Connection } from '../connections';
-import { DataCollectionSpec } from '../connectors';
-import { ErrorData } from '../errors';
-import { AppliedToIntegrations, Integration } from '../integrations';
-import { User } from '../users';
-import { WorkspaceElement } from '../workspace-elements';
-export interface DataSourceUnitConfig {
-    key?: string;
-    collectionKey?: any;
-    collectionParameters?: any;
-    udm?: any;
-    path?: string;
-    pullUpdatesIntervalSeconds?: number;
-    fullSyncIntervalSeconds?: number;
-}
-export interface DataSource extends WorkspaceElement {
-    revision: string;
-    publishedRevision?: string;
-    integrationId?: string;
-    integration?: Integration;
-    universalDataSourceId?: string;
-    universalDataSourceRevision?: string;
-    udm?: string;
-    pullUpdatesIntervalSeconds?: number;
-    fullSyncIntervalSeconds?: number;
-    collectionKey?: string;
-    collectionParameters?: any;
-    archivedAt?: string;
-    createdAt?: string;
-    updatedAt?: string;
-    customized?: boolean;
-    appliedToIntegrations?: AppliedToIntegrations<DataSource>;
-    defaultPath?: string;
-}
-export interface DataSourceInstance extends WorkspaceElement {
-    userId: string;
-    revision: string;
-    user?: User;
-    dataSourceRevision?: string;
-    dataSourceId?: string;
-    universalDataSourceId?: string;
-    dataSource?: DataSource;
-    udm?: string;
-    connectionId: string;
-    connection?: Connection;
-    integrationId: string;
-    integration?: Integration;
-    instanceKey?: string;
-    collectionKey?: string;
-    collectionParameters?: any;
-    defaultCollectionKey?: string;
-    defaultCollectionParameters?: any;
-    collectionSpec?: DataCollectionSpec;
-    isCustomized?: boolean;
-    errors?: ErrorData[];
-    pullUpdatesIntervalSeconds?: number;
-    fullSyncIntervalSeconds?: number;
-    path?: string;
-    defaultPath?: string;
-}
-export interface DataSourceSelector extends IntegrationSpecificElementSelector {
-}

package/dist/dts/errors/error-doc-enum.d.ts

@@ -1,7 +0,0 @@
-export declare enum ErrorDoc {
-    AuthenticationTokenErrors = "authentication-token-errors",
-    DataSourceNoCollectionSelected = "data-source-no-collection-selected",
-    FlowInstanceSetupFailed = "flow-instance-setup-failed",
-    FlowInstanceSetupTimeout = "flow-instance-setup-timeout",
-    WebhookCannotFindUser = "webhook-cannot-find-user"
-}

package/dist/dts/external-events/types.d.ts

@@ -1,157 +0,0 @@
-import { Connection } from '../connections';
-import { DataSourceUnitConfig } from '../data-sources';
-import { ErrorData } from '../errors';
-import { AppliedToIntegrations, Integration } from '../integrations';
-import { Customer } from '../users';
-export declare enum ExternalEventType {
-    DataRecordCreated = "data-record-created",
-    DataRecordUpdated = "data-record-updated",
-    DataRecordDeleted = "data-record-deleted",
-    ConnectorEvent = "connector-event"
-}
-export declare enum ExternalEventSubscriptionStatus {
-    Subscribed = "subscribed",
-    Unsubscribed = "unsubscribed",
-    Error = "error"
-}
-export declare enum ExternalEventPullStatus {
-    RUNNING = "running",
-    SUCCESS = "success",
-    ERROR = "error",
-    QUEUED = "queued"
-}
-export declare enum IncomingWebhooksState {
-    SUCCESS = "success",
-    ERROR = "error"
-}
-export interface ExternalEventUnitConfig {
-    type: ExternalEventType;
-    dataSource?: DataSourceUnitConfig;
-    eventKey?: string;
-    eventParameters?: any;
-}
-export declare enum ExternalEventSubscriptionType {
-    DataRecordCreated = "data-record-created",
-    DataRecordUpdated = "data-record-updated",
-    DataRecordDeleted = "data-record-deleted",
-    ConnectorEvent = "connector-event"
-}
-export interface ExternalEventSubscriptionConfig {
-    type: ExternalEventSubscriptionType;
-    dataSource?: DataSourceUnitConfig;
-    eventKey?: string;
-    eventParameters?: any;
-}
-export interface ExternalEvent {
-    config?: ExternalEventUnitConfig;
-    appliedToIntegrations?: AppliedToIntegrations<ExternalEvent>;
-}
-export interface ExternalEventSubscription {
-    id: string;
-    name?: string;
-    userId: string;
-    user?: Customer;
-    connectionId: string;
-    connection?: Connection;
-    integrationId: string;
-    integration?: Integration;
-    uuid: string;
-    config?: ExternalEventSubscriptionConfig;
-    status?: ExternalEventSubscriptionStatus;
-    error?: ErrorData;
-    isRealTime?: boolean;
-    requiresPull?: boolean;
-    requiresFullSync?: boolean;
-    createdAt?: string;
-    archivedAt?: string;
-    stateData?: any;
-    nextPullEventsTimestamp?: number;
-    pullUpdatesIntervalSeconds?: number;
-    fullSyncIntervalSeconds?: number;
-    nextRefreshTimestamp?: number;
-    globalWebhookKey?: string;
-    globalWebhookEventSelector?: string;
-}
-export declare enum ExternalEventLogStatus {
-    CREATED = "created",
-    ERROR = "error",
-    SUCCESS = "success"
-}
-export interface ExternalEventLogRecord {
-    id: string;
-    userId: string;
-    user?: Customer;
-    name?: string;
-    externalEventSubscriptionId: string;
-    externalEventSubscription?: ExternalEventSubscription;
-    integrationId: string;
-    integration?: Integration;
-    connectionId: string;
-    connection?: Connection;
-    payload?: any;
-    launchedFlowRunIds?: string[];
-    status: ExternalEventLogStatus;
-    error?: ErrorData;
-}
-export interface ExternalEventCustomPullSubscribeResponse {
-    state: Record<string, any>;
-}
-export interface ExternalEventCustomPullCollectEventsRequest {
-    state: Record<string, any>;
-}
-export interface ExternalEventCustomPullCollectEventsResponse<EventPayload = any> {
-    events: EventPayload[];
-    state: Record<string, any>;
-}
-export interface ExternalEventWebhookSubscribeRequest {
-    webhookUri: string;
-}
-export interface ExternalEventWebhookSubscribeResponse {
-    state?: Record<string, any>;
-    nextRefreshTimestamp?: number;
-}
-export interface ExternalEventWebhookUnsubscribeRequest {
-    state: Record<string, any>;
-}
-export interface ExternalEventWebhookHandleRequest {
-    state: Record<string, any>;
-    query: Record<string, string>;
-    data: any;
-    rawBody?: string;
-    headers: any;
-}
-export interface ExternalEventWebhookHandleResponse<EventPayload = any> {
-    events?: EventPayload[];
-    response?: {
-        headers?: Record<string, string>;
-        data?: any;
-        status?: number;
-    };
-    state?: Record<string, any>;
-}
-export interface ExternalEventWebhookRefreshRequest {
-    state: Record<string, any>;
-    webhookUri: string;
-}
-export interface ExternalEventWebhookRefreshResponse {
-    state?: Record<string, any>;
-    nextRefreshTimestamp?: number;
-}
-export interface ExternalEventPull {
-    id: string;
-    name?: string;
-    userId: string;
-    user?: Customer;
-    externalEventSubscriptionId: string;
-    externalEventSubscription?: ExternalEventSubscription;
-    integrationId: string;
-    integration?: Integration;
-    connectionId: string;
-    connection?: Connection;
-    startDatetime: string;
-    endDatetime: string;
-    isFullScan?: boolean;
-    status: ExternalEventPullStatus;
-    collectedEventIds: string[];
-    error?: ErrorData;
-}

package/dist/dts/field-mappings/accessors.d.ts

@@ -1,54 +0,0 @@
-import { ElementAccessor, ElementInstanceAccessor, ElementInstanceListAccessor, ElementListAccessor } from '../accessors';
-import { IntegrationAppApiClient } from '../api-client';
-import { OpenConfigurationOptions } from '../iframe';
-import { CreateFieldMappingInstanceRequest, CreateFieldMappingRequest, FieldMappingInstanceSelector, FindFieldMappingInstancesQuery, FindFieldMappingsQuery, ListFieldMappingInstancesForConnectionQuery, ListFieldMappingsForIntegrationQuery, UpdateFieldMappingInstanceRequest, UpdateFieldMappingRequest } from './api';
-import { InstanceKeyQuery } from '../integration-elements/common';
-import { ConnectionLevelElementAccessor, ConnectionLevelElementsListAccessor } from '../integration-elements/connection-level-element.accessor';
-import { IntegrationLevelElementAccessor, IntegrationLevelElementsListAccessor } from '../integration-elements/integration-level-element.accessor';
-import { FieldMapping, FieldMappingInstance, FieldMappingSelector } from '.';
-export interface OpenFieldMappingInstanceConfigurationOptions extends OpenConfigurationOptions {
-}
-export declare class FieldMappingsAccessor extends ElementListAccessor<FieldMapping, FindFieldMappingsQuery, CreateFieldMappingRequest> {
-    constructor(client: IntegrationAppApiClient);
-}
-export declare class FieldMappingAccessor extends ElementAccessor<FieldMapping, UpdateFieldMappingRequest, FieldMappingSelector> {
-    constructor(client: IntegrationAppApiClient, selector: string | FieldMappingSelector);
-    getAppSchema(): Promise<any>;
-    apply(integrationKeys: string[]): Promise<FieldMapping[]>;
-    setup(): Promise<any>;
-    reset(): Promise<any>;
-}
-export declare class FieldMappingInstancesAccessor extends ElementInstanceListAccessor<FieldMappingInstance, FindFieldMappingInstancesQuery> {
-    constructor(client: IntegrationAppApiClient);
-}
-export declare class FieldMappingInstanceAccessor extends ElementInstanceAccessor<FieldMappingInstance, FieldMappingInstanceSelector, CreateFieldMappingInstanceRequest, UpdateFieldMappingInstanceRequest> {
-    private client;
-    constructor(client: IntegrationAppApiClient, selector: string | FieldMappingInstanceSelector);
-    setup(): Promise<void>;
-    reset(): Promise<void>;
-    openConfiguration({ onClose }?: OpenFieldMappingInstanceConfigurationOptions): Promise<void>;
-}
-export declare class IntegrationLevelFieldMappingAccessor extends IntegrationLevelElementAccessor<FieldMapping, UpdateFieldMappingRequest> {
-    client: IntegrationAppApiClient;
-    integrationSelector: string;
-    fieldMappingSelector: string;
-    constructor(client: IntegrationAppApiClient, integrationSelector: string, fieldMappingSelector: string);
-}
-export declare class IntegrationLevelFieldMappingsListAccessor extends IntegrationLevelElementsListAccessor<FieldMapping, ListFieldMappingsForIntegrationQuery, Omit<CreateFieldMappingRequest, 'integrationId'>> {
-    client: IntegrationAppApiClient;
-    integrationSelector: string;
-    constructor(client: IntegrationAppApiClient, integrationSelector: string);
-}
-export declare class ConnectionLevelFieldMappingAccessor extends ConnectionLevelElementAccessor<FieldMappingInstance, UpdateFieldMappingInstanceRequest> {
-    client: IntegrationAppApiClient;
-    connectionSelector: string;
-    fieldMappingSelector: string;
-    query: InstanceKeyQuery;
-    constructor(client: IntegrationAppApiClient, connectionSelector: string, fieldMappingSelector: string, query: InstanceKeyQuery);
-    openConfiguration({ onClose }?: OpenFieldMappingInstanceConfigurationOptions): Promise<void>;
-}
-export declare class ConnectionLevelFieldMappingsAccessor extends ConnectionLevelElementsListAccessor<FieldMapping, ListFieldMappingInstancesForConnectionQuery> {
-    client: IntegrationAppApiClient;
-    connectionSelector: string;
-    constructor(client: IntegrationAppApiClient, connectionSelector: string);
-}

package/dist/dts/field-mappings/api.d.ts

@@ -1,58 +0,0 @@
-import { ElementInstanceSelector, IntegrationSpecificElementSelector } from '../accessors';
-import { ConnectionSelector } from '../connections/api';
-import { DataSchema } from '../data-schema';
-import { CommonInstancesListQuery, CommonIntegrationOrConnectionQuery, CommonListElementsQuery } from '../entity-repository';
-import { FlowInstanceSelector } from '../flows/api';
-import { FieldMappingDirection } from '.';
-export interface ListFieldMappingsForIntegrationQuery extends CommonListElementsQuery {
-    universalFieldMappingId?: string | 'null';
-}
-export interface FindFieldMappingsQuery extends ListFieldMappingsForIntegrationQuery {
-    integrationId?: string | 'null';
-}
-export type ListFieldMappingInstancesForConnectionQuery = CommonInstancesListQuery & {
-    fieldMappingId?: string;
-    universalFieldMappingId?: string;
-    dataSourceInstanceId?: string;
-};
-export type FindFieldMappingInstancesQuery = ListFieldMappingInstancesForConnectionQuery & CommonIntegrationOrConnectionQuery;
-export interface UpdateFieldMappingRequest {
-    key?: string;
-    name?: string;
-    dataSourceKey?: string;
-    dataSourceId?: string;
-    appSchema?: DataSchema;
-    direction?: FieldMappingDirection;
-    defaultImportValue?: any;
-    exportValue?: any;
-    importValue?: any;
-    defaultExportValue?: any;
-    frozenImportFields?: any;
-    frozenExportFields?: any;
-    frozenUnifiedExportFields?: any;
-    archivedAt?: string;
-}
-export interface CreateFieldMappingRequest extends UpdateFieldMappingRequest {
-    key: string;
-    name: string;
-    integrationId?: string;
-}
-export interface CreateFieldMappingInstanceRequest {
-    connectionId: string;
-    fieldMappingId?: string;
-    instanceKey?: string;
-    importValue?: any;
-    exportValue?: any;
-}
-export interface UpdateFieldMappingInstanceRequest {
-    importValue?: any;
-    exportValue?: any;
-}
-export interface FieldMappingInstanceSelector extends ConnectionSelector, FlowInstanceSelector, ElementInstanceSelector {
-    fieldMappingKey?: string;
-    fieldMappingId?: string;
-    instanceKey?: string;
-    nodeKey?: string;
-}
-export interface FieldMappingSelector extends IntegrationSpecificElementSelector {
-}

package/dist/dts/field-mappings/index.d.ts

@@ -1,66 +0,0 @@
-import { Connection } from '../connections';
-import { DataSchema } from '../data-schema';
-import { DataSourceInstance } from '../data-sources';
-import { ErrorData } from '../errors';
-import { AppliedToIntegrations, Integration } from '../integrations';
-import { User } from '../users';
-import { WorkspaceElement, WorkspaceElementState } from '../workspace-elements';
-export * from './accessors';
-export * from './api';
-export * from './merge/merge-with-formulas';
-export * from './types';
-export declare enum FieldMappingDirection {
-    IMPORT = "import",
-    EXPORT = "export",
-    BOTH = "both"
-}
-export interface FieldMapping extends WorkspaceElement {
-    revision: string;
-    publishedRevision?: string;
-    universalFieldMappingId?: string;
-    universalFieldMappingRevision?: string;
-    integrationId?: string;
-    integration?: Integration;
-    dataSourceId: string;
-    dataSourceKey: string;
-    appSchema: DataSchema;
-    direction: FieldMappingDirection;
-    defaultImportValue?: any;
-    defaultExportValue?: any;
-    importValue?: any;
-    exportValue?: any;
-    frozenImportFields?: any;
-    frozenExportFields?: any;
-    frozenUnifiedExportFields?: any;
-    archivedAt?: string;
-    customized?: boolean;
-    appliedToIntegrations?: AppliedToIntegrations<FieldMapping>;
-}
-export interface FieldMappingInstance extends WorkspaceElement {
-    userId: string;
-    revision: string;
-    user?: User;
-    connectionId: string;
-    connection?: Connection;
-    integrationId: string;
-    integration?: Integration;
-    fieldMappingRevision?: string;
-    fieldMappingId?: string;
-    fieldMapping?: FieldMapping;
-    instanceKey?: string;
-    dataSourceInstanceId?: string;
-    dataSourceInstance?: DataSourceInstance;
-    dataSourceSchema?: DataSchema;
-    direction?: FieldMappingDirection;
-    appSchema?: DataSchema;
-    importValue?: any;
-    exportValue?: any;
-    isCustomized?: boolean;
-    unifiedExportValue?: any;
-    unifiedImportValue?: any;
-    frozenImportFields?: string[];
-    frozenExportFields?: string[];
-    state?: WorkspaceElementState;
-    error?: ErrorData;
-    externalSchema?: any;
-}

package/dist/dts/field-mappings/types.d.ts

@@ -1,12 +0,0 @@
-import { DataSchema } from '../data-schema';
-export interface FieldMappingUnitConfig {
-    key?: string;
-    input?: any;
-    includeRawFields?: any;
-    importValue?: any;
-    exportValue?: any;
-    default?: any;
-    defaultUnifiedValue?: any;
-    defaultValue?: any;
-    appSchema?: DataSchema;
-}

package/dist/dts/flow-runs/index.d.ts

@@ -1,78 +0,0 @@
-import { Connection } from '../connections';
-import { PaginationResponse, PaginationQuery } from '../entity-repository';
-import { ErrorData } from '../errors';
-import { FlowInstance } from '../flows';
-import { Integration } from '../integrations';
-import { Customer } from '../users';
-export * from './flow-node-runs';
-export * from './accessors';
-export declare enum FlowRunState {
-    QUEUED = "queued",
-    RUNNING = "running",
-    COMPLETED = "completed",
-    STOPPED = "stopped",
-    FAILED = "failed"
-}
-export declare enum FlowRunNodeState {
-    RUNNING = "running",
-    COMPLETED = "completed",
-    STOPPED = "stopped",
-    FAILED = "failed"
-}
-export declare enum FlowRunLaunchedByTrigger {
-    ApiTrigger = "api-trigger",
-    ScheduleTrigger = "schedule-trigger",
-    AppEventTrigger = "app-event-trigger",
-    DataSourceTrigger = "data-source-trigger",
-    ExternalEvent = "external-event"
-}
-export interface FlowRun {
-    id: string;
-    name?: string;
-    flowInstanceId: string;
-    flowInstance?: FlowInstance;
-    universalFlowId?: string;
-    connectionId?: string;
-    connection?: Connection;
-    integrationId?: string;
-    integration?: Integration;
-    startNodeKey: string;
-    userId: string;
-    user?: Customer;
-    input?: any;
-    state: FlowRunState;
-    startTime: string;
-    endTime?: string;
-    errors?: ErrorData[];
-    nodes?: Record<string, FlowRunNode>;
-    launchedBy?: FlowRunLaunchedBy;
-}
-export interface FlowRunNode {
-    state: FlowRunNodeState;
-    runs?: number;
-    erroredRuns?: number;
-    outputs?: number;
-}
-export interface FlowRunLaunchedBy {
-    type: FlowRunLaunchedByTrigger;
-    ids?: string[];
-}
-export interface CreateFlowRunRequest {
-    flowInstanceId: string;
-    nodeKey?: string;
-    input?: any;
-}
-export interface FindFlowRunsQuery extends PaginationQuery {
-    id?: string;
-    flowInstanceId?: string;
-    startNodeKey?: string;
-    flowId?: string;
-    universalFlowId?: string;
-    userId?: string;
-    state?: FlowRunState;
-    integrationId?: string;
-    connectionId?: string;
-    startedAfter?: string;
-}
-export interface FindFlowRunsResponse extends PaginationResponse<FlowRun> {
-}

package/dist/dts/flows/api.d.ts

@@ -1,54 +0,0 @@
-import { ElementInstanceSelector, IntegrationSpecificElementSelector } from '../accessors';
-import { ConnectionSelector } from '../connections';
-import { DataSchema } from '../data-schema';
-import { CommonInstancesListQuery, CommonIntegrationOrConnectionQuery, CommonListElementsQuery } from '../entity-repository';
-import { FlowNodeLink } from '.';
-export interface ListFlowsForIntegrationQuery extends CommonListElementsQuery {
-    universalFlowId?: string | 'null';
-}
-export interface FindFlowsQuery extends ListFlowsForIntegrationQuery {
-    integrationId?: string | 'null';
-}
-export interface CreateFlowNodeRequest {
-    type: string;
-    config?: any;
-    ui?: any;
-    links?: FlowNodeLink[];
-}
-export interface CreateFlowRequest {
-    key: string;
-    name: string;
-    integrationId?: string;
-    nodes?: Record<string, CreateFlowNodeRequest>;
-    parametersSchema?: DataSchema;
-    autoCreateInstances?: boolean;
-}
-export interface UpdateFlowRequest extends CreateFlowRequest {
-    archivedAt?: string;
-}
-export interface FlowSelector extends IntegrationSpecificElementSelector {
-    autoCreate?: boolean;
-}
-export type ListFlowInstancesForConnectionQuery = CommonInstancesListQuery & {
-    flowId?: string;
-    flowKey?: string;
-    enabled?: boolean;
-};
-export type FindFlowInstancesQuery = ListFlowInstancesForConnectionQuery & CommonIntegrationOrConnectionQuery;
-export interface FlowInstanceSelector extends ConnectionSelector, ElementInstanceSelector {
-    flowId?: string;
-    flowKey?: string;
-    instanceKey?: string;
-    autoUpdate?: boolean;
-}
-export interface ResetFlowInstanceOptions {
-    name?: boolean;
-    nodes?: Record<string, boolean>;
-    allNodes?: boolean;
-}
-export interface RunFlowOptions {
-    nodeKey?: string;
-    input?: any;
-    returnImmediately?: boolean;
-    onUpdate?: (...args: any) => void;
-}

package/dist/dts/flows/index.d.ts

@@ -1,6 +0,0 @@
-export * from './accessors';
-export * from './api';
-export * from './nodes';
-export * from './types';
-export * from './utils';
-export * from './schemas';

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

@@ -1,76 +0,0 @@
-import { Connection } from '../connections';
-import { DataSchema } from '../data-schema';
-import { ErrorData } from '../errors';
-import { IntegrationElementInstance } from '../integration-elements';
-import { AppliedToIntegrations, Integration } from '../integrations';
-import { User } from '../users';
-import { WorkspaceElement, WorkspaceElementState } from '../workspace-elements';
-export interface FlowNode {
-    type?: string;
-    version?: number;
-    name?: string;
-    description?: string;
-    config?: any;
-    concurrency?: number;
-    onError?: 'stop' | 'continue';
-    ui?: any;
-    inputSchema?: any;
-    outputSchema?: any;
-    outputExample?: any;
-    links?: FlowNodeLink[];
-    isCustomized?: boolean;
-}
-export interface Flow extends WorkspaceElement {
-    integrationId?: string;
-    integration?: Integration;
-    universalFlowId?: string;
-    universalFlowRevision?: string;
-    parametersSchema?: DataSchema;
-    nodes?: Record<string, FlowNode>;
-    autoCreateInstances?: boolean;
-    archivedAt?: string;
-    revision: string;
-    customized?: boolean;
-    appliedToIntegrations?: AppliedToIntegrations<Flow>;
-}
-export interface FlowInstance extends WorkspaceElement {
-    userId: string;
-    user?: User;
-    connectionId?: string;
-    connection?: Connection;
-    flow?: Flow;
-    flowId?: string;
-    universalFlowId?: string;
-    integrationId: string;
-    integration?: Integration;
-    instanceKey?: string;
-    parameters?: any;
-    parametersSchema?: DataSchema;
-    nodes?: Record<string, FlowInstanceNode>;
-    enabled: boolean;
-    createdAt: string;
-    updatedAt: string;
-    state?: WorkspaceElementState;
-    outdated?: boolean;
-    customized?: {
-        name?: boolean;
-        nodes?: boolean;
-    };
-    dependencies?: IntegrationElementInstance[];
-}
-export declare enum FlowInstanceNodeState {
-    SETUP_FAILED = "SETUP_FAILED",
-    READY = "READY"
-}
-export interface FlowInstanceNode extends FlowNode {
-    state?: FlowInstanceNodeState;
-    errors?: ErrorData[];
-    userConfig?: any;
-    testInput?: any;
-    dependencies?: IntegrationElementInstance[];
-}
-export interface FlowNodeLink {
-    key?: string;
-    filter?: any;
-    name?: string;
-}