diskio-api 1.6.0 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/cjs/index.d.ts +77 -33
  2. package/cjs/index.js +7 -5
  3. package/mjs/index.d.ts +77 -33
  4. package/mjs/index.js +7 -5
  5. package/openapi/specification.d.ts +78 -1
  6. package/openapi/specification.json +199 -6
  7. package/package.json +1 -1
package/cjs/index.d.ts CHANGED
@@ -8,47 +8,90 @@ export declare class DiskioAPIClient {
8
8
  set: (access_token: string) => void;
9
9
  get: () => string | undefined;
10
10
  };
11
- healthCheck(): Promise<import("openapi-fetch").FetchResponse<{
12
- parameters: {
13
- query?: never;
14
- header?: never;
15
- path?: never;
16
- cookie?: never;
17
- };
18
- requestBody?: never;
19
- responses: {
20
- 200: {
21
- headers: {
22
- [name: string]: unknown;
11
+ healthCheck: {
12
+ it: () => Promise<import("openapi-fetch").FetchResponse<{
13
+ parameters: {
14
+ query?: never;
15
+ header?: never;
16
+ path?: never;
17
+ cookie?: never;
18
+ };
19
+ requestBody?: never;
20
+ responses: {
21
+ 200: {
22
+ headers: {
23
+ [name: string]: unknown;
24
+ };
25
+ content: {
26
+ "application/json": components["schemas"]["response.model"] & {
27
+ response: components["schemas"]["health-check.model"];
28
+ };
29
+ };
23
30
  };
24
- content: {
25
- "application/json": components["schemas"]["response.model"] & {
26
- data: number;
31
+ };
32
+ }, import("openapi-fetch").FetchOptions<{
33
+ parameters: {
34
+ query?: never;
35
+ header?: never;
36
+ path?: never;
37
+ cookie?: never;
38
+ };
39
+ requestBody?: never;
40
+ responses: {
41
+ 200: {
42
+ headers: {
43
+ [name: string]: unknown;
44
+ };
45
+ content: {
46
+ "application/json": components["schemas"]["response.model"] & {
47
+ response: components["schemas"]["health-check.model"];
48
+ };
27
49
  };
28
50
  };
29
51
  };
30
- };
31
- }, import("openapi-fetch").FetchOptions<{
32
- parameters: {
33
- query?: never;
34
- header?: never;
35
- path?: never;
36
- cookie?: never;
37
- };
38
- requestBody?: never;
39
- responses: {
40
- 200: {
41
- headers: {
42
- [name: string]: unknown;
52
+ }> | undefined, `${string}/${string}`>>;
53
+ all: () => Promise<import("openapi-fetch").FetchResponse<{
54
+ parameters: {
55
+ query?: never;
56
+ header?: never;
57
+ path?: never;
58
+ cookie?: never;
59
+ };
60
+ requestBody?: never;
61
+ responses: {
62
+ 200: {
63
+ headers: {
64
+ [name: string]: unknown;
65
+ };
66
+ content: {
67
+ "application/json": components["schemas"]["response.model"] & {
68
+ response: components["schemas"]["health-check.model"][];
69
+ };
70
+ };
43
71
  };
44
- content: {
45
- "application/json": components["schemas"]["response.model"] & {
46
- data: number;
72
+ };
73
+ }, import("openapi-fetch").FetchOptions<{
74
+ parameters: {
75
+ query?: never;
76
+ header?: never;
77
+ path?: never;
78
+ cookie?: never;
79
+ };
80
+ requestBody?: never;
81
+ responses: {
82
+ 200: {
83
+ headers: {
84
+ [name: string]: unknown;
85
+ };
86
+ content: {
87
+ "application/json": components["schemas"]["response.model"] & {
88
+ response: components["schemas"]["health-check.model"][];
89
+ };
47
90
  };
48
91
  };
49
92
  };
50
- };
51
- }> | undefined, `${string}/${string}`>>;
93
+ }> | undefined, `${string}/${string}`>>;
94
+ };
52
95
  files(): Promise<import("openapi-fetch").FetchResponse<{
53
96
  parameters: {
54
97
  query?: never;
@@ -102,6 +145,7 @@ export declare class DiskioAPIClient {
102
145
  }): Promise<{
103
146
  size: string | null;
104
147
  stream: ArrayBuffer | ReadableStream<Uint8Array<ArrayBuffer>> | null | undefined;
148
+ name: string | undefined;
105
149
  }>;
106
150
  delete(uuid: string): Promise<import("openapi-fetch").FetchResponse<{
107
151
  parameters: {
package/cjs/index.js CHANGED
@@ -23,12 +23,13 @@ class DiskioAPIClient {
23
23
  return this.authentication;
24
24
  }
25
25
  };
26
+ this.healthCheck = {
27
+ it: () => this.client.GET('/health-check'),
28
+ all: () => this.client.GET('/health-check/all')
29
+ };
26
30
  this.client = (0, openapi_fetch_1.default)({ baseUrl, headers: { Bearer: 'access_token' } });
27
31
  this.client.use(this.authenticate);
28
32
  }
29
- healthCheck() {
30
- return this.client.GET('/health-check');
31
- }
32
33
  async files() {
33
34
  return this.client.GET('/diskio');
34
35
  }
@@ -39,11 +40,12 @@ class DiskioAPIClient {
39
40
  return response.data;
40
41
  }
41
42
  async download(uuid, type = 'arrayBuffer', range) {
42
- var _a;
43
+ var _a, _b;
43
44
  const Range = range ? `bytes=${range.from}-${(_a = range.to) !== null && _a !== void 0 ? _a : ''}` : '';
44
45
  const response = this.client.GET('/diskio/{uuid}', { params: { path: { uuid }, header: { Range } }, parseAs: type });
45
46
  const size = response.response.headers.get('Content-Length');
46
- return { size, stream: response.data };
47
+ const name = (_b = response.response.headers.get('Content-Disposition')) === null || _b === void 0 ? void 0 : _b.split('filename=')[1];
48
+ return { size, stream: response.data, name };
47
49
  }
48
50
  delete(uuid) {
49
51
  return this.client.DELETE('/diskio/{uuid}', { params: { path: { uuid } } });
package/mjs/index.d.ts CHANGED
@@ -8,47 +8,90 @@ export declare class DiskioAPIClient {
8
8
  set: (access_token: string) => void;
9
9
  get: () => string | undefined;
10
10
  };
11
- healthCheck(): Promise<import("openapi-fetch").FetchResponse<{
12
- parameters: {
13
- query?: never;
14
- header?: never;
15
- path?: never;
16
- cookie?: never;
17
- };
18
- requestBody?: never;
19
- responses: {
20
- 200: {
21
- headers: {
22
- [name: string]: unknown;
11
+ healthCheck: {
12
+ it: () => Promise<import("openapi-fetch").FetchResponse<{
13
+ parameters: {
14
+ query?: never;
15
+ header?: never;
16
+ path?: never;
17
+ cookie?: never;
18
+ };
19
+ requestBody?: never;
20
+ responses: {
21
+ 200: {
22
+ headers: {
23
+ [name: string]: unknown;
24
+ };
25
+ content: {
26
+ "application/json": components["schemas"]["response.model"] & {
27
+ response: components["schemas"]["health-check.model"];
28
+ };
29
+ };
23
30
  };
24
- content: {
25
- "application/json": components["schemas"]["response.model"] & {
26
- data: number;
31
+ };
32
+ }, import("openapi-fetch").FetchOptions<{
33
+ parameters: {
34
+ query?: never;
35
+ header?: never;
36
+ path?: never;
37
+ cookie?: never;
38
+ };
39
+ requestBody?: never;
40
+ responses: {
41
+ 200: {
42
+ headers: {
43
+ [name: string]: unknown;
44
+ };
45
+ content: {
46
+ "application/json": components["schemas"]["response.model"] & {
47
+ response: components["schemas"]["health-check.model"];
48
+ };
27
49
  };
28
50
  };
29
51
  };
30
- };
31
- }, import("openapi-fetch").FetchOptions<{
32
- parameters: {
33
- query?: never;
34
- header?: never;
35
- path?: never;
36
- cookie?: never;
37
- };
38
- requestBody?: never;
39
- responses: {
40
- 200: {
41
- headers: {
42
- [name: string]: unknown;
52
+ }> | undefined, `${string}/${string}`>>;
53
+ all: () => Promise<import("openapi-fetch").FetchResponse<{
54
+ parameters: {
55
+ query?: never;
56
+ header?: never;
57
+ path?: never;
58
+ cookie?: never;
59
+ };
60
+ requestBody?: never;
61
+ responses: {
62
+ 200: {
63
+ headers: {
64
+ [name: string]: unknown;
65
+ };
66
+ content: {
67
+ "application/json": components["schemas"]["response.model"] & {
68
+ response: components["schemas"]["health-check.model"][];
69
+ };
70
+ };
43
71
  };
44
- content: {
45
- "application/json": components["schemas"]["response.model"] & {
46
- data: number;
72
+ };
73
+ }, import("openapi-fetch").FetchOptions<{
74
+ parameters: {
75
+ query?: never;
76
+ header?: never;
77
+ path?: never;
78
+ cookie?: never;
79
+ };
80
+ requestBody?: never;
81
+ responses: {
82
+ 200: {
83
+ headers: {
84
+ [name: string]: unknown;
85
+ };
86
+ content: {
87
+ "application/json": components["schemas"]["response.model"] & {
88
+ response: components["schemas"]["health-check.model"][];
89
+ };
47
90
  };
48
91
  };
49
92
  };
50
- };
51
- }> | undefined, `${string}/${string}`>>;
93
+ }> | undefined, `${string}/${string}`>>;
94
+ };
52
95
  files(): Promise<import("openapi-fetch").FetchResponse<{
53
96
  parameters: {
54
97
  query?: never;
@@ -102,6 +145,7 @@ export declare class DiskioAPIClient {
102
145
  }): Promise<{
103
146
  size: string | null;
104
147
  stream: ArrayBuffer | ReadableStream<Uint8Array<ArrayBuffer>> | null | undefined;
148
+ name: string | undefined;
105
149
  }>;
106
150
  delete(uuid: string): Promise<import("openapi-fetch").FetchResponse<{
107
151
  parameters: {
package/mjs/index.js CHANGED
@@ -17,12 +17,13 @@ export class DiskioAPIClient {
17
17
  return this.authentication;
18
18
  }
19
19
  };
20
+ this.healthCheck = {
21
+ it: () => this.client.GET('/health-check'),
22
+ all: () => this.client.GET('/health-check/all')
23
+ };
20
24
  this.client = createClient({ baseUrl, headers: { Bearer: 'access_token' } });
21
25
  this.client.use(this.authenticate);
22
26
  }
23
- healthCheck() {
24
- return this.client.GET('/health-check');
25
- }
26
27
  async files() {
27
28
  return this.client.GET('/diskio');
28
29
  }
@@ -33,11 +34,12 @@ export class DiskioAPIClient {
33
34
  return response.data;
34
35
  }
35
36
  async download(uuid, type = 'arrayBuffer', range) {
36
- var _a;
37
+ var _a, _b;
37
38
  const Range = range ? `bytes=${range.from}-${(_a = range.to) !== null && _a !== void 0 ? _a : ''}` : '';
38
39
  const response = await this.client.GET('/diskio/{uuid}', { params: { path: { uuid }, header: { Range } }, parseAs: type });
39
40
  const size = response.response.headers.get('Content-Length');
40
- return { size, stream: response.data };
41
+ const name = (_b = response.response.headers.get('Content-Disposition')) === null || _b === void 0 ? void 0 : _b.split('filename=')[1];
42
+ return { size, stream: response.data, name };
41
43
  }
42
44
  delete(uuid) {
43
45
  return this.client.DELETE('/diskio/{uuid}', { params: { path: { uuid } } });
package/openapi/specification.d.ts CHANGED
@@ -28,7 +28,45 @@ export interface paths {
28
28
  };
29
29
  content: {
30
30
  "application/json": components["schemas"]["response.model"] & {
31
- data: number;
31
+ response: components["schemas"]["health-check.model"];
32
+ };
33
+ };
34
+ };
35
+ };
36
+ };
37
+ put?: never;
38
+ post?: never;
39
+ delete?: never;
40
+ options?: never;
41
+ head?: never;
42
+ patch?: never;
43
+ trace?: never;
44
+ };
45
+ "/health-check/all": {
46
+ parameters: {
47
+ query?: never;
48
+ header?: never;
49
+ path?: never;
50
+ cookie?: never;
51
+ };
52
+ /** Health check list endpoint */
53
+ get: {
54
+ parameters: {
55
+ query?: never;
56
+ header?: never;
57
+ path?: never;
58
+ cookie?: never;
59
+ };
60
+ requestBody?: never;
61
+ responses: {
62
+ /** @description Correct response indicating that the server is alive */
63
+ 200: {
64
+ headers: {
65
+ [name: string]: unknown;
66
+ };
67
+ content: {
68
+ "application/json": components["schemas"]["response.model"] & {
69
+ response: components["schemas"]["health-check.model"][];
32
70
  };
33
71
  };
34
72
  };
@@ -231,6 +269,45 @@ export interface components {
231
269
  /** @example 1707947871721 */
232
270
  timestamp: number;
233
271
  };
272
+ "health-check.model": {
273
+ /** Format: uuid */
274
+ uuid?: string;
275
+ /** Format: int64 */
276
+ createdAt?: number;
277
+ /** Format: int64 */
278
+ updatedAt?: number;
279
+ server?: {
280
+ name?: string;
281
+ memory?: {
282
+ rss?: number;
283
+ heapTotal?: number;
284
+ heapUsed?: number;
285
+ external?: number;
286
+ arrayBuffers?: number;
287
+ };
288
+ /**
289
+ * @description Version of the server
290
+ * @example 1.0.0
291
+ */
292
+ version?: string;
293
+ };
294
+ uptime?: number;
295
+ time?: number;
296
+ disk?: {
297
+ filesystem?: string;
298
+ size?: number;
299
+ used?: number;
300
+ available?: number;
301
+ capacity?: string;
302
+ mount?: string;
303
+ };
304
+ diskio?: {
305
+ size?: number;
306
+ used?: number;
307
+ available?: number;
308
+ capacity?: string;
309
+ };
310
+ };
234
311
  "diskio-file.model": {
235
312
  /** Format: uuid */
236
313
  uuid?: string;
package/openapi/specification.json CHANGED
@@ -35,9 +35,103 @@
35
35
  "application/json": {
36
36
  "schema": {
37
37
  "example": {
38
- "code": 200,
39
- "data": 1523,
40
- "timestamp": 1707947871722
38
+ "uuid": "e2b16358-70f6-4011-977a-718739aaa06f",
39
+ "createdAt": 1766684576444,
40
+ "updatedAt": 1766687487305,
41
+ "server": {
42
+ "name": "diskio-server",
43
+ "memory": {
44
+ "rss": 94130176,
45
+ "heapTotal": 30113792,
46
+ "heapUsed": 21605456,
47
+ "external": 21130525,
48
+ "arrayBuffers": 18577892
49
+ },
50
+ "version": "1.0.0"
51
+ },
52
+ "uptime": 2916.297684914,
53
+ "time": 0,
54
+ "disk": {
55
+ "filesystem": "/dev/mmcblk0p2",
56
+ "size": 60795516,
57
+ "used": 6117300,
58
+ "available": 52154968,
59
+ "capacity": "11%",
60
+ "mount": "/app/data"
61
+ },
62
+ "diskio": {
63
+ "size": 1649267437568,
64
+ "used": 16361099,
65
+ "available": 1649249786229,
66
+ "capacity": "100%"
67
+ }
68
+ },
69
+ "allOf": [
70
+ {
71
+ "$ref": "#/components/schemas/response.model"
72
+ },
73
+ {
74
+ "type": "object",
75
+ "required": [
76
+ "response"
77
+ ],
78
+ "properties": {
79
+ "response": {
80
+ "$ref": "#/components/schemas/health-check.model"
81
+ }
82
+ }
83
+ }
84
+ ]
85
+ }
86
+ }
87
+ }
88
+ }
89
+ }
90
+ }
91
+ },
92
+ "/health-check/all": {
93
+ "get": {
94
+ "tags": [
95
+ "Crosscutting"
96
+ ],
97
+ "summary": "Health check list endpoint",
98
+ "responses": {
99
+ "200": {
100
+ "description": "Correct response indicating that the server is alive",
101
+ "content": {
102
+ "application/json": {
103
+ "schema": {
104
+ "example": {
105
+ "uuid": "e2b16358-70f6-4011-977a-718739aaa06f",
106
+ "createdAt": 1766684576444,
107
+ "updatedAt": 1766687487305,
108
+ "server": {
109
+ "name": "diskio-server",
110
+ "memory": {
111
+ "rss": 94130176,
112
+ "heapTotal": 30113792,
113
+ "heapUsed": 21605456,
114
+ "external": 21130525,
115
+ "arrayBuffers": 18577892
116
+ },
117
+ "version": "1.0.0"
118
+ },
119
+ "uptime": 2916.297684914,
120
+ "time": 0,
121
+ "disk": {
122
+ "filesystem": "/dev/mmcblk0p2",
123
+ "size": 60795516,
124
+ "used": 6117300,
125
+ "available": 52154968,
126
+ "capacity": "11%",
127
+ "mount": "/app/data"
128
+ },
129
+ "diskio": {
130
+ "size": 1649267437568,
131
+ "used": 16361099,
132
+ "available": 1649249786229,
133
+ "capacity": "100%"
134
+ }
41
135
  },
42
136
  "allOf": [
43
137
  {
@@ -46,11 +140,14 @@
46
140
  {
47
141
  "type": "object",
48
142
  "required": [
49
- "data"
143
+ "response"
50
144
  ],
51
145
  "properties": {
52
- "data": {
53
- "type": "number"
146
+ "response": {
147
+ "type": "array",
148
+ "items": {
149
+ "$ref": "#/components/schemas/health-check.model"
150
+ }
54
151
  }
55
152
  }
56
153
  }
@@ -367,6 +464,102 @@
367
464
  }
368
465
  }
369
466
  },
467
+ "health-check.model": {
468
+ "type": "object",
469
+ "properties": {
470
+ "uuid": {
471
+ "type": "string",
472
+ "format": "uuid"
473
+ },
474
+ "createdAt": {
475
+ "type": "integer",
476
+ "format": "int64"
477
+ },
478
+ "updatedAt": {
479
+ "type": "integer",
480
+ "format": "int64"
481
+ },
482
+ "server": {
483
+ "type": "object",
484
+ "properties": {
485
+ "name": {
486
+ "type": "string"
487
+ },
488
+ "memory": {
489
+ "type": "object",
490
+ "properties": {
491
+ "rss": {
492
+ "type": "integer"
493
+ },
494
+ "heapTotal": {
495
+ "type": "integer"
496
+ },
497
+ "heapUsed": {
498
+ "type": "integer"
499
+ },
500
+ "external": {
501
+ "type": "integer"
502
+ },
503
+ "arrayBuffers": {
504
+ "type": "integer"
505
+ }
506
+ }
507
+ },
508
+ "version": {
509
+ "description": "Version of the server",
510
+ "example": "1.0.0",
511
+ "type": "string"
512
+ }
513
+ }
514
+ },
515
+ "uptime": {
516
+ "type": "number"
517
+ },
518
+ "time": {
519
+ "type": "number"
520
+ },
521
+ "disk": {
522
+ "type": "object",
523
+ "properties": {
524
+ "filesystem": {
525
+ "type": "string"
526
+ },
527
+ "size": {
528
+ "type": "integer"
529
+ },
530
+ "used": {
531
+ "type": "integer"
532
+ },
533
+ "available": {
534
+ "type": "integer"
535
+ },
536
+ "capacity": {
537
+ "type": "string"
538
+ },
539
+ "mount": {
540
+ "type": "string"
541
+ }
542
+ }
543
+ },
544
+ "diskio": {
545
+ "type": "object",
546
+ "properties": {
547
+ "size": {
548
+ "type": "integer"
549
+ },
550
+ "used": {
551
+ "type": "integer"
552
+ },
553
+ "available": {
554
+ "type": "integer"
555
+ },
556
+ "capacity": {
557
+ "type": "string"
558
+ }
559
+ }
560
+ }
561
+ }
562
+ },
370
563
  "diskio-file.model": {
371
564
  "type": "object",
372
565
  "properties": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "diskio-api",
3
- "version": "1.6.0",
3
+ "version": "1.8.0",
4
4
  "description": "An API Client for diskio-server",
5
5
  "type": "module",
6
6
  "main": "cjs/index.js",