@kulupu-linku/sona 0.3.7 → 2.1.0

package/dist/lib/v1/client.mjs

@@ -0,0 +1,8 @@
+import { hc } from "hono/client";
+//#region src/lib/v1/client.ts
+const client = (args) => {
+	const { baseUrl = "https://api.linku.la", fetch = globalThis.fetch } = args ?? {};
+	return hc(baseUrl, { fetch });
+};
+//#endregion
+export { client };

package/dist/lib/v1/client.test.d.mts

@@ -0,0 +1,30 @@
+import { client } from "./client.mjs";
+import { d as LocalizedFingerspellingSign, f as LocalizedSign, g as Signs, i as Fingerspelling, l as Language, o as Font, p as LocalizedWord, s as Fonts, u as Languages, y as Words } from "../../index-nmyNJa57.mjs";
+import { ClientResponse } from "hono/client";
+import { Equal, Expect } from "hono/utils/types";
+
+//#region src/lib/v1/client.test.d.ts
+type ResponseType<F> = F extends {
+  $get: (...args: any[]) => Promise<ClientResponse<infer O>>;
+} ? O : never;
+type ClientType = ReturnType<typeof client>;
+type Result<T> = {
+  ok: true;
+  data: T;
+} | {
+  ok: false;
+  message: string;
+};
+type WordsTest = Expect<Equal<ResponseType<ClientType["v1"]["words"]>, Words>>;
+type WordTest = Expect<Equal<ResponseType<ClientType["v1"]["words"][":word"]>, Result<LocalizedWord>>>;
+type SignsTest = Expect<Equal<ResponseType<ClientType["v1"]["luka_pona"]["signs"]>, Signs>>;
+type SignTest = Expect<Equal<ResponseType<ClientType["v1"]["luka_pona"]["signs"][":sign"]>, Result<LocalizedSign>>>;
+type FingerspellingsTest = Expect<Equal<ResponseType<ClientType["v1"]["luka_pona"]["fingerspelling"]>, Fingerspelling>>;
+type FingerspellingTest = Expect<Equal<ResponseType<ClientType["v1"]["luka_pona"]["fingerspelling"][":sign"]>, Result<LocalizedFingerspellingSign>>>;
+type SandboxTest = Expect<Equal<ResponseType<ClientType["v1"]["sandbox"]>, Words>>;
+type FontsTest = Expect<Equal<ResponseType<ClientType["v1"]["fonts"]>, Fonts>>;
+type FontTest = Expect<Equal<ResponseType<ClientType["v1"]["fonts"][":font"]>, Result<Font>>>;
+type LanguagesTest = Expect<Equal<ResponseType<ClientType["v1"]["languages"]>, Languages>>;
+type LanguageTest = Expect<Equal<ResponseType<ClientType["v1"]["languages"][":language"]>, Result<Language>>>;
+//#endregion
+export { FingerspellingTest, FingerspellingsTest, FontTest, FontsTest, LanguageTest, LanguagesTest, SandboxTest, SignTest, SignsTest, WordTest, WordsTest };

package/dist/lib/v1/client.test.mjs

@@ -0,0 +1,2 @@
+import "./client.mjs";
+export {};

package/dist/lib/v1/index.d.mts

@@ -0,0 +1,2 @@
+import { A as WordKuData, C as LocalizedWordDefinition, D as SignVideo, E as SignEtymology, F as WordUsage, M as WordRepresentations, N as WordTranslation, O as SignWriting, P as WordTranslations, S as LocalizedWordCommentary, T as LocalizedWordSitelenEtymology, _ as SitelenPonaTranslation, a as FingerspellingSign, b as FontLinks, c as IconTranslation, d as LocalizedFingerspellingSign, f as LocalizedSign, g as Signs, h as Sign, i as Fingerspelling, j as WordPuVerbatim, k as WordAudio, l as Language, m as ParametersTranslation, n as DefinitionTranslation, o as Font, p as LocalizedWord, r as EtymologyTranslation, s as Fonts, t as CommentaryTranslation, u as Languages, v as Word, w as LocalizedWordEtymology, x as LocalizedSignParameters, y as Words } from "../../index-nmyNJa57.mjs";
+export { CommentaryTranslation, DefinitionTranslation, EtymologyTranslation, Fingerspelling, FingerspellingSign, Font, FontLinks, Fonts, IconTranslation, Language, Languages, LocalizedFingerspellingSign, LocalizedSign, LocalizedSignParameters, LocalizedWord, LocalizedWordCommentary, LocalizedWordDefinition, LocalizedWordEtymology, LocalizedWordSitelenEtymology, ParametersTranslation, Sign, SignEtymology, SignVideo, SignWriting, Signs, SitelenPonaTranslation, Word, WordAudio, WordKuData, WordPuVerbatim, WordRepresentations, WordTranslation, WordTranslations, WordUsage, Words };

