@ory/kratos typescript API 25.4.0 adds strange "UnknownDefaultOpenApi" von Enums breaking typing

[finsterwalder]

Preflight checklist

• I could not find a solution in the existing issues, docs, nor discussions.
• I agree to follow this project's Code of Conduct.
• I have read and am following this repository's Contribution Guidelines.
• I have joined the Ory Community Slack.
• I am signed up to the Ory Security Patch Newsletter.

Ory Network Project

No response

Describe the bug

I just tried to upgrade @ory/kratos to version 25.4.0.
This produces typing errors in code that worked fine with 1.3.8.
One of the culprits is, that ContinueWithVerificationUi is no longer assignable to ContinueWith.
This is strange.
Digging into it, I found that the ContinueWithVerificationUiActionEnum has a strange definition:

export const ContinueWithVerificationUiActionEnum = {
ShowVerificationUi: 'show_verification_ui',
UnknownDefaultOpenApi: '11184809'
} as const;

And there are many more that have "UnknownDefaultOpenApi" things.

Looks like a generation error to me.

Here is the concrete error I get:

error TS2677: A type predicate's type must be assignable to its parameter's type.
Type 'ContinueWithVerificationUi' is not assignable to type 'ContinueWith'.
Type 'ContinueWithVerificationUi' is not assignable to type '{ action: "show_verification_ui"; } & ContinueWithVerificationUi'.
Type 'ContinueWithVerificationUi' is not assignable to type '{ action: "show_verification_ui"; }'.
Types of property 'action' are incompatible.
Type 'ContinueWithVerificationUiActionEnum' is not assignable to type '"show_verification_ui"'.
Type '"11184809"' is not assignable to type '"show_verification_ui"'.

33 const isContinueWithVerificationUi = (continueWith: ContinueWith): continueWith is ContinueWithVerificationUi => {

Reproducing the bug

run type checking on my typescript code.

Relevant log output

Relevant configuration

Version

25.4.0

On which operating system are you observing this issue?

None

In which environment are you deploying?

None

Additional Context

No response

[finsterwalder]

Forgot to mention: This is the method where the type check fails:

const isContinueWithVerificationUi = (continueWith: ContinueWith): continueWith is ContinueWithVerificationUi => {
return continueWith.action === ContinueWithVerificationUiActionEnum.ShowVerificationUi
}

[aeneasr]

Seems like some incorrect payload or something, not necessarily a type issue. Can you please share a reproducible example?

[finsterwalder]

Here is a project you can check out and execute yarn and yarn type-check to see the error.
https://gitlab.holi.team/stuff/ory-krator-bugreport
The problematic definitions are in the type files, e.g: node_modules/@ory/kratos-client/dist/api.d.ts(230:1)
It's not about a payload.

[aeneasr]

That's helpful, thank you. In our library Ory Elements we use this:

import {ContinueWith, ContinueWithVerificationUi, ContinueWithVerificationUiActionEnum} from "@ory/kratos-client";

/**
 * Checks if the continue with action is to show the verification UI.
 *
 * @param continueWith - The continue with action.
 */
export function isShowVerificationUi(
    continueWith: ContinueWith,
): continueWith is ContinueWithVerificationUi & {
    action: "show_verification_ui"
} {
    return continueWith.action === ContinueWithVerificationUiActionEnum.ShowVerificationUi
}

The problem seems to come from OpenAPI generator and I think the way the oneOf works. Could be a generator bug too or something, it will probably take time until it's resolved so I recommend going with the type guard I provided.

@wassimoo you may stumble on this too.

[finsterwalder]

Thanks, the workaround is good and solves my problem
Would still be nice to fix the lib eventually. :-)