@kulupu-linku/sona 0.1.6 → 0.1.7

package/dist/client.d.ts

@@ -337,6 +337,15 @@ declare const app: hono_hono_base.HonoBase<hono.Env, hono_types.MergeSchemaPath<
 } | {
     ok: false;
     message: string;
+}> & hono.ToSchema<"get", "/languages", unknown, {
+    [x: string]: {
+        name: {
+            en: string;
+            tok?: string | undefined;
+            endonym?: string | undefined;
+        };
+        locale: string;
+    };
 }>, "/v1"> & hono.ToSchema<"get", "/", unknown, {}>, "/">;
 
 type AppType = typeof app;
@@ -793,6 +802,24 @@ declare const client: {
             }>;
         };
     };
+} & {
+    v1: {
+        languages: hono_client.ClientRequest<{
+            $get: {
+                input: {};
+                output: {
+                    [x: string]: {
+                        name: {
+                            en: string;
+                            tok?: string | undefined;
+                            endonym?: string | undefined;
+                        };
+                        locale: string;
+                    };
+                };
+            };
+        }>;
+    };
 };
 type ApiType = AppType;
 

package/dist/index.d.ts

@@ -1043,5 +1043,36 @@ declare const Fonts: z.ZodRecord<z.ZodString, z.ZodObject<{
     last_updated?: `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` | undefined;
 }>>;
 type Fonts = z.infer<typeof Fonts>;
