@typia/utils 12.0.0-dev.20260225

package/lib/validators/LlmTypeChecker.mjs

@@ -0,0 +1,300 @@
+import { MapUtil } from '../utils/MapUtil.mjs';
+import { OpenApiTypeCheckerBase } from '../utils/internal/OpenApiTypeCheckerBase.mjs';
+
+/**
+ * Type checker for LLM function calling schema.
+ *
+ * `LlmTypeChecker` is a type checker of {@link ILlmSchema}, the type schema for
+ * LLM (Large Language Model) function calling.
+ *
+ * This checker provides type guard functions for validating schema types, and
+ * operators for traversing and comparing schemas.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+var LlmTypeChecker;
+(function (LlmTypeChecker) {
+    /* -----------------------------------------------------------
+      TYPE CHECKERS
+    ----------------------------------------------------------- */
+    /**
+     * Test whether the schema is a null type.
+     *
+     * @param schema Target schema
+     * @returns Whether null type or not
+     */
+    LlmTypeChecker.isNull = (schema) => schema.type === "null";
+    /**
+     * Test whether the schema is an unknown type.
+     *
+     * @param schema Target schema
+     * @returns Whether unknown type or not
+     */
+    LlmTypeChecker.isUnknown = (schema) => schema.type === undefined &&
+        !LlmTypeChecker.isAnyOf(schema) &&
+        !LlmTypeChecker.isReference(schema);
+    /**
+     * Test whether the schema is a boolean type.
+     *
+     * @param schema Target schema
+     * @returns Whether boolean type or not
+     */
+    LlmTypeChecker.isBoolean = (schema) => schema.type === "boolean";
+    /**
+     * Test whether the schema is an integer type.
+     *
+     * @param schema Target schema
+     * @returns Whether integer type or not
+     */
+    LlmTypeChecker.isInteger = (schema) => schema.type === "integer";
+    /**
+     * Test whether the schema is a number type.
+     *
+     * @param schema Target schema
+     * @returns Whether number type or not
+     */
+    LlmTypeChecker.isNumber = (schema) => schema.type === "number";
+    /**
+     * Test whether the schema is a string type.
+     *
+     * @param schema Target schema
+     * @returns Whether string type or not
+     */
+    LlmTypeChecker.isString = (schema) => schema.type === "string";
+    /**
+     * Test whether the schema is an array type.
+     *
+     * @param schema Target schema
+     * @returns Whether array type or not
+     */
+    LlmTypeChecker.isArray = (schema) => schema.type === "array" &&
+        schema.items !== undefined;
+    /**
+     * Test whether the schema is an object type.
+     *
+     * @param schema Target schema
+     * @returns Whether object type or not
+     */
+    LlmTypeChecker.isObject = (schema) => schema.type === "object";
+    /**
+     * Test whether the schema is a reference type.
+     *
+     * @param schema Target schema
+     * @returns Whether reference type or not
+     */
+    LlmTypeChecker.isReference = (schema) => schema.$ref !== undefined;
+    /**
+     * Test whether the schema is a union type.
+     *
+     * @param schema Target schema
+     * @returns Whether union type or not
+     */
+    LlmTypeChecker.isAnyOf = (schema) => schema.anyOf !== undefined;
+    /* -----------------------------------------------------------
+      OPERATORS
+    ----------------------------------------------------------- */
+    /**
+     * Visit every nested schemas.
+     *
+     * Visit every nested schemas of the target, and apply the `props.closure`
+     * function.
+     *
+     * Here is the list of occurring nested visitings:
+     *
+     * - {@link ILlmSchema.IAnyOf.anyOf}
+     * - {@link ILlmSchema.IReference}
+     * - {@link ILlmSchema.IObject.properties}
+     * - {@link ILlmSchema.IArray.items}
+     *
+     * @param props Properties for visiting
+     */
+    LlmTypeChecker.visit = (props) => {
+        const already = new Set();
+        const refAccessor = props.refAccessor ?? "$input.$defs";
+        const next = (schema, accessor) => {
+            props.closure(schema, accessor);
+            if (LlmTypeChecker.isReference(schema)) {
+                const key = schema.$ref.split("#/$defs/").pop();
+                if (already.has(key) === true)
+                    return;
+                already.add(key);
+                const found = props.$defs?.[key];
+                if (found !== undefined)
+                    next(found, `${refAccessor}[${key}]`);
+            }
+            else if (LlmTypeChecker.isAnyOf(schema))
+                schema.anyOf.forEach((s, i) => next(s, `${accessor}.anyOf[${i}]`));
+            else if (LlmTypeChecker.isObject(schema)) {
+                for (const [key, value] of Object.entries(schema.properties))
+                    next(value, `${accessor}.properties[${JSON.stringify(key)}]`);
+                if (typeof schema.additionalProperties === "object" &&
+                    schema.additionalProperties !== null)
+                    next(schema.additionalProperties, `${accessor}.additionalProperties`);
+            }
+            else if (LlmTypeChecker.isArray(schema))
+                next(schema.items, `${accessor}.items`);
+        };
+        next(props.schema, props.accessor ?? "$input.schemas");
+    };
+    /**
+     * Test whether the `x` schema covers the `y` schema.
+     *
+     * @param props Properties for testing
+     * @returns Whether the `x` schema covers the `y` schema
+     */
+    LlmTypeChecker.covers = (props) => coverStation({
+        $defs: props.$defs,
+        x: props.x,
+        y: props.y,
+        visited: new Map(),
+    });
+    const coverStation = (p) => {
+        const cache = p.visited.get(p.x)?.get(p.y);
+        if (cache !== undefined)
+            return cache;
+        // FOR RECURSIVE CASE
+        const nested = MapUtil.take(p.visited, p.x, () => new Map());
+        nested.set(p.y, true);
+        // COMPUTE IT
+        const result = coverSchema(p);
+        nested.set(p.y, result);
+        return result;
+    };
+    const coverSchema = (p) => {
+        // CHECK EQUALITY
+        if (p.x === p.y)
+            return true;
+        else if (LlmTypeChecker.isReference(p.x) && LlmTypeChecker.isReference(p.y) && p.x.$ref === p.y.$ref)
+            return true;
+        // COMPARE WITH FLATTENING
+        const alpha = flatSchema(p.$defs, p.x);
+        const beta = flatSchema(p.$defs, p.y);
+        if (alpha.some((x) => LlmTypeChecker.isUnknown(x)))
+            return true;
+        else if (beta.some((x) => LlmTypeChecker.isUnknown(x)))
+            return false;
+        return beta.every((b) => alpha.some((a) => coverEscapedSchema({
+            $defs: p.$defs,
+            visited: p.visited,
+            x: a,
+            y: b,
+        })));
+    };
+    const coverEscapedSchema = (p) => {
+        // CHECK EQUALITY
+        if (p.x === p.y)
+            return true;
+        else if (LlmTypeChecker.isUnknown(p.x))
+            return true;
+        else if (LlmTypeChecker.isUnknown(p.y))
+            return false;
+        else if (LlmTypeChecker.isNull(p.x))
+            return LlmTypeChecker.isNull(p.y);
+        // ATOMIC CASE
+        else if (LlmTypeChecker.isBoolean(p.x))
+            return LlmTypeChecker.isBoolean(p.y) && coverBoolean(p.x, p.y);
+        else if (LlmTypeChecker.isInteger(p.x))
+            return LlmTypeChecker.isInteger(p.y) && coverInteger(p.x, p.y);
+        else if (LlmTypeChecker.isNumber(p.x))
+            return LlmTypeChecker.isNumber(p.y) && coverNumber(p.x, p.y);
+        else if (LlmTypeChecker.isString(p.x))
+            return LlmTypeChecker.isString(p.y) && coverString(p.x, p.y);
+        // INSTANCE CASE
+        else if (LlmTypeChecker.isArray(p.x))
+            return (LlmTypeChecker.isArray(p.y) &&
+                coverArray({
+                    $defs: p.$defs,
+                    visited: p.visited,
+                    x: p.x,
+                    y: p.y,
+                }));
+        else if (LlmTypeChecker.isObject(p.x))
+            return (LlmTypeChecker.isObject(p.y) &&
+                coverObject({
+                    $defs: p.$defs,
+                    visited: p.visited,
+                    x: p.x,
+                    y: p.y,
+                }));
+        else if (LlmTypeChecker.isReference(p.x))
+            return LlmTypeChecker.isReference(p.y) && p.x.$ref === p.y.$ref;
+        return false;
+    };
+    const coverArray = (p) => {
+        if (!(p.x.minItems === undefined ||
+            (p.y.minItems !== undefined && p.x.minItems <= p.y.minItems)))
+            return false;
+        else if (!(p.x.maxItems === undefined ||
+            (p.y.maxItems !== undefined && p.x.maxItems >= p.y.maxItems)))
+            return false;
+        return coverStation({
+            $defs: p.$defs,
+            visited: p.visited,
+            x: p.x.items,
+            y: p.y.items,
+        });
+    };
+    const coverObject = (p) => {
+        if (!p.x.additionalProperties && !!p.y.additionalProperties)
+            return false;
+        else if (!!p.x.additionalProperties &&
+            !!p.y.additionalProperties &&
+            ((typeof p.x.additionalProperties === "object" &&
+                p.y.additionalProperties === true) ||
+                (typeof p.x.additionalProperties === "object" &&
+                    typeof p.y.additionalProperties === "object" &&
+                    !coverStation({
+                        $defs: p.$defs,
+                        visited: p.visited,
+                        x: p.x.additionalProperties,
+                        y: p.y.additionalProperties,
+                    }))))
+            return false;
+        return Object.entries(p.y.properties ?? {}).every(([key, b]) => {
+            const a = p.x.properties?.[key];
+            if (a === undefined)
+                return false;
+            else if ((p.x.required?.includes(key) ?? false) === true &&
+                (p.y.required?.includes(key) ?? false) === false)
+                return false;
+            return coverStation({
+                $defs: p.$defs,
+                visited: p.visited,
+                x: a,
+                y: b,
+            });
+        });
+    };
+    const coverBoolean = (x, y) => {
+        if (!!x.enum?.length)
+            return !!y.enum?.length && y.enum.every((v) => x.enum.includes(v));
+        return true;
+    };
+    const coverInteger = (x, y) => {
+        if (!!x.enum?.length)
+            return !!y.enum?.length && y.enum.every((v) => x.enum.includes(v));
+        return OpenApiTypeCheckerBase.coverInteger(x, y);
+    };
+    const coverNumber = (x, y) => {
+        if (!!x.enum?.length)
+            return !!y.enum?.length && y.enum.every((v) => x.enum.includes(v));
+        return OpenApiTypeCheckerBase.coverNumber(x, y);
+    };
+    const coverString = (x, y) => {
+        if (!!x.enum?.length)
+            return !!y.enum?.length && y.enum.every((v) => x.enum.includes(v));
+        return OpenApiTypeCheckerBase.coverString(x, y);
+    };
+    const flatSchema = ($defs, schema) => {
+        schema = escapeReference($defs, schema);
+        if (LlmTypeChecker.isAnyOf(schema))
+            return schema.anyOf.map((v) => flatSchema($defs, v)).flat();
+        return [schema];
+    };
+    const escapeReference = ($defs, schema) => LlmTypeChecker.isReference(schema)
+        ? escapeReference($defs, $defs[schema.$ref.replace("#/$defs/", "")])
+        : schema;
+})(LlmTypeChecker || (LlmTypeChecker = {}));
+
+export { LlmTypeChecker };
+//# sourceMappingURL=LlmTypeChecker.mjs.map

