diskio-api 1.0.0

package/README.md

@@ -0,0 +1,48 @@
+<p align="center">
+  <a href="https://github.com/xutyxd/diskio-server">
+    <picture>
+      <source srcset="../diskio-logo.png" width="150">
+      <img alt="diskio logo" src="./diskio-logo.png" width="150">
+    </picture>
+  </a>
+</p>
+
+<h1 align="center">
+  Client to interact with the Diskio Server API
+</h1>
+
+<p align="left">
+    <img src="https://img.shields.io/npm/dw/diskio-api"/>
+    <img alt="NPM Unpacked Size" src="https://img.shields.io/npm/unpacked-size/diskio-api">
+    <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/min/diskio-api">
+    <img alt="NPM Version" src="https://img.shields.io/npm/v/diskio-api">
+</p>
+
+# Diskio Client
+An API client for [diskio-server](https://github.com/xutyxd/diskio-server) exposed with OpenAPI.
+
+
+
+## 📦 Packages
+
+### 📦 CommonJS
+
+```js
+const { DiskioAPIClient } = require('diskio-api');
+```
+
+### 📦 ESM
+
+```js
+import { DiskioAPIClient } from 'diskio-api';
+```
+
+### 📦 TypeScript
+
+```ts
+import { DiskioAPIClient } from 'diskio-api';
+```
+
+## 📝 License
+
+This project is licensed under the `GNU AFFERO GENERAL PUBLIC LICENSE` - see the [LICENSE](LICENSE) file for details

package/cjs/index.d.ts

@@ -0,0 +1,52 @@
+import type { components } from "../openapi/specification";
+export declare class DiskioAPIClient {
+    private client;
+    private authentication?;
+    constructor(baseUrl: string);
+    private authenticate;
+    auth: {
+        set: (access_token: string) => void;
+        get: () => string | undefined;
+    };
+    healthCheck(): Promise<import("openapi-fetch").FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["response.model"] & {
+                        data: number;
+                    };
+                };
+            };
+        };
+    }, import("openapi-fetch").FetchOptions<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["response.model"] & {
+                        data: number;
+                    };
+                };
+            };
+        };
+    }> | undefined, `${string}/${string}`>>;
+}

package/cjs/index.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DiskioAPIClient = void 0;
+const openapi_fetch_1 = __importDefault(require("openapi-fetch"));
+class DiskioAPIClient {
+    constructor(baseUrl) {
+        this.authenticate = {
+            onRequest: ({ request }) => {
+                if (this.authentication) {
+                    request.headers.set('Authorization', `Bearer ${this.authentication}`);
+                }
+                return request;
+            }
+        };
+        this.auth = {
+            set: (access_token) => {
+                this.authentication = access_token;
+            },
+            get: () => {
+                return this.authentication;
+            }
+        };
+        this.client = (0, openapi_fetch_1.default)({ baseUrl, headers: { Bearer: 'access_token' } });
+        this.client.use(this.authenticate);
+    }
+    healthCheck() {
+        return this.client.GET('/health-check');
+    }
+}
+exports.DiskioAPIClient = DiskioAPIClient;

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/mjs/index.d.ts

@@ -0,0 +1,52 @@
+import type { components } from "../openapi/specification";
+export declare class DiskioAPIClient {
+    private client;
+    private authentication?;
+    constructor(baseUrl: string);
+    private authenticate;
+    auth: {
+        set: (access_token: string) => void;
+        get: () => string | undefined;
+    };
+    healthCheck(): Promise<import("openapi-fetch").FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["response.model"] & {
+                        data: number;
+                    };
+                };
+            };
+        };
+    }, import("openapi-fetch").FetchOptions<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["response.model"] & {
+                        data: number;
+                    };
+                };
+            };
+        };
+    }> | undefined, `${string}/${string}`>>;
+}

package/mjs/index.js

