@darco2903/cdn-api 1.0.7-beta.0 → 1.1.0

package/README.md

@@ -2,24 +2,64 @@
 
 ## Description
 
-This API is a TypeScript client for the Darco2903 CDN service.
+This package provides an API for interacting with Darco2903's CDN service, including functionalities for uploading, managing, and retrieving media assets. It includes both client and server utilities to facilitate the integration of CDN functionalities across multiple applications.
 
 ## Installation
 
 ```bash
-npm install cdn-api-<version>.tgz
-npm install @ts-rest/core zod@3.22.3
+npm install @darco2903/cdn-api
 ```
 
 ## Usage
 
-Create an instance of the API
+### Creating a client
 
 ```ts
-import { initClient } from "@ts-rest/core";
-import { contract } from "cdn-api";
+import { createClient } from "@darco2903/cdn-api/client";
 
-const api = initClient(contract, {
-    baseUrl: "https://api.example.com",
-});
+const SERVER_ORIGIN = "https://cdn.example.com";
+const cdnApi = createClient(SERVER_ORIGIN);
+```
+
+### Signing a JWT token
+
+```ts
+import { CdnAssetTokenData, JWTSign } from "@darco2903/cdn-api/server";
+import { Hour } from "@darco2903/secondthought";
+
+const JWT_PRIVATE_KEY = "..."; // Private key here
+const tokenData: CdnAssetTokenData = {
+    user_public_id: "user_public_id",
+    endpoint: "/test",
+    service: "auth",
+    type: "avatar",
+};
+const expiresIn = new Hour(1); // Token expires in 1 hour. Also accepts a number of seconds (e.g., 3600).
+
+await JWTSign(tokenData, JWT_PRIVATE_KEY, expiresIn).match(
+    (signedToken) => {
+        console.log("JWT signing successful:", signedToken);
+    },
+    (err) => {
+        console.error(`JWT signing failed: ${err.message}`);
+    }
+);
+```
+
+### Verifying a JWT token
+
+```ts
+import { JWTVerify } from "@darco2903/cdn-api/server";
+
+const JWT_PUBLIC_KEY = "..."; // Public key here
+const accessToken = "..."; // JWT token here
+
+await JWTVerify(accessToken, JWT_PUBLIC_KEY).match(
+    (decodedToken) => {
+        console.log("JWT verification successful:", decodedToken);
+    },
+    (err) => {
+        console.error(`JWT verification failed: ${err.message}`);
+    }
+);
 ```