@membranehq/sdk 0.1.0

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

@@ -0,0 +1,38 @@
+import { Connection } from '../connections';
+import { ConnectorAuthSpec, ConnectorAuthType, ConnectorSpec } from '../connectors';
+import { DataSchema } from '../data-schema';
+import { ErrorData } from '../errors';
+import { WorkspaceElement, WorkspaceElementState } from '../workspace-elements';
+export interface Integration extends WorkspaceElement {
+    state?: WorkspaceElementState;
+    errors?: ErrorData[];
+    logoUri: string;
+    connectorId?: string;
+    connectorVersion?: string;
+    authOptions?: IntegrationAuthOption[];
+    oAuthCallbackUri?: string;
+    parametersSchema?: DataSchema;
+    parameters?: any;
+    baseUri: string;
+    connection?: Connection;
+    archivedAt?: string;
+    spec?: ConnectorSpec;
+    hasMissingParameters?: boolean;
+    hasDocumentation?: boolean;
+    hasOperations?: boolean;
+    hasData?: boolean;
+    hasEvents?: boolean;
+    hasGlobalWebhooks?: boolean;
+    hasUdm?: boolean;
+    isTest?: boolean;
+    appUuid?: string;
+    isDeactivated?: boolean;
+    authType?: ConnectorAuthType;
+}
+export type IntegrationAuthOption = ConnectorAuthSpec & {
+    key: string;
+};
+export type AppliedToIntegrations<Element> = {
+    element: Element;
+    integration: Integration;
+}[];

package/dist/dts/jwt.d.ts

@@ -0,0 +1 @@
+export declare function decodeJWT(token: string | undefined): any;

package/dist/dts/jwt.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,8 @@
+import { Readable } from 'node:stream';
+export * from './types';
+export type WithExecutionLogs<T extends Record<string, any>> = T & {
+    logs?: any[];
+};
+export declare function isStream(obj: any): boolean;
+export declare function streamToString(stream: Readable): Promise<string>;
+export declare function truncateData(data: any, depth?: number): any;

package/dist/dts/logging/index.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,13 @@
+export declare enum LogRecordType {
+    MSG = "message",
+    TEXT = "text",
+    ERR = "error",
+    DATA = "data",
+    COMP = "compare",
+    API = "api-request"
+}
+export interface LogRecord {
+    type?: LogRecordType;
+    msg?: string;
+    data?: any;
+}

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

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

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

@@ -0,0 +1,59 @@
+export declare enum OrgLimitsType {
+    NUMBER_OF_WORKSPACES = "numberOfWorkspaces",
+    TODAY_USAGE = "todayUsage",
+    LAST_THIRTY_DAY_USAGE = "lastThirtyDayUsage"
+}
+export interface OrgLimits {
+    [OrgLimitsType.NUMBER_OF_WORKSPACES]?: number;
+    [OrgLimitsType.TODAY_USAGE]?: number;
+    [OrgLimitsType.LAST_THIRTY_DAY_USAGE]?: number;
+}
+export interface Org {
+    id: string;
+    key: string;
+    secret?: string;
+    name: string;
+    createdAt: Date;
+    updatedAt: Date;
+    trialEndDate?: string;
+    lastTrialExtensionDate?: string;
+    limits?: OrgLimits;
+    lastThirtyDayUsagePercent?: number;
+    todayUsagePercent?: number;
+}
+export declare enum OrgUserRole {
+    Admin = "admin",
+    Member = "member"
+}
+export declare enum OrgUserStatus {
+    Invited = "invited",
+    Active = "active"
+}
+export interface PlatformUser {
+    id: string;
+    email: string;
+    name: string;
+    trialRequested: boolean;
+}
+export interface OrgUser {
+    id: string;
+    orgId: string;
+    userId: string;
+    role: OrgUserRole;
+    status: OrgUserStatus;
+    workspaces: string[];
+    user: PlatformUser;
+}
+export interface OrgWorkspace {
+    id: string;
+    key: string;
+    name: string;
+    orgId: string;
+    logoUri?: string;
+    secret: string;
+    createdAt: Date;
+    updatedAt: Date;
+    archivedAt?: Date;
+    trialEndDate?: string;
+    featureFlags?: string[];
+}

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

@@ -0,0 +1,9 @@
+import { ElementAccessor, ElementListAccessor } from '../accessors';
+import { IntegrationAppApiClient } from '../api-client';
+import { CreateScenarioRequest, FindScenariosQuery, UpdateScenarioRequest, Scenario } from './types';
+export declare class ScenariosAccessor extends ElementListAccessor<Scenario, FindScenariosQuery, CreateScenarioRequest> {
+    constructor(client: IntegrationAppApiClient);
+}
+export declare class ScenarioAccessor extends ElementAccessor<Scenario, UpdateScenarioRequest> {
+    constructor(client: IntegrationAppApiClient, selector: string);
+}

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

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

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

