@membranehq/sdk 0.7.1 → 0.7.4

package/dist/dts/accessors/connections-accessors.d.ts

@@ -45,8 +45,8 @@ export declare class ConnectionAccessor {
         name: string;
         createdAt: string;
         updatedAt: string;
-        userId: string;
         integrationId: string;
+        userId: string;
         error?: import("../errors").ErrorDataSchema | undefined;
         integration?: {
             id: string;
@@ -55,6 +55,7 @@ export declare class ConnectionAccessor {
             key?: string | undefined;
             uuid?: string | undefined;
             description?: string | undefined;
+            meta?: Record<string, any> | undefined;
             state?: import("..").WorkspaceElementState | undefined;
             errors?: import("../errors").ErrorDataSchema[] | undefined;
             revision?: string | undefined;
@@ -80,8 +81,8 @@ export declare class ConnectionAccessor {
             appUuid?: string | undefined;
             authType?: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials" | undefined;
         } | undefined;
+        meta?: Record<string, any> | undefined;
         state?: import("..").WorkspaceElementState | undefined;
-        errors?: import("../errors").ErrorDataSchema[] | undefined;
         archivedAt?: string | undefined;
         isDeactivated?: boolean | undefined;
         authOptionKey?: string | undefined;
@@ -89,6 +90,7 @@ export declare class ConnectionAccessor {
             id: string;
             name: string;
             internalId: string;
+            meta?: Record<string, any> | undefined;
             createdAt?: string | undefined;
             archivedAt?: string | undefined;
             credentials?: any;
@@ -98,7 +100,6 @@ export declare class ConnectionAccessor {
             isBillable?: boolean | undefined;
         } | undefined;
         isTest?: boolean | undefined;
-        meta?: Record<string, any> | undefined;
         disconnected?: boolean | undefined;
         isDefunct?: boolean | undefined;
         lastActiveAt?: string | undefined;

package/dist/dts/accessors/integrations-accessors.d.ts

@@ -49,8 +49,8 @@ export declare class IntegrationAccessor extends ElementAccessor<Integration, Up
         name: string;
         createdAt: string;
         updatedAt: string;
-        userId: string;
         integrationId: string;
+        userId: string;
         error?: import("..").ErrorDataSchema | undefined;
         integration?: {
             id: string;
@@ -59,6 +59,7 @@ export declare class IntegrationAccessor extends ElementAccessor<Integration, Up
             key?: string | undefined;
             uuid?: string | undefined;
             description?: string | undefined;
+            meta?: Record<string, any> | undefined;
             state?: import("..").WorkspaceElementState | undefined;
             errors?: import("..").ErrorDataSchema[] | undefined;
             revision?: string | undefined;
@@ -84,8 +85,8 @@ export declare class IntegrationAccessor extends ElementAccessor<Integration, Up
             appUuid?: string | undefined;
             authType?: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials" | undefined;
         } | undefined;
+        meta?: Record<string, any> | undefined;
         state?: import("..").WorkspaceElementState | undefined;
-        errors?: import("..").ErrorDataSchema[] | undefined;
         archivedAt?: string | undefined;
         isDeactivated?: boolean | undefined;
         authOptionKey?: string | undefined;
@@ -93,6 +94,7 @@ export declare class IntegrationAccessor extends ElementAccessor<Integration, Up
             id: string;
             name: string;
             internalId: string;
+            meta?: Record<string, any> | undefined;
             createdAt?: string | undefined;
             archivedAt?: string | undefined;
             credentials?: any;
@@ -102,7 +104,6 @@ export declare class IntegrationAccessor extends ElementAccessor<Integration, Up
             isBillable?: boolean | undefined;
         } | undefined;
         isTest?: boolean | undefined;
-        meta?: Record<string, any> | undefined;
         disconnected?: boolean | undefined;
         isDefunct?: boolean | undefined;
         lastActiveAt?: string | undefined;

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

@@ -1,9 +1,10 @@
 import { MembraneApiClient } from '../api-client';
 import { ElementAccessor, ElementListAccessor } from './base-accessors';
-import { CreateScenarioRequest, FindScenariosQuery, Scenario, UpdateScenarioRequest } from '../workspace-elements/api/scenarios-api';
-export declare class ScenariosAccessor extends ElementListAccessor<Scenario, FindScenariosQuery, CreateScenarioRequest> {
+import { ScenarioEditableProperties } from '../workspace-elements';
+import { FindScenariosQuery, Scenario } from '../workspace-elements/api/scenarios-api';
+export declare class ScenariosAccessor extends ElementListAccessor<Scenario, FindScenariosQuery, ScenarioEditableProperties> {
     constructor(client: MembraneApiClient);
 }
-export declare class ScenarioAccessor extends ElementAccessor<Scenario, UpdateScenarioRequest> {
+export declare class ScenarioAccessor extends ElementAccessor<Scenario, Partial<ScenarioEditableProperties>> {
     constructor(client: MembraneApiClient, selector: string);
 }

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

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

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

@@ -0,0 +1,42 @@
+import { z } from 'zod';
+export declare const CONFIG_FILE_NAME = "membrane.config.yml";
+export declare const membraneConfigSchema: z.ZodObject<{
+    workspaceKey: z.ZodString;
+    workspaceSecret: z.ZodString;
+    apiUri: z.ZodOptional<z.ZodString>;
+    testCustomerId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    workspaceKey: string;
+    workspaceSecret: string;
+    apiUri?: string | undefined;
+    testCustomerId?: string | undefined;
+}, {
+    workspaceKey: string;
+    workspaceSecret: string;
+    apiUri?: string | undefined;
+    testCustomerId?: string | undefined;
+}>;
+export type MembraneConfig = z.infer<typeof membraneConfigSchema>;
+export type PartialMembraneConfig = Partial<MembraneConfig>;
+export interface LoadConfigOptions {
+    validate?: boolean;
+    useCache?: boolean;
+}
+export declare class MembraneConfigLoader {
+    private cachedConfig;
+    private cwd;
+    constructor(cwd?: string);
+    loadConfig(options?: LoadConfigOptions): PartialMembraneConfig;
+    hasValidConfig(): boolean;
+    hasWorkspaceCredentials(): boolean;
+    clearCache(): void;
+    updateConfig(newConfig: PartialMembraneConfig): PartialMembraneConfig;
+    saveToFile(config: PartialMembraneConfig): boolean;
+    getCwd(): string;
+    setCwd(newCwd: string): void;
+    private loadFromFile;
+    private loadFromEnv;
+}
+export declare function getDefaultMembraneConfigLoader(): MembraneConfigLoader;
+export declare function loadMembraneConfig(cwd?: string, options?: LoadConfigOptions): PartialMembraneConfig;
+export declare function hasMembraneCredentials(cwd?: string): boolean;

package/dist/dts/entity-repository.d.ts

@@ -77,12 +77,12 @@ export declare const CommonIntegrationOrConnectionQuery: z.ZodObject<{
     integrationId: z.ZodOptional<z.ZodString>;
     integrationKey: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    connectionId?: string | undefined;
     integrationId?: string | undefined;
+    connectionId?: string | undefined;
     integrationKey?: string | undefined;
 }, {
-    connectionId?: string | undefined;
     integrationId?: string | undefined;
+    connectionId?: string | undefined;
     integrationKey?: string | undefined;
 }>;
 export type CommonIntegrationOrConnectionQuery = z.infer<typeof CommonIntegrationOrConnectionQuery>;

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

@@ -0,0 +1,31 @@
+export * from './errors';
+export * from './workspace-elements';
+export * from './workspace-elements-catalog';
+export * from './auth';
+export * from './connector-copilot';
+export * from './data-builder';
+export * from './data-filter';
+export * from './formulas';
+export * from './locators';
+export * from './error-tools';
+export * from './data-form';
+export * from './data-schema';
+export * from './data-schema-utils';
+export * from './date-time';
+export * from './entity-repository';
+export * from './http-requests';
+export * from './integration-elements';
+export * from './logging';
+export * from './usage';
+export * from './variables';
+export * from './workspaces';
+export * from './apps';
+export * from './workspace-updates';
+export * from './orgs';
+export * from './webhooks';
+export * from './alerts';
+export * from './accessors';
+export * from './sse';
+export * from './scenario-templates';
+export { MembraneClient as IntegrationAppClient } from './client';
+export { MembraneClient as MembraneClient } from './client';

package/dist/dts/index.d.ts

@@ -26,5 +26,7 @@ export * from './webhooks';
 export * from './alerts';
 export * from './accessors';
 export * from './sse';
+export * from './scenario-templates';
+export * from './config';
 export { MembraneClient as IntegrationAppClient } from './client';
 export { MembraneClient as MembraneClient } from './client';

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

@@ -0,0 +1,2 @@
+export * from './index.browser';
+export * from './config';

package/dist/dts/integration-elements/index.d.ts

@@ -27,7 +27,6 @@ export interface ElementTemplateFields {
     integrationId?: string;
     integration?: Integration;
     parentId?: string;
-    parentRevision?: string;
     isCustomized?: boolean;
     createdAt?: string;
     updatedAt?: string;
@@ -38,7 +37,6 @@ export interface ElementInstanceFields {
     name: string;
     revision: string;
     parentId?: string;
-    parentRevision?: string;
     universalParentId?: string;
     userId: string;
     user?: Customer;

package/dist/dts/{workspace-elements/base/scenarios/types.d.ts → scenario-templates/index.d.ts}

@@ -1,4 +1,6 @@
 import { z } from 'zod';
+import { SearchQuery, PaginationQuery } from '../entity-repository';
+import { IntegrationElementType } from '../integration-elements';
 export declare enum ScenarioTemplateCategory {
     DataExport = "data-export",
     DataImport = "data-import",
@@ -6,156 +8,6 @@ export declare enum ScenarioTemplateCategory {
     UnifiedApi = "unified-api",
     DataEnrichment = "data-enrichment"
 }
-export declare const ScenarioToDo: 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 ScenarioToDo = z.infer<typeof ScenarioToDo>;
-export declare const ScenarioElement: 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;
-}>;
-export type ScenarioElement = z.infer<typeof ScenarioElement>;
-export declare const BaseScenario: z.ZodObject<{
-    id: z.ZodString;
-    key: z.ZodOptional<z.ZodString>;
-    uuid: z.ZodOptional<z.ZodString>;
-    description: z.ZodOptional<z.ZodString>;
-    name: z.ZodString;
-    state: z.ZodOptional<z.ZodNativeEnum<typeof import("../../types").WorkspaceElementState>>;
-    errors: z.ZodOptional<z.ZodArray<z.ZodType<import("../../..").ErrorDataSchema, z.ZodTypeDef, import("../../..").ErrorDataSchema>, "many">>;
-    revision: z.ZodOptional<z.ZodString>;
-    createdAt: z.ZodOptional<z.ZodString>;
-    updatedAt: z.ZodOptional<z.ZodString>;
-    isDeactivated: z.ZodOptional<z.ZodBoolean>;
-} & {
-    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>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    name: string;
-    appId: string;
-    key?: string | undefined;
-    uuid?: string | undefined;
-    description?: string | undefined;
-    state?: import("../../types").WorkspaceElementState | undefined;
-    errors?: import("../../..").ErrorDataSchema[] | undefined;
-    revision?: string | undefined;
-    createdAt?: string | undefined;
-    updatedAt?: string | undefined;
-    archivedAt?: string | undefined;
-    isDeactivated?: boolean | 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;
-}, {
-    id: string;
-    name: string;
-    appId: string;
-    key?: string | undefined;
-    uuid?: string | undefined;
-    description?: string | undefined;
-    state?: import("../../types").WorkspaceElementState | undefined;
-    errors?: import("../../..").ErrorDataSchema[] | undefined;
-    revision?: string | undefined;
-    createdAt?: string | undefined;
-    updatedAt?: string | undefined;
-    archivedAt?: string | undefined;
-    isDeactivated?: boolean | 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 BaseScenario = z.infer<typeof BaseScenario>;
 export declare const HandyScenarioTemplateElement: z.ZodObject<{
     type: z.ZodString;
     integration: z.ZodOptional<z.ZodObject<{
@@ -538,17 +390,6 @@ export declare const ScenarioTemplate: z.ZodObject<{
             connectorId: string;
         }> | undefined;
     }>>>;
-    todos: z.ZodOptional<z.ZodArray<z.ZodObject<Omit<{
-        name: z.ZodString;
-        description: z.ZodString;
-        isComplete: z.ZodBoolean;
-    }, "isComplete">, "strip", z.ZodTypeAny, {
-        name: string;
-        description: string;
-    }, {
-        name: string;
-        description: string;
-    }>, "many">>;
     connectors: z.ZodOptional<z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         key: z.ZodString;
@@ -658,10 +499,6 @@ export declare const ScenarioTemplate: z.ZodObject<{
         name: string;
         logoUri: string;
     }[] | undefined;
-    todos?: {
-        name: string;
-        description: string;
-    }[] | undefined;
     shortDescription?: string | undefined;
     demoWorkspaceKey?: string | undefined;
     demoAppUri?: string | undefined;
@@ -715,10 +552,6 @@ export declare const ScenarioTemplate: z.ZodObject<{
         name: string;
         logoUri: string;
     }[] | undefined;
-    todos?: {
-        name: string;
-        description: string;
-    }[] | undefined;
     shortDescription?: string | undefined;
     demoWorkspaceKey?: string | undefined;
     demoAppUri?: string | undefined;
@@ -742,3 +575,65 @@ export declare const ScenarioTemplate: z.ZodObject<{
     }[] | undefined;
 }>;
 export type ScenarioTemplate = z.infer<typeof ScenarioTemplate>;
+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;
+}
+export interface UpdateScenarioTemplateRequest {
+    name?: string;
+    key?: string;
+    shortDescription?: string;
+    description?: string;
+    demoWorkspaceKey?: string;
+    demoAppUri?: string;
+    demoGithubRepo?: string;
+    demoVideoYoutubeUri?: string;
+    tags?: string[];
+    elements?: ScenarioTemplateElementsApi;
+}
+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;
+};
+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>;
+}