@hotmeshio/long-tail 0.1.7 → 0.1.9

package/build/api/users.d.ts

@@ -1,5 +1,15 @@
 import type { LTApiResult } from '../types/sdk';
 import type { LTRoleType } from '../types';
+/**
+ * List users with optional filters for role, role type, status, and pagination.
+ *
+ * @param input.role — filter by role name
+ * @param input.roleType — filter by role type (superadmin, admin, member)
+ * @param input.status — filter by user status
+ * @param input.limit — maximum number of users to return
+ * @param input.offset — number of users to skip for pagination
+ * @returns `{ status: 200, data: User[] }` on success
+ */
 export declare function listUsers(input: {
     role?: string;
     roleType?: LTRoleType;
@@ -7,9 +17,28 @@ export declare function listUsers(input: {
     limit?: number;
     offset?: number;
 }): Promise<LTApiResult>;
+/**
+ * Retrieve a single user by ID.
+ *
+ * @param input.id — the user's unique identifier
+ * @returns `{ status: 200, data: User }` on success, or `{ status: 404 }` if not found
+ */
 export declare function getUser(input: {
     id: string;
 }): Promise<LTApiResult>;
+/**
+ * Create a new user. Requires admin privileges.
+ *
+ * Validates that external_id is present and that any provided roles have valid
+ * names and types. Returns 409 if a user with the same external_id already exists.
+ *
+ * @param input.external_id — external system identifier (required)
+ * @param input.email — user's email address
+ * @param input.display_name — user's display name
+ * @param input.roles — initial role assignments, each with a role name and type (superadmin, admin, member)
+ * @param input.metadata — arbitrary key-value metadata to attach to the user
+ * @returns `{ status: 201, data: User }` on success, or `{ status: 409 }` on duplicate external_id
+ */
 export declare function createUser(input: {
     external_id?: string;
     email?: string;
@@ -20,6 +49,18 @@ export declare function createUser(input: {
     }[];
     metadata?: Record<string, any>;
 }): Promise<LTApiResult>;
+/**
+ * Update an existing user's profile fields. Requires admin privileges.
+ *
+ * Only the provided fields are updated; omitted fields remain unchanged.
+ *
+ * @param input.id — the user's unique identifier (required)
+ * @param input.email — new email address
+ * @param input.display_name — new display name
+ * @param input.status — new user status
+ * @param input.metadata — replacement metadata object
+ * @returns `{ status: 200, data: User }` on success, or `{ status: 404 }` if not found
+ */
 export declare function updateUser(input: {
     id: string;
     email?: string;
@@ -27,17 +68,47 @@ export declare function updateUser(input: {
     status?: string;
     metadata?: Record<string, any>;
 }): Promise<LTApiResult>;
+/**
+ * Delete a user by ID. Requires admin privileges.
+ *
+ * @param input.id — the user's unique identifier
+ * @returns `{ status: 200, data: { deleted: true } }` on success, or `{ status: 404 }` if not found
+ */
 export declare function deleteUser(input: {
     id: string;
 }): Promise<LTApiResult>;
+/**
+ * Retrieve all roles assigned to a user.
+ *
+ * @param input.id — the user's unique identifier
+ * @returns `{ status: 200, data: { roles: Role[] } }` on success
+ */
 export declare function getUserRoles(input: {
     id: string;
 }): Promise<LTApiResult>;
+/**
+ * Assign a role to a user. Requires admin privileges.
+ *
+ * Validates that both role and type are provided and that the type is one of
+ * superadmin, admin, or member.
+ *
+ * @param input.id — the user's unique identifier
+ * @param input.role — the role name to assign
+ * @param input.type — the role type (superadmin, admin, or member)
+ * @returns `{ status: 201, data: UserRole }` on success
+ */
 export declare function addUserRole(input: {
     id: string;
     role: string;
     type: string;
 }): Promise<LTApiResult>;
+/**
+ * Remove a role from a user. Requires admin privileges.
+ *
+ * @param input.id — the user's unique identifier
+ * @param input.role — the role name to remove
+ * @returns `{ status: 200, data: { removed: true } }` on success, or `{ status: 404 }` if role not found
+ */
 export declare function removeUserRole(input: {
     id: string;
     role: string;

package/build/api/users.js

@@ -42,6 +42,16 @@ exports.getUserRoles = getUserRoles;
 exports.addUserRole = addUserRole;
 exports.removeUserRole = removeUserRole;
 const userService = __importStar(require("../services/user"));
+/**
+ * List users with optional filters for role, role type, status, and pagination.
+ *
+ * @param input.role — filter by role name
+ * @param input.roleType — filter by role type (superadmin, admin, member)
+ * @param input.status — filter by user status
+ * @param input.limit — maximum number of users to return
+ * @param input.offset — number of users to skip for pagination
+ * @returns `{ status: 200, data: User[] }` on success
+ */
 async function listUsers(input) {
     try {
         const result = await userService.listUsers(input);
@@ -51,6 +61,12 @@ async function listUsers(input) {
         return { status: 500, error: err.message };
     }
 }
+/**
+ * Retrieve a single user by ID.
+ *
+ * @param input.id — the user's unique identifier
+ * @returns `{ status: 200, data: User }` on success, or `{ status: 404 }` if not found
+ */
 async function getUser(input) {
     try {
         const user = await userService.getUser(input.id);
@@ -63,7 +79,19 @@ async function getUser(input) {
         return { status: 500, error: err.message };
     }
 }
-// Admin-required
+/**
+ * Create a new user. Requires admin privileges.
+ *
+ * Validates that external_id is present and that any provided roles have valid
+ * names and types. Returns 409 if a user with the same external_id already exists.
+ *
+ * @param input.external_id — external system identifier (required)
+ * @param input.email — user's email address
+ * @param input.display_name — user's display name
+ * @param input.roles — initial role assignments, each with a role name and type (superadmin, admin, member)
+ * @param input.metadata — arbitrary key-value metadata to attach to the user
+ * @returns `{ status: 201, data: User }` on success, or `{ status: 409 }` on duplicate external_id
+ */
 async function createUser(input) {
     try {
         if (!input.external_id) {
@@ -95,7 +123,18 @@ async function createUser(input) {
         return { status: 500, error: err.message };
     }
 }
-// Admin-required
+/**
+ * Update an existing user's profile fields. Requires admin privileges.
+ *
+ * Only the provided fields are updated; omitted fields remain unchanged.
+ *
+ * @param input.id — the user's unique identifier (required)
+ * @param input.email — new email address
+ * @param input.display_name — new display name
+ * @param input.status — new user status
+ * @param input.metadata — replacement metadata object
+ * @returns `{ status: 200, data: User }` on success, or `{ status: 404 }` if not found
+ */
 async function updateUser(input) {
     try {
         const { id, ...fields } = input;
@@ -109,7 +148,12 @@ async function updateUser(input) {
         return { status: 500, error: err.message };
     }
 }
-// Admin-required
+/**
+ * Delete a user by ID. Requires admin privileges.
+ *
+ * @param input.id — the user's unique identifier
+ * @returns `{ status: 200, data: { deleted: true } }` on success, or `{ status: 404 }` if not found
+ */
 async function deleteUser(input) {
     try {
         const deleted = await userService.deleteUser(input.id);
@@ -122,6 +166,12 @@ async function deleteUser(input) {
         return { status: 500, error: err.message };
     }
 }
+/**
+ * Retrieve all roles assigned to a user.
+ *
+ * @param input.id — the user's unique identifier
+ * @returns `{ status: 200, data: { roles: Role[] } }` on success
+ */
 async function getUserRoles(input) {
     try {
         const roles = await userService.getUserRoles(input.id);
@@ -131,7 +181,17 @@ async function getUserRoles(input) {
         return { status: 500, error: err.message };
     }
 }
-// Admin-required
+/**
+ * Assign a role to a user. Requires admin privileges.
+ *
+ * Validates that both role and type are provided and that the type is one of
+ * superadmin, admin, or member.
+ *
+ * @param input.id — the user's unique identifier
+ * @param input.role — the role name to assign
+ * @param input.type — the role type (superadmin, admin, or member)
+ * @returns `{ status: 201, data: UserRole }` on success
+ */
 async function addUserRole(input) {
     try {
         if (!input.role || !input.type) {
@@ -147,7 +207,13 @@ async function addUserRole(input) {
         return { status: 500, error: err.message };
     }
 }
-// Admin-required
+/**
+ * Remove a role from a user. Requires admin privileges.
+ *
+ * @param input.id — the user's unique identifier
+ * @param input.role — the role name to remove
+ * @returns `{ status: 200, data: { removed: true } }` on success, or `{ status: 404 }` if role not found
+ */
 async function removeUserRole(input) {
     try {
         const removed = await userService.removeUserRole(input.id, input.role);

package/build/api/workflow-sets.d.ts

@@ -1,26 +1,77 @@
 import type { LTApiResult, LTApiAuth } from '../types/sdk';
+/**
+ * Create a new workflow set and kick off the LLM-powered planner.
+ *
+ * Persists the workflow set record, then starts an async planner workflow
+ * that generates the plan from the specification. Requires at least one
+ * LLM API key (OPENAI_API_KEY or ANTHROPIC_API_KEY) to be configured.
+ * Returns 409 if a workflow set with the same name already exists.
+ *
+ * @param input.name — unique name for the workflow set (required)
+ * @param input.description — optional description of the workflow set
+ * @param input.specification — free-text specification the planner uses to generate workflows (required)
+ * @param auth — authenticated user context; userId is forwarded to the planner
+ * @returns `{ status: 201, data: { ...set, source_workflow_id, planner_workflow_id } }` the created set with planner IDs
+ */
 export declare function createWorkflowSet(input: {
     name: string;
     description?: string;
     specification: string;
 }, auth?: LTApiAuth): Promise<LTApiResult>;
+/**
+ * List workflow sets with optional filtering and pagination.
+ *
+ * @param input.status — filter by workflow set status
+ * @param input.search — free-text search term to match against set names or descriptions
+ * @param input.limit — maximum number of results to return
+ * @param input.offset — number of results to skip for pagination
+ * @returns `{ status: 200, data: WorkflowSet[] }` paginated list of workflow sets
+ */
 export declare function listWorkflowSets(input: {
     status?: string;
     search?: string;
     limit?: number;
     offset?: number;
 }): Promise<LTApiResult>;
+/**
+ * Retrieve a single workflow set by ID.
+ *
+ * @param input.id — unique identifier of the workflow set
+ * @returns `{ status: 200, data: WorkflowSet }` the workflow set record, or 404 if not found
+ */
 export declare function getWorkflowSet(input: {
     id: string;
 }): Promise<LTApiResult>;
+/**
+ * Replace the plan and optional namespaces on a workflow set.
+ *
+ * @param input.id — unique identifier of the workflow set to update
+ * @param input.plan — array of plan entries (required, must be an array)
+ * @param input.namespaces — optional array of namespace definitions associated with the plan
+ * @returns `{ status: 200, data: WorkflowSet }` the updated workflow set, or 404 if not found
+ */
 export declare function updateWorkflowSetPlanApi(input: {
     id: string;
     plan: any[];
     namespaces?: any[];
 }): Promise<LTApiResult>;
+/**
+ * Transition a workflow set from "planned" to "building" status.
+ *
+ * Returns 409 if the set is not currently in "planned" status.
+ *
+ * @param input.id — unique identifier of the workflow set to build
+ * @returns `{ status: 200, data: { status: 'building', id } }` confirmation the build has started
+ */
 export declare function buildWorkflowSet(input: {
     id: string;
 }): Promise<LTApiResult>;
+/**
+ * Transition a workflow set to "deploying" status.
+ *
+ * @param input.id — unique identifier of the workflow set to deploy
+ * @returns `{ status: 200, data: { status: 'deploying', id } }` confirmation the deploy has started
+ */
 export declare function deployWorkflowSet(input: {
     id: string;
 }): Promise<LTApiResult>;

package/build/api/workflow-sets.js

@@ -8,6 +8,20 @@ exports.buildWorkflowSet = buildWorkflowSet;
 exports.deployWorkflowSet = deployWorkflowSet;
 const workflow_sets_1 = require("../services/workflow-sets");
 const insight_1 = require("../services/insight");
+/**
+ * Create a new workflow set and kick off the LLM-powered planner.
+ *
+ * Persists the workflow set record, then starts an async planner workflow
+ * that generates the plan from the specification. Requires at least one
+ * LLM API key (OPENAI_API_KEY or ANTHROPIC_API_KEY) to be configured.
+ * Returns 409 if a workflow set with the same name already exists.
+ *
+ * @param input.name — unique name for the workflow set (required)
+ * @param input.description — optional description of the workflow set
+ * @param input.specification — free-text specification the planner uses to generate workflows (required)
+ * @param auth — authenticated user context; userId is forwarded to the planner
+ * @returns `{ status: 201, data: { ...set, source_workflow_id, planner_workflow_id } }` the created set with planner IDs
+ */
 async function createWorkflowSet(input, auth) {
     try {
         if (!input.specification || typeof input.specification !== 'string') {
@@ -47,6 +61,15 @@ async function createWorkflowSet(input, auth) {
         return { status: 500, error: err.message };
     }
 }
+/**
+ * List workflow sets with optional filtering and pagination.
+ *
+ * @param input.status — filter by workflow set status
+ * @param input.search — free-text search term to match against set names or descriptions
+ * @param input.limit — maximum number of results to return
+ * @param input.offset — number of results to skip for pagination
+ * @returns `{ status: 200, data: WorkflowSet[] }` paginated list of workflow sets
+ */
 async function listWorkflowSets(input) {
     try {
         const result = await (0, workflow_sets_1.listWorkflowSets)({
@@ -61,6 +84,12 @@ async function listWorkflowSets(input) {
         return { status: 500, error: err.message };
     }
 }
+/**
+ * Retrieve a single workflow set by ID.
+ *
+ * @param input.id — unique identifier of the workflow set
+ * @returns `{ status: 200, data: WorkflowSet }` the workflow set record, or 404 if not found
+ */
 async function getWorkflowSet(input) {
     try {
         const set = await (0, workflow_sets_1.getWorkflowSet)(input.id);
@@ -73,6 +102,14 @@ async function getWorkflowSet(input) {
         return { status: 500, error: err.message };
     }
 }
+/**
+ * Replace the plan and optional namespaces on a workflow set.
+ *
+ * @param input.id — unique identifier of the workflow set to update
+ * @param input.plan — array of plan entries (required, must be an array)
+ * @param input.namespaces — optional array of namespace definitions associated with the plan
+ * @returns `{ status: 200, data: WorkflowSet }` the updated workflow set, or 404 if not found
+ */
 async function updateWorkflowSetPlanApi(input) {
     try {
         if (!Array.isArray(input.plan)) {
@@ -88,6 +125,14 @@ async function updateWorkflowSetPlanApi(input) {
         return { status: 500, error: err.message };
     }
 }
+/**
+ * Transition a workflow set from "planned" to "building" status.
+ *
+ * Returns 409 if the set is not currently in "planned" status.
+ *
+ * @param input.id — unique identifier of the workflow set to build
+ * @returns `{ status: 200, data: { status: 'building', id } }` confirmation the build has started
+ */
 async function buildWorkflowSet(input) {
     try {
         const set = await (0, workflow_sets_1.getWorkflowSet)(input.id);
@@ -104,6 +149,12 @@ async function buildWorkflowSet(input) {
         return { status: 500, error: err.message };
     }
 }
+/**
+ * Transition a workflow set to "deploying" status.
+ *
+ * @param input.id — unique identifier of the workflow set to deploy
+ * @returns `{ status: 200, data: { status: 'deploying', id } }` confirmation the deploy has started
+ */
 async function deployWorkflowSet(input) {
     try {
         const set = await (0, workflow_sets_1.getWorkflowSet)(input.id);

package/build/api/workflows.d.ts

@@ -1,33 +1,134 @@
 import type { LTApiResult, LTApiAuth } from '../types/sdk';
+/**
+ * Start a workflow — proxy for `Durable.Client.workflow.start()`.
+ *
+ * Resolves the task queue, enforces auth/role constraints, builds the
+ * LTEnvelope with IAM context, and delegates to the Durable client.
+ * Any WorkflowOptions field (workflowId, expire, entity, namespace,
+ * search, signalIn, pending, etc.) can be passed via `options` and
+ * flows through to the Durable client unchanged.
+ *
+ * @see https://docs.hotmesh.io/types/types_durable.WorkflowOptions.html
+ */
 export declare function invokeWorkflow(input: {
     type: string;
     data?: Record<string, any>;
     metadata?: Record<string, any>;
     execute_as?: string;
+    /** Passthrough to Durable WorkflowOptions. */
+    options?: Record<string, any>;
 }, auth: LTApiAuth): Promise<LTApiResult>;
+/**
+ * Get the execution status of a workflow.
+ *
+ * Returns the HotMesh status code (0 = completed, 1 = running).
+ * Resolves the workflow handle via task record or worker registry.
+ *
+ * @param input.workflowId — HotMesh workflow ID
+ * @returns `{ status: 200, data: { workflowId, status } }` or 404
+ */
 export declare function getWorkflowStatus(input: {
     workflowId: string;
 }): Promise<LTApiResult>;
+/**
+ * Get the result of a completed workflow.
+ *
+ * Returns 202 if the workflow is still running, 200 with the result
+ * payload when complete. Never blocks — always returns immediately.
+ *
+ * @param input.workflowId — HotMesh workflow ID
+ * @returns `{ status: 200, data: { workflowId, result } }` or 202 if running
+ */
 export declare function getWorkflowResult(input: {
     workflowId: string;
 }): Promise<LTApiResult>;
+/**
+ * Terminate a running workflow.
+ *
+ * Interrupts the workflow execution immediately via HotMesh.
+ *
+ * @param input.workflowId — HotMesh workflow ID
+ * @returns `{ status: 200, data: { terminated: true, workflowId } }` or 404
+ */
 export declare function terminateWorkflow(input: {
     workflowId: string;
 }): Promise<LTApiResult>;
+/**
+ * Export the full state of a workflow.
+ *
+ * Returns the serialized workflow state including all activity
+ * results, signals, and metadata.
+ *
+ * @param input.workflowId — HotMesh workflow ID
+ * @returns `{ status: 200, data: <exported state> }` or 404
+ */
 export declare function exportWorkflow(input: {
     workflowId: string;
 }): Promise<LTApiResult>;
+/**
+ * List active workflow workers with their registration status.
+ *
+ * @param input.include_system — include system workflows (default: false)
+ * @returns `{ status: 200, data: { workers: [{ name, task_queue, registered, system }] } }`
+ */
 export declare function listWorkers(input: {
     include_system?: boolean;
 }): Promise<LTApiResult>;
+/**
+ * Discover all known workflow types from workers, history, and config.
+ *
+ * Merges three sources: active in-memory workers, historical entities
+ * from the durable jobs table, and registered workflow configs. Returns
+ * a unified list with status flags for each type.
+ *
+ * @param input.include_system — include system workflows (default: false)
+ * @returns `{ status: 200, data: { workflows: [{ workflow_type, task_queue, registered, active, invocable, ... }] } }`
+ */
 export declare function listDiscoveredWorkflows(input: {
     include_system?: boolean;
 }): Promise<LTApiResult>;
+/**
+ * List all cron-scheduled workflows and their active state.
+ *
+ * @returns `{ status: 200, data: { schedules: [{ workflow_type, cron_schedule, active, ... }] } }`
+ */
 export declare function getCronStatus(): Promise<LTApiResult>;
+/**
+ * List all registered workflow configurations.
+ *
+ * @returns `{ status: 200, data: { workflows: LTWorkflowConfig[] } }`
+ */
 export declare function listWorkflowConfigs(): Promise<LTApiResult>;
+/**
+ * Get a single workflow configuration by type.
+ *
+ * @param input.type — workflow type name (e.g. `"reviewContent"`)
+ * @returns `{ status: 200, data: <config> }` or 404
+ */
 export declare function getWorkflowConfig(input: {
     type: string;
 }): Promise<LTApiResult>;
+/**
+ * Create or replace a workflow configuration.
+ *
+ * Invalidates the config cache and restarts the cron schedule if one
+ * is defined. Idempotent — safe to call repeatedly with the same input.
+ *
+ * @param input.type — workflow type name
+ * @param input.invocable — whether the workflow can be started via the API
+ * @param input.task_queue — HotMesh task queue
+ * @param input.default_role — default escalation role
+ * @param input.description — human-readable description
+ * @param input.execute_as — service account for proxy invocation
+ * @param input.roles — roles that can resolve escalations
+ * @param input.invocation_roles — roles that can invoke this workflow
+ * @param input.consumes — workflow types whose data this workflow consumes
+ * @param input.tool_tags — MCP tool tags for discovery
+ * @param input.envelope_schema — JSON Schema for envelope.data validation
+ * @param input.resolver_schema — JSON Schema for resolver payload validation
+ * @param input.cron_schedule — cron expression for scheduled execution
+ * @returns `{ status: 200, data: <saved config> }`
+ */
 export declare function upsertWorkflowConfig(input: {
     type: string;
     invocable?: boolean;
@@ -43,6 +144,15 @@ export declare function upsertWorkflowConfig(input: {
     resolver_schema?: any;
     cron_schedule?: string | null;
 }): Promise<LTApiResult>;
+/**
+ * Delete a workflow configuration.
+ *
+ * Removes the config record and invalidates the cache. Active workers
+ * continue running — this only removes the config/interceptor binding.
+ *
+ * @param input.type — workflow type name
+ * @returns `{ status: 200, data: { deleted: true, workflow_type } }` or 404
+ */
 export declare function deleteWorkflowConfig(input: {
     type: string;
 }): Promise<LTApiResult>;