@config-bound/schema-export 0.1.0

package/dist/schemaFormatters.spec.js

@@ -0,0 +1,161 @@
+import { formatAsJSON, formatAsYAML, formatAsEnvExample } from './schemaFormatters.js';
+describe('Schema Formatters', () => {
+    const mockSchema = {
+        name: 'testApp',
+        sections: [
+            {
+                name: 'app',
+                description: 'Application settings',
+                elements: [
+                    {
+                        name: 'port',
+                        description: 'Server port',
+                        type: 'number',
+                        default: 3000,
+                        example: 8080,
+                        required: false,
+                        sensitive: false,
+                        joiValidation: {
+                            type: 'number',
+                            rules: [
+                                { name: 'min', args: { limit: 1 } },
+                                { name: 'max', args: { limit: 65535 } }
+                            ]
+                        }
+                    },
+                    {
+                        name: 'apiKey',
+                        description: 'API key',
+                        type: 'string',
+                        default: undefined,
+                        example: 'sk_test_123',
+                        required: true,
+                        sensitive: true,
+                        joiValidation: { type: 'string', flags: { presence: 'required' } }
+                    }
+                ]
+            },
+            {
+                name: 'database',
+                description: 'Database configuration',
+                elements: [
+                    {
+                        name: 'host',
+                        description: 'Database host',
+                        type: 'string',
+                        default: 'localhost',
+                        example: undefined,
+                        required: false,
+                        sensitive: false,
+                        joiValidation: { type: 'string' }
+                    }
+                ]
+            }
+        ]
+    };
+    describe('formatAsJSON', () => {
+        it('should format schema as pretty JSON', () => {
+            const result = formatAsJSON(mockSchema, true);
+            expect(result).toContain('"name": "testApp"');
+            expect(result).toContain('"port"');
+            expect(result).toContain('"database"');
+            expect(JSON.parse(result)).toEqual(mockSchema);
+        });
+        it('should format schema as compact JSON', () => {
+            const result = formatAsJSON(mockSchema, false);
+            expect(result).not.toContain('\n');
+            expect(JSON.parse(result)).toEqual(mockSchema);
+        });
+    });
+    describe('formatAsYAML', () => {
+        it('should format schema as YAML', () => {
+            const result = formatAsYAML(mockSchema);
+            expect(result).toContain('name: testApp');
+            expect(result).toContain('- name: port');
+            expect(result).toContain('- name: database');
+            expect(result).toBeTruthy();
+        });
+    });
+    describe('formatAsEnvExample', () => {
+        it('should format schema as .env.example without prefix', () => {
+            const result = formatAsEnvExample(mockSchema);
+            expect(result).toContain('# testApp Configuration');
+            expect(result).toContain('# Generated from schema export');
+            expect(result).toContain('APP_PORT=');
+            expect(result).toContain('APP_APIKEY=');
+            expect(result).toContain('DATABASE_HOST=');
+            expect(result).toContain('# Server port');
+            expect(result).toContain('# API key');
+            expect(result).toContain('# Database host');
+        });
+        it('should format schema as .env.example with prefix', () => {
+            const result = formatAsEnvExample(mockSchema, 'MYAPP');
+            expect(result).toContain('MYAPP_APP_PORT=');
+            expect(result).toContain('MYAPP_APP_APIKEY=');
+            expect(result).toContain('MYAPP_DATABASE_HOST=');
+        });
+        it('should include example values when available', () => {
+            const result = formatAsEnvExample(mockSchema);
+            expect(result).toContain('APP_PORT=8080');
+        });
+        it('should include default values when example is not available', () => {
+            const result = formatAsEnvExample(mockSchema);
+            expect(result).toContain('DATABASE_HOST=localhost');
+        });
+        it('should use placeholder for sensitive values', () => {
+            const result = formatAsEnvExample(mockSchema);
+            expect(result).toContain('APP_APIKEY=your-example-value');
+        });
+        it('should mark required fields', () => {
+            const result = formatAsEnvExample(mockSchema);
+            expect(result).toContain('# API key (required)');
+        });
+        it('should handle sections without descriptions', () => {
+            const schemaWithoutDesc = {
+                name: 'test',
+                sections: [
+                    {
+                        name: 'app',
+                        elements: [
+                            {
+                                name: 'port',
+                                type: 'number',
+                                default: 3000,
+                                required: false,
+                                sensitive: false,
+                                joiValidation: {}
+                            }
+                        ]
+                    }
+                ]
+            };
+            const result = formatAsEnvExample(schemaWithoutDesc);
+            expect(result).toContain('APP_PORT=3000');
+        });
+        it('should handle elements without descriptions', () => {
+            const schemaWithoutElementDesc = {
+                name: 'test',
+                sections: [
+                    {
+                        name: 'app',
+                        description: 'App config',
+                        elements: [
+                            {
+                                name: 'port',
+                                type: 'number',
+                                default: 3000,
+                                required: false,
+                                sensitive: false,
+                                joiValidation: {}
+                            }
+                        ]
+                    }
+                ]
+            };
+            const result = formatAsEnvExample(schemaWithoutElementDesc);
+            expect(result).toContain('# App config');
+            expect(result).toContain('APP_PORT=3000');
+        });
+    });
+});
+//# sourceMappingURL=schemaFormatters.spec.js.map

