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

package/__tests__/__fixtures_versioned__/static/schemas/1.1.1/add-to-cart-event.json

@@ -0,0 +1,44 @@
+{
+  "$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"]
+    }
+  }
+}

package/__tests__/__fixtures_versioned__/static/schemas/1.1.1/components/dataLayer.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://tracking-docs-demo.buchert.digital/schemas/components/dataLayer.json",
+  "title": "dataLayer",
+  "description": "Schema for the object structure pushed to the dataLayer.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "#/$defs/strictObject"
+    }
+  ],
+  "properties": {
+    "event": {
+      "type": "string",
+      "description": "The name of the event."
+    },
+    "ecommerce": {
+      "type": "object",
+      "description": "Ecommerce related data.",
+      "x-gtm-clear": true
+    },
+    "user_data": {
+      "type": "object",
+      "description": "User related data.",
+      "x-gtm-clear": true
+    }
+  },
+  "required": ["event"],
+  "$defs": {
+    "strictObject": {
+      "type": "object",
+      "propertyNames": {
+        "maxLength": 40,
+        "pattern": "^[a-z0-9_]+$"
+      },
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/strictObject"
+          },
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/strictObject"
+            }
+          },
+          {
+            "not": {
+              "type": "object"
+            }
+          }
+        ]
+      }
+    }
+  }
+}

package/__tests__/__fixtures_versioned__/static/schemas/1.1.1/components/product.json

@@ -0,0 +1,125 @@
+{
+  "$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",
+  "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.0, 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"]
+    }
+  },
+  "required": []
+}

package/__tests__/__fixtures_versioned__/static/schemas/next/add-to-cart-event.json

@@ -0,0 +1,44 @@
+{
+  "$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"]
+    }
+  }
+}

package/__tests__/__fixtures_versioned__/static/schemas/next/components/dataLayer.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://tracking-docs-demo.buchert.digital/schemas/components/dataLayer.json",
+  "title": "dataLayer",
+  "description": "Schema for the object structure pushed to the dataLayer.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "#/$defs/strictObject"
+    }
+  ],
+  "properties": {
+    "event": {
+      "type": "string",
+      "description": "The name of the event."
+    },
+    "ecommerce": {
+      "type": "object",
+      "description": "Ecommerce related data.",
+      "x-gtm-clear": true
+    },
+    "user_data": {
+      "type": "object",
+      "description": "User related data.",
+      "x-gtm-clear": true
+    }
+  },
+  "required": ["event"],
+  "$defs": {
+    "strictObject": {
+      "type": "object",
+      "propertyNames": {
+        "maxLength": 40,
+        "pattern": "^[a-z0-9_]+$"
+      },
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/strictObject"
+          },
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/strictObject"
+            }
+          },
+          {
+            "not": {
+              "type": "object"
+            }
+          }
+        ]
+      }
+    }
+  }
+}

package/__tests__/__fixtures_versioned__/static/schemas/next/components/product.json

@@ -0,0 +1,125 @@
+{
+  "$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",
+  "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.0, 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"]
+    }
+  },
+  "required": []
+}

package/__tests__/__fixtures_versioned__/versions.json

@@ -0,0 +1 @@
+["1.1.1"]

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

@@ -0,0 +1,117 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`ExampleDataLayer should render a single example for a simple schema 1`] = `
+<div>
+  <pre
+    data-language="javascript"
+  >
+    window.dataLayer.push({
+  "event": "test_event"
+});
+  </pre>
+</div>
+`;
+
+exports[`ExampleDataLayer should render grouped tabs for a schema with choices 1`] = `
+<div>
+  <div
+    style="margin-top: 20px;"
+  >
+    <h4>
+      <code>
+        user_id
+      </code>
+       options:
+    </h4>
+    <div
+      data-testid="tabs"
+    >
+      <div
+        data-label="User ID as String"
+        data-testid="tab-item"
+      >
+        <pre
+          data-language="javascript"
+        >
+          window.dataLayer.push({
+  "event": "one_of_event",
+  "user_id": "user-123",
+  "payment_method": {
+    "payment_type": "credit_card",
+    "card_number": "1234-5678-9012-3456",
+    "expiry_date": "12/26"
+  }
+});
+        </pre>
+      </div>
+      <div
+        data-label="User ID as Integer"
+        data-testid="tab-item"
+      >
+        <pre
+          data-language="javascript"
+        >
+          window.dataLayer.push({
+  "event": "one_of_event",
+  "user_id": 123,
+  "payment_method": {
+    "payment_type": "credit_card",
+    "card_number": "1234-5678-9012-3456",
+    "expiry_date": "12/26"
+  }
+});
+        </pre>
+      </div>
+    </div>
+  </div>
+  <div
+    style="margin-top: 20px;"
+  >
+    <h4>
+      <code>
+        payment_method
+      </code>
+       options:
+    </h4>
+    <div
+      data-testid="tabs"
+    >
+      <div
+        data-label="Credit Card"
+        data-testid="tab-item"
+      >
+        <pre
+          data-language="javascript"
+        >
+          window.dataLayer.push({
+  "event": "one_of_event",
+  "user_id": "user-123",
+  "payment_method": {
+    "payment_type": "credit_card",
+    "card_number": "1234-5678-9012-3456",
+    "expiry_date": "12/26"
+  }
+});
+        </pre>
+      </div>
+      <div
+        data-label="PayPal"
+        data-testid="tab-item"
+      >
+        <pre
+          data-language="javascript"
+        >
+          window.dataLayer.push({
+  "event": "one_of_event",
+  "user_id": "user-123",
+  "payment_method": {
+    "payment_type": "paypal",
+    "email": "test@example.com"
+  }
+});
+        </pre>
+      </div>
+    </div>
+  </div>
+</div>
+`;

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