@@ -0,0 +1,145 @@
+import { CreateActionRequest } from '../actions';
+import { CreateAppDataSchemaRequest } from '../app-data-schemas';
+import { CreateAppEventTypeRequest } from '../app-events';
+import { MinimalConnector } from '../connectors';
+import { CreateDataLinkTableRequest } from '../data-links';
+import { CreateDataSourceRequest } from '../data-sources';
+import { SearchQuery, PaginationQuery } from '../entity-repository';
+import { CreateFieldMappingRequest } from '../field-mappings';
+import { CreateFlowRequest } from '../flows';
+import { IntegrationElementType } from '../integration-elements';
+import { Integration } from '../integrations';
+import { WorkspaceElement } from '../workspace-elements';
+export interface Scenario extends WorkspaceElement {
+    appId: string;
+    scenarioTemplateId?: string;
+    elements?: ScenarioElement[];
+    connectors?: MinimalConnector[];
+    todos?: ScenarioToDo[];
+    appliedToIntegrations?: Integration[];
+    archivedAt?: string;
+}
+export type ScenarioToDo = {
+    name: string;
+    description: string;
+    isComplete: boolean;
+};
+export type ScenarioElement = {
+    id: string;
+    type: IntegrationElementType;
+    element?: any;
+};
+export interface FindScenariosQuery extends SearchQuery, PaginationQuery {
+}
+export interface CreateScenarioRequest {
+    name: string;
+    key: string;
+    elements?: ScenarioElement[];
+    todos?: ScenarioToDo[];
+}
+export interface UpdateScenarioRequest {
+    name?: string;
+    key?: string;
+    elements?: ScenarioElement[];
+    todos?: ScenarioToDo[];
+}
+export interface ScenarioTemplate {
+    id: string;
+    name: string;
+    key: string;
+    shortDescription?: string;
+    description?: string;
+    demoWorkspaceKey?: string;
+    demoAppUri?: string;
+    demoGithubRepo?: string;
+    demoVideoYoutubeUri?: string;
+    tags?: ScenarioTemplateCategory[];
+    elements?: ScenarioTemplateElements;
+    todos?: Omit<ScenarioToDo, 'isComplete'>[];
+    connectors?: MinimalConnector[];
+    handyElements?: HandyScenarioTemplateElement[];
+}
+export declare enum ScenarioTemplateCategory {
+    DataExport = "data-export",
+    DataImport = "data-import",
+    BiDirectionalSync = "bi-directional-sync",
+    UnifiedApi = "unified-api",
+    DataEnrichment = "data-enrichment"
+}
+export interface FindScenarioTemplatesQuery extends SearchQuery, PaginationQuery {
+}
+export interface CreateScenarioTemplateRequest {
+    name: string;
+    shortDescription?: string;
+    description?: string;
+    demoWorkspaceKey?: string;
+    demoAppUri?: string;
+    demoGithubRepo?: string;
+    demoVideoYoutubeUri?: string;
+    tags?: string[];
+    elements?: ScenarioTemplateElements;
+    todos?: Omit<ScenarioToDo, 'isComplete'>[];
+}
+export interface UpdateScenarioTemplateRequest {
+    name?: string;
+    key?: string;
+    shortDescription?: string;
+    description?: string;
+    demoWorkspaceKey?: string;
+    demoAppUri?: string;
+    demoGithubRepo?: string;
+    demoVideoYoutubeUri?: string;
+    tags?: string[];
+    elements?: ScenarioTemplateElements;
+    todos?: Omit<ScenarioToDo, 'isComplete'>[];
+}
+export type ScenarioTemplateElementOverride = {
+    type: IntegrationElementType;
+    originalKey: string;
+    name: string;
+    key: string;
+};
+export type ScenarioTemplateKeyCollision = {
+    type: IntegrationElementType;
+    key: string;
+};
+export type ScenarioTemplateIntegration = {
+    id?: string;
+    connectorId: string;
+    key: string;
+    name: string;
+    logoUri: string;
+};
+type WithIntegrationKeys<T> = T & {
+    integrationKeys?: string[];
+};
+type ElementsExportFeilds = {
+    flows?: Record<string, WithIntegrationKeys<CreateFlowRequest>>;
+    actions?: Record<string, WithIntegrationKeys<CreateActionRequest>>;
+    fieldMappings?: Record<string, WithIntegrationKeys<CreateFieldMappingRequest>>;
+    dataSources?: Record<string, WithIntegrationKeys<CreateDataSourceRequest>>;
+    dataLinkTables?: Record<string, CreateDataLinkTableRequest>;
+    appEventTypes?: Record<string, CreateAppEventTypeRequest>;
+    appDataSchemas?: Record<string, CreateAppDataSchemaRequest>;
+};
+export type ScenarioTemplateElements = ElementsExportFeilds & {
+    integrations?: Record<string, ElementsExportFeilds & {
+        connectorId: string;
+    }>;
+};
+export interface HandyScenarioTemplateElement {
+    type: IntegrationElementType;
+    integration?: {
+        key: string;
+        connectorId: string;
+    };
+    integrations?: {
+        key: string;
+        connectorId: string;
+    }[];
+    fields: {
+        key: string;
+        name: string;
+    } & Record<string, any>;
+}
+export {};

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

