@uniformdev/cli 17.7.0 → 17.7.1-alpha.140
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1 -1
- package/dist/sync/index.d.ts +12 -12
- package/package.json +5 -5
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { CommandModule } from 'yargs';
|
|
3
3
|
|
|
4
4
|
/** Export this type as `uniformCLI` from a package to define a Uniform CLI plugin. The plugin must be known to the CLI as well. */
|
|
5
|
-
|
|
5
|
+
type UniformCLIPlugin = {
|
|
6
6
|
commands: Array<CommandModule>;
|
|
7
7
|
};
|
|
8
8
|
|
package/dist/sync/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Change } from 'diff';
|
|
2
2
|
import { Argv } from 'yargs';
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
type SyncEngineLogOptions = {
|
|
5
5
|
id: string;
|
|
6
6
|
providerId: string;
|
|
7
7
|
displayName: string;
|
|
@@ -9,7 +9,7 @@ declare type SyncEngineLogOptions = {
|
|
|
9
9
|
whatIf: boolean;
|
|
10
10
|
diff: Change[];
|
|
11
11
|
};
|
|
12
|
-
|
|
12
|
+
type SyncEngineObject<TObject> = {
|
|
13
13
|
/** Unique ID that is identical across all providers */
|
|
14
14
|
id: string;
|
|
15
15
|
/** Provider specific ID. Value is provided to deleteObject() function (always the provider ID from the same provider that issued it). */
|
|
@@ -19,7 +19,7 @@ declare type SyncEngineObject<TObject> = {
|
|
|
19
19
|
/** The object being synced. */
|
|
20
20
|
object: TObject;
|
|
21
21
|
};
|
|
22
|
-
|
|
22
|
+
type SyncEngineDataSource<TObject> = {
|
|
23
23
|
/** The objects to sync. */
|
|
24
24
|
objects: AsyncIterable<SyncEngineObject<TObject>>;
|
|
25
25
|
/**
|
|
@@ -39,7 +39,7 @@ declare type SyncEngineDataSource<TObject> = {
|
|
|
39
39
|
*/
|
|
40
40
|
onSyncComplete?: (isTarget: boolean) => Promise<void>;
|
|
41
41
|
};
|
|
42
|
-
|
|
42
|
+
type SyncEngineOptions<TObject> = {
|
|
43
43
|
source: SyncEngineDataSource<TObject>;
|
|
44
44
|
target: SyncEngineDataSource<TObject>;
|
|
45
45
|
compareContents?: (source: SyncEngineObject<TObject>, target: SyncEngineObject<TObject>) => boolean;
|
|
@@ -55,7 +55,7 @@ declare class SyncEngineError<TObject> extends Error {
|
|
|
55
55
|
constructor(innerError: unknown, sourceObject: SyncEngineObject<TObject>);
|
|
56
56
|
}
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
type CreateArraySyncEngineDataSourceOptions<TObject> = {
|
|
59
59
|
objects: Array<TObject>;
|
|
60
60
|
selectIdentifier: (object: TObject) => string;
|
|
61
61
|
selectDisplayName?: (object: TObject) => string;
|
|
@@ -65,7 +65,7 @@ declare function createArraySyncEngineDataSource<TObject>({ objects, selectIdent
|
|
|
65
65
|
extractCurrent: () => Array<TObject>;
|
|
66
66
|
}>;
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
type CreateFileSyncEngineDataSourceOptions<TObject> = {
|
|
69
69
|
directory: string;
|
|
70
70
|
selectIdentifier: (object: TObject) => string;
|
|
71
71
|
selectDisplayName?: (object: TObject) => string;
|
|
@@ -74,36 +74,36 @@ declare type CreateFileSyncEngineDataSourceOptions<TObject> = {
|
|
|
74
74
|
};
|
|
75
75
|
declare function createFileSyncEngineDataSource<TObject>({ directory, format, selectIdentifier, selectDisplayName, selectFilename, }: CreateFileSyncEngineDataSourceOptions<TObject>): Promise<SyncEngineDataSource<TObject>>;
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
type UniformPackage = {
|
|
78
78
|
[key: string]: unknown;
|
|
79
79
|
};
|
|
80
80
|
declare function readUniformPackage(filename: string, assertExists: boolean): UniformPackage;
|
|
81
81
|
declare function writeUniformPackage(filename: string, packageContents: UniformPackage): void;
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
type DiffMode = 'off' | 'on' | 'update';
|
|
84
84
|
declare function createSyncEngineConsoleLogger(options?: {
|
|
85
85
|
diffMode?: DiffMode;
|
|
86
86
|
indent?: string;
|
|
87
87
|
prefix?: string;
|
|
88
88
|
}): ({ action, displayName, whatIf, diff }: SyncEngineLogOptions) => void;
|
|
89
89
|
|
|
90
|
-
|
|
90
|
+
type ApiArgs = {
|
|
91
91
|
apiKey: string;
|
|
92
92
|
apiHost: string;
|
|
93
93
|
proxy?: string;
|
|
94
94
|
};
|
|
95
95
|
declare function withApiOptions<T>(yargs: Argv<T>): Argv<T>;
|
|
96
96
|
declare function nodeFetchProxy(proxy: string | undefined): typeof fetch;
|
|
97
|
-
|
|
97
|
+
type ProjectArgs = {
|
|
98
98
|
project: string;
|
|
99
99
|
};
|
|
100
100
|
declare function withProjectOptions<T>(yargs: Argv<T>): Argv<T>;
|
|
101
|
-
|
|
101
|
+
type FormatArgs = {
|
|
102
102
|
format: 'json' | 'yaml';
|
|
103
103
|
filename?: string;
|
|
104
104
|
};
|
|
105
105
|
declare function withFormatOptions<T>(yargs: Argv<T>): Argv<T>;
|
|
106
|
-
|
|
106
|
+
type DiffArgs = {
|
|
107
107
|
diff: DiffMode;
|
|
108
108
|
};
|
|
109
109
|
declare function withDiffOptions<T>(yargs: Argv<T>): Argv<T>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/cli",
|
|
3
|
-
"version": "17.7.
|
|
3
|
+
"version": "17.7.1-alpha.140+80ab6baf9",
|
|
4
4
|
"description": "Uniform command line interface tool",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"main": "./cli.js",
|
|
@@ -35,18 +35,18 @@
|
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
37
|
"diff": "^5.0.0",
|
|
38
|
-
"dotenv": "^16.0.
|
|
38
|
+
"dotenv": "^16.0.3",
|
|
39
39
|
"https-proxy-agent": "^5.0.1",
|
|
40
40
|
"isomorphic-unfetch": "^3.1.0",
|
|
41
41
|
"js-yaml": "^4.1.0",
|
|
42
42
|
"lodash.isequalwith": "^4.4.0",
|
|
43
|
-
"yargs": "^17.
|
|
43
|
+
"yargs": "^17.6.2"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@types/diff": "5.0.2",
|
|
47
47
|
"@types/js-yaml": "4.0.5",
|
|
48
48
|
"@types/lodash.isequalwith": "4.4.7",
|
|
49
|
-
"@types/yargs": "17.0.
|
|
49
|
+
"@types/yargs": "17.0.19"
|
|
50
50
|
},
|
|
51
51
|
"bin": {
|
|
52
52
|
"uniform": "./cli.js"
|
|
@@ -57,5 +57,5 @@
|
|
|
57
57
|
"publishConfig": {
|
|
58
58
|
"access": "public"
|
|
59
59
|
},
|
|
60
|
-
"gitHead": "
|
|
60
|
+
"gitHead": "80ab6baf9edea6b520738bd3dff5c6afc882bf77"
|
|
61
61
|
}
|