[@unkey/api 0.26.2] response.error.message is undefined despite valid error object

[unrenamed]

Preliminary Checks

• I have reviewed the documentation: https://unkey.com/docs

• I have searched for existing issues: https://github.com/unkeyed/unkey/issues

• This issue is not a question, general help request, or anything other than a bug report directly related to Unkey. Please ask questions in our Discord community: https://unkey.com/discord.

Reproduction / Replay Link (Optional)

No response

Issue Summary

When calling the @unkey/api methods (e.g. unkey.keys.create), the response.error.message field is undefined, because of the nested error object though the response.error object exists and contains other fields such as code and docs.

{
  error: {
    error: {
      code: 'BAD_REQUEST',
      docs: 'https://unkey.dev/docs/api-reference/errors/code/BAD_REQUEST',
      message: 'remaining must be set if you are using refill.',
      requestId: 'req_*************'
    }
  }
}

When the expected response format contains one error object in the response:

{
  error: {
    // A machine readable error code
    code: ErrorCode;

    // A link to our documentation explaining this error in more detail
    docs: string;

    // A human readable short explanation
    message: string;

    // The request id for easy support lookup
    requestId: string;
  }
}

Same for verifyKey method. So I assume this may be a general behaviour for all methods.

Steps to Reproduce

Code snippet

import { Unkey } from "@unkey/api";

async function createApiKey() {
  const unkey = new Unkey({ rootKey: "<UNKEY_ROOT_KEY>" });

  const response = await unkey.keys.create({
    apiId: "<UNKEY_API_ID>",
    refill: { interval: "daily", amount: 100 },
  });

  console.error("Response object: ", response);
  console.error("Error message: ", response.error?.message); // message is undefined
}

createApiKey();

Actual result:

Response object:  {
  error: {
    error: {
      code: 'BAD_REQUEST',
      docs: 'https://unkey.dev/docs/api-reference/errors/code/BAD_REQUEST',
      message: 'remaining must be set if you are using refill.',
      requestId: 'req_*************'
    }
  }
}
Error message:  undefined

Expected behavior

1. The response object should contain one error property (no nested error fields)
2. The provided code snippet should log the actual error message from the response, as per the TypeScript definition and the actual response structure.

Other information

No response

Screenshots

Note that, @unkey/api types work correctly and TS autocomplete expects message property as it has to:

Version info

- OS: macOS 13.5.2 (22G91)
- Node: v20.9.0
- npm: 10.1.0

[linear]

ENG-1447 [`@unkey/api 0.26.2`] `response.error.message` is `undefined` despite valid error object

[unrenamed]

@chronark I think this one is critical. It already affected me while working on templates. May I ask you to verify if this is still reproducible?

[unrenamed]

cc @perkinsjr

[unrenamed]

@perkinsjr @chronark Question: what determines if a bug qualifies for points? I haven’t found any new info in the guidelines. For example, this one is approved, but no points yet. Just curious about how the system works (yeah, after 3 weeks of participating 😅)

[chronark]

/award 150

[oss-gg]

Awarding unrenamed: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/unrenamed

[chronark]

@MichaelUnkey is on this btw, it's indeed a dumb mistake in our sdk

[unrenamed]

@chronark thanks for the update