Merge pull request #511 from appwrite/feat-new-headers

feat: New headers

Author: christyjacob4

composer.lock

@@ -41,6 +41,7 @@ class SDK
         'description' => '',
         'shortDescription' => '',
         'version' => '',
+        'platform'=>'',
         'license' => '',
         'licenseContent' => '',
         'gitURL' => '',
@@ -192,23 +193,23 @@ public function setDefaultHeaders($headers) {
     }
 
     /**
-     * @param string $text
+     * @param string $namespace
      * @return $this
      */
-    public function setNamespace($text)
+    public function setNamespace($namespace)
     {
-        $this->setParam('namespace', $text);
+        $this->setParam('namespace', $namespace);
 
         return $this;
     }
 
     /**
-     * @param string $text
+     * @param string $name
      * @return $this
      */
-    public function setName($text)
+    public function setName($name)
     {
-        $this->setParam('name', $text);
+        $this->setParam('name', $name);
 
         return $this;
     }
@@ -225,7 +226,7 @@ public function setDescription($text)
     }
 
     /**
-     * @param string $name
+     * @param string $text
      * @return $this
      */
     public function setShortDescription($text)
@@ -236,23 +237,34 @@ public function setShortDescription($text)
     }
 
     /**
-     * @param string $text
+     * @param string $version
      * @return $this
      */
-    public function setVersion($text)
+    public function setVersion($version)
     {
-        $this->setParam('version', $text);
+        $this->setParam('version', $version);
 
         return $this;
     }
 
     /**
-     * @param string $text
+     * @param string $platform
+     * @return $this
+     */
+    public function setPlatform($platform)
+    {
+        $this->setParam('platform', $platform);
+
+        return $this;
+    }
+
+    /**
+     * @param string $license
      * @return $this
      */
-    public function setLicense($text)
+    public function setLicense($license)
     {
-        $this->setParam('license', $text);
+        $this->setParam('license', $license);
 
         return $this;
     }

src/SDK/SDK.php

