@membranehq/sdk 0.2.1 → 0.4.0

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

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+export declare const DataRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    uri: z.ZodOptional<z.ZodString>;
+    iconUri: z.ZodOptional<z.ZodString>;
+    fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    udm: z.ZodOptional<z.ZodString>;
+    unifiedFields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    rawFields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    createdTime: z.ZodOptional<z.ZodString>;
+    updatedTime: z.ZodOptional<z.ZodString>;
+    deletedTime: z.ZodOptional<z.ZodString>;
+    createdById: z.ZodOptional<z.ZodString>;
+    updatedById: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name?: string | undefined;
+    uri?: string | undefined;
+    iconUri?: string | undefined;
+    fields?: Record<string, any> | undefined;
+    udm?: string | undefined;
+    unifiedFields?: Record<string, any> | undefined;
+    rawFields?: Record<string, any> | undefined;
+    createdTime?: string | undefined;
+    updatedTime?: string | undefined;
+    deletedTime?: string | undefined;
+    createdById?: string | undefined;
+    updatedById?: string | undefined;
+}, {
+    id: string;
+    name?: string | undefined;
+    uri?: string | undefined;
+    iconUri?: string | undefined;
+    fields?: Record<string, any> | undefined;
+    udm?: string | undefined;
+    unifiedFields?: Record<string, any> | undefined;
+    rawFields?: Record<string, any> | undefined;
+    createdTime?: string | undefined;
+    updatedTime?: string | undefined;
+    deletedTime?: string | undefined;
+    createdById?: string | undefined;
+    updatedById?: string | undefined;
+}>;
+export type DataRecord = z.infer<typeof DataRecordSchema>;
+export declare enum DataCollectionEventType {
+    CREATED = "created",
+    UPDATED = "updated",
+    DELETED = "deleted"
+}
+export interface DataCollectionEvent {
+    type: DataCollectionEventType;
+    record: DataRecord;
+}

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

