@kulupu-linku/sona 0.1.0

package/dist/index.js

@@ -0,0 +1,210 @@
+import {
+  Book,
+  CoinedEra,
+  UsageCategory,
+  WritingSystem,
+  YearMonth
+} from "./chunk-T34XQGQK.js";
+
+// src/index.ts
+import { z } from "zod";
+var Word = z.object({
+  author_verbatim: z.string().describe("The author's original definition, taken verbatim in their words"),
+  author_verbatim_source: z.string().describe("Where the author's original definition is located (usually Discord)"),
+  book: Book.describe("Which official Toki Pona book was this word featured in, if any."),
+  coined_era: CoinedEra.or(z.literal("")).describe(
+    "When this word was coined (relative to the publication dates of the official Toki Pona books, if known)"
+  ),
+  coined_year: z.string().describe("The year when this word was coined (if known)"),
+  creator: z.array(z.string()).describe("The person who created this word (if known)"),
+  ku_data: z.record(z.number().min(0).max(100)).optional().describe(
+    "The usage data of the word as described in ku (the official Toki Pona dictionary)"
+  ),
+  see_also: z.array(z.string()).describe("A list of related words"),
+  representations: z.object({
+    sitelen_emosi: z.string().emoji().or(z.literal("")).describe(
+      "The sitelen emosi representation of this word, a script for writing Toki Pona using emoji"
+    ),
+    sitelen_pona: z.array(z.string()).describe(
+      "A list of sitelen Lasina representations of this word, to be converted into sitelen pona glyphs"
+    ),
+    sitelen_sitelen: z.string().url().or(z.literal("")).describe("A URL pointing to an image of this word's sitelen sitelen hieroglyphic block"),
+    ucsur: z.string().regex(/^U\+[\da-fA-F]{4,6}$/g).or(z.literal("")).describe(
+      "The word's UCSUR codepoint, as defined in https://www.kreativekorp.com/ucsur/charts/sitelen.html"
+    )
+  }).describe("Ways of representing this word in the real world, via text/computers"),
+  source_language: z.string().describe("The language this word originated from"),
+  usage_category: UsageCategory.describe(
+    "The word's usage category, according to a survey performed by the Linku Project"
+  ),
+  word: z.string().describe(`The word's actual text, in case of a word with multiple definitions (like "we")`),
+  etymology: z.array(
+    z.object({
+      word: z.string().optional().describe(
+        "One of the root words of this word, as written out in its language of origin"
+      ),
+      alt: z.string().optional().describe(`A latinized representation of the "word" field`)
+    })
+  ).describe("Unlocalized etymological values regarding this word's origin"),
+  audio: z.object({
+    jan_lakuse: z.string().url().optional().describe(
+      "jan Lakuse's pronounciation of the word, made for jan Sonja's Memrise course: https://archive.org/details/toki-pona-audio-by-jan-lakuse"
+    ),
+    kala_asi: z.string().url().describe("kala Asi's pronounciation of the word, made for the Linku Project")
+  }).describe("Audio files of the words pronounced out loud"),
+  pu_verbatim: z.object({
+    en: z.string().describe("The original definition in the English version of pu"),
+    fr: z.string().describe("The original definition in the French version of pu"),
+    de: z.string().describe("The original definition in the German version of pu"),
+    eo: z.string().describe("The original definition in the Esperanto version of pu")
+  }).optional().describe("The original definition of the word in pu, the first official Toki Pona book"),
+  recognition: z.record(
+    z.string().regex(/^20\d{2}-(0[1-9]|1[0-2])$/g),
+    z.number().min(0).max(100)
+  ).describe(
+    "The percentage of people in the Toki Pona community who recognize this word, according to surveys performed by the Linku Project"
+  )
+}).describe("General info on a Toki Pona word");
+var CommentaryTranslation = z.record(z.string()).describe("Localized commentary regarding Toki Pona words");
+var DefinitionTranslation = z.record(z.string().min(1)).describe("Localized definitions of Toki Pona words");
+var SitelenPonaTranslation = z.record(z.string()).describe("Localized descriptions of the origins of the sitelen pona glyphs for Toki Pona words");
+var EtymologyTranslation = z.record(
+  z.array(
+    z.object({
+      definition: z.string().optional().describe("The localized definition of the root word in its origin language"),
+      language: z.string().describe("The localized name of the language this word originated from")
+    })
+  )
+).describe("Localized etymological values for Toki Pona words");
+var Sign = z.object({
+  definition: z.string().describe("The definition of the sign as a single toki pona word."),
+  id: z.string().describe("A globally unique name for the sign which is also a gloss."),
+  is_two_handed: z.boolean().describe("Whether the sign is two-handed or not."),
+  new_gloss: z.string().describe("The more recent, preferred gloss for this sign."),
+  old_gloss: z.string().describe("The older gloss for this sign, similar to `id`."),
+  etymology: z.array(
+    z.object({
+      language: z.string().describe("The language of the sign."),
+      sign: z.string().optional().describe(
+        "The name of the sign such that it could be found in a sign language dictionary."
+      )
+    })
+  ).describe("Unlocalized etymological values regarding this sign's origin"),
+  signwriting: z.object({
+    fsw: z.string().describe(
+      "The [Formal SignWriting](https://en.wikipedia.org/wiki/SignWriting) representation of the sign."
+    ),
+    swu: z.string().describe(
+      "The [SignWriting with Unicode](https://en.wikipedia.org/wiki/SignWriting) representation of the sign."
+    )
+  }).describe("Scripts for representing a sign as characters."),
+  video: z.object({
+    gif: z.string().describe("A link to a gif of the sign being signed."),
+    mp4: z.string().describe("a link to an mp4 of the sign being signed.")
+  }).describe("Videos of the sign being performed, by format.")
+}).describe("Unlocalized info on a Luka Pona sign");
+var FingerspellingSign = z.object({
+  id: z.string().describe("A globally unique name for the sign which is also a gloss."),
+  is_two_handed: z.boolean().describe("Whether the sign is two-handed or not."),
+  etymology: z.array(
+    z.object({
+      language: z.string().describe("The language of the sign."),
+      sign: z.string().describe(
+        "The name of the sign such that it could be found in a sign language dictionary."
+      )
+    })
+  ).describe("Unlocalized etymological values regarding this sign's origin"),
+  signwriting: z.object({
+    fsw: z.string().describe("The Formal Sign Writing representation of the sign."),
+    swu: z.string().describe("The Sign Writing with Unicode representation of hte sign.")
+  }).describe("Scripts for representing a sign as characters."),
+  video: z.object({
+    gif: z.string().optional().describe("A link to a gif of the sign being signed."),
+    mp4: z.string().optional().describe("a link to an mp4 of the sign being signed.")
+  }).describe("Videos of the sign being performed, by format.")
+}).describe("Unlocalized info on a fingerspelling sign.");
+var ParametersTranslation = z.record(
+  z.object({
+    handshape: z.string().optional().describe(
+      "The shape of the hand when signing, identified by its name in ASL. Should not be translated in any language other than Toki Pona"
+    ),
+    movement: z.string().optional().describe("The motion of the hand when signing."),
+    placement: z.string().optional().describe("The placement of the hand when signing."),
+    orientation: z.string().optional().describe("The orientation of the hand when signing.")
+  })
+).describe("Partly localized descriptions of how a sign is signed.");
+var IconTranslation = z.record(z.string().min(1)).describe("Localized descriptions of the thing a sign represents.");
+var Font = z.object({
+  creator: z.array(z.string()).describe("a list of this font's creators"),
+  features: z.array(z.string()).describe("a list of features this font supports"),
+  filename: z.string().regex(/^(?:.+\.(ttf|otf|woff2|woff))?$/).describe("the name of the file this font is stored in at https://github.com/lipu-linku/ijo"),
+  last_updated: YearMonth.optional().describe("the rough date of this font's last update"),
+  license: z.string().describe("an SPDX expression describing this font's license: https://spdx.org/licenses/"),
+  ligatures: z.boolean().describe("whether this font supports ligatures"),
+  name: z.string().min(1).describe("this font's name"),
+  style: z.string().min(1).describe("the general style of this font"),
+  ucsur: z.boolean().describe(
+    "whether this font conforms to the UCSUR standard: https://www.kreativekorp.com/ucsur/charts/sitelen.html"
+  ),
+  version: z.string().describe("the current version of this font"),
+  writing_system: WritingSystem.describe("the writing system this font uses as its script"),
+  links: z.object({
+    fontfile: z.string().url().optional().describe(
+      "a link to the font file published by the original author (not the mirror on the Linku Project's GitHub)"
+    ),
+    repo: z.string().url().optional().describe(
+      "a link to a web hosted repository of this font's source files (usually hosted on GitHub or GitLab)"
+    ),
+    webpage: z.string().url().optional().describe(
+      "a link to this font's home page, usually showcasing its features and usage/installation"
+    )
+  })
+}).describe("Info on a font for Toki Pona");
+var Words = z.record(
+  Word.extend({
+    translations: z.record(
+      z.object({
+        commentary: CommentaryTranslation.valueSchema,
+        definitions: DefinitionTranslation.valueSchema,
+        etymology: EtymologyTranslation.valueSchema,
+        sp_etymology: SitelenPonaTranslation.valueSchema
+      })
+    )
+  })
+).describe("A raw data object containing dictionary info about Toki Pona words");
+var Sandbox = Words.describe(
+  "A raw data object containing dictionary info about Toki Pona sandbox"
+);
+var Signs = z.record(
+  Sign.extend({
+    translations: z.record(
+      z.object({
+        parameters: ParametersTranslation.valueSchema,
+        icons: IconTranslation.valueSchema
+      })
+    )
+  })
+).describe("A raw data object containing information about Luka Pona signs");
+var Fingerspelling = z.record(
+  FingerspellingSign.extend({
+    translations: z.record(z.object({ parameters: ParametersTranslation.valueSchema }))
+  })
+).describe("A raw data object containing information about Luka Pona fingerspelling signs");
+var Fonts = z.record(Font).describe("A raw data object containing all the fonts data in sona");
+export {
+  CommentaryTranslation,
+  DefinitionTranslation,
+  EtymologyTranslation,
+  Fingerspelling,
+  FingerspellingSign,
+  Font,
+  Fonts,
+  IconTranslation,
+  ParametersTranslation,
+  Sandbox,
+  Sign,
+  Signs,
+  SitelenPonaTranslation,
+  Word,
+  Words
+};