@@ -0,0 +1,79 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`generateEventDocs (oneOf with $anchor) should generate documentation using $anchor for slug 1`] = `
+"---
+title: Parent Event Anchor
+description: "This is a parent event with oneOf."
+---
+import SchemaJsonViewer from '@theme/SchemaJsonViewer';
+
+# Parent Event Anchor
+
+This is a parent event with oneOf.
+
+Please select one of the following options:
+
+- [Child Event Anchor](./child-event-with-anchor)
+- [Child Event Title](./child-event-title)
+
+<SchemaJsonViewer schema={{"$id":"https://example.com/parent-event-anchor.json","title":"Parent Event Anchor","description":"This is a parent event with oneOf.","type":"object","oneOf":[{"title":"Child Event Anchor","description":"This is a child event with an anchor.","$anchor":"child-event-with-anchor","type":"object","properties":{"property_a":{"type":"string"}}},{"title":"Child Event Title","description":"This is a child event with only a title.","type":"object","properties":{"property_b":{"type":"string"}}}]}} />
+"
+`;
+
+exports[`generateEventDocs (oneOf with $anchor) should generate documentation using $anchor for slug 2`] = `
+"---
+title: Child Event Anchor
+description: "This is a child event with an anchor."
+sidebar_label: Child Event Anchor
+custom_edit_url: https://github.com/test-org/test-project/edit/main/__fixtures_anchor__/docs/parent-event-anchor/01-child-event-with-anchor.json
+---
+
+import SchemaViewer from '@theme/SchemaViewer';
+import SchemaJsonViewer from '@theme/SchemaJsonViewer';
+
+
+
+# Child Event Anchor
+
+This is a child event with an anchor.
+
+
+
+<SchemaViewer
+  schema={{"$id":"https://example.com/parent-event-anchor.json#child-event-with-anchor","title":"Child Event Anchor","description":"This is a child event with an anchor.","type":"object","$anchor":"child-event-with-anchor","properties":{"property_a":{"type":"string"}}}}
+  
+/>
+<SchemaJsonViewer schema={{"$id":"https://example.com/parent-event-anchor.json#child-event-with-anchor","title":"Child Event Anchor","description":"This is a child event with an anchor.","type":"object","$anchor":"child-event-with-anchor","properties":{"property_a":{"type":"string"}}}} />
+
+
+"
+`;
+
+exports[`generateEventDocs (oneOf with $anchor) should generate documentation using $anchor for slug 3`] = `
+"---
+title: Child Event Title
+description: "This is a child event with only a title."
+sidebar_label: Child Event Title
+custom_edit_url: https://github.com/test-org/test-project/edit/main/__fixtures_anchor__/docs/parent-event-anchor/02-child-event-title.json
+---
+
+import SchemaViewer from '@theme/SchemaViewer';
+import SchemaJsonViewer from '@theme/SchemaJsonViewer';
+
+
+
+# Child Event Title
+
+This is a child event with only a title.
+
+
+
+<SchemaViewer
+  schema={{"$id":"https://example.com/parent-event-anchor.json#child-event-title","title":"Child Event Title","description":"This is a child event with only a title.","type":"object","properties":{"property_b":{"type":"string"}}}}
+  
+/>
+<SchemaJsonViewer schema={{"$id":"https://example.com/parent-event-anchor.json#child-event-title","title":"Child Event Title","description":"This is a child event with only a title.","type":"object","properties":{"property_b":{"type":"string"}}}} />
+
+
+"
+`;