Zod integration and nullable values for the schema

[Nils-Kolvenbach]

I am currently exploring options to implement search functionality for elek.io - which is a file based CMS that runs on your local computer instead of a server. Orama seems to be the best fit yet (thanks for all your work). But I am running into some problems trying to implement it.

Schema duplication

Since orama uses it's own schema and I am using zod I have to duplicate my schemas. Of cause orama cannot possibly support all schema validation libraries out there. But maybe someone has an idea how to improve on this?

Zod:

const assetSchema = z.object({
  id: uuidSchema,
  language: supportedLanguageSchema,
  objectType: z.literal(objectTypeSchema.Enum.asset),
  name: z.string(),
  description: z.string(),
  extension: supportedAssetExtensionSchema,
  mimeType: supportedAssetMimeTypeSchema,
  size: z.number(),
  absolutePath: z.string(),
  created: z.number(),
  updated: z.number().nullable(),
});

Orama:

const asseSchema = {
  id: 'string',
  language: 'enum',
  objectType: 'enum',
  name: 'string',
  description: 'string',
  extension: 'enum',
  mimeType: 'enum',
  size: 'number',
  absolutePath: 'string',
  created: 'number',
  updated: 'number',
} as const;

Weaker search result types

The result type of oramas search function is looser compared to my other functions returning a strict type inferred from it's zod schema. This would require me to use a type guard or to cast - or is there another solution I might not see right now?

Zod:

type Asset = {
  id: string;
  language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | ... 13 more ... | "zh";
  objectType: "asset";
  name: string;
  description: string;  
  extension: "json" | ... 11 more ... | "flac";
  mimeType: "image/avif" | ... 10 more ... | "audio/flac";
  size: number;
  absolutePath: string;
  created: number;
  updated: number | null;
}

Orama:

type Asset = Results<InternalTypedDocument<{
  id: string;
  language: string | number;
  objectType: string | number;
  name: string;
  description: string;
  extension: string | number;
  mimeType: string | number;
  size: number;
  absolutePath: string;
  created: number;
  updated: number;
}>>

Nullable values do not seem to be supported

As you might have noticed, the type of updated is a number or null. There currently is no mention of nullable values in the documentation and I don't know how to handle this. I would like to have updated as a searchable value. Do I have to set it to undefined before inserting it into the orama db and then set it to null again after if the value is null?

Any feedback is appreciated and thanks in advance!