@eduzz/miau-client 1.4.1 → 1.4.2-rc.8

package/.turbo/turbo-build$colon$types.log

@@ -1,4 +1,4 @@
 
-> @eduzz/miau-client@1.4.1 build:types /home/runner/work/eduzz-miau/eduzz-miau/packages/client
+> @eduzz/miau-client@1.4.2 build:types /home/runner/work/eduzz-miau/eduzz-miau/packages/client
 > tsc --emitDeclarationOnly --outDir dist
 

package/README.md

@@ -0,0 +1,143 @@
+# @eduzz/miau-client
+
+Node.js client for the Eduzz Miau authentication and authorization service. Includes Express and Fastify middleware for automatic request validation.
+
+## Installation
+
+```bash
+npm install @eduzz/miau-client
+```
+
+## Usage
+
+```typescript
+import { MiauClient } from '@eduzz/miau-client';
+
+const client = new MiauClient({
+  apiUrl: 'https://your-miau-api-url',
+  appSecret: 'your-app-secret',
+});
+
+const token = await client.getToken();
+```
+
+## Example
+
+```typescript
+import { MiauClient } from '@eduzz/miau-client';
+
+const MIAU_API_URL = process.env.MIAU_API_URL!;
+const MIAU_APP_SECRET = process.env.MIAU_APP_SECRET!;
+const YOUR_API_URL = process.env.YOUR_API_URL || 'https://your-api.example.com';
+
+const miau = new MiauClient({ apiUrl: MIAU_API_URL, appSecret: MIAU_APP_SECRET });
+const token = await miau.getToken();
+
+const response = await fetch(`${YOUR_API_URL}/your/endpoint`, {
+  headers: { Authorization: `Bearer ${token}` },
+});
+
+const data = await response.json();
+console.log(JSON.stringify(data, null, 2));
+```
+
+## Express Middleware
+
+Validates incoming requests using Miau tokens and checks permissions automatically.
+
+```typescript
+import express from 'express';
+import { MiauClient } from '@eduzz/miau-client';
+
+const app = express();
+const miau = new MiauClient({ apiUrl: MIAU_API_URL, appSecret: MIAU_APP_SECRET });
+
+app.use(miau.middleware());
+
+app.get('/your/endpoint', (req, res) => {
+  // req.miauApplication - the authenticated application
+  // req.miauMetadata - permission metadata
+  res.json({ app: req.miauApplication });
+});
+```
+
+With custom request augmentation:
+
+```typescript
+app.use(
+  miau.middleware({
+    requestAugmentation: ({ req, app, meta }) => {
+      // Attach custom data to the request
+    },
+    fallbackMiddleware: (req, res, next) => {
+      // Called when token is missing/malformed (400 errors)
+      next();
+    },
+  })
+);
+```
+
+## Fastify Hook
+
+```typescript
+import Fastify from 'fastify';
+import { MiauClient } from '@eduzz/miau-client';
+
+const app = Fastify();
+const miau = new MiauClient({ apiUrl: MIAU_API_URL, appSecret: MIAU_APP_SECRET });
+
+app.addHook('preHandler', miau.hook());
+
+app.get('/your/endpoint', async (request, reply) => {
+  // request.miauApplication - the authenticated application
+  // request.miauMetadata - permission metadata
+  return { app: request.miauApplication };
+});
+```
+
+## API
+
+### `new MiauClient({ apiUrl, appSecret })`
+
+Creates a new client instance.
+
+| Parameter   | Type     | Description                  |
+|------------|----------|------------------------------|
+| `apiUrl`   | `string` | Miau API base URL            |
+| `appSecret`| `string` | Application secret from Miau |
+
+### `client.getToken(): Promise<string>`
+
+Returns a valid JWT access token. Tokens are cached in memory and automatically refreshed when they are within 60 seconds of expiration.
+
+### `client.getTokenData(): Promise<MiauClientToken>`
+
+Returns the decoded token payload.
+
+### `client.getEnvironment(): SecretEnv`
+
+Returns the environment extracted from the app secret (e.g. `production`, `staging`).
+
+### `client.getPublicKey(kid: string): Promise<string>`
+
+Fetches and caches the public key for the given key ID from the JWKS endpoint.
+
+### `client.verify(token: string, publicKey: string): Promise<MiauClientToken>`
+
+Verifies a JWT token using the provided public key (RS256).
+
+### `client.hasPermission(sourceAppId: string, resource: Resource): Promise<HasPermissionResponse>`
+
+Checks if a source application has permission to access a given resource.
+
+### `client.middleware(config?): RequestHandler`
+
+Returns an Express middleware that authenticates requests and checks permissions.
+
+### `client.hook(config?): FastifyHook`
+
+Returns a Fastify `preHandler` hook that authenticates requests and checks permissions.
+
+## Requirements
+
+- Node.js >= 18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eduzz/miau-client",
-  "version": "1.4.1",
+  "version": "1.4.2-rc.8",
   "description": "Eduzz Miau Client",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",