@membranehq/sdk 0.4.0 → 0.5.0

package/dist/dts/workspace-elements/api/scenarios-api.d.ts

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 import { CreateActionRequest } from './actions-api';
 import { CreateAppDataSchemaRequest } from './app-data-schemas-api';
 import { CreateAppEventTypeRequest } from './app-event-types-api';
@@ -7,39 +8,163 @@ import { CreateFieldMappingRequest } from './field-mappings-api';
 import { CreateFlowRequest } from './flows-api';
 import { SearchQuery, PaginationQuery } from '../../entity-repository';
 import { IntegrationElementType } from '../../integration-elements';
-import { BaseIntegration } from '../base/integrations';
-import { BaseScenario } from '../base/scenarios';
-export declare enum ScenarioTemplateCategory {
-    DataExport = "data-export",
-    DataImport = "data-import",
-    BiDirectionalSync = "bi-directional-sync",
-    UnifiedApi = "unified-api",
-    DataEnrichment = "data-enrichment"
-}
-export type ScenarioToDo = {
+export declare const ScenarioToDoApi: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodString;
+    isComplete: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
     name: string;
     description: string;
     isComplete: boolean;
-};
-export type ScenarioElement = {
+}, {
+    name: string;
+    description: string;
+    isComplete: boolean;
+}>;
+export type ScenarioToDoApi = z.infer<typeof ScenarioToDoApi>;
+export declare const ScenarioElementApi: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodNativeEnum<typeof IntegrationElementType>;
+    element: z.ZodOptional<z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    type: IntegrationElementType;
     id: string;
