@egose/n8n-client 0.1.1 → 0.2.0

package/types.d.cts

@@ -1,5 +1,13 @@
-export { PaginatedResponse, PaginationParams } from './pagination.cjs';
+import { PaginationParams } from './pagination.cjs';
+export { PaginatedResponse } from './pagination.cjs';
 
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+interface JsonObject {
+    [key: string]: JsonValue;
+}
+interface JsonArray extends Array<JsonValue> {
+}
 type N8nClientConfig = {
     baseUrl: string;
 } & ({
@@ -24,11 +32,11 @@ interface Workflow {
     versionId: string;
     triggerCount: number;
     nodes: WorkflowNode[];
-    connections: Record<string, unknown>;
+    connections: WorkflowConnections;
     settings?: WorkflowSettings;
-    staticData?: unknown;
-    pinData?: Record<string, unknown>;
-    meta?: Record<string, unknown>;
+    staticData?: string | JsonObject | null;
+    pinData?: WorkflowPinData | null;
+    meta?: WorkflowMeta | null;
     tags?: Tag[];
     shared?: SharedWorkflow[];
     activeVersion?: ActiveVersion | null;
@@ -37,7 +45,7 @@ interface ActiveVersion {
     versionId: string;
     workflowId: string;
     nodes: WorkflowNode[];
-    connections: Record<string, unknown>;
+    connections: WorkflowConnections;
     authors: string;
     name?: string;
     description?: string;
@@ -48,20 +56,20 @@ interface WorkflowCreate {
     name: string;
     description?: string;
     nodes: WorkflowNode[];
-    connections: Record<string, unknown>;
+    connections: WorkflowConnections;
     settings: WorkflowSettings;
-    staticData?: unknown;
-    pinData?: Record<string, unknown>;
+    staticData?: string | JsonObject | null;
+    pinData?: WorkflowPinData | null;
     projectId?: string;
 }
 interface WorkflowUpdate {
     name: string;
     description?: string;
     nodes: WorkflowNode[];
-    connections: Record<string, unknown>;
+    connections: WorkflowConnections;
     settings: WorkflowSettings;
-    staticData?: unknown;
-    pinData?: Record<string, unknown>;
+    staticData?: string | JsonObject | null;
+    pinData?: WorkflowPinData | null;
 }
 interface WorkflowSettings {
     saveExecutionProgress?: boolean;
@@ -77,10 +85,7 @@ interface WorkflowSettings {
     timeSavedPerExecution?: number;
     redactionPolicy?: 'none' | 'non-manual' | 'manual-only' | 'all';
     availableInMCP?: boolean;
-    customTelemetryTags?: Array<{
-        key: string;
-        value: string;
-    }>;
+    customTelemetryTags?: WorkflowTelemetryTag[];
 }
 interface WorkflowNode {
     id?: string;
@@ -88,8 +93,8 @@ interface WorkflowNode {
     type: string;
     typeVersion?: number;
     position: number[];
-    parameters?: Record<string, unknown>;
-    credentials?: Record<string, unknown>;
+    parameters?: JsonObject;
+    credentials?: JsonObject;
     disabled?: boolean;
     notesInFlow?: boolean;
     notes?: string;
@@ -99,33 +104,58 @@ interface WorkflowNode {
     retryOnFail?: boolean;
     maxTries?: number;
     waitBetweenTries?: number;
+    continueOnFail?: boolean;
     onError?: string;
-    customTelemetryTags?: {
-        tag?: Array<{
-            key: string;
-            value: string;
-        }>;
-    };
+    customTelemetryTags?: WorkflowNodeTelemetryTags;
     createdAt?: string;
     updatedAt?: string;
 }
+interface WorkflowConnection {
+    node: string;
+    type: string;
+    index: number;
+}
+type WorkflowConnectionBranch = WorkflowConnection[];
+interface WorkflowConnectionTypeMap {
+    [connectionType: string]: WorkflowConnectionBranch[];
+}
+interface WorkflowConnections {
+    [sourceNode: string]: WorkflowConnectionTypeMap;
+}
+interface WorkflowTelemetryTag {
+    key: string;
+    value: string;
+}
+interface WorkflowNodeTelemetryTags {
+    tag?: WorkflowTelemetryTag[];
+}
+interface WorkflowPinData {
+    [nodeName: string]: JsonValue;
+}
+interface WorkflowMeta {
+    onboardingId?: string;
+    templateId?: string;
+    instanceId?: string;
+    templateCredsSetupCompleted?: boolean;
+}
 interface SharedWorkflow {
     role: string;
     workflowId: string;
     projectId: string;
-    project?: {
-        id: string;
-        name: string;
-        type: string;
-    };
+    project?: SharedWorkflowProject;
     createdAt: string;
     updatedAt: string;
 }
+interface SharedWorkflowProject {
+    id: string;
+    name: string;
+    type: string;
+}
 interface WorkflowVersion {
     versionId: string;
     workflowId: string;
     nodes: WorkflowNode[];
-    connections: Record<string, unknown>;
+    connections: WorkflowConnections;
     authors: string;
     name?: string;
     description?: string;
@@ -136,11 +166,26 @@ interface WorkflowListResponse {
     data: Workflow[];
     nextCursor?: string;
 }
+interface WorkflowListParams extends PaginationParams {
+    active?: boolean;
+    tags?: string;
+    name?: string;
+    projectId?: string;
+    excludePinnedData?: boolean;
+}
+interface WorkflowGetParams {
+    excludePinnedData?: boolean;
+}
+interface WorkflowActivateRequest {
+    versionId?: string;
+    name?: string;
+    description?: string;
+}
 type ExecutionStatus = 'canceled' | 'crashed' | 'error' | 'new' | 'running' | 'success' | 'unknown' | 'waiting';
 type ExecutionMode = 'cli' | 'error' | 'integrated' | 'internal' | 'manual' | 'retry' | 'trigger' | 'webhook' | 'evaluation' | 'chat';
 interface Execution {
     id: number;
-    data?: Record<string, unknown>;
+    data?: JsonObject;
     finished: boolean;
     mode: ExecutionMode;
     retryOf?: number;
@@ -149,7 +194,7 @@ interface Execution {
     stoppedAt?: string;
     workflowId: number;
     waitTill?: string;
-    customData?: Record<string, unknown>;
+    customData?: JsonObject;
     status: ExecutionStatus;
 }
 interface ExecutionListResponse {
@@ -165,11 +210,25 @@ interface StopManyExecutionsRequest {
 interface StopManyExecutionsResponse {
     stopped: number;
 }
+interface ExecutionListParams extends PaginationParams {
+    includeData?: boolean;
+    redactExecutionData?: boolean;
+    status?: ExecutionStatus;
+    workflowId?: string;
+    projectId?: string;
+}
+interface ExecutionGetParams {
+    includeData?: boolean;
+    redactExecutionData?: boolean;
+}
+interface ExecutionRetryRequest {
+    loadWorkflow?: boolean;
+}
 interface Credential {
     id: string;
     name: string;
     type: string;
-    data?: Record<string, unknown>;
+    data?: JsonObject;
     isResolvable?: boolean;
     createdAt: string;
     updatedAt: string;
@@ -177,13 +236,13 @@ interface Credential {
 interface CredentialCreate {
     name: string;
     type: string;
-    data: Record<string, unknown>;
+    data: JsonObject;
     projectId?: string;
 }
 interface CredentialUpdate {
     name?: string;
     type?: string;
-    data?: Record<string, unknown>;
+    data?: JsonObject;
     isGlobal?: boolean;
     isResolvable?: boolean;
     isPartialData?: boolean;
@@ -231,6 +290,9 @@ interface TagListResponse {
     data: Tag[];
     nextCursor?: string;
 }
+interface TagMutation {
+    name: string;
+}
 interface User {
     id: string;
     email: string;
@@ -259,6 +321,17 @@ interface UserListResponse {
     data: User[];
     nextCursor?: string;
 }
+interface UserListParams extends PaginationParams {
+    offset?: number;
+    includeRole?: boolean;
+    projectId?: string;
+}
+interface UserGetParams {
+    includeRole?: boolean;
+}
+interface UserRoleChangeRequest {
+    newRoleName: string;
+}
 interface Variable {
     id: string;
     key: string;
@@ -275,6 +348,10 @@ interface VariableListResponse {
     data: Variable[];
     nextCursor?: string;
 }
+interface VariableListParams extends PaginationParams {
+    projectId?: string;
+    state?: 'empty';
+}
 interface Project {
     id: string;
     name: string;
@@ -297,6 +374,16 @@ interface ProjectMemberListResponse {
     data: ProjectMember[];
     nextCursor?: string;
 }
+interface ProjectMutation {
+    name: string;
+}
+interface ProjectMemberRelation {
+    userId: string;
+    role: string;
+}
+interface ProjectMemberRoleChangeRequest {
+    role: string;
+}
 interface DataTable {
     id: string;
     name: string;
@@ -316,7 +403,7 @@ interface DataTableRow {
     id: number;
     createdAt?: string;
     updatedAt?: string;
-    [key: string]: unknown;
+    [key: string]: JsonValue | undefined;
 }
 interface CreateDataTableRequest {
     name: string;
@@ -338,8 +425,17 @@ interface UpdateColumnRequest {
     name?: string;
     index?: number;
 }
+interface DataTableListParams extends PaginationParams {
+    filter?: string;
+    sortBy?: string;
+}
+interface DataTableRowListParams extends PaginationParams {
+    filter?: string;
+    sortBy?: string;
+    search?: string;
+}
 interface InsertRowsRequest {
-    data: Record<string, unknown>[];
+    data: JsonObject[];
     returnType?: 'count' | 'id' | 'all';
 }
 interface InsertRowsCountRequest extends InsertRowsRequest {
@@ -356,12 +452,12 @@ interface DataTableFilter {
     filters: Array<{
         columnName: string;
         condition: 'eq' | 'neq' | 'like' | 'ilike' | 'gt' | 'gte' | 'lt' | 'lte';
-        value: unknown;
+        value: JsonValue;
     }>;
 }
 interface UpdateRowsRequest {
     filter: DataTableFilter;
-    data: Record<string, unknown>;
+    data: JsonObject;
     returnData?: boolean;
     dryRun?: boolean;
 }
@@ -373,7 +469,7 @@ interface UpdateRowsDataRequest extends UpdateRowsRequest {
 }
 interface UpsertRowRequest {
     filter: DataTableFilter;
-    data: Record<string, unknown>;
+    data: JsonObject;
     returnData?: boolean;
     dryRun?: boolean;
 }
@@ -426,26 +522,38 @@ interface FolderDetail extends Folder {
     totalSubFolders?: number;
     totalWorkflows?: number;
 }
+interface FolderListParams extends PaginationParams {
+    filter?: string;
+    select?: string;
+    sortBy?: 'name:asc' | 'name:desc' | 'createdAt:asc' | 'createdAt:desc' | 'updatedAt:asc' | 'updatedAt:desc';
+    skip?: string;
+    take?: string;
+}
 interface CommunityPackage {
     packageName: string;
     installedVersion: string;
     authorName: string;
     authorEmail: string;
-    installedNodes: Array<{
-        name: string;
-        type: string;
-        latestVersion: number;
-    }>;
+    installedNodes: CommunityPackageNode[];
     createdAt: string;
     updatedAt: string;
     updateAvailable?: string;
     failedLoading?: boolean;
 }
+interface CommunityPackageNode {
+    name: string;
+    type: string;
+    latestVersion: number;
+}
 interface InstallCommunityPackageRequest {
     name: string;
     version?: string;
     verify?: boolean;
 }
+interface UpdateCommunityPackageRequest {
+    version?: string;
+    verify?: boolean;
+}
 interface AuditAdditionalOptions {
     daysAbandonedWorkflow?: number;
     categories?: Array<'credentials' | 'database' | 'nodes' | 'filesystem' | 'instance'>;
@@ -457,12 +565,32 @@ interface AuditRiskSection {
     title: string;
     description: string;
     recommendation: string;
-    location?: Array<Record<string, unknown>>;
+    location?: AuditRiskLocation[];
 }
 interface AuditRiskReport {
-    risk: string;
+    risk: AuditRisk;
     sections: AuditRiskSection[];
 }
+type AuditRisk = 'credentials' | 'database' | 'filesystem' | 'nodes' | 'execution';
+interface AuditCredentialLocation {
+    kind: 'credential';
+    id: string;
+    name: string;
+}
+interface AuditNodeLocation {
+    kind: 'node';
+    workflowId: string;
+    workflowName: string;
+    nodeId: string;
+    nodeName: string;
+    nodeType: string;
+}
+interface AuditCommunityLocation {
+    kind: 'community';
+    nodeType: string;
+    packageUrl: string;
+}
+type AuditRiskLocation = AuditCredentialLocation | AuditNodeLocation | AuditCommunityLocation;
 interface Audit {
     'Credentials Risk Report'?: AuditRiskReport;
     'Database Risk Report'?: AuditRiskReport;
@@ -482,6 +610,11 @@ interface InsightsSummary {
     timeSaved: InsightsMetric;
     averageRunTime: InsightsMetric;
 }
+interface InsightsSummaryParams {
+    startDate?: string;
+    endDate?: string;
+    projectId?: string;
+}
 interface PullRequest {
     force?: boolean;
     autoPublish?: 'none' | 'all' | 'published';
@@ -498,20 +631,21 @@ interface SourceControlledFile {
     pushed?: boolean;
     isLocalPublished?: boolean;
     isRemoteArchived?: boolean;
-    parentFolderId?: string;
+    parentFolderId?: string | null;
     folderPath?: string[];
-    owner?: {
-        type: 'personal' | 'team';
-        projectId: string;
-        projectName: string;
-    };
+    owner?: SourceControlledOwner;
     publishingError?: string;
 }
+interface SourceControlledOwner {
+    type: 'personal' | 'team';
+    projectId: string;
+    projectName: string;
+}
 interface DiscoverEndpoint {
     method: string;
     path: string;
     operationId: string;
-    requestSchema?: unknown;
+    requestSchema?: JsonObject;
 }
 interface DiscoverResource {
     operations: string[];
@@ -529,6 +663,11 @@ interface DiscoverResponse {
         specUrl: string;
     };
 }
+interface DiscoverParams {
+    include?: 'schemas';
+    resource?: string;
+    operation?: string;
+}
 interface ExportWorkflowsRequest {
     workflowIds: string[];
 }
@@ -554,6 +693,13 @@ interface ImportPackageResponse {
     workflows: ImportPackageWorkflow[];
     bindings: ImportPackageBindings;
 }
+interface ImportPackageOptions {
+    projectId?: string;
+    folderId?: string;
+    credentialMatchingMode?: 'id-only';
+    credentialMissingMode?: 'must-preexist';
+    workflowConflictPolicy: 'new-version' | 'fail' | 'skip';
+}
 interface ImportPackageConflictError {
     code: number;
     message: string;
@@ -575,4 +721,4 @@ interface ImportPackageUnprocessableError {
     }>;
 }
 
-export type { ActiveVersion, Audit, AuditAdditionalOptions, AuditRequest, AuditRiskReport, AuditRiskSection, CommunityPackage, CreateColumnRequest, CreateDataTableRequest, Credential, CredentialCreate, CredentialListItem, CredentialListResponse, CredentialResponse, CredentialSharedItem, CredentialTestResponse, CredentialUpdate, DataTable, DataTableColumn, DataTableFilter, DataTableListResponse, DataTableRow, DataTableRowListResponse, DeleteRowsBooleanParams, DeleteRowsDataParams, DeleteRowsParams, DiscoverEndpoint, DiscoverFilter, DiscoverResource, DiscoverResponse, Execution, ExecutionListResponse, ExecutionMode, ExecutionStatus, ExportWorkflowsRequest, Folder, FolderCreate, FolderDetail, FolderListResponse, FolderUpdate, ImportPackageBindings, ImportPackageConflictError, ImportPackageResponse, ImportPackageUnprocessableError, ImportPackageWorkflow, InsertRowsAllRequest, InsertRowsCountRequest, InsertRowsIdsRequest, InsertRowsRequest, InsightsMetric, InsightsSummary, InstallCommunityPackageRequest, N8nApiError, N8nClientConfig, Project, ProjectListResponse, ProjectMember, ProjectMemberListResponse, PullRequest, SharedWorkflow, SourceControlledFile, StopManyExecutionsRequest, StopManyExecutionsResponse, Tag, TagId, TagListResponse, UpdateColumnRequest, UpdateDataTableRequest, UpdateRowsBooleanRequest, UpdateRowsDataRequest, UpdateRowsRequest, UpsertRowBooleanRequest, UpsertRowDataRequest, UpsertRowRequest, User, UserCreate, UserCreateResponse, UserListResponse, Variable, VariableCreate, VariableListResponse, Workflow, WorkflowCreate, WorkflowListResponse, WorkflowNode, WorkflowSettings, WorkflowUpdate, WorkflowVersion };
+export { type ActiveVersion, type Audit, type AuditAdditionalOptions, type AuditCommunityLocation, type AuditCredentialLocation, type AuditNodeLocation, type AuditRequest, type AuditRisk, type AuditRiskLocation, type AuditRiskReport, type AuditRiskSection, type CommunityPackage, type CommunityPackageNode, type CreateColumnRequest, type CreateDataTableRequest, type Credential, type CredentialCreate, type CredentialListItem, type CredentialListResponse, type CredentialResponse, type CredentialSharedItem, type CredentialTestResponse, type CredentialUpdate, type DataTable, type DataTableColumn, type DataTableFilter, type DataTableListParams, type DataTableListResponse, type DataTableRow, type DataTableRowListParams, type DataTableRowListResponse, type DeleteRowsBooleanParams, type DeleteRowsDataParams, type DeleteRowsParams, type DiscoverEndpoint, type DiscoverFilter, type DiscoverParams, type DiscoverResource, type DiscoverResponse, type Execution, type ExecutionGetParams, type ExecutionListParams, type ExecutionListResponse, type ExecutionMode, type ExecutionRetryRequest, type ExecutionStatus, type ExportWorkflowsRequest, type Folder, type FolderCreate, type FolderDetail, type FolderListParams, type FolderListResponse, type FolderUpdate, type ImportPackageBindings, type ImportPackageConflictError, type ImportPackageOptions, type ImportPackageResponse, type ImportPackageUnprocessableError, type ImportPackageWorkflow, type InsertRowsAllRequest, type InsertRowsCountRequest, type InsertRowsIdsRequest, type InsertRowsRequest, type InsightsMetric, type InsightsSummary, type InsightsSummaryParams, type InstallCommunityPackageRequest, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type N8nApiError, type N8nClientConfig, PaginationParams, type Project, type ProjectListResponse, type ProjectMember, type ProjectMemberListResponse, type ProjectMemberRelation, type ProjectMemberRoleChangeRequest, type ProjectMutation, type PullRequest, type SharedWorkflow, type SharedWorkflowProject, type SourceControlledFile, type SourceControlledOwner, type StopManyExecutionsRequest, type StopManyExecutionsResponse, type Tag, type TagId, type TagListResponse, type TagMutation, type UpdateColumnRequest, type UpdateCommunityPackageRequest, type UpdateDataTableRequest, type UpdateRowsBooleanRequest, type UpdateRowsDataRequest, type UpdateRowsRequest, type UpsertRowBooleanRequest, type UpsertRowDataRequest, type UpsertRowRequest, type User, type UserCreate, type UserCreateResponse, type UserGetParams, type UserListParams, type UserListResponse, type UserRoleChangeRequest, type Variable, type VariableCreate, type VariableListParams, type VariableListResponse, type Workflow, type WorkflowActivateRequest, type WorkflowConnection, type WorkflowConnectionBranch, type WorkflowConnectionTypeMap, type WorkflowConnections, type WorkflowCreate, type WorkflowGetParams, type WorkflowListParams, type WorkflowListResponse, type WorkflowMeta, type WorkflowNode, type WorkflowNodeTelemetryTags, type WorkflowPinData, type WorkflowSettings, type WorkflowTelemetryTag, type WorkflowUpdate, type WorkflowVersion };