@@ -0,0 +1,9 @@
+import { ElementAccessor, ElementListAccessor } from '../accessors';
+import { IntegrationAppApiClient } from '../api-client';
+import { Screen, ScreenSelector, CreateScreenRequest, FindScreensQuery, UpdateScreenRequest } from './types';
+export declare class ScreensAccessor extends ElementListAccessor<Screen, FindScreensQuery, CreateScreenRequest> {
+    constructor(client: IntegrationAppApiClient);
+}
+export declare class ScreenAccessor extends ElementAccessor<Screen, UpdateScreenRequest, ScreenSelector> {
+    constructor(client: IntegrationAppApiClient, selector: ScreenSelector | string);
+}

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

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

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

@@ -0,0 +1,37 @@
+import { PaginationQuery } from '../entity-repository';
+import { WorkspaceElement } from '../workspace-elements';
+export declare enum ScreenType {
+    Integration = "integration"
+}
+export declare enum ScreenBlockType {
+    Flow = "flow",
+    FieldMapping = "field-mapping",
+    DataSource = "data-source",
+    Action = "action"
+}
+export interface ScreenBlock {
+    type: ScreenBlockType;
+    [key: string]: any;
+}
+export interface ScreenSelector {
+    id?: string;
+    type?: ScreenType;
+    key?: string;
+    autoCreate?: boolean;
+    connectionId?: string;
+}
+export interface UpdateScreenRequest {
+    blocks?: ScreenBlock[];
+    key?: string;
+}
+export interface CreateScreenRequest extends UpdateScreenRequest {
+    type: ScreenType;
+}
+export interface FindScreensQuery extends PaginationQuery {
+    type?: ScreenType;
+}
+export interface Screen extends Omit<WorkspaceElement, 'key'> {
+    type: ScreenType;
+    key?: string;
+    blocks: ScreenBlock[];
+}

package/dist/dts/udm/activities.d.ts

@@ -0,0 +1,143 @@
+import { UnifiedDataModel } from './base';
+export declare const FIELDS_SCHEMA: {
+    type: string;
+    properties: {
+        id: {
+            type: string;
+            readOnly: boolean;
+        };
+        title: {
+            type: string;
+        };
+        description: {
+            type: string;
+        };
+        type: {
+            type: string;
+        };
+        durationSeconds: {
+            type: string;
+        };
+        location: {
+            type: string;
+        };
+        isRecurrent: {
+            type: string;
+        };
+        participants: {
+            type: string;
+            items: {
+                type: string;
+                properties: {
+                    userId: {
+                        type: string;
+                    };
+                    contactId: {
+                        type: string;
+                    };
+                };
+            };
+        };
+        status: {
+            type: string;
+        };
+        contactId: {
+            type: string;
+            referenceUdm: string;
+        };
+        companyId: {
+            type: string;
+            referenceUdm: string;
+        };
+        dealId: {
+            type: string;
+            referenceUdm: string;
+        };
+        leadId: {
+            type: string;
+            referenceUdm: string;
+        };
+        ownerId: {
+            type: string;
+            referenceUdm: string;
+        };
+        startTime: {
+            type: string;
+            format: string;
+        };
+        endTime: {
+            type: string;
+            format: string;
+        };
+        dueTime: {
+            type: string;
+            format: string;
+        };
+        createdTime: {
+            type: string;
+            format: string;
+            readOnly: boolean;
+        };
+        createdBy: {
+            type: string;
+            referenceUdm: string;
+            readOnly: boolean;
+        };
+        updatedTime: {
+            type: string;
+            format: string;
+            readOnly: boolean;
+        };
+        updatedBy: {
+            type: string;
+            referenceUdm: string;
+            readOnly: boolean;
+        };
+    };
+};
+export declare const FallbackFieldsMap: {
+    fromActivitiesToTasks: {
+        subject: {
+            $var: string;
+        };
+        content: {
+            $var: string;
+        };
+    };
+    fromTasksToActivities: {
+        title: {
+            $var: string;
+        };
+        description: {
+            $var: string;
+        };
+    };
+    fromActivitiesToNotes: {
+        content: {
+            $var: string;
+        };
+    };
+    fromNotesToActivities: {
+        description: {
+            $var: string;
+        };
+    };
+    fromActivitiesToEmails: {
+        subject: {
+            $var: string;
+        };
+        body: {
+            $var: string;
+        };
+    };
+    fromEmailsToActivities: {
+        title: {
+            $var: string;
+        };
+        description: {
+            $var: string;
+        };
+    };
+};
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/activities.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/dts/udm/base.d.ts

