@vtex/faststore 0.0.10 → 0.0.11

package/dist/cli/server-runtime.js

@@ -49270,18 +49270,30 @@ var extendable_entities_default = {
 };
 //#endregion
 //#region src/cli/subgraph/vendor-prefix.ts
-/** GraphQL-safe vendor token: lowercase letters and digits, starting with a letter (ADR-0001). */
-const VENDOR_PATTERN = /^[a-z][a-z0-9]*$/;
 /** The root operation type names, whose fields are always prefixed as root fields (never renamed as types). */
 const ROOT_TYPE_NAMES = /* @__PURE__ */ new Set([
 	"Query",
 	"Mutation",
 	"Subscription"
 ]);
-/** Throws when `vendor` is missing or does not match `^[a-z][a-z0-9]*$` (FR-2, ADR-0001). */
-function assertValidVendor(vendor) {
-	if (!vendor) throw new Error("buildSubgraph: `vendor` is required on defineSubgraph.");
-	if (!VENDOR_PATTERN.test(vendor)) throw new Error(`buildSubgraph: vendor "${vendor}" must match ${VENDOR_PATTERN}.`);
+/**
+* The platform's vendor grammar, `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`, minus the leading digit no GraphQL
+* name admits. Checked on the vendor as written, before any `-` becomes `_`: `acme_corp` is not a
+* vendor, and mapping first would let it share `acme-corp`'s token.
+*/
+const VENDOR_PATTERN = /^[a-z](?:[-a-z0-9]*[a-z0-9])?$/;
+/**
+* The vendor as a GraphQL name prefix: every `-` becomes `_`, so `acme-corp` prefixes
+* `acme_corp_reviews`. A digit-leading vendor is the one platform vendor refused here, with the
+* message the Finding carries. Kept in this graphql-only module, not beside the manifest reader,
+* so `server.mjs` bundles no file parser.
+*/
+function vendorPrefixToken(vendor) {
+	if (!VENDOR_PATTERN.test(vendor)) throw new Error(vendorInvalidMessage(vendor));
+	return vendor.replaceAll("-", "_");
+}
+function vendorInvalidMessage(vendor) {
+	return `storefront: vendor ${JSON.stringify(vendor)} must be kebab-case and start with a letter to prefix GraphQL names (lowercase letters, digits and hyphens, not ending in one).`;
 }
 /** The declared type-definition kinds a `vendor_` type-prefix applies to (FR-3): object, input, enum, interface, union. */
 const DECLARED_TYPE_KINDS = /* @__PURE__ */ new Set([
@@ -49311,7 +49323,8 @@ function collectDeclaredTypeNames(document, coreTypenames) {
 }
 /**
 * The prefix pass — a pure `graphql` AST transform. Renames every name this
-* extension contributes to `<vendor>_<name>`:
+* extension contributes to `<token>_<name>`, where `token` is the vendor with
+* `-` mapped to `_` (`vendorPrefixToken` above):
 *
 * - fields added to a core entity (`extend type Product { reviews }`),
 *   except the entity's `@key` field(s), which are core-owned;
@@ -49329,12 +49342,12 @@ function collectDeclaredTypeNames(document, coreTypenames) {
 * from the same pass, so the SDL rename and the resolver remap can never
 * drift apart (ADR-0001).
 */
-function applyVendorPrefix(document, vendor, coreEntities) {
+function applyVendorPrefix(document, token, coreEntities) {
 	const coreEntityByTypename = new Map(coreEntities.map((entity) => [entity.typename, entity]));
 	const declaredTypeNames = collectDeclaredTypeNames(document, new Set(coreEntityByTypename.keys()));
 	const resolverKeyRenames = {};
 	function renameField(typename, fieldName) {
-		const prefixed = `${vendor}_${fieldName}`;
+		const prefixed = `${token}_${fieldName}`;
 		resolverKeyRenames[typename] = {
 			...resolverKeyRenames[typename],
 			[fieldName]: prefixed
@@ -49348,7 +49361,7 @@ function applyVendorPrefix(document, vendor, coreEntities) {
 			...node,
 			name: {
 				...node.name,
-				value: `${vendor}_${node.name.value}`
+				value: `${token}_${node.name.value}`
 			}
 		};
 	}
@@ -49379,7 +49392,7 @@ function applyVendorPrefix(document, vendor, coreEntities) {
 				...node,
 				name: {
 					...node.name,
-					value: `${vendor}_${node.name.value}`
+					value: `${token}_${node.name.value}`
 				}
 			};
 		},
@@ -49405,7 +49418,7 @@ function applyVendorPrefix(document, vendor, coreEntities) {
 		}
 	});
 	const declaredTypeRenames = {};
-	for (const typeName of declaredTypeNames) declaredTypeRenames[typeName] = `${vendor}_${typeName}`;
+	for (const typeName of declaredTypeNames) declaredTypeRenames[typeName] = `${token}_${typeName}`;
 	return {
 		sdl: (0, import_graphql.print)(renamed),
 		resolverKeyRenames,
@@ -49537,35 +49550,6 @@ function assertNoDeclareAndExtendSameType(document, coreTypenames) {
 		throw new Error(`buildSubgraph: typeDefs both declares \`type ${typename}\` and extends it with \`extend type ${typename}\` in the same subgraph. Merge the fields into a single \`type ${typename}\` declaration.`);
 	}
 }
-const SECRET_NAME_PATTERN = /^[A-Z][A-Z0-9_]*$/;
-/**
-* Operational environment the runner and Node depend on. Declaring one of
-* these as a secret would have the boot-time scrub delete it from the live
-* `process.env` — exactly the damage ADR-0002 promises the scrub can never
-* do ("operational env is always preserved").
-*/
-const RESERVED_SECRET_NAMES = /* @__PURE__ */ new Set([
-	"PATH",
-	"HOME",
-	"PWD",
-	"SHELL",
-	"TMPDIR"
-]);
-const RESERVED_SECRET_PREFIXES = ["VTEX_", "NODE_"];
-/**
-* Validates the declared `secrets` names before anything captures or scrubs
-* them. Guards the failure modes tsx never catches at runtime: a non-array
-* declaration (`secrets: 'KEY'` would be iterated character by character)
-* and a reserved name whose scrub would break the process.
-*/
-function assertValidSecrets(secrets) {
-	if (secrets === void 0) return;
-	if (!Array.isArray(secrets)) throw new Error(`buildSubgraph: \`secrets\` must be an array of names, got ${typeof secrets}. Declare it as secrets: ['ACME_API_KEY'].`);
-	for (const name of secrets) {
-		if (typeof name !== "string" || !SECRET_NAME_PATTERN.test(name)) throw new Error(`buildSubgraph: invalid secret name ${JSON.stringify(name)}. Secret names must match ${SECRET_NAME_PATTERN} (e.g. ACME_API_KEY).`);
-		if (RESERVED_SECRET_NAMES.has(name) || RESERVED_SECRET_PREFIXES.some((prefix) => name.startsWith(prefix))) throw new Error(`buildSubgraph: secret name "${name}" is reserved operational environment — declaring it would remove it from process.env at boot (ADR-0002). Choose an extension-specific name instead.`);
-	}
-}
 function assertEntityHasKey(document, typename) {
 	if (!findKeyDirective(document, typename)) throw new Error(`buildSubgraph: "${typename}" is listed in \`extends\` but its declaration in typeDefs has no @key directive. An extended entity must declare its frozen @key (e.g. @key(fields: "slug")).`);
 }
@@ -49633,16 +49617,15 @@ function resolveCoreEntities(document, extendsList) {
 	}));
 }
 /**
-* Validates `vendor` and the declared `secrets`, checks `extends` against
-* the bundled allow-list, and applies the vendor-prefix pass over `typeDefs`
+* Derives the prefix token from `vendor`, checks `extends` against the
+* bundled allow-list, and applies the vendor-prefix pass over `typeDefs`
 * — the shared step behind
 * both `buildSubgraph` and `printSubgraphSdl` so the built schema and the
 * emitted SDL always agree. Returns the prefixed SDL (still
 * `@link`-preamble-free) plus the resolver renames the same pass derived.
 */
