docusaurus-plugin-generate-schema-docs 1.2.0 → 1.3.0

package/__tests__/__snapshots__/generateEventDocs.test.js.snap

@@ -1,11 +1,11 @@
 // Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
-exports[`generateEventDocs should generate documentation correctly when no partials exist 1`] = `
+exports[`generateEventDocs (non-versioned) should generate documentation correctly 1`] = `
 "---
 title: Add to Cart Event
 description: "An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications."
 sidebar_label: Add to Cart Event
-custom_edit_url: https://github.com/test-org/test-project/edit/main/demo/static/schemas/add-to-cart-event.json
+custom_edit_url: https://github.com/test-org/test-project/edit/main/__fixtures__/static/schemas/add-to-cart-event.json
 ---
 
 import SchemaViewer from '@theme/SchemaViewer';
@@ -26,28 +26,126 @@ An add_to_cart event fires when a user adds one or more items to their shopping
 "
 `;
 
-exports[`generateEventDocs should generate documentation with top and bottom partials when they exist 1`] = `
+exports[`generateEventDocs (non-versioned) should generate documentation correctly 2`] = `
 "---
-title: Add to Cart Event
-description: "An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications."
-sidebar_label: Add to Cart Event
-custom_edit_url: https://github.com/test-org/test-project/edit/main/demo/static/schemas/add-to-cart-event.json
+title: Choice Event
+description: "An example event that uses oneOf and anyOf."
+sidebar_label: Choice Event
+custom_edit_url: https://github.com/test-org/test-project/edit/main/__fixtures__/static/schemas/choice-event.json
 ---
 
 import SchemaViewer from '@theme/SchemaViewer';
 import SchemaJsonViewer from '@theme/SchemaJsonViewer';
-import TopPartial from '@site/docs/partials/add-to-cart-event.mdx';
-import BottomPartial from '@site/docs/partials/add-to-cart-event_bottom.mdx';
 
-# Add to Cart Event
 
-An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications.
 
-<TopPartial />
+# Choice Event
+
+An example event that uses oneOf and anyOf.
+
+
+
+<SchemaViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/1.2.0/choice-event.json","title":"Choice Event","description":"An example event that uses oneOf and anyOf.","type":"object","required":["event","user_id","payment_method"],"properties":{"event":{"type":"string","const":"one_of_event"},"user_id":{"description":"The user's ID.","oneOf":[{"type":"string","title":"User ID as String","description":"The user's ID as a string.","examples":["user-123"]},{"type":"integer","title":"User ID as Integer","description":"The user's ID as an integer.","examples":[123]}]},"payment_method":{"description":"The user's payment method.","type":"object","anyOf":[{"title":"Credit Card","properties":{"payment_type":{"type":"string","enum":["credit_card","debit_card"],"examples":["credit_card"]},"card_number":{"type":"string","examples":["1234-5678-9012-3456"]},"expiry_date":{"type":"string","examples":["12/26"]}},"required":["card_number","expiry_date"]},{"title":"PayPal","type":"object","properties":{"payment_type":{"type":"string","const":"paypal"},"email":{"type":"string","format":"email","examples":["test@example.com"]}},"required":["email"]}]}}}} />
+<SchemaJsonViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/1.2.0/choice-event.json","title":"Choice Event","description":"An example event that uses oneOf and anyOf.","type":"object","properties":{"event":{"type":"string","const":"one_of_event"},"user_id":{"description":"The user's ID.","oneOf":[{"type":"string","title":"User ID as String","description":"The user's ID as a string.","examples":["user-123"]},{"type":"integer","title":"User ID as Integer","description":"The user's ID as an integer.","examples":[123]}]},"payment_method":{"description":"The user's payment method.","type":"object","anyOf":[{"title":"Credit Card","properties":{"payment_type":{"type":"string","enum":["credit_card","debit_card"],"examples":["credit_card"]},"card_number":{"type":"string","examples":["1234-5678-9012-3456"]},"expiry_date":{"type":"string","examples":["12/26"]}},"required":["card_number","expiry_date"]},{"title":"PayPal","type":"object","properties":{"payment_type":{"type":"string","const":"paypal"},"email":{"type":"string","format":"email","examples":["test@example.com"]}},"required":["email"]}]}},"required":["event","user_id","payment_method"]}} />
+
+
+"
+`;
+
+exports[`generateEventDocs (non-versioned) should generate documentation correctly 3`] = `
+"---
+title: Root AnyOf Event
+description: "An example event that has anyOf at the root level."
+sidebar_label: Root AnyOf Event
+custom_edit_url: https://github.com/test-org/test-project/edit/main/__fixtures__/static/schemas/root-any-of-event.json
+---
+
+import SchemaViewer from '@theme/SchemaViewer';
+import SchemaJsonViewer from '@theme/SchemaJsonViewer';
+
+
+
+# Root AnyOf Event
+
+An example event that has anyOf at the root level.
+
+
+
+<SchemaViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/1.2.0/root-any-of-event.json","title":"Root AnyOf Event","description":"An example event that has anyOf at the root level.","type":"object","anyOf":[{"title":"Has Param C","properties":{"param_c":{"type":"string","examples":["example_c"],"description":"This is the description for Param C."}}},{"title":"Has Param D","properties":{"param_d":{"type":"boolean","examples":[true]}}}],"properties":{"event":{"type":"string","const":"any_of_event"}}}} />
+<SchemaJsonViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/1.2.0/root-any-of-event.json","title":"Root AnyOf Event","description":"An example event that has anyOf at the root level.","type":"object","properties":{"event":{"type":"string","const":"any_of_event"}},"anyOf":[{"title":"Has Param C","properties":{"param_c":{"type":"string","examples":["example_c"],"description":"This is the description for Param C."}}},{"title":"Has Param D","properties":{"param_d":{"type":"boolean","examples":[true]}}}]}} />
+
+
+"
+`;
+
+exports[`generateEventDocs (non-versioned) should generate documentation correctly 4`] = `
+"---
+title: Root Choice Event
+description: "An example event that has oneOf at the root level."
+---
+import SchemaJsonViewer from '@theme/SchemaJsonViewer';
+
+# Root Choice Event
+
+An example event that has oneOf at the root level.
+
+Please select one of the following options:
+
+- [Option A](./option-a)
+- [Option B](./option-b)
+
+<SchemaJsonViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://example.com/root-choice-event.schema.json","title":"Root Choice Event","description":"An example event that has oneOf at the root level.","oneOf":[{"title":"Option A","type":"object","properties":{"event":{"type":"string","const":"option_a"},"param_a":{"type":"string","examples":["example_a"]}}},{"title":"Option B","type":"object","properties":{"event":{"type":"string","const":"option_b"},"param_b":{"type":"integer","examples":[123]}}}]}} />
+"
+`;
+
+exports[`generateEventDocs (non-versioned) should generate documentation correctly 5`] = `
+"---
+title: Option A
+description: "An example event that has oneOf at the root level."
+sidebar_label: Option A
+custom_edit_url: https://github.com/test-org/test-project/edit/main/__fixtures__/docs/root-choice-event/01-option-a.json
+---
+
+import SchemaViewer from '@theme/SchemaViewer';
+import SchemaJsonViewer from '@theme/SchemaJsonViewer';
+
+
+
+# Option A
+
+An example event that has oneOf at the root level.
+
+
+
+<SchemaViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://example.com/root-choice-event.schema.json#option-a","title":"Option A","description":"An example event that has oneOf at the root level.","type":"object","properties":{"event":{"type":"string","const":"option_a"},"param_a":{"type":"string","examples":["example_a"]}}}} />
+<SchemaJsonViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://example.com/root-choice-event.schema.json#option-a","title":"Option A","description":"An example event that has oneOf at the root level.","type":"object","properties":{"event":{"type":"string","const":"option_a"},"param_a":{"type":"string","examples":["example_a"]}}}} />
+
+
+"
+`;
+
+exports[`generateEventDocs (non-versioned) should generate documentation correctly 6`] = `
+"---
+title: Option B
+description: "An example event that has oneOf at the root level."
+sidebar_label: Option B
+custom_edit_url: https://github.com/test-org/test-project/edit/main/__fixtures__/docs/root-choice-event/02-option-b.json
+---
+
+import SchemaViewer from '@theme/SchemaViewer';
+import SchemaJsonViewer from '@theme/SchemaJsonViewer';
+
+
+
+# Option B
+
+An example event that has oneOf at the root level.
+
+
+
+<SchemaViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://example.com/root-choice-event.schema.json#option-b","title":"Option B","description":"An example event that has oneOf at the root level.","type":"object","properties":{"event":{"type":"string","const":"option_b"},"param_b":{"type":"integer","examples":[123]}}}} />
+<SchemaJsonViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://example.com/root-choice-event.schema.json#option-b","title":"Option B","description":"An example event that has oneOf at the root level.","type":"object","properties":{"event":{"type":"string","const":"option_b"},"param_b":{"type":"integer","examples":[123]}}}} />
 
-<SchemaViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/add-to-cart-event.json","title":"Add to Cart Event","description":"An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications.","type":"object","required":["event"],"$defs":{"strictObject":{"type":"object","propertyNames":{"maxLength":40,"pattern":"^[a-z0-9_]+$"},"additionalProperties":{"anyOf":[{"$ref":"#/allOf/0/$defs/strictObject"},{"type":"array","items":{"$ref":"#/allOf/0/$defs/strictObject"}},{"not":{"type":"object"}}]}}},"$ref":"#/allOf/0/$defs/strictObject","properties":{"event":{"type":"string","const":"add_to_cart","description":"The name of the event indicating a add_to_cart has occurred."},"ecommerce":{"type":"object","description":"Ecommerce related data for the purchase event.","required":["currency","items"],"x-gtm-clear":true,"properties":{"value":{"type":"number","description":"The monetary value of the event. Set value to the sum of (price * quantity) for all items in items.","examples":[30.03,99.99,45.5]},"currency":{"type":"string","description":"The currency of the items in ISO 4217 three-letter format. Required when value is set.","examples":["USD","EUR","GBP"]},"items":{"type":"array","description":"The products added to the cart.","minItems":1,"items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/components/product.json","title":"A Product","description":"A product object representing an item for use within a purchase event, based on Google Analytics 4 ecommerce event specifications.","type":"object","required":[],"properties":{"item_id":{"type":"string","description":"The ID of the item. Either item_id or item_name is required.","examples":["SKU_12345","PROD_98765"]},"item_name":{"type":"string","description":"The name of the item. Either item_id or item_name is required.","examples":["Stan and Friends Tee","Blue Running Shoes"]},"affiliation":{"type":"string","description":"A product affiliation to indicate a supplier or store. Note: affiliation is only available at the item level.","examples":["Google Merchandise Store","Nike Store"]},"coupon":{"type":"string","description":"The coupon name/code associated with the item. Coupon parameters at event and item levels are independent.","examples":["SUMMER_FUN","WELCOME20","SAVE10"]},"discount":{"type":"number","description":"The monetary value of the discount per unit applied to the item.","examples":[2.22,5,10.5]},"index":{"type":"number","description":"The index or position of the item in a list.","examples":[0,1,2]},"item_brand":{"type":"string","description":"The brand of the item.","examples":["Google","Nike","Adidas"]},"item_category":{"type":"string","description":"The category of the item. If used as part of a category hierarchy or taxonomy, this is the first category.","examples":["Apparel","Footwear","Electronics"]},"item_category2":{"type":"string","description":"The second category hierarchy or additional taxonomy of the item.","examples":["Adult","Women","Men"]},"item_category3":{"type":"string","description":"The third category hierarchy or additional taxonomy of the item.","examples":["Shirts","Shoes","Boots"]},"item_category4":{"type":"string","description":"The fourth category hierarchy or additional taxonomy of the item.","examples":["Crew","Running","Casual"]},"item_category5":{"type":"string","description":"The fifth category hierarchy or additional taxonomy of the item.","examples":["Short sleeve","Long distance","Lightweight"]},"item_list_id":{"type":"string","description":"The ID of the list in which the item was presented to the user. If set, item_list_id at the event level is ignored. If not set, item_list_id at the event level is used if available.","examples":["related_products","search_results","recommendations"]},"item_list_name":{"type":"string","description":"The name of the list in which the item was presented to the user. If set, item_list_name at the event level is ignored. If not set, item_list_name at the event level is used if available.","examples":["Related Products","Search Results","Recommended Items"]},"item_variant":{"type":"string","description":"The item variant or unique code or description for additional item details/options.","examples":["green","Blue Size 10","M-Black"]},"location_id":{"type":"string","description":"The physical location associated with the item, such as the location of a brick-and-mortar store. It is recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used. Note: location_id is only available at the item level.","examples":["ChIJIQBpAG2ahYAR_6128GcTUEo","store_123","location_sf"]},"price":{"type":"number","description":"The price of the item in the specified currency unit. If a discount is applied to the item, set price to the reduced per-unit price and provide the per-unit price discount in the discount parameter.","examples":[10.01,21.01,89.99]},"quantity":{"type":"number","description":"The item quantity. If not set, quantity is set to 1.","examples":[1,2,3]},"promotion_id":{"type":"string","description":"The ID of the promotion associated with the item.","examples":["P_12345","PROMO_001"]},"promotion_name":{"type":"string","description":"The name of the promotion associated with the item.","examples":["Summer Sale","Black Friday","Flash Deal"]},"creative_name":{"type":"string","description":"The name of the promotion creative.","examples":["summer_banner2","holiday_email_v1"]},"creative_slot":{"type":"string","description":"The name of the creative slot associated with the item.","examples":["featured_app_1","top_banner","sidebar"]},"google_business_vertical":{"type":"string","description":"The business vertical for the item (e.g., 'retail').","examples":["retail","ecommerce"]}}}}}},"user_data":{"type":"object","description":"User related data.","x-gtm-clear":true}}}} />
-<SchemaJsonViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/add-to-cart-event.json","title":"Add to Cart Event","description":"An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications.","type":"object","allOf":[{"$ref":"./components/dataLayer.json"}],"properties":{"event":{"type":"string","const":"add_to_cart","description":"The name of the event indicating a add_to_cart has occurred."},"ecommerce":{"type":"object","description":"Ecommerce related data for the purchase event.","properties":{"value":{"type":"number","description":"The monetary value of the event. Set value to the sum of (price * quantity) for all items in items.","examples":[30.03,99.99,45.5]},"currency":{"type":"string","description":"The currency of the items in ISO 4217 three-letter format. Required when value is set.","examples":["USD","EUR","GBP"]},"items":{"type":"array","description":"The products added to the cart.","minItems":1,"items":{"$ref":"./components/product.json"}}},"required":["currency","items"]}}}} />
 
-<BottomPartial />
 "
 `;

