Merge pull request #3 from SanduniU/client-gen

Add OpenAPI Specification, Sanitations and Generated Client

.gitignore

@@ -1,6 +1,6 @@
 # Compiled class file
 *.class
-
+*.balx
 # Log file
 *.log
 
@@ -10,15 +10,49 @@
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
 
-# Package Files #
+# .DS_Store files
+*.DS_Store
+
+# Package Files
 *.jar
+!gradle/wrapper/gradle-wrapper.jar
 *.war
-*.nar
 *.ear
 *.zip
 *.tar.gz
 *.rar
+*.deb
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
-replay_pid*
+
+# Ignore everything in this directory
+target
+.classpath
+.settings
+.project
+*.iml
+*.iws
+*.ipr
+.idea
+.m2
+.vscode/
+
+# Ignore ballerina files
+accessToken.bal
+temp.bal.ballerina/
+target/
+generated/
+.DS_Store
+*Ballerina.lock
+.ballerina
+**/Config.toml
+
+# Ignore Gradle project-specific cache directory
+.gradle
+
+# Ignore Gradle build output directory
+build
+
+# Ignore Docker env file
+docker.env

ballerina/Ballerina.toml

@@ -6,7 +6,7 @@ version = "0.1.0"
 license = ["Apache-2.0"]
 authors = ["Ballerina"]
 keywords = []
-icon = "icon.png"
+# icon = "icon.png"
 repository = "https://github.com/ballerina-platform/module-ballerinax-openai.assistants"
 
 [build-options]

ballerina/utils.bal