package/lib/validators/LlmTypeChecker.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"LlmTypeChecker.mjs","sources":["../../src/validators/LlmTypeChecker.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAKA;;;;;;;;;;AAUG;AACG,IAAW;AAAjB,CAAA,UAAiB,cAAc,EAAA;AAC7B;;AAE8D;AAC9D;;;;;AAKG;IACU,cAAA,CAAA,MAAM,GAAG,CAAC,MAAkB,KACtC,MAA2B,CAAC,IAAI,KAAK,MAAM;AAE9C;;;;;AAKG;IACU,cAAA,CAAA,SAAS,GAAG,CACvB,MAAkB,KAEjB,MAA8B,CAAC,IAAI,KAAK,SAAS;AAClD,QAAA,CAAC,cAAA,CAAA,OAAO,CAAC,MAAM,CAAC;AAChB,QAAA,CAAC,cAAA,CAAA,WAAW,CAAC,MAAM,CAAC;AAEtB;;;;;AAKG;IACU,cAAA,CAAA,SAAS,GAAG,CACvB,MAAkB,KAEjB,MAA8B,CAAC,IAAI,KAAK,SAAS;AAEpD;;;;;AAKG;IACU,cAAA,CAAA,SAAS,GAAG,CACvB,MAAkB,KAEjB,MAA8B,CAAC,IAAI,KAAK,SAAS;AAEpD;;;;;AAKG;IACU,cAAA,CAAA,QAAQ,GAAG,CAAC,MAAkB,KACxC,MAA6B,CAAC,IAAI,KAAK,QAAQ;AAElD;;;;;AAKG;IACU,cAAA,CAAA,QAAQ,GAAG,CAAC,MAAkB,KACxC,MAA6B,CAAC,IAAI,KAAK,QAAQ;AAElD;;;;;AAKG;IACU,cAAA,CAAA,OAAO,GAAG,CAAC,MAAkB,KACvC,MAA4B,CAAC,IAAI,KAAK,OAAO;AAC7C,QAAA,MAA4B,CAAC,KAAK,KAAK,SAAS;AAEnD;;;;;AAKG;IACU,cAAA,CAAA,QAAQ,GAAG,CAAC,MAAkB,KACxC,MAA6B,CAAC,IAAI,KAAK,QAAQ;AAElD;;;;;AAKG;IACU,cAAA,CAAA,WAAW,GAAG,CACzB,MAAkB,KACmB,MAAc,CAAC,IAAI,KAAK,SAAS;AAExE;;;;;AAKG;IACU,cAAA,CAAA,OAAO,GAAG,CAAC,MAAkB,KACvC,MAA4B,CAAC,KAAK,KAAK,SAAS;AAEnD;;AAE8D;AAC9D;;;;;;;;;;;;;;AAcG;AACU,IAAA,cAAA,CAAA,KAAK,GAAG,CAAC,KAMrB,KAAU;AACT,QAAA,MAAM,OAAO,GAAgB,IAAI,GAAG,EAAE;AACtC,QAAA,MAAM,WAAW,GAAW,KAAK,CAAC,WAAW,IAAI,cAAc;AAC/D,QAAA,MAAM,IAAI,GAAG,CAAC,MAAkB,EAAE,QAAgB,KAAU;AAC1D,YAAA,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC;AAC/B,YAAA,IAAI,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE;AACtC,gBAAA,MAAM,GAAG,GAAW,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,EAAG;AACxD,gBAAA,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI;oBAAE;AAC/B,gBAAA,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;gBAChB,MAAM,KAAK,GAA2B,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC;gBACxD,IAAI,KAAK,KAAK,SAAS;oBAAE,IAAI,CAAC,KAAK,EAAE,CAAA,EAAG,WAAW,CAAA,CAAA,EAAI,GAAG,CAAA,CAAA,CAAG,CAAC;YAChE;AAAO,iBAAA,IAAI,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC;gBACvC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,EAAE,CAAA,EAAG,QAAQ,UAAU,CAAC,CAAA,CAAA,CAAG,CAAC,CAAC;AAC/D,iBAAA,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AACxC,gBAAA,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC;AAC1D,oBAAA,IAAI,CAAC,KAAK,EAAE,CAAA,EAAG,QAAQ,CAAA,YAAA,EAAe,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA,CAAA,CAAG,CAAC;AAC/D,gBAAA,IACE,OAAO,MAAM,CAAC,oBAAoB,KAAK,QAAQ;oBAC/C,MAAM,CAAC,oBAAoB,KAAK,IAAI;oBAEpC,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAA,EAAG,QAAQ,CAAA,qBAAA,CAAuB,CAAC;YACzE;AAAO,iBAAA,IAAI,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC;gBACvC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA,EAAG,QAAQ,CAAA,MAAA,CAAQ,CAAC;AAC3C,QAAA,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,IAAI,gBAAgB,CAAC;AACxD,IAAA,CAAC;AAED;;;;;AAKG;AACU,IAAA,cAAA,CAAA,MAAM,GAAG,CAAC,KAItB,KACC,YAAY,CAAC;QACX,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,CAAC,EAAE,KAAK,CAAC,CAAC;QACV,CAAC,EAAE,KAAK,CAAC,CAAC;QACV,OAAO,EAAE,IAAI,GAAG,EAAE;AACnB,KAAA,CAAC;AAEJ,IAAA,MAAM,YAAY,GAAG,CAAC,CAKrB,KAAa;AACZ,QAAA,MAAM,KAAK,GAAwB,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/D,IAAI,KAAK,KAAK,SAAS;AAAE,YAAA,OAAO,KAAK;;QAGrC,MAAM,MAAM,GAA6B,OAAO,CAAC,IAAI,CACnD,CAAC,CAAC,OAAO,EACT,CAAC,CAAC,CAAC,EACH,MAAM,IAAI,GAAG,EAAE,CAChB;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;;AAGrB,QAAA,MAAM,MAAM,GAAY,WAAW,CAAC,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;AACvB,QAAA,OAAO,MAAM;AACf,IAAA,CAAC;AAED,IAAA,MAAM,WAAW,GAAG,CAAC,CAKpB,KAAa;;AAEZ,QAAA,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,IAAI;aACvB,IAAI,cAAA,CAAA,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,cAAA,CAAA,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI;AACpE,YAAA,OAAO,IAAI;;AAGb,QAAA,MAAM,KAAK,GAAiB,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AACpD,QAAA,MAAM,IAAI,GAAiB,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AACnD,QAAA,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,cAAA,CAAA,SAAS,CAAC,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,IAAI;AAC3C,aAAA,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,cAAA,CAAA,SAAS,CAAC,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,KAAK;AACrD,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAClB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KACX,kBAAkB,CAAC;YACjB,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,OAAO,EAAE,CAAC,CAAC,OAAO;AAClB,YAAA,CAAC,EAAE,CAAC;AACJ,YAAA,CAAC,EAAE,CAAC;SACL,CAAC,CACH,CACF;AACH,IAAA,CAAC;AAED,IAAA,MAAM,kBAAkB,GAAG,CAAC,CAK3B,KAAa;;AAEZ,QAAA,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,IAAI;AACvB,aAAA,IAAI,eAAA,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,IAAI;AAC/B,aAAA,IAAI,eAAA,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,KAAK;AAChC,aAAA,IAAI,eAAA,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,eAAA,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;;AAEnC,aAAA,IAAI,eAAA,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,eAAA,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACnE,aAAA,IAAI,eAAA,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,eAAA,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACnE,aAAA,IAAI,eAAA,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,eAAA,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAChE,aAAA,IAAI,eAAA,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,eAAA,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;;AAEhE,aAAA,IAAI,eAAA,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AACnB,YAAA,QACE,cAAA,CAAA,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AACZ,gBAAA,UAAU,CAAC;oBACT,KAAK,EAAE,CAAC,CAAC,KAAK;oBACd,OAAO,EAAE,CAAC,CAAC,OAAO;oBAClB,CAAC,EAAE,CAAC,CAAC,CAAC;oBACN,CAAC,EAAE,CAAC,CAAC,CAAC;AACP,iBAAA,CAAC;AAED,aAAA,IAAI,eAAA,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACpB,YAAA,QACE,cAAA,CAAA,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACb,gBAAA,WAAW,CAAC;oBACV,KAAK,EAAE,CAAC,CAAC,KAAK;oBACd,OAAO,EAAE,CAAC,CAAC,OAAO;oBAClB,CAAC,EAAE,CAAC,CAAC,CAAC;oBACN,CAAC,EAAE,CAAC,CAAC,CAAC;AACP,iBAAA,CAAC;AAED,aAAA,IAAI,eAAA,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;AAAE,YAAA,OAAO,eAAA,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI;AAC3E,QAAA,OAAO,KAAK;AACd,IAAA,CAAC;AAED,IAAA,MAAM,UAAU,GAAG,CAAC,CAKnB,KAAa;QACZ,IACE,EACE,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS;aACzB,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAC7D;AAED,YAAA,OAAO,KAAK;aACT,IACH,EACE,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS;aACzB,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAC7D;AAED,YAAA,OAAO,KAAK;AACd,QAAA,OAAO,YAAY,CAAC;YAClB,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,OAAO,EAAE,CAAC,CAAC,OAAO;AAClB,YAAA,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK;AACZ,YAAA,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK;AACb,SAAA,CAAC;AACJ,IAAA,CAAC;AAED,IAAA,MAAM,WAAW,GAAG,CAAC,CAKpB,KAAa;AACZ,QAAA,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB;AAAE,YAAA,OAAO,KAAK;AACpE,aAAA,IACH,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB;AAC1B,YAAA,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB;aACzB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,oBAAoB,KAAK,QAAQ;AAC5C,gBAAA,CAAC,CAAC,CAAC,CAAC,oBAAoB,KAAK,IAAI;AACjC,iBAAC,OAAO,CAAC,CAAC,CAAC,CAAC,oBAAoB,KAAK,QAAQ;AAC3C,oBAAA,OAAO,CAAC,CAAC,CAAC,CAAC,oBAAoB,KAAK,QAAQ;AAC5C,oBAAA,CAAC,YAAY,CAAC;wBACZ,KAAK,EAAE,CAAC,CAAC,KAAK;wBACd,OAAO,EAAE,CAAC,CAAC,OAAO;AAClB,wBAAA,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,oBAAoB;AAC3B,wBAAA,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,oBAAoB;AAC5B,qBAAA,CAAC,CAAC,CAAC;AAER,YAAA,OAAO,KAAK;QACd,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAI;YAC7D,MAAM,CAAC,GAA2B,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,GAAG,CAAC;YACvD,IAAI,CAAC,KAAK,SAAS;AAAE,gBAAA,OAAO,KAAK;AAC5B,iBAAA,IACH,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI;AAC/C,gBAAA,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,KAAK;AAEhD,gBAAA,OAAO,KAAK;AACd,YAAA,OAAO,YAAY,CAAC;gBAClB,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,OAAO,EAAE,CAAC,CAAC,OAAO;AAClB,gBAAA,CAAC,EAAE,CAAC;AACJ,gBAAA,CAAC,EAAE,CAAC;AACL,aAAA,CAAC;AACJ,QAAA,CAAC,CAAC;AACJ,IAAA,CAAC;AAED,IAAA,MAAM,YAAY,GAAG,CACnB,CAAsB,EACtB,CAAsB,KACX;AACX,QAAA,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM;AAClB,YAAA,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AACrE,QAAA,OAAO,IAAI;AACb,IAAA,CAAC;AAED,IAAA,MAAM,YAAY,GAAG,CACnB,CAAsB,EACtB,CAAsB,KACX;AACX,QAAA,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM;AAClB,YAAA,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACrE,OAAO,sBAAsB,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;AAClD,IAAA,CAAC;AAED,IAAA,MAAM,WAAW,GAAG,CAClB,CAAqB,EACrB,CAA2C,KAChC;AACX,QAAA,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM;AAClB,YAAA,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACrE,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;AACjD,IAAA,CAAC;AAED,IAAA,MAAM,WAAW,GAAG,CAClB,CAAqB,EACrB,CAAqB,KACV;AACX,QAAA,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM;AAClB,YAAA,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACrE,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;AACjD,IAAA,CAAC;AAED,IAAA,MAAM,UAAU,GAAG,CACjB,KAA6C,EAC7C,MAAkB,KACF;AAChB,QAAA,MAAM,GAAG,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC;AACvC,QAAA,IAAI,cAAA,CAAA,OAAO,CAAC,MAAM,CAAC;YACjB,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;QAC7D,OAAO,CAAC,MAAM,CAAC;AACjB,IAAA,CAAC;AAED,IAAA,MAAM,eAAe,GAAG,CACtB,KAA6C,EAC7C,MAAkB,KAElB,cAAA,CAAA,WAAW,CAAC,MAAM;AAChB,UAAE,eAAe,CAAC,KAAK,EAAE,KAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAE;UACnE,MAAM;AACd,CAAC,EAjYgB,cAAc,KAAd,cAAc,GAAA,EAAA,CAAA,CAAA;;;;"}