package/__tests__/__snapshots__/generateEventDocs.versioned.test.js.snap

@@ -0,0 +1,53 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`generateEventDocs (versioned) should generate documentation for "current" version 1`] = `
+"---
+title: Add to Cart Event
+description: "An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications."
+sidebar_label: Add to Cart Event
+custom_edit_url: https://github.com/test-org/test-project/edit/main/__fixtures_versioned__/static/schemas/next/add-to-cart-event.json
+---
+
+import SchemaViewer from '@theme/SchemaViewer';
+import SchemaJsonViewer from '@theme/SchemaJsonViewer';
+
+
+
+# Add to Cart Event
+
+An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications.
+
+
+
+<SchemaViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/add-to-cart-event.json","title":"Add to Cart Event","description":"An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications.","type":"object","required":["event"],"$defs":{"strictObject":{"type":"object","propertyNames":{"maxLength":40,"pattern":"^[a-z0-9_]+$"},"additionalProperties":{"anyOf":[{"$ref":"#/allOf/0/$defs/strictObject"},{"type":"array","items":{"$ref":"#/allOf/0/$defs/strictObject"}},{"not":{"type":"object"}}]}}},"$ref":"#/allOf/0/$defs/strictObject","properties":{"event":{"type":"string","const":"add_to_cart","description":"The name of the event indicating a add_to_cart has occurred."},"ecommerce":{"type":"object","description":"Ecommerce related data for the purchase event.","required":["currency","items"],"x-gtm-clear":true,"properties":{"value":{"type":"number","description":"The monetary value of the event. Set value to the sum of (price * quantity) for all items in items.","examples":[30.03,99.99,45.5]},"currency":{"type":"string","description":"The currency of the items in ISO 4217 three-letter format. Required when value is set.","examples":["USD","EUR","GBP"]},"items":{"type":"array","description":"The products added to the cart.","minItems":1,"items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/components/product.json","title":"A Product","description":"A product object representing an item for use within a purchase event, based on Google Analytics 4 ecommerce event specifications.","type":"object","required":[],"properties":{"item_id":{"type":"string","description":"The ID of the item. Either item_id or item_name is required.","examples":["SKU_12345","PROD_98765"]},"item_name":{"type":"string","description":"The name of the item. Either item_id or item_name is required.","examples":["Stan and Friends Tee","Blue Running Shoes"]},"affiliation":{"type":"string","description":"A product affiliation to indicate a supplier or store. Note: affiliation is only available at the item level.","examples":["Google Merchandise Store","Nike Store"]},"coupon":{"type":"string","description":"The coupon name/code associated with the item. Coupon parameters at event and item levels are independent.","examples":["SUMMER_FUN","WELCOME20","SAVE10"]},"discount":{"type":"number","description":"The monetary value of the discount per unit applied to the item.","examples":[2.22,5,10.5]},"index":{"type":"number","description":"The index or position of the item in a list.","examples":[0,1,2]},"item_brand":{"type":"string","description":"The brand of the item.","examples":["Google","Nike","Adidas"]},"item_category":{"type":"string","description":"The category of the item. If used as part of a category hierarchy or taxonomy, this is the first category.","examples":["Apparel","Footwear","Electronics"]},"item_category2":{"type":"string","description":"The second category hierarchy or additional taxonomy of the item.","examples":["Adult","Women","Men"]},"item_category3":{"type":"string","description":"The third category hierarchy or additional taxonomy of the item.","examples":["Shirts","Shoes","Boots"]},"item_category4":{"type":"string","description":"The fourth category hierarchy or additional taxonomy of the item.","examples":["Crew","Running","Casual"]},"item_category5":{"type":"string","description":"The fifth category hierarchy or additional taxonomy of the item.","examples":["Short sleeve","Long distance","Lightweight"]},"item_list_id":{"type":"string","description":"The ID of the list in which the item was presented to the user. If set, item_list_id at the event level is ignored. If not set, item_list_id at the event level is used if available.","examples":["related_products","search_results","recommendations"]},"item_list_name":{"type":"string","description":"The name of the list in which the item was presented to the user. If set, item_list_name at the event level is ignored. If not set, item_list_name at the event level is used if available.","examples":["Related Products","Search Results","Recommended Items"]},"item_variant":{"type":"string","description":"The item variant or unique code or description for additional item details/options.","examples":["green","Blue Size 10","M-Black"]},"location_id":{"type":"string","description":"The physical location associated with the item, such as the location of a brick-and-mortar store. It is recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used. Note: location_id is only available at the item level.","examples":["ChIJIQBpAG2ahYAR_6128GcTUEo","store_123","location_sf"]},"price":{"type":"number","description":"The price of the item in the specified currency unit. If a discount is applied to the item, set price to the reduced per-unit price and provide the per-unit price discount in the discount parameter.","examples":[10.01,21.01,89.99]},"quantity":{"type":"number","description":"The item quantity. If not set, quantity is set to 1.","examples":[1,2,3]},"promotion_id":{"type":"string","description":"The ID of the promotion associated with the item.","examples":["P_12345","PROMO_001"]},"promotion_name":{"type":"string","description":"The name of the promotion associated with the item.","examples":["Summer Sale","Black Friday","Flash Deal"]},"creative_name":{"type":"string","description":"The name of the promotion creative.","examples":["summer_banner2","holiday_email_v1"]},"creative_slot":{"type":"string","description":"The name of the creative slot associated with the item.","examples":["featured_app_1","top_banner","sidebar"]},"google_business_vertical":{"type":"string","description":"The business vertical for the item (e.g., 'retail').","examples":["retail","ecommerce"]}}}}}},"user_data":{"type":"object","description":"User related data.","x-gtm-clear":true}}}} />
+<SchemaJsonViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/next/add-to-cart-event.json","title":"Add to Cart Event","description":"An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications.","type":"object","allOf":[{"$ref":"./components/dataLayer.json"}],"properties":{"event":{"type":"string","const":"add_to_cart","description":"The name of the event indicating a add_to_cart has occurred."},"ecommerce":{"type":"object","description":"Ecommerce related data for the purchase event.","properties":{"value":{"type":"number","description":"The monetary value of the event. Set value to the sum of (price * quantity) for all items in items.","examples":[30.03,99.99,45.5]},"currency":{"type":"string","description":"The currency of the items in ISO 4217 three-letter format. Required when value is set.","examples":["USD","EUR","GBP"]},"items":{"type":"array","description":"The products added to the cart.","minItems":1,"items":{"$ref":"./components/product.json"}}},"required":["currency","items"]}}}} />
+
+
+"
+`;
+
+exports[`generateEventDocs (versioned) should generate documentation for a specific version 1`] = `
+"---
+title: Add to Cart Event
+description: "An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications."
+sidebar_label: Add to Cart Event
+custom_edit_url: https://github.com/test-org/test-project/edit/main/__fixtures_versioned__/static/schemas/1.1.1/add-to-cart-event.json
+---
+
+import SchemaViewer from '@theme/SchemaViewer';
+import SchemaJsonViewer from '@theme/SchemaJsonViewer';
+
+
+
+# Add to Cart Event
+
+An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications.
+
+
+
+<SchemaViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/add-to-cart-event.json","title":"Add to Cart Event","description":"An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications.","type":"object","required":["event"],"$defs":{"strictObject":{"type":"object","propertyNames":{"maxLength":40,"pattern":"^[a-z0-9_]+$"},"additionalProperties":{"anyOf":[{"$ref":"#/allOf/0/$defs/strictObject"},{"type":"array","items":{"$ref":"#/allOf/0/$defs/strictObject"}},{"not":{"type":"object"}}]}}},"$ref":"#/allOf/0/$defs/strictObject","properties":{"event":{"type":"string","const":"add_to_cart","description":"The name of the event indicating a add_to_cart has occurred."},"ecommerce":{"type":"object","description":"Ecommerce related data for the purchase event.","required":["currency","items"],"x-gtm-clear":true,"properties":{"value":{"type":"number","description":"The monetary value of the event. Set value to the sum of (price * quantity) for all items in items.","examples":[30.03,99.99,45.5]},"currency":{"type":"string","description":"The currency of the items in ISO 4217 three-letter format. Required when value is set.","examples":["USD","EUR","GBP"]},"items":{"type":"array","description":"The products added to the cart.","minItems":1,"items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/components/product.json","title":"A Product","description":"A product object representing an item for use within a purchase event, based on Google Analytics 4 ecommerce event specifications.","type":"object","required":[],"properties":{"item_id":{"type":"string","description":"The ID of the item. Either item_id or item_name is required.","examples":["SKU_12345","PROD_98765"]},"item_name":{"type":"string","description":"The name of the item. Either item_id or item_name is required.","examples":["Stan and Friends Tee","Blue Running Shoes"]},"affiliation":{"type":"string","description":"A product affiliation to indicate a supplier or store. Note: affiliation is only available at the item level.","examples":["Google Merchandise Store","Nike Store"]},"coupon":{"type":"string","description":"The coupon name/code associated with the item. Coupon parameters at event and item levels are independent.","examples":["SUMMER_FUN","WELCOME20","SAVE10"]},"discount":{"type":"number","description":"The monetary value of the discount per unit applied to the item.","examples":[2.22,5,10.5]},"index":{"type":"number","description":"The index or position of the item in a list.","examples":[0,1,2]},"item_brand":{"type":"string","description":"The brand of the item.","examples":["Google","Nike","Adidas"]},"item_category":{"type":"string","description":"The category of the item. If used as part of a category hierarchy or taxonomy, this is the first category.","examples":["Apparel","Footwear","Electronics"]},"item_category2":{"type":"string","description":"The second category hierarchy or additional taxonomy of the item.","examples":["Adult","Women","Men"]},"item_category3":{"type":"string","description":"The third category hierarchy or additional taxonomy of the item.","examples":["Shirts","Shoes","Boots"]},"item_category4":{"type":"string","description":"The fourth category hierarchy or additional taxonomy of the item.","examples":["Crew","Running","Casual"]},"item_category5":{"type":"string","description":"The fifth category hierarchy or additional taxonomy of the item.","examples":["Short sleeve","Long distance","Lightweight"]},"item_list_id":{"type":"string","description":"The ID of the list in which the item was presented to the user. If set, item_list_id at the event level is ignored. If not set, item_list_id at the event level is used if available.","examples":["related_products","search_results","recommendations"]},"item_list_name":{"type":"string","description":"The name of the list in which the item was presented to the user. If set, item_list_name at the event level is ignored. If not set, item_list_name at the event level is used if available.","examples":["Related Products","Search Results","Recommended Items"]},"item_variant":{"type":"string","description":"The item variant or unique code or description for additional item details/options.","examples":["green","Blue Size 10","M-Black"]},"location_id":{"type":"string","description":"The physical location associated with the item, such as the location of a brick-and-mortar store. It is recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used. Note: location_id is only available at the item level.","examples":["ChIJIQBpAG2ahYAR_6128GcTUEo","store_123","location_sf"]},"price":{"type":"number","description":"The price of the item in the specified currency unit. If a discount is applied to the item, set price to the reduced per-unit price and provide the per-unit price discount in the discount parameter.","examples":[10.01,21.01,89.99]},"quantity":{"type":"number","description":"The item quantity. If not set, quantity is set to 1.","examples":[1,2,3]},"promotion_id":{"type":"string","description":"The ID of the promotion associated with the item.","examples":["P_12345","PROMO_001"]},"promotion_name":{"type":"string","description":"The name of the promotion associated with the item.","examples":["Summer Sale","Black Friday","Flash Deal"]},"creative_name":{"type":"string","description":"The name of the promotion creative.","examples":["summer_banner2","holiday_email_v1"]},"creative_slot":{"type":"string","description":"The name of the creative slot associated with the item.","examples":["featured_app_1","top_banner","sidebar"]},"google_business_vertical":{"type":"string","description":"The business vertical for the item (e.g., 'retail').","examples":["retail","ecommerce"]}}}}}},"user_data":{"type":"object","description":"User related data.","x-gtm-clear":true}}}} />
+<SchemaJsonViewer schema={{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://tracking-docs-demo.buchert.digital/schemas/1.1.1/add-to-cart-event.json","title":"Add to Cart Event","description":"An add_to_cart event fires when a user adds one or more items to their shopping cart. Based on Google Analytics 4 ecommerce event specifications.","type":"object","allOf":[{"$ref":"./components/dataLayer.json"}],"properties":{"event":{"type":"string","const":"add_to_cart","description":"The name of the event indicating a add_to_cart has occurred."},"ecommerce":{"type":"object","description":"Ecommerce related data for the purchase event.","properties":{"value":{"type":"number","description":"The monetary value of the event. Set value to the sum of (price * quantity) for all items in items.","examples":[30.03,99.99,45.5]},"currency":{"type":"string","description":"The currency of the items in ISO 4217 three-letter format. Required when value is set.","examples":["USD","EUR","GBP"]},"items":{"type":"array","description":"The products added to the cart.","minItems":1,"items":{"$ref":"./components/product.json"}}},"required":["currency","items"]}}}} />
+
+
+"
+`;