@@ -0,0 +1,217 @@
+// AUTO-GENERATED FILE. DO NOT MODIFY.
+// This file is auto-generated by the Ballerina OpenAPI tool.
+
+// Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com).
+//
+// WSO2 LLC. licenses this file to you under the Apache License,
+// Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+import ballerina/url;
+
+type SimpleBasicType string|boolean|int|float|decimal;
+
+# Represents encoding mechanism details.
+type Encoding record {
+    # Defines how multiple values are delimited
+    string style = FORM;
+    # Specifies whether arrays and objects should generate as separate fields
+    boolean explode = true;
+    # Specifies the custom content type
+    string contentType?;
+    # Specifies the custom headers
+    map<any> headers?;
+};
+
+enum EncodingStyle {
+    DEEPOBJECT, FORM, SPACEDELIMITED, PIPEDELIMITED
+}
+
+final Encoding & readonly defaultEncoding = {};
+
+# Serialize the record according to the deepObject style.
+#
+# + parent - Parent record name
+# + anyRecord - Record to be serialized
+# + return - Serialized record as a string
+isolated function getDeepObjectStyleRequest(string parent, record {} anyRecord) returns string {
+    string[] recordArray = [];
+    foreach [string, anydata] [key, value] in anyRecord.entries() {
+        if value is SimpleBasicType {
+            recordArray.push(parent + "[" + key + "]" + "=" + getEncodedUri(value.toString()));
+        } else if value is SimpleBasicType[] {
+            recordArray.push(getSerializedArray(parent + "[" + key + "]" + "[]", value, DEEPOBJECT, true));
+        } else if value is record {} {
+            string nextParent = parent + "[" + key + "]";
+            recordArray.push(getDeepObjectStyleRequest(nextParent, value));
+        } else if value is record {}[] {
+            string nextParent = parent + "[" + key + "]";
+            recordArray.push(getSerializedRecordArray(nextParent, value, DEEPOBJECT));
+        }
+        recordArray.push("&");
+    }
+    _ = recordArray.pop();
+    return string:'join("", ...recordArray);
+}
+
+# Serialize the record according to the form style.
+#
+# + parent - Parent record name
+# + anyRecord - Record to be serialized
+# + explode - Specifies whether arrays and objects should generate separate parameters
+# + return - Serialized record as a string
+isolated function getFormStyleRequest(string parent, record {} anyRecord, boolean explode = true) returns string {
+    string[] recordArray = [];
+    if explode {
+        foreach [string, anydata] [key, value] in anyRecord.entries() {
+            if value is SimpleBasicType {
+                recordArray.push(key, "=", getEncodedUri(value.toString()));
+            } else if value is SimpleBasicType[] {
+                recordArray.push(getSerializedArray(key, value, explode = explode));
+            } else if value is record {} {
+                recordArray.push(getFormStyleRequest(parent, value, explode));
+            }
+            recordArray.push("&");
+        }
+        _ = recordArray.pop();
+    } else {
+        foreach [string, anydata] [key, value] in anyRecord.entries() {
+            if value is SimpleBasicType {
+                recordArray.push(key, ",", getEncodedUri(value.toString()));
+            } else if value is SimpleBasicType[] {
+                recordArray.push(getSerializedArray(key, value, explode = false));
+            } else if value is record {} {
+                recordArray.push(getFormStyleRequest(parent, value, explode));
+            }
+            recordArray.push(",");
+        }
+        _ = recordArray.pop();
+    }
+    return string:'join("", ...recordArray);
+}
+
+# Serialize arrays.
+#
+# + arrayName - Name of the field with arrays
+# + anyArray - Array to be serialized
+# + style - Defines how multiple values are delimited
+# + explode - Specifies whether arrays and objects should generate separate parameters
+# + return - Serialized array as a string
+isolated function getSerializedArray(string arrayName, anydata[] anyArray, string style = "form", boolean explode = true) returns string {
+    string key = arrayName;
+    string[] arrayValues = [];
+    if anyArray.length() > 0 {
+        if style == FORM && !explode {
+            arrayValues.push(key, "=");
+            foreach anydata i in anyArray {
+                arrayValues.push(getEncodedUri(i.toString()), ",");
+            }
+        } else if style == SPACEDELIMITED && !explode {
+            arrayValues.push(key, "=");
+            foreach anydata i in anyArray {
+                arrayValues.push(getEncodedUri(i.toString()), "%20");
+            }
+        } else if style == PIPEDELIMITED && !explode {
+            arrayValues.push(key, "=");
+            foreach anydata i in anyArray {
+                arrayValues.push(getEncodedUri(i.toString()), "|");
+            }
+        } else if style == DEEPOBJECT {
+            foreach anydata i in anyArray {
+                arrayValues.push(key, "[]", "=", getEncodedUri(i.toString()), "&");
+            }
+        } else {
+            foreach anydata i in anyArray {
+                arrayValues.push(key, "=", getEncodedUri(i.toString()), "&");
+            }
+        }
+        _ = arrayValues.pop();
+    }
+    return string:'join("", ...arrayValues);
+}
+
+# Serialize the array of records according to the form style.
+#
+# + parent - Parent record name
+# + value - Array of records to be serialized
+# + style - Defines how multiple values are delimited
+# + explode - Specifies whether arrays and objects should generate separate parameters
+# + return - Serialized record as a string
+isolated function getSerializedRecordArray(string parent, record {}[] value, string style = FORM, boolean explode = true) returns string {
+    string[] serializedArray = [];
+    if style == DEEPOBJECT {
+        int arayIndex = 0;
+        foreach var recordItem in value {
+            serializedArray.push(getDeepObjectStyleRequest(parent + "[" + arayIndex.toString() + "]", recordItem), "&");
+            arayIndex = arayIndex + 1;
+        }
+    } else {
+        if !explode {
+            serializedArray.push(parent, "=");
+        }
+        foreach var recordItem in value {
+            serializedArray.push(getFormStyleRequest(parent, recordItem, explode), ",");
+        }
+    }
+    _ = serializedArray.pop();
+    return string:'join("", ...serializedArray);
+}
+
+# Get Encoded URI for a given value.
+#
+# + value - Value to be encoded
+# + return - Encoded string
+isolated function getEncodedUri(anydata value) returns string {
+    string|error encoded = url:encode(value.toString(), "UTF8");
+    if encoded is string {
+        return encoded;
+    } else {
+        return value.toString();
+    }
+}
+
+# Generate query path with query parameter.
+#
+# + queryParam - Query parameter map
+# + encodingMap - Details on serialization mechanism
+# + return - Returns generated Path or error at failure of client initialization
+isolated function getPathForQueryParam(map<anydata> queryParam, map<Encoding> encodingMap = {}) returns string|error {
+    string[] param = [];
+    if queryParam.length() > 0 {
+        param.push("?");
+        foreach var [key, value] in queryParam.entries() {
+            if value is () {
+                _ = queryParam.remove(key);
+                continue;
+            }
+            Encoding encodingData = encodingMap.hasKey(key) ? encodingMap.get(key) : defaultEncoding;
+            if value is SimpleBasicType {
+                param.push(key, "=", getEncodedUri(value.toString()));
+            } else if value is SimpleBasicType[] {
+                param.push(getSerializedArray(key, value, encodingData.style, encodingData.explode));
+            } else if value is record {} {
+                if encodingData.style == DEEPOBJECT {
+                    param.push(getDeepObjectStyleRequest(key, value));
+                } else {
+                    param.push(getFormStyleRequest(key, value, encodingData.explode));
+                }
+            } else {
+                param.push(key, "=", value.toString());
+            }
+            param.push("&");
+        }
+        _ = param.pop();
+    }
+    string restOfPath = string:'join("", ...param);
+    return restOfPath;
+}