@git.zone/cli 8.0.0 → 8.2.0
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_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/mod_deprecate/helpers.deprecation.d.ts +14 -4
- package/dist_ts/mod_deprecate/helpers.deprecation.js +34 -15
- package/dist_ts/mod_deprecate/index.js +35 -14
- package/dist_ts/mod_services/classes.serviceconfiguration.d.ts +95 -8
- package/dist_ts/mod_services/classes.serviceconfiguration.js +229 -29
- package/dist_ts/mod_services/index.js +13 -8
- package/package.json +1 -1
- package/readme.md +80 -6
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/mod_deprecate/helpers.deprecation.ts +54 -22
- package/ts/mod_deprecate/index.ts +39 -12
- package/ts/mod_services/classes.serviceconfiguration.ts +324 -30
- package/ts/mod_services/index.ts +15 -7
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@git.zone/cli',
|
|
6
|
-
version: '8.
|
|
6
|
+
version: '8.2.0',
|
|
7
7
|
description: 'A comprehensive CLI tool for enhancing and managing local development workflows with gitzone utilities, focusing on project setup, version control, code formatting, and template management.'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxlQUFlO0lBQ3JCLE9BQU8sRUFBRSxPQUFPO0lBQ2hCLFdBQVcsRUFBRSwrTEFBK0w7Q0FDN00sQ0FBQSJ9
|
|
@@ -1,12 +1,22 @@
|
|
|
1
1
|
import * as plugins from "./mod.plugins.js";
|
|
2
2
|
export interface IDeprecationPlan {
|
|
3
3
|
packageName: string;
|
|
4
|
-
|
|
4
|
+
/** The package that supersedes the deprecated one, or `null` when none exists. */
|
|
5
|
+
replacement: string | null;
|
|
5
6
|
message: string;
|
|
6
7
|
registries: string[];
|
|
7
8
|
}
|
|
8
|
-
export
|
|
9
|
+
export interface IDeprecationPlanOptions {
|
|
10
|
+
packageName: string;
|
|
11
|
+
replacement?: string | null;
|
|
9
12
|
message?: string;
|
|
10
|
-
|
|
11
|
-
|
|
13
|
+
registries: string[];
|
|
14
|
+
}
|
|
15
|
+
export declare const createDeprecationPlan: (options: IDeprecationPlanOptions) => IDeprecationPlan;
|
|
16
|
+
/** Human-readable plan lines; `--json` prints the plan object itself. */
|
|
17
|
+
export declare const describeDeprecationPlan: (plan: IDeprecationPlan) => string[];
|
|
18
|
+
/**
|
|
19
|
+
* Verify the old package (and its replacement, when one is named) on every
|
|
20
|
+
* registry before changing metadata for any of them.
|
|
21
|
+
*/
|
|
12
22
|
export declare const executeDeprecation: (planArg: IDeprecationPlan, shell: plugins.smartshell.Smartshell, cwd: string, fetchImplementation?: typeof fetch) => Promise<void>;
|
|
@@ -3,18 +3,23 @@ import { normalizeNpmRegistryUrl } from "../mod_release/helpers.npmartifact.js";
|
|
|
3
3
|
export const createDeprecationPlan = (options) => {
|
|
4
4
|
const namePattern = /^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$/;
|
|
5
5
|
if (typeof options.packageName !== "string" ||
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
6
|
+
!namePattern.test(options.packageName))
|
|
7
|
+
throw new Error("Deprecation requires a valid package name.");
|
|
8
|
+
const replacement = options.replacement ?? null;
|
|
9
|
+
if (replacement !== null &&
|
|
10
|
+
(typeof replacement !== "string" ||
|
|
11
|
+
!namePattern.test(replacement) ||
|
|
12
|
+
options.packageName === replacement))
|
|
10
13
|
throw new Error("Deprecation requires distinct valid package and replacement names.");
|
|
14
|
+
if (replacement === null && options.message == null)
|
|
15
|
+
throw new Error("Deprecation without a replacement requires a message with guidance.");
|
|
11
16
|
if (!Array.isArray(options.registries))
|
|
12
17
|
throw new Error("Invalid deprecation registries.");
|
|
13
18
|
const registries = options.registries.map(normalizeNpmRegistryUrl);
|
|
14
19
|
if (!registries.length || new Set(registries).size !== registries.length)
|
|
15
20
|
throw new Error("Deprecation requires unique explicit registries.");
|
|
16
21
|
const message = options.message ??
|
|
17
|
-
`Use ${
|
|
22
|
+
`Use ${replacement}. ${options.packageName} is deprecated.`;
|
|
18
23
|
if (typeof message !== "string" ||
|
|
19
24
|
!message.trim() ||
|
|
20
25
|
message.length > 2000 ||
|
|
@@ -23,11 +28,18 @@ export const createDeprecationPlan = (options) => {
|
|
|
23
28
|
}
|
|
24
29
|
return {
|
|
25
30
|
packageName: options.packageName,
|
|
26
|
-
replacement
|
|
31
|
+
replacement,
|
|
27
32
|
registries,
|
|
28
33
|
message,
|
|
29
34
|
};
|
|
30
35
|
};
|
|
36
|
+
/** Human-readable plan lines; `--json` prints the plan object itself. */
|
|
37
|
+
export const describeDeprecationPlan = (plan) => [
|
|
38
|
+
`package: ${plan.packageName}`,
|
|
39
|
+
`replacement: ${plan.replacement ?? "none"}`,
|
|
40
|
+
`registries: ${plan.registries.join(", ")}`,
|
|
41
|
+
`message: ${plan.message}`,
|
|
42
|
+
];
|
|
31
43
|
const readMetadata = async (registry, packageName, fetchImplementation) => {
|
|
32
44
|
const response = await fetchImplementation(`${registry}/${encodeURIComponent(packageName)}`, {
|
|
33
45
|
method: "GET",
|
|
@@ -35,6 +47,8 @@ const readMetadata = async (registry, packageName, fetchImplementation) => {
|
|
|
35
47
|
signal: AbortSignal.timeout(30_000),
|
|
36
48
|
headers: { accept: "application/json", "cache-control": "no-cache" },
|
|
37
49
|
});
|
|
50
|
+
if (response.status === 404)
|
|
51
|
+
throw new Error(`${packageName} is not published on ${registry}.`);
|
|
38
52
|
if (!response.ok)
|
|
39
53
|
throw new Error(`Cannot verify ${packageName} on ${registry} (HTTP ${response.status}).`);
|
|
40
54
|
const metadata = await response.json();
|
|
@@ -50,17 +64,22 @@ const readMetadata = async (registry, packageName, fetchImplementation) => {
|
|
|
50
64
|
return metadata;
|
|
51
65
|
};
|
|
52
66
|
const isDeprecationComplete = (metadata, message) => Object.values(metadata.versions).every((version) => version.deprecated === message);
|
|
53
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Verify the old package (and its replacement, when one is named) on every
|
|
69
|
+
* registry before changing metadata for any of them.
|
|
70
|
+
*/
|
|
54
71
|
export const executeDeprecation = async (planArg, shell, cwd, fetchImplementation = fetch) => {
|
|
55
72
|
const plan = createDeprecationPlan(planArg);
|
|
56
73
|
for (const registry of plan.registries) {
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
74
|
+
if (plan.replacement !== null) {
|
|
75
|
+
const replacement = await readMetadata(registry, plan.replacement, fetchImplementation);
|
|
76
|
+
const latestTag = replacement["dist-tags"]?.latest;
|
|
77
|
+
const latest = typeof latestTag === "string"
|
|
78
|
+
? replacement.versions[latestTag]
|
|
79
|
+
: undefined;
|
|
80
|
+
if (!latest || latest.deprecated)
|
|
81
|
+
throw new Error(`Replacement ${plan.replacement} has no active latest version on ${registry}.`);
|
|
82
|
+
}
|
|
64
83
|
await readMetadata(registry, plan.packageName, fetchImplementation);
|
|
65
84
|
}
|
|
66
85
|
for (const registry of plan.registries) {
|
|
@@ -97,4 +116,4 @@ export const executeDeprecation = async (planArg, shell, cwd, fetchImplementatio
|
|
|
97
116
|
}
|
|
98
117
|
}
|
|
99
118
|
};
|
|
100
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
119
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5kZXByZWNhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3RzL21vZF9kZXByZWNhdGUvaGVscGVycy5kZXByZWNhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGtCQUFrQixDQUFDO0FBQzVDLE9BQU8sRUFBRSx1QkFBdUIsRUFBRSxNQUFNLHVDQUF1QyxDQUFDO0FBaUJoRixNQUFNLENBQUMsTUFBTSxxQkFBcUIsR0FBRyxDQUNuQyxPQUFnQyxFQUNkLEVBQUU7SUFDcEIsTUFBTSxXQUFXLEdBQUcsb0RBQW9ELENBQUM7SUFDekUsSUFDRSxPQUFPLE9BQU8sQ0FBQyxXQUFXLEtBQUssUUFBUTtRQUN2QyxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQztRQUV0QyxNQUFNLElBQUksS0FBSyxDQUFDLDRDQUE0QyxDQUFDLENBQUM7SUFDaEUsTUFBTSxXQUFXLEdBQUcsT0FBTyxDQUFDLFdBQVcsSUFBSSxJQUFJLENBQUM7SUFDaEQsSUFDRSxXQUFXLEtBQUssSUFBSTtRQUNwQixDQUFDLE9BQU8sV0FBVyxLQUFLLFFBQVE7WUFDOUIsQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQztZQUM5QixPQUFPLENBQUMsV0FBVyxLQUFLLFdBQVcsQ0FBQztRQUV0QyxNQUFNLElBQUksS0FBSyxDQUNiLG9FQUFvRSxDQUNyRSxDQUFDO0lBQ0osSUFBSSxXQUFXLEtBQUssSUFBSSxJQUFJLE9BQU8sQ0FBQyxPQUFPLElBQUksSUFBSTtRQUNqRCxNQUFNLElBQUksS0FBSyxDQUNiLHFFQUFxRSxDQUN0RSxDQUFDO0lBQ0osSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQztRQUNwQyxNQUFNLElBQUksS0FBSyxDQUFDLGlDQUFpQyxDQUFDLENBQUM7SUFDckQsTUFBTSxVQUFVLEdBQUcsT0FBTyxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsdUJBQXVCLENBQUMsQ0FBQztJQUNuRSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sSUFBSSxJQUFJLEdBQUcsQ0FBQyxVQUFVLENBQUMsQ0FBQyxJQUFJLEtBQUssVUFBVSxDQUFDLE1BQU07UUFDdEUsTUFBTSxJQUFJLEtBQUssQ0FBQyxrREFBa0QsQ0FBQyxDQUFDO0lBQ3RFLE1BQU0sT0FBTyxHQUNYLE9BQU8sQ0FBQyxPQUFPO1FBQ2YsT0FBTyxXQUFXLEtBQUssT0FBTyxDQUFDLFdBQVcsaUJBQWlCLENBQUM7SUFDOUQsSUFDRSxPQUFPLE9BQU8sS0FBSyxRQUFRO1FBQzNCLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRTtRQUNmLE9BQU8sQ0FBQyxNQUFNLEdBQUcsSUFBSTtRQUNyQixrQ0FBa0MsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQ2hELENBQUM7UUFDRCxNQUFNLElBQUksS0FBSyxDQUFDLDhCQUE4QixDQUFDLENBQUM7SUFDbEQsQ0FBQztJQUNELE9BQU87UUFDTCxXQUFXLEVBQUUsT0FBTyxDQUFDLFdBQVc7UUFDaEMsV0FBVztRQUNYLFVBQVU7UUFDVixPQUFPO0tBQ1IsQ0FBQztBQUNKLENBQUMsQ0FBQztBQUVGLHlFQUF5RTtBQUN6RSxNQUFNLENBQUMsTUFBTSx1QkFBdUIsR0FBRyxDQUFDLElBQXNCLEVBQVksRUFBRSxDQUFDO0lBQzNFLFlBQVksSUFBSSxDQUFDLFdBQVcsRUFBRTtJQUM5QixnQkFBZ0IsSUFBSSxDQUFDLFdBQVcsSUFBSSxNQUFNLEVBQUU7SUFDNUMsZUFBZSxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRTtJQUMzQyxZQUFZLElBQUksQ0FBQyxPQUFPLEVBQUU7Q0FDM0IsQ0FBQztBQVFGLE1BQU0sWUFBWSxHQUFHLEtBQUssRUFDeEIsUUFBZ0IsRUFDaEIsV0FBbUIsRUFDbkIsbUJBQWlDLEVBQ04sRUFBRTtJQUM3QixNQUFNLFFBQVEsR0FBRyxNQUFNLG1CQUFtQixDQUN4QyxHQUFHLFFBQVEsSUFBSSxrQkFBa0IsQ0FBQyxXQUFXLENBQUMsRUFBRSxFQUNoRDtRQUNFLE1BQU0sRUFBRSxLQUFLO1FBQ2IsUUFBUSxFQUFFLE9BQU87UUFDakIsTUFBTSxFQUFFLFdBQVcsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDO1FBQ25DLE9BQU8sRUFBRSxFQUFFLE1BQU0sRUFBRSxrQkFBa0IsRUFBRSxlQUFlLEVBQUUsVUFBVSxFQUFFO0tBQ3JFLENBQ0YsQ0FBQztJQUNGLElBQUksUUFBUSxDQUFDLE1BQU0sS0FBSyxHQUFHO1FBQ3pCLE1BQU0sSUFBSSxLQUFLLENBQUMsR0FBRyxXQUFXLHdCQUF3QixRQUFRLEdBQUcsQ0FBQyxDQUFDO0lBQ3JFLElBQUksQ0FBQyxRQUFRLENBQUMsRUFBRTtRQUNkLE1BQU0sSUFBSSxLQUFLLENBQ2IsaUJBQWlCLFdBQVcsT0FBTyxRQUFRLFVBQVUsUUFBUSxDQUFDLE1BQU0sSUFBSSxDQUN6RSxDQUFDO0lBQ0osTUFBTSxRQUFRLEdBQUcsTUFBTSxRQUFRLENBQUMsSUFBSSxFQUFFLENBQUM7SUFDdkMsSUFDRSxDQUFDLFFBQVE7UUFDVCxRQUFRLENBQUMsSUFBSSxLQUFLLFdBQVc7UUFDN0IsQ0FBQyxRQUFRLENBQUMsUUFBUTtRQUNsQixPQUFPLFFBQVEsQ0FBQyxRQUFRLEtBQUssUUFBUTtRQUNyQyxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUM7UUFDaEMsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsQ0FBQyxNQUFNO1FBQ3RDLE1BQU0sQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBQyxDQUFDLElBQUksQ0FDbkMsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUNWLENBQUMsT0FBTyxJQUFJLE9BQU8sT0FBTyxLQUFLLFFBQVEsSUFBSSxLQUFLLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUNwRSxFQUNELENBQUM7UUFDRCxNQUFNLElBQUksS0FBSyxDQUNiLGlDQUFpQyxXQUFXLE9BQU8sUUFBUSxHQUFHLENBQy9ELENBQUM7SUFDSixDQUFDO0lBQ0QsT0FBTyxRQUFRLENBQUM7QUFDbEIsQ0FBQyxDQUFDO0FBRUYsTUFBTSxxQkFBcUIsR0FBRyxDQUM1QixRQUEwQixFQUMxQixPQUFlLEVBQ04sRUFBRSxDQUNYLE1BQU0sQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBQyxDQUFDLEtBQUssQ0FDcEMsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLE9BQU8sQ0FBQyxVQUFVLEtBQUssT0FBTyxDQUM1QyxDQUFDO0FBRUo7OztHQUdHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sa0JBQWtCLEdBQUcsS0FBSyxFQUNyQyxPQUF5QixFQUN6QixLQUFvQyxFQUNwQyxHQUFXLEVBQ1gsc0JBQW9DLEtBQUssRUFDMUIsRUFBRTtJQUNqQixNQUFNLElBQUksR0FBRyxxQkFBcUIsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUM1QyxLQUFLLE1BQU0sUUFBUSxJQUFJLElBQUksQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUN2QyxJQUFJLElBQUksQ0FBQyxXQUFXLEtBQUssSUFBSSxFQUFFLENBQUM7WUFDOUIsTUFBTSxXQUFXLEdBQUcsTUFBTSxZQUFZLENBQ3BDLFFBQVEsRUFDUixJQUFJLENBQUMsV0FBVyxFQUNoQixtQkFBbUIsQ0FDcEIsQ0FBQztZQUNGLE1BQU0sU0FBUyxHQUFHLFdBQVcsQ0FBQyxXQUFXLENBQUMsRUFBRSxNQUFNLENBQUM7WUFDbkQsTUFBTSxNQUFNLEdBQ1YsT0FBTyxTQUFTLEtBQUssUUFBUTtnQkFDM0IsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxRQUFRLENBQUMsU0FBUyxDQUFDO2dCQUNqQyxDQUFDLENBQUMsU0FBUyxDQUFDO1lBQ2hCLElBQUksQ0FBQyxNQUFNLElBQUksTUFBTSxDQUFDLFVBQVU7Z0JBQzlCLE1BQU0sSUFBSSxLQUFLLENBQ2IsZUFBZSxJQUFJLENBQUMsV0FBVyxvQ0FBb0MsUUFBUSxHQUFHLENBQy9FLENBQUM7UUFDTixDQUFDO1FBQ0QsTUFBTSxZQUFZLENBQUMsUUFBUSxFQUFFLElBQUksQ0FBQyxXQUFXLEVBQUUsbUJBQW1CLENBQUMsQ0FBQztJQUN0RSxDQUFDO0lBQ0QsS0FBSyxNQUFNLFFBQVEsSUFBSSxJQUFJLENBQUMsVUFBVSxFQUFFLENBQUM7UUFDdkMseUVBQXlFO1FBQ3pFLDZFQUE2RTtRQUM3RSxNQUFNLFFBQVEsR0FBRyxNQUFNLFlBQVksQ0FDakMsUUFBUSxFQUNSLElBQUksQ0FBQyxXQUFXLEVBQ2hCLG1CQUFtQixDQUNwQixDQUFDO1FBQ0YsSUFBSSxxQkFBcUIsQ0FBQyxRQUFRLEVBQUUsSUFBSSxDQUFDLE9BQU8sQ0FBQztZQUFFLFNBQVM7UUFDNUQsTUFBTSxNQUFNLEdBQUcsTUFBTSxLQUFLLENBQUMsU0FBUyxDQUNsQyxNQUFNLEVBQ047WUFDRSxXQUFXO1lBQ1gsR0FBRyxJQUFJLENBQUMsV0FBVyxJQUFJO1lBQ3ZCLElBQUksQ0FBQyxPQUFPO1lBQ1osWUFBWTtZQUNaLFFBQVE7U0FDVCxFQUNEO1lBQ0UsR0FBRztZQUNILE9BQU8sRUFBRSxPQUFPO1lBQ2hCLGtCQUFrQixFQUFFLEtBQUs7U0FDMUIsQ0FDRixDQUFDO1FBQ0YsSUFBSSxRQUFRLEdBQUcsS0FBSyxDQUFDO1FBQ3JCLEtBQUssSUFBSSxPQUFPLEdBQUcsQ0FBQyxFQUFFLE9BQU8sR0FBRyxDQUFDLEVBQUUsT0FBTyxFQUFFLEVBQUUsQ0FBQztZQUM3QyxNQUFNLFFBQVEsR0FBRyxNQUFNLFlBQVksQ0FDakMsUUFBUSxFQUNSLElBQUksQ0FBQyxXQUFXLEVBQ2hCLG1CQUFtQixDQUNwQixDQUFDO1lBQ0YsSUFBSSxxQkFBcUIsQ0FBQyxRQUFRLEVBQUUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUM7Z0JBQ2xELFFBQVEsR0FBRyxJQUFJLENBQUM7Z0JBQ2hCLE1BQU07WUFDUixDQUFDO1lBQ0QsSUFBSSxPQUFPLEdBQUcsQ0FBQztnQkFDYixNQUFNLElBQUksT0FBTyxDQUFPLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxVQUFVLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUM7UUFDckUsQ0FBQztRQUNELElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUNkLElBQUksTUFBTSxDQUFDLFFBQVEsS0FBSyxDQUFDO2dCQUN2QixNQUFNLElBQUksS0FBSyxDQUFDLHlCQUF5QixRQUFRLEdBQUcsQ0FBQyxDQUFDO1lBQ3hELE1BQU0sSUFBSSxLQUFLLENBQ2Isd0RBQXdELFFBQVEsMkNBQTJDLENBQzVHLENBQUM7UUFDSixDQUFDO0lBQ0gsQ0FBQztBQUNILENBQUMsQ0FBQyJ9
|
|
@@ -1,20 +1,24 @@
|
|
|
1
1
|
import * as plugins from "./mod.plugins.js";
|
|
2
2
|
import { logger } from "../gitzone.logging.js";
|
|
3
3
|
import { getCliMode, printJson } from "../helpers.climode.js";
|
|
4
|
-
import { createDeprecationPlan, executeDeprecation, } from "./helpers.deprecation.js";
|
|
4
|
+
import { createDeprecationPlan, describeDeprecationPlan, executeDeprecation, } from "./helpers.deprecation.js";
|
|
5
5
|
export const run = async (argvArg = {}) => {
|
|
6
6
|
const mode = await getCliMode(argvArg);
|
|
7
7
|
if (mode.help) {
|
|
8
8
|
console.log("gitzone deprecate --package <old> --replacement <new> --registries <url,url> [--message <text>] [--plan] [-y]");
|
|
9
|
-
console.log(
|
|
9
|
+
console.log('gitzone deprecate --package <old> --registries <url,url> --message "<old> is no longer maintained; <guidance>" [--plan] [-y]');
|
|
10
|
+
console.log("Deprecates all versions after verifying the package, and the replacement when one is named, on every registry.");
|
|
10
11
|
return;
|
|
11
12
|
}
|
|
12
13
|
let registryInput = argvArg.registries;
|
|
13
14
|
let oldPackageName = argvArg.package;
|
|
14
15
|
let newPackageName = argvArg.replacement;
|
|
15
|
-
|
|
16
|
+
let message = argvArg.message;
|
|
17
|
+
if (!registryInput ||
|
|
18
|
+
!oldPackageName ||
|
|
19
|
+
(newPackageName === undefined && message === undefined)) {
|
|
16
20
|
if (!mode.interactive || argvArg.plan || mode.json)
|
|
17
|
-
throw new Error("Specify --package, --
|
|
21
|
+
throw new Error("Specify --package, --registries, and --replacement or --message.");
|
|
18
22
|
const smartInteract = new plugins.smartinteract.SmartInteract([
|
|
19
23
|
{
|
|
20
24
|
name: `registryUrls`,
|
|
@@ -36,48 +40,65 @@ export const run = async (argvArg = {}) => {
|
|
|
36
40
|
},
|
|
37
41
|
{
|
|
38
42
|
name: `newPackageName`,
|
|
39
|
-
message: `Whats the name of the NEW package
|
|
43
|
+
message: `Whats the name of the NEW package? (leave empty if there is none)`,
|
|
40
44
|
type: `input`,
|
|
41
45
|
default: ``,
|
|
42
|
-
validate: (
|
|
43
|
-
return
|
|
46
|
+
validate: () => {
|
|
47
|
+
return !process.env.CI;
|
|
44
48
|
},
|
|
45
49
|
},
|
|
46
50
|
]);
|
|
47
51
|
const answerBucket = await smartInteract.runQueue();
|
|
48
52
|
registryInput = answerBucket.getAnswerFor("registryUrls");
|
|
49
53
|
oldPackageName = answerBucket.getAnswerFor("oldPackageName");
|
|
50
|
-
|
|
54
|
+
const newPackageAnswer = answerBucket.getAnswerFor("newPackageName");
|
|
55
|
+
newPackageName = newPackageAnswer === "" ? undefined : newPackageAnswer;
|
|
56
|
+
if (newPackageName === undefined && message === undefined) {
|
|
57
|
+
const messageAnswer = await smartInteract.askQuestion({
|
|
58
|
+
name: `message`,
|
|
59
|
+
message: `What deprecation message guides users of the OLD package?`,
|
|
60
|
+
type: `input`,
|
|
61
|
+
default: ``,
|
|
62
|
+
validate: (stringInput) => {
|
|
63
|
+
return stringInput !== "" && !process.env.CI;
|
|
64
|
+
},
|
|
65
|
+
});
|
|
66
|
+
message = messageAnswer.value;
|
|
67
|
+
}
|
|
51
68
|
}
|
|
52
69
|
if (typeof registryInput !== "string" ||
|
|
53
70
|
typeof oldPackageName !== "string" ||
|
|
54
|
-
typeof newPackageName !== "string")
|
|
71
|
+
(newPackageName !== undefined && typeof newPackageName !== "string") ||
|
|
72
|
+
(message !== undefined && typeof message !== "string")) {
|
|
55
73
|
throw new Error("Deprecation arguments must be strings.");
|
|
56
74
|
}
|
|
57
75
|
const plan = createDeprecationPlan({
|
|
58
76
|
packageName: oldPackageName,
|
|
59
77
|
replacement: newPackageName,
|
|
60
78
|
registries: registryInput.split(",").map((value) => value.trim()),
|
|
61
|
-
message
|
|
79
|
+
message,
|
|
62
80
|
});
|
|
63
81
|
if (mode.json) {
|
|
64
82
|
printJson({ ok: true, plan });
|
|
65
83
|
return;
|
|
66
84
|
}
|
|
67
|
-
|
|
85
|
+
for (const line of describeDeprecationPlan(plan))
|
|
86
|
+
console.log(line);
|
|
68
87
|
if (argvArg.plan)
|
|
69
88
|
return;
|
|
70
89
|
if (!mode.yes) {
|
|
71
90
|
if (!mode.interactive)
|
|
72
91
|
throw new Error("Deprecation requires -y or interactive confirmation.");
|
|
73
|
-
if (!(await plugins.smartinteract.SmartInteract.getCliConfirmation(`Deprecate every version of ${
|
|
92
|
+
if (!(await plugins.smartinteract.SmartInteract.getCliConfirmation(`Deprecate every version of ${plan.packageName}?`, false)))
|
|
74
93
|
return;
|
|
75
94
|
}
|
|
76
|
-
logger.log("info",
|
|
95
|
+
logger.log("info", plan.replacement === null
|
|
96
|
+
? `Deprecating package ${plan.packageName} without a replacement`
|
|
97
|
+
: `Deprecating package ${plan.packageName} in favour of ${plan.replacement}`);
|
|
77
98
|
const smartshellInstance = new plugins.smartshell.Smartshell({
|
|
78
99
|
executor: "bash",
|
|
79
100
|
});
|
|
80
101
|
await executeDeprecation(plan, smartshellInstance, process.cwd());
|
|
81
102
|
logger.log("ok", `Verified deprecation on ${plan.registries.length} registries.`);
|
|
82
103
|
};
|
|
83
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
104
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi90cy9tb2RfZGVwcmVjYXRlL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sa0JBQWtCLENBQUM7QUFFNUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLHVCQUF1QixDQUFDO0FBQy9DLE9BQU8sRUFBRSxVQUFVLEVBQUUsU0FBUyxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDOUQsT0FBTyxFQUNMLHFCQUFxQixFQUNyQix1QkFBdUIsRUFDdkIsa0JBQWtCLEdBQ25CLE1BQU0sMEJBQTBCLENBQUM7QUFFbEMsTUFBTSxDQUFDLE1BQU0sR0FBRyxHQUFHLEtBQUssRUFBRSxVQUFlLEVBQUUsRUFBRSxFQUFFO0lBQzdDLE1BQU0sSUFBSSxHQUFHLE1BQU0sVUFBVSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ3ZDLElBQUksSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDO1FBQ2QsT0FBTyxDQUFDLEdBQUcsQ0FDVCwrR0FBK0csQ0FDaEgsQ0FBQztRQUNGLE9BQU8sQ0FBQyxHQUFHLENBQ1QsOEhBQThILENBQy9ILENBQUM7UUFDRixPQUFPLENBQUMsR0FBRyxDQUNULGdIQUFnSCxDQUNqSCxDQUFDO1FBQ0YsT0FBTztJQUNULENBQUM7SUFDRCxJQUFJLGFBQWEsR0FBRyxPQUFPLENBQUMsVUFBVSxDQUFDO0lBQ3ZDLElBQUksY0FBYyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUM7SUFDckMsSUFBSSxjQUFjLEdBQUcsT0FBTyxDQUFDLFdBQVcsQ0FBQztJQUN6QyxJQUFJLE9BQU8sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDO0lBQzlCLElBQ0UsQ0FBQyxhQUFhO1FBQ2QsQ0FBQyxjQUFjO1FBQ2YsQ0FBQyxjQUFjLEtBQUssU0FBUyxJQUFJLE9BQU8sS0FBSyxTQUFTLENBQUMsRUFDdkQsQ0FBQztRQUNELElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxJQUFJLE9BQU8sQ0FBQyxJQUFJLElBQUksSUFBSSxDQUFDLElBQUk7WUFDaEQsTUFBTSxJQUFJLEtBQUssQ0FDYixrRUFBa0UsQ0FDbkUsQ0FBQztRQUNKLE1BQU0sYUFBYSxHQUFHLElBQUksT0FBTyxDQUFDLGFBQWEsQ0FBQyxhQUFhLENBQUM7WUFDNUQ7Z0JBQ0UsSUFBSSxFQUFFLGNBQWM7Z0JBQ3BCLE9BQU8sRUFBRSw2Q0FBNkM7Z0JBQ3RELElBQUksRUFBRSxPQUFPO2dCQUNiLE9BQU8sRUFBRSw0QkFBNEI7Z0JBQ3JDLFFBQVEsRUFBRSxDQUFDLFdBQVcsRUFBRSxFQUFFO29CQUN4QixPQUFPLFdBQVcsS0FBSyxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztnQkFDL0MsQ0FBQzthQUNGO1lBQ0Q7Z0JBQ0UsSUFBSSxFQUFFLGdCQUFnQjtnQkFDdEIsT0FBTyxFQUFFLG9DQUFvQztnQkFDN0MsSUFBSSxFQUFFLE9BQU87Z0JBQ2IsT0FBTyxFQUFFLEVBQUU7Z0JBQ1gsUUFBUSxFQUFFLENBQUMsV0FBVyxFQUFFLEVBQUU7b0JBQ3hCLE9BQU8sV0FBVyxLQUFLLEVBQUUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO2dCQUMvQyxDQUFDO2FBQ0Y7WUFDRDtnQkFDRSxJQUFJLEVBQUUsZ0JBQWdCO2dCQUN0QixPQUFPLEVBQUUsbUVBQW1FO2dCQUM1RSxJQUFJLEVBQUUsT0FBTztnQkFDYixPQUFPLEVBQUUsRUFBRTtnQkFDWCxRQUFRLEVBQUUsR0FBRyxFQUFFO29CQUNiLE9BQU8sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztnQkFDekIsQ0FBQzthQUNGO1NBQ0YsQ0FBQyxDQUFDO1FBQ0gsTUFBTSxZQUFZLEdBQUcsTUFBTSxhQUFhLENBQUMsUUFBUSxFQUFFLENBQUM7UUFDcEQsYUFBYSxHQUFHLFlBQVksQ0FBQyxZQUFZLENBQUMsY0FBYyxDQUFDLENBQUM7UUFDMUQsY0FBYyxHQUFHLFlBQVksQ0FBQyxZQUFZLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUM3RCxNQUFNLGdCQUFnQixHQUFHLFlBQVksQ0FBQyxZQUFZLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUNyRSxjQUFjLEdBQUcsZ0JBQWdCLEtBQUssRUFBRSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLGdCQUFnQixDQUFDO1FBQ3hFLElBQUksY0FBYyxLQUFLLFNBQVMsSUFBSSxPQUFPLEtBQUssU0FBUyxFQUFFLENBQUM7WUFDMUQsTUFBTSxhQUFhLEdBQUcsTUFBTSxhQUFhLENBQUMsV0FBVyxDQUFDO2dCQUNwRCxJQUFJLEVBQUUsU0FBUztnQkFDZixPQUFPLEVBQUUsMkRBQTJEO2dCQUNwRSxJQUFJLEVBQUUsT0FBTztnQkFDYixPQUFPLEVBQUUsRUFBRTtnQkFDWCxRQUFRLEVBQUUsQ0FBQyxXQUFXLEVBQUUsRUFBRTtvQkFDeEIsT0FBTyxXQUFXLEtBQUssRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7Z0JBQy9DLENBQUM7YUFDRixDQUFDLENBQUM7WUFDSCxPQUFPLEdBQUcsYUFBYSxDQUFDLEtBQUssQ0FBQztRQUNoQyxDQUFDO0lBQ0gsQ0FBQztJQUNELElBQ0UsT0FBTyxhQUFhLEtBQUssUUFBUTtRQUNqQyxPQUFPLGNBQWMsS0FBSyxRQUFRO1FBQ2xDLENBQUMsY0FBYyxLQUFLLFNBQVMsSUFBSSxPQUFPLGNBQWMsS0FBSyxRQUFRLENBQUM7UUFDcEUsQ0FBQyxPQUFPLEtBQUssU0FBUyxJQUFJLE9BQU8sT0FBTyxLQUFLLFFBQVEsQ0FBQyxFQUN0RCxDQUFDO1FBQ0QsTUFBTSxJQUFJLEtBQUssQ0FBQyx3Q0FBd0MsQ0FBQyxDQUFDO0lBQzVELENBQUM7SUFDRCxNQUFNLElBQUksR0FBRyxxQkFBcUIsQ0FBQztRQUNqQyxXQUFXLEVBQUUsY0FBYztRQUMzQixXQUFXLEVBQUUsY0FBYztRQUMzQixVQUFVLEVBQUUsYUFBYSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLEtBQUssQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUNqRSxPQUFPO0tBQ1IsQ0FBQyxDQUFDO0lBQ0gsSUFBSSxJQUFJLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDZCxTQUFTLENBQUMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7UUFDOUIsT0FBTztJQUNULENBQUM7SUFDRCxLQUFLLE1BQU0sSUFBSSxJQUFJLHVCQUF1QixDQUFDLElBQUksQ0FBQztRQUFFLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDcEUsSUFBSSxPQUFPLENBQUMsSUFBSTtRQUFFLE9BQU87SUFDekIsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUNkLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVztZQUNuQixNQUFNLElBQUksS0FBSyxDQUFDLHNEQUFzRCxDQUFDLENBQUM7UUFDMUUsSUFDRSxDQUFDLENBQUMsTUFBTSxPQUFPLENBQUMsYUFBYSxDQUFDLGFBQWEsQ0FBQyxrQkFBa0IsQ0FDNUQsOEJBQThCLElBQUksQ0FBQyxXQUFXLEdBQUcsRUFDakQsS0FBSyxDQUNOLENBQUM7WUFFRixPQUFPO0lBQ1gsQ0FBQztJQUNELE1BQU0sQ0FBQyxHQUFHLENBQ1IsTUFBTSxFQUNOLElBQUksQ0FBQyxXQUFXLEtBQUssSUFBSTtRQUN2QixDQUFDLENBQUMsdUJBQXVCLElBQUksQ0FBQyxXQUFXLHdCQUF3QjtRQUNqRSxDQUFDLENBQUMsdUJBQXVCLElBQUksQ0FBQyxXQUFXLGlCQUFpQixJQUFJLENBQUMsV0FBVyxFQUFFLENBQy9FLENBQUM7SUFDRixNQUFNLGtCQUFrQixHQUFHLElBQUksT0FBTyxDQUFDLFVBQVUsQ0FBQyxVQUFVLENBQUM7UUFDM0QsUUFBUSxFQUFFLE1BQU07S0FDakIsQ0FBQyxDQUFDO0lBQ0gsTUFBTSxrQkFBa0IsQ0FBQyxJQUFJLEVBQUUsa0JBQWtCLEVBQUUsT0FBTyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7SUFDbEUsTUFBTSxDQUFDLEdBQUcsQ0FDUixJQUFJLEVBQ0osMkJBQTJCLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxjQUFjLENBQ2hFLENBQUM7QUFDSixDQUFDLENBQUMifQ==
|
|
@@ -8,7 +8,45 @@ export declare const isValidS3BucketName: (bucketArg: unknown) => bucketArg is s
|
|
|
8
8
|
* alphabet than custom S3 names. Long names retain a stable hash suffix.
|
|
9
9
|
*/
|
|
10
10
|
export declare const deriveS3BucketName: (projectNameArg: string) => string;
|
|
11
|
-
|
|
11
|
+
/**
|
|
12
|
+
* The serve.zone capability environment
|
|
13
|
+
* (`serve.zone/docs/developers/app-integration.md`, "Capability environment")
|
|
14
|
+
* that GitZone does not already manage under the same name. `MONGODB_HOST`,
|
|
15
|
+
* `MONGODB_PORT`, `MONGODB_URL`, `S3_PORT`, `S3_REGION` and `S3_BUCKET` share
|
|
16
|
+
* their platform name and meaning with the GitZone fields. `S3_ENDPOINT` shares
|
|
17
|
+
* the name only: GitZone keeps the user's value (a host, `host:port`, or an
|
|
18
|
+
* origin, see `resolveS3Endpoint`), and `AWS_ENDPOINT_URL` carries the endpoint
|
|
19
|
+
* origin. Every value is derived from the GitZone fields and rewritten on each
|
|
20
|
+
* reconciliation.
|
|
21
|
+
*/
|
|
22
|
+
export interface IServicePlatformEnvironment {
|
|
23
|
+
/** Identical to `MONGODB_URL` and `MONGO_URL`. */
|
|
24
|
+
MONGODB_URI: string;
|
|
25
|
+
MONGO_URL: string;
|
|
26
|
+
MONGODB_DATABASE: string;
|
|
27
|
+
MONGO_DBNAME: string;
|
|
28
|
+
/** The four credential names are present only while MongoDB auth is enabled. */
|
|
29
|
+
MONGODB_USERNAME?: string;
|
|
30
|
+
MONGO_DBUSER?: string;
|
|
31
|
+
MONGODB_PASSWORD?: string;
|
|
32
|
+
MONGO_DBPASS?: string;
|
|
33
|
+
/** Endpoint origin, e.g. `http://localhost:29000`. */
|
|
34
|
+
AWS_ENDPOINT_URL: string;
|
|
35
|
+
/** Host of `AWS_ENDPOINT_URL`; an IPv6 address without brackets. */
|
|
36
|
+
S3_ENDPOINT_HOST: string;
|
|
37
|
+
/** `true` or `false`, the scheme of `AWS_ENDPOINT_URL`. */
|
|
38
|
+
S3_USE_SSL: string;
|
|
39
|
+
AWS_REGION: string;
|
|
40
|
+
/** Always `true`. */
|
|
41
|
+
AWS_S3_FORCE_PATH_STYLE: string;
|
|
42
|
+
S3_ACCESS_KEY: string;
|
|
43
|
+
S3_ACCESS_KEY_ID: string;
|
|
44
|
+
AWS_ACCESS_KEY_ID: string;
|
|
45
|
+
S3_SECRET_KEY: string;
|
|
46
|
+
S3_SECRET_ACCESS_KEY: string;
|
|
47
|
+
AWS_SECRET_ACCESS_KEY: string;
|
|
48
|
+
}
|
|
49
|
+
export interface IServiceConfig extends IServicePlatformEnvironment {
|
|
12
50
|
PROJECT_NAME: string;
|
|
13
51
|
MONGODB_HOST: string;
|
|
14
52
|
MONGODB_NAME: string;
|
|
@@ -43,6 +81,56 @@ export interface IServiceConfig {
|
|
|
43
81
|
ELASTICSEARCH_PASS: string;
|
|
44
82
|
ELASTICSEARCH_URL: string;
|
|
45
83
|
}
|
|
84
|
+
/** The fields derived from GitZone's database and object-storage primitives. */
|
|
85
|
+
export type TDerivedServiceConnectionEnvironment = IServicePlatformEnvironment & Pick<IServiceConfig, 'MONGODB_URL'>;
|
|
86
|
+
/** Every runtime field that is not derived by `deriveServiceConnectionEnvironment`. */
|
|
87
|
+
export type TServiceConfigPrimitives = Omit<IServiceConfig, keyof TDerivedServiceConnectionEnvironment>;
|
|
88
|
+
/** The primitives the connection environment is derived from. */
|
|
89
|
+
export type TServiceConnectionPrimitives = Pick<IServiceConfig, 'MONGODB_HOST' | 'MONGODB_PORT' | 'MONGODB_NAME' | 'MONGODB_USER' | 'MONGODB_PASS' | 'MONGODB_AUTH_ENABLED' | 'S3_HOST' | 'S3_ENDPOINT' | 'S3_PORT' | 'S3_USESSL' | 'S3_REGION' | 'S3_ACCESSKEY' | 'S3_SECRETKEY'>;
|
|
90
|
+
/** Names of every derived connection field, in `.nogit/env.json` order. */
|
|
91
|
+
export declare const serviceDerivedConnectionFieldNames: Array<keyof TDerivedServiceConnectionEnvironment>;
|
|
92
|
+
/** Runtime fields whose value is or contains a secret; `services config --json` redacts them. */
|
|
93
|
+
export declare const serviceSecretEnvironmentNames: ReadonlyArray<keyof IServiceConfig>;
|
|
94
|
+
/**
|
|
95
|
+
* The MongoDB connection URI. The credential lives in `admin`, so a local URI
|
|
96
|
+
* authenticates there; the path names the database, and `directConnection`
|
|
97
|
+
* matches the standalone NoSQLDB node. Credentials and `authSource` are
|
|
98
|
+
* omitted when auth is disabled.
|
|
99
|
+
*/
|
|
100
|
+
export declare const buildMongoConnectionUri: (primitivesArg: TServiceConnectionPrimitives, hostArg?: string) => string;
|
|
101
|
+
/** The object-storage endpoint the platform names describe. */
|
|
102
|
+
export interface IS3Endpoint {
|
|
103
|
+
/** Host only, exactly as written; an IPv6 address without brackets. */
|
|
104
|
+
host: string;
|
|
105
|
+
/** Endpoint origin, e.g. `http://localhost:29000`; the scheme's default port is omitted. */
|
|
106
|
+
origin: string;
|
|
107
|
+
useSsl: boolean;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Resolve the object-storage endpoint from `S3_ENDPOINT`, read but never
|
|
111
|
+
* rewritten. It is user-controlled and accepted in three forms:
|
|
112
|
+
*
|
|
113
|
+
* - a bare host or IP address (`localhost`, `::1`): scheme from `S3_USESSL`,
|
|
114
|
+
* port from `S3_PORT`;
|
|
115
|
+
* - `host:port` or `[ipv6]:port`: its port wins over `S3_PORT`, the scheme
|
|
116
|
+
* comes from `S3_USESSL`;
|
|
117
|
+
* - an origin, `http(s)://host[:port]`: a complete origin, so its scheme wins
|
|
118
|
+
* over `S3_USESSL` and its port, or the scheme's default port, over `S3_PORT`.
|
|
119
|
+
*
|
|
120
|
+
* The host is taken as written, so no URL normalization rewrites IPv4
|
|
121
|
+
* shorthand, IPv4-mapped IPv6, or letter case. User info, a path, a query, a
|
|
122
|
+
* fragment, a scheme other than `http`/`https`, and a port outside 1-65535 are
|
|
123
|
+
* not part of an origin and are not carried over. An endpoint without a host
|
|
124
|
+
* (`:9000`) takes its host from `S3_HOST`, as a missing `S3_ENDPOINT` does.
|
|
125
|
+
* Never throws: 8.0.0 loaded any non-empty `S3_ENDPOINT`.
|
|
126
|
+
*/
|
|
127
|
+
export declare const resolveS3Endpoint: (primitivesArg: TServiceConnectionPrimitives) => IS3Endpoint;
|
|
128
|
+
/**
|
|
129
|
+
* Derive `MONGODB_URL` and the serve.zone capability environment from the
|
|
130
|
+
* primitives GitZone manages. The single mapping from primitives to both name
|
|
131
|
+
* sets.
|
|
132
|
+
*/
|
|
133
|
+
export declare const deriveServiceConnectionEnvironment: (primitivesArg: TServiceConnectionPrimitives) => TDerivedServiceConnectionEnvironment;
|
|
46
134
|
/** Validate the complete canonical env.json shape before runtime use or persistence. */
|
|
47
135
|
export declare const assertCanonicalServiceRuntimeConfig: (configArg: unknown) => asserts configArg is IServiceConfig;
|
|
48
136
|
export declare class ServiceConfiguration {
|
|
@@ -74,17 +162,16 @@ export declare class ServiceConfiguration {
|
|
|
74
162
|
* explicit `false` in `.nogit/env.json` disables it.
|
|
75
163
|
*/
|
|
76
164
|
isMongoAuthEnabled(): boolean;
|
|
77
|
-
/**
|
|
78
|
-
* Build MONGODB_URL from the current fields.
|
|
79
|
-
*
|
|
80
|
-
* Credentials are omitted entirely when auth is disabled, so the stored URL
|
|
81
|
-
* never advertises a username that the engine would not accept.
|
|
82
|
-
*/
|
|
83
|
-
private buildMongoUrl;
|
|
84
165
|
/**
|
|
85
166
|
* Recompute every derived field from the primitive ones.
|
|
86
167
|
*/
|
|
87
168
|
private updateDerivedFields;
|
|
169
|
+
/**
|
|
170
|
+
* Rewrite `MONGODB_URL` and the serve.zone capability environment from the
|
|
171
|
+
* primitives, in place, and drop the platform database credential names while
|
|
172
|
+
* auth is disabled. Returns the names whose value changed, never the values.
|
|
173
|
+
*/
|
|
174
|
+
private reconcileDerivedConnectionFields;
|
|
88
175
|
/**
|
|
89
176
|
* Refuse an unauthenticated database that would be reachable off-host.
|
|
90
177
|
*
|