n8n
Version:
n8n Workflow Automation Tool
86 lines (85 loc) • 4.41 kB
TypeScript
import { IWorkflowToImport } from '../../interfaces';
import { PullWorkFolderRequestDto, PushWorkFolderRequestDto, type GitCommitInfo, type SourceControlledFile } from '@n8n/api-types';
import { AuthenticatedRequest } from '@n8n/db';
import * as express from 'express';
import type { PullResult } from 'simple-git';
import { SourceControlPreferencesService } from './source-control-preferences.service.ee';
import { SourceControlScopedService } from './source-control-scoped.service';
import { SourceControlService } from './source-control.service.ee';
import type { ImportResult } from './types/import-result';
import { SourceControlRequest } from './types/requests';
import type { SourceControlPreferences } from './types/source-control-preferences';
import { EventService } from '../../events/event.service';
export declare class SourceControlController {
private readonly sourceControlService;
private readonly sourceControlPreferencesService;
private readonly sourceControlScopedService;
private readonly eventService;
constructor(sourceControlService: SourceControlService, sourceControlPreferencesService: SourceControlPreferencesService, sourceControlScopedService: SourceControlScopedService, eventService: EventService);
getPreferences(): Promise<SourceControlPreferences>;
setPreferences(req: SourceControlRequest.UpdatePreferences): Promise<SourceControlPreferences>;
updatePreferences(req: SourceControlRequest.UpdatePreferences): Promise<SourceControlPreferences>;
disconnect(req: SourceControlRequest.Disconnect): Promise<SourceControlPreferences>;
getBranches(): Promise<{
branches: string[];
currentBranch: string;
}>;
pushWorkfolder(req: AuthenticatedRequest, res: express.Response, payload: PushWorkFolderRequestDto): Promise<{
files: SourceControlledFile[];
commit: GitCommitInfo | null;
}>;
pullWorkfolder(req: AuthenticatedRequest, res: express.Response, payload: PullWorkFolderRequestDto): Promise<SourceControlledFile[] | ImportResult | PullResult | undefined>;
resetWorkfolder(): Promise<ImportResult | undefined>;
getStatus(req: SourceControlRequest.GetStatus): Promise<{
status: "unknown" | "new" | "modified" | "deleted" | "created" | "renamed" | "conflicted" | "ignored" | "staged";
type: "workflow" | "project" | "credential" | "tags" | "variables" | "file" | "folders" | "datatable";
id: string;
name: string;
updatedAt: string;
location: "local" | "remote";
file: string;
conflict: boolean;
pushed?: boolean | undefined;
isLocalPublished?: boolean | undefined;
isRemoteArchived?: boolean | undefined;
parentFolderId?: string | null | undefined;
folderPath?: string[] | undefined;
owner?: {
type: "personal" | "team";
projectId: string;
projectName: string;
} | undefined;
publishingError?: string | undefined;
}[] | import("./types/source-control-get-status").SourceControlGetStatusVerboseResult>;
status(req: SourceControlRequest.GetStatus): Promise<{
status: "unknown" | "new" | "modified" | "deleted" | "created" | "renamed" | "conflicted" | "ignored" | "staged";
type: "workflow" | "project" | "credential" | "tags" | "variables" | "file" | "folders" | "datatable";
id: string;
name: string;
updatedAt: string;
location: "local" | "remote";
file: string;
conflict: boolean;
pushed?: boolean | undefined;
isLocalPublished?: boolean | undefined;
isRemoteArchived?: boolean | undefined;
parentFolderId?: string | null | undefined;
folderPath?: string[] | undefined;
owner?: {
type: "personal" | "team";
projectId: string;
projectName: string;
} | undefined;
publishingError?: string | undefined;
}[] | import("./types/source-control-get-status").SourceControlGetStatusVerboseResult>;
generateKeyPair(req: SourceControlRequest.GenerateKeyPair): Promise<SourceControlPreferences>;
getFileContent(req: AuthenticatedRequest & {
params: {
type: SourceControlledFile['type'];
id: string;
};
}): Promise<{
content: IWorkflowToImport;
type: SourceControlledFile['type'];
}>;
}