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

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

@@ -0,0 +1,53 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`generateEventDocs should generate documentation correctly when no partials exist 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
+---
+
+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/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 should generate documentation with top and bottom partials when they exist 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
+---
+
+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 />
+
+<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__/components/PropertiesTable.test.js

@@ -0,0 +1,24 @@
+import '@testing-library/jest-dom';
+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>);
+
+describe('PropertiesTable', () => {
+    it('renders the table with header and schema rows', () => {
+        const schema = {
+            properties: {
+                name: { type: 'string' },
+            },
+            required: ['name'],
+        };
+
+        const { getByText } = render(<PropertiesTable schema={schema} />);
+
+        expect(getByText('Mocked TableHeader')).toBeInTheDocument();
+        expect(getByText('Mocked SchemaRows')).toBeInTheDocument();
+    });
+});

package/__tests__/components/PropertyRow.test.js

@@ -0,0 +1,67 @@
+import '@testing-library/jest-dom';
+import React from 'react';
+import { render } from '@testing-library/react';
+import PropertyRow from '../../components/PropertyRow';
+
+describe('PropertyRow', () => {
+    const getConstraints = (prop, isReq) => {
+        const constraints = [];
+        if (isReq) constraints.push('required');
+        if (prop.minLength) constraints.push(`minLength: ${prop.minLength}`);
+        if (prop.maxLength) constraints.push(`maxLength: ${prop.maxLength}`);
+        return constraints;
+    };
+
+    it('renders a basic property', () => {
+        const prop = { type: 'string', description: 'The name of the user.' };
+        const { getByText } = render(
+            <table>
+                <tbody>
+                    <PropertyRow propertyKey="name" prop={prop} requiredList={[]} getConstraints={getConstraints} />
+                </tbody>
+            </table>
+        );
+        expect(getByText('name')).toBeInTheDocument();
+        expect(getByText('string')).toBeInTheDocument();
+        expect(getByText('The name of the user.')).toBeInTheDocument();
+    });
+
+    it('marks required properties', () => {
+        const prop = { type: 'string' };
+        const { container } = render(
+            <table>
+                <tbody>
+                    <PropertyRow propertyKey="name" prop={prop} requiredList={['name']} getConstraints={getConstraints} />
+                </tbody>
+            </table>
+        );
+        expect(container.querySelector('.required-row')).toBeInTheDocument();
+        expect(container.querySelector('.required')).toBeInTheDocument();
+    });
+
+    it('renders multiple constraints', () => {
+        const prop = { type: 'string', minLength: 1, maxLength: 10 };
+        const { getByText } = render(
+            <table>
+                <tbody>
+                    <PropertyRow propertyKey="name" prop={prop} requiredList={['name']} getConstraints={getConstraints} />
+                </tbody>
+            </table>
+        );
+        expect(getByText('required')).toBeInTheDocument();
+        expect(getByText('minLength: 1')).toBeInTheDocument();
+        expect(getByText('maxLength: 10')).toBeInTheDocument();
+    });
+
+    it('formats examples', () => {
+        const prop = { type: 'string', examples: ['foo', 'bar'] };
+        const { getByText } = render(
+            <table>
+                <tbody>
+                    <PropertyRow propertyKey="name" prop={prop} requiredList={[]} getConstraints={getConstraints} />
+                </tbody>
+            </table>
+        );
+        expect(getByText('foo, bar')).toBeInTheDocument();
+    });
+});

package/__tests__/components/SchemaJsonViewer.test.js

@@ -0,0 +1,32 @@
+import '@testing-library/jest-dom';
+import React from 'react';
+import { render } from '@testing-library/react';
+import SchemaJsonViewer from '../../components/SchemaJsonViewer';
+
+// Mock CodeBlock as it's an external theme component
+jest.mock('@theme/CodeBlock', () => {
+    return function DummyCodeBlock({ children, language }) {
+        return <pre data-language={language}>{children}</pre>;
+    };
+});
+
+describe('SchemaJsonViewer', () => {
+    it('renders the schema in a CodeBlock', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                name: { type: 'string' },
+            },
+        };
+
+        const { getByText, container } = render(<SchemaJsonViewer schema={schema} />);
+
+        expect(getByText('View Raw JSON Schema')).toBeInTheDocument();
+        const detailsElement = container.querySelector('details');
+        expect(detailsElement).toHaveClass('schema-json-viewer');
+        const codeBlockElement = container.querySelector('pre');
+        expect(codeBlockElement).toBeInTheDocument();
+        expect(codeBlockElement).toHaveAttribute('data-language', 'json');
+        expect(codeBlockElement.textContent).toEqual(JSON.stringify(schema, null, 2));
+    });
+});

package/__tests__/components/SchemaRows.test.js

@@ -0,0 +1,80 @@
+import '@testing-library/jest-dom';
+import React from 'react';
+import { render } from '@testing-library/react';
+import SchemaRows from '../../components/SchemaRows';
+
+// Mock child components
+jest.mock('../../components/PropertyRow', () => (props) => <tr><td>Mocked PropertyRow: {props.propertyKey}</td></tr>);
+jest.mock('../../components/TableHeader', () => () => <thead><tr><th>Mocked TableHeader</th></tr></thead>);
+
+describe('SchemaRows', () => {
+    it('renders a PropertyRow for each property', () => {
+        const properties = {
+            name: { type: 'string' },
+            age: { type: 'integer' },
+        };
+        const { getByText } = render(
+            <table>
+                <tbody>
+                    <SchemaRows properties={properties} getConstraints={() => []} />
+                </tbody>
+            </table>
+        );
+
+        expect(getByText('Mocked PropertyRow: name')).toBeInTheDocument();
+        expect(getByText('Mocked PropertyRow: age')).toBeInTheDocument();
+    });
+
+    it('recursively renders for nested objects', () => {
+        const properties = {
+            user: {
+                type: 'object',
+                properties: {
+                    name: { type: 'string' },
+                },
+            },
+        };
+        const { getByText } = render(
+            <table>
+                <tbody>
+                    <SchemaRows properties={properties} getConstraints={() => []} />
+                </tbody>
+            </table>
+        );
+
+        expect(getByText('Mocked PropertyRow: user')).toBeInTheDocument();
+        expect(getByText('Mocked TableHeader')).toBeInTheDocument();
+        expect(getByText('user { }')).toBeInTheDocument();
+        // This will be inside the nested table
+        expect(getByText('Mocked PropertyRow: name')).toBeInTheDocument();
+    });
+
+    it('recursively renders for nested arrays of objects', () => {
+        const properties = {
+            products: {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    properties: {
+                        name: { type: 'string' },
+                        price: { type: 'number' },
+                    },
+                },
+            },
+        };
+        const { getByText } = render(
+            <table>
+                <tbody>
+                    <SchemaRows properties={properties} getConstraints={() => []} />
+                </tbody>
+            </table>
+        );
+
+        expect(getByText('Mocked PropertyRow: products')).toBeInTheDocument();
+        expect(getByText('Mocked TableHeader')).toBeInTheDocument();
+        expect(getByText('products [ ]')).toBeInTheDocument();
+        // These will be inside the nested table
+        expect(getByText('Mocked PropertyRow: name')).toBeInTheDocument();
+        expect(getByText('Mocked PropertyRow: price')).toBeInTheDocument();
+    });
+});

package/__tests__/components/SchemaViewer.test.js

@@ -0,0 +1,27 @@
+import '@testing-library/jest-dom';
+import React from 'react';
+import { render } from '@testing-library/react';
+import SchemaViewer from '../../components/SchemaViewer';
+
+// Mock child components
+
+jest.mock('../../components/ExampleDataLayer', () => () => <div>Mocked ExampleDataLayer</div>);
+jest.mock('../../components/PropertiesTable', () => () => <div>Mocked PropertiesTable</div>);
+
+describe('SchemaViewer', () => {
+    it('renders the schema viewer with all child components', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                name: { type: 'string' },
+            },
+        };
+
+        const { getByText } = render(<SchemaViewer schema={schema} />);
+
+        expect(getByText('DataLayer Example')).toBeInTheDocument();
+        expect(getByText('Mocked ExampleDataLayer')).toBeInTheDocument();
+        expect(getByText('Event Properties')).toBeInTheDocument();
+        expect(getByText('Mocked PropertiesTable')).toBeInTheDocument();
+    });
+});

package/__tests__/components/TableHeader.test.js

@@ -0,0 +1,20 @@
+import '@testing-library/jest-dom';
+import React from 'react';
+import { render } from '@testing-library/react';
+import TableHeader from '../../components/TableHeader';
+
+describe('TableHeader', () => {
+    it('renders the table header with correct columns', () => {
+        const { getByText } = render(
+            <table>
+                <TableHeader />
+            </table>
+        );
+
+        expect(getByText('Property')).toBeInTheDocument();
+        expect(getByText('Type')).toBeInTheDocument();
+        expect(getByText('Constraints')).toBeInTheDocument();
+        expect(getByText('Examples')).toBeInTheDocument();
+        expect(getByText('Description')).toBeInTheDocument();
+    });
+});

package/__tests__/generateEventDocs.test.js

@@ -0,0 +1,84 @@
+/**
+ * @jest-environment node
+ */
+
+import generateEventDocs from '../generateEventDocs';
+import fs from 'fs';
+import path from 'path';
+
+jest.mock('fs', () => {
+    const originalFs = jest.requireActual('fs');
+    return {
+        ...originalFs,
+        writeFileSync: jest.fn(),
+        mkdirSync: jest.fn(),
+        existsSync: jest.fn(),
+        readdirSync: originalFs.readdirSync,
+        readFileSync: originalFs.readFileSync,
+    };
+});
+
+describe('generateEventDocs', () => {
+
+    const options = {
+        organizationName: 'test-org',
+        projectName: 'test-project',
+        // Use the fixtures directory as the siteDir for tests
+        siteDir: path.resolve(__dirname, '__fixtures__')
+    }
+    const outputDir = path.join(options.siteDir, 'docs/events');
+    const partialsDir = path.join(options.siteDir, 'docs/partials');
+
+
+    beforeEach(() => {
+        // Clear all instances and calls to constructor and all methods:
+        fs.writeFileSync.mockClear();
+        fs.mkdirSync.mockClear();
+        fs.existsSync.mockClear();
+    });
+
+    it('should generate documentation correctly when no partials exist', async () => {
+        console.log = jest.fn(); // suppress console.log
+
+        // Simulate that no partials exist
+        fs.existsSync.mockReturnValue(false);
+
+        await generateEventDocs(options);
+
+        // Expect writeFileSync to have been called once for each schema
+        expect(fs.writeFileSync).toHaveBeenCalledTimes(1);
+
+        // Check the content of the generated file
+        const [filePath, content] = fs.writeFileSync.mock.calls[0];
+        expect(filePath).toBe(path.join(outputDir, 'add-to-cart-event.mdx'));
+        expect(content).toMatchSnapshot();
+    });
+
+    it('should generate documentation with top and bottom partials when they exist', async () => {
+        console.log = jest.fn(); // suppress console.log
+
+        // Simulate that the output directory and partials exist
+        fs.existsSync.mockImplementation((filePath) => {
+            if (filePath === outputDir) {
+                return true;
+            }
+            if (filePath === path.join(partialsDir, 'add-to-cart-event.mdx')) {
+                return true;
+            }
+            if (filePath === path.join(partialsDir, 'add-to-cart-event_bottom.mdx')) {
+                return true;
+            }
+            return false;
+        });
+
+        await generateEventDocs(options);
+
+        // Expect writeFileSync to have been called once for each schema
+        expect(fs.writeFileSync).toHaveBeenCalledTimes(1);
+
+        // Check the content of the generated file
+        const [filePath, content] = fs.writeFileSync.mock.calls[0];
+        expect(filePath).toBe(path.join(outputDir, 'add-to-cart-event.mdx'));
+        expect(content).toMatchSnapshot();
+    });
+});

package/__tests__/helpers/buildExampleFromSchema.test.js

@@ -0,0 +1,188 @@
+import buildExampleFromSchema from '../../helpers/buildExampleFromSchema.js';
+
+describe('buildExampleFromSchema', () => {
+    it('should build a basic example from a schema', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                name: { type: 'string' },
+                age: { type: 'integer' },
+                isStudent: { type: 'boolean' },
+            },
+        };
+
+        const example = buildExampleFromSchema(schema);
+
+        expect(example).toEqual({
+            name: '',
+            age: 0,
+            isStudent: false,
+        });
+    });
+
+    it('should handle nested objects and arrays', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'object',
+                    properties: {
+                        name: { type: 'string' },
+                    },
+                },
+                posts: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            title: { type: 'string' },
+                            tags: {
+                                type: 'array',
+                                items: { type: 'string' },
+                            },
+                        },
+                    },
+                },
+            },
+        };
+
+        const example = buildExampleFromSchema(schema);
+
+        expect(example).toEqual({
+            user: {
+                name: '',
+            },
+            posts: [
+                {
+                    title: '',
+                    tags: [''],
+                },
+            ],
+        });
+    });
+
+    it('should use examples, const, and default values', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                name: {
+                    type: 'string',
+                    examples: ['John Doe'],
+                },
+                role: {
+                    type: 'string',
+                    const: 'admin',
+                },
+                level: {
+                    type: 'integer',
+                    default: 1,
+                },
+            },
+        };
+
+        const example = buildExampleFromSchema(schema);
+
+        expect(example).toEqual({
+            name: 'John Doe',
+            role: 'admin',
+            level: 1,
+        });
+    });
+
+    it('should build a complex example', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                event: {
+                    type: 'string',
+                    examples: ['purchase'],
+                },
+                ecommerce: {
+                    type: 'object',
+                    properties: {
+                        transaction_id: {
+                            type: 'string',
+                            examples: ['T_12345'],
+                        },
+                        value: {
+                            type: 'number',
+                            default: 10.0,
+                        },
+                        items: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    item_id: { type: 'string', examples: ['SKU_123'] },
+                                    item_name: { type: 'string', examples: ['Stan Smith Shoes'] },
+                                    price: { type: 'number' },
+                                    quantity: { type: 'integer', default: 1 },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        };
+
+        const example = buildExampleFromSchema(schema);
+
+        expect(example).toEqual({
+            event: 'purchase',
+            ecommerce: {
+                transaction_id: 'T_12345',
+                value: 10.0,
+                items: [
+                    {
+                        item_id: 'SKU_123',
+                        item_name: 'Stan Smith Shoes',
+                        price: 0,
+                        quantity: 1,
+                    },
+                ],
+            },
+        });
+    });
+    it('should not include empty objects for properties with no defined value', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                event: { type: 'string', examples: ['test_event'] },
+                user_data: {
+                    type: 'object'
+                },
+                ecommerce: {
+                    type: 'object',
+                    properties: {
+                        items: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    item_id: { type: 'string', examples: ['SKU_123'] }
+                                }
+                            }
+                        }
+                    }
+                },
+                empty_object: {
+                    type: 'object',
+                    properties: {}
+                }
+            }
+        };
+
+        const example = buildExampleFromSchema(schema);
+
+        expect(example).toEqual({
+            event: 'test_event',
+            ecommerce: {
+                items: [
+                    {
+                        item_id: 'SKU_123',
+                    },
+                ],
+            },
+        });
+    });
+});