Skip to content

Commit 805d8ff

Browse files
christyjacob4christyjacob4
authored
Merge pull request #511 from appwrite/feat-new-headers
feat: New headers
2 parents 86a6fc6 + c1ff034 commit 805d8ff

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+572
-440
lines changed

‎composer.lock

Lines changed: 132 additions & 337 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/SDK/SDK.php

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ class SDK
4141
'description' => '',
4242
'shortDescription' => '',
4343
'version' => '',
44+
'platform'=>'',
4445
'license' => '',
4546
'licenseContent' => '',
4647
'gitURL' => '',
@@ -192,23 +193,23 @@ public function setDefaultHeaders($headers) {
192193
}
193194

194195
/**
195-
* @param string $text
196+
* @param string $namespace
196197
* @return $this
197198
*/
198-
public function setNamespace($text)
199+
public function setNamespace($namespace)
199200
{
200-
$this->setParam('namespace', $text);
201+
$this->setParam('namespace', $namespace);
201202

202203
return $this;
203204
}
204205

205206
/**
206-
* @param string $text
207+
* @param string $name
207208
* @return $this
208209
*/
209-
public function setName($text)
210+
public function setName($name)
210211
{
211-
$this->setParam('name', $text);
212+
$this->setParam('name', $name);
212213

213214
return $this;
214215
}
@@ -225,7 +226,7 @@ public function setDescription($text)
225226
}
226227

227228
/**
228-
* @param string $name
229+
* @param string $text
229230
* @return $this
230231
*/
231232
public function setShortDescription($text)
@@ -236,23 +237,34 @@ public function setShortDescription($text)
236237
}
237238

238239
/**
239-
* @param string $text
240+
* @param string $version
240241
* @return $this
241242
*/
242-
public function setVersion($text)
243+
public function setVersion($version)
243244
{
244-
$this->setParam('version', $text);
245+
$this->setParam('version', $version);
245246

246247
return $this;
247248
}
248249

249250
/**
250-
* @param string $text
251+
* @param string $platform
252+
* @return $this
253+
*/
254+
public function setPlatform($platform)
255+
{
256+
$this->setParam('platform', $platform);
257+
258+
return $this;
259+
}
260+
261+
/**
262+
* @param string $license
251263
* @return $this
252264
*/
253-
public function setLicense($text)
265+
public function setLicense($license)
254266
{
255-
$this->setParam('license', $text);
267+
$this->setParam('license', $license);
256268

257269
return $this;
258270
}

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ import kotlin.coroutines.resume
4040

