Can we export all types from the package?

Title says it all. There are types like RichTextItemResponse and BlockObjectResponse that would be useful to have so we could create utils in our integrations that perform type checking

[seancdavis]

This would also help me a lot. I’ve currently copied the api-endpoints.ts file to my project and exported all types, and it’s made type checking a much more pleasant process.

Another related suggestion is to use types for all objects, rather than embedding objects. For example, instead of this:

export type BlockObjectResponse =
  | {
      type: "paragraph";
      // ...
    }
  | {
      type: "heading_1";
      // ...
    }
  // ...

Do this:

export type ParagraphBlockResponse = {
  type: "paragraph";
  // ...
}

export type Heading1BlockResponse = {
  type: "heading_1";
  // ...
}

export type BlockObjectResponse = {
  ParagraphBlockResponse | Heading1BlockResponse | // ...
}

This way, if I’ve done the checking and am confident I’m working with a paragraph, then I can take advantage of the types this library is generating. Otherwise, I’m getting almost no benefit from the typings.

---

We do have the option to use the Extract utility, but it’s not a great experience. Here’s an example that demonstrates the complexity of this process.

[wcauchois]

Hi, I recently made some changes to name many more response types and export them from this package in #319, so I am going to close this issue. These changes are available in version 2.1.0 of the SDK.

Note that I have not exported all types per the request from this issue, but every exported type requires a stability guarantee from us so I’ve been somewhat judicious. You can still extract types using TypeScript helpers like type indexes and Extract<>, where necessary. If there are any more specific issues around types please open a new GitHub issue, thank you!