Wrong type of examples?

[zdila]

I combine typia with oRPC OpenAPI and have a typescript error:

Type 'Record<string, IJsonSchema> | undefined' is not assignable to type 'Record<string, SchemaObject> | undefined'.
  Type 'Record<string, IJsonSchema>' is not assignable to type 'Record<string, SchemaObject>'.
    'string' index signatures are incompatible.
      Type 'IJsonSchema' is not assignable to type 'SchemaObject'.
        Type 'IConstant' is not assignable to type 'SchemaObject'.
          Type 'IConstant' is not assignable to type 'MixedSchemaObject'.
            Types of property 'examples' are incompatible.
              Type 'Record<string, any> | undefined' is not assignable to type 'any[] | undefined'.
                Type 'Record<string, any>' is missing the following properties from type 'any[]': length, pop, push, concat, and 35 

Typia:

const typiaSchemas = json.schemas<[MyType1, MyType2]>();

oRPC:

new OpenAPIReferencePlugin({
      docsProvider: "scalar",
      schemaConverters: [new TypiaToJsonSchemaConverter()],
      specPath: "/spec.json",
      docsPath: "/documentation",
      specGenerateOptions: {
        info: {
          title: "My API",
          version: "1.0.0",
        },
        components: {
          schemas: typiaSchemas.components.schemas, // <------ type error
        },
      },
    })

Is it a bug or the problem is in my code?

[ismaildasci]

this is type mismatch between typia IJsonSchema and OpenAPI SchemaObject.

typia uses examples as Record<string, any> (OpenAPI 3.0 style) but oRPC expects any[] (OpenAPI 3.1 style).

quick fix - transform the schemas:

const typiaSchemas = json.schemas<[MyType1, MyType2]>();

const convertedSchemas = Object.fromEntries(
  Object.entries(typiaSchemas.components.schemas).map(([key, schema]) => [
    key,
    {
      ...schema,
      examples: schema.examples 
        ? Object.values(schema.examples) 
        : undefined,
    },
  ])
);

new OpenAPIReferencePlugin({
  // ...
  specGenerateOptions: {
    components: {
      schemas: convertedSchemas,
    },
  },
})

or use type assertion if you dont use examples:

schemas: typiaSchemas.components.schemas as Record<string, SchemaObject>,

its not a bug - just different OpenAPI spec versions between libraries

[samchon]

Thanks for the report. This is a valid boundary mismatch between typia's emended schema representation and raw OpenAPI SchemaObject typing.

I opened a fix in #2001:

• raw OpenApiV3* Schema Object examples types are narrowed to arrays;
• OpenApiConverter.downgradeSchema / downgradeComponents now convert typia's named schema examples record into raw array examples for OpenAPI 3.0/3.1 output;
• the JSON schema guide now documents using OpenApiConverter.downgradeComponents(collection.components, 3.1) when passing typia schemas to third-party OpenAPI plugins.

I will leave this discussion open until the PR is merged.