package/dist/schemaFormatters.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaFormatters.spec.js","sourceRoot":"","sources":["../src/schemaFormatters.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,kBAAkB,EACnB,MAAM,uBAAuB,CAAC;AAG/B,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,MAAM,UAAU,GAAmB;QACjC,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,KAAK;gBACX,WAAW,EAAE,sBAAsB;gBACnC,QAAQ,EAAE;oBACR;wBACE,IAAI,EAAE,MAAM;wBACZ,WAAW,EAAE,aAAa;wBAC1B,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,IAAI;wBACb,OAAO,EAAE,IAAI;wBACb,QAAQ,EAAE,KAAK;wBACf,SAAS,EAAE,KAAK;wBAChB,aAAa,EAAE;4BACb,IAAI,EAAE,QAAQ;4BACd,KAAK,EAAE;gCACL,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;gCACnC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;6BACxC;yBACF;qBACF;oBACD;wBACE,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,SAAS;wBACtB,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,SAAS;wBAClB,OAAO,EAAE,aAAa;wBACtB,QAAQ,EAAE,IAAI;wBACd,SAAS,EAAE,IAAI;wBACf,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE;qBACnE;iBACF;aACF;YACD;gBACE,IAAI,EAAE,UAAU;gBAChB,WAAW,EAAE,wBAAwB;gBACrC,QAAQ,EAAE;oBACR;wBACE,IAAI,EAAE,MAAM;wBACZ,WAAW,EAAE,eAAe;wBAC5B,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,WAAW;wBACpB,OAAO,EAAE,SAAS;wBAClB,QAAQ,EAAE,KAAK;wBACf,SAAS,EAAE,KAAK;wBAChB,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBAClC;iBACF;aACF;SACF;KACF,CAAC;IAEF,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAC7C,MAAM,MAAM,GAAG,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAE9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;YAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,MAAM,MAAM,GAAG,YAAY,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,MAAM,MAAM,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;YAExC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,MAAM,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAE9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;YACpD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;YAC3D,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,MAAM,GAAG,kBAAkB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAEvD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;YAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,MAAM,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAE9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,MAAM,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAE9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,MAAM,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAE9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,MAAM,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAE9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,iBAAiB,GAAmB;gBACxC,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE;oBACR;wBACE,IAAI,EAAE,KAAK;wBACX,QAAQ,EAAE;4BACR;gCACE,IAAI,EAAE,MAAM;gCACZ,IAAI,EAAE,QAAQ;gCACd,OAAO,EAAE,IAAI;gCACb,QAAQ,EAAE,KAAK;gCACf,SAAS,EAAE,KAAK;gCAChB,aAAa,EAAE,EAAE;6BAClB;yBACF;qBACF;iBACF;aACF,CAAC;YAEF,MAAM,MAAM,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,wBAAwB,GAAmB;gBAC/C,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE;oBACR;wBACE,IAAI,EAAE,KAAK;wBACX,WAAW,EAAE,YAAY;wBACzB,QAAQ,EAAE;4BACR;gCACE,IAAI,EAAE,MAAM;gCACZ,IAAI,EAAE,QAAQ;gCACd,OAAO,EAAE,IAAI;gCACb,QAAQ,EAAE,KAAK;gCACf,SAAS,EAAE,KAAK;gCAChB,aAAa,EAAE,EAAE;6BAClB;yBACF;qBACF;iBACF;aACF,CAAC;YAEF,MAAM,MAAM,GAAG,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;YAC5D,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/eslint.config.mjs

