@mikeyt23/node-cli-utils 2.0.0-beta.1 → 2.0.0-beta.2

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.
Files changed (51) hide show
  1. package/dist/cjs/GitUtility.d.ts +7 -0
  2. package/dist/cjs/GitUtility.d.ts.map +1 -0
  3. package/dist/cjs/GitUtility.js +49 -0
  4. package/dist/cjs/TarballUtility.d.ts +17 -7
  5. package/dist/cjs/TarballUtility.d.ts.map +1 -1
  6. package/dist/cjs/TarballUtility.js +18 -24
  7. package/dist/cjs/certUtils.d.ts +53 -17
  8. package/dist/cjs/certUtils.d.ts.map +1 -1
  9. package/dist/cjs/certUtils.js +175 -111
  10. package/dist/cjs/dbMigrationUtils.js +44 -54
  11. package/dist/cjs/dotnetUtils.d.ts.map +1 -1
  12. package/dist/cjs/dotnetUtils.js +4 -2
  13. package/dist/cjs/esmSpecific.d.mts +5 -0
  14. package/dist/cjs/esmSpecific.d.mts.map +1 -1
  15. package/dist/cjs/esmSpecific.mjs +6 -1
  16. package/dist/cjs/generalUtils.d.ts +268 -26
  17. package/dist/cjs/generalUtils.d.ts.map +1 -1
  18. package/dist/cjs/generalUtils.js +522 -106
  19. package/dist/cjs/generalUtilsInternal.d.ts +9 -3
  20. package/dist/cjs/generalUtilsInternal.d.ts.map +1 -1
  21. package/dist/cjs/generalUtilsInternal.js +159 -59
  22. package/dist/cjs/hostsUtils.d.ts +16 -0
  23. package/dist/cjs/hostsUtils.d.ts.map +1 -0
  24. package/dist/cjs/hostsUtils.js +82 -0
  25. package/dist/cjs/runWhileParentAlive.js +7 -9
  26. package/dist/esm/GitUtility.d.ts +7 -0
  27. package/dist/esm/GitUtility.d.ts.map +1 -0
  28. package/dist/esm/GitUtility.js +43 -0
  29. package/dist/esm/TarballUtility.d.ts +17 -7
  30. package/dist/esm/TarballUtility.d.ts.map +1 -1
  31. package/dist/esm/TarballUtility.js +21 -25
  32. package/dist/esm/certUtils.d.ts +53 -17
  33. package/dist/esm/certUtils.d.ts.map +1 -1
  34. package/dist/esm/certUtils.js +172 -86
  35. package/dist/esm/dbMigrationUtils.js +45 -55
  36. package/dist/esm/dotnetUtils.d.ts.map +1 -1
  37. package/dist/esm/dotnetUtils.js +4 -2
  38. package/dist/esm/esmSpecific.d.mts +5 -0
  39. package/dist/esm/esmSpecific.d.mts.map +1 -1
  40. package/dist/esm/esmSpecific.mjs +6 -1
  41. package/dist/esm/generalUtils.d.ts +268 -26
  42. package/dist/esm/generalUtils.d.ts.map +1 -1
  43. package/dist/esm/generalUtils.js +490 -105
  44. package/dist/esm/generalUtilsInternal.d.ts +9 -3
  45. package/dist/esm/generalUtilsInternal.d.ts.map +1 -1
  46. package/dist/esm/generalUtilsInternal.js +150 -57
  47. package/dist/esm/hostsUtils.d.ts +16 -0
  48. package/dist/esm/hostsUtils.d.ts.map +1 -0
  49. package/dist/esm/hostsUtils.js +69 -0
  50. package/dist/esm/runWhileParentAlive.js +8 -10
  51. package/package.json +4 -2