package/dist/utils.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+
+declare const Book: z.ZodUnion<[z.ZodLiteral<"pu">, z.ZodLiteral<"ku suli">, z.ZodLiteral<"ku lili">, z.ZodLiteral<"none">]>;
+type Book = z.infer<typeof Book>;
+declare const CoinedEra: z.ZodUnion<[z.ZodLiteral<"pre-pu">, z.ZodLiteral<"post-pu">, z.ZodLiteral<"post-ku">]>;
+type CoinedEra = z.infer<typeof CoinedEra>;
+declare const UsageCategory: z.ZodUnion<[z.ZodLiteral<"core">, z.ZodLiteral<"widespread">, z.ZodLiteral<"common">, z.ZodLiteral<"uncommon">, z.ZodLiteral<"rare">, z.ZodLiteral<"obscure">]>;
+type UsageCategory = z.infer<typeof UsageCategory>;
+declare const YearMonth: z.ZodType<`20${number}-01` | `20${number}-02` | `20${number}-03` | `20${number}-04` | `20${number}-05` | `20${number}-06` | `20${number}-07` | `20${number}-08` | `20${number}-09` | `20${number}-10` | `20${number}-11` | `20${number}-12`, z.ZodTypeDef, `20${number}-01` | `20${number}-02` | `20${number}-03` | `20${number}-04` | `20${number}-05` | `20${number}-06` | `20${number}-07` | `20${number}-08` | `20${number}-09` | `20${number}-10` | `20${number}-11` | `20${number}-12`>;
+declare const WritingSystem: z.ZodEnum<["sitelen pona", "sitelen sitelen", "alphabet", "syllabary", "logography", "tokiponido alphabet", "tokiponido syllabary", "tokiponido logography"]>;
+type WritingSystem = z.infer<typeof WritingSystem>;
+
+export { Book, CoinedEra, UsageCategory, WritingSystem, YearMonth };

