@egose/n8n-client 0.1.1

package/types.d.ts

@@ -0,0 +1,578 @@
+export { PaginatedResponse, PaginationParams } from './pagination.js';
+
+type N8nClientConfig = {
+    baseUrl: string;
+} & ({
+    apiKey: string;
+    bearerToken?: never;
+} | {
+    bearerToken: string;
+    apiKey?: never;
+});
+interface N8nApiError extends Error {
+    status: number;
+    data: unknown;
+}
+interface Workflow {
+    id: string;
+    name: string;
+    description?: string;
+    active: boolean;
+    createdAt: string;
+    updatedAt: string;
+    isArchived: boolean;
+    versionId: string;
+    triggerCount: number;
+    nodes: WorkflowNode[];
+    connections: Record<string, unknown>;
+    settings?: WorkflowSettings;
+    staticData?: unknown;
+    pinData?: Record<string, unknown>;
+    meta?: Record<string, unknown>;
+    tags?: Tag[];
+    shared?: SharedWorkflow[];
+    activeVersion?: ActiveVersion | null;
+}
+interface ActiveVersion {
+    versionId: string;
+    workflowId: string;
+    nodes: WorkflowNode[];
+    connections: Record<string, unknown>;
+    authors: string;
+    name?: string;
+    description?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface WorkflowCreate {
+    name: string;
+    description?: string;
+    nodes: WorkflowNode[];
+    connections: Record<string, unknown>;
+    settings: WorkflowSettings;
+    staticData?: unknown;
+    pinData?: Record<string, unknown>;
+    projectId?: string;
+}
+interface WorkflowUpdate {
+    name: string;
+    description?: string;
+    nodes: WorkflowNode[];
+    connections: Record<string, unknown>;
+    settings: WorkflowSettings;
+    staticData?: unknown;
+    pinData?: Record<string, unknown>;
+}
+interface WorkflowSettings {
+    saveExecutionProgress?: boolean;
+    saveManualExecutions?: boolean;
+    saveDataErrorExecution?: 'all' | 'none';
+    saveDataSuccessExecution?: 'all' | 'none';
+    executionTimeout?: number;
+    errorWorkflow?: string;
+    timezone?: string;
+    executionOrder?: string;
+    callerPolicy?: 'any' | 'none' | 'workflowsFromAList' | 'workflowsFromSameOwner';
+    callerIds?: string;
+    timeSavedPerExecution?: number;
+    redactionPolicy?: 'none' | 'non-manual' | 'manual-only' | 'all';
+    availableInMCP?: boolean;
+    customTelemetryTags?: Array<{
+        key: string;
+        value: string;
+    }>;
+}
+interface WorkflowNode {
+    id?: string;
+    name: string;
+    type: string;
+    typeVersion?: number;
+    position: number[];
+    parameters?: Record<string, unknown>;
+    credentials?: Record<string, unknown>;
+    disabled?: boolean;
+    notesInFlow?: boolean;
+    notes?: string;
+    webhookId?: string;
+    executeOnce?: boolean;
+    alwaysOutputData?: boolean;
+    retryOnFail?: boolean;
+    maxTries?: number;
+    waitBetweenTries?: number;
+    onError?: string;
+    customTelemetryTags?: {
+        tag?: Array<{
+            key: string;
+            value: string;
+        }>;
+    };
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface SharedWorkflow {
+    role: string;
+    workflowId: string;
+    projectId: string;
+    project?: {
+        id: string;
+        name: string;
+        type: string;
+    };
+    createdAt: string;
+    updatedAt: string;
+}
+interface WorkflowVersion {
+    versionId: string;
+    workflowId: string;
+    nodes: WorkflowNode[];
+    connections: Record<string, unknown>;
+    authors: string;
+    name?: string;
+    description?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface WorkflowListResponse {
+    data: Workflow[];
+    nextCursor?: 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>;
+    finished: boolean;
+    mode: ExecutionMode;
+    retryOf?: number;
+    retrySuccessId?: number;
+    startedAt: string;
+    stoppedAt?: string;
+    workflowId: number;
+    waitTill?: string;
+    customData?: Record<string, unknown>;
+    status: ExecutionStatus;
+}
+interface ExecutionListResponse {
+    data: Execution[];
+    nextCursor?: string;
+}
+interface StopManyExecutionsRequest {
+    status: Array<'queued' | 'running' | 'waiting'>;
+    workflowId?: string;
+    startedAfter?: string;
+    startedBefore?: string;
+}
+interface StopManyExecutionsResponse {
+    stopped: number;
+}
+interface Credential {
+    id: string;
+    name: string;
+    type: string;
+    data?: Record<string, unknown>;
+    isResolvable?: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CredentialCreate {
+    name: string;
+    type: string;
+    data: Record<string, unknown>;
+    projectId?: string;
+}
+interface CredentialUpdate {
+    name?: string;
+    type?: string;
+    data?: Record<string, unknown>;
+    isGlobal?: boolean;
+    isResolvable?: boolean;
+    isPartialData?: boolean;
+}
+interface CredentialResponse {
+    id: string;
+    name: string;
+    type: string;
+    isManaged: boolean;
+    isGlobal: boolean;
+    isResolvable: boolean;
+    resolvableAllowFallback?: boolean;
+    resolverId?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CredentialListItem extends CredentialResponse {
+    shared: CredentialSharedItem[];
+}
+interface CredentialSharedItem {
+    id: string;
+    name: string;
+    role: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CredentialTestResponse {
+    status: 'OK' | 'Error';
+    message: string;
+}
+interface CredentialListResponse {
+    data: CredentialListItem[];
+    nextCursor?: string;
+}
+interface Tag {
+    id: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface TagId {
+    id: string;
+}
+interface TagListResponse {
+    data: Tag[];
+    nextCursor?: string;
+}
+interface User {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    isPending: boolean;
+    createdAt: string;
+    updatedAt: string;
+    role?: string;
+    mfaEnabled?: boolean;
+}
+interface UserCreate {
+    email: string;
+    role?: string;
+}
+interface UserCreateResponse {
+    user: {
+        id: string;
+        email: string;
+        inviteAcceptUrl?: string;
+        emailSent?: boolean;
+    };
+    error?: string;
+}
+interface UserListResponse {
+    data: User[];
+    nextCursor?: string;
+}
+interface Variable {
+    id: string;
+    key: string;
+    value: string;
+    type?: string;
+    project?: Project;
+}
+interface VariableCreate {
+    key: string;
+    value: string;
+    projectId?: string;
+}
+interface VariableListResponse {
+    data: Variable[];
+    nextCursor?: string;
+}
+interface Project {
+    id: string;
+    name: string;
+    type?: string;
+}
+interface ProjectMember {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    createdAt: string;
+    updatedAt: string;
+    role: string;
+}
+interface ProjectListResponse {
+    data: Project[];
+    nextCursor?: string;
+}
+interface ProjectMemberListResponse {
+    data: ProjectMember[];
+    nextCursor?: string;
+}
+interface DataTable {
+    id: string;
+    name: string;
+    columns: DataTableColumn[];
+    projectId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface DataTableColumn {
+    id: string;
+    name: string;
+    dataTableId: string;
+    type: 'string' | 'number' | 'boolean' | 'date';
+    index: number;
+}
+interface DataTableRow {
+    id: number;
+    createdAt?: string;
+    updatedAt?: string;
+    [key: string]: unknown;
+}
+interface CreateDataTableRequest {
+    name: string;
+    columns: Array<{
+        name: string;
+        type: 'string' | 'number' | 'boolean' | 'date' | 'json';
+    }>;
+    projectId?: string;
+}
+interface UpdateDataTableRequest {
+    name: string;
+}
+interface CreateColumnRequest {
+    name: string;
+    type: 'string' | 'number' | 'boolean' | 'date';
+    index?: number;
+}
+interface UpdateColumnRequest {
+    name?: string;
+    index?: number;
+}
+interface InsertRowsRequest {
+    data: Record<string, unknown>[];
+    returnType?: 'count' | 'id' | 'all';
+}
+interface InsertRowsCountRequest extends InsertRowsRequest {
+    returnType?: 'count';
+}
+interface InsertRowsIdsRequest extends InsertRowsRequest {
+    returnType: 'id';
+}
+interface InsertRowsAllRequest extends InsertRowsRequest {
+    returnType: 'all';
+}
+interface DataTableFilter {
+    type?: 'and' | 'or';
+    filters: Array<{
+        columnName: string;
+        condition: 'eq' | 'neq' | 'like' | 'ilike' | 'gt' | 'gte' | 'lt' | 'lte';
+        value: unknown;
+    }>;
+}
+interface UpdateRowsRequest {
+    filter: DataTableFilter;
+    data: Record<string, unknown>;
+    returnData?: boolean;
+    dryRun?: boolean;
+}
+interface UpdateRowsBooleanRequest extends UpdateRowsRequest {
+    returnData?: false;
+}
+interface UpdateRowsDataRequest extends UpdateRowsRequest {
+    returnData: true;
+}
+interface UpsertRowRequest {
+    filter: DataTableFilter;
+    data: Record<string, unknown>;
+    returnData?: boolean;
+    dryRun?: boolean;
+}
+interface UpsertRowBooleanRequest extends UpsertRowRequest {
+    returnData?: false;
+}
+interface UpsertRowDataRequest extends UpsertRowRequest {
+    returnData: true;
+}
+interface DeleteRowsParams {
+    filter: string;
+    returnData?: boolean;
+    dryRun?: boolean;
+    [key: string]: unknown;
+}
+interface DeleteRowsBooleanParams extends DeleteRowsParams {
+    returnData?: false;
+}
+interface DeleteRowsDataParams extends DeleteRowsParams {
+    returnData: true;
+}
+interface DataTableListResponse {
+    data: DataTable[];
+    nextCursor?: string;
+}
+interface DataTableRowListResponse {
+    data: DataTableRow[];
+    nextCursor?: string;
+}
+interface Folder {
+    id: string;
+    name: string;
+    parentFolderId?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface FolderCreate {
+    name: string;
+    parentFolderId?: string;
+}
+interface FolderUpdate {
+    name?: string;
+    parentFolderId?: string;
+}
+interface FolderListResponse {
+    count: number;
+    data: Folder[];
+}
+interface FolderDetail extends Folder {
+    totalSubFolders?: number;
+    totalWorkflows?: number;
+}
+interface CommunityPackage {
+    packageName: string;
+    installedVersion: string;
+    authorName: string;
+    authorEmail: string;
+    installedNodes: Array<{
+        name: string;
+        type: string;
+        latestVersion: number;
+    }>;
+    createdAt: string;
+    updatedAt: string;
+    updateAvailable?: string;
+    failedLoading?: boolean;
+}
+interface InstallCommunityPackageRequest {
+    name: string;
+    version?: string;
+    verify?: boolean;
+}
+interface AuditAdditionalOptions {
+    daysAbandonedWorkflow?: number;
+    categories?: Array<'credentials' | 'database' | 'nodes' | 'filesystem' | 'instance'>;
+}
+interface AuditRequest {
+    additionalOptions?: AuditAdditionalOptions;
+}
+interface AuditRiskSection {
+    title: string;
+    description: string;
+    recommendation: string;
+    location?: Array<Record<string, unknown>>;
+}
+interface AuditRiskReport {
+    risk: string;
+    sections: AuditRiskSection[];
+}
+interface Audit {
+    'Credentials Risk Report'?: AuditRiskReport;
+    'Database Risk Report'?: AuditRiskReport;
+    'Filesystem Risk Report'?: AuditRiskReport;
+    'Nodes Risk Report'?: AuditRiskReport;
+    'Instance Risk Report'?: AuditRiskReport;
+}
+interface InsightsMetric {
+    value: number;
+    deviation: number | null;
+    unit: string;
+}
+interface InsightsSummary {
+    total: InsightsMetric;
+    failed: InsightsMetric;
+    failureRate: InsightsMetric;
+    timeSaved: InsightsMetric;
+    averageRunTime: InsightsMetric;
+}
+interface PullRequest {
+    force?: boolean;
+    autoPublish?: 'none' | 'all' | 'published';
+}
+interface SourceControlledFile {
+    file: string;
+    id: string;
+    name: string;
+    type: 'credential' | 'workflow' | 'tags' | 'variables' | 'file' | 'folders' | 'project' | 'datatable';
+    status: 'new' | 'modified' | 'deleted' | 'created' | 'renamed' | 'conflicted' | 'ignored' | 'staged' | 'unknown';
+    location: 'local' | 'remote';
+    conflict: boolean;
+    updatedAt: string;
+    pushed?: boolean;
+    isLocalPublished?: boolean;
+    isRemoteArchived?: boolean;
+    parentFolderId?: string;
+    folderPath?: string[];
+    owner?: {
+        type: 'personal' | 'team';
+        projectId: string;
+        projectName: string;
+    };
+    publishingError?: string;
+}
+interface DiscoverEndpoint {
+    method: string;
+    path: string;
+    operationId: string;
+    requestSchema?: unknown;
+}
+interface DiscoverResource {
+    operations: string[];
+    endpoints: DiscoverEndpoint[];
+}
+interface DiscoverFilter {
+    description: string;
+    values: string[];
+}
+interface DiscoverResponse {
+    data: {
+        scopes: string[];
+        resources: Record<string, DiscoverResource>;
+        filters: Record<string, DiscoverFilter>;
+        specUrl: string;
+    };
+}
+interface ExportWorkflowsRequest {
+    workflowIds: string[];
+}
+interface ImportPackageWorkflow {
+    sourceWorkflowId: string;
+    localId: string;
+    name: string;
+    projectId: string;
+    parentFolderId: string | null;
+    activeVersionId: string | null;
+    status: 'created' | 'updated' | 'skipped';
+}
+interface ImportPackageBindings {
+    workflows: Record<string, string>;
+    credentials: Record<string, string>;
+}
+interface ImportPackageResponse {
+    package: {
+        sourceN8nVersion: string;
+        sourceId: string;
+        exportedAt: string;
+    };
+    workflows: ImportPackageWorkflow[];
+    bindings: ImportPackageBindings;
+}
+interface ImportPackageConflictError {
+    code: number;
+    message: string;
+    meta: {
+        code: 'WORKFLOW_CONFLICT';
+        conflicts: Array<{
+            sourceWorkflowId: string;
+            existingWorkflowId: string;
+            name: string;
+        }>;
+    };
+}
+interface ImportPackageUnprocessableError {
+    message: string;
+    failures: Array<{
+        kind: 'not_found' | 'unknown_type';
+        sourceId: string;
+        usedByWorkflows: string[];
+    }>;
+}
+
+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 };

package/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/utils/retry.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunk7B5DLJYYcjs = require('../chunk-7B5DLJYY.cjs');
+
+
+exports.retryTransientError = _chunk7B5DLJYYcjs.retryTransientError;
+//# sourceMappingURL=retry.cjs.map

package/utils/retry.d.cts

@@ -0,0 +1,3 @@
+declare function retryTransientError<T>(operation: () => Promise<T>, attempts?: number): Promise<T>;
+
+export { retryTransientError };

package/utils/retry.d.ts

@@ -0,0 +1,3 @@
+declare function retryTransientError<T>(operation: () => Promise<T>, attempts?: number): Promise<T>;
+
+export { retryTransientError };

package/utils/retry.js

@@ -0,0 +1,7 @@
+import {
+  retryTransientError
+} from "../chunk-DURH6QOX.js";
+export {
+  retryTransientError
+};
+//# sourceMappingURL=retry.js.map