@membranehq/sdk 0.15.6 → 0.16.0

package/dist/index.browser.js

@@ -3497,36 +3497,78 @@ exports.WorkspaceElementDependencyType = void 0;
     WorkspaceElementDependencyType["Parent"] = "PARENT";
 })(exports.WorkspaceElementDependencyType || (exports.WorkspaceElementDependencyType = {}));
 const BaseWorkspaceElement = z.z.object({
-    id: z.z.string(),
-    name: z.z.string(),
+    id: z.z.string().describe('Internal database ID of the element. Assigned by the API; unique per element.'),
+    name: z.z.string().describe('Display name of the workspace element.'),
 });
 const BaseMembraneInterfaceEditableProperties = z.z.object({
-    uuid: z.z.string().optional(),
-    key: z.z.string().optional(),
-    name: z.z.string().optional(),
-    description: z.z.string().optional(),
-    meta: z.z.record(z.z.string(), z.z.any()).optional(),
+    uuid: z.z
+        .string()
+        .optional()
+        .describe('Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.'),
+    key: z.z
+        .string()
+        .optional()
+        .describe('Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.'),
+    name: z.z.string().optional().describe('Display name. Optional on create; used to generate key when key is omitted.'),
+    description: z.z.string().optional().describe('Optional human-readable description.'),
+    meta: z.z.record(z.z.string(), z.z.any()).optional().describe('Optional key-value metadata.'),
 });
 const BaseMembraneInterfaceReadOnlyProperties = z.z.object({
-    name: z.z.string(),
-    state: z.z.enum(exports.WorkspaceElementState).optional(),
-    errors: z.z.array(ErrorDataSchema).optional(),
-    revision: z.z.string().optional(),
-    createdAt: z.z.string().optional(),
-    updatedAt: z.z.string().optional(),
-    archivedAt: z.z.string().optional(),
-    isDeactivated: z.z.boolean().optional(),
-    isReadOnly: z.z.boolean().optional(),
+    name: z.z.string().describe('Display name. Always present in API responses (filled by API if not set on create).'),
+    state: z.z
+        .enum(exports.WorkspaceElementState)
+        .optional()
+        .describe('Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR). Set by the engine during setup and validation.'),
+    errors: z.z.array(ErrorDataSchema).optional().describe('Validation or setup errors when state is not READY.'),
+    revision: z.z
+        .string()
+        .optional()
+        .describe('Opaque revision token; changes on each update. Used for optimistic concurrency.'),
+    createdAt: z.z.string().optional().describe('ISO date when the element was created.'),
+    updatedAt: z.z.string().optional().describe('ISO date when the element was last updated.'),
+    archivedAt: z.z
+        .string()
+        .optional()
+        .describe('When set, the element is archived (soft-deleted). Archived elements cannot be patched.'),
+    isDeactivated: z.z
+        .boolean()
+        .optional()
+        .describe('When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).'),
+    isReadOnly: z.z
+        .boolean()
+        .optional()
+        .describe('When true, the element cannot be modified (e.g. published package elements or elements from another workspace).'),
 });
 const BaseMembraneInterface = BaseWorkspaceElement.merge(BaseMembraneInterfaceEditableProperties).merge(BaseMembraneInterfaceReadOnlyProperties);
 const BaseIntegrationLevelMembraneInterfaceEditableProperties = BaseMembraneInterfaceEditableProperties.extend({
-    integrationId: z.z.string().optional(),
-    integrationUuid: z.z.string().optional(),
-    parentId: z.z.string().optional(),
-    parentUuid: z.z.string().optional(),
-    connectionId: z.z.string().optional(),
-    instanceKey: z.z.string().optional(),
-    isUniversal: z.z.boolean().optional(),
+    integrationId: z.z
+        .string()
+        .optional()
+        .describe('Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.'),
+    integrationUuid: z.z
+        .string()
+        .optional()
+        .describe('UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.'),
+    parentId: z.z
+        .string()
+        .optional()
+        .describe('Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.'),
+    parentUuid: z.z
+        .string()
+        .optional()
+        .describe('UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.'),
+    connectionId: z.z
+        .string()
+        .optional()
+        .describe('Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.'),
+    instanceKey: z.z
+        .string()
+        .optional()
+        .describe('Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.'),
+    isUniversal: z.z
+        .boolean()
+        .optional()
+        .describe('When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.'),
 });
 const BaseIntegrationLevelMembraneInterfaceReadOnlyProperties = BaseMembraneInterfaceReadOnlyProperties.extend({
     isCustomized: z.z.boolean().optional(),
@@ -3822,24 +3864,52 @@ const ActionDependency = z.z.object({
     element: z.z.any().optional(),
 });
 const ActionSpecificProperties = z.z.object({
-    connectionId: z.z.string().optional(),
-    instanceKey: z.z.string().optional(),
-    inputSchema: DataSchema.optional(),
-    type: z.z.enum(exports.ActionType).optional(),
-    config: z.z.object({}).loose().optional(),
-    outputMapping: z.z.any().optional(),
-    customOutputSchema: DataSchema.optional(),
+    connectionId: z.z
+        .string()
+        .optional()
+        .describe('Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.'),
+    instanceKey: z.z
+        .string()
+        .optional()
+        .describe('Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.'),
+    inputSchema: DataSchema.optional().describe('JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.'),
+    type: z.z
+        .enum(exports.ActionType)
+        .optional()
+        .describe('Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.'),
+    config: z.z
+        .object({})
+        .loose()
+        .optional()
+        .describe("Type-specific configuration object. Validated by the handler's config schema; passed to handler setup/run and getTemplateOutputSchema."),
+    outputMapping: z.z
+        .any()
+        .optional()
+        .describe("Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time."),
+    customOutputSchema: DataSchema.optional().describe('Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.'),
 });
-const ActionEditableProperties = BaseIntegrationLevelMembraneInterfaceEditableProperties.extend(ActionSpecificProperties.shape);
+const ActionEditableProperties = BaseIntegrationLevelMembraneInterfaceEditableProperties.extend(ActionSpecificProperties.shape).describe('Action editable properties: key, name, type, config, inputSchema, outputMapping, optional connectionId and instanceKey for connection-level instances.');
 const ActionExportProperties = BaseIntegrationLevelMembraneInterfaceExportProperties.extend(ActionSpecificProperties.shape).omit({
     connectionId: true,
 });
 const ActionReadOnlyProperties = BaseIntegrationLevelMembraneInterfaceReadOnlyProperties.extend({
     ...TenantLayerElement.partial().shape,
-    universalParentId: z.z.string().optional(),
-    outputSchema: z.z.any().optional(),
-    isPublic: z.z.boolean().optional(),
-    externalAppUuid: z.z.string().optional(),
+    universalParentId: z.z
+        .string()
+        .optional()
+        .describe('For connection-level instances: ID of the universal (root) action in the hierarchy. Set automatically when creating an instance; used in list/selector queries to filter by universal parent.'),
+    outputSchema: z.z
+        .any()
+        .optional()
+        .describe('Resolved output schema (cached after setup). Derived from customOutputSchema, transformed schema from outputMapping, default output schema, or parent custom output schema. Read-only.'),
+    isPublic: z.z
+        .boolean()
+        .optional()
+        .describe('When true, the element is publicly listed (e.g. in universe). Used for published packages; publish/unpublish updates this on published elements.'),
+    externalAppUuid: z.z
+        .string()
+        .optional()
+        .describe('UUID of the external app when this action is published in a package that has an external app. Populated in API responses for published actions.'),
 });
 const BaseAction = BaseMembraneInterface.merge(ActionEditableProperties).merge(ActionReadOnlyProperties);
 const BaseActionInstance = BaseAction;
@@ -10244,7 +10314,9 @@ const ConnectPayload = z.z.object({
     redirectUri: z.z.string().optional(),
     customState: z.z.string().optional(),
 });
-const ConnectUIOptions = ConnectPayload.omit({ input: true, redirectUri: true });
+const ConnectUIOptions = ConnectPayload.omit({ input: true, redirectUri: true }).extend({
+    theme: z.z.enum(['light', 'dark', 'auto']).optional(),
+});
 
 const ListPublicConnectorsQuery = PaginationQuery.extend({
     search: z.z.string().optional(),
@@ -11249,6 +11321,11 @@ function hasCycles(nodes) {
     return hasCycles;
 }
 
+function getSchemaDescription(schema) {
+    const json = z.z.toJSONSchema(schema);
+    return json.description;
+}
+
 function addUndefinedWriteableProperties(value, schema) {
     if (!(schema instanceof z.z.ZodObject)) {
         return value;
@@ -15051,6 +15128,31 @@ const AsyncRequestTriggerResponse = z.z.object({
     accessKey: z.z.string(),
 });
 
+const SelfHostingToken = z.z.object({
+    id: z.z.string(),
+    name: z.z.string(),
+    orgId: z.z.string(),
+    tokenPrefix: z.z.string(),
+    createdAt: z.z.coerce.date(),
+    updatedAt: z.z.coerce.date(),
+    lastUsedAt: z.z.coerce.date().optional(),
+});
+const CreateSelfHostingTokenRequest = z.z.object({
+    name: z.z.string().min(1).max(100),
+});
+const CreateSelfHostingTokenResponse = SelfHostingToken.extend({
+    token: z.z.string(),
+});
+const UpdateSelfHostingTokenRequest = z.z.object({
+    name: z.z.string().min(1).max(100),
+});
+const ValidateSelfHostingTokenRequest = z.z.object({});
+const ValidateSelfHostingTokenResponse = z.z.object({
+    valid: z.z.boolean(),
+    orgId: z.z.string().optional(),
+    orgName: z.z.string().optional(),
+});
+
 const CONSOLE_ACCOUNT_API_TOKEN_PATH = 'settings/account/api-token';
 
 class UI {
@@ -15681,6 +15783,8 @@ exports.CreateOrgRequest = CreateOrgRequest;
 exports.CreateOrgUserRequest = CreateOrgUserRequest;
 exports.CreatePackageRequest = CreatePackageRequest;
 exports.CreateScreenRequest = CreateScreenRequest;
+exports.CreateSelfHostingTokenRequest = CreateSelfHostingTokenRequest;
+exports.CreateSelfHostingTokenResponse = CreateSelfHostingTokenResponse;
 exports.CustomCodeError = CustomCodeError;
 exports.CustomerAccessor = CustomerAccessor;
 exports.CustomerApiResponse = CustomerApiResponse;
@@ -15966,6 +16070,7 @@ exports.ScreenSelector = ScreenSelector;
 exports.ScreensAccessor = ScreensAccessor;
 exports.SearchQuery = SearchQuery;
 exports.SelfAccessor = SelfAccessor;
+exports.SelfHostingToken = SelfHostingToken;
 exports.StatsFilterQuery = StatsFilterQuery;
 exports.TenantLayerElement = TenantLayerElement;
 exports.UNIFIED_DATA_MODELS = UNIFIED_DATA_MODELS;
@@ -15987,9 +16092,12 @@ exports.UpdateOrgRequest = UpdateOrgRequest;
 exports.UpdateOrgUserRequest = UpdateOrgUserRequest;
 exports.UpdatePackageRequest = UpdatePackageRequest;
 exports.UpdateScreenRequest = UpdateScreenRequest;
+exports.UpdateSelfHostingTokenRequest = UpdateSelfHostingTokenRequest;
 exports.UpstreamFlowNodeRunSchema = UpstreamFlowNodeRunSchema;
 exports.UserAccessor = UserAccessor;
 exports.UsersAccessor = UsersAccessor;
+exports.ValidateSelfHostingTokenRequest = ValidateSelfHostingTokenRequest;
+exports.ValidateSelfHostingTokenResponse = ValidateSelfHostingTokenResponse;
 exports.WORKSPACE_ELEMENTS_STATS_COLLECTIONS = WORKSPACE_ELEMENTS_STATS_COLLECTIONS;
 exports.WORKSPACE_SIZE_LIMITS = WORKSPACE_SIZE_LIMITS;
 exports.Workspace = Workspace;
@@ -16084,6 +16192,7 @@ exports.getReferenceCollectionPointerForSchema = getReferenceCollectionPointerFo
 exports.getRequiredFieldsFromSchema = getRequiredFieldsFromSchema;
 exports.getRootNodeKeys = getRootNodeKeys;
 exports.getSchemaByLocator = getSchemaByLocator;
+exports.getSchemaDescription = getSchemaDescription;
 exports.getSchemaFromValue = getSchemaFromValue;
 exports.getUpstreamNodeKeys = getUpstreamNodeKeys;
 exports.getValueAtLocator = getValueAtLocator;