@@ -40,7 +40,7 @@ import kotlin.coroutines.resume
 
 class Client @JvmOverloads constructor(
     context: Context,
-    var endPoint: String = "https://appwrite.io/v1",
+    var endPoint: String = "{{spec.endpoint}}",
     var endPointRealtime: String? = null,
     private var selfSigned: Boolean = false
 ) : CoroutineScope {
@@ -85,7 +85,10 @@ class Client @JvmOverloads constructor(
             "content-type" to "application/json",
             "origin" to "{{ spec.title | caseLower }}-android://${context.packageName}",
             "user-agent" to "${context.packageName}/${appVersion}, ${System.getProperty("http.agent")}",
-            "x-sdk-version" to "{{spec.title | caseDash}}:{{ language.name | caseLower }}:${BuildConfig.SDK_VERSION}"{% if spec.global.defaultHeaders | length > 0 %},{% endif %}
+            "x-sdk-name" to "{{ sdk.name }}",
+            "x-sdk-platform" to "{{ sdk.platform }}",
+            "x-sdk-language" to "{{ language.name | caseLower }}",
+            "x-sdk-version" to "{{ sdk.version }}"{% if spec.global.defaultHeaders | length > 0 %},{% endif %}
 
 {% for key,header in spec.global.defaultHeaders %}
             "{{ key | caseLower }}" to "{{ header }}"{% if not loop.last %},{% endif %}

templates/android/library/src/main/java/io/appwrite/Client.kt.twig

@@ -12,8 +12,11 @@ class Client {
     this.endpoint = '{{spec.endpoint}}';
     this.headers = {
       'content-type': '',
-      'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
-      'User-Agent' : `{{spec.title | caseUcfirst}}CLI/{{ sdk.version }} (${os.type()} ${os.version()}; ${os.arch()})`,
+      'x-sdk-name': '{{ sdk.name }}',
+      'x-sdk-platform': '{{ sdk.platform }}',
+      'x-sdk-language': '{{ language.name | caseLower }}',
+      'x-sdk-version': '{{ sdk.version }}',
+      'user-agent' : `{{spec.title | caseUcfirst}}CLI/{{ sdk.version }} (${os.type()} ${os.version()}; ${os.arch()})`,
 {% for key,header in spec.global.defaultHeaders %}
       '{{key}}' : '{{header}}',
 {% endfor %}

templates/cli/lib/client.js.twig

@@ -30,7 +30,10 @@ class ClientBrowser extends ClientBase with ClientMixin {
     _httpClient = BrowserClient();
     _headers = {
       'content-type': 'application/json',
-      'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
+      'x-sdk-name': '{{ sdk.name }}',
+      'x-sdk-platform': '{{ sdk.platform }}',
+      'x-sdk-language': '{{ language.name | caseLower }}',
+      'x-sdk-version': '{{ sdk.version }}',
 {% for key,header in spec.global.defaultHeaders %}
       '{{key}}' : '{{header}}',
 {% endfor %}

templates/dart/lib/src/client_browser.dart.twig

@@ -39,7 +39,10 @@ class ClientIO extends ClientBase with ClientMixin {
     _endPoint = endPoint;
     _headers = {
       'content-type': 'application/json',
-      'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
+      'x-sdk-name': '{{ sdk.name }}',
+      'x-sdk-platform': '{{ sdk.platform }}',
+      'x-sdk-language': '{{ language.name | caseLower }}',
+      'x-sdk-version': '{{ sdk.version }}',
 {% for key,header in spec.global.defaultHeaders %}
       '{{key}}' : '{{header}}',
 {% endfor %}

templates/dart/lib/src/client_io.dart.twig

@@ -8,10 +8,13 @@ export class Client {
     static CHUNK_SIZE = 5*1024*1024; // 5MB
     static DENO_READ_CHUNK_SIZE = 16384; // 16kb; refference: https://github.com/denoland/deno/discussions/9906
 
-    endpoint: string = 'https://appwrite.io/v1';
+    endpoint: string = '{{spec.endpoint}}';
     headers: Payload = {
         'content-type': '',
-        'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
+        'x-sdk-name': '{{ sdk.name }}',
+        'x-sdk-platform': '{{ sdk.platform }}',
+        'x-sdk-language': '{{ language.name | caseLower }}',
+        'x-sdk-version': '{{ sdk.version }}',
 {% for key,header in spec.global.defaultHeaders %}
         '{{key}}':'{{header}}',
 {% endfor %}

templates/deno/src/client.ts.twig

@@ -30,7 +30,10 @@ namespace {{ spec.title | caseUcfirst }}
             this.headers = new Dictionary<string, string>()
             {
                 { "content-type", "application/json" },
-                { "x-sdk-version", "{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{sdk.version}}" }{% if spec.global.defaultHeaders | length > 0 %},{% endif %}
+                { "x-sdk-name", "{{ sdk.name }}" },
+                { "x-sdk-platform", "{{ sdk.platform }}" },
+                { "x-sdk-language", "{{ language.name | caseLower }}" },
+                { "x-sdk-version", "{{ sdk.version }}"}{% if spec.global.defaultHeaders | length > 0 %},{% endif %}
 
 {% for key,header in spec.global.defaultHeaders %}
                 { "{{key}}", "{{header}}" }{% if not loop.last %},{% endif %}

templates/dotnet/src/Appwrite/Client.cs.twig

@@ -40,7 +40,10 @@ class ClientBrowser extends ClientBase with ClientMixin {
         .replaceFirst('http://', 'ws://');
     _headers = {
       'content-type': 'application/json',
-      'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
+      'x-sdk-name': '{{ sdk.name }}',
+      'x-sdk-platform': '{{ sdk.platform }}',
+      'x-sdk-language': '{{ language.name | caseLower }}',
+      'x-sdk-version': '{{ sdk.version }}',
 {% for key,header in spec.global.defaultHeaders %}
       '{{key}}' : '{{header}}',
 {% endfor %}

templates/flutter/lib/src/client_browser.dart.twig

@@ -49,7 +49,7 @@ class ClientIO extends ClientBase with ClientMixin {
   String? get endPointRealtime => _endPointRealtime;
 
   ClientIO({
-    String endPoint = 'https://appwrite.io/v1',
+    String endPoint = '{{spec.endpoint}}',
     this.selfSigned = false,
   }) : _endPoint = endPoint {
     _nativeClient = HttpClient()
@@ -61,7 +61,10 @@ class ClientIO extends ClientBase with ClientMixin {
         .replaceFirst('http://', 'ws://');
     _headers = {
       'content-type': 'application/json',
-      'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
+      'x-sdk-name': '{{ sdk.name }}',
+      'x-sdk-platform': '{{ sdk.platform }}',
+      'x-sdk-language': '{{ language.name | caseLower }}',
+      'x-sdk-version': '{{ sdk.version }}',
 {% for key,header in spec.global.defaultHeaders %}
       '{{key}}' : '{{header}}',
 {% endfor %}