@@ -0,0 +1,3 @@
+import configBoundConfig from '@config-bound/eslint-config/package.eslint.mjs';
+
+export default configBoundConfig;

package/jest.config.js

@@ -0,0 +1,26 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+export default {
+  testEnvironment: 'node',
+  rootDir: './src',
+  testMatch: ['**/*.spec.ts'],
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1'
+  },
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+        tsconfig: {
+          isolatedModules: false
+        },
+        diagnostics: {
+          ignoreCodes: [151002]
+        }
+      }
+    ]
+  }
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@config-bound/schema-export",
+  "version": "0.1.0",
+  "description": "Schema export utilities for ConfigBound configuration library",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "test": "jest",
+    "lint": "eslint src/**/*.ts --fix",
+    "lint:ci": "eslint src/**/*.ts",
+    "format": "prettier --write --config ../../.config/.prettierrc --ignore-path ../../.config/.prettierignore src/**/*.ts",
+    "format:ci": "prettier --check --config ../../.config/.prettierrc --ignore-path ../../.config/.prettierignore src/**/*.ts"
+  },
+  "keywords": [
+    "config",
+    "configuration",
+    "schema",
+    "export",
+    "json",
+    "yaml",
+    "documentation"
+  ],
+  "author": "Robert Keyser",
+  "license": "MIT",
+  "dependencies": {
+    "@config-bound/config-bound": "0.1.0",
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@config-bound/eslint-config": "*",
+    "@types/jest": "^30.0.0",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^24.10.0",
+    "eslint": "^9.39.1",
+    "jest": "^30.2.0",
+    "rimraf": "^6.1.0",
+    "ts-jest": "^29.4.5",
+    "typescript": "^5.9.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/notr-ai/ConfigBound"
+  }
+}

package/src/index.ts

@@ -0,0 +1,14 @@
+export {
+  exportElement,
+  exportSection,
+  exportSchema,
+  type ExportedElement,
+  type ExportedSection,
+  type ExportedSchema
+} from './schemaExporter.js';
+
+export {
+  formatAsJSON,
+  formatAsYAML,
+  formatAsEnvExample
+} from './schemaFormatters.js';

package/src/schemaExporter.spec.ts

