@kulupu-linku/sona 0.1.7 → 0.1.8

package/dist/index.js

@@ -2,13 +2,16 @@ import {
   Book,
   CoinedEra,
   UsageCategory,
-  WritingSystem,
-  YearMonth
-} from "./chunk-T34XQGQK.js";
+  WritingSystem
+} from "./chunk-QCIUEY5V.js";
 
 // src/index.ts
 import { z } from "zod";
+var YearMonth = z.string().regex(/^20\d{2}-(0[1-9]|1[0-2])$/g);
 var 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."),
@@ -26,21 +29,24 @@ var Word = z.object({
     "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"),
-  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."
-  ),
+  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().or(z.literal("")).describe(
+    sitelen_emosi: z.string().emoji().optional().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"
+    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().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(
+    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"
     )
-  }).describe("Ways of representing this word in the real world, via text/computers"),
+  }).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"
@@ -66,10 +72,7 @@ var Word = z.object({
     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(
+  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");
@@ -145,6 +148,7 @@ var ParametersTranslation = z.record(
 ).describe("Partly localized descriptions of how a sign is signed.");
 var IconTranslation = z.record(z.string().min(1), z.string()).describe("Localized descriptions of the thing a sign represents.");
 var 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"),
@@ -176,7 +180,7 @@ var Words = z.record(
     translations: z.record(
       z.object({
         commentary: CommentaryTranslation.valueSchema,
-        definitions: DefinitionTranslation.valueSchema,
+        definition: DefinitionTranslation.valueSchema,
         etymology: EtymologyTranslation.valueSchema,
         sp_etymology: SitelenPonaTranslation.valueSchema
       })

package/dist/utils.d.ts

@@ -1,13 +1,2 @@
-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 };
+import 'zod';
+export { Book, CoinedEra, FontLinks, LocalizedSignParameters, LocalizedWordCommentary, LocalizedWordDefinition, LocalizedWordEtymology, LocalizedWordSitelenEtymology, SignEtymology, SignVideo, SignWriting, UsageCategory, WordAudio, WordKuData, WordPuVerbatim, WordRepresentations, WordTranslation, WordTranslations, WordUsage, WritingSystem, getTranslatedData } from './index.js';

package/dist/utils.js

@@ -3,12 +3,12 @@ import {
   CoinedEra,
   UsageCategory,
   WritingSystem,
-  YearMonth
-} from "./chunk-T34XQGQK.js";
+  getTranslatedData
+} from "./chunk-QCIUEY5V.js";
 export {
   Book,
   CoinedEra,
   UsageCategory,
   WritingSystem,
-  YearMonth
+  getTranslatedData
 };

package/generated/etymology.json

@@ -0,0 +1,20 @@
+{
+  "$ref": "#/definitions/etymology",
+  "definitions": {
+    "etymology": {
+      "type": "object",
+      "properties": {
+        "word": {
+          "type": "string",
+          "description": "One of the root words of this word, as written out in its language of origin"
+        },
+        "alt": {
+          "type": "string",
+          "description": "A latinized representation of the \"word\" field"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/generated/font.json

@@ -4,6 +4,11 @@
     "font": {
       "type": "object",
       "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The font's unique ID, identifying it among other fonts"
+        },
         "creator": {
           "type": "array",
           "items": {
@@ -91,6 +96,7 @@
         }
       },
       "required": [
+        "id",
         "creator",
         "features",
         "filename",

package/generated/fonts.json

@@ -6,6 +6,11 @@
       "additionalProperties": {
         "type": "object",
         "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The font's unique ID, identifying it among other fonts"
+          },
           "creator": {
             "type": "array",
             "items": {
@@ -93,6 +98,7 @@
           }
         },
         "required": [
+          "id",
           "creator",
           "features",
           "filename",

package/generated/representations.json

@@ -0,0 +1,43 @@
+{
+  "$ref": "#/definitions/representations",
+  "definitions": {
+    "representations": {
+      "anyOf": [
+        {
+          "not": {}
+        },
+        {
+          "type": "object",
+          "properties": {
+            "sitelen_emosi": {
+              "type": "string",
+              "pattern": "^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$",
+              "description": "The sitelen emosi representation of this word, a script for writing Toki Pona using emoji"
+            },
+            "ligatures": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              },
+              "description": "A list of sitelen Lasina representations of the word, used by ligature fonts to visually convert latin characters into sitelen pona"
+            },
+            "sitelen_sitelen": {
+              "type": "string",
+              "format": "uri",
+              "description": "A URL pointing to an image of this word's sitelen sitelen hieroglyphic block"
+            },
+            "ucsur": {
+              "type": "string",
+              "pattern": "^U\\+[\\da-fA-F]{4,6}$",
+              "description": "The word's UCSUR codepoint, as defined in https://www.kreativekorp.com/ucsur/charts/sitelen.html"
+            }
+          },
+          "additionalProperties": false
+        }
+      ],
+      "description": "Ways of representing this word in the real world, via text/computers"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/generated/resources.json

@@ -0,0 +1,30 @@
+{
+  "$ref": "#/definitions/resources",
+  "definitions": {
+    "resources": {
+      "anyOf": [
+        {
+          "not": {}
+        },
+        {
+          "type": "object",
+          "properties": {
+            "sona_pona": {
+              "type": "string",
+              "format": "uri",
+              "description": "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": {
+              "type": "string",
+              "format": "uri",
+              "description": "A link to lipamanka's description of the word's semantic space."
+            }
+          },
+          "additionalProperties": false
+        }
+      ],
+      "description": "Non-Linku resources related to the specific word, such as wiki links."
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/generated/sandbox.json

@@ -6,6 +6,11 @@
       "additionalProperties": {
         "type": "object",
         "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1,
+            "description": "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": {
             "type": "string",
             "description": "The author's original definition, taken verbatim in their words"
@@ -72,67 +77,50 @@
             },
             "description": "A list of related words"
           },
-          "sona_pona": {
-            "type": "string",
-            "format": "uri",
-            "description": "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."
+          "resources": {
+            "type": "object",
+            "properties": {
+              "sona_pona": {
+                "type": "string",
+                "format": "uri",
+                "description": "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": {
+                "type": "string",
+                "format": "uri",
+                "description": "A link to lipamanka's description of the word's semantic space."
+              }
+            },
+            "additionalProperties": false,
+            "description": "Non-Linku resources related to the specific word, such as wiki links."
           },
           "representations": {
             "type": "object",
             "properties": {
               "sitelen_emosi": {
-                "anyOf": [
-                  {
-                    "type": "string",
-                    "pattern": "^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$"
-                  },
-                  {
-                    "type": "string",
-                    "const": ""
-                  }
-                ],
+                "type": "string",
+                "pattern": "^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$",
                 "description": "The sitelen emosi representation of this word, a script for writing Toki Pona using emoji"
               },
-              "sitelen_pona": {
+              "ligatures": {
                 "type": "array",
                 "items": {
-                  "type": "string"
+                  "type": "string",
+                  "minLength": 1
                 },
-                "description": "A list of sitelen Lasina representations of this word, to be converted into sitelen pona glyphs"
+                "description": "A list of sitelen Lasina representations of the word, used by ligature fonts to visually convert latin characters into sitelen pona"
               },
               "sitelen_sitelen": {
-                "anyOf": [
-                  {
-                    "type": "string",
-                    "format": "uri"
-                  },
-                  {
-                    "type": "string",
-                    "const": ""
-                  }
-                ],
+                "type": "string",
+                "format": "uri",
                 "description": "A URL pointing to an image of this word's sitelen sitelen hieroglyphic block"
               },
               "ucsur": {
-                "anyOf": [
-                  {
-                    "type": "string",
-                    "pattern": "^U\\+[\\da-fA-F]{4,6}$"
-                  },
-                  {
-                    "type": "string",
-                    "const": ""
-                  }
-                ],
+                "type": "string",
+                "pattern": "^U\\+[\\da-fA-F]{4,6}$",
                 "description": "The word's UCSUR codepoint, as defined in https://www.kreativekorp.com/ucsur/charts/sitelen.html"
               }
             },
-            "required": [
-              "sitelen_emosi",
-              "sitelen_pona",
-              "sitelen_sitelen",
-              "ucsur"
-            ],
             "additionalProperties": false,
             "description": "Ways of representing this word in the real world, via text/computers"
           },
@@ -246,7 +234,7 @@
                 "commentary": {
                   "type": "string"
                 },
-                "definitions": {
+                "definition": {
                   "type": "string",
                   "minLength": 1
                 },
@@ -276,7 +264,7 @@
               },
               "required": [
                 "commentary",
-                "definitions",
+                "definition",
                 "etymology",
                 "sp_etymology"
               ],
@@ -285,6 +273,7 @@
           }
         },
         "required": [
+          "id",
           "author_verbatim",
           "author_verbatim_source",
           "book",
@@ -292,7 +281,6 @@
           "coined_year",
           "creator",
           "see_also",
-          "representations",
           "source_language",
           "usage_category",
           "word",

package/generated/word.json

@@ -4,6 +4,11 @@
     "word": {
       "type": "object",
       "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "description": "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": {
           "type": "string",
           "description": "The author's original definition, taken verbatim in their words"
@@ -70,67 +75,50 @@
           },
           "description": "A list of related words"
         },
-        "sona_pona": {
-          "type": "string",
-          "format": "uri",
-          "description": "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."
+        "resources": {
+          "type": "object",
+          "properties": {
+            "sona_pona": {
+              "type": "string",
+              "format": "uri",
+              "description": "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": {
+              "type": "string",
+              "format": "uri",
+              "description": "A link to lipamanka's description of the word's semantic space."
+            }
+          },
+          "additionalProperties": false,
+          "description": "Non-Linku resources related to the specific word, such as wiki links."
         },
         "representations": {
           "type": "object",
           "properties": {
             "sitelen_emosi": {
-              "anyOf": [
-                {
-                  "type": "string",
-                  "pattern": "^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$"
-                },
-                {
-                  "type": "string",
-                  "const": ""
-                }
-              ],
+              "type": "string",
+              "pattern": "^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$",
               "description": "The sitelen emosi representation of this word, a script for writing Toki Pona using emoji"
             },
-            "sitelen_pona": {
+            "ligatures": {
               "type": "array",
               "items": {
-                "type": "string"
+                "type": "string",
+                "minLength": 1
               },
-              "description": "A list of sitelen Lasina representations of this word, to be converted into sitelen pona glyphs"
+              "description": "A list of sitelen Lasina representations of the word, used by ligature fonts to visually convert latin characters into sitelen pona"
             },
             "sitelen_sitelen": {
-              "anyOf": [
-                {
-                  "type": "string",
-                  "format": "uri"
-                },
-                {
-                  "type": "string",
-                  "const": ""
-                }
-              ],
+              "type": "string",
+              "format": "uri",
               "description": "A URL pointing to an image of this word's sitelen sitelen hieroglyphic block"
             },
             "ucsur": {
-              "anyOf": [
-                {
-                  "type": "string",
-                  "pattern": "^U\\+[\\da-fA-F]{4,6}$"
-                },
-                {
-                  "type": "string",
-                  "const": ""
-                }
-              ],
+              "type": "string",
+              "pattern": "^U\\+[\\da-fA-F]{4,6}$",
               "description": "The word's UCSUR codepoint, as defined in https://www.kreativekorp.com/ucsur/charts/sitelen.html"
             }
           },
-          "required": [
-            "sitelen_emosi",
-            "sitelen_pona",
-            "sitelen_sitelen",
-            "ucsur"
-          ],
           "additionalProperties": false,
           "description": "Ways of representing this word in the real world, via text/computers"
         },
@@ -238,6 +226,7 @@
         }
       },
       "required": [
+        "id",
         "author_verbatim",
         "author_verbatim_source",
         "book",
@@ -245,7 +234,6 @@
         "coined_year",
         "creator",
         "see_also",
-        "representations",
         "source_language",
         "usage_category",
         "word",

package/generated/words.json

@@ -6,6 +6,11 @@
       "additionalProperties": {
         "type": "object",
         "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1,
+            "description": "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": {
             "type": "string",
             "description": "The author's original definition, taken verbatim in their words"
@@ -72,67 +77,50 @@
             },
             "description": "A list of related words"
           },
-          "sona_pona": {
-            "type": "string",
-            "format": "uri",
-            "description": "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."
+          "resources": {
+            "type": "object",
+            "properties": {
+              "sona_pona": {
+                "type": "string",
+                "format": "uri",
+                "description": "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": {
+                "type": "string",
+                "format": "uri",
+                "description": "A link to lipamanka's description of the word's semantic space."
+              }
+            },
+            "additionalProperties": false,
+            "description": "Non-Linku resources related to the specific word, such as wiki links."
           },
           "representations": {
             "type": "object",
             "properties": {
               "sitelen_emosi": {
-                "anyOf": [
-                  {
-                    "type": "string",
-                    "pattern": "^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$"
-                  },
-                  {
-                    "type": "string",
-                    "const": ""
-                  }
-                ],
+                "type": "string",
+                "pattern": "^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$",
                 "description": "The sitelen emosi representation of this word, a script for writing Toki Pona using emoji"
               },
-              "sitelen_pona": {
+              "ligatures": {
                 "type": "array",
                 "items": {
-                  "type": "string"
+                  "type": "string",
+                  "minLength": 1
                 },
-                "description": "A list of sitelen Lasina representations of this word, to be converted into sitelen pona glyphs"
+                "description": "A list of sitelen Lasina representations of the word, used by ligature fonts to visually convert latin characters into sitelen pona"
               },
               "sitelen_sitelen": {
-                "anyOf": [
-                  {
-                    "type": "string",
-                    "format": "uri"
-                  },
-                  {
-                    "type": "string",
-                    "const": ""
-                  }
-                ],
+                "type": "string",
+                "format": "uri",
                 "description": "A URL pointing to an image of this word's sitelen sitelen hieroglyphic block"
               },
               "ucsur": {
-                "anyOf": [
-                  {
-                    "type": "string",
-                    "pattern": "^U\\+[\\da-fA-F]{4,6}$"
-                  },
-                  {
-                    "type": "string",
-                    "const": ""
-                  }
-                ],
+                "type": "string",
+                "pattern": "^U\\+[\\da-fA-F]{4,6}$",
                 "description": "The word's UCSUR codepoint, as defined in https://www.kreativekorp.com/ucsur/charts/sitelen.html"
               }
             },
-            "required": [
-              "sitelen_emosi",
-              "sitelen_pona",
-              "sitelen_sitelen",
-              "ucsur"
-            ],
             "additionalProperties": false,
             "description": "Ways of representing this word in the real world, via text/computers"
           },
@@ -246,7 +234,7 @@
                 "commentary": {
                   "type": "string"
                 },
-                "definitions": {
+                "definition": {
                   "type": "string",
                   "minLength": 1
                 },
@@ -276,7 +264,7 @@
               },
               "required": [
                 "commentary",
-                "definitions",
+                "definition",
                 "etymology",
                 "sp_etymology"
               ],
@@ -285,6 +273,7 @@
           }
         },
         "required": [
+          "id",
           "author_verbatim",
           "author_verbatim_source",
           "book",
@@ -292,7 +281,6 @@
           "coined_year",
           "creator",
           "see_also",
-          "representations",
           "source_language",
           "usage_category",
           "word",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kulupu-linku/sona",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "A library providing TypeScript types and Zod schemas for the sona API",
   "homepage": "https://linku.la/",
   "bugs": {