feat: document JSON Schema type properties on Functionary chat function types

Author: giladgd

src/utils/getTypeScriptTypeStringForGbnfJsonSchema.ts

@@ -1,6 +1,6 @@
 import {
-    GbnfJsonSchema, isGbnfJsonArraySchema, isGbnfJsonBasicSchemaIncludesType, isGbnfJsonConstSchema,
-    isGbnfJsonEnumSchema, isGbnfJsonObjectSchema, isGbnfJsonOneOfSchema
+    GbnfJsonSchema, isGbnfJsonArraySchema, isGbnfJsonBasicSchemaIncludesType, isGbnfJsonBasicStringSchema, isGbnfJsonConstSchema,
+    isGbnfJsonEnumSchema, isGbnfJsonFormatStringSchema, isGbnfJsonObjectSchema, isGbnfJsonOneOfSchema
 } from "./gbnfJson/types.js";
 
 const maxTypeRepetition = 10;
@@ -31,11 +31,50 @@ export function getTypeScriptTypeStringForGbnfJsonSchema(schema: GbnfJsonSchema)
 
                 const mapping = keyText + ": " + valueType;
 
-                if (propSchema.description != null && propSchema.description !== "") {
+                const description: string[] = (propSchema.description != null && propSchema.description !== "")
+                    ? [propSchema.description]
+                    : [];
+                const propInfo: string[] = [];
+
+                if (isGbnfJsonBasicStringSchema(propSchema)) {
+                    if (propSchema.minLength != null && propSchema.minLength > 0)
+                        propInfo.push("minimum length: " + String(Math.floor(propSchema.minLength)));
+
+                    if (propSchema.maxLength != null)
+                        propInfo.push("maximum length: " + String(Math.floor(Math.max(propSchema.maxLength, propSchema.minLength ?? 0, 0))));
+                } else if (isGbnfJsonFormatStringSchema(propSchema)) {
+                    if (propSchema.format === "date-time")
+                        propInfo.push("format: ISO 8601 date-time");
+                    else
+                        propInfo.push("format: " + String(propSchema.format));
+                } else if (isGbnfJsonArraySchema(propSchema)) {
+                    if (propSchema.minItems != null && propSchema.minItems > maxTypeRepetition)
+                        propInfo.push("minimum items: " + String(Math.floor(propSchema.minItems)));
+
+                    if (propSchema.maxItems != null)
+                        propInfo.push("maximum items: " + String(Math.floor(Math.max(propSchema.maxItems, propSchema.minItems ?? 0, 0))));
+                } else if (isGbnfJsonObjectSchema(propSchema)) {
+                    if (propSchema.minProperties != null && propSchema.minProperties > 0)
+                        propInfo.push("minimum number of properties: " + String(Math.floor(propSchema.minProperties)));
+
+                    if (propSchema.maxProperties != null)
+                        propInfo.push(
+                            "maximum number of properties: " +
+                            String(Math.floor(Math.max(propSchema.maxProperties, propSchema.minProperties ?? 0, 0)))
+                        );
+                }
+
+                if (propInfo.length > 0)
+                    description.push(propInfo.join(", "));
+
+                if (description.length > 0) {
                     addNewline = true;
                     return [
                         "\n",
-                        "// ", propSchema.description.split("\n").join("\n// "),
+                        "// ", description
+                            .join("\n")
+                            .split("\n")
+                            .join("\n// "),
                         "\n",
                         mapping
                     ].join("");

test/standalone/chatWrappers/FunctionaryChatWrapper.test.ts

@@ -38,6 +38,61 @@ describe("FunctionaryChatWrapper", () => {
             async handler(params) {
                 return Math.floor(Math.random() * (params.max - params.min + 1) + params.min);
             }
+        }),
+        func1: defineChatSessionFunction({
+            description: "Some function",
+            params: {
+                type: "object",
+                properties: {
+                    message: {
+                        type: "string",
+                        description: "Some message",
+                        minLength: 3,
+                        maxLength: 10
+                    },
+                    words: {
+                        type: "array",
+                        description: "Some words",
+                        items: {
+                            type: "string"
+                        },
+                        minItems: 2,
+                        maxItems: 5
+                    },
+                    headers: {
+                        type: "object",
+                        description: "Some headers",
+                        additionalProperties: {
+                            type: "string"
+                        },
+                        minProperties: 4,
+                        maxProperties: 12
+                    },
+                    mappings: {
+                        type: "object",
+                        description: "Some mappings",
+                        properties: {
+                            a: {
+                                type: "boolean"
+                            },
+                            b: {
+                                type: "number"
+                            },
+                            c: {
+                                type: ["string", "null"]
+                            }
+                        },
+                        additionalProperties: {
+                            type: "string"
+                        },
+                        minProperties: 4,
+                        maxProperties: 12
+                    }
+                }
+            },
+            handler(params) {
+
+            }
         })
     };
     const conversationHistory2: ChatHistoryItem[] = [{
@@ -169,6 +224,25 @@ describe("FunctionaryChatWrapper", () => {
               // Get a random number
               type getRandomNumber = (_: {min: number, max: number}) => any;
 
+              // Some function
+              type func1 = (_: {
+                  // Some message
+                  // minimum length: 3, maximum length: 10
+                  message: string,
+                  
+                  // Some words
+                  // maximum items: 5
+                  words: [string, string, ...string[]],
+                  
+                  // Some headers
+                  // minimum number of properties: 4, maximum number of properties: 12
+                  headers: {[key: string]: string},
+                  
+                  // Some mappings
+                  // minimum number of properties: 4, maximum number of properties: 12
+                  mappings: {a: boolean, b: number, c: string | null} & {[key: string]: string}
+              }) => any;
+
               } // namespace functions",
                 {
                   "type": "specialToken",
@@ -524,6 +598,25 @@ describe("FunctionaryChatWrapper", () => {
               // Get a random number
               type getRandomNumber = (_: {min: number, max: number}) => any;
 
+              // Some function
+              type func1 = (_: {
+                  // Some message
+                  // minimum length: 3, maximum length: 10
+                  message: string,
+                  
+                  // Some words
+                  // maximum items: 5
+                  words: [string, string, ...string[]],
+                  
+                  // Some headers
+                  // minimum number of properties: 4, maximum number of properties: 12
+                  headers: {[key: string]: string},
+                  
+                  // Some mappings
+                  // minimum number of properties: 4, maximum number of properties: 12
+                  mappings: {a: boolean, b: number, c: string | null} & {[key: string]: string}
+              }) => any;
+
               } // namespace functions",
                 {
                   "type": "specialTokensText",