Obsidian Schemas

1
import z from "zod";
2

3
const CorePropertiesSchema = z.object({
4
  tags: z
5
    .array(z.string())
6
    .nullish()
7
    .describe(
8
      "Tags are keywords or topics that help you quickly find the notes you want.",
9
    ),
10
  aliases: z
11
    .array(z.string())
12
    .describe("An alias is an alternative name for a note."),
13
  cssclasses: z
14
    .array(z.string())
15
    .describe("Allows you to style individual notes using CSS snippets."),
16
});
17

18
const PublishPropertiesSchema = z.object({
19
  publish: z.boolean().optional().describe("Automatically include it for publishing as either a new or changed note."),
20
  permalink: z.string().optional().describe("Permanent link for the document"),
21
  description: z
22
    .string()
23
    .optional()
24
    .describe("Document description for SEO/previews"),
25
  image: z.string().optional().describe("Featured image URL"),
26
  cover: z.string().optional().describe("Cover image URL"),
27
});
28

29
const DocumentSchema = z
30
  .object({
31
    ...CorePropertiesSchema.shape,
32
    ...PublishPropertiesSchema.shape,
33
  })
34
  .describe("Obsidian document frontmatter schema");
35

36
const ObsidianSchemas = {
37
  Document: DocumentSchema,
38
};
39

40
type Document = z.infer<typeof DocumentSchema>;
41

42
declare namespace Obsidian {
43
  export type { Document };
44
}
45

46
export type { Document, Obsidian };
47
export { DocumentSchema, ObsidianSchemas };
48
export default ObsidianSchemas;