-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathpitstop-server-cli.d.ts
112 lines (112 loc) · 3.26 KB
/
pitstop-server-cli.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/**
* Export of the interface for the options when constructing a new instance of the PitStopServer class
*/
export interface PitStopServerOptions {
inputPDF: string;
outputPDFName?: string;
outputFolder: string;
preflightProfile?: string;
actionLists?: string[];
variableSet?: string;
variableSetName?: string;
pdfReport?: boolean;
pdfReportName?: string;
xmlReport?: boolean;
xmlReportName?: string;
taskReport?: boolean;
taskReportName?: string;
configFile?: string;
configFileName?: string;
applicationPath?: string;
measurementUnit?: "Millimeter" | "Centimeter" | "Inch" | "Point";
language?: string;
}
/**
* Export of the interface for each individual variable for use in VariableSetOptions
*/
export interface VSOption {
variable: string;
type: "Number" | "String" | "Boolean" | "Length";
value: string | number | boolean;
}
/**
* Export of the interface for the creation or update of a variable set (an array of VSOption)
*/
export interface VariableSetOptions extends Array<VSOption> {
}
/**
* Export of the class PitStop Server
*/
export declare class PitStopServer {
static applicationPath: string;
private configFile;
private configFileName;
private finalConfigFilePath;
private inputPDF;
private outputPDFName;
private outputFolder;
private preflightProfile;
private actionLists;
private variableSet;
private variableSetName;
private finalVariableSetPath;
private pdfReport;
private pdfReportName;
private xmlReport;
private xmlReportName;
private taskReport;
private taskReportName;
debugMessages: string[];
private measurementUnit?;
private language?;
private startExecutionTime;
private endExecutionTime;
executionTime: number;
/**
* Constructs a PitStopServer instance
* @param options
*/
constructor(options: PitStopServerOptions);
/**
* Runs PitStop Server
* @returns execution result
*/
run: () => Promise<Record<string, any>>;
/**
* Based on a simple object the variable set file is created and saved in the output folder
* @param values
*/
createVariableSet: (values: VariableSetOptions) => void;
/**
* The variable set template is updated and saved in its final version to the output folder
* @param values
*/
updateVariableSet: (values: VariableSetOptions) => void;
/**
* Removes the output folder and all the contents
*/
cleanup: () => void;
/**
* Updates the config file with all settings just before running PitStop Server
*/
private updateConfigFile;
/**
* Creates an XML string of a basic configuration file for PitStop Server
*/
private createBasicConfigFile;
/**
* Static method returning the version number of PitStop Server
* @returns string
*/
static getVersion: () => Promise<any>;
/**
* Static function to get the path of the CLI application of PitStop Server
* @returns string
*/
static getApplicationPath: () => string;
/**
* Private static method to find the path to the PitStop Server CLI application in the Windows registry
* @returns string
*/
private static findPitStopServerInRegistry;
}