+declare const Languages: z.ZodRecord<z.ZodString, z.ZodObject<{
+    locale: z.ZodString;
+    name: z.ZodObject<{
+        en: z.ZodString;
+        tok: z.ZodOptional<z.ZodString>;
+        endonym: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        en: string;
+        tok?: string | undefined;
+        endonym?: string | undefined;
+    }, {
+        en: string;
+        tok?: string | undefined;
+        endonym?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    name: {
+        en: string;
+        tok?: string | undefined;
+        endonym?: string | undefined;
+    };
+    locale: string;
+}, {
+    name: {
+        en: string;
+        tok?: string | undefined;
+        endonym?: string | undefined;
+    };
+    locale: string;
+}>>;
+type Languages = z.infer<typeof Languages>;
 
-export { CommentaryTranslation, DefinitionTranslation, EtymologyTranslation, Fingerspelling, FingerspellingSign, Font, Fonts, IconTranslation, ParametersTranslation, Sandbox, Sign, Signs, SitelenPonaTranslation, Word, Words };
+export { CommentaryTranslation, DefinitionTranslation, EtymologyTranslation, Fingerspelling, FingerspellingSign, Font, Fonts, IconTranslation, Languages, ParametersTranslation, Sandbox, Sign, Signs, SitelenPonaTranslation, Word, Words };

package/dist/index.js

@@ -17,7 +17,12 @@ var Word = z.object({
   ),
   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(
+  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"),
@@ -65,13 +70,14 @@ var Word = z.object({
     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"
+    "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");
-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 CommentaryTranslation = z.record(z.string().min(1), z.string()).describe("Localized commentary regarding Toki Pona words");
+var DefinitionTranslation = z.record(z.string().min(1), z.string().min(1)).describe("Localized definitions of Toki Pona words");
+var SitelenPonaTranslation = z.record(z.string().min(1), z.string()).describe("Localized descriptions of the origins of the sitelen pona glyphs for Toki Pona words");
 var 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"),
@@ -127,6 +133,7 @@ var FingerspellingSign = z.object({
   }).describe("Videos of the sign being performed, by format.")
 }).describe("Unlocalized info on a fingerspelling sign.");
 var 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"
@@ -136,7 +143,7 @@ var ParametersTranslation = z.record(
     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 IconTranslation = z.record(z.string().min(1), z.string()).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"),
@@ -164,6 +171,7 @@ var Font = z.object({
   })
 }).describe("Info on a font for Toki Pona");
 var Words = z.record(
+  z.string().min(1),
   Word.extend({
     translations: z.record(
       z.object({
@@ -179,6 +187,7 @@ var Sandbox = Words.describe(
   "A raw data object containing dictionary info about Toki Pona sandbox"
 );
 var Signs = z.record(
+  z.string().min(1),
   Sign.extend({
     translations: z.record(
       z.object({
@@ -189,11 +198,27 @@ var Signs = z.record(
   })
 ).describe("A raw data object containing information about Luka Pona signs");
 var Fingerspelling = z.record(
+  z.string().min(1),
   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");
+var Languages = z.record(
+  z.string().min(2).describe("The language code used by Crowdin. Approximates 2 letter code -> 3 letter code."),
+  z.object({
+    locale: z.string().describe("The locale code corresponding to the language."),
+    name: z.object({
+      en: z.string().describe("The name of the language in English."),
+      // These are optional because we can add a language via Crowdin and Crowdin doesn't provide these.
+      // Downstream projects should prefer endonym over name_en if both are available.
+      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.")
+    })
+    // TODO: completion percentage on a per-file basis?
+    // we also care about completion within usage categories, since the most important words are core+widespread+common
+  }).describe("The languages offered by sona Linku.")
+);
 export {
   CommentaryTranslation,
   DefinitionTranslation,
@@ -203,6 +228,7 @@ export {
   Font,
   Fonts,
   IconTranslation,
+  Languages,
   ParametersTranslation,
   Sandbox,
   Sign,

package/generated/commentary_translation.json

@@ -6,6 +6,9 @@
       "additionalProperties": {
         "type": "string"
       },
+      "propertyNames": {
+        "minLength": 1
+      },
       "description": "Localized commentary regarding Toki Pona words"
     }
   },

package/generated/definition_translation.json

@@ -7,6 +7,9 @@
         "type": "string",
         "minLength": 1
       },
+      "propertyNames": {
+        "minLength": 1
+      },
       "description": "Localized definitions of Toki Pona words"
     }
   },

package/generated/etymology_translation.json

@@ -23,6 +23,9 @@
           "additionalProperties": false
         }
       },
+      "propertyNames": {
+        "minLength": 1
+      },
       "description": "Localized etymological values for Toki Pona words"
     }
   },

package/generated/fingerspelling.json

@@ -116,6 +116,9 @@
         "additionalProperties": false,
         "description": "Unlocalized info on a fingerspelling sign."
       },
+      "propertyNames": {
+        "minLength": 1
+      },
       "description": "A raw data object containing information about Luka Pona fingerspelling signs"
     }
   },

package/generated/icon_translation.json

@@ -4,7 +4,9 @@
     "icon_translation": {
       "type": "object",
       "additionalProperties": {
-        "type": "string",
+        "type": "string"
+      },
+      "propertyNames": {
         "minLength": 1
       },
       "description": "Localized descriptions of the thing a sign represents."

package/generated/languages.json

@@ -0,0 +1,48 @@
+{
+  "$ref": "#/definitions/languages",
+  "definitions": {
+    "languages": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "locale": {
+            "type": "string",
+            "description": "The locale code corresponding to the language."
+          },
+          "name": {
+            "type": "object",
+            "properties": {
+              "en": {
+                "type": "string",
+                "description": "The name of the language in English."
+              },
+              "tok": {
+                "type": "string",
+                "description": "The name of the language in Toki Pona."
+              },
+              "endonym": {
+                "type": "string",
+                "description": "The name of the language in that language."
+              }
+            },
+            "required": [
+              "en"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "locale",
+          "name"
+        ],
+        "additionalProperties": false,
+        "description": "The languages offered by sona Linku."
+      },
+      "propertyNames": {
+        "minLength": 2
+      }
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/generated/parameters_translation.json

@@ -25,6 +25,9 @@
         },
         "additionalProperties": false
       },
+      "propertyNames": {
+        "minLength": 1
+      },
       "description": "Partly localized descriptions of how a sign is signed."
     }
   },

package/generated/sandbox.json

@@ -57,7 +57,11 @@
             "additionalProperties": {
               "type": "number",
               "minimum": 0,
-              "maximum": 100
+              "maximum": 100,
+              "description": "The percentage of ku survey respondents who report this translation as accurate to their usage."
+            },
+            "propertyNames": {
+              "minLength": 1
             },
             "description": "The usage data of the word as described in ku (the official Toki Pona dictionary)"
           },
