primitive-admin 1.0.61 → 1.0.63
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/README.md +125 -69
- package/assets/skill/skills/primitive-platform/SKILL.md +336 -37
- package/dist/bin/primitive.js +25 -14
- package/dist/bin/primitive.js.map +1 -1
- package/dist/src/commands/analytics.js +36 -16
- package/dist/src/commands/analytics.js.map +1 -1
- package/dist/src/commands/apps.js +52 -188
- package/dist/src/commands/apps.js.map +1 -1
- package/dist/src/commands/blob-buckets.js +13 -153
- package/dist/src/commands/blob-buckets.js.map +1 -1
- package/dist/src/commands/collection-type-configs.js +14 -100
- package/dist/src/commands/collection-type-configs.js.map +1 -1
- package/dist/src/commands/collections.js +47 -8
- package/dist/src/commands/collections.js.map +1 -1
- package/dist/src/commands/config.d.ts +46 -0
- package/dist/src/commands/config.js +479 -0
- package/dist/src/commands/config.js.map +1 -0
- package/dist/src/commands/connections.js +12 -7
- package/dist/src/commands/connections.js.map +1 -1
- package/dist/src/commands/cron-triggers.js +84 -176
- package/dist/src/commands/cron-triggers.js.map +1 -1
- package/dist/src/commands/database-type-configs.d.ts +2 -0
- package/dist/src/commands/database-type-configs.js +171 -0
- package/dist/src/commands/database-type-configs.js.map +1 -0
- package/dist/src/commands/database-types.js +4 -4
- package/dist/src/commands/database-types.js.map +1 -1
- package/dist/src/commands/databases.d.ts +63 -0
- package/dist/src/commands/databases.js +649 -87
- package/dist/src/commands/databases.js.map +1 -1
- package/dist/src/commands/documents.js +869 -12
- package/dist/src/commands/documents.js.map +1 -1
- package/dist/src/commands/email-templates.js +21 -128
- package/dist/src/commands/email-templates.js.map +1 -1
- package/dist/src/commands/env.d.ts +12 -1
- package/dist/src/commands/env.js +115 -26
- package/dist/src/commands/env.js.map +1 -1
- package/dist/src/commands/feature-flags.d.ts +14 -0
- package/dist/src/commands/feature-flags.js +116 -0
- package/dist/src/commands/feature-flags.js.map +1 -0
- package/dist/src/commands/group-type-configs.js +14 -109
- package/dist/src/commands/group-type-configs.js.map +1 -1
- package/dist/src/commands/init.d.ts +24 -1
- package/dist/src/commands/init.js +1194 -279
- package/dist/src/commands/init.js.map +1 -1
- package/dist/src/commands/integrations.js +166 -435
- package/dist/src/commands/integrations.js.map +1 -1
- package/dist/src/commands/metadata-category-configs.d.ts +12 -0
- package/dist/src/commands/metadata-category-configs.js +112 -0
- package/dist/src/commands/metadata-category-configs.js.map +1 -0
- package/dist/src/commands/metadata.js +33 -141
- package/dist/src/commands/metadata.js.map +1 -1
- package/dist/src/commands/prompts.js +206 -563
- package/dist/src/commands/prompts.js.map +1 -1
- package/dist/src/commands/rule-sets.d.ts +1 -1
- package/dist/src/commands/rule-sets.js +16 -132
- package/dist/src/commands/rule-sets.js.map +1 -1
- package/dist/src/commands/scripts.d.ts +10 -0
- package/dist/src/commands/scripts.js +203 -241
- package/dist/src/commands/scripts.js.map +1 -1
- package/dist/src/commands/sessions.js +17 -5
- package/dist/src/commands/sessions.js.map +1 -1
- package/dist/src/commands/sync-app-settings.d.ts +113 -70
- package/dist/src/commands/sync-app-settings.js +193 -242
- package/dist/src/commands/sync-app-settings.js.map +1 -1
- package/dist/src/commands/sync.d.ts +1904 -51
- package/dist/src/commands/sync.js +9468 -1790
- package/dist/src/commands/sync.js.map +1 -1
- package/dist/src/commands/tokens.js +8 -2
- package/dist/src/commands/tokens.js.map +1 -1
- package/dist/src/commands/users.js +92 -1
- package/dist/src/commands/users.js.map +1 -1
- package/dist/src/commands/vars.js +44 -58
- package/dist/src/commands/vars.js.map +1 -1
- package/dist/src/commands/webhooks.js +318 -156
- package/dist/src/commands/webhooks.js.map +1 -1
- package/dist/src/commands/workflows.d.ts +49 -12
- package/dist/src/commands/workflows.js +652 -1086
- package/dist/src/commands/workflows.js.map +1 -1
- package/dist/src/lib/access-rule-display.d.ts +21 -0
- package/dist/src/lib/access-rule-display.js +34 -0
- package/dist/src/lib/access-rule-display.js.map +1 -0
- package/dist/src/lib/api-client.d.ts +541 -61
- package/dist/src/lib/api-client.js +559 -102
- package/dist/src/lib/api-client.js.map +1 -1
- package/dist/src/lib/app-settings-descriptor.d.ts +180 -25
- package/dist/src/lib/app-settings-descriptor.js +403 -82
- package/dist/src/lib/app-settings-descriptor.js.map +1 -1
- package/dist/src/lib/canonical-json.d.ts +12 -0
- package/dist/src/lib/canonical-json.js +35 -0
- package/dist/src/lib/canonical-json.js.map +1 -0
- package/dist/src/lib/cli-manifest.d.ts +8 -0
- package/dist/src/lib/cli-manifest.js +1 -0
- package/dist/src/lib/cli-manifest.js.map +1 -1
- package/dist/src/lib/codegen-shared/generatedFiles.d.ts +6 -2
- package/dist/src/lib/codegen-shared/generatedFiles.js +9 -2
- package/dist/src/lib/codegen-shared/generatedFiles.js.map +1 -1
- package/dist/src/lib/codegen-shared/resolveCodegenSourceDir.d.ts +6 -6
- package/dist/src/lib/codegen-shared/resolveCodegenSourceDir.js +8 -8
- package/dist/src/lib/codegen-shared/resolveCodegenSourceDir.js.map +1 -1
- package/dist/src/lib/config-object-descriptor.d.ts +127 -0
- package/dist/src/lib/config-object-descriptor.js +658 -0
- package/dist/src/lib/config-object-descriptor.js.map +1 -0
- package/dist/src/lib/config-payload.d.ts +85 -0
- package/dist/src/lib/config-payload.js +116 -0
- package/dist/src/lib/config-payload.js.map +1 -0
- package/dist/src/lib/config-surface.d.ts +130 -0
- package/dist/src/lib/config-surface.js +300 -0
- package/dist/src/lib/config-surface.js.map +1 -0
- package/dist/src/lib/credentials-store.d.ts +10 -0
- package/dist/src/lib/credentials-store.js +23 -0
- package/dist/src/lib/credentials-store.js.map +1 -1
- package/dist/src/lib/data-input.d.ts +23 -0
- package/dist/src/lib/data-input.js +50 -0
- package/dist/src/lib/data-input.js.map +1 -0
- package/dist/src/lib/db-codegen/dbTemplates.js +1 -1
- package/dist/src/lib/db-codegen/dbTemplates.js.map +1 -1
- package/dist/src/lib/db-codegen/dbTypeIR.d.ts +1 -1
- package/dist/src/lib/env-resolver-core.d.ts +187 -0
- package/dist/src/lib/env-resolver-core.js +325 -0
- package/dist/src/lib/env-resolver-core.js.map +1 -0
- package/dist/src/lib/env-resolver.d.ts +28 -6
- package/dist/src/lib/env-resolver.js +44 -32
- package/dist/src/lib/env-resolver.js.map +1 -1
- package/dist/src/lib/generated-allowlist.js +12 -0
- package/dist/src/lib/generated-allowlist.js.map +1 -1
- package/dist/src/lib/generated-config-surfaces.d.ts +682 -0
- package/dist/src/lib/generated-config-surfaces.js +4058 -0
- package/dist/src/lib/generated-config-surfaces.js.map +1 -0
- package/dist/src/lib/generated-template-lint.d.ts +212 -0
- package/dist/src/lib/generated-template-lint.js +624 -0
- package/dist/src/lib/generated-template-lint.js.map +1 -0
- package/dist/src/lib/init-adopt.d.ts +16 -0
- package/dist/src/lib/init-adopt.js +34 -0
- package/dist/src/lib/init-adopt.js.map +1 -0
- package/dist/src/lib/init-assets.d.ts +39 -0
- package/dist/src/lib/init-assets.js +97 -0
- package/dist/src/lib/init-assets.js.map +1 -0
- package/dist/src/lib/init-client-platforms.d.ts +14 -0
- package/dist/src/lib/init-client-platforms.js +71 -0
- package/dist/src/lib/init-client-platforms.js.map +1 -0
- package/dist/src/lib/init-config.d.ts +44 -5
- package/dist/src/lib/init-config.js +80 -7
- package/dist/src/lib/init-config.js.map +1 -1
- package/dist/src/lib/init-email-redirect-uris.d.ts +37 -0
- package/dist/src/lib/init-email-redirect-uris.js +46 -0
- package/dist/src/lib/init-email-redirect-uris.js.map +1 -0
- package/dist/src/lib/init-ios-links.d.ts +90 -0
- package/dist/src/lib/init-ios-links.js +218 -0
- package/dist/src/lib/init-ios-links.js.map +1 -0
- package/dist/src/lib/init-plan.d.ts +80 -0
- package/dist/src/lib/init-plan.js +95 -0
- package/dist/src/lib/init-plan.js.map +1 -0
- package/dist/src/lib/init-production-env.d.ts +48 -0
- package/dist/src/lib/init-production-env.js +59 -0
- package/dist/src/lib/init-production-env.js.map +1 -0
- package/dist/src/lib/init-schema.d.ts +74 -0
- package/dist/src/lib/init-schema.js +358 -0
- package/dist/src/lib/init-schema.js.map +1 -0
- package/dist/src/lib/init-xcode.d.ts +33 -0
- package/dist/src/lib/init-xcode.js +114 -0
- package/dist/src/lib/init-xcode.js.map +1 -0
- package/dist/src/lib/integration-request-config.d.ts +30 -0
- package/dist/src/lib/integration-request-config.js +145 -0
- package/dist/src/lib/integration-request-config.js.map +1 -0
- package/dist/src/lib/integration-selector.d.ts +42 -0
- package/dist/src/lib/integration-selector.js +46 -0
- package/dist/src/lib/integration-selector.js.map +1 -0
- package/dist/src/lib/local-state.d.ts +55 -0
- package/dist/src/lib/local-state.js +167 -0
- package/dist/src/lib/local-state.js.map +1 -0
- package/dist/src/lib/local-test-cases.d.ts +63 -0
- package/dist/src/lib/local-test-cases.js +135 -0
- package/dist/src/lib/local-test-cases.js.map +1 -0
- package/dist/src/lib/log-inspection.d.ts +568 -0
- package/dist/src/lib/log-inspection.js +639 -0
- package/dist/src/lib/log-inspection.js.map +1 -0
- package/dist/src/lib/migration-nag.d.ts +2 -2
- package/dist/src/lib/migration-nag.js +3 -3
- package/dist/src/lib/object-status-filter.d.ts +22 -0
- package/dist/src/lib/object-status-filter.js +45 -0
- package/dist/src/lib/object-status-filter.js.map +1 -0
- package/dist/src/lib/output.d.ts +24 -1
- package/dist/src/lib/output.js +42 -1
- package/dist/src/lib/output.js.map +1 -1
- package/dist/src/lib/package-manager.d.ts +140 -0
- package/dist/src/lib/package-manager.js +305 -0
- package/dist/src/lib/package-manager.js.map +1 -0
- package/dist/src/lib/paginate.d.ts +50 -0
- package/dist/src/lib/paginate.js +53 -0
- package/dist/src/lib/paginate.js.map +1 -1
- package/dist/src/lib/platform-owned.d.ts +29 -3
- package/dist/src/lib/platform-owned.js +42 -3
- package/dist/src/lib/platform-owned.js.map +1 -1
- package/dist/src/lib/project-config.d.ts +8 -0
- package/dist/src/lib/project-config.js +30 -5
- package/dist/src/lib/project-config.js.map +1 -1
- package/dist/src/lib/query-operators.d.ts +1 -1
- package/dist/src/lib/query-operators.js +1 -1
- package/dist/src/lib/record-filter.d.ts +18 -0
- package/dist/src/lib/record-filter.js +55 -0
- package/dist/src/lib/record-filter.js.map +1 -0
- package/dist/src/lib/resolve-init-dev-port.d.ts +56 -0
- package/dist/src/lib/resolve-init-dev-port.js +55 -0
- package/dist/src/lib/resolve-init-dev-port.js.map +1 -0
- package/dist/src/lib/resolve-init-server.d.ts +64 -0
- package/dist/src/lib/resolve-init-server.js +77 -0
- package/dist/src/lib/resolve-init-server.js.map +1 -0
- package/dist/src/lib/resolve-platform.d.ts +43 -14
- package/dist/src/lib/resolve-platform.js +74 -12
- package/dist/src/lib/resolve-platform.js.map +1 -1
- package/dist/src/lib/run-status.d.ts +19 -0
- package/dist/src/lib/run-status.generated.d.ts +39 -0
- package/dist/src/lib/run-status.generated.js +66 -0
- package/dist/src/lib/run-status.generated.js.map +1 -0
- package/dist/src/lib/run-status.js +19 -0
- package/dist/src/lib/run-status.js.map +1 -0
- package/dist/src/lib/server-text-normalization.d.ts +51 -0
- package/dist/src/lib/server-text-normalization.js +90 -0
- package/dist/src/lib/server-text-normalization.js.map +1 -0
- package/dist/src/lib/server-url.d.ts +22 -0
- package/dist/src/lib/server-url.js +33 -0
- package/dist/src/lib/server-url.js.map +1 -0
- package/dist/src/lib/signing-secret-status.d.ts +81 -0
- package/dist/src/lib/signing-secret-status.js +116 -0
- package/dist/src/lib/signing-secret-status.js.map +1 -0
- package/dist/src/lib/skill-installer.js +6 -3
- package/dist/src/lib/skill-installer.js.map +1 -1
- package/dist/src/lib/snapshots.d.ts +2 -2
- package/dist/src/lib/snapshots.js +2 -2
- package/dist/src/lib/swift-codegen/dbGenerator.d.ts +15 -2
- package/dist/src/lib/swift-codegen/dbGenerator.js +250 -18
- package/dist/src/lib/swift-codegen/dbGenerator.js.map +1 -1
- package/dist/src/lib/swift-codegen/generator.d.ts +11 -2
- package/dist/src/lib/swift-codegen/generator.js +181 -7
- package/dist/src/lib/swift-codegen/generator.js.map +1 -1
- package/dist/src/lib/swift-codegen/siblingSymbols.d.ts +7 -3
- package/dist/src/lib/swift-codegen/siblingSymbols.js +4 -1
- package/dist/src/lib/swift-codegen/siblingSymbols.js.map +1 -1
- package/dist/src/lib/sync-dir-selector.d.ts +21 -0
- package/dist/src/lib/sync-dir-selector.js +30 -0
- package/dist/src/lib/sync-dir-selector.js.map +1 -0
- package/dist/src/lib/sync-paths.d.ts +39 -0
- package/dist/src/lib/sync-paths.js +70 -2
- package/dist/src/lib/sync-paths.js.map +1 -1
- package/dist/src/lib/sync-resource-types.d.ts +138 -31
- package/dist/src/lib/sync-resource-types.js +241 -47
- package/dist/src/lib/sync-resource-types.js.map +1 -1
- package/dist/src/lib/sync-selectors.d.ts +95 -0
- package/dist/src/lib/sync-selectors.js +228 -0
- package/dist/src/lib/sync-selectors.js.map +1 -0
- package/dist/src/lib/template.d.ts +62 -4
- package/dist/src/lib/template.js +147 -39
- package/dist/src/lib/template.js.map +1 -1
- package/dist/src/lib/test-case-file-names.d.ts +40 -0
- package/dist/src/lib/test-case-file-names.js +91 -0
- package/dist/src/lib/test-case-file-names.js.map +1 -0
- package/dist/src/lib/test-case-keys.d.ts +29 -0
- package/dist/src/lib/test-case-keys.js +55 -0
- package/dist/src/lib/test-case-keys.js.map +1 -0
- package/dist/src/lib/test-case-variables.d.ts +15 -0
- package/dist/src/lib/test-case-variables.js +29 -0
- package/dist/src/lib/test-case-variables.js.map +1 -0
- package/dist/src/lib/toml-database-config.d.ts +4 -4
- package/dist/src/lib/toml-database-config.js +27 -34
- package/dist/src/lib/toml-database-config.js.map +1 -1
- package/dist/src/lib/toml-metadata-config.d.ts +9 -5
- package/dist/src/lib/toml-metadata-config.js +40 -45
- package/dist/src/lib/toml-metadata-config.js.map +1 -1
- package/dist/src/lib/toml-native-form.d.ts +1 -1
- package/dist/src/lib/toml-native-form.js +1 -1
- package/dist/src/lib/toml-params-validator.d.ts +1 -1
- package/dist/src/lib/toml-params-validator.js +1 -1
- package/dist/src/lib/toml-scalar-edit.d.ts +43 -0
- package/dist/src/lib/toml-scalar-edit.js +283 -0
- package/dist/src/lib/toml-scalar-edit.js.map +1 -0
- package/dist/src/lib/user-selector.d.ts +24 -0
- package/dist/src/lib/user-selector.js +33 -0
- package/dist/src/lib/user-selector.js.map +1 -0
- package/dist/src/lib/version-check.d.ts +25 -0
- package/dist/src/lib/version-check.js +77 -8
- package/dist/src/lib/version-check.js.map +1 -1
- package/dist/src/lib/watch.d.ts +121 -0
- package/dist/src/lib/watch.js +169 -0
- package/dist/src/lib/watch.js.map +1 -0
- package/dist/src/lib/web-url.d.ts +40 -0
- package/dist/src/lib/web-url.js +76 -0
- package/dist/src/lib/web-url.js.map +1 -0
- package/dist/src/lib/workflow-apply.d.ts +69 -45
- package/dist/src/lib/workflow-apply.js +99 -72
- package/dist/src/lib/workflow-apply.js.map +1 -1
- package/dist/src/lib/workflow-codegen/generator.js +4 -4
- package/dist/src/lib/workflow-codegen/generator.js.map +1 -1
- package/dist/src/lib/workflow-codegen/invokerIR.d.ts +11 -0
- package/dist/src/lib/workflow-codegen/invokerIR.js +5 -0
- package/dist/src/lib/workflow-codegen/invokerIR.js.map +1 -1
- package/dist/src/lib/workflow-config-apply.d.ts +70 -0
- package/dist/src/lib/workflow-config-apply.js +137 -0
- package/dist/src/lib/workflow-config-apply.js.map +1 -0
- package/dist/src/lib/workflow-config-sidecar.d.ts +63 -0
- package/dist/src/lib/workflow-config-sidecar.js +96 -0
- package/dist/src/lib/workflow-config-sidecar.js.map +1 -0
- package/dist/src/lib/workflow-defaults.d.ts +29 -0
- package/dist/src/lib/workflow-defaults.js +41 -0
- package/dist/src/lib/workflow-defaults.js.map +1 -0
- package/dist/src/lib/workflow-include-preserve.d.ts +76 -0
- package/dist/src/lib/workflow-include-preserve.js +286 -0
- package/dist/src/lib/workflow-include-preserve.js.map +1 -0
- package/dist/src/lib/workflow-payload.d.ts +31 -20
- package/dist/src/lib/workflow-payload.js +100 -110
- package/dist/src/lib/workflow-payload.js.map +1 -1
- package/dist/src/lib/workflow-toml-validator.d.ts +37 -16
- package/dist/src/lib/workflow-toml-validator.js +141 -16
- package/dist/src/lib/workflow-toml-validator.js.map +1 -1
- package/dist/src/types/index.d.ts +78 -22
- package/dist/src/validators.d.ts +7 -7
- package/dist/src/validators.js +6 -6
- package/package.json +11 -6
- package/dist/src/commands/settings.d.ts +0 -15
- package/dist/src/commands/settings.js +0 -102
- package/dist/src/commands/settings.js.map +0 -1
|
@@ -0,0 +1,305 @@
|
|
|
1
|
+
import { existsSync, readdirSync, realpathSync } from "fs";
|
|
2
|
+
import { dirname, join } from "path";
|
|
3
|
+
import { fileURLToPath } from "url";
|
|
4
|
+
/** The npm package name of this CLI. */
|
|
5
|
+
export const PRIMITIVE_CLI_PACKAGE = "primitive-admin";
|
|
6
|
+
/** Normalize separators and drop a trailing slash so path matching is uniform. */
|
|
7
|
+
export function normalize(p) {
|
|
8
|
+
return p.replace(/\\/g, "/").replace(/\/+$/, "");
|
|
9
|
+
}
|
|
10
|
+
/** The entries of PATH, split on the separator this environment uses. */
|
|
11
|
+
function pathEntries(env) {
|
|
12
|
+
const pathVar = env.PATH || env.Path || "";
|
|
13
|
+
if (!pathVar)
|
|
14
|
+
return [];
|
|
15
|
+
const separator = pathVar.includes(";") && !pathVar.includes(":/") ? ";" : ":";
|
|
16
|
+
return pathVar.split(separator).filter(Boolean);
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Classifies an already-resolved absolute path to a file inside the installed
|
|
20
|
+
* package. Pure over (path, env) — no filesystem access, no child processes.
|
|
21
|
+
*/
|
|
22
|
+
export function classifyInstallPath(realPath, env) {
|
|
23
|
+
const p = normalize(realPath);
|
|
24
|
+
if (!p)
|
|
25
|
+
return { kind: "unknown" };
|
|
26
|
+
const lower = p.toLowerCase();
|
|
27
|
+
// Global roots we deliberately do not support (yarn, bun): classify as
|
|
28
|
+
// unknown so the caller renders the safe fallback command instead of an
|
|
29
|
+
// invalid yarn/bun one.
|
|
30
|
+
const bunInstall = env.BUN_INSTALL ? normalize(env.BUN_INSTALL) : null;
|
|
31
|
+
if (lower.includes("/yarn/global/") ||
|
|
32
|
+
lower.includes("/.config/yarn/") ||
|
|
33
|
+
lower.includes("/.yarn/") ||
|
|
34
|
+
lower.includes("/.bun/") ||
|
|
35
|
+
(bunInstall && lower.startsWith(`${bunInstall.toLowerCase()}/`))) {
|
|
36
|
+
return { kind: "unknown" };
|
|
37
|
+
}
|
|
38
|
+
// pnpm global: $PNPM_HOME, or one of the well-known pnpm global roots.
|
|
39
|
+
// (A bare `/.pnpm/` virtual-store segment is not a global signal on its own
|
|
40
|
+
// — a project's own node_modules/.pnpm store has one too — so it falls
|
|
41
|
+
// through to the "local" branch below.)
|
|
42
|
+
const pnpmHome = env.PNPM_HOME ? normalize(env.PNPM_HOME) : null;
|
|
43
|
+
if ((pnpmHome && lower.startsWith(`${pnpmHome.toLowerCase()}/`)) ||
|
|
44
|
+
lower.includes("/pnpm/global/")) {
|
|
45
|
+
return { kind: "global", manager: "pnpm" };
|
|
46
|
+
}
|
|
47
|
+
// npm global: `<prefix>/lib/node_modules` on POSIX, `<AppData>/npm/node_modules`
|
|
48
|
+
// on Windows. Covers homebrew, /usr/local, nvm, and volta-style prefixes.
|
|
49
|
+
if (lower.includes("/lib/node_modules/") || lower.includes("/npm/node_modules/")) {
|
|
50
|
+
return { kind: "global", manager: "npm" };
|
|
51
|
+
}
|
|
52
|
+
// Anything else under a node_modules directory is a project dependency.
|
|
53
|
+
if (lower.includes("/node_modules/")) {
|
|
54
|
+
return { kind: "local" };
|
|
55
|
+
}
|
|
56
|
+
// No node_modules segment at all — running from a git checkout.
|
|
57
|
+
return { kind: "source" };
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Picks the manager for a project-local install from the nearest lockfile,
|
|
61
|
+
* walking up from the installed file. Touches the filesystem, so it lives
|
|
62
|
+
* outside the pure classifier.
|
|
63
|
+
*/
|
|
64
|
+
function managerFromNearestLockfile(startPath) {
|
|
65
|
+
let dir = dirname(startPath);
|
|
66
|
+
for (let i = 0; i < 64; i++) {
|
|
67
|
+
if (existsSync(join(dir, "pnpm-lock.yaml")))
|
|
68
|
+
return "pnpm";
|
|
69
|
+
if (existsSync(join(dir, "package-lock.json")))
|
|
70
|
+
return "npm";
|
|
71
|
+
const parent = dirname(dir);
|
|
72
|
+
if (parent === dir)
|
|
73
|
+
break;
|
|
74
|
+
dir = parent;
|
|
75
|
+
}
|
|
76
|
+
return "npm";
|
|
77
|
+
}
|
|
78
|
+
/** Classifies the copy of the CLI that is executing right now. */
|
|
79
|
+
export function detectInstall(opts = {}) {
|
|
80
|
+
const env = opts.env ?? process.env;
|
|
81
|
+
try {
|
|
82
|
+
const selfPath = realpathSync(opts.selfPath ?? fileURLToPath(import.meta.url));
|
|
83
|
+
const classification = classifyInstallPath(selfPath, env);
|
|
84
|
+
if (classification.kind === "local") {
|
|
85
|
+
return { kind: "local", manager: managerFromNearestLockfile(selfPath) };
|
|
86
|
+
}
|
|
87
|
+
return classification;
|
|
88
|
+
}
|
|
89
|
+
catch {
|
|
90
|
+
return { kind: "unknown" };
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* True when a `pnpm` executable is found on PATH (no child process spawned).
|
|
95
|
+
*
|
|
96
|
+
* `template.ts` has a separate `isPnpmInstalled` that shells out to
|
|
97
|
+
* `pnpm --version`. Both exist on purpose: this module must not spawn child
|
|
98
|
+
* processes (it runs on every command, inside the version check), while
|
|
99
|
+
* `template.ts` needs to know pnpm actually *runs*, not just that a file with
|
|
100
|
+
* that name is on PATH. The two can therefore disagree — a broken pnpm binary
|
|
101
|
+
* satisfies this one and not that one.
|
|
102
|
+
*/
|
|
103
|
+
export function isPnpmOnPath(env = process.env) {
|
|
104
|
+
const entries = pathEntries(env);
|
|
105
|
+
if (entries.length === 0)
|
|
106
|
+
return false;
|
|
107
|
+
const candidates = process.platform === "win32" ? ["pnpm.cmd", "pnpm.exe", "pnpm"] : ["pnpm"];
|
|
108
|
+
for (const entry of entries) {
|
|
109
|
+
for (const candidate of candidates) {
|
|
110
|
+
try {
|
|
111
|
+
if (existsSync(join(entry, candidate)))
|
|
112
|
+
return true;
|
|
113
|
+
}
|
|
114
|
+
catch {
|
|
115
|
+
// Unreadable PATH entry — keep looking.
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
return false;
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* True when pnpm has somewhere to put a global install.
|
|
123
|
+
*
|
|
124
|
+
* `pnpm add -g` fails with `ERR_PNPM_NO_GLOBAL_BIN_DIR` when pnpm has no
|
|
125
|
+
* global bin directory — the state a machine is in when pnpm was installed
|
|
126
|
+
* with `npm install -g pnpm` and `pnpm setup` was never run, which is exactly
|
|
127
|
+
* what `primitive init` does when it bootstraps pnpm. A `pnpm` binary on PATH
|
|
128
|
+
* is therefore not enough to conclude that pnpm can install globally.
|
|
129
|
+
*
|
|
130
|
+
* Two signals count:
|
|
131
|
+
* - `PNPM_HOME` is set *and* on PATH. `pnpm setup` sets both together; when
|
|
132
|
+
* the directory is set but not on PATH the install succeeds and leaves a
|
|
133
|
+
* binary the user can't run.
|
|
134
|
+
* - A pnpm global root already exists on disk — pnpm has installed globals
|
|
135
|
+
* here before, so it has a working global bin directory.
|
|
136
|
+
*/
|
|
137
|
+
export function canPnpmInstallGlobally(env, execPath) {
|
|
138
|
+
const home = env.PNPM_HOME ? normalize(env.PNPM_HOME).toLowerCase() : null;
|
|
139
|
+
if (home && pathEntries(env).some((entry) => normalize(entry).toLowerCase() === home)) {
|
|
140
|
+
return true;
|
|
141
|
+
}
|
|
142
|
+
return globalRootCandidates(env, execPath).pnpm.some((root) => existingDir(join(root, "global")));
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* The manager to use when nothing else identifies one: pnpm when it is on
|
|
146
|
+
* PATH *and* able to install globally, else npm. Never suggest or run a
|
|
147
|
+
* command the user's machine can't carry out.
|
|
148
|
+
*/
|
|
149
|
+
function pathFallbackManager(opts) {
|
|
150
|
+
const env = opts.env ?? process.env;
|
|
151
|
+
const execPath = opts.execPath ?? process.execPath;
|
|
152
|
+
return isPnpmOnPath(env) && canPnpmInstallGlobally(env, execPath) ? "pnpm" : "npm";
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* The manager to install `pkg` globally with: whichever one already owns a
|
|
156
|
+
* global copy (so we upgrade that copy instead of creating a second one),
|
|
157
|
+
* else the PATH fallback.
|
|
158
|
+
*/
|
|
159
|
+
function installManager(pkg, opts) {
|
|
160
|
+
const existing = findDuplicateGlobalInstalls(pkg, opts);
|
|
161
|
+
if (existing.some((e) => e.manager === "pnpm"))
|
|
162
|
+
return "pnpm";
|
|
163
|
+
if (existing.some((e) => e.manager === "npm"))
|
|
164
|
+
return "npm";
|
|
165
|
+
return pathFallbackManager(opts);
|
|
166
|
+
}
|
|
167
|
+
function globalUpgrade(manager, spec) {
|
|
168
|
+
return manager === "pnpm" ? `pnpm add -g ${spec}` : `npm i -g ${spec}`;
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* The command that upgrades this install to `distTag` ("latest", "alpha", …),
|
|
172
|
+
* or null when there is nothing sensible to suggest (a source checkout).
|
|
173
|
+
*/
|
|
174
|
+
export function upgradeCommand(install, pkg, distTag, opts = {}) {
|
|
175
|
+
const spec = `${pkg}@${distTag}`;
|
|
176
|
+
switch (install.kind) {
|
|
177
|
+
case "global":
|
|
178
|
+
return globalUpgrade(install.manager, spec);
|
|
179
|
+
case "local":
|
|
180
|
+
return install.manager === "pnpm" ? `pnpm up ${spec}` : `npm i ${spec}`;
|
|
181
|
+
case "source":
|
|
182
|
+
// A git checkout can't be upgraded by a package manager, and suggesting
|
|
183
|
+
// one there is how a user ends up with an extra copy.
|
|
184
|
+
return null;
|
|
185
|
+
case "unknown":
|
|
186
|
+
return globalUpgrade(pathFallbackManager(opts), spec);
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
/** The argv for a first-time global install of `pkg`. */
|
|
190
|
+
export function installArgv(pkg, opts = {}) {
|
|
191
|
+
const manager = installManager(pkg, opts);
|
|
192
|
+
return manager === "pnpm"
|
|
193
|
+
? { command: "pnpm", args: ["add", "-g", pkg] }
|
|
194
|
+
: { command: "npm", args: ["install", "-g", pkg] };
|
|
195
|
+
}
|
|
196
|
+
/** The command a user should run for a first-time global install of `pkg`. */
|
|
197
|
+
export function installCommand(pkg, opts = {}) {
|
|
198
|
+
const { command, args } = installArgv(pkg, opts);
|
|
199
|
+
return [command, ...args].join(" ");
|
|
200
|
+
}
|
|
201
|
+
/**
|
|
202
|
+
* The install's location with symlinks resolved, or the path itself when it
|
|
203
|
+
* can't be resolved. pnpm's global `node_modules/<pkg>` is a link into
|
|
204
|
+
* `<root>/global/<version>/.pnpm/<pkg>@<version>/node_modules/<pkg>`, and only
|
|
205
|
+
* the resolved form matches the resolved path of the running CLI file.
|
|
206
|
+
*/
|
|
207
|
+
function resolveLink(path) {
|
|
208
|
+
try {
|
|
209
|
+
return realpathSync(path);
|
|
210
|
+
}
|
|
211
|
+
catch {
|
|
212
|
+
return path;
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
function existingDir(path) {
|
|
216
|
+
try {
|
|
217
|
+
return existsSync(path);
|
|
218
|
+
}
|
|
219
|
+
catch {
|
|
220
|
+
return false;
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
/** pnpm keeps its global installs under `<root>/global/<version>/node_modules`. */
|
|
224
|
+
function pnpmGlobalPackagePaths(root, pkg) {
|
|
225
|
+
const globalRoot = join(root, "global");
|
|
226
|
+
let versions = [];
|
|
227
|
+
try {
|
|
228
|
+
versions = readdirSync(globalRoot);
|
|
229
|
+
}
|
|
230
|
+
catch {
|
|
231
|
+
return [];
|
|
232
|
+
}
|
|
233
|
+
return versions
|
|
234
|
+
.map((v) => join(globalRoot, v, "node_modules", pkg))
|
|
235
|
+
.filter(existingDir);
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* The directories each manager could hold a global install in, derived from
|
|
239
|
+
* the environment and the running node executable. Pure — it only builds
|
|
240
|
+
* candidate paths; `findDuplicateGlobalInstalls` decides which ones exist.
|
|
241
|
+
*
|
|
242
|
+
* - pnpm keeps globals under `<pnpm root>/global/<version>/node_modules`.
|
|
243
|
+
* - npm keeps them under `<prefix>/lib/node_modules` (or
|
|
244
|
+
* `<AppData>/npm/node_modules` on Windows). The prefix is derived from the
|
|
245
|
+
* node executable and from every `.../bin` entry on PATH, which is what
|
|
246
|
+
* catches layouts like homebrew's, where the executable lives in a
|
|
247
|
+
* versioned Cellar directory but globals land in `/opt/homebrew`.
|
|
248
|
+
*/
|
|
249
|
+
export function globalRootCandidates(env, execPath) {
|
|
250
|
+
const pnpm = [
|
|
251
|
+
env.PNPM_HOME,
|
|
252
|
+
env.HOME ? join(env.HOME, "Library", "pnpm") : undefined,
|
|
253
|
+
env.HOME ? join(env.HOME, ".local", "share", "pnpm") : undefined,
|
|
254
|
+
env.LOCALAPPDATA ? join(env.LOCALAPPDATA, "pnpm") : undefined,
|
|
255
|
+
].filter((r) => !!r);
|
|
256
|
+
const prefixes = [dirname(dirname(execPath))];
|
|
257
|
+
if (env.npm_config_prefix)
|
|
258
|
+
prefixes.push(env.npm_config_prefix);
|
|
259
|
+
for (const entry of (env.PATH || env.Path || "").split(/[:;]/)) {
|
|
260
|
+
if (entry && /[\\/]bin$/.test(entry))
|
|
261
|
+
prefixes.push(dirname(entry));
|
|
262
|
+
}
|
|
263
|
+
const npm = prefixes.map((prefix) => join(prefix, "lib", "node_modules"));
|
|
264
|
+
if (env.APPDATA)
|
|
265
|
+
npm.push(join(env.APPDATA, "npm", "node_modules"));
|
|
266
|
+
return { pnpm: unique(pnpm), npm: unique(npm) };
|
|
267
|
+
}
|
|
268
|
+
function unique(paths) {
|
|
269
|
+
const seen = new Set();
|
|
270
|
+
return paths.filter((p) => {
|
|
271
|
+
const key = normalize(p);
|
|
272
|
+
if (seen.has(key))
|
|
273
|
+
return false;
|
|
274
|
+
seen.add(key);
|
|
275
|
+
return true;
|
|
276
|
+
});
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* Finds global copies of `pkg` in the global roots of each supported manager.
|
|
280
|
+
* Path checks only — no child processes.
|
|
281
|
+
*/
|
|
282
|
+
export function findDuplicateGlobalInstalls(pkg, opts = {}) {
|
|
283
|
+
const roots = opts.roots ?? globalRootCandidates(opts.env ?? process.env, opts.execPath ?? process.execPath);
|
|
284
|
+
const found = [];
|
|
285
|
+
const seen = new Set();
|
|
286
|
+
const add = (manager, path) => {
|
|
287
|
+
const key = normalize(path);
|
|
288
|
+
if (seen.has(key))
|
|
289
|
+
return;
|
|
290
|
+
seen.add(key);
|
|
291
|
+
found.push({ manager, path, realPath: resolveLink(path) });
|
|
292
|
+
};
|
|
293
|
+
for (const root of roots.pnpm) {
|
|
294
|
+
for (const path of pnpmGlobalPackagePaths(root, pkg)) {
|
|
295
|
+
add("pnpm", path);
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
for (const root of roots.npm) {
|
|
299
|
+
const path = join(root, pkg);
|
|
300
|
+
if (existingDir(path))
|
|
301
|
+
add("npm", path);
|
|
302
|
+
}
|
|
303
|
+
return found;
|
|
304
|
+
}
|
|
305
|
+
//# sourceMappingURL=package-manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"package-manager.js","sourceRoot":"","sources":["../../../src/lib/package-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,wCAAwC;AACxC,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;AA6DvD,kFAAkF;AAClF,MAAM,UAAU,SAAS,CAAC,CAAS;IACjC,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACnD,CAAC;AAED,yEAAyE;AACzE,SAAS,WAAW,CAAC,GAAsB;IACzC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;IAC3C,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IACxB,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;IAC/E,OAAO,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,QAAgB,EAChB,GAAsB;IAEtB,MAAM,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC9B,IAAI,CAAC,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;IAE9B,uEAAuE;IACvE,wEAAwE;IACxE,wBAAwB;IACxB,MAAM,UAAU,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACvE,IACE,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC/B,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC;QAChC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;QACzB,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACxB,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,EAChE,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAC7B,CAAC;IAED,uEAAuE;IACvE,4EAA4E;IAC5E,uEAAuE;IACvE,wCAAwC;IACxC,MAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,IACE,CAAC,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QAC5D,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC/B,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAC7C,CAAC;IAED,iFAAiF;IACjF,0EAA0E;IAC1E,IAAI,KAAK,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACjF,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC5C,CAAC;IAED,wEAAwE;IACxE,IAAI,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACrC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,gEAAgE;IAChE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,SAAS,0BAA0B,CAAC,SAAiB;IACnD,IAAI,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5B,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;YAAE,OAAO,MAAM,CAAC;QAC3D,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,MAAM,KAAK,GAAG;YAAE,MAAM;QAC1B,GAAG,GAAG,MAAM,CAAC;IACf,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,aAAa,CAAC,OAA6B,EAAE;IAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IACpC,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,QAAQ,IAAI,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/E,MAAM,cAAc,GAAG,mBAAmB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC1D,IAAI,cAAc,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACpC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1E,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY,CAAC,MAAyB,OAAO,CAAC,GAAG;IAC/D,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACvC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC9F,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,IAAI,CAAC;gBACH,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;oBAAE,OAAO,IAAI,CAAC;YACtD,CAAC;YAAC,MAAM,CAAC;gBACP,wCAAwC;YAC1C,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,sBAAsB,CACpC,GAAsB,EACtB,QAAgB;IAEhB,MAAM,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3E,IAAI,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,oBAAoB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC5D,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAClC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,mBAAmB,CAAC,IAA0B;IACrD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC;IACnD,OAAO,YAAY,CAAC,GAAG,CAAC,IAAI,sBAAsB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;AACrF,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,GAAW,EAAE,IAA0B;IAC7D,MAAM,QAAQ,GAAG,2BAA2B,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACxD,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,MAAM,CAAC;QAAE,OAAO,MAAM,CAAC;IAC9D,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC5D,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,aAAa,CAAC,OAAuB,EAAE,IAAY;IAC1D,OAAO,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC,CAAC,YAAY,IAAI,EAAE,CAAC;AACzE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAoB,EACpB,GAAW,EACX,OAAe,EACf,OAA6B,EAAE;IAE/B,MAAM,IAAI,GAAG,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;IACjC,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,QAAQ;YACX,OAAO,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC9C,KAAK,OAAO;YACV,OAAO,OAAO,CAAC,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC;QAC1E,KAAK,QAAQ;YACX,wEAAwE;YACxE,sDAAsD;YACtD,OAAO,IAAI,CAAC;QACd,KAAK,SAAS;YACZ,OAAO,aAAa,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,WAAW,CACzB,GAAW,EACX,OAA6B,EAAE;IAE/B,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1C,OAAO,OAAO,KAAK,MAAM;QACvB,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE;QAC/C,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;AACvD,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,cAAc,CAAC,GAAW,EAAE,OAA6B,EAAE;IACzE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACjD,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,IAAY;IAC/B,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAC/B,IAAI,CAAC;QACH,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,mFAAmF;AACnF,SAAS,sBAAsB,CAAC,IAAY,EAAE,GAAW;IACvD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxC,IAAI,QAAQ,GAAa,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,QAAQ;SACZ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,cAAc,EAAE,GAAG,CAAC,CAAC;SACpD,MAAM,CAAC,WAAW,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,oBAAoB,CAClC,GAAsB,EACtB,QAAgB;IAEhB,MAAM,IAAI,GAAG;QACX,GAAG,CAAC,SAAS;QACb,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;QACxD,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;QAChE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;KAC9D,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAElC,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC9C,IAAI,GAAG,CAAC,iBAAiB;QAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAChE,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/D,IAAI,KAAK,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;IAC1E,IAAI,GAAG,CAAC,OAAO;QAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC;IAEpE,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;AAClD,CAAC;AAED,SAAS,MAAM,CAAC,KAAe;IAC7B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QACxB,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QACzB,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CACzC,GAAW,EACX,OAA6B,EAAE;IAE/B,MAAM,KAAK,GACT,IAAI,CAAC,KAAK,IAAI,oBAAoB,CAAC,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjG,MAAM,KAAK,GAAoB,EAAE,CAAC;IAClC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAE/B,MAAM,GAAG,GAAG,CAAC,OAAuB,EAAE,IAAY,EAAE,EAAE;QACpD,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO;QAC1B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,sBAAsB,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;YACrD,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC7B,IAAI,WAAW,CAAC,IAAI,CAAC;YAAE,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -13,6 +13,56 @@ export interface PaginatedPage<T> {
|
|
|
13
13
|
items: T[];
|
|
14
14
|
nextCursor?: string | null;
|
|
15
15
|
}
|
|
16
|
+
/**
|
|
17
|
+
* The one list envelope the CLI prints (issue #2357).
|
|
18
|
+
*
|
|
19
|
+
* `nextCursor` is present only when there is a next page. The deprecated
|
|
20
|
+
* `cursor` alias (#1316, removal tracked in #1982) is accepted on input but
|
|
21
|
+
* never re-emitted, so CLI consumers are already on `nextCursor` when the
|
|
22
|
+
* server drops it.
|
|
23
|
+
*/
|
|
24
|
+
export interface ListEnvelope<T = any> {
|
|
25
|
+
items: T[];
|
|
26
|
+
hasMore: boolean;
|
|
27
|
+
nextCursor?: string;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Normalize an endpoint's list response into the CLI's own output contract.
|
|
31
|
+
*
|
|
32
|
+
* The records read paths speak two different wire shapes: js-bao's Durable
|
|
33
|
+
* Object envelope (`{ data, hasMore, nextCursor?, prevCursor? }`) and the
|
|
34
|
+
* server's unified list payload (`{ items, hasMore, nextCursor, cursor }`).
|
|
35
|
+
* Both are collapsed here to `{ items, hasMore, nextCursor? }` so like verbs
|
|
36
|
+
* print like envelopes.
|
|
37
|
+
*
|
|
38
|
+
* Accepts `items` or `data` as the array key and `nextCursor` or the
|
|
39
|
+
* deprecated `cursor` alias as the cursor. Throws when neither array key is
|
|
40
|
+
* present so an error body is never coerced into an empty result.
|
|
41
|
+
*
|
|
42
|
+
* Named `normalizeCliListEnvelope` to keep it distinct from the JS client's
|
|
43
|
+
* `normalizeListEnvelope` (`src/client/internal/listEnvelope.ts`), whose
|
|
44
|
+
* cursor contract is the opposite: it *back-fills* the deprecated `cursor`
|
|
45
|
+
* alias so the client keeps working against pre-#1316 servers, while this one
|
|
46
|
+
* drops it so CLI consumers are already off it when #1982 lands. The two are
|
|
47
|
+
* unrelated — the client helper is not re-exported from `src/client/index.ts`
|
|
48
|
+
* and the CLI does not depend on the client package.
|
|
49
|
+
*
|
|
50
|
+
* Note: the list methods in `api-client.ts` that re-emit the deprecated
|
|
51
|
+
* `cursor` alias are deliberately NOT routed through this helper — they must
|
|
52
|
+
* keep dual-emitting until #1982 closes its deprecation window, which is the
|
|
53
|
+
* opposite of this contract. As of this writing that is eight methods (grep
|
|
54
|
+
* `cursor: nextCursor` in `api-client.ts` for the current set):
|
|
55
|
+
* `listInvitations`, `listWebhookEvents`, `listWorkflowRuns`,
|
|
56
|
+
* `listUserWorkflowRuns`, `listAllAdmins`, `listGroups`, `listGroupMembers`,
|
|
57
|
+
* `listBucketBlobs`. The `listCollection*` methods only *read* the alias and
|
|
58
|
+
* emit `nextCursor` alone, so they already match this contract.
|
|
59
|
+
*
|
|
60
|
+
* `databases operations execute` routes through here too, but conditionally: a
|
|
61
|
+
* registered operation is only sometimes a list, so
|
|
62
|
+
* `normalizeDatabaseOperationResult()` (`api-client.ts`) tests the result shape
|
|
63
|
+
* first and calls this helper only for a Durable Object query page (#2440).
|
|
64
|
+
*/
|
|
65
|
+
export declare function normalizeCliListEnvelope<T = any>(raw: unknown): ListEnvelope<T>;
|
|
16
66
|
export type PageFetcher<T> = (cursor: string | undefined) => Promise<PaginatedPage<T>>;
|
|
17
67
|
export interface PaginateOptions {
|
|
18
68
|
/**
|
package/dist/src/lib/paginate.js
CHANGED
|
@@ -9,6 +9,59 @@
|
|
|
9
9
|
* Exported separately so the looping contract can be unit-tested without
|
|
10
10
|
* stubbing the full ApiClient.
|
|
11
11
|
*/
|
|
12
|
+
/**
|
|
13
|
+
* Normalize an endpoint's list response into the CLI's own output contract.
|
|
14
|
+
*
|
|
15
|
+
* The records read paths speak two different wire shapes: js-bao's Durable
|
|
16
|
+
* Object envelope (`{ data, hasMore, nextCursor?, prevCursor? }`) and the
|
|
17
|
+
* server's unified list payload (`{ items, hasMore, nextCursor, cursor }`).
|
|
18
|
+
* Both are collapsed here to `{ items, hasMore, nextCursor? }` so like verbs
|
|
19
|
+
* print like envelopes.
|
|
20
|
+
*
|
|
21
|
+
* Accepts `items` or `data` as the array key and `nextCursor` or the
|
|
22
|
+
* deprecated `cursor` alias as the cursor. Throws when neither array key is
|
|
23
|
+
* present so an error body is never coerced into an empty result.
|
|
24
|
+
*
|
|
25
|
+
* Named `normalizeCliListEnvelope` to keep it distinct from the JS client's
|
|
26
|
+
* `normalizeListEnvelope` (`src/client/internal/listEnvelope.ts`), whose
|
|
27
|
+
* cursor contract is the opposite: it *back-fills* the deprecated `cursor`
|
|
28
|
+
* alias so the client keeps working against pre-#1316 servers, while this one
|
|
29
|
+
* drops it so CLI consumers are already off it when #1982 lands. The two are
|
|
30
|
+
* unrelated — the client helper is not re-exported from `src/client/index.ts`
|
|
31
|
+
* and the CLI does not depend on the client package.
|
|
32
|
+
*
|
|
33
|
+
* Note: the list methods in `api-client.ts` that re-emit the deprecated
|
|
34
|
+
* `cursor` alias are deliberately NOT routed through this helper — they must
|
|
35
|
+
* keep dual-emitting until #1982 closes its deprecation window, which is the
|
|
36
|
+
* opposite of this contract. As of this writing that is eight methods (grep
|
|
37
|
+
* `cursor: nextCursor` in `api-client.ts` for the current set):
|
|
38
|
+
* `listInvitations`, `listWebhookEvents`, `listWorkflowRuns`,
|
|
39
|
+
* `listUserWorkflowRuns`, `listAllAdmins`, `listGroups`, `listGroupMembers`,
|
|
40
|
+
* `listBucketBlobs`. The `listCollection*` methods only *read* the alias and
|
|
41
|
+
* emit `nextCursor` alone, so they already match this contract.
|
|
42
|
+
*
|
|
43
|
+
* `databases operations execute` routes through here too, but conditionally: a
|
|
44
|
+
* registered operation is only sometimes a list, so
|
|
45
|
+
* `normalizeDatabaseOperationResult()` (`api-client.ts`) tests the result shape
|
|
46
|
+
* first and calls this helper only for a Durable Object query page (#2440).
|
|
47
|
+
*/
|
|
48
|
+
export function normalizeCliListEnvelope(raw) {
|
|
49
|
+
const page = raw;
|
|
50
|
+
const rawItems = page && typeof page === "object" && !Array.isArray(page)
|
|
51
|
+
? (page.items ?? page.data)
|
|
52
|
+
: undefined;
|
|
53
|
+
if (!Array.isArray(rawItems)) {
|
|
54
|
+
throw new Error("Unexpected list response: expected an object with an `items` or `data` array.");
|
|
55
|
+
}
|
|
56
|
+
const nextCursor = page.nextCursor ?? page.cursor ?? undefined;
|
|
57
|
+
const envelope = {
|
|
58
|
+
items: rawItems,
|
|
59
|
+
hasMore: typeof page.hasMore === "boolean" ? page.hasMore : Boolean(nextCursor),
|
|
60
|
+
};
|
|
61
|
+
if (nextCursor)
|
|
62
|
+
envelope.nextCursor = nextCursor;
|
|
63
|
+
return envelope;
|
|
64
|
+
}
|
|
12
65
|
/**
|
|
13
66
|
* Walk every cursor page from `fetchPage` and return the concatenated items.
|
|
14
67
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"paginate.js","sourceRoot":"","sources":["../../../src/lib/paginate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;
|
|
1
|
+
{"version":3,"file":"paginate.js","sourceRoot":"","sources":["../../../src/lib/paginate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAqBH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,UAAU,wBAAwB,CAAU,GAAY;IAC5D,MAAM,IAAI,GAAG,GAA6C,CAAC;IAC3D,MAAM,QAAQ,GACZ,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QACtD,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC;QAC3B,CAAC,CAAC,SAAS,CAAC;IAEhB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAG,IAAK,CAAC,UAAU,IAAI,IAAK,CAAC,MAAM,IAAI,SAAS,CAAC;IACjE,MAAM,QAAQ,GAAoB;QAChC,KAAK,EAAE,QAAe;QACtB,OAAO,EACL,OAAO,IAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;KAC3E,CAAC;IACF,IAAI,UAAU;QAAE,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;IACjD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAaD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,SAAyB,EACzB,UAA2B,EAAE;IAE7B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;IAC1C,MAAM,GAAG,GAAQ,EAAE,CAAC;IACpB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IACtC,IAAI,MAA0B,CAAC;IAE/B,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;QAC3C,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,CAAC;QAC1C,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,6CAA6C,IAAI,iDAAiD,CACnG,CAAC;QACJ,CAAC;QACD,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACtB,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,IAAI,KAAK,CACb,uBAAuB,QAAQ,iEAAiE,CACjG,CAAC;AACJ,CAAC"}
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
* the server's `src/workflows/reserved-workflow-keys.ts`). These rows are
|
|
6
6
|
* created and managed by the platform, never authored in an app's config tree:
|
|
7
7
|
*
|
|
8
|
-
* - `
|
|
9
|
-
* - `
|
|
10
|
-
* - `
|
|
8
|
+
* - `config pull` must not export them (they have no local TOML),
|
|
9
|
+
* - `config diff` must not report them (they are not app config),
|
|
10
|
+
* - `config push` must not upload them (the hollow export can't round-trip),
|
|
11
11
|
* - `workflows codegen` must not generate an invoker for them.
|
|
12
12
|
*
|
|
13
13
|
* The CLI cannot import from `src/`, so this module mirrors the server's prefix
|
|
@@ -35,3 +35,29 @@ export declare function isPlatformOwnedWorkflowKey(key: unknown): boolean;
|
|
|
35
35
|
* `key` covers a locally-parsed `[workflow]` table.
|
|
36
36
|
*/
|
|
37
37
|
export declare function isPlatformOwnedWorkflow(item: any): boolean;
|
|
38
|
+
/**
|
|
39
|
+
* Why the authoring surface refuses a platform-owned key (#2645).
|
|
40
|
+
*
|
|
41
|
+
* `config create`, `config set` and `config push --only` all name an object by
|
|
42
|
+
* `<type>/<key>`, and `config push` skips the reserved namespace — so scaffolding
|
|
43
|
+
* or selecting one produces a file that is never uploaded, or a push that
|
|
44
|
+
* reports success having applied nothing. With configuration authored in TOML
|
|
45
|
+
* only, those are the two failures the surface has to make impossible: a flag
|
|
46
|
+
* that was rejected was visible, a file that is silently ignored is not.
|
|
47
|
+
*
|
|
48
|
+
* Returns the operator-facing reason, or `undefined` when the key is authorable.
|
|
49
|
+
* Pure, so every caller can be unit-tested without a live server.
|
|
50
|
+
*/
|
|
51
|
+
export declare function platformOwnedAuthoringError(type: string, key: string): string | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* Why the authoring surface refuses `<type>/<key>` — or `undefined` when it
|
|
54
|
+
* doesn't.
|
|
55
|
+
*
|
|
56
|
+
* The same question `config create`, `config set` and `config push --only`
|
|
57
|
+
* each ask before touching a file, now with two answers: a platform-owned
|
|
58
|
+
* workflow key (#1660/#2645) and a retired email type (#2884). Both fail the
|
|
59
|
+
* same way if unchecked — a file that is written locally and then either
|
|
60
|
+
* skipped silently or refused at the far end of a push — so both are refused
|
|
61
|
+
* at the point the key is named, with the sentence that says what to do.
|
|
62
|
+
*/
|
|
63
|
+
export declare function configAuthoringError(type: string, key: string): string | undefined;
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
* the server's `src/workflows/reserved-workflow-keys.ts`). These rows are
|
|
6
6
|
* created and managed by the platform, never authored in an app's config tree:
|
|
7
7
|
*
|
|
8
|
-
* - `
|
|
9
|
-
* - `
|
|
10
|
-
* - `
|
|
8
|
+
* - `config pull` must not export them (they have no local TOML),
|
|
9
|
+
* - `config diff` must not report them (they are not app config),
|
|
10
|
+
* - `config push` must not upload them (the hollow export can't round-trip),
|
|
11
11
|
* - `workflows codegen` must not generate an invoker for them.
|
|
12
12
|
*
|
|
13
13
|
* The CLI cannot import from `src/`, so this module mirrors the server's prefix
|
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
* NOT here — it is deferred until a second resource type has a platform-owned
|
|
19
19
|
* contract (human decision, 2026-07-17).
|
|
20
20
|
*/
|
|
21
|
+
import { isRetiredEmailType, retiredEmailTypeGuidance, } from "./generated-config-surfaces.js";
|
|
21
22
|
/** Prefix marking a platform-owned workflow key (mirrors the server). */
|
|
22
23
|
export const INTERNAL_WORKFLOW_KEY_PREFIX = "__internal.";
|
|
23
24
|
/**
|
|
@@ -43,4 +44,42 @@ export function isPlatformOwnedWorkflow(item) {
|
|
|
43
44
|
const key = item?.workflowKey ?? item?.key;
|
|
44
45
|
return isPlatformOwnedWorkflowKey(key);
|
|
45
46
|
}
|
|
47
|
+
/**
|
|
48
|
+
* Why the authoring surface refuses a platform-owned key (#2645).
|
|
49
|
+
*
|
|
50
|
+
* `config create`, `config set` and `config push --only` all name an object by
|
|
51
|
+
* `<type>/<key>`, and `config push` skips the reserved namespace — so scaffolding
|
|
52
|
+
* or selecting one produces a file that is never uploaded, or a push that
|
|
53
|
+
* reports success having applied nothing. With configuration authored in TOML
|
|
54
|
+
* only, those are the two failures the surface has to make impossible: a flag
|
|
55
|
+
* that was rejected was visible, a file that is silently ignored is not.
|
|
56
|
+
*
|
|
57
|
+
* Returns the operator-facing reason, or `undefined` when the key is authorable.
|
|
58
|
+
* Pure, so every caller can be unit-tested without a live server.
|
|
59
|
+
*/
|
|
60
|
+
export function platformOwnedAuthoringError(type, key) {
|
|
61
|
+
if (type !== "workflow" || !isPlatformOwnedWorkflowKey(key))
|
|
62
|
+
return undefined;
|
|
63
|
+
return `'${key}' is a platform-owned workflow — the reserved '${INTERNAL_WORKFLOW_KEY_PREFIX}' namespace is managed by the platform. 'config pull' does not export these and 'config push' skips them, so a file here would never reach the server.`;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Why the authoring surface refuses `<type>/<key>` — or `undefined` when it
|
|
67
|
+
* doesn't.
|
|
68
|
+
*
|
|
69
|
+
* The same question `config create`, `config set` and `config push --only`
|
|
70
|
+
* each ask before touching a file, now with two answers: a platform-owned
|
|
71
|
+
* workflow key (#1660/#2645) and a retired email type (#2884). Both fail the
|
|
72
|
+
* same way if unchecked — a file that is written locally and then either
|
|
73
|
+
* skipped silently or refused at the far end of a push — so both are refused
|
|
74
|
+
* at the point the key is named, with the sentence that says what to do.
|
|
75
|
+
*/
|
|
76
|
+
export function configAuthoringError(type, key) {
|
|
77
|
+
const platformOwned = platformOwnedAuthoringError(type, key);
|
|
78
|
+
if (platformOwned)
|
|
79
|
+
return platformOwned;
|
|
80
|
+
if (type === "email-template" && isRetiredEmailType(key)) {
|
|
81
|
+
return retiredEmailTypeGuidance(key);
|
|
82
|
+
}
|
|
83
|
+
return undefined;
|
|
84
|
+
}
|
|
46
85
|
//# sourceMappingURL=platform-owned.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"platform-owned.js","sourceRoot":"","sources":["../../../src/lib/platform-owned.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,yEAAyE;AACzE,MAAM,CAAC,MAAM,4BAA4B,GAAG,aAAa,CAAC;AAE1D;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,GAAY;IACrD,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAClE,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAS;IAC/C,IAAI,IAAI,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACrD,MAAM,GAAG,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,EAAE,GAAG,CAAC;IAC3C,OAAO,0BAA0B,CAAC,GAAG,CAAC,CAAC;AACzC,CAAC"}
|
|
1
|
+
{"version":3,"file":"platform-owned.js","sourceRoot":"","sources":["../../../src/lib/platform-owned.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EACL,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,gCAAgC,CAAC;AAExC,yEAAyE;AACzE,MAAM,CAAC,MAAM,4BAA4B,GAAG,aAAa,CAAC;AAE1D;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,GAAY;IACrD,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAClE,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAS;IAC/C,IAAI,IAAI,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACrD,MAAM,GAAG,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,EAAE,GAAG,CAAC;IAC3C,OAAO,0BAA0B,CAAC,GAAG,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,2BAA2B,CACzC,IAAY,EACZ,GAAW;IAEX,IAAI,IAAI,KAAK,UAAU,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAC9E,OAAO,IAAI,GAAG,kDAAkD,4BAA4B,wJAAwJ,CAAC;AACvP,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAY,EACZ,GAAW;IAEX,MAAM,aAAa,GAAG,2BAA2B,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7D,IAAI,aAAa;QAAE,OAAO,aAAa,CAAC;IACxC,IAAI,IAAI,KAAK,gBAAgB,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;QACzD,OAAO,wBAAwB,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}
|
|
@@ -34,6 +34,14 @@ export interface ProjectEnvironment {
|
|
|
34
34
|
apiUrl: string;
|
|
35
35
|
appId?: string;
|
|
36
36
|
appName?: string;
|
|
37
|
+
/**
|
|
38
|
+
* The app's web counterpart for this environment, as a normalized origin
|
|
39
|
+
* (`https://app.example.com`) — the deployment whose `/oauth/callback` the
|
|
40
|
+
* emailed sign-in link points at, and the origin an incoming universal link
|
|
41
|
+
* is trusted from (#2982). Per environment, because that deployment has to
|
|
42
|
+
* talk to the same backend and app as this entry.
|
|
43
|
+
*/
|
|
44
|
+
webUrl?: string;
|
|
37
45
|
/** Optional notes about this environment. */
|
|
38
46
|
description?: string;
|
|
39
47
|
}
|
|
@@ -18,6 +18,18 @@
|
|
|
18
18
|
*/
|
|
19
19
|
import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
|
|
20
20
|
import { dirname, join, resolve } from "path";
|
|
21
|
+
import { detectInstall, installCommand, upgradeCommand, PRIMITIVE_CLI_PACKAGE, } from "./package-manager.js";
|
|
22
|
+
import { validateServerUrl } from "./server-url.js";
|
|
23
|
+
import { normalizeWebUrl, validateWebUrl } from "./web-url.js";
|
|
24
|
+
/**
|
|
25
|
+
* The command that upgrades the running CLI. Falls back to the first-time
|
|
26
|
+
* install command when the running copy can't be upgraded by a package
|
|
27
|
+
* manager (a source checkout).
|
|
28
|
+
*/
|
|
29
|
+
function cliUpgradeCommand() {
|
|
30
|
+
return (upgradeCommand(detectInstall(), PRIMITIVE_CLI_PACKAGE, "latest") ??
|
|
31
|
+
installCommand(PRIMITIVE_CLI_PACKAGE));
|
|
32
|
+
}
|
|
21
33
|
/**
|
|
22
34
|
* Current schema version. Increment the major version when making
|
|
23
35
|
* backward-incompatible changes. Older configs will be rejected.
|
|
@@ -104,7 +116,7 @@ export function validateProjectConfig(raw, sourcePath) {
|
|
|
104
116
|
// reject v1 configs and tell the user to migrate.
|
|
105
117
|
if (version !== CURRENT_CONFIG_VERSION) {
|
|
106
118
|
if (version > CURRENT_CONFIG_VERSION) {
|
|
107
|
-
throw new ProjectConfigError(`${PROJECT_CONFIG_DISPLAY_NAME} has version ${version}, but this CLI only understands version ${CURRENT_CONFIG_VERSION}. Please upgrade the CLI:
|
|
119
|
+
throw new ProjectConfigError(`${PROJECT_CONFIG_DISPLAY_NAME} has version ${version}, but this CLI only understands version ${CURRENT_CONFIG_VERSION}. Please upgrade the CLI: ${cliUpgradeCommand()}`, sourcePath);
|
|
108
120
|
}
|
|
109
121
|
throw new ProjectConfigError(`${PROJECT_CONFIG_DISPLAY_NAME} has unsupported version ${version}. This CLI expects version ${CURRENT_CONFIG_VERSION}.`, sourcePath);
|
|
110
122
|
}
|
|
@@ -124,10 +136,7 @@ export function validateProjectConfig(raw, sourcePath) {
|
|
|
124
136
|
if (typeof envObj.apiUrl !== "string" || !envObj.apiUrl) {
|
|
125
137
|
throw new ProjectConfigError(`Environment "${name}" must have a non-empty "apiUrl" string in ${PROJECT_CONFIG_DISPLAY_NAME}.`, sourcePath);
|
|
126
138
|
}
|
|
127
|
-
|
|
128
|
-
new URL(envObj.apiUrl);
|
|
129
|
-
}
|
|
130
|
-
catch {
|
|
139
|
+
if (validateServerUrl(envObj.apiUrl) !== true) {
|
|
131
140
|
throw new ProjectConfigError(`Environment "${name}" has invalid apiUrl: ${envObj.apiUrl}`, sourcePath);
|
|
132
141
|
}
|
|
133
142
|
if (envObj.appId !== undefined && typeof envObj.appId !== "string") {
|
|
@@ -139,10 +148,26 @@ export function validateProjectConfig(raw, sourcePath) {
|
|
|
139
148
|
if (envObj.description !== undefined && typeof envObj.description !== "string") {
|
|
140
149
|
throw new ProjectConfigError(`Environment "${name}": "description" must be a string if set.`, sourcePath);
|
|
141
150
|
}
|
|
151
|
+
// An origin, not any URL: the emailed sign-in link is built from it, so a
|
|
152
|
+
// value the server's allow-list would refuse — or one whose callback path
|
|
153
|
+
// neither the web app nor the AASA component names — is a 400 or a dead
|
|
154
|
+
// link later rather than an error here (#2982).
|
|
155
|
+
if (envObj.webUrl !== undefined) {
|
|
156
|
+
if (typeof envObj.webUrl !== "string") {
|
|
157
|
+
throw new ProjectConfigError(`Environment "${name}": "webUrl" must be a string if set.`, sourcePath);
|
|
158
|
+
}
|
|
159
|
+
const problem = validateWebUrl(envObj.webUrl);
|
|
160
|
+
if (problem !== true) {
|
|
161
|
+
throw new ProjectConfigError(`Environment "${name}" has invalid webUrl: ${problem}`, sourcePath);
|
|
162
|
+
}
|
|
163
|
+
}
|
|
142
164
|
environments[name] = {
|
|
143
165
|
apiUrl: envObj.apiUrl.replace(/\/$/, ""),
|
|
144
166
|
appId: envObj.appId,
|
|
145
167
|
appName: envObj.appName,
|
|
168
|
+
webUrl: envObj.webUrl === undefined
|
|
169
|
+
? undefined
|
|
170
|
+
: normalizeWebUrl(envObj.webUrl),
|
|
146
171
|
description: envObj.description,
|
|
147
172
|
};
|
|
148
173
|
}
|