@@ -0,0 +1,7 @@
1
+ import { spawnAsync } from './generalUtils.js';
2
+ export interface GitUtilityDependencies {
3
+ spawnAsyncFn: typeof spawnAsync;
4
+ }
5
+ export declare const isValidBranchName: (branchName: string) => boolean;
6
+ export declare const cloneProject: (repoUrl: string, localDestPath: string, branchName?: string, deleteGitFolder?: boolean) => Promise<void>;
7
+ //# sourceMappingURL=GitUtility.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GitUtility.d.ts","sourceRoot":"","sources":["../../src/GitUtility.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAGtD,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,OAAO,UAAU,CAAA;CAChC;AAgDD,eAAO,MAAM,iBAAiB,eAvCE,MAAM,KAAG,OAuC2B,CAAA;AACpE,eAAO,MAAM,YAAY,YAzBK,MAAM,iBAAiB,MAAM,eAAc,MAAM,oBAA4B,OAAO,kBAyBxD,CAAA"}
@@ -0,0 +1,49 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.cloneProject = exports.isValidBranchName = void 0;
7
+ const node_fs_1 = __importDefault(require("node:fs"));
8
+ const promises_1 = __importDefault(require("node:fs/promises"));
9
+ const generalUtils_js_1 = require("./generalUtils.js");
10
+ const node_path_1 = require("node:path");
11
+ class GitUtility {
12
+ constructor(dependencies = {}) {
13
+ var _a;
14
+ this.spawnAsyncFn = (_a = dependencies.spawnAsyncFn) !== null && _a !== void 0 ? _a : generalUtils_js_1.spawnAsync;
15
+ }
16
+ isValidBranchName(branchName) {
17
+ if (branchName.startsWith('-') || branchName.endsWith('/') || branchName.endsWith('.') || branchName.endsWith('@{') || branchName.includes('..')) {
18
+ return false;
19
+ }
20
+ const invalidChars = [' ', '~', '^', ':', '\\', '*', '?', '[', ']', '/'];
21
+ for (const char of branchName) {
22
+ if (invalidChars.includes(char)) {
23
+ return false;
24
+ }
25
+ }
26
+ return true;
27
+ }
28
+ async cloneProject(repoUrl, localDestPath, branchName = 'main', deleteGitFolder = true) {
29
+ if (node_fs_1.default.existsSync(localDestPath)) {
30
+ throw new Error(`Cannot clone project - destination path already exists: ${localDestPath}`);
31
+ }
32
+ if (!this.isValidBranchName(branchName)) {
33
+ throw new Error(`Cannot clone project - invalid branch name: ${branchName}`);
34
+ }
35
+ await (0, generalUtils_js_1.mkdirp)(localDestPath);
36
+ const cloneArgs = `clone -b ${branchName} --single-branch --depth 1 ${repoUrl} ${localDestPath}`.split(' ');
37
+ const result = await this.spawnAsyncFn('git', cloneArgs);
38
+ if (result.code !== 0) {
39
+ throw new Error(`Failed to clone project '${result.stderr}' to '${localDestPath}'`);
40
+ }
41
+ if (deleteGitFolder) {
42
+ await promises_1.default.rm((0, node_path_1.join)(localDestPath, '.git'), { recursive: true });
43
+ }
44
+ }
45
+ }
46
+ const defaultGitUtility = new GitUtility();
47
+ exports.isValidBranchName = defaultGitUtility.isValidBranchName;
48
+ exports.cloneProject = defaultGitUtility.cloneProject;
49
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiR2l0VXRpbGl0eS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9HaXRVdGlsaXR5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7OztBQUFBLHNEQUF3QjtBQUN4QixnRUFBa0M7QUFDbEMsdURBQXNEO0FBQ3RELHlDQUFnQztBQU1oQyxNQUFNLFVBQVU7SUFHZCxZQUFZLGVBQWdELEVBQUU7O1FBQzVELElBQUksQ0FBQyxZQUFZLEdBQUcsTUFBQSxZQUFZLENBQUMsWUFBWSxtQ0FBSSw0QkFBVSxDQUFBO0lBQzdELENBQUM7SUFFRCxpQkFBaUIsQ0FBQyxVQUFrQjtRQUNsQyxJQUFJLFVBQVUsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLElBQUksVUFBVSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsSUFBSSxVQUFVLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxJQUFJLFVBQVUsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLElBQUksVUFBVSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUNoSixPQUFPLEtBQUssQ0FBQTtTQUNiO1FBRUQsTUFBTSxZQUFZLEdBQUcsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLEdBQUcsRUFBRSxHQUFHLEVBQUUsR0FBRyxFQUFFLEdBQUcsRUFBRSxHQUFHLENBQUMsQ0FBQTtRQUN4RSxLQUFLLE1BQU0sSUFBSSxJQUFJLFVBQVUsRUFBRTtZQUM3QixJQUFJLFlBQVksQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLEVBQUU7Z0JBQy9CLE9BQU8sS0FBSyxDQUFBO2FBQ2I7U0FDRjtRQUVELE9BQU8sSUFBSSxDQUFBO0lBQ2IsQ0FBQztJQUVELEtBQUssQ0FBQyxZQUFZLENBQUMsT0FBZSxFQUFFLGFBQXFCLEVBQUUsYUFBcUIsTUFBTSxFQUFFLGtCQUEyQixJQUFJO1FBQ3JILElBQUksaUJBQUUsQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLEVBQUU7WUFDaEMsTUFBTSxJQUFJLEtBQUssQ0FBQywyREFBMkQsYUFBYSxFQUFFLENBQUMsQ0FBQTtTQUM1RjtRQUNELElBQUksQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsVUFBVSxDQUFDLEVBQUU7WUFDdkMsTUFBTSxJQUFJLEtBQUssQ0FBQywrQ0FBK0MsVUFBVSxFQUFFLENBQUMsQ0FBQTtTQUM3RTtRQUVELE1BQU0sSUFBQSx3QkFBTSxFQUFDLGFBQWEsQ0FBQyxDQUFBO1FBRTNCLE1BQU0sU0FBUyxHQUFHLFlBQVksVUFBVSw4QkFBOEIsT0FBTyxJQUFJLGFBQWEsRUFBRSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQTtRQUMzRyxNQUFNLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxZQUFZLENBQUMsS0FBSyxFQUFFLFNBQVMsQ0FBQyxDQUFBO1FBQ3hELElBQUksTUFBTSxDQUFDLElBQUksS0FBSyxDQUFDLEVBQUU7WUFDckIsTUFBTSxJQUFJLEtBQUssQ0FBQyw0QkFBNEIsTUFBTSxDQUFDLE1BQU0sU0FBUyxhQUFhLEdBQUcsQ0FBQyxDQUFBO1NBQ3BGO1FBRUQsSUFBSSxlQUFlLEVBQUU7WUFDbkIsTUFBTSxrQkFBRyxDQUFDLEVBQUUsQ0FBQyxJQUFBLGdCQUFJLEVBQUMsYUFBYSxFQUFFLE1BQU0sQ0FBQyxFQUFFLEVBQUUsU0FBUyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUE7U0FDL0Q7SUFDSCxDQUFDO0NBQ0Y7QUFFRCxNQUFNLGlCQUFpQixHQUFHLElBQUksVUFBVSxFQUFFLENBQUE7QUFFN0IsUUFBQSxpQkFBaUIsR0FBRyxpQkFBaUIsQ0FBQyxpQkFBaUIsQ0FBQTtBQUN2RCxRQUFBLFlBQVksR0FBRyxpQkFBaUIsQ0FBQyxZQUFZLENBQUEifQ==
@@ -1,4 +1,5 @@
1
- import { whichSync } from './generalUtils.js';
1
+ import fs from 'node:fs';
2
+ import { mkdirp, spawnAsync, whichSync } from './generalUtils.js';
2
3
  export interface CreateTarballOptions {
3
4
  /**
4
5
  * A list of files or directories to exclude from the tarball.
@@ -7,16 +8,25 @@ export interface CreateTarballOptions {
7
8
  excludes?: string[];
8
9
  }
9
10
  export interface TarballUnpackOptions {
10
- createDirIfNotExists?: boolean;
11
- stripComponents?: number;
12
- throwOnNonEmptyUnpackDir?: boolean;
11
+ createDirIfNotExists: boolean;
12
+ stripComponents: number;
13
+ throwOnNonEmptyUnpackDir: boolean;
14
+ }
15
+ export interface TarballUtilityDependencies {
16
+ whichSyncFn: typeof whichSync;
17
+ spawnAsyncFn: typeof spawnAsync;
18
+ statSyncFn: typeof fs.statSync;
19
+ mkdirpFn: typeof mkdirp;
13
20
  }
14
21
  /**
15
22
  * This utility class exists so we can mock the `which` dependency in unit tests without resorting to libraries that hack the import system.
16
23
  */
17
24
  export declare class TarballUtility {
18
25
  private whichSyncFn;
19
- constructor(whichSyncFn: typeof whichSync);
26
+ private spawnAsyncFn;
27
+ private statSyncFn;
28
+ private mkdirpFn;
29
+ constructor(dependencies?: Partial<TarballUtilityDependencies>);
20
30
  /**
21
31
  * Creates a gzipped tarball from a directory by spawning a process to run OS-installed `tar` to avoid pulling in npm package dependencies.
22
32
  * Note that Windows has tar since Windows 10 1803 (see https://devblogs.microsoft.com/commandline/windows10v1803/.
@@ -35,7 +45,7 @@ export declare class TarballUtility {
35
45
  * @param unpackDirectory The directory to unpack the tarball into
36
46
  * @param options The options to use when unpacking the tarball. See {@link TarballUnpackOptions}.
37
47
  */
38
- unpackTarball: (tarballPath: string, unpackDirectory: string, options?: TarballUnpackOptions) => Promise<void>;
48
+ unpackTarball: (tarballPath: string, unpackDirectory: string, options?: Partial<TarballUnpackOptions>) => Promise<void>;
39
49
  /**
40
50
  * A more opinionated version of {@link unpackTarball} that assumes you want to create the directory and strip the first directory out of the unpacked files.
41
51
  * @param tarballPath The path to the tarball to unpack
@@ -48,6 +58,6 @@ export declare class TarballUtility {
48
58
  private tryCreateDirectory;
49
59
  }
50
60
  export declare const createTarball: (directoryToTarball: string, tarballPath: string, options?: CreateTarballOptions) => Promise<void>;
51
- export declare const unpackTarball: (tarballPath: string, unpackDirectory: string, options?: TarballUnpackOptions) => Promise<void>;
61
+ export declare const unpackTarball: (tarballPath: string, unpackDirectory: string, options?: Partial<TarballUnpackOptions>) => Promise<void>;
52
62
  export declare const unpackTarballContents: (tarballPath: string, unpackDirectory: string, stripComponents?: number) => Promise<void>;
53
63
  //# sourceMappingURL=TarballUtility.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"TarballUtility.d.ts","sourceRoot":"","sources":["../../src/TarballUtility.ts"],"names":[],"mappings":"AAGA,OAAO,EAA8D,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAGzG,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,wBAAwB,CAAC,EAAE,OAAO,CAAA;CACnC;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,WAAW,CAAkB;gBAEzB,WAAW,EAAE,OAAO,SAAS;IAIzC;;;;;;;;;OASG;IACH,aAAa,uBAA8B,MAAM,eAAe,MAAM,YAAY,oBAAoB,mBA4CrG;IAED;;;;;;OAMG;IACH,aAAa,gBAAuB,MAAM,mBAAmB,MAAM,YAAY,oBAAoB,mBA0ClG;IAED;;;;;OAKG;IACH,qBAAqB,gBAAuB,MAAM,mBAAmB,MAAM,oBAAmB,MAAM,mBAEnG;IAED,OAAO,CAAC,WAAW,CAOlB;IAED,OAAO,CAAC,aAAa,CAOpB;IAED,OAAO,CAAC,kBAAkB,CAUzB;CACF;AAID,eAAO,MAAM,aAAa,uBA5ImB,MAAM,eAAe,MAAM,YAAY,oBAAoB,kBA4IlD,CAAA;AACtD,eAAO,MAAM,aAAa,gBAxFY,MAAM,mBAAmB,MAAM,YAAY,oBAAoB,kBAwF/C,CAAA;AACtD,eAAO,MAAM,qBAAqB,gBAvCY,MAAM,mBAAmB,MAAM,oBAAmB,MAAM,kBAuChC,CAAA"}
1
+ {"version":3,"file":"TarballUtility.d.ts","sourceRoot":"","sources":["../../src/TarballUtility.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAA;AAExB,OAAO,EAAiB,MAAM,EAAmC,UAAU,EAAS,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAGxH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,oBAAoB,EAAE,OAAO,CAAA;IAC7B,eAAe,EAAE,MAAM,CAAA;IACvB,wBAAwB,EAAE,OAAO,CAAA;CAClC;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,OAAO,SAAS,CAAA;IAC7B,YAAY,EAAE,OAAO,UAAU,CAAA;IAC/B,UAAU,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAA;IAC9B,QAAQ,EAAE,OAAO,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,YAAY,CAAmB;IACvC,OAAO,CAAC,UAAU,CAAoB;IACtC,OAAO,CAAC,QAAQ,CAAe;gBAEnB,YAAY,GAAE,OAAO,CAAC,0BAA0B,CAAM;IAOlE;;;;;;;;;OASG;IACH,aAAa,uBAA8B,MAAM,eAAe,MAAM,YAAY,oBAAoB,mBAsCrG;IAED;;;;;;OAMG;IACH,aAAa,gBAAuB,MAAM,mBAAmB,MAAM,YAAY,QAAQ,oBAAoB,CAAC,mBA0C3G;IAED;;;;;OAKG;IACH,qBAAqB,gBAAuB,MAAM,mBAAmB,MAAM,oBAAmB,MAAM,mBAEnG;IAED,OAAO,CAAC,WAAW,CAQlB;IAED,OAAO,CAAC,aAAa,CAOpB;IAED,OAAO,CAAC,kBAAkB,CAMzB;CACF;AAID,eAAO,MAAM,aAAa,uBAnImB,MAAM,eAAe,MAAM,YAAY,oBAAoB,kBAmIlD,CAAA;AACtD,eAAO,MAAM,aAAa,gBArFY,MAAM,mBAAmB,MAAM,YAAY,QAAQ,oBAAoB,CAAC,kBAqFxD,CAAA;AACtD,eAAO,MAAM,qBAAqB,gBApCY,MAAM,mBAAmB,MAAM,oBAAmB,MAAM,kBAoChC,CAAA"}
@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.unpackTarballContents = exports.unpackTarball = exports.createTarball = exports.TarballUtility = void 0;
7
7
  const node_fs_1 = __importDefault(require("node:fs"));
8
- const promises_1 = __importDefault(require("node:fs/promises"));
9
8
  const node_path_1 = __importDefault(require("node:path"));
10
9
  const generalUtils_js_1 = require("./generalUtils.js");
11
10
  const NodeCliUtilsConfig_js_1 = require("./NodeCliUtilsConfig.js");
@@ -13,7 +12,8 @@ const NodeCliUtilsConfig_js_1 = require("./NodeCliUtilsConfig.js");
13
12
  * This utility class exists so we can mock the `which` dependency in unit tests without resorting to libraries that hack the import system.
14
13
  */
15
14
  class TarballUtility {
16
- constructor(whichSyncFn) {
15
+ constructor(dependencies = {}) {
16
+ var _a, _b, _c, _d;
17
17
  /**
18
18
  * Creates a gzipped tarball from a directory by spawning a process to run OS-installed `tar` to avoid pulling in npm package dependencies.
19
19
  * Note that Windows has tar since Windows 10 1803 (see https://devblogs.microsoft.com/commandline/windows10v1803/.
@@ -32,28 +32,23 @@ class TarballUtility {
32
32
  if (!this.whichSyncFn('tar').location) {
33
33
  throw new Error('tar command not found - please install tar on your OS to use this method, or consider using the npm package node-tar instead');
34
34
  }
35
- if (!node_fs_1.default.existsSync(directoryToTarball)) {
36
- throw new Error(`directoryToTarball does not exist: ${directoryToTarball}`);
37
- }
38
35
  if (tarballPath.endsWith('.tar.gz') === false) {
39
36
  throw new Error(`tarballPath must end with '.tar.gz': ${tarballPath}`);
40
37
  }
41
38
  const directoryToTarballParentDir = node_path_1.default.dirname(directoryToTarball);
42
39
  const directoryToTarballName = node_path_1.default.basename(directoryToTarball);
43
40
  const outputDirectory = node_path_1.default.dirname(tarballPath);
44
- const tarballName = node_path_1.default.basename(tarballPath);
45
41
  if (!node_fs_1.default.existsSync(outputDirectory)) {
46
42
  (0, generalUtils_js_1.trace)(`tarballPath directory does not exist - creating '${outputDirectory}'`);
47
- await (0, generalUtils_js_1.mkdirp)(outputDirectory);
43
+ await this.mkdirpFn(outputDirectory);
48
44
  }
49
45
  else if (node_fs_1.default.existsSync(tarballPath)) {
50
- (0, generalUtils_js_1.trace)(`removing existing tarball '${tarballName}' before creating new one`);
51
- await promises_1.default.unlink(tarballPath);
46
+ throw new Error(`tarballPath already exists - delete, move or rename it first: ${tarballPath}`);
52
47
  }
53
48
  const excludesArgs = mergedOptions.excludes.length > 0 ? mergedOptions.excludes.map(exclude => `--exclude=${exclude}`) : [];
54
49
  const verboseFlag = NodeCliUtilsConfig_js_1.config.traceEnabled ? ['-v'] : [];
55
50
  const args = [...(verboseFlag), '-czf', tarballPath, '-C', directoryToTarballParentDir, ...excludesArgs, directoryToTarballName];
56
- const result = await (0, generalUtils_js_1.spawnAsync)('tar', args);
51
+ const result = await this.spawnAsyncFn('tar', args);
57
52
  if (result.code !== 0) {
58
53
  throw new Error(`tar command failed with code ${result.code}`);
59
54
  }
@@ -92,7 +87,7 @@ class TarballUtility {
92
87
  }
93
88
  const verboseFlag = NodeCliUtilsConfig_js_1.config.traceEnabled ? ['-v'] : [];
94
89
  const args = [...(verboseFlag), '-xzf', tarballPath, '-C', unpackDirectory, '--strip-components', mergedOptions.stripComponents.toString()];
95
- const result = await (0, generalUtils_js_1.spawnAsync)('tar', args);
90
+ const result = await this.spawnAsyncFn('tar', args);
96
91
  if (result.code !== 0) {
97
92
  throw new Error(`tar command failed with code ${result.code}`);
98
93
  }
@@ -109,41 +104,40 @@ class TarballUtility {
109
104
  };
110
105
  this.isDirectory = (path) => {
111
106
  try {
112
- const stats = node_fs_1.default.statSync(path);
107
+ const stats = this.statSyncFn(path);
113
108
  return stats.isDirectory();
114
109
  }
115
110
  catch (err) {
111
+ (0, generalUtils_js_1.trace)('error checking idDirectory (returning false)', err);
116
112
  return false;
117
113
  }
118
114
  };
119
115
  this.dirIsNotEmpty = (dirPath) => {
120
116
  try {
121
- const stats = node_fs_1.default.statSync(dirPath);
117
+ const stats = this.statSyncFn(dirPath);
122
118
  return stats.isDirectory() && node_fs_1.default.readdirSync(dirPath).length > 0;
123
119
  }
124
120
  catch (err) {
125
- return false;
121
+ throw new generalUtils_js_1.ExtendedError('Error checking dirIsNotEmpty - see innerError', err);
126
122
  }
127
123
  };
128
124
  this.tryCreateDirectory = async (dirPath) => {
129
125
  try {
130
- await (0, generalUtils_js_1.mkdirp)(dirPath);
126
+ await this.mkdirpFn(dirPath);
131
127
  }
132
128
  catch (err) {
133
- if (err instanceof Error) {
134
- throw new Error(`Error creating unpackDirectory: ${err.message}`);
135
- }
136
- else {
137
- throw new Error(`Error creating unpackDirectory: ${err}`);
138
- }
129
+ throw new generalUtils_js_1.ExtendedError('Error creating unpackDirectory - see innerError', err);
139
130
  }
140
131
  };
141
- this.whichSyncFn = whichSyncFn;
132
+ this.whichSyncFn = (_a = dependencies.whichSyncFn) !== null && _a !== void 0 ? _a : generalUtils_js_1.whichSync;
133
+ this.spawnAsyncFn = (_b = dependencies.spawnAsyncFn) !== null && _b !== void 0 ? _b : generalUtils_js_1.spawnAsync;
134
+ this.statSyncFn = (_c = dependencies.statSyncFn) !== null && _c !== void 0 ? _c : node_fs_1.default.statSync;
135
+ this.mkdirpFn = (_d = dependencies.mkdirpFn) !== null && _d !== void 0 ? _d : generalUtils_js_1.mkdirp;
142
136
  }
143
137
  }
144
138
  exports.TarballUtility = TarballUtility;
145
- const defaultUtil = new TarballUtility(generalUtils_js_1.whichSync);
139
+ const defaultUtil = new TarballUtility();
146
140
  exports.createTarball = defaultUtil.createTarball;
147
141
  exports.unpackTarball = defaultUtil.unpackTarball;
148
142
  exports.unpackTarballContents = defaultUtil.unpackTarballContents;
149
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVGFyYmFsbFV0aWxpdHkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvVGFyYmFsbFV0aWxpdHkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsc0RBQXdCO0FBQ3hCLGdFQUFrQztBQUNsQywwREFBNEI7QUFDNUIsdURBQXlHO0FBQ3pHLG1FQUFnRDtBQWdCaEQ7O0dBRUc7QUFDSCxNQUFhLGNBQWM7SUFHekIsWUFBWSxXQUE2QjtRQUl6Qzs7Ozs7Ozs7O1dBU0c7UUFDSCxrQkFBYSxHQUFHLEtBQUssRUFBRSxrQkFBMEIsRUFBRSxXQUFtQixFQUFFLE9BQThCLEVBQUUsRUFBRTtZQUN4RyxJQUFBLGtDQUFnQixFQUFDLG9CQUFvQixFQUFFLGtCQUFrQixDQUFDLENBQUE7WUFDMUQsSUFBQSwrQkFBYSxFQUFDLGFBQWEsRUFBRSxXQUFXLENBQUMsQ0FBQTtZQUV6QyxNQUFNLGNBQWMsR0FBRyxFQUFFLFFBQVEsRUFBRSxFQUFFLEVBQUUsQ0FBQTtZQUN2QyxNQUFNLGFBQWEsR0FBRyxFQUFFLEdBQUcsY0FBYyxFQUFFLEdBQUcsT0FBTyxFQUFFLENBQUE7WUFFdkQsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsS0FBSyxDQUFDLENBQUMsUUFBUSxFQUFFO2dCQUNyQyxNQUFNLElBQUksS0FBSyxDQUFDLDhIQUE4SCxDQUFDLENBQUE7YUFDaEo7WUFFRCxJQUFJLENBQUMsaUJBQUUsQ0FBQyxVQUFVLENBQUMsa0JBQWtCLENBQUMsRUFBRTtnQkFDdEMsTUFBTSxJQUFJLEtBQUssQ0FBQyxzQ0FBc0Msa0JBQWtCLEVBQUUsQ0FBQyxDQUFBO2FBQzVFO1lBRUQsSUFBSSxXQUFXLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxLQUFLLEtBQUssRUFBRTtnQkFDN0MsTUFBTSxJQUFJLEtBQUssQ0FBQyx3Q0FBd0MsV0FBVyxFQUFFLENBQUMsQ0FBQTthQUN2RTtZQUVELE1BQU0sMkJBQTJCLEdBQUcsbUJBQUksQ0FBQyxPQUFPLENBQUMsa0JBQWtCLENBQUMsQ0FBQTtZQUNwRSxNQUFNLHNCQUFzQixHQUFHLG1CQUFJLENBQUMsUUFBUSxDQUFDLGtCQUFrQixDQUFDLENBQUE7WUFFaEUsTUFBTSxlQUFlLEdBQUcsbUJBQUksQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDLENBQUE7WUFDakQsTUFBTSxXQUFXLEdBQUcsbUJBQUksQ0FBQyxRQUFRLENBQUMsV0FBVyxDQUFDLENBQUE7WUFFOUMsSUFBSSxDQUFDLGlCQUFFLENBQUMsVUFBVSxDQUFDLGVBQWUsQ0FBQyxFQUFFO2dCQUNuQyxJQUFBLHVCQUFLLEVBQUMsb0RBQW9ELGVBQWUsR0FBRyxDQUFDLENBQUE7Z0JBQzdFLE1BQU0sSUFBQSx3QkFBTSxFQUFDLGVBQWUsQ0FBQyxDQUFBO2FBQzlCO2lCQUFNLElBQUksaUJBQUUsQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLEVBQUU7Z0JBQ3JDLElBQUEsdUJBQUssRUFBQyw4QkFBOEIsV0FBVywyQkFBMkIsQ0FBQyxDQUFBO2dCQUMzRSxNQUFNLGtCQUFHLENBQUMsTUFBTSxDQUFDLFdBQVcsQ0FBQyxDQUFBO2FBQzlCO1lBRUQsTUFBTSxZQUFZLEdBQUcsYUFBYSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxhQUFhLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLGFBQWEsT0FBTyxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFBO1lBQzNILE1BQU0sV0FBVyxHQUFHLDhCQUFNLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUE7WUFDckQsTUFBTSxJQUFJLEdBQUcsQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLEVBQUUsTUFBTSxFQUFFLFdBQVcsRUFBRSxJQUFJLEVBQUUsMkJBQTJCLEVBQUUsR0FBRyxZQUFZLEVBQUUsc0JBQXNCLENBQUMsQ0FBQTtZQUVoSSxNQUFNLE1BQU0sR0FBRyxNQUFNLElBQUEsNEJBQVUsRUFBQyxLQUFLLEVBQUUsSUFBSSxDQUFDLENBQUE7WUFFNUMsSUFBSSxNQUFNLENBQUMsSUFBSSxLQUFLLENBQUMsRUFBRTtnQkFDckIsTUFBTSxJQUFJLEtBQUssQ0FBQyxnQ0FBZ0MsTUFBTSxDQUFDLElBQUksRUFBRSxDQUFDLENBQUE7YUFDL0Q7WUFFRCxJQUFBLHVCQUFLLEVBQUMsbUJBQW1CLEdBQUcsV0FBVyxDQUFDLENBQUE7UUFDMUMsQ0FBQyxDQUFBO1FBRUQ7Ozs7OztXQU1HO1FBQ0gsa0JBQWEsR0FBRyxLQUFLLEVBQUUsV0FBbUIsRUFBRSxlQUF1QixFQUFFLE9BQThCLEVBQUUsRUFBRTtZQUNyRyxJQUFBLGtDQUFnQixFQUFDLGFBQWEsRUFBRSxXQUFXLENBQUMsQ0FBQTtZQUM1QyxJQUFBLCtCQUFhLEVBQUMsaUJBQWlCLEVBQUUsZUFBZSxDQUFDLENBQUE7WUFFakQsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsS0FBSyxDQUFDLENBQUMsUUFBUSxFQUFFO2dCQUNyQyxNQUFNLElBQUksS0FBSyxDQUFDLDhIQUE4SCxDQUFDLENBQUE7YUFDaEo7WUFFRCxNQUFNLGNBQWMsR0FBRyxFQUFFLG9CQUFvQixFQUFFLEtBQUssRUFBRSxlQUFlLEVBQUUsQ0FBQyxFQUFFLHdCQUF3QixFQUFFLElBQUksRUFBRSxDQUFBO1lBQzFHLE1BQU0sYUFBYSxHQUFHLEVBQUUsR0FBRyxjQUFjLEVBQUUsR0FBRyxPQUFPLEVBQUUsQ0FBQTtZQUV2RCxJQUFJLGFBQWEsQ0FBQyxlQUFlLEdBQUcsQ0FBQyxFQUFFO2dCQUNyQyxNQUFNLElBQUksS0FBSyxDQUFDLGdFQUFnRSxDQUFDLENBQUE7YUFDbEY7WUFFRCxNQUFNLGlCQUFpQixHQUFHLGlCQUFFLENBQUMsVUFBVSxDQUFDLGVBQWUsQ0FBQyxDQUFBO1lBRXhELElBQUksaUJBQWlCLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLGVBQWUsQ0FBQyxFQUFFO2dCQUMzRCxNQUFNLElBQUksS0FBSyxDQUFDLGtEQUFrRCxlQUFlLEVBQUUsQ0FBQyxDQUFBO2FBQ3JGO1lBRUQsSUFBSSxhQUFhLENBQUMsb0JBQW9CLElBQUksQ0FBQyxpQkFBaUIsRUFBRTtnQkFDNUQsTUFBTSxJQUFJLENBQUMsa0JBQWtCLENBQUMsZUFBZSxDQUFDLENBQUE7YUFDL0M7WUFFRCxJQUFJLENBQUMsYUFBYSxDQUFDLG9CQUFvQixJQUFJLENBQUMsaUJBQWlCLEVBQUU7Z0JBQzdELE1BQU0sSUFBSSxLQUFLLENBQUMsbUNBQW1DLGVBQWUsRUFBRSxDQUFDLENBQUE7YUFDdEU7WUFFRCxJQUFJLGFBQWEsQ0FBQyx3QkFBd0IsSUFBSSxJQUFJLENBQUMsYUFBYSxDQUFDLGVBQWUsQ0FBQyxFQUFFO2dCQUNqRixNQUFNLElBQUksS0FBSyxDQUFDLDRDQUE0QyxlQUFlLEVBQUUsQ0FBQyxDQUFBO2FBQy9FO1lBRUQsTUFBTSxXQUFXLEdBQUcsOEJBQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQTtZQUNyRCxNQUFNLElBQUksR0FBRyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsRUFBRSxNQUFNLEVBQUUsV0FBVyxFQUFFLElBQUksRUFBRSxlQUFlLEVBQUUsb0JBQW9CLEVBQUUsYUFBYSxDQUFDLGVBQWUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFBO1lBQzNJLE1BQU0sTUFBTSxHQUFHLE1BQU0sSUFBQSw0QkFBVSxFQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsQ0FBQTtZQUU1QyxJQUFJLE1BQU0sQ0FBQyxJQUFJLEtBQUssQ0FBQyxFQUFFO2dCQUNyQixNQUFNLElBQUksS0FBSyxDQUFDLGdDQUFnQyxNQUFNLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQTthQUMvRDtZQUVELElBQUEsdUJBQUssRUFBQyx1QkFBdUIsZUFBZSxFQUFFLENBQUMsQ0FBQTtRQUNqRCxDQUFDLENBQUE7UUFFRDs7Ozs7V0FLRztRQUNILDBCQUFxQixHQUFHLEtBQUssRUFBRSxXQUFtQixFQUFFLGVBQXVCLEVBQUUsa0JBQTBCLENBQUMsRUFBRSxFQUFFO1lBQzFHLE1BQU0sSUFBSSxDQUFDLGFBQWEsQ0FBQyxXQUFXLEVBQUUsZUFBZSxFQUFFLEVBQUUsZUFBZSxFQUFFLG9CQUFvQixFQUFFLElBQUksRUFBRSxDQUFDLENBQUE7UUFDekcsQ0FBQyxDQUFBO1FBRU8sZ0JBQVcsR0FBRyxDQUFDLElBQVksRUFBVyxFQUFFO1lBQzlDLElBQUk7Z0JBQ0YsTUFBTSxLQUFLLEdBQUcsaUJBQUUsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUE7Z0JBQy9CLE9BQU8sS0FBSyxDQUFDLFdBQVcsRUFBRSxDQUFBO2FBQzNCO1lBQUMsT0FBTyxHQUFHLEVBQUU7Z0JBQ1osT0FBTyxLQUFLLENBQUE7YUFDYjtRQUNILENBQUMsQ0FBQTtRQUVPLGtCQUFhLEdBQUcsQ0FBQyxPQUFlLEVBQVcsRUFBRTtZQUNuRCxJQUFJO2dCQUNGLE1BQU0sS0FBSyxHQUFHLGlCQUFFLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFBO2dCQUNsQyxPQUFPLEtBQUssQ0FBQyxXQUFXLEVBQUUsSUFBSSxpQkFBRSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFBO2FBQ2pFO1lBQUMsT0FBTyxHQUFHLEVBQUU7Z0JBQ1osT0FBTyxLQUFLLENBQUE7YUFDYjtRQUNILENBQUMsQ0FBQTtRQUVPLHVCQUFrQixHQUFHLEtBQUssRUFBRSxPQUFlLEVBQUUsRUFBRTtZQUNyRCxJQUFJO2dCQUNGLE1BQU0sSUFBQSx3QkFBTSxFQUFDLE9BQU8sQ0FBQyxDQUFBO2FBQ3RCO1lBQUMsT0FBTyxHQUFHLEVBQUU7Z0JBQ1osSUFBSSxHQUFHLFlBQVksS0FBSyxFQUFFO29CQUN4QixNQUFNLElBQUksS0FBSyxDQUFDLG1DQUFtQyxHQUFHLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQTtpQkFDbEU7cUJBQU07b0JBQ0wsTUFBTSxJQUFJLEtBQUssQ0FBQyxtQ0FBbUMsR0FBRyxFQUFFLENBQUMsQ0FBQTtpQkFDMUQ7YUFDRjtRQUNILENBQUMsQ0FBQTtRQXBKQyxJQUFJLENBQUMsV0FBVyxHQUFHLFdBQVcsQ0FBQTtJQUNoQyxDQUFDO0NBb0pGO0FBekpELHdDQXlKQztBQUVELE1BQU0sV0FBVyxHQUFHLElBQUksY0FBYyxDQUFDLDJCQUFTLENBQUMsQ0FBQTtBQUVwQyxRQUFBLGFBQWEsR0FBRyxXQUFXLENBQUMsYUFBYSxDQUFBO0FBQ3pDLFFBQUEsYUFBYSxHQUFHLFdBQVcsQ0FBQyxhQUFhLENBQUE7QUFDekMsUUFBQSxxQkFBcUIsR0FBRyxXQUFXLENBQUMscUJBQXFCLENBQUEifQ==
143
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVGFyYmFsbFV0aWxpdHkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvVGFyYmFsbFV0aWxpdHkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsc0RBQXdCO0FBQ3hCLDBEQUE0QjtBQUM1Qix1REFBd0g7QUFDeEgsbUVBQWdEO0FBdUJoRDs7R0FFRztBQUNILE1BQWEsY0FBYztJQU16QixZQUFZLGVBQW9ELEVBQUU7O1FBT2xFOzs7Ozs7Ozs7V0FTRztRQUNILGtCQUFhLEdBQUcsS0FBSyxFQUFFLGtCQUEwQixFQUFFLFdBQW1CLEVBQUUsT0FBOEIsRUFBRSxFQUFFO1lBQ3hHLElBQUEsa0NBQWdCLEVBQUMsb0JBQW9CLEVBQUUsa0JBQWtCLENBQUMsQ0FBQTtZQUMxRCxJQUFBLCtCQUFhLEVBQUMsYUFBYSxFQUFFLFdBQVcsQ0FBQyxDQUFBO1lBRXpDLE1BQU0sY0FBYyxHQUFHLEVBQUUsUUFBUSxFQUFFLEVBQUUsRUFBRSxDQUFBO1lBQ3ZDLE1BQU0sYUFBYSxHQUFHLEVBQUUsR0FBRyxjQUFjLEVBQUUsR0FBRyxPQUFPLEVBQUUsQ0FBQTtZQUV2RCxJQUFJLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxLQUFLLENBQUMsQ0FBQyxRQUFRLEVBQUU7Z0JBQ3JDLE1BQU0sSUFBSSxLQUFLLENBQUMsOEhBQThILENBQUMsQ0FBQTthQUNoSjtZQUVELElBQUksV0FBVyxDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUMsS0FBSyxLQUFLLEVBQUU7Z0JBQzdDLE1BQU0sSUFBSSxLQUFLLENBQUMsd0NBQXdDLFdBQVcsRUFBRSxDQUFDLENBQUE7YUFDdkU7WUFFRCxNQUFNLDJCQUEyQixHQUFHLG1CQUFJLENBQUMsT0FBTyxDQUFDLGtCQUFrQixDQUFDLENBQUE7WUFDcEUsTUFBTSxzQkFBc0IsR0FBRyxtQkFBSSxDQUFDLFFBQVEsQ0FBQyxrQkFBa0IsQ0FBQyxDQUFBO1lBRWhFLE1BQU0sZUFBZSxHQUFHLG1CQUFJLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQyxDQUFBO1lBRWpELElBQUksQ0FBQyxpQkFBRSxDQUFDLFVBQVUsQ0FBQyxlQUFlLENBQUMsRUFBRTtnQkFDbkMsSUFBQSx1QkFBSyxFQUFDLG9EQUFvRCxlQUFlLEdBQUcsQ0FBQyxDQUFBO2dCQUM3RSxNQUFNLElBQUksQ0FBQyxRQUFRLENBQUMsZUFBZSxDQUFDLENBQUE7YUFDckM7aUJBQU0sSUFBSSxpQkFBRSxDQUFDLFVBQVUsQ0FBQyxXQUFXLENBQUMsRUFBRTtnQkFDckMsTUFBTSxJQUFJLEtBQUssQ0FBQyxpRUFBaUUsV0FBVyxFQUFFLENBQUMsQ0FBQTthQUNoRztZQUVELE1BQU0sWUFBWSxHQUFHLGFBQWEsQ0FBQyxRQUFRLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsYUFBYSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxhQUFhLE9BQU8sRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQTtZQUMzSCxNQUFNLFdBQVcsR0FBRyw4QkFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFBO1lBQ3JELE1BQU0sSUFBSSxHQUFHLENBQUMsR0FBRyxDQUFDLFdBQVcsQ0FBQyxFQUFFLE1BQU0sRUFBRSxXQUFXLEVBQUUsSUFBSSxFQUFFLDJCQUEyQixFQUFFLEdBQUcsWUFBWSxFQUFFLHNCQUFzQixDQUFDLENBQUE7WUFFaEksTUFBTSxNQUFNLEdBQUcsTUFBTSxJQUFJLENBQUMsWUFBWSxDQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsQ0FBQTtZQUVuRCxJQUFJLE1BQU0sQ0FBQyxJQUFJLEtBQUssQ0FBQyxFQUFFO2dCQUNyQixNQUFNLElBQUksS0FBSyxDQUFDLGdDQUFnQyxNQUFNLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQTthQUMvRDtZQUVELElBQUEsdUJBQUssRUFBQyxtQkFBbUIsR0FBRyxXQUFXLENBQUMsQ0FBQTtRQUMxQyxDQUFDLENBQUE7UUFFRDs7Ozs7O1dBTUc7UUFDSCxrQkFBYSxHQUFHLEtBQUssRUFBRSxXQUFtQixFQUFFLGVBQXVCLEVBQUUsT0FBdUMsRUFBRSxFQUFFO1lBQzlHLElBQUEsa0NBQWdCLEVBQUMsYUFBYSxFQUFFLFdBQVcsQ0FBQyxDQUFBO1lBQzVDLElBQUEsK0JBQWEsRUFBQyxpQkFBaUIsRUFBRSxlQUFlLENBQUMsQ0FBQTtZQUVqRCxJQUFJLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxLQUFLLENBQUMsQ0FBQyxRQUFRLEVBQUU7Z0JBQ3JDLE1BQU0sSUFBSSxLQUFLLENBQUMsOEhBQThILENBQUMsQ0FBQTthQUNoSjtZQUVELE1BQU0sY0FBYyxHQUFHLEVBQUUsb0JBQW9CLEVBQUUsS0FBSyxFQUFFLGVBQWUsRUFBRSxDQUFDLEVBQUUsd0JBQXdCLEVBQUUsSUFBSSxFQUFFLENBQUE7WUFDMUcsTUFBTSxhQUFhLEdBQUcsRUFBRSxHQUFHLGNBQWMsRUFBRSxHQUFHLE9BQU8sRUFBRSxDQUFBO1lBRXZELElBQUksYUFBYSxDQUFDLGVBQWUsR0FBRyxDQUFDLEVBQUU7Z0JBQ3JDLE1BQU0sSUFBSSxLQUFLLENBQUMsZ0VBQWdFLENBQUMsQ0FBQTthQUNsRjtZQUVELE1BQU0saUJBQWlCLEdBQUcsaUJBQUUsQ0FBQyxVQUFVLENBQUMsZUFBZSxDQUFDLENBQUE7WUFFeEQsSUFBSSxpQkFBaUIsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsZUFBZSxDQUFDLEVBQUU7Z0JBQzNELE1BQU0sSUFBSSxLQUFLLENBQUMsa0RBQWtELGVBQWUsRUFBRSxDQUFDLENBQUE7YUFDckY7WUFFRCxJQUFJLGFBQWEsQ0FBQyxvQkFBb0IsSUFBSSxDQUFDLGlCQUFpQixFQUFFO2dCQUM1RCxNQUFNLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxlQUFlLENBQUMsQ0FBQTthQUMvQztZQUVELElBQUksQ0FBQyxhQUFhLENBQUMsb0JBQW9CLElBQUksQ0FBQyxpQkFBaUIsRUFBRTtnQkFDN0QsTUFBTSxJQUFJLEtBQUssQ0FBQyxtQ0FBbUMsZUFBZSxFQUFFLENBQUMsQ0FBQTthQUN0RTtZQUVELElBQUksYUFBYSxDQUFDLHdCQUF3QixJQUFJLElBQUksQ0FBQyxhQUFhLENBQUMsZUFBZSxDQUFDLEVBQUU7Z0JBQ2pGLE1BQU0sSUFBSSxLQUFLLENBQUMsNENBQTRDLGVBQWUsRUFBRSxDQUFDLENBQUE7YUFDL0U7WUFFRCxNQUFNLFdBQVcsR0FBRyw4QkFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFBO1lBQ3JELE1BQU0sSUFBSSxHQUFHLENBQUMsR0FBRyxDQUFDLFdBQVcsQ0FBQyxFQUFFLE1BQU0sRUFBRSxXQUFXLEVBQUUsSUFBSSxFQUFFLGVBQWUsRUFBRSxvQkFBb0IsRUFBRSxhQUFhLENBQUMsZUFBZSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUE7WUFDM0ksTUFBTSxNQUFNLEdBQUcsTUFBTSxJQUFJLENBQUMsWUFBWSxDQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsQ0FBQTtZQUVuRCxJQUFJLE1BQU0sQ0FBQyxJQUFJLEtBQUssQ0FBQyxFQUFFO2dCQUNyQixNQUFNLElBQUksS0FBSyxDQUFDLGdDQUFnQyxNQUFNLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQTthQUMvRDtZQUVELElBQUEsdUJBQUssRUFBQyx1QkFBdUIsZUFBZSxFQUFFLENBQUMsQ0FBQTtRQUNqRCxDQUFDLENBQUE7UUFFRDs7Ozs7V0FLRztRQUNILDBCQUFxQixHQUFHLEtBQUssRUFBRSxXQUFtQixFQUFFLGVBQXVCLEVBQUUsa0JBQTBCLENBQUMsRUFBRSxFQUFFO1lBQzFHLE1BQU0sSUFBSSxDQUFDLGFBQWEsQ0FBQyxXQUFXLEVBQUUsZUFBZSxFQUFFLEVBQUUsZUFBZSxFQUFFLG9CQUFvQixFQUFFLElBQUksRUFBRSxDQUFDLENBQUE7UUFDekcsQ0FBQyxDQUFBO1FBRU8sZ0JBQVcsR0FBRyxDQUFDLElBQVksRUFBVyxFQUFFO1lBQzlDLElBQUk7Z0JBQ0YsTUFBTSxLQUFLLEdBQUcsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsQ0FBQTtnQkFDbkMsT0FBTyxLQUFLLENBQUMsV0FBVyxFQUFFLENBQUE7YUFDM0I7WUFBQyxPQUFPLEdBQUcsRUFBRTtnQkFDWixJQUFBLHVCQUFLLEVBQUMsOENBQThDLEVBQUUsR0FBRyxDQUFDLENBQUE7Z0JBQzFELE9BQU8sS0FBSyxDQUFBO2FBQ2I7UUFDSCxDQUFDLENBQUE7UUFFTyxrQkFBYSxHQUFHLENBQUMsT0FBZSxFQUFXLEVBQUU7WUFDbkQsSUFBSTtnQkFDRixNQUFNLEtBQUssR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyxDQUFBO2dCQUN0QyxPQUFPLEtBQUssQ0FBQyxXQUFXLEVBQUUsSUFBSSxpQkFBRSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFBO2FBQ2pFO1lBQUMsT0FBTyxHQUFHLEVBQUU7Z0JBQ1osTUFBTSxJQUFJLCtCQUFhLENBQUMsK0NBQStDLEVBQUUsR0FBWSxDQUFDLENBQUE7YUFDdkY7UUFDSCxDQUFDLENBQUE7UUFFTyx1QkFBa0IsR0FBRyxLQUFLLEVBQUUsT0FBZSxFQUFFLEVBQUU7WUFDckQsSUFBSTtnQkFDRixNQUFNLElBQUksQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUE7YUFDN0I7WUFBQyxPQUFPLEdBQUcsRUFBRTtnQkFDWixNQUFNLElBQUksK0JBQWEsQ0FBQyxpREFBaUQsRUFBRSxHQUFZLENBQUMsQ0FBQTthQUN6RjtRQUNILENBQUMsQ0FBQTtRQTlJQyxJQUFJLENBQUMsV0FBVyxHQUFHLE1BQUEsWUFBWSxDQUFDLFdBQVcsbUNBQUksMkJBQVMsQ0FBQTtRQUN4RCxJQUFJLENBQUMsWUFBWSxHQUFHLE1BQUEsWUFBWSxDQUFDLFlBQVksbUNBQUksNEJBQVUsQ0FBQTtRQUMzRCxJQUFJLENBQUMsVUFBVSxHQUFHLE1BQUEsWUFBWSxDQUFDLFVBQVUsbUNBQUksaUJBQUUsQ0FBQyxRQUFRLENBQUE7UUFDeEQsSUFBSSxDQUFDLFFBQVEsR0FBRyxNQUFBLFlBQVksQ0FBQyxRQUFRLG1DQUFJLHdCQUFNLENBQUE7SUFDakQsQ0FBQztDQTJJRjtBQXRKRCx3Q0FzSkM7QUFFRCxNQUFNLFdBQVcsR0FBRyxJQUFJLGNBQWMsRUFBRSxDQUFBO0FBRTNCLFFBQUEsYUFBYSxHQUFHLFdBQVcsQ0FBQyxhQUFhLENBQUE7QUFDekMsUUFBQSxhQUFhLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQTtBQUN6QyxRQUFBLHFCQUFxQixHQUFHLFdBQVcsQ0FBQyxxQkFBcUIsQ0FBQSJ9
@@ -1,30 +1,66 @@
1
+ /** Control what is logged when running certUtils functions. */
2
+ export interface CertLogOptions {
3
+ logSpawnOutput: boolean;
4
+ logTraceMessages: boolean;
5
+ logElevatedPermissionsMessage: boolean;
6
+ logSuccess: boolean;
7
+ }
8
+ export interface GenerateCertOptions extends CertLogOptions {
9
+ /** The directory to write the generated cert files to. Defaults to `./cert`. */
10
+ outputDirectory: string;
11
+ }
12
+ /** Subject, thumbprint or path to the pfx file. Used with the {@link winUninstallCert} function. */
13
+ export type CertIdentifier = string | {
14
+ thumbprint: string;
15
+ } | {
16
+ pfxPath: string;
17
+ };
18
+ /** The subject or path to the pfx file. Used with the {@link winCertIsInstalled} function. */
19
+ export type CertIdentifierWithoutThumbprint = string | {
20
+ pfxPath: string;
21
+ };
22
+ /** Cert info returned by {@link winGetPfxInfo}. */
23
+ export type CertInfo = {
24
+ subject: string;
25
+ thumbprint: string;
26
+ pfxPath: string;
27
+ };
1
28
  /**
2
29
  * Wrapper function for calling openssl to generate a self-signed cert to be used for developing a local website with trusted https.
3
30
  * @param url The url to generate a cert for. This will be used as the common name (CN) in the cert as well as the filename for the generated cert files.
4
- * @param outputDirectory The directory to write the generated cert files to. Defaults to './cert'.
31
+ * @param options Options for generating the cert.
32
+ * @returns The path to the generated pfx file.
5
33
  */
6
- export declare function generateCertWithOpenSsl(url: string, outputDirectory?: string): Promise<void>;
34
+ export declare function generateCertWithOpenSsl(url: string, options?: Partial<GenerateCertOptions>): Promise<string>;
7
35
  /**
8
- * Uses Powershell to install a cert to the local machine's trusted root store. Must have admin permissions.
9
- *
10
- * If the cert is already installed, this method will do nothing.
11
- * @param urlOrCertFilename The url or cert filename to install. The url + '.pfx' or the cert filename passed must match a file that exists in the certDirectory.
12
- * @param certDirectory The directory to look for the cert file in. Defaults to './cert'.
36
+ * Uses Powershell to install a cert to the local machine's trusted root store. Must have elevated permissions.
37
+ * If the cert is already installed, this function will do nothing.
38
+ * @param pfxPath The path to the pfx file to install.
13
39
  */
14
- export declare function winInstallCert(urlOrCertFilename: string, certDirectory?: string): Promise<void>;
40
+ export declare function winInstallCert(pfxPath: string, options?: Partial<CertLogOptions>): Promise<void>;
15
41
  /**
16
- * Uses Powershell to uninstall a cert from the local machine's trusted root store. Must have admin permissions.
17
- * @param urlOrSubject The url or subject of the cert to uninstall. If the cert was installed with the winInstallCert method, this will be the url passed to that method.
42
+ * Uses Powershell to check if a cert is already installed to the local machine's trusted root store.
43
+ * Uses the subject of the cert in order to avoid false negatives from regenerating the same self-signed cert
44
+ * with the same subject but different thumbprint. Note that this method is geared towards use with certs generated
45
+ * with the {@link generateCertWithOpenSsl} function, so this may not work using subject if your subject is not precisely "`CN=<url>`".
46
+ * @param identifier The subject or path to the pfx file of the cert to check.
47
+ * @returns `true` if the cert is already installed, `false` otherwise.
18
48
  */
19
- export declare function winUninstallCert(urlOrSubject: string): Promise<void>;
49
+ export declare function winCertIsInstalled(identifier: CertIdentifierWithoutThumbprint, options?: Partial<CertLogOptions>): Promise<boolean>;
20
50
  /**
21
- * Does not actually do anything - just outputs the manual instructions for installing a cert for use by chrome on linux.
51
+ * Uses Powershell to uninstall a cert from the local machine's trusted root store. Must have elevated permissions.
52
+ * @param identifier The subject, thumbprint or path to the pfx file of the cert to uninstall.
53
+ * @param options Options for uninstalling the cert.
22
54
  */
23
- export declare function linuxInstallCert(): void;
55
+ export declare function winUninstallCert(identifier: CertIdentifier, options?: Partial<CertLogOptions>): Promise<void>;
24
56
  /**
25
- * Uses Powershell to check if a cert is already installed to the local machine's trusted root store.
26
- * @param urlOrSubject The url or subject of the cert to check. If the cert was installed with the winInstallCert method, this will be the url passed to that method.
27
- * @returns `true` if the cert is already installed, `false` otherwise.
57
+ * Uses Powershell to get info about a cert.
58
+ * @param pfxPath The path to the pfx file to get info for.
59
+ * @returns The subject, thumbprint and pfxPath of the cert.
28
60
  */
29
- export declare function winCertAlreadyInstalled(urlOrSubject: string): Promise<boolean>;
61
+ export declare function winGetPfxInfo(pfxPath: string): Promise<CertInfo>;
62
+ /**
63
+ * Does not actually do anything - just outputs the manual instructions for installing a cert for use by chrome on linux.
64
+ */
65
+ export declare function linuxInstallCert(): void;
30
66
  //# sourceMappingURL=certUtils.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"certUtils.d.ts","sourceRoot":"","sources":["../../src/certUtils.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,wBAAsB,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,GAAE,MAAiB,iBAuD5F;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,iBAAiB,EAAE,MAAM,EAAE,aAAa,SAAW,iBA8BvF;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,YAAY,EAAE,MAAM,iBAY1D;AAED;;GAEG;AACH,wBAAgB,gBAAgB,SAU/B;AAED;;;;GAIG;AACH,wBAAsB,uBAAuB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAmBpF"}
1
+ {"version":3,"file":"certUtils.d.ts","sourceRoot":"","sources":["../../src/certUtils.ts"],"names":[],"mappings":"AAqBA,+DAA+D;AAC/D,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,OAAO,CAAA;IACvB,gBAAgB,EAAE,OAAO,CAAA;IACzB,6BAA6B,EAAE,OAAO,CAAA;IACtC,UAAU,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,mBAAoB,SAAQ,cAAc;IACzD,gFAAgF;IAChF,eAAe,EAAE,MAAM,CAAA;CACxB;AASD,oGAAoG;AACpG,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAElF,8FAA8F;AAC9F,MAAM,MAAM,+BAA+B,GAAG,MAAM,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1E,mDAAmD;AACnD,MAAM,MAAM,QAAQ,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAE/E;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAkElH;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,iBAwBtF;AAED;;;;;;;GAOG;AACH,wBAAsB,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAkCzI;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,iBA+BnG;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAqBtE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,SAU/B"}