Type generation metadata

[Maryusz]

Hi,
when using type generation with

appwrite types [options] <output-directory>

which is the best way to obtain metadata like $id?

[SametDulger]

Hi Maryusz,

When using appwrite types to generate types, the tool primarily creates type definitions based on your database or API schemas, but it doesn’t automatically include metadata fields like $id in the generated types by default.

To include metadata such as $id in your types, here are some approaches:

Extend generated types manually:
After generating types, you can create your own TypeScript interfaces or types that extend the generated ones and add the $id field where needed. For example:

import { GeneratedType } from './generated-types';

interface ExtendedType extends GeneratedType {
  $id: string;
}

Check if your schema includes metadata:
Sometimes, metadata fields like $id are part of the data returned by the API but not defined in your schema. You might need to update your schema definitions in Appwrite to explicitly include these fields so the generator picks them up.

Use runtime typings:
If metadata fields are dynamic or not part of your schema, consider handling them at runtime, e.g., by defining utility types or guards that accommodate such properties.

Consult Appwrite documentation or feature requests:
The CLI or generator might evolve, so keep an eye on Appwrite’s docs or GitHub issues for updates or flags that allow metadata inclusion.