Export all componentSchemas

src/compileComponentSchemas.ts

@@ -0,0 +1,40 @@
+import { builders } from "ast-types";
+import { Compiler } from "./compiler";
+import { compileValueSchema } from "./compileValueSchema";
+import { OpenAPIValueSchema } from "./types";
+import { annotateWithJSDocComment } from "./comments";
+
+const COMMENT = `
+Map of all components defined in the spec to their validation functions.
+`;
+
+/**
+ * Compile all component schemas to be expoerted as `components['Name']`.
+ */
+export function compileComponentSchemas(compiler: Compiler, schemas: {
+    [key: string]: OpenAPIValueSchema;
+}) {
+    const properties = Object.entries(schemas).map(([name]) => {
+        return builders.property(
+            'init',
+            builders.literal(name),
+            compileValueSchema(compiler, schemas[name]),
+        );
+    });
+
+    return [
+        annotateWithJSDocComment(
+            builders.exportNamedDeclaration(
+                builders.variableDeclaration('const', [
+                    builders.variableDeclarator(
+                        builders.identifier('componentSchemas'),
+                        builders.objectExpression(
+                            properties,
+                        ),
+                    )
+                ]),
+            ),
+            COMMENT,
+        ),
+    ];
+}

src/compiler.ts

@@ -5,6 +5,7 @@ import { OpenAPIRef, OpenAPISpec } from './types';
 import { compileValueSchema } from './compileValueSchema';
 import { hash } from './hash';
 import { compileValidateRequest } from './compileValidateRequest';
+import { compileComponentSchemas } from './compileComponentSchemas';
 
 /**
  * Compiler for OpenAPI specs.
@@ -117,23 +118,13 @@ export class Compiler {
         });
     }
 
-    /**
-     * Build the AST from the entire spec.
-     */
-    public indexAllComponents() {
-        // Index all the schema components.
-        const schemas = this.input.components?.schemas ?? {};
-        Object.values(schemas).forEach((schema) => {
-            compileValueSchema(this, schema);
-        });
-    }
-
     /**
      * Return the AST for the program.
      */
     public ast() {
         return builders.program([
             ...compileValidateRequest(this, this.input),
+            ...compileComponentSchemas(this, this.input.components?.schemas ?? {}),
             ...this.globalDeclarations,
         ]);
     }

src/tests/__snapshots__/compileValueSchema.test.ts.snap

@@ -10,6 +10,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -49,6 +53,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -91,6 +99,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -133,6 +145,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -175,6 +191,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -217,6 +237,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -256,6 +280,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -298,6 +326,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -334,6 +366,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -374,6 +410,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -414,6 +454,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -492,6 +536,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -552,6 +600,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -589,6 +641,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -649,6 +705,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -725,6 +785,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -768,6 +832,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -826,6 +894,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -883,6 +955,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -939,6 +1015,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -1002,6 +1082,10 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/

src/tests/__snapshots__/compiler.test.ts.snap

@@ -10,6 +10,13 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {
+    'A': obj0,
+    'B': obj1
+};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/
@@ -86,6 +93,13 @@ Validate a request against the OpenAPI spec
 export function validateRequest(request, context) {
     return new RequestError(404, 'no operation match path');
 }
+/** 
+Map of all components defined in the spec to their validation functions.
+*/
+export const componentSchemas = {
+    'A': obj0,
+    'B': obj1
+};
 export class RequestError extends Error {
     /** @param {number} code HTTP code for the error
 @param {string} message The error message*/

src/tests/compiler.test.ts

@@ -22,7 +22,6 @@ test('components ref', () => {
             },
         },
     });
-    compiler.indexAllComponents();
     expect(compiler.compile()).toMatchSnapshot();
 });
 
@@ -50,6 +49,5 @@ test('recursive refs', () => {
             },
         },
     });
-    compiler.indexAllComponents();
     expect(compiler.compile()).toMatchSnapshot();
 });

tests/gitbook.test.ts

@@ -1,5 +1,5 @@
-import { expect, test } from 'bun:test';
-import { validateRequest, ValidationError } from './gitbook.validate';
+import { describe, expect, test } from 'bun:test';
+import { validateRequest, ValidationError, componentSchemas } from './gitbook.validate';
 
 test('POST orgs/appleId/custom-fields', () => {
     const result = validateRequest({
@@ -287,3 +287,24 @@ test('/orgs/xxx/synced-blocks?ids[]=foo allow string parameter as array too', ()
     });
     expect(result.query).toEqual({ ids: ['foo'] });
 });
+
+describe('componentSchemas', () => {
+    test('should export a function to validate a component', () => {
+        const validate = componentSchemas['ApiInformation'];
+        expect(validate).toBeInstanceOf(Function);
+        expect(validate([], {
+            version: '1.0.0',
+            build: '123',
+        })).toEqual({
+            version: '1.0.0',
+            build: '123',
+        });
+
+        const error = validate([], {
+            version: '1.0.0',
+            // Missing property
+        })
+        expect(error instanceof ValidationError ? error.path : null).toEqual([]);
+        expect(error instanceof ValidationError ? error.message : null).toEqual('expected "build" to be defined');
+    });
+});