@inai-dev/shared 1.0.0 → 1.1.0

package/README.md

@@ -1,6 +1,6 @@
 # @inai-dev/shared
 
-Shared utilities for the InAI Auth SDK. Includes validators, error classes, JWT helpers, URL utilities, and constants.
+Shared utilities for the InAI Auth SDK. Includes error class, JWT helpers, validators, URL utilities, and constants.
 
 ## Installation
 
@@ -10,25 +10,82 @@ npm install @inai-dev/shared
 
 > **Note:** You typically don't need to install this directly. It's included as a dependency of higher-level packages.
 
-## Usage
+## Exports
+
+### Error Class
 
 ```ts
-import { InAIError, isInAIError } from "@inai-dev/shared";
-import { validateEmail, validatePassword } from "@inai-dev/shared";
-import { AUTH_COOKIE_NAME, REFRESH_COOKIE_NAME } from "@inai-dev/shared";
+import { InAIAuthError } from "@inai-dev/shared";
+
+try {
+  // ...
+} catch (err) {
+  if (err instanceof InAIAuthError) {
+    console.error(err.status, err.message, err.body);
+  }
+}
 ```
 
-## Exports
+### JWT Utilities
+
+```ts
+import { decodeJWTPayload, isTokenExpired, getClaimsFromToken } from "@inai-dev/shared";
+
+const payload = decodeJWTPayload(token);   // Raw JWT payload or null
+const expired = isTokenExpired(token);      // boolean
+const claims = getClaimsFromToken(token);   // JWTClaims or null
+```
+
+### Validators
+
+```ts
+import { isValidEmail, isStrongPassword } from "@inai-dev/shared";
+
+isValidEmail("user@example.com");  // true
+isStrongPassword("MyP@ss1234");    // true
+```
+
+### Constants
+
+```ts
+import {
+  COOKIE_AUTH_TOKEN,       // "auth_token"
+  COOKIE_REFRESH_TOKEN,    // "refresh_token"
+  COOKIE_AUTH_SESSION,     // "auth_session"
+  DEFAULT_SIGN_IN_URL,     // "/login"
+  DEFAULT_SIGN_UP_URL,     // "/register"
+  DEFAULT_AFTER_SIGN_IN_URL,  // "/"
+  DEFAULT_AFTER_SIGN_OUT_URL, // "/login"
+  HEADER_PUBLISHABLE_KEY,  // "X-Publishable-Key"
+  HEADER_AUTHORIZATION,    // "Authorization"
+  HEADER_INAI_AUTH,        // "x-inai-auth"
+  DEFAULT_API_URL,         // Internal — not for public use
+} from "@inai-dev/shared";
+```
+
+### URL Utilities
 
-- **Errors**: `InAIError`, `isInAIError`, error codes
-- **Validators**: Email, password, and input validation
-- **JWT**: Token decode and verification utilities
-- **URL**: API URL builder helpers
-- **Constants**: Cookie names, header names, default values
+```ts
+import { normalizeApiUrl, buildEndpoint } from "@inai-dev/shared";
+```
 
-## Documentation
+## Exports Reference
 
-See the full [API Reference](https://github.com/inai-dev/sdk/blob/main/docs/api-reference.md).
+| Export | Kind | Description |
+|---|---|---|
+| `InAIAuthError` | Class | Auth error with status and body |
+| `decodeJWTPayload` | Function | Decode JWT payload (no verification) |
+| `isTokenExpired` | Function | Check if JWT is expired |
+| `getClaimsFromToken` | Function | Extract typed JWTClaims from token |
+| `isValidEmail` | Function | Email format validation |
+| `isStrongPassword` | Function | Password strength validation |
+| `normalizeApiUrl` | Function | Normalize API URL (trailing slash) |
+| `buildEndpoint` | Function | Build full API endpoint URL |
+| `COOKIE_AUTH_TOKEN` | Constant | Auth token cookie name |
+| `COOKIE_REFRESH_TOKEN` | Constant | Refresh token cookie name |
+| `COOKIE_AUTH_SESSION` | Constant | Session cookie name |
+| `DEFAULT_API_URL` | Constant | Default API URL (internal) |
+| `HEADER_PUBLISHABLE_KEY` | Constant | Publishable key header name |
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inai-dev/shared",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Shared utilities for the InAI Auth SDK",
   "type": "module",
   "main": "./dist/index.js",
@@ -24,7 +24,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@inai-dev/types": "^1.0.0"
+    "@inai-dev/types": "^1.1.0"
   },
   "sideEffects": false,
   "publishConfig": {