@decocms/apps-vtex 7.9.0 → 7.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decocms/apps-vtex",
-  "version": "7.9.0",
+  "version": "7.10.0",
   "type": "module",
   "description": "Deco commerce app: VTEX integration",
   "repository": {
@@ -17,6 +17,7 @@
     ".": "./src/index.ts",
     "./commerceLoaders": "./src/commerceLoaders.ts",
     "./mod": "./src/mod.ts",
+    "./schemas": "./src/schemas.ts",
     "./client": "./src/client.ts",
     "./types": "./src/types.ts",
     "./actions": "./src/actions/index.ts",
@@ -44,15 +45,16 @@
   },
   "scripts": {
     "build": "tsc",
+    "generate:schemas": "bun ../blocks-cli/scripts/generate-app-schemas.ts",
     "test": "vitest run --root ../.. packages/apps-vtex/",
     "typecheck": "tsc --noEmit",
     "lint:unused": "knip"
   },
   "dependencies": {
-    "@decocms/blocks": "7.9.0",
-    "@decocms/apps-commerce": "7.9.0",
-    "@decocms/apps-website": "7.9.0",
-    "@decocms/tanstack": "7.9.0"
+    "@decocms/blocks": "7.10.0",
+    "@decocms/apps-commerce": "7.10.0",
+    "@decocms/apps-website": "7.10.0",
+    "@decocms/tanstack": "7.10.0"
   },
   "peerDependencies": {
     "react": "^19.0.0",

package/src/__tests__/schemas.test.ts

@@ -0,0 +1,71 @@
+/**
+ * End-to-end guard for the acceptance criteria of "real props schemas in
+ * /deco/meta": after a site wires VTEX the standard way
+ * (createVtexCommerceLoaders → registerCommerceLoaders), the composed meta
+ * must publish the real props of the app's loaders/actions — enums included —
+ * not the `__resolveType`-only stubs.
+ */
+
+import { registerCommerceLoaders } from "@decocms/blocks/cms";
+import { composeMeta, type MetaResponse } from "@decocms/blocks/cms/client";
+import { describe, expect, it } from "vitest";
+import { createVtexCommerceLoaders } from "../commerceLoaders";
+import { registerVtexSchemas } from "../schemas";
+
+const b64 = (s: string) => Buffer.from(s).toString("base64");
+
+const emptySiteMeta = (): MetaResponse => ({
+	major: 1,
+	version: "1.0.0",
+	namespace: "site",
+	site: "test",
+	manifest: { blocks: {} },
+	schema: { definitions: {}, root: {} },
+});
+
+describe("vtex schemas in the composed meta", () => {
+	// Mirrors a real site setup: build the loader map (this also registers the
+	// real schemas), then register it (which auto-registers the stubs).
+	registerCommerceLoaders(createVtexCommerceLoaders());
+	registerVtexSchemas();
+	const meta = composeMeta(emptySiteMeta());
+	const def = (key: string) => meta.schema.definitions[b64(key)];
+
+	it("publishes real props for the intelligent-search PDP loader (both key forms)", () => {
+		for (const key of [
+			"vtex/loaders/intelligentSearch/productDetailsPage.ts",
+			"vtex/loaders/intelligentSearch/productDetailsPage",
+		]) {
+			const d = def(key);
+			expect(d, key).toBeDefined();
+			expect(d.properties.slug, key).toMatchObject({ type: "string" });
+			expect(d.properties.__resolveType.enum, key).toEqual([key]);
+			expect(d.additionalProperties, key).toBeUndefined();
+		}
+	});
+
+	it("publishes the legacy PLP loader with its sort enum preserved", () => {
+		const d = def("vtex/loaders/legacy/productListingPage.ts");
+		expect(d).toBeDefined();
+		expect(d.properties.sort.enum).toContain("OrderByPriceDESC");
+		expect(d.properties.sort.enum).toContain("OrderByPriceASC");
+		expect(d.properties.count).toMatchObject({ type: "number" });
+		expect(d.properties.fq).toMatchObject({ type: "string" });
+	});
+
+	it("publishes real props for a checkout action", () => {
+		const d = def("vtex/actions/checkout/addItemsToCart.ts");
+		expect(d).toBeDefined();
+		expect(d.properties.orderItems).toMatchObject({ type: "array" });
+		expect(d.additionalProperties).toBeUndefined();
+	});
+
+	it("keeps the JSON-editor stub shape for keys without a generated schema", () => {
+		// Registered by createVtexCommerceLoaders but owned by another namespace —
+		// no schemas.gen entry, so the stub (additionalProperties: true) survives.
+		const d = def("commerce/loaders/navbar.ts");
+		expect(d).toBeDefined();
+		expect(d.additionalProperties).toBe(true);
+		expect(Object.keys(d.properties)).toEqual(["__resolveType"]);
+	});
+});

package/src/commerceLoaders.ts

@@ -19,6 +19,7 @@ import vtexSuggestions from "./loaders/intelligentSearch/suggestions";
 import vtexRelatedProducts from "./loaders/legacy/relatedProductsLoader";
 import vtexProductList from "./loaders/productListFull";
 import vtexWorkflowProducts from "./loaders/workflow/products";
+import { registerVtexSchemas } from "./schemas";
 import { VALID_IS_SORTS } from "./utils/intelligentSearch";
 
 export type CommerceLoaderFn = (props: any) => Promise<any>;
@@ -85,6 +86,11 @@ function extractCollectionName(result: any, collectionId: string): string | null
 export function createVtexCommerceLoaders(
 	options?: VtexCommerceLoadersOptions,
 ): Record<string, CommerceLoaderFn> {
+	// Real props schemas for the admin meta. The stub registration that
+	// registerCommerceLoaders() later performs for this returned map never
+	// overwrites these (real-over-stub precedence in the schema registry).
+	registerVtexSchemas();
+
 	const profiles = {
 		listing: options?.cacheProfiles?.listing ?? "listing",
 		product: options?.cacheProfiles?.product ?? "product",

package/src/mod.ts

@@ -20,6 +20,7 @@ import type { Secret } from "@decocms/apps-website/mod";
 import { configureVtex, type VtexConfig } from "./client";
 import manifest from "./manifest.gen";
 import { extractVtexContext, propagateISCookies, vtexCacheControl } from "./middleware";
+import { registerVtexSchemas } from "./schemas";
 
 // -------------------------------------------------------------------------
 // CMS Props (mirrors deco-cx/apps/vtex/mod.ts)
@@ -118,6 +119,10 @@ export async function configure(
 ): Promise<AppDefinition<VtexState> | null> {
 	if (!block?.account) return null;
 
+	// Real props schemas for the admin meta — must be in place before
+	// setupApps() auto-registers the __resolveType-only stubs.
+	registerVtexSchemas();
+
 	const appKey = await resolveSecret(block.appKey, "VTEX_APP_KEY");
 	const appToken = await resolveSecret(block.appToken, "VTEX_APP_TOKEN");