@@ -0,0 +1,26 @@
+import createClient from "openapi-fetch";
+export class DiskioAPIClient {
+    constructor(baseUrl) {
+        this.authenticate = {
+            onRequest: ({ request }) => {
+                if (this.authentication) {
+                    request.headers.set('Authorization', `Bearer ${this.authentication}`);
+                }
+                return request;
+            }
+        };
+        this.auth = {
+            set: (access_token) => {
+                this.authentication = access_token;
+            },
+            get: () => {
+                return this.authentication;
+            }
+        };
+        this.client = createClient({ baseUrl, headers: { Bearer: 'access_token' } });
+        this.client.use(this.authenticate);
+    }
+    healthCheck() {
+        return this.client.GET('/health-check');
+    }
+}

package/mjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/openapi/specification.d.ts

@@ -0,0 +1,67 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/health-check": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Health check endpoint */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Correct response indicating that the server is alive */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["response.model"] & {
+                            data: number;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        "id-request.model": {
+            /** @example f0a6f400-be55-42ae-9545-1bcba9b69b99 */
+            uuid: string;
+        };
+        "response.model": {
+            /** @example 200 */
+            code: number;
+            /** @example 1707947871721 */
+            timestamp: number;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;

package/openapi/specification.json

@@ -0,0 +1,95 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Crosscutting API",
+    "summary": "A boilerplate for building contract-first APIs in TypeScript with OpenAPI. Includes OpenAPI definition, compliant server setup, and npm package generation for seamless API development.",
+    "version": "0.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://localhost:8080",
+      "description": "Production server"
+    }
+  ],
+  "tags": [
+    {
+      "name": "Crosscutting",
+      "description": "Operation related to a crosscutting actions"
+    }
+  ],
+  "paths": {
+    "/health-check": {
+      "get": {
+        "tags": [
+          "Crosscutting"
+        ],
+        "summary": "Health check endpoint",
+        "responses": {
+          "200": {
+            "description": "Correct response indicating that the server is alive",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "example": {
+                    "code": 200,
+                    "data": 1523,
+                    "timestamp": 1707947871722
+                  },
+                  "allOf": [
+                    {
+                      "$ref": "#/components/schemas/response.model"
+                    },
+                    {
+                      "type": "object",
+                      "required": [
+                        "data"
+                      ],
+                      "properties": {
+                        "data": {
+                          "type": "number"
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "id-request.model": {
+        "type": "object",
+        "required": [
+          "uuid"
+        ],
+        "properties": {
+          "uuid": {
+            "type": "string",
+            "example": "f0a6f400-be55-42ae-9545-1bcba9b69b99"
+          }
+        }
+      },
+      "response.model": {
+        "type": "object",
+        "required": [
+          "code",
+          "timestamp"
+        ],
+        "properties": {
+          "code": {
+            "type": "number",
+            "example": "200"
+          },
+          "timestamp": {
+            "type": "number",
+            "example": "1707947871721"
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+    "name": "diskio-api",
+    "version": "1.0.0",
+    "description": "An API Client for diskio-server",
+    "type": "module",
+    "main": "cjs/index.js",
+    "module": "mjs/index.js",
+    "exports": {
+        ".": {
+            "import": "./mjs/index.js",
+            "require": "./cjs/index.js"
+        }
+    },
+    "files": [
+        "cjs",
+        "mjs",
+        "openapi"
+    ],
+    "scripts": {},
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/xutyxd/diskio-server.git"
+    },
+    "author": "XutyXD",
+    "license": "ISC",
+    "bugs": {
+        "url": "https://github.com/xutyxd/diskio-server/issues"
+    },
+    "homepage": "https://github.com/xutyxd/diskio-server#readme",
+    "keywords": [
+        "diskio",
+        "diskio-core",
+        "diskio-server",
+        "file-system",
+        "io",
+        "fs",
+        "api"
+    ],
+    "dependencies": {
+        "openapi-fetch": "^0.12.0"
+    }
+}