package/__tests__/components/FoldableRows.test.js

@@ -0,0 +1,330 @@
+import '@testing-library/jest-dom';
+import React from 'react';
+import { render, screen, fireEvent } from '@testing-library/react';
+import FoldableRows from '../../components/FoldableRows';
+
+jest.mock('../../components/SchemaRows', () => {
+  const MockSchemaRows = (props) => (
+    // The mock needs to return a valid element to be a child of a tbody
+    // We'll use a data-testid to check for its presence.
+    <tr data-testid="schema-rows">
+      <td>{JSON.stringify(props.tableData)}</td>
+    </tr>
+  );
+  MockSchemaRows.displayName = 'MockSchemaRows';
+  return MockSchemaRows;
+});
+
+jest.mock('@theme/Heading', () => {
+  const MockHeading = ({ as: Component, children, ...props }) => (
+    <Component {...props}>{children}</Component>
+  );
+  MockHeading.displayName = 'MockHeading';
+  return MockHeading;
+});
+
+describe('FoldableRows', () => {
+  const oneOfRow = {
+    type: 'choice',
+    choiceType: 'oneOf',
+    path: ['payment'],
+    level: 1,
+    description: 'Select one payment method:',
+    options: [
+      {
+        title: 'Credit Card',
+        description: 'Pay with card',
+        rows: [{ name: 'cardNumber' }],
+      },
+      {
+        title: 'PayPal',
+        description: 'Pay with PayPal',
+        rows: [{ name: 'email' }],
+      },
+    ],
+  };
+
+  const anyOfRow = {
+    type: 'choice',
+    choiceType: 'anyOf',
+    path: ['contact'],
+    level: 1,
+    description: 'Select any contact method:',
+    options: [
+      {
+        title: 'Email',
+        description: 'Contact via email',
+        rows: [{ name: 'email_address' }],
+      },
+      {
+        title: 'Phone',
+        description: 'Contact via phone',
+        rows: [{ name: 'phone_number' }],
+      },
+    ],
+  };
+
+  it('renders oneOf as a radio-style accordion', () => {
+    render(
+      <table>
+        <tbody>
+          <FoldableRows row={oneOfRow} />
+        </tbody>
+      </table>,
+    );
+
+    const creditCardToggle = screen.getByText('Credit Card');
+    const paypalToggle = screen.getByText('PayPal');
+
+    // Initially, first option is open
+    expect(
+      screen.getByText(JSON.stringify([{ name: 'cardNumber' }])),
+    ).toBeInTheDocument();
+    expect(
+      screen.queryByText(JSON.stringify([{ name: 'email' }])),
+    ).not.toBeInTheDocument();
+
+    // Click the second option
+    fireEvent.click(paypalToggle);
+
+    // Now, second option should be open and first should be closed
+    expect(
+      screen.queryByText(JSON.stringify([{ name: 'cardNumber' }])),
+    ).not.toBeInTheDocument();
+    expect(
+      screen.getByText(JSON.stringify([{ name: 'email' }])),
+    ).toBeInTheDocument();
+  });
+
+  it('renders anyOf as a checkbox-style accordion', () => {
+    render(
+      <table>
+        <tbody>
+          <FoldableRows row={anyOfRow} />
+        </tbody>
+      </table>,
+    );
+
+    const emailToggle = screen.getByText('Email');
+    const phoneToggle = screen.getByText('Phone');
+
+    // Initially, nothing is open
+    expect(screen.queryByTestId('schema-rows')).not.toBeInTheDocument();
+
+    // Click the first option
+    fireEvent.click(emailToggle);
+    expect(
+      screen.getByText(JSON.stringify([{ name: 'email_address' }])),
+    ).toBeInTheDocument();
+    expect(
+      screen.queryByText(JSON.stringify([{ name: 'phone_number' }])),
+    ).not.toBeInTheDocument();
+
+    // Click the second option
+    fireEvent.click(phoneToggle);
+    expect(
+      screen.getByText(JSON.stringify([{ name: 'email_address' }])),
+    ).toBeInTheDocument();
+    expect(
+      screen.getByText(JSON.stringify([{ name: 'phone_number' }])),
+    ).toBeInTheDocument();
+
+    // Click the first option again to close it
+    fireEvent.click(emailToggle);
+    expect(
+      screen.queryByText(JSON.stringify([{ name: 'email_address' }])),
+    ).not.toBeInTheDocument();
+    expect(
+      screen.getByText(JSON.stringify([{ name: 'phone_number' }])),
+    ).toBeInTheDocument();
+  });
+
+  describe('hierarchical lines feature', () => {
+    it('applies padding-left based on level using rem units', () => {
+      const rowWithLevel = {
+        type: 'choice',
+        choiceType: 'oneOf',
+        path: ['nested', 'payment'],
+        level: 2,
+        description: 'Nested choice',
+        continuingLevels: [],
+        options: [
+          {
+            title: 'Option A',
+            description: 'First option',
+            rows: [{ name: 'fieldA' }],
+          },
+        ],
+      };
+
+      const { container } = render(
+        <table>
+          <tbody>
+            <FoldableRows row={rowWithLevel} />
+          </tbody>
+        </table>,
+      );
+
+      const cells = container.querySelectorAll('td[colspan="5"]');
+      // level 2: 2 * 1.25 + 0.5 = 3rem
+      cells.forEach((cell) => {
+        expect(cell.style.paddingLeft).toBe('3rem');
+      });
+    });
+
+    it('applies background-image for continuing ancestor lines', () => {
+      const rowWithContinuingLevels = {
+        type: 'choice',
+        choiceType: 'anyOf',
+        path: ['deeply', 'nested', 'choice'],
+        level: 2,
+        description: 'Choice with continuing lines',
+        continuingLevels: [0], // Ancestor at level 0 has more siblings
+        options: [
+          {
+            title: 'Option A',
+            rows: [{ name: 'fieldA' }],
+          },
+        ],
+      };
+
+      const { container } = render(
+        <table>
+          <tbody>
+            <FoldableRows row={rowWithContinuingLevels} />
+          </tbody>
+        </table>,
+      );
+
+      const cells = container.querySelectorAll('td[colspan="5"]');
+      cells.forEach((cell) => {
+        expect(cell.style.backgroundImage).toContain('linear-gradient');
+      });
+    });
+
+    it('applies background-image for immediate parent level connection', () => {
+      const rowWithParentLevel = {
+        type: 'choice',
+        choiceType: 'oneOf',
+        path: ['parent', 'choice'],
+        level: 1,
+        description: 'Choice at level 1',
+        continuingLevels: [],
+        options: [
+          {
+            title: 'Option A',
+            rows: [{ name: 'fieldA' }],
+          },
+        ],
+      };
+
+      const { container } = render(
+        <table>
+          <tbody>
+            <FoldableRows row={rowWithParentLevel} />
+          </tbody>
+        </table>,
+      );
+
+      const cells = container.querySelectorAll('td[colspan="5"]');
+      // Should have a line at parent level (level 0) position
+      cells.forEach((cell) => {
+        expect(cell.style.backgroundImage).toContain('linear-gradient');
+      });
+    });
+
+    it('has no background-image for root level choices with no continuing levels', () => {
+      const rootLevelRow = {
+        type: 'choice',
+        choiceType: 'oneOf',
+        path: ['user_id'],
+        level: 0,
+        description: 'Root level choice',
+        continuingLevels: [],
+        options: [
+          {
+            title: 'Option A',
+            rows: [{ name: 'fieldA' }],
+          },
+        ],
+      };
+
+      const { container } = render(
+        <table>
+          <tbody>
+            <FoldableRows row={rootLevelRow} />
+          </tbody>
+        </table>,
+      );
+
+      const cells = container.querySelectorAll('td[colspan="5"]');
+      cells.forEach((cell) => {
+        expect(cell.style.backgroundImage).toBe('');
+      });
+    });
+
+    it('combines multiple continuing levels in background-image', () => {
+      const rowWithMultipleLevels = {
+        type: 'choice',
+        choiceType: 'anyOf',
+        path: ['a', 'b', 'c', 'choice'],
+        level: 3,
+        description: 'Deeply nested choice',
+        continuingLevels: [0, 1], // Multiple ancestors have siblings
+        options: [
+          {
+            title: 'Option A',
+            rows: [{ name: 'fieldA' }],
+          },
+        ],
+      };
+
+      const { container } = render(
+        <table>
+          <tbody>
+            <FoldableRows row={rowWithMultipleLevels} />
+          </tbody>
+        </table>,
+      );
+
+      const cells = container.querySelectorAll('td[colspan="5"]');
+      cells.forEach((cell) => {
+        const bgImage = cell.style.backgroundImage;
+        // Should have multiple gradients (one for each continuing level + parent)
+        const gradientCount = (bgImage.match(/linear-gradient/g) || []).length;
+        expect(gradientCount).toBeGreaterThanOrEqual(2);
+      });
+    });
+
+    it('applies correct indentation for level 0', () => {
+      const levelZeroRow = {
+        type: 'choice',
+        choiceType: 'oneOf',
+        path: ['user_id'],
+        level: 0,
+        description: 'Level 0 choice',
+        continuingLevels: [],
+        options: [
+          {
+            title: 'Option A',
+            rows: [{ name: 'fieldA' }],
+          },
+        ],
+      };
+
+      const { container } = render(
+        <table>
+          <tbody>
+            <FoldableRows row={levelZeroRow} />
+          </tbody>
+        </table>,
+      );
+
+      const cells = container.querySelectorAll('td[colspan="5"]');
+      // level 0: 0 * 1.25 + 0.5 = 0.5rem
+      cells.forEach((cell) => {
+        expect(cell.style.paddingLeft).toBe('0.5rem');
+      });
+    });
+  });
+});

