@membranehq/sdk 0.3.0 → 0.4.0

package/dist/dts/{integrations → workspace-elements/base/integrations}/types.d.ts

@@ -1,11 +1,7 @@
-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[];
+import { BaseMembraneInterface } from '../..';
+import { DataSchema } from '../../../data-schema';
+import { ConnectorAuthSpec, ConnectorAuthType } from '../connectors';
+export interface BaseIntegration extends BaseMembraneInterface {
     logoUri: string;
     connectorId?: string;
     connectorVersion?: string;
@@ -14,9 +10,7 @@ export interface Integration extends WorkspaceElement {
     parametersSchema?: DataSchema;
     parameters?: any;
     baseUri: string;
-    connection?: Connection;
     archivedAt?: string;
-    spec?: ConnectorSpec;
     hasMissingParameters?: boolean;
     hasDocumentation?: boolean;
     hasOperations?: boolean;
@@ -34,5 +28,5 @@ export type IntegrationAuthOption = ConnectorAuthSpec & {
 };
 export type AppliedToIntegrations<Element> = {
     element: Element;
-    integration: Integration;
+    integration: BaseIntegration;
 }[];

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

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

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

@@ -0,0 +1,27 @@
+import { BaseMembraneInterface } from '../..';
+import { ScenarioElement, ScenarioToDo, ScenarioTemplateElements, HandyScenarioTemplateElement, ScenarioTemplateCategory } from '../../api/scenarios-api';
+import { MinimalConnector } from '../connectors';
+export interface BaseScenario extends BaseMembraneInterface {
+    appId: string;
+    scenarioTemplateId?: string;
+    elements?: ScenarioElement[];
+    connectors?: MinimalConnector[];
+    todos?: ScenarioToDo[];
+    archivedAt?: string;
+}
+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[];
+}

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

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

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

@@ -0,0 +1,7 @@
+import { BaseWorkspaceElement } from '../..';
+import { ScreenType, ScreenBlock } from '../../api/screens-api';
+export interface BaseScreen extends BaseWorkspaceElement {
+    type: ScreenType;
+    key?: string;
+    blocks: ScreenBlock[];
+}

package/dist/dts/workspace-elements/errors.d.ts

@@ -0,0 +1,5 @@
+import { ErrorConstructorArg, IntegrationAppError } from '../errors';
+import { WorkspaceElementReference } from './types';
+export declare class DependencyError extends IntegrationAppError {
+    constructor(arg: ErrorConstructorArg, workspaceElementReference?: WorkspaceElementReference);
+}

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

@@ -1 +1,5 @@
+export * from './base';
 export * from './types';
+export * from './api';
+export * from './errors';
+export * from './utils';

package/dist/dts/workspace-elements/types.d.ts

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 import { ErrorData } from '../errors';
 export interface ConfigurationStateResult {
     state: ConfigurationState;
@@ -60,13 +61,38 @@ export interface WorkspaceElementCalculateStateResult {
     state: WorkspaceElementState;
     errors?: ErrorData[];
 }
-export interface WorkspaceElement {
+export declare const BaseWorkspaceElement: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
     id: string;
     name: string;
+}, {
+    id: string;
+    name: string;
+}>;
+export type BaseWorkspaceElement = z.infer<typeof BaseWorkspaceElement>;
+export declare const BaseMembraneInterface: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+} & {
+    key: z.ZodString;
+    state: z.ZodOptional<z.ZodNativeEnum<typeof WorkspaceElementState>>;
+    errors: z.ZodOptional<z.ZodArray<any, "many">>;
+}, "strip", z.ZodTypeAny, {
     key: string;
-    state?: WorkspaceElementState;
-    errors?: ErrorData[];
-}
+    id: string;
+    name: string;
+    state?: WorkspaceElementState | undefined;
+    errors?: any[] | undefined;
+}, {
+    key: string;
+    id: string;
+    name: string;
+    state?: WorkspaceElementState | undefined;
+    errors?: any[] | undefined;
+}>;
+export type BaseMembraneInterface = z.infer<typeof BaseMembraneInterface>;
 export interface WorkspaceElementReference {
     type: WorkspaceElementType;
     id: string;

package/dist/dts/{flows/utils.d.ts → workspace-elements/utils/flow-utils.d.ts}

@@ -1,6 +1,6 @@
-import { FlowNodeSpec } from './nodes';
-import { IntegrationElementInstance, IntegrationElementType } from '../integration-elements';
-import { Flow, FlowInstance, FlowInstanceNode, FlowNode } from '.';
+import { IntegrationElementType, IntegrationElementInstance } from '../../integration-elements';
+import { Flow, FlowInstance } from '../api';
+import { FlowNode, FlowNodeSpec, FlowInstanceNode } from '../base';
 export declare function getFlowNode(flow: Flow | FlowInstance, nodeKey: string): FlowNode;
 export declare function getFlowNodeTitle(flow: Flow | FlowInstance, nodeKey: string): string | undefined;
 export declare function getFlowNodeDescription(flow: Flow | FlowInstance, nodeKey: string): string | undefined;

package/dist/dts/workspace-elements/utils/index.d.ts

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

package/dist/dts/workspace-elements-catalog/index.d.ts

@@ -1,12 +1,7 @@
 import { z } from 'zod';
-import { CreateActionRequest } from '../actions';
-import { CreateAppDataSchemaRequest } from '../app-data-schemas';
-import { CreateAppEventTypeRequest } from '../app-events';
-import { CreateDataLinkTableRequest } from '../data-links';
-import { CreateDataSourceRequest } from '../data-sources';
-import { CreateFieldMappingRequest } from '../field-mappings';
-import { CreateFlowRequest } from '../flows';
-import { WorkspaceElementType } from '../workspace-elements';
+import { CreateAppDataSchemaRequest, CreateAppEventTypeRequest, CreateDataLinkTableRequest, CreateFieldMappingRequest } from '../workspace-elements';
+import { CreateActionRequest, CreateDataSourceRequest, CreateFlowRequest } from '../workspace-elements/api';
+import { WorkspaceElementType } from '../workspace-elements/types';
 export interface WorkspaceElementSpec {
     type: WorkspaceElementType;
     apiPath: string;

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

@@ -1,6 +1,6 @@
-import { ConnectorAuth, RestApiClientOptions } from '../connectors';
 import { DataSchema } from '../data-schema';
-import { User } from '../users';
+import { User } from '../workspace-elements/api/customers-api';
+import { ConnectorAuth, RestApiClientOptions } from '../workspace-elements/base/connectors';
 export declare enum WorkspaceOnboardingStep {
     AddConnectors = "add-connectors",
     ConnectYourApp = "connect-your-app",
@@ -86,7 +86,7 @@ export declare const enum ParallelExecutionLimits {
     ParallelBackgroundJobs = "parallelBackgroundJobs",
     ParallelEventLogs = "parallelEventLogs",
     ParallelEventLogsPerConnection = "parallelEventLogsPerConnection",
-    ParallelWriteDatabaseRequests = "parallelWriteDatabaseRequests"
+    ParallelPathfinderAgentSessions = "parallelPathfinderAgentSessions"
 }
 export declare const enum RateLimits {
     fileUploadsMbPerHour = "fileUploadsMbPerHour",
@@ -96,8 +96,7 @@ export declare const enum RateLimits {
     WebhookRequestsPerHour = "webhookRequestsPerHour",
     WorkspaceElementCreationsPerSecond = "workspaceElementCreationsPerSecond",
     WorkspaceElementCreationsPerHour = "workspaceElementCreationsPerHour",
-    ExternalEventsPerCustomerPerDay = "externalEventsPerCustomerPerDay",
-    CreateDatabaseRequestsPerSecond = "createDatabaseRequestsPerSecond"
+    ExternalEventsPerCustomerPerDay = "externalEventsPerCustomerPerDay"
 }
 export declare const enum WorkspaceSizeLimits {
     TotalNumberOfCustomers = "totalNumberOfCustomers",
@@ -110,10 +109,7 @@ export declare const enum CustomerLimits {
     ApiRequestsPerCustomerPerSecond = "apiRequestsPerCustomerPerSecond",
     ApiRequestsPerCustomerPerHour = "apiRequestsPerCustomerPerHour",
     WebhookRequestsPerCustomerPerSecond = "webhookRequestsPerCustomerPerSecond",
-    WebhookRequestsPerCustomerPerHour = "webhookRequestsPerCustomerPerHour",
-    ParallelWriteDatabaseRequestsPerCustomer = "parallelWriteDatabaseRequestsPerCustomer",
-    CreateDatabaseRequestsPerCustomerPerSecond = "createDatabaseRequestsPerCustomerPerSecond",
-    UpdateDatabaseRequestsPerCustomerPerSecond = "updateDatabaseRequestsPerCustomerPerSecond"
+    WebhookRequestsPerCustomerPerHour = "webhookRequestsPerCustomerPerHour"
 }
 export declare const enum LimitUnits {
     Number = "number",
@@ -125,39 +121,7 @@ export interface WorkspaceLimit {
     defaultValue?: number;
     unit: LimitUnits;
 }
-export interface WorkspaceLimits {
-    [ParallelExecutionLimits.ParallelEventPulls]?: WorkspaceLimit;
-    [ParallelExecutionLimits.ParallelIncrementalEventPullsPerConnection]?: WorkspaceLimit;
-    [ParallelExecutionLimits.ParallelFullSyncEventPullsPerConnection]?: WorkspaceLimit;
-    [ParallelExecutionLimits.ParallelFlowRuns]?: WorkspaceLimit;
-    [ParallelExecutionLimits.ParallelFlowRunsPerConnection]?: WorkspaceLimit;
-    [ParallelExecutionLimits.ParallelApiRequests]?: WorkspaceLimit;
-    [ParallelExecutionLimits.ParallelBackgroundJobs]?: WorkspaceLimit;
-    [ParallelExecutionLimits.ParallelEventLogs]?: WorkspaceLimit;
-    [ParallelExecutionLimits.ParallelEventLogsPerConnection]?: WorkspaceLimit;
-    [ParallelExecutionLimits.ParallelWriteDatabaseRequests]?: WorkspaceLimit;
-    [RateLimits.fileUploadsMbPerHour]?: WorkspaceLimit;
-    [RateLimits.ApiRequestsPerSecond]?: WorkspaceLimit;
-    [RateLimits.ApiRequestsPerHour]?: WorkspaceLimit;
-    [RateLimits.WebhookRequestsPerSecond]?: WorkspaceLimit;
-    [RateLimits.WebhookRequestsPerHour]?: WorkspaceLimit;
-    [RateLimits.WorkspaceElementCreationsPerSecond]?: WorkspaceLimit;
-    [RateLimits.WorkspaceElementCreationsPerHour]?: WorkspaceLimit;
-    [RateLimits.ExternalEventsPerCustomerPerDay]?: WorkspaceLimit;
-    [RateLimits.CreateDatabaseRequestsPerSecond]?: WorkspaceLimit;
-    [WorkspaceSizeLimits.TotalNumberOfCustomers]?: WorkspaceLimit;
-    [WorkspaceSizeLimits.TotalNumberOfConnections]?: WorkspaceLimit;
-    [WorkspaceSizeLimits.TotalNumberOfWorkspaceElements]?: WorkspaceLimit;
-    [CustomerLimits.ParallelApiRequestsPerCustomer]?: WorkspaceLimit;
-    [CustomerLimits.ParallelBackgroundJobsPerCustomer]?: WorkspaceLimit;
-    [CustomerLimits.ApiRequestsPerCustomerPerSecond]?: WorkspaceLimit;
-    [CustomerLimits.ApiRequestsPerCustomerPerHour]?: WorkspaceLimit;
-    [CustomerLimits.WebhookRequestsPerCustomerPerSecond]?: WorkspaceLimit;
-    [CustomerLimits.WebhookRequestsPerCustomerPerHour]?: WorkspaceLimit;
-    [CustomerLimits.ParallelWriteDatabaseRequestsPerCustomer]?: WorkspaceLimit;
-    [CustomerLimits.CreateDatabaseRequestsPerCustomerPerSecond]?: WorkspaceLimit;
-    [CustomerLimits.UpdateDatabaseRequestsPerCustomerPerSecond]?: WorkspaceLimit;
-}
+export type WorkspaceLimits = Record<ParallelExecutionLimits, WorkspaceLimit> & Record<RateLimits, WorkspaceLimit> & Record<WorkspaceSizeLimits, WorkspaceLimit> & Record<CustomerLimits, WorkspaceLimit>;
 export interface EngineWorkspaceWithOrgData {
     id: string;
     key: string;