package/dist/utils.js

@@ -0,0 +1,14 @@
+import {
+  Book,
+  CoinedEra,
+  UsageCategory,
+  WritingSystem,
+  YearMonth
+} from "./chunk-T34XQGQK.js";
+export {
+  Book,
+  CoinedEra,
+  UsageCategory,
+  WritingSystem,
+  YearMonth
+};

package/generated/commentary_translation.json

@@ -0,0 +1,13 @@
+{
+  "$ref": "#/definitions/commentary_translation",
+  "definitions": {
+    "commentary_translation": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      },
+      "description": "Localized commentary regarding Toki Pona words"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/generated/definition_translation.json

@@ -0,0 +1,14 @@
+{
+  "$ref": "#/definitions/definition_translation",
+  "definitions": {
+    "definition_translation": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string",
+        "minLength": 1
+      },
+      "description": "Localized definitions of Toki Pona words"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/generated/etymology_translation.json

@@ -0,0 +1,30 @@
+{
+  "$ref": "#/definitions/etymology_translation",
+  "definitions": {
+    "etymology_translation": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "definition": {
+              "type": "string",
+              "description": "The localized definition of the root word in its origin language"
+            },
+            "language": {
+              "type": "string",
+              "description": "The localized name of the language this word originated from"
+            }
+          },
+          "required": [
+            "language"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "description": "Localized etymological values for Toki Pona words"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/generated/fingerspelling.json

@@ -0,0 +1,123 @@
+{
+  "$ref": "#/definitions/fingerspelling",
+  "definitions": {
+    "fingerspelling": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "A globally unique name for the sign which is also a gloss."
+          },
+          "is_two_handed": {
+            "type": "boolean",
+            "description": "Whether the sign is two-handed or not."
+          },
+          "etymology": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "language": {
+                  "type": "string",
+                  "description": "The language of the sign."
+                },
+                "sign": {
+                  "type": "string",
+                  "description": "The name of the sign such that it could be found in a sign language dictionary."
+                }
+              },
+              "required": [
+                "language",
+                "sign"
+              ],
+              "additionalProperties": false
+            },
+            "description": "Unlocalized etymological values regarding this sign's origin"
+          },
+          "signwriting": {
+            "type": "object",
+            "properties": {
+              "fsw": {
+                "type": "string",
+                "description": "The Formal Sign Writing representation of the sign."
+              },
+              "swu": {
+                "type": "string",
+                "description": "The Sign Writing with Unicode representation of hte sign."
+              }
+            },
+            "required": [
+              "fsw",
+              "swu"
+            ],
+            "additionalProperties": false,
+            "description": "Scripts for representing a sign as characters."
+          },
+          "video": {
+            "type": "object",
+            "properties": {
+              "gif": {
+                "type": "string",
+                "description": "A link to a gif of the sign being signed."
+              },
+              "mp4": {
+                "type": "string",
+                "description": "a link to an mp4 of the sign being signed."
+              }
+            },
+            "additionalProperties": false,
+            "description": "Videos of the sign being performed, by format."
+          },
+          "translations": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "object",
+              "properties": {
+                "parameters": {
+                  "type": "object",
+                  "properties": {
+                    "handshape": {
+                      "type": "string",
+                      "description": "The shape of the hand when signing, identified by its name in ASL. Should not be translated in any language other than Toki Pona"
+                    },
+                    "movement": {
+                      "type": "string",
+                      "description": "The motion of the hand when signing."
+                    },
+                    "placement": {
+                      "type": "string",
+                      "description": "The placement of the hand when signing."
+                    },
+                    "orientation": {
+                      "type": "string",
+                      "description": "The orientation of the hand when signing."
+                    }
+                  },
+                  "additionalProperties": false
+                }
+              },
+              "required": [
+                "parameters"
+              ],
+              "additionalProperties": false
+            }
+          }
+        },
+        "required": [
+          "id",
+          "is_two_handed",
+          "etymology",
+          "signwriting",
+          "video",
+          "translations"
+        ],
+        "additionalProperties": false,
+        "description": "Unlocalized info on a fingerspelling sign."
+      },
+      "description": "A raw data object containing information about Luka Pona fingerspelling signs"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/generated/fingerspelling_sign.json

