@membranehq/sdk 0.3.0 → 0.5.0

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

@@ -0,0 +1,486 @@
+import { z } from 'zod';
+import { CreateActionRequest } from './actions-api';
+import { CreateAppDataSchemaRequest } from './app-data-schemas-api';
+import { CreateAppEventTypeRequest } from './app-event-types-api';
+import { CreateDataLinkTableRequest } from './data-link-tables-api';
+import { CreateDataSourceRequest } from './data-sources-api';
+import { CreateFieldMappingRequest } from './field-mappings-api';
+import { CreateFlowRequest } from './flows-api';
+import { SearchQuery, PaginationQuery } from '../../entity-repository';
+import { IntegrationElementType } from '../../integration-elements';
+export declare const ScenarioToDoApi: 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;
+}>;
+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 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;
+    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 {
+    name: string;
+    shortDescription?: string;
+    description?: string;
+    demoWorkspaceKey?: string;
+    demoAppUri?: string;
+    demoGithubRepo?: string;
+    demoVideoYoutubeUri?: string;
+    tags?: string[];
+    elements?: ScenarioTemplateElementsApi;
+    todos?: Omit<ScenarioToDoApi, 'isComplete'>[];
+}
+export interface UpdateScenarioTemplateRequest {
+    name?: string;
+    key?: string;
+    shortDescription?: string;
+    description?: string;
+    demoWorkspaceKey?: string;
+    demoAppUri?: string;
+    demoGithubRepo?: string;
+    demoVideoYoutubeUri?: string;
+    tags?: string[];
+    elements?: ScenarioTemplateElementsApi;
+    todos?: Omit<ScenarioToDoApi, '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 ElementsExportFields = {
+    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 ScenarioTemplateElementsApi = ElementsExportFields & {
+    integrations?: Record<string, ElementsExportFields & {
+        connectorId: string;
+    }>;
+};
+export interface HandyScenarioTemplateElementApi {
+    type: IntegrationElementType;
+    integration?: {
+        key: string;
+        connectorId: string;
+    };
+    integrations?: {
+        key: string;
+        connectorId: string;
+    }[];
+    fields: {
+        key: string;
+        name: string;
+    } & Record<string, any>;
+}
+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/{screens/types.d.ts → workspace-elements/api/screens-api.d.ts}

@@ -1,5 +1,5 @@
-import { PaginationQuery } from '../entity-repository';
-import { WorkspaceElement } from '../workspace-elements';
+import { PaginationQuery } from '../../entity-repository';
+import { BaseScreen } from '../base/screens';
 export declare enum ScreenType {
     Integration = "integration"
 }
@@ -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 {
@@ -30,8 +30,6 @@ export interface CreateScreenRequest extends UpdateScreenRequest {
 export interface FindScreensQuery extends PaginationQuery {
     type?: ScreenType;
 }
-export interface Screen extends Omit<WorkspaceElement, 'key'> {
-    type: ScreenType;
-    key?: string;
-    blocks: ScreenBlock[];
+export interface Screen extends BaseScreen {
 }
+export type ScreenApiResponse = Screen;

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

@@ -0,0 +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 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 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;
+    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;
+}, {
+    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

@@ -0,0 +1,42 @@
+import { z } from 'zod';
+export declare enum ActionRunStatus {
+    RUNNING = "running",
+    SUCCESS = "success",
+    ERROR = "error",
+    QUEUED = "queued"
+}
+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;
+    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;
+    error?: any;
+    input?: any;
+    output?: any;
+    completedAt?: string | undefined;
+}>;
+export type BaseActionRunLogRecord = z.infer<typeof BaseActionRunLogRecord>;

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

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