@@ -0,0 +1,286 @@
+import { Section } from '@config-bound/config-bound/section';
+import { Element } from '@config-bound/config-bound/element';
+import Joi from 'joi';
+import {
+  exportElement,
+  exportSection,
+  exportSchema
+} from './schemaExporter.js';
+
+describe('Schema Exporter', () => {
+  describe('exportElement', () => {
+    it('should export a basic element', () => {
+      const element = new Element<string>(
+        'testElement',
+        'A test element',
+        'default-value',
+        'example-value',
+        false,
+        false,
+        Joi.string()
+      );
+
+      const exported = exportElement(element);
+
+      expect(exported.name).toBe('testElement');
+      expect(exported.description).toBe('A test element');
+      expect(exported.type).toBe('string');
+      expect(exported.default).toBe('default-value');
+      expect(exported.example).toBe('example-value');
+      expect(exported.required).toBe(false);
+      expect(exported.sensitive).toBe(false);
+    });
+
+    it('should handle required elements', () => {
+      const element = new Element<number>(
+        'requiredElement',
+        'A required element',
+        undefined,
+        42,
+        false,
+        false,
+        Joi.number().required()
+      );
+
+      const exported = exportElement(element);
+
+      expect(exported.required).toBe(true);
+    });
+
+    it('should handle sensitive elements', () => {
+      const element = new Element<string>(
+        'secretKey',
+        'API secret key',
+        undefined,
+        'sk_test_123',
+        true,
+        false,
+        Joi.string()
+      );
+
+      const exported = exportElement(element);
+
+      expect(exported.sensitive).toBe(true);
+    });
+
+    it('should handle elements with omitFromSchema', () => {
+      const element = new Element<string>(
+        'privateKey',
+        'Private configuration key',
+        'default',
+        'example',
+        false,
+        true,
+        Joi.string()
+      );
+
+      expect(element.omitFromSchema).toBe(true);
+    });
+
+    it('should extract joi validation object', () => {
+      const element = new Element<number>(
+        'port',
+        'Server port',
+        3000,
+        undefined,
+        false,
+        false,
+        Joi.number().min(1).max(65535).required()
+      );
+
+      const exported = exportElement(element);
+
+      expect(exported.joiValidation).toBeDefined();
+      expect((exported.joiValidation as any).type).toBe('number');
+      expect((exported.joiValidation as any).rules).toBeDefined();
+    });
+
+    it('should handle enum types', () => {
+      const element = new Element<string>(
+        'environment',
+        'Runtime environment',
+        'development',
+        undefined,
+        false,
+        false,
+        Joi.string().valid('development', 'staging', 'production')
+      );
+
+      const exported = exportElement(element);
+
+      expect(exported.type).toContain('development');
+      expect(exported.type).toContain('staging');
+      expect(exported.type).toContain('production');
+    });
+  });
+
+  describe('exportSection', () => {
+    it('should export a section with elements', () => {
+      const elements = [
+        new Element<string>('host', 'Database host', 'localhost'),
+        new Element<number>('port', 'Database port', 5432)
+      ];
+
+      const section = new Section(
+        'database',
+        elements,
+        'Database configuration'
+      );
+
+      const exported = exportSection(section);
+
+      expect(exported.name).toBe('database');
+      expect(exported.description).toBe('Database configuration');
+      expect(exported.elements).toHaveLength(2);
+      expect(exported.elements[0].name).toBe('host');
+      expect(exported.elements[1].name).toBe('port');
+    });
+
+    it('should handle empty sections', () => {
+      const section = new Section('empty', [], 'Empty section');
+
+      const exported = exportSection(section);
+
+      expect(exported.name).toBe('empty');
+      expect(exported.elements).toHaveLength(0);
+    });
+
+    it('should filter out elements with omitFromSchema: true', () => {
+      const publicElement = new Element<string>(
+        'appName',
+        'Application name',
+        'myApp',
+        'exampleApp',
+        false,
+        false,
+        Joi.string()
+      );
+      const privateElement = new Element<string>(
+        'internalKey',
+        'Internal configuration key',
+        'secret',
+        'example',
+        false,
+        true,
+        Joi.string()
+      );
+
+      const section = new Section(
+        'app',
+        [publicElement, privateElement],
+        'Application settings'
+      );
+      const exported = exportSection(section);
+
+      expect(exported.name).toBe('app');
+      expect(exported.description).toBe('Application settings');
+      expect(exported.elements).toHaveLength(1);
+      expect(exported.elements[0].name).toBe('appName');
+      expect(
+        exported.elements.find(
+          (e: { name: string }) => e.name === 'internalKey'
+        )
+      ).toBeUndefined();
+    });
+
+    it('should include omitted elements when includeOmitted is true', () => {
+      const publicElement = new Element<string>(
+        'appName',
+        'Application name',
+        'myApp',
+        'exampleApp',
+        false,
+        false,
+        Joi.string()
+      );
+      const privateElement = new Element<string>(
+        'internalKey',
+        'Internal configuration key',
+        'secret',
+        'example',
+        false,
+        true,
+        Joi.string()
+      );
+
+      const section = new Section(
+        'app',
+        [publicElement, privateElement],
+        'Application settings'
+      );
+      const exported = exportSection(section, true);
+
+      expect(exported.name).toBe('app');
+      expect(exported.description).toBe('Application settings');
+      expect(exported.elements).toHaveLength(2);
+      expect(exported.elements[0].name).toBe('appName');
+      expect(exported.elements[1].name).toBe('internalKey');
+    });
+  });
+
+  describe('exportSchema', () => {
+    it('should export a complete schema', () => {
+      const appElements = [
+        new Element<number>('port', 'Application port', 3000),
+        new Element<string>('host', 'Application host', 'localhost')
+      ];
+
+      const dbElements = [
+        new Element<string>(
+          'connectionString',
+          'Database connection',
+          undefined
+        )
+      ];
+
+      const sections = [
+        new Section('app', appElements, 'Application settings'),
+        new Section('database', dbElements, 'Database settings')
+      ];
+
+      const schema = exportSchema('myApp', sections);
+
+      expect(schema.name).toBe('myApp');
+      expect(schema.sections).toHaveLength(2);
+      expect(schema.sections[0].name).toBe('app');
+      expect(schema.sections[1].name).toBe('database');
+    });
+
+    it('should include omitted elements when includeOmitted is true', () => {
+      const publicElement = new Element<string>(
+        'appName',
+        'Application name',
+        'myApp',
+        'exampleApp',
+        false,
+        false,
+        Joi.string()
+      );
+      const privateElement = new Element<string>(
+        'internalKey',
+        'Internal configuration key',
+        'secret',
+        'example',
+        false,
+        true,
+        Joi.string()
+      );
+
+      const sections = [
+        new Section(
+          'app',
+          [publicElement, privateElement],
+          'Application settings'
+        )
+      ];
+
+      const schema = exportSchema('myApp', sections, true);
+
+      expect(schema.name).toBe('myApp');
+      expect(schema.sections).toHaveLength(1);
+      expect(schema.sections[0].elements).toHaveLength(2);
+      expect(schema.sections[0].elements[0].name).toBe('appName');
+      expect(schema.sections[0].elements[1].name).toBe('internalKey');
+    });
+  });
+});