@@ -0,0 +1,84 @@
+{
+  "$ref": "#/definitions/fingerspelling_sign",
+  "definitions": {
+    "fingerspelling_sign": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "A globally unique name for the sign which is also a gloss."
+        },
+        "is_two_handed": {
+          "type": "boolean",
+          "description": "Whether the sign is two-handed or not."
+        },
+        "etymology": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "language": {
+                "type": "string",
+                "description": "The language of the sign."
+              },
+              "sign": {
+                "type": "string",
+                "description": "The name of the sign such that it could be found in a sign language dictionary."
+              }
+            },
+            "required": [
+              "language",
+              "sign"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Unlocalized etymological values regarding this sign's origin"
+        },
+        "signwriting": {
+          "type": "object",
+          "properties": {
+            "fsw": {
+              "type": "string",
+              "description": "The Formal Sign Writing representation of the sign."
+            },
+            "swu": {
+              "type": "string",
+              "description": "The Sign Writing with Unicode representation of hte sign."
+            }
+          },
+          "required": [
+            "fsw",
+            "swu"
+          ],
+          "additionalProperties": false,
+          "description": "Scripts for representing a sign as characters."
+        },
+        "video": {
+          "type": "object",
+          "properties": {
+            "gif": {
+              "type": "string",
+              "description": "A link to a gif of the sign being signed."
+            },
+            "mp4": {
+              "type": "string",
+              "description": "a link to an mp4 of the sign being signed."
+            }
+          },
+          "additionalProperties": false,
+          "description": "Videos of the sign being performed, by format."
+        }
+      },
+      "required": [
+        "id",
+        "is_two_handed",
+        "etymology",
+        "signwriting",
+        "video"
+      ],
+      "additionalProperties": false,
+      "description": "Unlocalized info on a fingerspelling sign."
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/generated/font.json