@@ -0,0 +1,62 @@
+import { DataCollectionCreateSpec, DataCollectionDeleteSpec, DataCollectionFindSpec, DataCollectionListSpec, DataCollectionMatchSpec, DataCollectionUpdateSpec } from '../connectors/data-locations';
+import { CONNECTOR_CATEGORIES } from '../connectors/types';
+export interface UnifiedDataModel {
+    singularName: string;
+    pluralName: string;
+    fieldsSchema: any;
+    description?: string;
+    categories?: (typeof CONNECTOR_CATEGORIES)[number][];
+    normalizeFields?: (fields: Record<string, any>) => Record<string, any>;
+    populateFields?: (fields: Record<string, any>) => Record<string, any>;
+    list?: DataCollectionListSpec;
+    find?: DataCollectionFindSpec;
+    match?: DataCollectionMatchSpec;
+    create?: DataCollectionCreateSpec;
+    update?: DataCollectionUpdateSpec;
+    delete?: DataCollectionDeleteSpec;
+    udmFallbacks?: Array<UDMFallback>;
+    fieldFallbacks?: Record<string, FieldFallbackValues>;
+}
+export interface UDMFallback {
+    udm: string;
+    importFields?: Record<string, any>;
+    exportFields?: Record<string, any>;
+}
+export type FieldFallbackValues = any[];
+export declare const AddressSchema: {
+    type: string;
+    properties: {
+        type: {
+            type: string;
+        };
+        full: {
+            type: string;
+        };
+        street: {
+            type: string;
+        };
+        city: {
+            type: string;
+        };
+        state: {
+            type: string;
+        };
+        country: {
+            type: string;
+        };
+        zip: {
+            type: string;
+        };
+    };
+};
+export declare const PhoneEmailSchema: {
+    type: string;
+    properties: {
+        value: {
+            type: string;
+        };
+        type: {
+            type: string;
+        };
+    };
+};

package/dist/dts/udm/bills.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/campaign-members.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/campaigns.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/companies.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/contact-lists.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/contacts.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/credit-notes.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/customers.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/deal-products.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/deal-stages.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/deals.d.ts

@@ -0,0 +1,3 @@
+import { UnifiedDataModel } from './base';
+declare const udm: UnifiedDataModel;
+export default udm;

package/dist/dts/udm/documents.d.ts

@@ -0,0 +1,59 @@
+import { UnifiedDataModel } from './base';
+export declare const FIELDS_SCHEMA: {
+    type: string;
+    properties: {
+        id: {
+            type: string;
+            readOnly: boolean;
+        };
+        uri: {
+            type: string;
+            readOnly: boolean;
+        };
+        title: {
+            type: string;
+        };
+        parentDocumentId: {
+            type: string;
+            referenceUdm: string;
+        };
+        canHaveChildren: {
+            type: string;
+            readOnly: boolean;
+        };
+        isDownloadable: {
+            type: string;
+            readOnly: boolean;
+            default: boolean;
+        };
+        text: {
+            type: string;
+        };
+        ownerId: {
+            type: string;
+            referenceUdm: string;
+        };
+        createdTime: {
+            type: string;
+            format: string;
+            readOnly: boolean;
+        };
+        createdBy: {
+            type: string;
+            referenceUdm: string;
+            readOnly: boolean;
+        };
+        updatedTime: {
+            type: string;
+            format: string;
+            readOnly: boolean;
+        };
+        updatedBy: {
+            type: string;
+            referenceUdm: string;
+            readOnly: boolean;
+        };
+    };
+};
+declare const udm: UnifiedDataModel;
+export default udm;