+    element?: any;
+}, {
     type: IntegrationElementType;
+    id: string;
     element?: any;
-};
-export interface FindScenariosQuery extends SearchQuery, PaginationQuery {
-}
-export interface CreateScenarioRequest {
+}>;
+export type ScenarioElementApi = z.infer<typeof ScenarioElementApi>;
+export declare const FindScenariosQuery: z.ZodObject<{
+    search: z.ZodOptional<z.ZodString>;
+} & {
+    limit: z.ZodOptional<z.ZodNumber>;
+    cursor: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    search?: string | undefined;
+    limit?: number | undefined;
+    cursor?: string | undefined;
+}, {
+    search?: string | undefined;
+    limit?: number | undefined;
+    cursor?: string | undefined;
+}>;
+export type FindScenariosQuery = z.infer<typeof FindScenariosQuery>;
+export declare const CreateScenarioRequest: z.ZodObject<{
+    name: z.ZodString;
+    key: z.ZodString;
+    elements: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodNativeEnum<typeof IntegrationElementType>;
+        element: z.ZodOptional<z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: IntegrationElementType;
+        id: string;
+        element?: any;
+    }, {
+        type: IntegrationElementType;
+        id: string;
+        element?: any;
+    }>, "many">>;
+    todos: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        isComplete: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }, {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    key: string;
     name: string;
+    elements?: {
+        type: IntegrationElementType;
+        id: string;
+        element?: any;
+    }[] | undefined;
+    todos?: {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }[] | undefined;
+}, {
     key: string;
-    elements?: ScenarioElement[];
-    todos?: ScenarioToDo[];
-}
-export interface UpdateScenarioRequest {
-    name?: string;
-    key?: string;
-    elements?: ScenarioElement[];
-    todos?: ScenarioToDo[];
-}
+    name: string;
+    elements?: {
+        type: IntegrationElementType;
+        id: string;
+        element?: any;
+    }[] | undefined;
+    todos?: {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }[] | undefined;
+}>;
+export type CreateScenarioRequest = z.infer<typeof CreateScenarioRequest>;
+export declare const UpdateScenarioRequest: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodString>;
+    elements: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodNativeEnum<typeof IntegrationElementType>;
+        element: z.ZodOptional<z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: IntegrationElementType;
+        id: string;
+        element?: any;
+    }, {
+        type: IntegrationElementType;
+        id: string;
+        element?: any;
+    }>, "many">>;
+    todos: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        isComplete: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }, {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    key?: string | undefined;
+    name?: string | undefined;
+    elements?: {
+        type: IntegrationElementType;
+        id: string;
+        element?: any;
+    }[] | undefined;
+    todos?: {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }[] | undefined;
+}, {
+    key?: string | undefined;
+    name?: string | undefined;
+    elements?: {
+        type: IntegrationElementType;
+        id: string;
+        element?: any;
+    }[] | undefined;
+    todos?: {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }[] | undefined;
+}>;
+export type UpdateScenarioRequest = z.infer<typeof UpdateScenarioRequest>;
 export interface FindScenarioTemplatesQuery extends SearchQuery, PaginationQuery {
 }
 export interface CreateScenarioTemplateRequest {
@@ -51,8 +176,8 @@ export interface CreateScenarioTemplateRequest {
     demoGithubRepo?: string;
     demoVideoYoutubeUri?: string;
     tags?: string[];
-    elements?: ScenarioTemplateElements;
-    todos?: Omit<ScenarioToDo, 'isComplete'>[];
+    elements?: ScenarioTemplateElementsApi;
+    todos?: Omit<ScenarioToDoApi, 'isComplete'>[];
 }
 export interface UpdateScenarioTemplateRequest {
     name?: string;
@@ -64,8 +189,8 @@ export interface UpdateScenarioTemplateRequest {
     demoGithubRepo?: string;
     demoVideoYoutubeUri?: string;
     tags?: string[];
-    elements?: ScenarioTemplateElements;
-    todos?: Omit<ScenarioToDo, 'isComplete'>[];
+    elements?: ScenarioTemplateElementsApi;
+    todos?: Omit<ScenarioToDoApi, 'isComplete'>[];
 }
 export type ScenarioTemplateElementOverride = {
     type: IntegrationElementType;
@@ -96,12 +221,12 @@ type ElementsExportFields = {
     appEventTypes?: Record<string, CreateAppEventTypeRequest>;
     appDataSchemas?: Record<string, CreateAppDataSchemaRequest>;
 };
-export type ScenarioTemplateElements = ElementsExportFields & {
+export type ScenarioTemplateElementsApi = ElementsExportFields & {
     integrations?: Record<string, ElementsExportFields & {
         connectorId: string;
     }>;
 };
-export interface HandyScenarioTemplateElement {
+export interface HandyScenarioTemplateElementApi {
     type: IntegrationElementType;
     integration?: {
         key: string;
@@ -116,8 +241,246 @@ export interface HandyScenarioTemplateElement {
         name: string;
     } & Record<string, any>;
 }
-export interface Scenario extends BaseScenario {
-    appliedToIntegrations?: BaseIntegration[];
-}
+export declare const Scenario: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+} & {
+    key: z.ZodString;
+    state: z.ZodOptional<z.ZodNativeEnum<typeof import("..").WorkspaceElementState>>;
+    errors: z.ZodOptional<z.ZodArray<any, "many">>;
+} & {
+    appId: z.ZodString;
+    scenarioTemplateId: z.ZodOptional<z.ZodString>;
+    elements: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodString;
+        element: z.ZodOptional<z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        id: string;
+        element?: any;
+    }, {
+        type: string;
+        id: string;
+        element?: any;
+    }>, "many">>;
+    connectors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        key: z.ZodString;
+        name: z.ZodString;
+        logoUri: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        key: string;
+        id: string;
+        name: string;
+        logoUri: string;
+    }, {
+        key: string;
+        id: string;
+        name: string;
+        logoUri: string;
+    }>, "many">>;
+    todos: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        isComplete: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }, {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }>, "many">>;
+    archivedAt: z.ZodOptional<z.ZodString>;
+} & {
+    appliedToIntegrations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+    } & {
+        key: z.ZodString;
+        state: z.ZodOptional<z.ZodNativeEnum<typeof import("..").WorkspaceElementState>>;
+        errors: z.ZodOptional<z.ZodArray<any, "many">>;
+    } & {
+        logoUri: z.ZodString;
+        connectorId: z.ZodOptional<z.ZodString>;
+        connectorVersion: z.ZodOptional<z.ZodString>;
+        authOptions: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+        oAuthCallbackUri: z.ZodOptional<z.ZodString>;
+        parametersSchema: z.ZodOptional<z.ZodType<import("../..").DataSchema, z.ZodTypeDef, import("../..").DataSchema>>;
+        parameters: z.ZodOptional<z.ZodAny>;
+        baseUri: z.ZodString;
+        archivedAt: z.ZodOptional<z.ZodString>;
+        hasMissingParameters: z.ZodOptional<z.ZodBoolean>;
+        hasDocumentation: z.ZodOptional<z.ZodBoolean>;
+        hasOperations: z.ZodOptional<z.ZodBoolean>;
+        hasData: z.ZodOptional<z.ZodBoolean>;
+        hasEvents: z.ZodOptional<z.ZodBoolean>;
+        hasGlobalWebhooks: z.ZodOptional<z.ZodBoolean>;
+        hasUdm: z.ZodOptional<z.ZodBoolean>;
+        isTest: z.ZodOptional<z.ZodBoolean>;
+        appUuid: z.ZodOptional<z.ZodString>;
+        isDeactivated: z.ZodOptional<z.ZodBoolean>;
+        authType: z.ZodOptional<z.ZodEnum<["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"]>>;
+    }, "strip", z.ZodTypeAny, {
+        key: string;
+        id: string;
+        name: string;
+        baseUri: string;
+        logoUri: string;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        parameters?: any;
+        parametersSchema?: import("../..").DataSchema | undefined;
+        archivedAt?: string | undefined;
+        isTest?: boolean | undefined;
+        connectorId?: string | undefined;
+        connectorVersion?: string | undefined;
+        authOptions?: any[] | undefined;
+        oAuthCallbackUri?: string | undefined;
+        hasMissingParameters?: boolean | undefined;
+        hasDocumentation?: boolean | undefined;
+        hasOperations?: boolean | undefined;
+        hasData?: boolean | undefined;
+        hasEvents?: boolean | undefined;
+        hasGlobalWebhooks?: boolean | undefined;
+        hasUdm?: boolean | undefined;
+        appUuid?: string | undefined;
+        isDeactivated?: boolean | undefined;
+        authType?: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials" | undefined;
+    }, {
+        key: string;
+        id: string;
+        name: string;
+        baseUri: string;
+        logoUri: string;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        parameters?: any;
+        parametersSchema?: import("../..").DataSchema | undefined;
+        archivedAt?: string | undefined;
+        isTest?: boolean | undefined;
+        connectorId?: string | undefined;
+        connectorVersion?: string | undefined;
+        authOptions?: any[] | undefined;
+        oAuthCallbackUri?: string | undefined;
+        hasMissingParameters?: boolean | undefined;
+        hasDocumentation?: boolean | undefined;
+        hasOperations?: boolean | undefined;
+        hasData?: boolean | undefined;
+        hasEvents?: boolean | undefined;
+        hasGlobalWebhooks?: boolean | undefined;
+        hasUdm?: boolean | undefined;
+        appUuid?: string | undefined;
+        isDeactivated?: boolean | undefined;
+        authType?: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials" | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    key: string;
+    id: string;
+    name: string;
+    appId: string;
+    state?: import("..").WorkspaceElementState | undefined;
+    errors?: any[] | undefined;
+    archivedAt?: string | undefined;
+    appliedToIntegrations?: {
+        key: string;
+        id: string;
+        name: string;
+        baseUri: string;
+        logoUri: string;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        parameters?: any;
+        parametersSchema?: import("../..").DataSchema | undefined;
+        archivedAt?: string | undefined;
+        isTest?: boolean | undefined;
+        connectorId?: string | undefined;
+        connectorVersion?: string | undefined;
+        authOptions?: any[] | undefined;
+        oAuthCallbackUri?: string | undefined;
+        hasMissingParameters?: boolean | undefined;
+        hasDocumentation?: boolean | undefined;
+        hasOperations?: boolean | undefined;
+        hasData?: boolean | undefined;
+        hasEvents?: boolean | undefined;
+        hasGlobalWebhooks?: boolean | undefined;
+        hasUdm?: boolean | undefined;
+        appUuid?: string | undefined;
+        isDeactivated?: boolean | undefined;
+        authType?: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials" | undefined;
+    }[] | undefined;
+    scenarioTemplateId?: string | undefined;
+    elements?: {
+        type: string;
+        id: string;
+        element?: any;
+    }[] | undefined;
+    connectors?: {
+        key: string;
+        id: string;
+        name: string;
+        logoUri: string;
+    }[] | undefined;
+    todos?: {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }[] | undefined;
+}, {
+    key: string;
+    id: string;
+    name: string;
+    appId: string;
+    state?: import("..").WorkspaceElementState | undefined;
+    errors?: any[] | undefined;
+    archivedAt?: string | undefined;
+    appliedToIntegrations?: {
+        key: string;
+        id: string;
+        name: string;
+        baseUri: string;
+        logoUri: string;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        parameters?: any;
+        parametersSchema?: import("../..").DataSchema | undefined;
+        archivedAt?: string | undefined;
+        isTest?: boolean | undefined;
+        connectorId?: string | undefined;
+        connectorVersion?: string | undefined;
+        authOptions?: any[] | undefined;
+        oAuthCallbackUri?: string | undefined;
+        hasMissingParameters?: boolean | undefined;
+        hasDocumentation?: boolean | undefined;
+        hasOperations?: boolean | undefined;
+        hasData?: boolean | undefined;
+        hasEvents?: boolean | undefined;
+        hasGlobalWebhooks?: boolean | undefined;
+        hasUdm?: boolean | undefined;
+        appUuid?: string | undefined;
+        isDeactivated?: boolean | undefined;
+        authType?: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials" | undefined;
+    }[] | undefined;
+    scenarioTemplateId?: string | undefined;
+    elements?: {
+        type: string;
+        id: string;
+        element?: any;
+    }[] | undefined;
+    connectors?: {
+        key: string;
+        id: string;
+        name: string;
+        logoUri: string;
+    }[] | undefined;
+    todos?: {
+        name: string;
+        description: string;
+        isComplete: boolean;
+    }[] | undefined;
+}>;
+export type Scenario = z.infer<typeof Scenario>;
 export type ScenarioApiResponse = Scenario;
 export {};

package/dist/dts/workspace-elements/api/screens-api.d.ts

@@ -9,7 +9,7 @@ export declare enum ScreenBlockType {
     DataSource = "data-source",
     Action = "action"
 }
-export interface ScreenBlock {
+export interface ScreenBlockApi {
     type: ScreenBlockType;
     [key: string]: any;
 }
@@ -21,7 +21,7 @@ export interface ScreenSelector {
     connectionId?: string;
 }
 export interface UpdateScreenRequest {
-    blocks?: ScreenBlock[];
+    blocks?: ScreenBlockApi[];
     key?: string;
 }
 export interface CreateScreenRequest extends UpdateScreenRequest {

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

@@ -1,30 +1,77 @@
+import { z } from 'zod';
 import { WorkspaceElementState } from '../../types';
 import { ActionType } from '../actions/action-types';
 export declare enum ActionDependencyType {
     FieldMapping = "FieldMapping",
     DataSource = "DataSource"
 }
-export interface ActionDependency {
+export declare const ActionDependency: z.ZodObject<{
+    type: z.ZodNativeEnum<typeof ActionDependencyType>;
+    key: z.ZodString;
+    element: z.ZodOptional<z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    key: string;
     type: ActionDependencyType;
+    element?: any;
+}, {
     key: string;
+    type: ActionDependencyType;
     element?: any;
-}
-export interface BaseActionInstance {
+}>;
+export type ActionDependency = z.infer<typeof ActionDependency>;
+export declare const BaseActionInstance: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    revision: z.ZodString;
+    parentId: z.ZodOptional<z.ZodString>;
+    parentRevision: z.ZodOptional<z.ZodString>;
+    universalParentId: z.ZodOptional<z.ZodString>;
+    userId: z.ZodString;
+    instanceKey: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodOptional<z.ZodString>;
+    updatedAt: z.ZodOptional<z.ZodString>;
+    archivedAt: z.ZodOptional<z.ZodString>;
+    type: z.ZodNativeEnum<typeof ActionType>;
+    inputSchema: z.ZodOptional<z.ZodAny>;
+    config: z.ZodOptional<z.ZodAny>;
+    outputSchema: z.ZodOptional<z.ZodAny>;
+    isOutdated: z.ZodOptional<z.ZodBoolean>;
+    state: z.ZodNativeEnum<typeof WorkspaceElementState>;
+}, "strip", z.ZodTypeAny, {
+    type: ActionType;
     id: string;
     name: string;
-    revision: string;
-    parentId?: string;
-    parentRevision?: string;
-    universalParentId?: string;
+    state: WorkspaceElementState;
     userId: string;
-    instanceKey?: string;
-    createdAt?: string;
-    updatedAt?: string;
-    archivedAt?: string;
-    type: ActionType;
+    revision: string;
+    instanceKey?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    archivedAt?: string | undefined;
+    parentId?: string | undefined;
+    parentRevision?: string | undefined;
     inputSchema?: any;
     config?: any;
     outputSchema?: any;
-    isOutdated?: boolean;
+    universalParentId?: string | undefined;
+    isOutdated?: boolean | undefined;
+}, {
+    type: ActionType;
+    id: string;
+    name: string;
     state: WorkspaceElementState;
-}
+    userId: string;
+    revision: string;
+    instanceKey?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    archivedAt?: string | undefined;
+    parentId?: string | undefined;
+    parentRevision?: string | undefined;
+    inputSchema?: any;
+    config?: any;
+    outputSchema?: any;
+    universalParentId?: string | undefined;
+    isOutdated?: boolean | undefined;
+}>;
+export type BaseActionInstance = z.infer<typeof BaseActionInstance>;

package/dist/dts/workspace-elements/base/action-run-log-records/types.d.ts

@@ -1,19 +1,42 @@
-import { ErrorData } from '../../../errors';
+import { z } from 'zod';
 export declare enum ActionRunStatus {
     RUNNING = "running",
     SUCCESS = "success",
     ERROR = "error",
     QUEUED = "queued"
 }
-export interface BaseActionRunLogRecord {
+export declare const BaseActionRunLogRecord: z.ZodObject<{
+    id: z.ZodString;
+    actionId: z.ZodString;
+    integrationId: z.ZodString;
+    connectionId: z.ZodString;
+    input: z.ZodOptional<z.ZodAny>;
+    output: z.ZodOptional<z.ZodAny>;
+    status: z.ZodNativeEnum<typeof ActionRunStatus>;
+    startedAt: z.ZodString;
+    completedAt: z.ZodOptional<z.ZodString>;
+    error: any;
+}, "strip", z.ZodTypeAny, {
+    status: ActionRunStatus;
     id: string;
-    actionId: string;
-    integrationId: string;
     connectionId: string;
+    integrationId: string;
+    actionId: string;
+    startedAt: string;
+    error?: any;
     input?: any;
     output?: any;
+    completedAt?: string | undefined;
+}, {
     status: ActionRunStatus;
+    id: string;
+    connectionId: string;
+    integrationId: string;
+    actionId: string;
     startedAt: string;
-    completedAt?: string;
-    error?: ErrorData;
-}
+    error?: any;
+    input?: any;
+    output?: any;
+    completedAt?: string | undefined;
+}>;
+export type BaseActionRunLogRecord = z.infer<typeof BaseActionRunLogRecord>;