package/__tests__/components/PropertiesTable.test.js

@@ -3,22 +3,39 @@ import React from 'react';
 import { render } from '@testing-library/react';
 import PropertiesTable from '../../components/PropertiesTable';
 
-// Mock child components
-jest.mock('../../components/TableHeader', () => () => <thead><tr><th>Mocked TableHeader</th></tr></thead>);
-jest.mock('../../components/SchemaRows', () => () => <tr><td>Mocked SchemaRows</td></tr>);
+jest.mock('../../components/TableHeader', () => {
+  const MockTableHeader = () => (
+    <thead>
+      <tr>
+        <th>Mocked TableHeader</th>
+      </tr>
+    </thead>
+  );
+  MockTableHeader.displayName = 'MockTableHeader';
+  return MockTableHeader;
+});
+jest.mock('../../components/SchemaRows', () => {
+  const MockSchemaRows = () => (
+    <tr>
+      <td>Mocked SchemaRows</td>
+    </tr>
+  );
+  MockSchemaRows.displayName = 'MockSchemaRows';
+  return MockSchemaRows;
+});
 
 describe('PropertiesTable', () => {
-    it('renders the table with header and schema rows', () => {
-        const schema = {
-            properties: {
-                name: { type: 'string' },
-            },
-            required: ['name'],
-        };
+  it('renders the table with header and schema rows', () => {
+    const schema = {
+      properties: {
+        name: { type: 'string' },
+      },
+      required: ['name'],
+    };
 
-        const { getByText } = render(<PropertiesTable schema={schema} />);
+    const { getByText } = render(<PropertiesTable schema={schema} />);
 
-        expect(getByText('Mocked TableHeader')).toBeInTheDocument();
-        expect(getByText('Mocked SchemaRows')).toBeInTheDocument();
-    });
+    expect(getByText('Mocked TableHeader')).toBeInTheDocument();
+    expect(getByText('Mocked SchemaRows')).toBeInTheDocument();
+  });
 });