4141
class Client @JvmOverloads constructor(
4242
context: Context,
43-
var endPoint: String = "https://appwrite.io/v1",
43+
var endPoint: String = "{{spec.endpoint}}",
4444
var endPointRealtime: String? = null,
4545
private var selfSigned: Boolean = false
4646
) : CoroutineScope {
@@ -85,7 +85,10 @@ class Client @JvmOverloads constructor(
8585
"content-type" to "application/json",
8686
"origin" to "{{ spec.title | caseLower }}-android://${context.packageName}",
8787
"user-agent" to "${context.packageName}/${appVersion}, ${System.getProperty("http.agent")}",
88-
"x-sdk-version" to "{{spec.title | caseDash}}:{{ language.name | caseLower }}:${BuildConfig.SDK_VERSION}"{% if spec.global.defaultHeaders | length > 0 %},{% endif %}
88+
"x-sdk-name" to "{{ sdk.name }}",
89+
"x-sdk-platform" to "{{ sdk.platform }}",
90+
"x-sdk-language" to "{{ language.name | caseLower }}",
91+
"x-sdk-version" to "{{ sdk.version }}"{% if spec.global.defaultHeaders | length > 0 %},{% endif %}
8992

9093
{% for key,header in spec.global.defaultHeaders %}
9194
"{{ key | caseLower }}" to "{{ header }}"{% if not loop.last %},{% endif %}

‎templates/cli/lib/client.js.twig

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@ class Client {
1212
this.endpoint = '{{spec.endpoint}}';
1313
this.headers = {
1414
'content-type': '',
15-
'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
16-
'User-Agent' : `{{spec.title | caseUcfirst}}CLI/{{ sdk.version }} (${os.type()} ${os.version()}; ${os.arch()})`,
15+
'x-sdk-name': '{{ sdk.name }}',
16+
'x-sdk-platform': '{{ sdk.platform }}',
17+
'x-sdk-language': '{{ language.name | caseLower }}',
18+
'x-sdk-version': '{{ sdk.version }}',
19+
'user-agent' : `{{spec.title | caseUcfirst}}CLI/{{ sdk.version }} (${os.type()} ${os.version()}; ${os.arch()})`,
1720
{% for key,header in spec.global.defaultHeaders %}
1821
'{{key}}' : '{{header}}',
1922
{% endfor %}

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ class ClientBrowser extends ClientBase with ClientMixin {
3030
_httpClient = BrowserClient();
3131
_headers = {
3232
'content-type': 'application/json',
33-
'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
33+
'x-sdk-name': '{{ sdk.name }}',
34+
'x-sdk-platform': '{{ sdk.platform }}',
35+
'x-sdk-language': '{{ language.name | caseLower }}',
36+
'x-sdk-version': '{{ sdk.version }}',
3437
{% for key,header in spec.global.defaultHeaders %}
3538
'{{key}}' : '{{header}}',
3639
{% endfor %}

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@ class ClientIO extends ClientBase with ClientMixin {
3939
_endPoint = endPoint;
4040
_headers = {
4141
'content-type': 'application/json',
42-
'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
42+
'x-sdk-name': '{{ sdk.name }}',
43+
'x-sdk-platform': '{{ sdk.platform }}',
44+
'x-sdk-language': '{{ language.name | caseLower }}',
45+
'x-sdk-version': '{{ sdk.version }}',
4346
{% for key,header in spec.global.defaultHeaders %}
4447
'{{key}}' : '{{header}}',
4548
{% endfor %}

‎templates/deno/src/client.ts.twig

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@ export class Client {
88
static CHUNK_SIZE = 5*1024*1024; // 5MB
99
static DENO_READ_CHUNK_SIZE = 16384; // 16kb; refference: https://github.com/denoland/deno/discussions/9906
1010

11-
endpoint: string = 'https://appwrite.io/v1';
11+
endpoint: string = '{{spec.endpoint}}';
1212
headers: Payload = {
1313
'content-type': '',
14-
'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
14+
'x-sdk-name': '{{ sdk.name }}',
15+
'x-sdk-platform': '{{ sdk.platform }}',
16+
'x-sdk-language': '{{ language.name | caseLower }}',
17+
'x-sdk-version': '{{ sdk.version }}',
1518
{% for key,header in spec.global.defaultHeaders %}
1619
'{{key}}':'{{header}}',
1720
{% endfor %}

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ namespace {{ spec.title | caseUcfirst }}
3030
this.headers = new Dictionary<string, string>()
3131
{
3232
{ "content-type", "application/json" },
33-
{ "x-sdk-version", "{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{sdk.version}}" }{% if spec.global.defaultHeaders | length > 0 %},{% endif %}
33+
{ "x-sdk-name", "{{ sdk.name }}" },
34+
{ "x-sdk-platform", "{{ sdk.platform }}" },
35+
{ "x-sdk-language", "{{ language.name | caseLower }}" },
36+
{ "x-sdk-version", "{{ sdk.version }}"}{% if spec.global.defaultHeaders | length > 0 %},{% endif %}
3437

3538
{% for key,header in spec.global.defaultHeaders %}
3639
{ "{{key}}", "{{header}}" }{% if not loop.last %},{% endif %}

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@ class ClientBrowser extends ClientBase with ClientMixin {
4040
.replaceFirst('http://', 'ws://');
4141
_headers = {
4242
'content-type': 'application/json',
43-
'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
43+
'x-sdk-name': '{{ sdk.name }}',
44+
'x-sdk-platform': '{{ sdk.platform }}',
45+
'x-sdk-language': '{{ language.name | caseLower }}',
46+
'x-sdk-version': '{{ sdk.version }}',
4447
{% for key,header in spec.global.defaultHeaders %}
4548
'{{key}}' : '{{header}}',
4649
{% endfor %}

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class ClientIO extends ClientBase with ClientMixin {
4949
String? get endPointRealtime => _endPointRealtime;
5050

5151
ClientIO({
52-
String endPoint = 'https://appwrite.io/v1',
52+
String endPoint = '{{spec.endpoint}}',
5353
this.selfSigned = false,
5454
}) : _endPoint = endPoint {
5555
_nativeClient = HttpClient()
@@ -61,7 +61,10 @@ class ClientIO extends ClientBase with ClientMixin {
6161
.replaceFirst('http://', 'ws://');
6262
_headers = {
6363
'content-type': 'application/json',
64-
'x-sdk-version': '{{spec.title | caseDash}}:{{ language.name | caseLower }}:{{ sdk.version }}',
64+
'x-sdk-name': '{{ sdk.name }}',
65+
'x-sdk-platform': '{{ sdk.platform }}',
66+
'x-sdk-language': '{{ language.name | caseLower }}',
67+
'x-sdk-version': '{{ sdk.version }}',
6568
{% for key,header in spec.global.defaultHeaders %}
6669
'{{key}}' : '{{header}}',
6770
{% endfor %}

0 commit comments

Comments
 (0)