@qidcloud/sdk 1.2.1 → 1.2.2

package/README.md

@@ -1,68 +1,142 @@
 # @qidcloud/sdk
 
-The official JavaScript/TypeScript SDK for QidCloud. Build PQC-secured, enclave-backed applications in minutes.
+The official JavaScript/TypeScript SDK for QidCloud. Build PQC-secured, enclave-backed applications with ease.
 
-## 🚀 30-Minute Quick Start
+## 🚀 Installation
 
-### 1. Install
 ```bash
 npm install @qidcloud/sdk
 ```
 
-### 2. Initialize
+## 🛠️ Initialization
+
 ```typescript
 import { QidCloud } from '@qidcloud/sdk';
 
 const qid = new QidCloud({
   apiKey: 'your_api_key',   // Found in QidCloud Console -> Settings
-  tenantId: 'your_project_id'
+  tenantId: 'your_project_id' // Optional, for project-scoped operations
 });
 ```
 
 ---
 
-## 🔑 Identity (`qid.auth`)
-
-Enforce Pure Post-Quantum Identity with zero passwords.
+## 🛡️ Identity & Auth (`qid.auth`)
 
 ### `createSession()`
-Initiates a new QR handshake session.
-- **Returns**: `Promise<QidAuthSession>` 
+Initializes a new PQC handshake session for QR login.
+- **Returns**: `Promise<{ sessionId: string, qrData: string, expiresAt: number }>`
+```typescript
+const { sessionId, qrData } = await qid.auth.createSession();
+```
+
+### `getProfile(token)`
+Verifies a session token and retrieves the user profile.
+- **Returns**: `Promise<QidUser>`
+```typescript
+const user = await qid.auth.getProfile(sessionToken);
+```
+
+### `listen(sessionId, onAuthorized, onDenied?)`
+Listen for real-time authorization events via WebSocket.
+```typescript
+qid.auth.listen(sessionId, 
+  (token) => console.log('Authenticated:', token), 
+  (error) => console.error('Denied:', error)
+);
+```
 
 ---
 
-## 🏗️ React Integration
+## 🗄️ Secure Vault (`qid.vault`)
+
+### `upload(file, name, metadata?, userToken?)`
+Encrypt and upload a file to the secure enclave.
+- **Returns**: `Promise<QidUploadResponse>`
+```typescript
+await qid.vault.upload(fileBlob, 'secret.pdf', { tag: 'confidential' }, userToken);
+```
 
-The SDK provides powerful React tools for seamless integration.
+### `list(userToken?)`
+List all encrypted files.
+- **Returns**: `Promise<QidFile[]>`
+```typescript
+const files = await qid.vault.list(userToken);
+```
 
-### `useQidAuth(sdk)`
-The recommended way to manage auth state in React.
+### `download(fileId, userToken?)`
+Download a file as an ArrayBuffer.
+```typescript
+const buffer = await qid.vault.download('file_123', userToken);
+```
 
-```tsx
-import { useQidAuth } from '@qidcloud/sdk';
+### `delete(fileId, userToken?)`
+Soft delete a file (move to recycle bin).
+```typescript
+await qid.vault.delete('file_123', userToken);
+```
 
-function MyComponent({ qid }) {
-  const { user, token, session, login, initializing } = useQidAuth(qid);
+---
 
-  if (user) return <p>Welcome, {user.username}</p>;
+## ⚡ Edge Computing (`qid.edge`)
 
-  return (
-    <button onClick={login}>
-      {initializing ? 'Connecting...' : 'Login'}
-    </button>
-  );
-}
+### `invoke(name, params?, userToken?)`
+Invoke a serverless edge function.
+- **Returns**: `Promise<QidEdgeResponse>`
+```typescript
+const result = await qid.edge.invoke('secure-calc', { input: 42 }, userToken);
 ```
 
-### `QidSignInButton`
-A plug-and-play button that handles the entire handshake UI.
+### `list()`
+List all provisioned functions.
+```typescript
+const functions = await qid.edge.list();
+```
+
+### `getLogs(name, userToken?)`
+Get logs for a specific function.
+```typescript
+const logs = await qid.edge.getLogs('my-function', userToken);
+```
+
+### `deploy(data, userToken?)`
+Deploy or update a function.
+```typescript
+await qid.edge.deploy({ 
+  name: 'new-func', 
+  code: '...', 
+  runtime: 'node18' 
+}, userToken);
+```
+
+---
+
+## 📊 Observability (`qid.logs`)
+
+### `write(message, source?, level?, meta?)`
+Ingest custom telemetry into the enclave.
+```typescript
+await qid.logs.write('User action detected', 'frontend', 'info', { userId: '123' });
+```
+
+### `fetch(query?)`
+Retrieve project logs.
+```typescript
+const logs = await qid.logs.fetch({ limit: 50, level: 'error' });
+```
+
+---
+
+## ⚛️ React Helpers
 
+### `useQidAuth(sdk)`
+Hook for managing authentication state.
 ```tsx
-import { QidSignInButton } from '@qidcloud/sdk';
+const { user, login, logout } = useQidAuth(qid);
+```
 
-<QidSignInButton 
-  sdk={qid}
-  onSuccess={(user, token) => console.log(user)}
-  onError={(err) => alert(err)}
-/>
+### `QidSignInButton`
+Pre-built component for PQC login.
+```tsx
+<QidSignInButton sdk={qid} onSuccess={(user) => console.log(user)} />
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qidcloud/sdk",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "The official JavaScript/TypeScript SDK for QidCloud Identity and Enclave Services.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",