package/lib/validators/OpenApiTypeChecker.d.ts

@@ -0,0 +1,211 @@
+import { IJsonSchemaTransformError, IResult, OpenApi } from "@typia/interface";
+/**
+ * Type checker for emended OpenAPI v3.1 JSON schemas.
+ *
+ * `OpenApiTypeChecker` provides type guard functions for
+ * {@link OpenApi.IJsonSchema} (typia's normalized OpenAPI format). Use these to
+ * narrow schema types before accessing type-specific properties.
+ *
+ * Type checkers:
+ *
+ * - Primitives: {@link isNull}, {@link isBoolean}, {@link isInteger},
+ *   {@link isNumber}, {@link isString}
+ * - Constants: {@link isConstant}
+ * - Collections: {@link isArray}, {@link isTuple}, {@link isObject}
+ * - Composition: {@link isOneOf}, {@link isReference}
+ * - Special: {@link isUnknown}
+ *
+ * Also provides schema operations:
+ *
+ * - {@link visit}: Traverse and transform schemas recursively
+ * - {@link covers}: Check if one schema subsumes another
+ * - {@link escape}: Unwrap reference schemas
+ *
+ * For other OpenAPI versions, use {@link OpenApiV3TypeChecker},
+ * {@link OpenApiV3_1TypeChecker}, or {@link SwaggerV2TypeChecker}.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare namespace OpenApiTypeChecker {
+    /**
+     * Test whether the schema is a nul type.
+     *
+     * @param schema Target schema
+     * @returns Whether null type or not
+     */
+    const isNull: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.INull;
+    /**
+     * Test whether the schema is an unknown type.
+     *
+     * @param schema Target schema
+     * @returns Whether unknown type or not
+     */
+    const isUnknown: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.IUnknown;
+    /**
+     * Test whether the schema is a constant type.
+     *
+     * @param schema Target schema
+     * @returns Whether constant type or not
+     */
+    const isConstant: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.IConstant;
+    /**
+     * Test whether the schema is a boolean type.
+     *
+     * @param schema Target schema
+     * @returns Whether boolean type or not
+     */
+    const isBoolean: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.IBoolean;
+    /**
+     * Test whether the schema is an integer type.
+     *
+     * @param schema Target schema
+     * @returns Whether integer type or not
+     */
+    const isInteger: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.IInteger;
+    /**
+     * Test whether the schema is a number type.
+     *
+     * @param schema Target schema
+     * @returns Whether number type or not
+     */
+    const isNumber: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.INumber;
+    /**
+     * Test whether the schema is a string type.
+     *
+     * @param schema Target schema
+     * @returns Whether string type or not
+     */
+    const isString: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.IString;
+    /**
+     * Test whether the schema is an array type.
+     *
+     * @param schema Target schema
+     * @returns Whether array type or not
+     */
+    const isArray: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.IArray;
+    /**
+     * Test whether the schema is a tuple type.
+     *
+     * @param schema Target schema
+     * @returns Whether tuple type or not
+     */
+    const isTuple: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.ITuple;
+    /**
+     * Test whether the schema is an object type.
+     *
+     * @param schema Target schema
+     * @returns Whether object type or not
+     */
+    const isObject: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.IObject;
+    /**
+     * Test whether the schema is a reference type.
+     *
+     * @param schema Target schema
+     * @returns Whether reference type or not
+     */
+    const isReference: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.IReference;
+    /**
+     * Test whether the schema is an union type.
+     *
+     * @param schema Target schema
+     * @returns Whether union type or not
+     */
+    const isOneOf: (schema: OpenApi.IJsonSchema) => schema is OpenApi.IJsonSchema.IOneOf;
+    /**
+     * Test whether the schema is recursive reference type.
+     *
+     * Test whether the target schema is a reference type, and test one thing more
+     * that the reference is self-recursive or not.
+     *
+     * @param props Properties for recursive reference test
+     * @returns Whether the schema is recursive reference type or not
+     */
+    const isRecursiveReference: (props: {
+        components: OpenApi.IComponents;
+        schema: OpenApi.IJsonSchema;
+    }) => boolean;
+    /**
+     * Escape from the {@link OpenApi.IJsonSchema.IReference} type.
+     *
+     * Escape from the {@link OpenApi.IJsonSchema.IReference} type, replacing the
+     * every references to the actual schemas. If the escape is successful, the
+     * returned schema never contains any {@link OpenApi.IJsonSchema.IReference}
+     * type in its structure.
+     *
+     * If the schema has a recursive reference, the recursive reference would be
+     * repeated as much as the `props.recursive` depth. If you've configured the
+     * `props.recursive` as `false` or `0`, it would be failed and return an
+     * {@link IJsonSchemaTransformError}. Also, if there's a
+     * {@link OpenApi.IJsonSchema.IReference} type which cannot find the matched
+     * type in the {@link OpenApi.IComponents.schemas}, it would also be failed and
+     * return an {@link IJsonSchemaTransformError} either.
+     *
+     * @param props Properties for escaping
+     * @returns Escaped schema, or error with reason
+     */
+    const escape: (props: {
+        components: OpenApi.IComponents;
+        schema: OpenApi.IJsonSchema;
+        recursive: false | number;
+        accessor?: string;
+        refAccessor?: string;
+    }) => IResult<OpenApi.IJsonSchema, IJsonSchemaTransformError>;
+    /**
+     * Unreference the schema.
+     *
+     * Unreference the schema, replacing the {@link OpenApi.IJsonSchema.IReference}
+     * type to the actual schema. Different with {@link escape} is, the
+     * `unreference` function does not resolve every references in the schema, but
+     * resolve only one time.
+     *
+     * If there's a {@link OpenApi.IJsonSchema.IReference} type which cannot find
+     * the matched type in the {@link OpenApi.IComponents.schemas}, and you've
+     * called this `unreference()` function with the reference, it would also be
+     * failed and return an {@link IJsonSchemaTransformError} value.
+     *
+     * @param props Properties of unreference
+     * @returns Unreferenced schema
+     */
+    const unreference: (props: {
+        components: OpenApi.IComponents;
+        schema: OpenApi.IJsonSchema;
+        accessor?: string;
+        refAccessor?: string;
+    }) => IResult<OpenApi.IJsonSchema, IJsonSchemaTransformError>;
+    /**
+     * Visit every nested schemas.
+     *
+     * Visit every nested schemas of the target, and apply the `props.closure`
+     * function.
+     *
+     * Here is the list of occurring nested visitings:
+     *
+     * - {@link OpenApi.IJsonSchema.IOneOf.oneOf}
+     * - {@link OpenApi.IJsonSchema.IReference}
+     * - {@link OpenApi.IJsonSchema.IObject.properties}
+     * - {@link OpenApi.IJsonSchema.IObject.additionalProperties}
+     * - {@link OpenApi.IJsonSchema.IArray.items}
+     * - {@link OpenApi.IJsonSchema.ITuple.prefixItems}
+     * - {@link OpenApi.IJsonSchema.ITuple.additionalItems}
+     *
+     * @param props Properties for visiting
+     */
+    const visit: (props: {
+        closure: (schema: OpenApi.IJsonSchema, accessor: string) => void;
+        components: OpenApi.IComponents;
+        schema: OpenApi.IJsonSchema;
+        accessor?: string;
+        refAccessor?: string;
+    }) => void;
+    /**
+     * Test whether the `x` schema covers the `y` schema.
+     *
+     * @param props Properties for testing
+     * @returns Whether the `x` schema covers the `y` schema
+     */
+    const covers: (props: {
+        components: OpenApi.IComponents;
+        x: OpenApi.IJsonSchema;
+        y: OpenApi.IJsonSchema;
+    }) => boolean;
+}