package/dist/lib/v1/index.mjs

@@ -0,0 +1,137 @@
+import { Book, CoinedEra, UsageCategory, WritingSystem } from "./utils.mjs";
+import { z } from "zod/v4";
+//#region src/lib/v1/index.ts
+const YearMonth = z.string().regex(/^20\d{2}-(0[1-9]|1[0-2])$/g);
+const Word = z.object({
+	id: z.string().min(1).describe(`A unique identifier for the word. Usually the word but may have an integer added in case of a word with multiple definitions (like "we")`),
+	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.string().min(1).describe("A translation of the word into English proposed in ku"), z.number().min(0).max(100).describe("The percentage of ku survey respondents who report this translation as accurate to their usage.")).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"),
+	resources: z.object({
+		sona_pona: z.string().url().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: z.string().url().optional().describe("A link to lipamanka's description of the word's semantic space.")
+	}).optional().describe("Non-Linku resources related to the specific word, such as wiki links."),
+	representations: z.object({
+		sitelen_emosi: z.string().emoji().optional().describe("The sitelen emosi representation of this word, a script for writing Toki Pona using emoji"),
+		sitelen_jelo: z.array(z.string().emoji()).min(1).optional().describe("One or more example emojis for how the word can be written in sitelen jelo"),
+		ligatures: z.array(z.string().min(1)).optional().describe("A list of sitelen Lasina representations of the word, used by ligature fonts to visually convert latin characters into sitelen pona"),
+		sitelen_sitelen: z.string().url().optional().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).optional().describe("The word's UCSUR codepoint, as defined in https://www.kreativekorp.com/ucsur/charts/sitelen.html")
+	}).optional().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")`),
+	deprecated: z.boolean().describe("Whether or not the word is considered deprecated by its author."),
+	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.array(z.object({
+		author: z.string().describe("The author of the audio file in `link`."),
+		link: z.string().url().describe("A link to the audio file for the word, pronounced by `author`.")
+	}).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"),
+	usage: 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 use this word, according to surveys performed by the Linku Project")
+}).describe("General info on a Toki Pona word");
+const CommentaryTranslation = z.record(z.string().min(1), z.string()).describe("Localized commentary regarding Toki Pona words");
+const DefinitionTranslation = z.record(z.string().min(1), z.string().min(1)).describe("Localized definitions of Toki Pona words");
+const SitelenPonaTranslation = z.record(z.string().min(1), z.string()).describe("Localized descriptions of the origins of the sitelen pona glyphs for Toki Pona words");
+const EtymologyTranslation = z.record(z.string().min(1), 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");
+const 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().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 Luka Pona sign");
+const 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.");
+const ParametersTranslation = z.record(z.string().min(1), 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 IconTranslation = z.record(z.string().min(1), z.string()).describe("Localized descriptions of the thing a sign represents.");
+const Font = z.object({
+	id: z.string().min(1).describe("The font's unique ID, identifying it among other fonts"),
+	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");
+const Words = z.record(z.string().min(1), Word.extend({ translations: z.record(z.string(), z.object({
+	commentary: CommentaryTranslation.valueType,
+	definition: DefinitionTranslation.valueType,
+	etymology: EtymologyTranslation.valueType,
+	sp_etymology: SitelenPonaTranslation.valueType
+})) })).describe("A raw data object containing dictionary info about Toki Pona words");
+const Signs = z.record(z.string().min(1), Sign.extend({ translations: z.record(z.string(), z.object({
+	parameters: ParametersTranslation.valueType,
+	icons: IconTranslation.valueType
+})) })).describe("A raw data object containing information about Luka Pona signs");
+const Fingerspelling = z.record(z.string().min(1), FingerspellingSign.extend({ translations: z.record(z.string(), z.object({ parameters: ParametersTranslation.valueType })) })).describe("A raw data object containing information about Luka Pona fingerspelling signs");
+const Fonts = z.record(z.string(), Font).describe("A raw data object containing all the fonts data in sona");
+const Languages = z.record(z.string().min(2).describe("The language code used by Crowdin. Approximates 2 letter code -> 3 letter code."), z.object({
+	id: z.string().min(2).describe("The language code used by Crowdin. Approximates 2 letter code -> 3 letter code."),
+	locale: z.string().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."),
+		tok: z.string().optional().describe("The name of the language in Toki Pona."),
+		endonym: z.string().optional().describe("The name of the language in that language.")
+	})
+}).describe("The languages offered by sona Linku."));
+//#endregion
+export { CommentaryTranslation, DefinitionTranslation, EtymologyTranslation, Fingerspelling, FingerspellingSign, Font, Fonts, IconTranslation, Languages, ParametersTranslation, Sign, Signs, SitelenPonaTranslation, Word, Words };

package/dist/lib/v1/types.d.mts

@@ -0,0 +1,2 @@
+import { A as WordKuData, C as LocalizedWordDefinition, D as SignVideo, E as SignEtymology, F as WordUsage, M as WordRepresentations, N as WordTranslation, O as SignWriting, P as WordTranslations, S as LocalizedWordCommentary, T as LocalizedWordSitelenEtymology, b as FontLinks, j as WordPuVerbatim, k as WordAudio, w as LocalizedWordEtymology, x as LocalizedSignParameters } from "../../index-nmyNJa57.mjs";
+export { FontLinks, LocalizedSignParameters, LocalizedWordCommentary, LocalizedWordDefinition, LocalizedWordEtymology, LocalizedWordSitelenEtymology, SignEtymology, SignVideo, SignWriting, WordAudio, WordKuData, WordPuVerbatim, WordRepresentations, WordTranslation, WordTranslations, WordUsage };

package/dist/lib/v1/types.mjs

@@ -0,0 +1 @@
+export {};

package/dist/lib/v1/utils.d.mts

@@ -0,0 +1,26 @@
+import { A as WordKuData, C as LocalizedWordDefinition, D as SignVideo, E as SignEtymology, F as WordUsage, M as WordRepresentations, N as WordTranslation, O as SignWriting, P as WordTranslations, S as LocalizedWordCommentary, T as LocalizedWordSitelenEtymology, b as FontLinks, j as WordPuVerbatim, k as WordAudio, w as LocalizedWordEtymology, x as LocalizedSignParameters } from "../../index-nmyNJa57.mjs";
+import { z } from "zod/v4";
+
+//#region src/lib/v1/utils.d.ts
+declare const Book: z.ZodUnion<readonly [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<readonly [z.ZodLiteral<"pre-pu">, z.ZodLiteral<"post-pu">, z.ZodLiteral<"post-ku">]>;
+type CoinedEra = z.infer<typeof CoinedEra>;
+declare const UsageCategory: z.ZodUnion<readonly [z.ZodLiteral<"core">, z.ZodLiteral<"common">, z.ZodLiteral<"uncommon">, z.ZodLiteral<"obscure">, z.ZodLiteral<"sandbox">]>;
+type UsageCategory = z.infer<typeof UsageCategory>;
+declare const WritingSystem: z.ZodEnum<{
+  "sitelen pona": "sitelen pona";
+  "sitelen sitelen": "sitelen sitelen";
+  alphabet: "alphabet";
+  syllabary: "syllabary";
+  logography: "logography";
+  "tokiponido alphabet": "tokiponido alphabet";
+  "tokiponido syllabary": "tokiponido syllabary";
+  "tokiponido logography": "tokiponido logography";
+}>;
+type WritingSystem = z.infer<typeof WritingSystem>;
+declare function getTranslatedData<Obj extends {
+  translations: Record<string, object>;
+}, Key extends keyof Obj["translations"][string]>(data: Obj, key: Key, language: string): Obj["translations"][string][Key];
+//#endregion
+export { Book, CoinedEra, FontLinks, LocalizedSignParameters, LocalizedWordCommentary, LocalizedWordDefinition, LocalizedWordEtymology, LocalizedWordSitelenEtymology, SignEtymology, SignVideo, SignWriting, UsageCategory, WordAudio, WordKuData, WordPuVerbatim, WordRepresentations, WordTranslation, WordTranslations, WordUsage, WritingSystem, getTranslatedData };

package/dist/lib/v1/utils.mjs

@@ -0,0 +1,35 @@
+import { z } from "zod/v4";
+//#region src/lib/v1/utils.ts
+const Book = z.union([
+	z.literal("pu"),
+	z.literal("ku suli"),
+	z.literal("ku lili"),
+	z.literal("none")
+]);
+const CoinedEra = z.union([
+	z.literal("pre-pu"),
+	z.literal("post-pu"),
+	z.literal("post-ku")
+]);
+const UsageCategory = z.union([
+	z.literal("core"),
+	z.literal("common"),
+	z.literal("uncommon"),
+	z.literal("obscure"),
+	z.literal("sandbox")
+]);
+const WritingSystem = z.enum([
+	"sitelen pona",
+	"sitelen sitelen",
+	"alphabet",
+	"syllabary",
+	"logography",
+	"tokiponido alphabet",
+	"tokiponido syllabary",
+	"tokiponido logography"
+]);
+function getTranslatedData(data, key, language) {
+	return (data.translations[language] ?? data.translations["en"])[key];
+}
+//#endregion
+export { Book, CoinedEra, UsageCategory, WritingSystem, getTranslatedData };