@@ -1,5 +1,5 @@
-import { DataCollectionCreateSpec, DataCollectionDeleteSpec, DataCollectionFindSpec, DataCollectionListSpec, DataCollectionMatchSpec, DataCollectionUpdateSpec } from '../connectors/data-locations';
-import { CONNECTOR_CATEGORIES } from '../connectors/types';
+import { CONNECTOR_CATEGORIES } from '../../connectors/types';
+import { DataCollectionCreateSpec, DataCollectionDeleteSpec, DataCollectionFindSpec, DataCollectionListSpec, DataCollectionMatchSpec, DataCollectionUpdateSpec } from '../schemas';
 export interface UnifiedDataModel {
     singularName: string;
     pluralName: string;

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

@@ -1,6 +1,6 @@
-import { ConnectorSpec } from '../connectors';
-import { DataLocationPointer } from '../connectors/data-locations';
 import { UnifiedDataModel } from './base';
+import { ConnectorSpec } from '../../connectors';
+import { DataLocationPointer } from '../schemas';
 export { UnifiedDataModel } from './base';
 export declare enum UDM {
     ACTIVITIES = "activities",

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

@@ -1,5 +1,6 @@
-import { DataSchema } from '../../data-schema';
-import { ConnectorDataLocation, DataCollectionSpec, DataLocationPointer } from '.';
+import { ConnectorDataCollection } from './data-locations';
+import { DataCollectionSpec, DataLocationPointer } from './schemas';
+import { DataSchema } from '../../../data-schema';
 export declare function getDataLocationMethodPath(locationKey: any, methodKey: any): string;
 export declare function dataLocationParametersMatch({ locationParameters, targetParameters, }: {
     locationParameters: Record<string, any>;
@@ -11,7 +12,9 @@ export declare function makeDataLocationPath(pointer: DataLocationPointer): stri
 export declare function makeDataLocationPath(pointer: DataLocationPointer | undefined): string | undefined;
 export declare function makeDataLocationOperationPath(collectionPath: string, operation: string): string;
 export declare function isSameDataLocation(location1: DataLocationPointer, location2: DataLocationPointer): boolean;
-export declare function isDataLocationMethodSupported(location: ConnectorDataLocation, methodKey: string): boolean;
+export declare function isDataLocationMethodSupported(location: ConnectorDataCollection, methodKey: string): boolean;
 export declare function getDataCollectionCreateFields(spec: DataCollectionSpec): DataSchema | undefined;
 export declare function getDataCollectionUpdateFields(spec: DataCollectionSpec): DataSchema | undefined;
 export declare function getWritableFieldsSchema(spec: DataCollectionSpec): DataSchema | undefined;
+export declare function getReferenceCollectionPointerForSchema(schema: DataSchema | undefined): DataLocationPointer | undefined;
+export declare function getReferenceCollectionPathForSchema(schema: DataSchema | undefined): string | undefined;

package/dist/dts/workspace-elements/base/data-link-table-instances/index.d.ts

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

package/dist/dts/workspace-elements/base/data-link-table-instances/types.d.ts

@@ -0,0 +1,20 @@
+import { BaseMembraneInterface } from '../../types';
+import { DataLinkDirection } from '../data-link-tables';
+export interface BaseDataLinkTableInstance extends BaseMembraneInterface {
+    dataLinkTableId?: string;
+    connectionId?: string;
+    integrationId: string;
+    instanceKey?: string;
+    userId: string;
+    archivedAt?: string;
+}
+export interface DataLink {
+    id: string;
+    dataLinkTableInstanceId: string;
+    externalRecordId: string;
+    appRecordId: string;
+    direction: DataLinkDirection;
+}
+export interface DataLinkTableConfig {
+    key: string;
+}

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

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

package/dist/dts/workspace-elements/base/data-link-tables/types.d.ts

@@ -0,0 +1,9 @@
+import { BaseMembraneInterface } from '../../types';
+export declare enum DataLinkDirection {
+    IMPORT = "import",
+    EXPORT = "export",
+    BOTH = "both"
+}
+export interface BaseDataLinkTable extends BaseMembraneInterface {
+    archivedAt?: string;
+}

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

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

package/dist/dts/workspace-elements/base/data-source-instances/types.d.ts

@@ -0,0 +1,25 @@
+import { BaseMembraneInterface } from '../..';
+import { ErrorData } from '../../../errors';
+import { DataCollectionSpec } from '../data-collections';
+export interface BaseDataSourceInstance extends BaseMembraneInterface {
+    userId: string;
+    revision: string;
+    dataSourceRevision?: string;
+    dataSourceId?: string;
+    universalDataSourceId?: string;
+    udm?: string;
+    connectionId: string;
+    integrationId: string;
+    instanceKey?: string;
+    collectionKey?: string;
+    collectionParameters?: any;
+    defaultCollectionKey?: string;
+    defaultCollectionParameters?: any;
+    collectionSpec?: DataCollectionSpec;
+    isCustomized?: boolean;
+    errors?: ErrorData[];
+    pullUpdatesIntervalSeconds?: number;
+    fullSyncIntervalSeconds?: number;
+    path?: string;
+    defaultPath?: string;
+}

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

@@ -1,4 +1,2 @@
-export * from './accessors';
-export * from './api';
 export * from './constants';
 export * from './types';

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

@@ -0,0 +1,27 @@
+import { BaseMembraneInterface } from '../../types';
+export interface DataSourceUnitConfig {
+    key?: string;
+    collectionKey?: any;
+    collectionParameters?: any;
+    udm?: any;
+    path?: string;
+    pullUpdatesIntervalSeconds?: number;
+    fullSyncIntervalSeconds?: number;
+}
+export interface BaseDataSource extends BaseMembraneInterface {
+    revision: string;
+    publishedRevision?: string;
+    integrationId?: string;
+    universalDataSourceId?: string;
+    universalDataSourceRevision?: string;
+    udm?: string;
+    pullUpdatesIntervalSeconds?: number;
+    fullSyncIntervalSeconds?: number;
+    collectionKey?: string;
+    collectionParameters?: any;
+    archivedAt?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    customized?: boolean;
+    defaultPath?: string;
+}

package/dist/dts/workspace-elements/base/external-event-log-records/index.d.ts

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

package/dist/dts/workspace-elements/base/external-event-log-records/types.d.ts

@@ -0,0 +1,18 @@
+import { ErrorData } from '../../../errors';
+export declare enum ExternalEventLogStatus {
+    CREATED = "created",
+    ERROR = "error",
+    SUCCESS = "success"
+}
+export interface BaseExternalEventLogRecord {
+    id: string;
+    userId: string;
+    name?: string;
+    externalEventSubscriptionId: string;
+    integrationId: string;
+    connectionId: string;
+    payload?: any;
+    launchedFlowRunIds?: string[];
+    status: ExternalEventLogStatus;
+    error?: ErrorData;
+}

package/dist/dts/workspace-elements/base/external-event-pulls/index.d.ts

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

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

@@ -0,0 +1,21 @@
+import { ErrorData } from '../../../errors';
+export declare enum ExternalEventPullStatus {
+    RUNNING = "running",
+    SUCCESS = "success",
+    ERROR = "error",
+    QUEUED = "queued"
+}
+export interface BaseExternalEventPull {
+    id: string;
+    name?: string;
+    userId: string;
+    externalEventSubscriptionId: string;
+    integrationId: string;
+    connectionId: string;
+    startDatetime: string;
+    endDatetime: string;
+    isFullScan?: boolean;
+    status: ExternalEventPullStatus;
+    collectedEventIds: string[];
+    error?: ErrorData;
+}

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

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

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

@@ -0,0 +1,42 @@
+import { ErrorData } from '../../../errors';
+import { DataSourceUnitConfig } from '../data-sources';
+export declare enum ExternalEventSubscriptionStatus {
+    Subscribed = "subscribed",
+    Unsubscribed = "unsubscribed",
+    Error = "error"
+}
+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 BaseExternalEventSubscription {
+    id: string;
+    name?: string;
+    userId: string;
+    connectionId: string;
+    integrationId: string;
+    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;
+}

package/dist/dts/{external-events → workspace-elements/base/external-events}/api.d.ts

@@ -1,5 +1,5 @@
-import { PaginationQuery } from '../entity-repository';
-import { ExternalEventLogStatus } from './types';
+import { PaginationQuery } from '../../../entity-repository';
+import { ExternalEventLogStatus } from '../external-event-log-records';
 export interface FindExternalEventSubscriptionsQuery extends PaginationQuery {
     userId?: string;
     connectionId?: string;

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

@@ -1,8 +1,5 @@
 import { DataCollectionEventType } from '../data-collections';
-import { ExternalEventSubscriptionType, ExternalEventType } from './types';
+import { ExternalEventType } from './types';
 export * from './types';
-export * from './accessors';
-export * from './api';
 export declare function externalEventTypeToDataCollectionEventType(type: ExternalEventType): DataCollectionEventType;
 export declare function dataCollectionEventTypeToExternalEventType(type: DataCollectionEventType): ExternalEventType;
-export declare function externalEventTypeToSubscriptionType(type: ExternalEventType): ExternalEventSubscriptionType;

package/dist/dts/workspace-elements/base/external-events/types.d.ts

@@ -0,0 +1,17 @@
+import { DataSourceUnitConfig } from '../data-sources';
+export declare enum ExternalEventType {
+    DataRecordCreated = "data-record-created",
+    DataRecordUpdated = "data-record-updated",
+    DataRecordDeleted = "data-record-deleted",
+    ConnectorEvent = "connector-event"
+}
+export declare enum IncomingWebhooksState {
+    SUCCESS = "success",
+    ERROR = "error"
+}
+export interface ExternalEventUnitConfig {
+    type: ExternalEventType;
+    dataSource?: DataSourceUnitConfig;
+    eventKey?: string;
+    eventParameters?: any;
+}

package/dist/dts/workspace-elements/base/field-mapping-instances/index.d.ts

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

package/dist/dts/workspace-elements/base/field-mapping-instances/types.d.ts

@@ -0,0 +1,27 @@
+import { DataSchema } from '../../../data-schema';
+import { ErrorData } from '../../../errors';
+import { BaseMembraneInterface, WorkspaceElementState } from '../../types';
+import { FieldMappingDirection } from '../field-mappings/types';
+export interface BaseFieldMappingInstance extends BaseMembraneInterface {
+    userId: string;
+    revision: string;
+    connectionId: string;
+    integrationId: string;
+    fieldMappingRevision?: string;
+    fieldMappingId?: string;
+    instanceKey?: string;
+    dataSourceInstanceId?: string;
+    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/workspace-elements/base/field-mappings/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './merge/merge-with-formulas';

package/dist/dts/workspace-elements/base/field-mappings/types.d.ts

@@ -0,0 +1,38 @@
+import { DataSchema } from '../../../data-schema';
+import { BaseMembraneInterface } from '../../types';
+export declare enum FieldMappingDirection {
+    IMPORT = "import",
+    EXPORT = "export",
+    BOTH = "both"
+}
+export interface BaseFieldMapping extends BaseMembraneInterface {
+    revision: string;
+    publishedRevision?: string;
+    universalFieldMappingId?: string;
+    universalFieldMappingRevision?: string;
+    integrationId?: string;
+    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;
+}
+export interface FieldMappingUnitConfig {
+    key?: string;
+    input?: any;
+    includeRawFields?: any;
+    importValue?: any;
+    exportValue?: any;
+    default?: any;
+    defaultUnifiedValue?: any;
+    defaultValue?: any;
+    appSchema?: DataSchema;
+}

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

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

package/dist/dts/workspace-elements/base/flow-instances/types.d.ts

@@ -0,0 +1,37 @@
+import { DataSchema } from '../../../data-schema';
+import { ErrorData } from '../../../errors';
+import { IntegrationElementInstance } from '../../../integration-elements';
+import { BaseMembraneInterface, WorkspaceElementState } from '../../types';
+import { FlowNode } from '../flows/types';
+export interface BaseFlowInstance extends BaseMembraneInterface {
+    userId: string;
+    connectionId?: string;
+    flowId?: string;
+    universalFlowId?: string;
+    integrationId: string;
+    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[];
+}