@@ -0,0 +1,111 @@
+{
+  "$ref": "#/definitions/font",
+  "definitions": {
+    "font": {
+      "type": "object",
+      "properties": {
+        "creator": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "a list of this font's creators"
+        },
+        "features": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "a list of features this font supports"
+        },
+        "filename": {
+          "type": "string",
+          "pattern": "^(?:.+\\.(ttf|otf|woff2|woff))?$",
+          "description": "the name of the file this font is stored in at https://github.com/lipu-linku/ijo"
+        },
+        "last_updated": {
+          "type": "string",
+          "pattern": "^20\\d{2}-(0[1-9]|1[0-2])$",
+          "description": "the rough date of this font's last update"
+        },
+        "license": {
+          "type": "string",
+          "description": "an SPDX expression describing this font's license: https://spdx.org/licenses/"
+        },
+        "ligatures": {
+          "type": "boolean",
+          "description": "whether this font supports ligatures"
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "this font's name"
+        },
+        "style": {
+          "type": "string",
+          "minLength": 1,
+          "description": "the general style of this font"
+        },
+        "ucsur": {
+          "type": "boolean",
+          "description": "whether this font conforms to the UCSUR standard: https://www.kreativekorp.com/ucsur/charts/sitelen.html"
+        },
+        "version": {
+          "type": "string",
+          "description": "the current version of this font"
+        },
+        "writing_system": {
+          "type": "string",
+          "enum": [
+            "sitelen pona",
+            "sitelen sitelen",
+            "alphabet",
+            "syllabary",
+            "logography",
+            "tokiponido alphabet",
+            "tokiponido syllabary",
+            "tokiponido logography"
+          ],
+          "description": "the writing system this font uses as its script"
+        },
+        "links": {
+          "type": "object",
+          "properties": {
+            "fontfile": {
+              "type": "string",
+              "format": "uri",
+              "description": "a link to the font file published by the original author (not the mirror on the Linku Project's GitHub)"
+            },
+            "repo": {
+              "type": "string",
+              "format": "uri",
+              "description": "a link to a web hosted repository of this font's source files (usually hosted on GitHub or GitLab)"
+            },
+            "webpage": {
+              "type": "string",
+              "format": "uri",
+              "description": "a link to this font's home page, usually showcasing its features and usage/installation"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "creator",
+        "features",
+        "filename",
+        "license",
+        "ligatures",
+        "name",
+        "style",
+        "ucsur",
+        "version",
+        "writing_system",
+        "links"
+      ],
+      "additionalProperties": false,
+      "description": "Info on a font for Toki Pona"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}