package/src/schemaExporter.ts

@@ -0,0 +1,119 @@
+import { Section } from '@config-bound/config-bound/section';
+import { Element } from '@config-bound/config-bound/element';
+import Joi from 'joi';
+
+/**
+ * Represents a single configuration element in the exported schema
+ */
+export interface ExportedElement {
+  name: string;
+  description?: string;
+  type: string;
+  default?: unknown;
+  example?: unknown;
+  required: boolean;
+  sensitive: boolean;
+  joiValidation: unknown;
+}
+
+/**
+ * Represents a configuration section in the exported schema
+ */
+export interface ExportedSection {
+  name: string;
+  description?: string;
+  elements: ExportedElement[];
+}
+
+/**
+ * The complete exported configuration schema
+ */
+export interface ExportedSchema {
+  name: string;
+  sections: ExportedSection[];
+}
+
+/**
+ * Extracts type information from a Joi schema
+ */
+function extractJoiType(validator: Joi.AnySchema): string {
+  const describe = validator.describe();
+
+  if (describe.type === 'alternatives') {
+    const types =
+      describe.matches?.map(
+        (m: Joi.Description) => m.schema?.type || 'unknown'
+      ) || [];
+    return types.join(' | ') || 'any';
+  }
+
+  if (describe.type === 'string' && describe.allow) {
+    const allowed = describe.allow;
+    if (Array.isArray(allowed) && allowed.length > 0) {
+      return allowed.map((v) => `'${v}'`).join(' | ');
+    }
+  }
+
+  return describe.type || 'unknown';
+}
+
+/**
+ * Extracts the raw Joi object from a schema
+ */
+function extractJoiValidation(validator: Joi.AnySchema): unknown {
+  return validator.describe();
+}
+
+/**
+ * Exports an Element to the external schema format
+ */
+export function exportElement(element: Element<unknown>): ExportedElement {
+  return {
+    name: element.name,
+    description: element.description,
+    type: extractJoiType(element.validator),
+    default: element.default,
+    example: element.example,
+    required: element.isRequired(),
+    sensitive: element.sensitive,
+    joiValidation: extractJoiValidation(element.validator)
+  };
+}
+
+/**
+ * Exports a Section to the external schema format
+ * @param section - The section to export
+ * @param includeOmitted - Whether to include elements marked with omitFromSchema (default: false)
+ */
+export function exportSection(
+  section: Section,
+  includeOmitted: boolean = false
+): ExportedSection {
+  return {
+    name: section.name,
+    description: section.description,
+    elements: section
+      .getElements()
+      .filter(
+        (element: Element<unknown>) => includeOmitted || !element.omitFromSchema
+      )
+      .map(exportElement)
+  };
+}
+
+/**
+ * Exports the complete schema to a structured format
+ * @param name - The name of the configuration
+ * @param sections - Array of sections to export
+ * @param includeOmitted - Whether to include elements marked with omitFromSchema (default: false)
+ */
+export function exportSchema(
+  name: string,
+  sections: Section[],
+  includeOmitted: boolean = false
+): ExportedSchema {
+  return {
+    name,
+    sections: sections.map((section) => exportSection(section, includeOmitted))
+  };
+}