@@ -232,7 +236,7 @@
             "propertyNames": {
               "pattern": "^20\\d{2}-(0[1-9]|1[0-2])$"
             },
-            "description": "The percentage of people in the Toki Pona community who recognize this word, according to surveys performed by the Linku Project"
+            "description": "The percentage of people in the Toki Pona community who use this word, according to surveys performed by the Linku Project"
           },
           "translations": {
             "type": "object",
@@ -300,6 +304,9 @@
         "additionalProperties": false,
         "description": "General info on a Toki Pona word"
       },
+      "propertyNames": {
+        "minLength": 1
+      },
       "description": "A raw data object containing dictionary info about Toki Pona sandbox"
     }
   },

package/generated/signs.json

@@ -113,8 +113,7 @@
                   "additionalProperties": false
                 },
                 "icons": {
-                  "type": "string",
-                  "minLength": 1
+                  "type": "string"
                 }
               },
               "required": [
@@ -139,6 +138,9 @@
         "additionalProperties": false,
         "description": "Unlocalized info on a Luka Pona sign"
       },
+      "propertyNames": {
+        "minLength": 1
+      },
       "description": "A raw data object containing information about Luka Pona signs"
     }
   },

package/generated/sitelen_pona_translation.json

@@ -6,6 +6,9 @@
       "additionalProperties": {
         "type": "string"
       },
+      "propertyNames": {
+        "minLength": 1
+      },
       "description": "Localized descriptions of the origins of the sitelen pona glyphs for Toki Pona words"
     }
   },

package/generated/word.json

@@ -55,7 +55,11 @@
           "additionalProperties": {
             "type": "number",
             "minimum": 0,
-            "maximum": 100
+            "maximum": 100,
+            "description": "The percentage of ku survey respondents who report this translation as accurate to their usage."
+          },
+          "propertyNames": {
+            "minLength": 1
           },
           "description": "The usage data of the word as described in ku (the official Toki Pona dictionary)"
         },
@@ -230,7 +234,7 @@
           "propertyNames": {
             "pattern": "^20\\d{2}-(0[1-9]|1[0-2])$"
           },
-          "description": "The percentage of people in the Toki Pona community who recognize this word, according to surveys performed by the Linku Project"
+          "description": "The percentage of people in the Toki Pona community who use this word, according to surveys performed by the Linku Project"
         }
       },
       "required": [

package/generated/words.json

@@ -57,7 +57,11 @@
             "additionalProperties": {
               "type": "number",
               "minimum": 0,
-              "maximum": 100
+              "maximum": 100,
+              "description": "The percentage of ku survey respondents who report this translation as accurate to their usage."
+            },
+            "propertyNames": {
+              "minLength": 1
             },
             "description": "The usage data of the word as described in ku (the official Toki Pona dictionary)"
           },
@@ -232,7 +236,7 @@
             "propertyNames": {
               "pattern": "^20\\d{2}-(0[1-9]|1[0-2])$"
             },
-            "description": "The percentage of people in the Toki Pona community who recognize this word, according to surveys performed by the Linku Project"
+            "description": "The percentage of people in the Toki Pona community who use this word, according to surveys performed by the Linku Project"
           },
           "translations": {
             "type": "object",
@@ -300,6 +304,9 @@
         "additionalProperties": false,
         "description": "General info on a Toki Pona word"
       },
+      "propertyNames": {
+        "minLength": 1
+      },
       "description": "A raw data object containing dictionary info about Toki Pona words"
     }
   },

package/package.json

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