@kulupu-linku/sona 0.3.7 → 2.0.2

package/dist/v2-CDtbJFxV.js

@@ -0,0 +1,194 @@
+import { a as Score, i as OptionalDate, n as Date, o as UsageCategory, r as Era, s as WritingSystem, t as Book } from "./utils-Z1o5sWsW.js";
+import { z } from "zod/v4";
+
+//#region src/lib/v2/index.ts
+const CAN_HAVE_KU_DATA = [
+	"pu",
+	"ku suli",
+	"ku lili"
+];
+const NO_PU_VERBATIM = ["ali"];
+const NO_KU_DATA = [
+	"e",
+	"ku",
+	"kulijo",
+	"li",
+	"su",
+	"wasoweli",
+	"ju",
+	"kalamARR",
+	"lu",
+	"neja",
+	"nu",
+	"polinpin",
+	"suke",
+	"toma",
+	"tuli",
+	"u",
+	"umesu"
+];
+const Id = z.string().min(1).describe("A unique identifier for an object in Linku. Generally named after the object.");
+const Ref = Id.describe("The ID of an object related to this one.");
+const Refs = z.array(Id).describe("The IDs of one or more objects related to this one.");
+Ref.optional();
+const Author = z.string().min(1);
+const Authors = z.array(Author).describe("The name or names of those involved in authoring this object (if known)");
+const Usage = z.record(Date, Score).describe("The percentage of respondents to an annual Linku survey who report to use this object.");
+const Ligature = z.string().min(1);
+const Ligatures = z.array(Ligature).optional();
+const UcsurCodepoint = z.string().regex(/^U\+[\da-fA-F]{4,6}$/g).optional().describe("A UCSUR codepoint, as defined in https://www.kreativekorp.com/ucsur/charts/sitelen.html");
+z.string().optional().describe("A Unicode codepoint, yet to be defined.");
+const SeeAlso = Refs.describe("A list of object IDs of objects related to this one.");
+const Source = z.string().describe("The source or origin of this object, often a URL.");
+const Resource = z.url().describe("A URL pointing to some external resource.");
+const Deprecated = z.boolean().describe("Whether the object is considered deprecated by its author(s).");
+const Audio = z.object({
+	author: Author.describe("The author of the audio file in `link`."),
+	link: Resource.describe("A link to the audio file for the word, pronounced by `author`.")
+}).describe("Audio files of the words pronounced out loud");
+const Video = z.object({
+	gif: Resource.describe("A link to a gif of the sign being signed."),
+	mp4: Resource.describe("a link to an mp4 of the sign being signed.")
+}).describe("Videos of the sign being performed, by format.");
+const SignWriting = z.object({
+	fsw: z.string().min(1).describe("The [Formal SignWriting](https://en.wikipedia.org/wiki/SignWriting) representation of the sign."),
+	swu: z.string().min(1).describe("The [SignWriting with Unicode](https://en.wikipedia.org/wiki/SignWriting) representation of the sign.")
+}).describe("Scripts for representing a sign as characters.");
+const Commentary = z.string().describe("Localized commentary on the parent, such as a word or glyph");
+const Definition = z.string().min(1).describe("Localized definition on the parent, such as a word or luka pona sign");
+const Etymology = z.string().describe("Localized etymology information for the parent, such as a word or glyph");
+const Names = z.array(z.string().describe("A name this sitelen pona glyph is known by.")).describe("A list of names used to refer to this sitelen pona glyph");
+const Icons = z.string().describe("Localized descriptions of the thing a sign represents.");
+const Parameters = 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.");
+const Word = z.object({
+	id: Id.describe("A unique identifier for the word. May have an integer to distinguish words with the same spelling but distinct coinings."),
+	word: z.string().min(1).describe(`The latin alphabet representation of the word.`),
+	author_verbatim: z.string().optional().describe("The author's original definition, taken verbatim in their words"),
+	author_source: Source.optional().describe("The source or origin of this glyph, often a URL."),
+	book: Book.describe("Which official Toki Pona book was this word featured in, if any."),
+	coined_era: Era.describe("The period of time in which this word was coined, relative to the publication of the first two official Toki Pona books"),
+	creation_date: OptionalDate.describe("When this word was coined, to precision known."),
+	author: Authors.describe("The name or names of those involved in creating this word."),
+	ku_data: z.record(z.string().min(1).describe("A possible translation of the word into English, as listed in the Toki Pona dictionary."), Score.describe("The percentage of Toki Pona Dictionary survey respondents who report this translation as accurate to their usage.")).optional().describe("The usage data of this word, as described in the Toki Pona Dictionary."),
+	parent_id: Ref.optional().describe("The most widely used word which is considered to be an exact synonym for this word."),
+	see_also: SeeAlso.describe("The IDs of words related to this one."),
+	resources: z.object({
+		sona_pona: Resource.optional().describe("A link to the word's page on sona.pona.la, a Toki Pona wiki. May redirect for words with references but no dedicated page."),
+		lipamanka_semantic: Resource.optional().describe("A link to lipamanka's description of the word's semantic space.")
+	}).describe("Non-Linku resources related to the specific word, such as wiki links."),
+	representations: z.object({
+		sitelen_emosi: z.emoji().min(1).optional().describe("The sitelen emosi representation of this word, a script for writing Toki Pona using emoji"),
+		sitelen_jelo: z.array(z.emoji().min(1)).min(1).optional().describe("One or more example emojis for how the word can be written in sitelen jelo"),
+		ligatures: Ligatures.describe("A list of sitelen Lasina representations of the word, used by ligature fonts to visually convert latin characters into sitelen pona"),
+		sitelen_sitelen: Resource.optional().describe("A URL pointing to an image of this word's sitelen sitelen hieroglyphic block"),
+		ucsur: UcsurCodepoint.describe("The UCSUR codepoint for this word.")
+	}).describe("Ways of representing this word via text/computers"),
+	source_language: z.string().min(1).describe("The language this word originated from"),
+	usage_category: UsageCategory.describe("The word's usage category, derived from the data of the annual Linku word survey."),
+	deprecated: Deprecated.describe("Whether this word is considered deprecated by its author(s)."),
+	audio: z.array(Audio),
+	pu_verbatim: z.object({
+		en: Definition.describe("The word's definition in the English edition of Toki Pona: The Language of Good"),
+		fr: Definition.describe("The word's definition in the French edition of Toki Pona: The Language of Good"),
+		de: Definition.describe("The word's definition in the German edition of Toki Pona: The Language of Good"),
+		eo: Definition.describe("The word's definition in the Esperanto edition of Toki Pona: The Language of Good")
+	}).optional().describe("The definition of the word in specific language editions of Toki Pona: The Language of Good"),
+	usage: Usage.describe("The percentage of respondents to the annual Linku word survey who report to use this word, by the date of the survey."),
+	glyph_ids: Refs.describe("The IDs of all sitelen pona glyphs which represent the word. The usage category of each fetched glyph may be used to show or hide glyphs."),
+	primary_glyph_id: Ref.min(3).optional().describe("The ID of the glyph most commonly used to represent this word in sitelen pona."),
+	image: Resource.optional().describe("Link to a PNG of the primary sitelen pona glyph for this word."),
+	svg: Resource.optional().describe("Link to an SVG of the primary sitelen pona glyph for this word."),
+	translations: z.object({
+		commentary: Commentary.describe("Localized commentary on this word, such as history, clarifications, or trivia."),
+		etymology: Etymology.describe("Localized etymology of this word."),
+		definition: Definition.describe("Localized definition of this word.")
+	})
+}).describe("General info on a Toki Pona word").refine(({ id, primary_glyph_id, glyph_ids, usage_category }) => usage_category !== "sandbox" ? primary_glyph_id && primary_glyph_id.length >= 3 && glyph_ids.length >= 1 : true).refine(({ id, book, pu_verbatim }) => book === "pu" && !NO_PU_VERBATIM.includes(id) ? pu_verbatim !== void 0 : true).refine(({ id, book, ku_data }) => CAN_HAVE_KU_DATA.includes(book) && !NO_KU_DATA.includes(id) ? ku_data !== void 0 : true);
+const Glyph = z.object({
+	id: Id.describe("A unique identifier for the glyph. Named after its primary word and numbered in order of coining or attestation."),
+	word: z.string().min(1).describe("The toki pona word which is written with this glyph."),
+	word_id: Id.describe("The Linku id of the toki pona word this glyph writes."),
+	usage_category: UsageCategory.describe("The glyph's usage category, derived from the data of the annual Linku glyph survey."),
+	author: Authors.describe("The name or names of those involved in creating this glyph."),
+	author_source: Source.optional().describe("The source or origin of this glyph, often a URL."),
+	creation_date: OptionalDate.describe("When this glyph was created, to precision known"),
+	see_also: SeeAlso.describe("A list of related glyphs by ID"),
+	primary: z.boolean().describe("Whether this glyph is the main glyph used to write the toki pona word in `word`"),
+	parent_id: Ref.optional().describe("The primary glyph which this glyph is considered to share its form with."),
+	deprecated: Deprecated.describe("Whether this glyph is considered deprecated by its author(s)."),
+	image: Resource.optional().describe("A URL to an image of the sitelen pona glyph."),
+	svg: Resource.optional().describe("A URL to an SVG of the sitelen pona glyph."),
+	ligature: Ligature.optional().describe("The specific numerical ligature used to render this sitelen pona glyph."),
+	alias_ligatures: Ligatures.describe("All non-numerical ligature used to render this sitelen pona glyph."),
+	ucsur: UcsurCodepoint.describe("The UCSUR codepoint used to render this specific sitelen pona glyph."),
+	usage: Usage.describe("The percentage of respondents to the annual Linku word survey who report to use this glyph, by the date of the survey."),
+	translations: z.object({
+		commentary: Commentary.describe("Localized commentary on this glyph, such as history, clarifications, or trivia."),
+		etymology: Etymology.describe("Localized etymology of this glyph."),
+		names: Names
+	})
+});
+const Fingerspelling = z.object({
+	id: Id.describe("A unique name for the fingerspelling 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().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: SignWriting,
+	video: Video.optional(),
+	translations: z.object({ parameters: Parameters })
+}).describe("Info on a fingerspelling sign.");
+const Sign = Fingerspelling.extend({
+	definition: z.string().describe("The definition of the sign as a single toki pona word."),
+	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`."),
+	old_id: z.string().describe("Previous, malformed id for the sign."),
+	translations: z.object({
+		icons: Icons,
+		parameters: Parameters
+	})
+}).describe("Info on a Luka Pona sign");
+const Font = z.object({
+	id: Id.describe("The font's unique ID, identifying it among other fonts"),
+	author: Authors.describe("a list of this font's authors"),
+	features: z.array(z.string().min(1)).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: OptionalDate.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: Resource.optional().describe("a link to the font file published by the original author (not the mirror on the Linku Project's GitHub)"),
+		repo: Resource.optional().describe("a link to a web hosted repository of this font's source files (usually hosted on GitHub or GitLab)"),
+		webpage: Resource.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");
+const Language = z.object({
+	id: Id.min(2).describe("The language's code in Crowdin. Usually its 2 or 3 letter code."),
+	locale: Id.min(2).describe("The locale code corresponding to the language."),
+	direction: z.union([z.literal("ltr"), z.literal("rtl")]).describe("The direction of the language's script."),
+	name: z.object({
+		en: z.string().describe("The name of the language in English."),
+		endonym: z.string().describe("The name of the language in that language. Prefer if available."),
+		tok: z.string().optional().describe("The name of the language in Toki Pona.")
+	})
+});
+const Languages = z.record(Id, Language).describe("The languages offered by sona Linku.");
+const Fonts = z.record(Id, Font).describe("A raw data object containing all fonts data in Linku");
+const Words = z.record(Id, Word).describe("A raw data object containing dictionary info about Toki Pona words");
+const Glyphs = z.record(Id, Glyph).describe("A raw data object containing metadata about Sitelen Pona glyphs");
+const Signs = z.record(Id, Sign).describe("A raw data object containing information about Luka Pona signs");
+const Fingerspellings = z.record(Id, Fingerspelling).describe("A raw data object containing information about Luka Pona fingerspelling signs");
+
+//#endregion
+export { Glyph as a, Languages as c, Word as d, Words as f, Fonts as i, Sign as l, Fingerspellings as n, Glyphs as o, Font as r, Language as s, Fingerspelling as t, Signs as u };

package/generated/v2/fingerspelling.json

@@ -0,0 +1,124 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Info on a fingerspelling sign.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "description": "A unique name for the fingerspelling which is also a gloss.",
+      "type": "string",
+      "minLength": 1
+    },
+    "is_two_handed": {
+      "description": "Whether the sign is two-handed or not.",
+      "type": "boolean"
+    },
+    "etymology": {
+      "description": "Unlocalized etymological values regarding this sign's origin",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "language": {
+            "description": "The language of the sign.",
+            "type": "string"
+          },
+          "sign": {
+            "description": "The name of the sign such that it could be found in a sign language dictionary.",
+            "type": "string"
+          }
+        },
+        "required": [
+          "language"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "signwriting": {
+      "description": "Scripts for representing a sign as characters.",
+      "type": "object",
+      "properties": {
+        "fsw": {
+          "description": "The [Formal SignWriting](https://en.wikipedia.org/wiki/SignWriting) representation of the sign.",
+          "type": "string",
+          "minLength": 1
+        },
+        "swu": {
+          "description": "The [SignWriting with Unicode](https://en.wikipedia.org/wiki/SignWriting) representation of the sign.",
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": [
+        "fsw",
+        "swu"
+      ],
+      "additionalProperties": false
+    },
+    "video": {
+      "description": "Videos of the sign being performed, by format.",
+      "type": "object",
+      "properties": {
+        "gif": {
+          "description": "A link to a gif of the sign being signed.",
+          "$ref": "#/$defs/__schema0"
+        },
+        "mp4": {
+          "description": "a link to an mp4 of the sign being signed.",
+          "$ref": "#/$defs/__schema0"
+        }
+      },
+      "required": [
+        "gif",
+        "mp4"
+      ],
+      "additionalProperties": false
+    },
+    "translations": {
+      "type": "object",
+      "properties": {
+        "parameters": {
+          "description": "Partly localized descriptions of how a sign is signed.",
+          "type": "object",
+          "properties": {
+            "handshape": {
+              "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",
+              "type": "string"
+            },
+            "movement": {
+              "description": "The motion of the hand when signing.",
+              "type": "string"
+            },
+            "placement": {
+              "description": "The placement of the hand when signing.",
+              "type": "string"
+            },
+            "orientation": {
+              "description": "The orientation of the hand when signing.",
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "parameters"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "id",
+    "is_two_handed",
+    "etymology",
+    "signwriting",
+    "translations"
+  ],
+  "additionalProperties": false,
+  "$defs": {
+    "__schema0": {
+      "description": "A URL pointing to some external resource.",
+      "type": "string",
+      "format": "uri"
+    }
+  }
+}

package/generated/v2/fingerspellings.json

@@ -0,0 +1,135 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "A raw data object containing information about Luka Pona fingerspelling signs",
+  "type": "object",
+  "propertyNames": {
+    "$ref": "#/$defs/__schema0"
+  },
+  "additionalProperties": {
+    "description": "Info on a fingerspelling sign.",
+    "type": "object",
+    "properties": {
+      "id": {
+        "description": "A unique name for the fingerspelling which is also a gloss.",
+        "$ref": "#/$defs/__schema0"
+      },
+      "is_two_handed": {
+        "description": "Whether the sign is two-handed or not.",
+        "type": "boolean"
+      },
+      "etymology": {
+        "description": "Unlocalized etymological values regarding this sign's origin",
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "language": {
+              "description": "The language of the sign.",
+              "type": "string"
+            },
+            "sign": {
+              "description": "The name of the sign such that it could be found in a sign language dictionary.",
+              "type": "string"
+            }
+          },
+          "required": [
+            "language"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "signwriting": {
+        "description": "Scripts for representing a sign as characters.",
+        "type": "object",
+        "properties": {
+          "fsw": {
+            "description": "The [Formal SignWriting](https://en.wikipedia.org/wiki/SignWriting) representation of the sign.",
+            "type": "string",
+            "minLength": 1
+          },
+          "swu": {
+            "description": "The [SignWriting with Unicode](https://en.wikipedia.org/wiki/SignWriting) representation of the sign.",
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "required": [
+          "fsw",
+          "swu"
+        ],
+        "additionalProperties": false
+      },
+      "video": {
+        "description": "Videos of the sign being performed, by format.",
+        "type": "object",
+        "properties": {
+          "gif": {
+            "description": "A link to a gif of the sign being signed.",
+            "$ref": "#/$defs/__schema1"
+          },
+          "mp4": {
+            "description": "a link to an mp4 of the sign being signed.",
+            "$ref": "#/$defs/__schema1"
+          }
+        },
+        "required": [
+          "gif",
+          "mp4"
+        ],
+        "additionalProperties": false
+      },
+      "translations": {
+        "type": "object",
+        "properties": {
+          "parameters": {
+            "description": "Partly localized descriptions of how a sign is signed.",
+            "type": "object",
+            "properties": {
+              "handshape": {
+                "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",
+                "type": "string"
+              },
+              "movement": {
+                "description": "The motion of the hand when signing.",
+                "type": "string"
+              },
+              "placement": {
+                "description": "The placement of the hand when signing.",
+                "type": "string"
+              },
+              "orientation": {
+                "description": "The orientation of the hand when signing.",
+                "type": "string"
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "parameters"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "required": [
+      "id",
+      "is_two_handed",
+      "etymology",
+      "signwriting",
+      "translations"
+    ],
+    "additionalProperties": false
+  },
+  "$defs": {
+    "__schema0": {
+      "description": "A unique identifier for an object in Linku. Generally named after the object.",
+      "type": "string",
+      "minLength": 1
+    },
+    "__schema1": {
+      "description": "A URL pointing to some external resource.",
+      "type": "string",
+      "format": "uri"
+    }
+  }
+}

package/generated/v2/font.json

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