@fluentcommerce/fc-connect-sdk 0.1.48 → 0.1.52

package/docs/versori-apis/JWT-GENERATION-GUIDE.md

@@ -1,94 +0,0 @@
-# Versori JWT Generation Guide
-
-This guide explains how to generate JWT tokens for the Versori Platform API using your private key.
-
-## Prerequisites
-
-- **Private Key**: You need the RSA private key associated with your Signing Key ID.
-- **Signing Key ID**: The ID of the signing key in the Versori Platform.
-
-## JWT Structure
-
-The JWT must be signed using `RS256` algorithm and contain the following claims:
-
-- **Header**:
-  ```json
-  {
-    "alg": "RS256",
-    "kid": "YOUR_SIGNING_KEY_ID"
-  }
-  ```
-
-- **Payload**:
-  ```json
-  {
-    "sub": "api-access", // or End User ID
-    "iss": "https://versori.com/sk/YOUR_SIGNING_KEY_ID",
-    "iat": 1678886400, // Current timestamp (seconds)
-    "exp": 1994446400  // Expiration timestamp (seconds)
-  }
-  ```
-
-## Node.js Script
-
-You can use the following Node.js script to generate a token.
-
-**File:** `generate-versori-jwt.js`
-
-```javascript
-const crypto = require('crypto');
-
-// YOUR PRIVATE KEY HERE
-const PRIVATE_KEY = `-----BEGIN PRIVATE KEY-----
-...
------END PRIVATE KEY-----`;
-
-// YOUR SIGNING KEY ID HERE
-const SIGNING_KEY_ID = 'YOUR_SIGNING_KEY_ID_HERE';
-
-function generateJWT(subject = 'api-access', expiresInSeconds = 3600) {
-  const header = {
-    alg: 'RS256',
-    kid: SIGNING_KEY_ID
-  };
-
-  const now = Math.floor(Date.now() / 1000);
-  const payload = {
-    sub: subject,
-    iss: `https://versori.com/sk/${SIGNING_KEY_ID}`,
-    iat: now,
-    exp: now + expiresInSeconds
-  };
-
-  const encodedHeader = Buffer.from(JSON.stringify(header))
-    .toString('base64url')
-    .replace(/=/g, '');
-  
-  const encodedPayload = Buffer.from(JSON.stringify(payload))
-    .toString('base64url')
-    .replace(/=/g, '');
-
-  const signatureInput = `${encodedHeader}.${encodedPayload}`;
-  const signature = crypto
-    .createSign('RSA-SHA256')
-    .update(signatureInput)
-    .sign(PRIVATE_KEY, 'base64url')
-    .replace(/=/g, '');
-
-  return `${encodedHeader}.${encodedPayload}.${signature}`;
-}
-
-console.log(generateJWT());
-```
-
-## Usage
-
-1.  **Generate Token**: Run the script to get your JWT.
-2.  **Use in Header**: Add the token to your API requests:
-    ```
-    Authorization: JWT <your_token>
-    ```
-
-**Note**: The prefix is `JWT`, not `Bearer`.
-
-

package/docs/versori-apis/QUICK-WORKFLOW.md

@@ -1,293 +0,0 @@
-# Versori Platform API - Quick Workflow Guide
-
-**Common tasks using the Postman collection**
-
----
-
-## 🚀 Quick Start: Add User to Project
-
-**Goal:** Activate a new user on a project with their specific variables
-
-### Step 1: Get Project Details
-```
-GET /o/{org_id}/projects/{project_id}
-```
-**Save from response:**
-- `environments[0].id` → Use as `environment_id`
-
----
-
-### Step 2: Get Connection Templates
-```
-GET /o/{org_id}/projects/{project_id}/connection-templates
-```
-**Save from response:**
-- Template IDs you need (e.g., for S3, Shopify, etc.)
-
----
-
-### Step 3: Create User (if new)
-```
-POST /o/{org_id}/users
-{
-  "externalId": "customer-123",
-  "displayName": "Customer Name"
-}
-```
-**Save from response:**
-- `id` → Use as `user_id`
-
----
-
-### Step 4: Get or Create Connection
-```
-GET /o/{org_id}/connections
-```
-Find existing connection OR create new:
-```
-POST /o/{org_id}/connections
-{
-  "name": "Customer S3 Connection",
-  "type": "s3",
-  "credentials": {
-    "accessKeyId": "...",
-    "secretAccessKey": "..."
-  }
-}
-```
-**Save from response:**
-- `id` → Use as `connection_id`
-
----
-
-### Step 5: Activate User
-```
-POST /o/{org_id}/activations
-{
-  "userId": "{user_id}",
-  "environmentId": "{environment_id}",
-  "connections": [
-    {
-      "connectionTemplateId": "{template_id}",
-      "existingConnectionId": "{connection_id}"
-    }
-  ],
-  "dynamicVariables": {
-    "apiKey": "customer-api-key",
-    "accountId": "12345",
-    "customSetting": "value"
-  }
-}
-```
-**Save from response:**
-- `id` → Use as `activation_id`
-
----
-
-## 📋 View User's Current Setup
-
-### Get Activation (includes variables!)
-```
-GET /o/{org_id}/activations/{activation_id}
-```
-
-**Response includes:**
-```json
-{
-  "id": "activation_id",
-  "user": {
-    "id": "...",
-    "displayName": "Customer Name"
-  },
-  "environment": {
-    "id": "...",
-    "name": "production"
-  },
-  "connections": [...],
-  "dynamicVariables": {     ← Current variable values
-    "apiKey": "customer-api-key",
-    "accountId": "12345"
-  }
-}
-```
-
----
-
-## ✏️ Update User Variables
-
-### Update Multiple Variables
-```
-PATCH /o/{org_id}/environments/{env_id}/activations/{activation_id}/variables
-{
-  "apiKey": "new-api-key",
-  "accountId": "67890"
-}
-```
-
-### Update Single Variable
-```
-PUT /o/{org_id}/environments/{env_id}/activations/{activation_id}/variables/{variable_name}
-{
-  "value": "new-value"
-}
-```
-
-**⚠️ Important:** If any **required** variables are missing, you must include them even if not changing them.
-
----
-
-## 🗂️ Manage Project Files
-
-### Upload Files
-```
-PUT /o/{org_id}/projects/{project_id}/files
-(multipart/form-data with your code files)
-```
-
-### Download Files
-```
-GET /o/{org_id}/projects/{project_id}/files
-```
-
----
-
-## 📊 Get Project Logs
-
-### Time-Based Logs
-```
-GET /o/{org_id}/projects/{project_id}/logs?project_env=production&start=2025-01-01T00:00:00Z&end=2025-01-19T23:59:59Z&limit=500
-```
-
-**Query Parameters:**
-- `project_env`: "production", "staging", etc.
-- `start`: ISO timestamp or Unix timestamp
-- `end`: ISO timestamp or Unix timestamp
-- `limit`: Number of logs (max varies)
-- `nextToken`: For pagination (from previous response)
-
----
-
-## 🔍 List All Users and Activations
-
-### List All Users
-```
-GET /o/{org_id}/users
-```
-
-### List All Activations (Org-Wide)
-```
-GET /o/{org_id}/activations
-```
-
-### List Activations for Specific Environment
-```
-GET /o/{org_id}/environments/{env_id}/activations
-```
-
----
-
-## 🎯 Common Scenarios
-
-### Scenario 1: Find Which Users Are Activated
-
-1. Get all users: `GET /o/{org_id}/users`
-2. Get all activations: `GET /o/{org_id}/activations`
-3. Match `activation.userId` with `user.id`
-
-### Scenario 2: Check What Variables a User Has
-
-1. Get activation: `GET /o/{org_id}/activations/{activation_id}`
-2. Look at `dynamicVariables` in response
-3. Compare with schema: `GET /o/{org_id}/projects/{project_id}/variables`
-
-### Scenario 3: Update Multiple Users' Variables
-
-For each activation:
-```
-PATCH /o/{org_id}/environments/{env_id}/activations/{activation_id}/variables
-{
-  "commonSetting": "new-value"
-}
-```
-
----
-
-## 🔐 Variable Schema Validation
-
-### Get Variable Schema (What SHOULD exist)
-```
-GET /o/{org_id}/projects/{project_id}/variables
-```
-
-**Response:**
-```json
-{
-  "properties": {
-    "apiKey": {
-      "type": "string",
-      "description": "API Key for external service"
-    },
-    "accountId": {
-      "type": "string"
-    }
-  },
-  "required": ["apiKey"]  ← Must be present in activation!
-}
-```
-
-### Set/Update Variable Schema
-```
-PUT /o/{org_id}/projects/{project_id}/variables
-{
-  "properties": {
-    "newVariable": {
-      "type": "string",
-      "description": "Description here"
-    }
-  },
-  "required": ["newVariable"]
-}
-```
-
----
-
-## 💡 Pro Tips
-
-1. **Get Connection Templates First**
-   Always fetch `GET /projects/{id}/connection-templates` before activating users.
-
-2. **Activation Includes Variables**
-   Use `GET /activations/{id}` to see current variable values (no separate endpoint).
-
-3. **Required Variables**
-   When updating variables, if required vars are missing, include them in the PATCH.
-
-4. **Pagination**
-   Use `nextToken` from response for paginated endpoints (logs, lists).
-
-5. **Environment Config**
-   Update environment-level settings: `PATCH /o/{org_id}/environments/{env_id}/config`
-
----
-
-## 📚 Related Guides
-
-- [ACTIVATIONS-AND-VARIABLES-GUIDE.md](./ACTIVATIONS-AND-VARIABLES-GUIDE.md) - Detailed activation concepts
-- [JWT-GENERATION-GUIDE.md](./JWT-GENERATION-GUIDE.md) - How to generate auth tokens
-- [README.md](./README.md) - Postman collection setup
-
----
-
-## 🆘 Troubleshooting
-
-**Error: "connectionTemplateId is required"**
-→ Get templates first: `GET /projects/{id}/connection-templates`
-
-**Error: "missing properties: 'apiKey'"**
-→ Include all required variables from schema in your PATCH request
-
-**Error: "404 Not Found" on environments**
-→ Environments are created on deployment, not manually
-
-**Error: "401 Unauthorized"**
-→ Check JWT token in environment variables (see JWT-GENERATION-GUIDE.md)

package/docs/versori-apis/README.md

@@ -1,73 +0,0 @@
-# Versori Platform API
-
-This directory contains the official Postman collection for the Versori Platform API, organized to match the [official documentation structure](https://docs.versori.com/latest/api-reference/platform-api/getting-started).
-
-> **⚠️ SECURITY:** Never commit credentials to version control. Use the `.example.json` template and keep your actual credentials local only.
-
-## Contents
-
-- **`Versori-Platform-API.postman_collection.json`**: Complete Postman collection (104 requests).
-- **`Versori-Platform-API.postman_environment.example.json`**: Environment template (copy and rename to `.postman_environment.json`).
-- **`QUICK-WORKFLOW.md`**: Step-by-step workflows for common tasks.
-- **`ACTIVATIONS-AND-VARIABLES-GUIDE.md`**: Detailed guide on managing activations and variables.
-- **`JWT-GENERATION-GUIDE.md`**: How to generate authentication tokens.
-
-## Structure
-
-The collection is organized into the following folders, matching the API reference:
-
-1.  **projects**: Manage projects and their configurations (Create, Read, Update, Delete).
-2.  **connections**: Manage connections to external systems.
-3.  **end_users**: Manage users within the organization.
-4.  **activations**: Manage activations and their dynamic variables.
-5.  **systems**: Manage systems and integrations.
-
-## Quick Start
-
-1.  **Import Collection**:
-    *   Open Postman.
-    *   Click **Import**.
-    *   Drag and drop `Versori-Platform-API.postman_collection.json`.
-
-2.  **Setup Environment**:
-    *   Copy `Versori-Platform-API.postman_environment.example.json` to `Versori-Platform-API.postman_environment.json`
-    *   Fill in your actual credentials (the `.json` file is gitignored)
-    *   Import the configured file into Postman
-
-3.  **Configure Environment**:
-    *   Select "Versori Platform API - Environment" from the environment dropdown (top right).
-    *   Click the "Eye" icon to edit variables.
-    *   Set `jwt_token` (Required for all requests).
-    *   Set `organisation_id` (Required for all requests).
-    *   Set other IDs (`project_id`, `environment_id`, etc.) as needed for specific requests.
-
-## Authentication
-
-All requests use **JWT Authentication**.
-The collection is configured to automatically add the `Authorization: JWT {{jwt_token}}` header to every request.
-
-**Important**: Ensure your `jwt_token` variable in the environment is valid and not expired.
-
-## Common Workflows
-
-### 1. Get Project Details
-*   **Folder**: `projects`
-*   **Request**: `Get Project`
-*   **Requires**: `organisation_id`, `project_id`
-
-### 2. Update Activation Variables
-*   **Folder**: `activations`
-*   **Request**: `Update Activation Variables`
-*   **Requires**: `organisation_id`, `environment_id`, `activation_id`
-*   **Body**: JSON object with variable key-value pairs.
-
-### 3. List Users
-*   **Folder**: `end_users`
-*   **Request**: `List Users`
-*   **Requires**: `organisation_id`
-
-## 📚 Documentation
-
-- **[QUICK-WORKFLOW.md](./QUICK-WORKFLOW.md)** - Common workflows (add users, manage variables, get logs)
-- **[ACTIVATIONS-AND-VARIABLES-GUIDE.md](./ACTIVATIONS-AND-VARIABLES-GUIDE.md)** - Activation concepts and variable validation
-- **[JWT-GENERATION-GUIDE.md](./JWT-GENERATION-GUIDE.md)** - Generate authentication tokens