-function prefixTypeDefs(definition) {
-	assertValidVendor(definition.vendor);
-	assertValidSecrets(definition.secrets);
+function prefixTypeDefs(definition, vendor) {
+	const token = vendorPrefixToken(vendor);
 	const allowList = loadExtendableEntities();
 	assertExtendsAllowed(definition.extends, allowList);
 	const document = (0, import_graphql.parse)(definition.typeDefs);
@@ -49654,13 +49637,12 @@ function prefixTypeDefs(definition) {
 		assertEntityHasKey(document, typename);
 		assertKeyMatchesAllowList(document, typename, allowList);
 	}
-	const coreEntities = resolveCoreEntities(document, definition.extends);
-	return applyVendorPrefix(document, definition.vendor, coreEntities);
+	return applyVendorPrefix(document, token, resolveCoreEntities(document, definition.extends));
 }
 /**
 * Turns a `SubgraphDefinition` into an executable Federation v2 subgraph
-* schema: validates `vendor` and the `extends` allow-list, applies the
-* vendor-prefix pass over `typeDefs`, injects the `@link` preamble when
+* schema: derives the prefix from `vendor`, the Platform Extension's, checks
+* the `extends` allow-list, applies the vendor-prefix pass over `typeDefs`, injects the `@link` preamble when
 * absent, generates an identity `__resolveReference` for each entity in
 * `extends`, merges the author's resolvers (remapped to the prefixed field
 * names), and hands the result to `buildSubgraphSchema`. Throws descriptive
@@ -49673,8 +49655,8 @@ function prefixTypeDefs(definition) {
 * non-atomically. Authors own idempotency/compensation for their own
 * mutations (see the RFC's "Resolved v1 decisions").
 */
-function buildSubgraph(definition) {
-	const { sdl: prefixedSdl, resolverKeyRenames, declaredTypeRenames } = prefixTypeDefs(definition);
+function buildSubgraph(definition, vendor) {
+	const { sdl: prefixedSdl, resolverKeyRenames, declaredTypeRenames } = prefixTypeDefs(definition, vendor);
 	const prefixedDocument = (0, import_graphql.parse)(prefixedSdl);
 	const mergedResolvers = {};
 	for (const typename of definition.extends) mergedResolvers[typename] = { __resolveReference: identityResolveReference() };
@@ -49718,11 +49700,11 @@ const BODY_LIMIT = "50mb";
 * `onError` receives a listener error after boot. The default prints, which is
 * `server.mjs`'s to do; `dev` passes its log sink instead.
 */
-async function startSubgraphServer(definition, port, contextInputs = {
+async function startSubgraphServer(definition, vendor, port, contextInputs = {
 	secretNames: [],
 	secrets: {}
 }, onError = (error) => console.error("storefront: subgraph server error after startup.", error)) {
-	const schema = buildSubgraph(definition);
+	const schema = buildSubgraph(definition, vendor);
 	const app = (0, import_express.default)();
 	const httpServer = createServer(app);
 	const server = new ApolloServer({
@@ -49814,12 +49796,11 @@ function resolvePort(env) {
 * found it. Nothing is read from disk, so the artifact runs on a read-only
 * filesystem.
 */
-async function serveDeclaration(definition, { name, env = process.env }) {
+async function serveDeclaration(definition, { name, vendor, secrets: secretNames, env = process.env }) {
 	const port = resolvePort(env);
-	const secretNames = definition.secrets ?? [];
 	const secrets = captureSecrets(secretNames, env);
 	for (const line of unsetSecretWarnings(secretNames, secrets, "server")) console.warn(line);
-	const server = await startSubgraphServer(definition, port, {
+	const server = await startSubgraphServer(definition, vendor, port, {
 		secretNames,
 		secrets
 	});
@@ -49827,7 +49808,7 @@ async function serveDeclaration(definition, { name, env = process.env }) {
 	console.log(JSON.stringify({
 		msg: "storefront subgraph: ready",
 		extension: name,
-		vendor: definition.vendor,
+		vendor,
 		port,
 		url: server.url,
 		secrets: secretNames
@@ -49865,9 +49846,9 @@ function installShutdownHandlers(handle, exit = process.exit) {
 * listening; on success the server keeps the process alive and the handlers
 * own the exit.
 */
-async function runServer(definition, name) {
+async function runServer(definition, identity) {
 	try {
-		installShutdownHandlers(await serveDeclaration(definition, { name }));
+		installShutdownHandlers(await serveDeclaration(definition, identity));
 	} catch (error) {
 		console.error(error instanceof Error ? error.message : String(error));
 		process.exit(1);