@flowripple/sdk 1.0.0 → 3.0.0

package/README.md

@@ -1,6 +1,6 @@
 # @flowripple/sdk
 
-The official Node.js SDK for Flowripple - a powerful event tracking and analytics platform.
+The official Node.js SDK for Flowripple - a visual workflow automation platform.
 
 ## Installation
 
@@ -16,30 +16,35 @@ Or using yarn:
 yarn add @flowripple/sdk
 ```
 
+Or using pnpm:
+
+```bash
+pnpm add @flowripple/sdk
+```
+
 ## Usage
 
-First, import and initialize the FlowrippleClient with your API credentials:
+First, import and initialize the FlowrippleClient with your API key:
 
 ```typescript
 import { FlowrippleClient } from '@flowripple/sdk';
 
 const client = new FlowrippleClient({
-  apiClientId: YOUR_CLIENT_ID,
-  apiKey: 'YOUR_API_KEY'
+  apiKey: 'frp_your-api-key'
 });
 ```
 
-Then use the client to capture events:
+Then use the client to trigger workflow events:
 
 ```typescript
-// Capture a simple event
-await client.capture('user.signup', {
+// Trigger a simple event
+await client.trigger('user.signup', {
   userId: '123',
   email: 'user@example.com'
 });
 
-// Capture an event with custom properties
-await client.capture('order.completed', {
+// Trigger an event with custom data
+await client.trigger('order.completed', {
   orderId: 'ord_123',
   amount: 99.99,
   currency: 'USD',
@@ -59,20 +64,18 @@ The `FlowrippleClient` constructor accepts a configuration object with the follo
 
 | Option | Type | Required | Default | Description |
 |--------|------|----------|---------|-------------|
-| `apiClientId` | number | Yes | - | Your Flowripple API Client ID |
-| `apiKey` | string | Yes | - | Your Flowripple API Key |
+| `apiKey` | string | Yes | - | Your Flowripple API Key (starts with `frp_`) |
 | `baseUrl` | string | No | 'https://api.flowripple.com' | Custom API base URL |
 | `silent` | boolean | No | false | If true, failed API calls return false instead of throwing errors |
-| `version` | 'v1' | No | 'v1' | API version to use |
 
 #### Methods
 
-##### `capture(eventName: string, payload: object): Promise<false | void>`
+##### `trigger(identifier: string, data?: Record<string, any>): Promise<false | void>`
 
-Captures an event by sending it to the Flowripple API.
+Triggers a workflow by sending an event to the Flowripple API.
 
-- `eventName`: The name of the event to capture
-- `payload`: An object containing the event data
+- `identifier`: The event identifier to trigger (e.g., 'user.signup', 'order.completed')
+- `data`: Optional object containing the event data
 - Returns: A promise that resolves to `void` on success, or `false` if the request fails and silent mode is enabled
 - Throws: An error if the request fails and silent mode is not enabled
 
@@ -82,15 +85,14 @@ By default, the SDK will throw errors when API requests fail. You can enable sil
 
 ```typescript
 const client = new FlowrippleClient({
-  apiClientId: YOUR_CLIENT_ID,
-  apiKey: 'YOUR_API_KEY',
+  apiKey: 'frp_your-api-key',
   silent: true
 });
 
 // This will return false instead of throwing if the request fails
-const result = await client.capture('user.signup', { userId: '123' });
+const result = await client.trigger('user.signup', { userId: '123' });
 if (result === false) {
-  console.log('Event capture failed');
+  console.log('Event trigger failed');
 }
 ```
 

package/dist/index.d.mts

@@ -2,9 +2,7 @@
  * Configuration options for initializing the FlowrippleClient
  */
 interface FlowrippleClientOptions {
-    /** (Required) Flowripple API Client ID */
-    apiClientId: number;
-    /** (Required) API key for authentication with Flowripple */
+    /** (Required) API key for authentication with Flowripple (starts with frp_) */
     apiKey: string;
     /** (Optional) Base URL for the Flowripple API. Defaults to https://api.flowripple.com */
     baseUrl?: string;
@@ -19,10 +17,10 @@ interface FlowrippleClientOptions {
  * @example
  * ```typescript
  * const client = new FlowrippleClient({
- *   apiKey: 'your-api-key'
+ *   apiKey: 'frp_your-api-key'
  * });
  *
- * await client.capture('user.signup', {
+ * await client.trigger('user.signup', {
  *   userId: '123',
  *   email: 'user@example.com'
  * });
@@ -37,14 +35,14 @@ declare class FlowrippleClient {
      */
     constructor(options: FlowrippleClientOptions);
     /**
-     * Captures an event by sending it to the Flowripple API
-     * @param eventName - The name of the event to capture
-     * @param payload - The payload data associated with the event
-     * @returns Promise that resolves to true if the event was successfully captured,
+     * Triggers a workflow by sending an event to the Flowripple API
+     * @param identifier - The event identifier to trigger
+     * @param data - Optional data payload associated with the event
+     * @returns Promise that resolves to void on success,
      *          or false if silent mode is enabled and the request failed
      * @throws {Error} If the request fails and silent mode is not enabled
      */
-    capture(eventName: string, payload: object): Promise<false | void>;
+    trigger(identifier: string, data?: Record<string, any>): Promise<false | void>;
 }
 
 export { FlowrippleClient };

package/dist/index.d.ts

@@ -2,9 +2,7 @@
  * Configuration options for initializing the FlowrippleClient
  */
 interface FlowrippleClientOptions {
-    /** (Required) Flowripple API Client ID */
-    apiClientId: number;
-    /** (Required) API key for authentication with Flowripple */
+    /** (Required) API key for authentication with Flowripple (starts with frp_) */
     apiKey: string;
     /** (Optional) Base URL for the Flowripple API. Defaults to https://api.flowripple.com */
     baseUrl?: string;
@@ -19,10 +17,10 @@ interface FlowrippleClientOptions {
  * @example
  * ```typescript
  * const client = new FlowrippleClient({
- *   apiKey: 'your-api-key'
+ *   apiKey: 'frp_your-api-key'
  * });
  *
- * await client.capture('user.signup', {
+ * await client.trigger('user.signup', {
  *   userId: '123',
  *   email: 'user@example.com'
  * });
@@ -37,14 +35,14 @@ declare class FlowrippleClient {
      */
     constructor(options: FlowrippleClientOptions);
     /**
-     * Captures an event by sending it to the Flowripple API
-     * @param eventName - The name of the event to capture
-     * @param payload - The payload data associated with the event
-     * @returns Promise that resolves to true if the event was successfully captured,
+     * Triggers a workflow by sending an event to the Flowripple API
+     * @param identifier - The event identifier to trigger
+     * @param data - Optional data payload associated with the event
+     * @returns Promise that resolves to void on success,
      *          or false if silent mode is enabled and the request failed
      * @throws {Error} If the request fails and silent mode is not enabled
      */
-    capture(eventName: string, payload: object): Promise<false | void>;
+    trigger(identifier: string, data?: Record<string, any>): Promise<false | void>;
 }
 
 export { FlowrippleClient };

package/dist/index.js

@@ -54,7 +54,6 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 var import_axios = __toESM(require("axios"));
-var import_crypto = __toESM(require("crypto"));
 var FlowrippleClient = class {
   /**
    * Creates a new FlowrippleClient instance
@@ -65,31 +64,26 @@ var FlowrippleClient = class {
     this.baseUrl = options.baseUrl || "https://api.flowripple.com";
   }
   /**
-   * Captures an event by sending it to the Flowripple API
-   * @param eventName - The name of the event to capture
-   * @param payload - The payload data associated with the event
-   * @returns Promise that resolves to true if the event was successfully captured,
+   * Triggers a workflow by sending an event to the Flowripple API
+   * @param identifier - The event identifier to trigger
+   * @param data - Optional data payload associated with the event
+   * @returns Promise that resolves to void on success,
    *          or false if silent mode is enabled and the request failed
    * @throws {Error} If the request fails and silent mode is not enabled
    */
-  capture(eventName, payload) {
+  trigger(identifier, data) {
     return __async(this, null, function* () {
       var _a, _b;
       try {
         const body = {
-          event: eventName,
-          payload
+          identifier,
+          data: data || {}
         };
-        const timestamp = Date.now().toString();
-        const stringToSign = timestamp + JSON.stringify(body);
-        const hmac = import_crypto.default.createHmac("sha256", this.options.apiKey).update(stringToSign).digest("hex");
-        const url = `${this.baseUrl.replace(/^\/+/, "")}/sdk/${(_a = this.options.version) != null ? _a : "v1"}/capture`;
+        const url = `${this.baseUrl.replace(/\/+$/, "")}/api/${(_a = this.options.version) != null ? _a : "v1"}/trigger`;
         yield import_axios.default.post(url, body, {
           headers: {
             "Content-Type": "application/json",
-            "X-Flowripple-Api-Client-Id": this.options.apiClientId,
-            "X-Flowripple-Signature": hmac,
-            "X-Flowripple-Timestamp": timestamp
+            "x-api-key": this.options.apiKey
           }
         });
         return;
@@ -98,7 +92,7 @@ var FlowrippleClient = class {
           return false;
         }
         throw new Error(
-          `Failed to capture event: ${(_b = error == null ? void 0 : error.message) != null ? _b : error}`
+          `Failed to trigger event: ${(_b = error == null ? void 0 : error.message) != null ? _b : error}`
         );
       }
     });

package/dist/index.mjs

@@ -21,7 +21,6 @@ var __async = (__this, __arguments, generator) => {
 
 // src/index.ts
 import axios from "axios";
-import crypto from "crypto";
 var FlowrippleClient = class {
   /**
    * Creates a new FlowrippleClient instance
@@ -32,31 +31,26 @@ var FlowrippleClient = class {
     this.baseUrl = options.baseUrl || "https://api.flowripple.com";
   }
   /**
-   * Captures an event by sending it to the Flowripple API
-   * @param eventName - The name of the event to capture
-   * @param payload - The payload data associated with the event
-   * @returns Promise that resolves to true if the event was successfully captured,
+   * Triggers a workflow by sending an event to the Flowripple API
+   * @param identifier - The event identifier to trigger
+   * @param data - Optional data payload associated with the event
+   * @returns Promise that resolves to void on success,
    *          or false if silent mode is enabled and the request failed
    * @throws {Error} If the request fails and silent mode is not enabled
    */
-  capture(eventName, payload) {
+  trigger(identifier, data) {
     return __async(this, null, function* () {
       var _a, _b;
       try {
         const body = {
-          event: eventName,
-          payload
+          identifier,
+          data: data || {}
         };
-        const timestamp = Date.now().toString();
-        const stringToSign = timestamp + JSON.stringify(body);
-        const hmac = crypto.createHmac("sha256", this.options.apiKey).update(stringToSign).digest("hex");
-        const url = `${this.baseUrl.replace(/^\/+/, "")}/sdk/${(_a = this.options.version) != null ? _a : "v1"}/capture`;
+        const url = `${this.baseUrl.replace(/\/+$/, "")}/api/${(_a = this.options.version) != null ? _a : "v1"}/trigger`;
         yield axios.post(url, body, {
           headers: {
             "Content-Type": "application/json",
-            "X-Flowripple-Api-Client-Id": this.options.apiClientId,
-            "X-Flowripple-Signature": hmac,
-            "X-Flowripple-Timestamp": timestamp
+            "x-api-key": this.options.apiKey
           }
         });
         return;
@@ -65,7 +59,7 @@ var FlowrippleClient = class {
           return false;
         }
         throw new Error(
-          `Failed to capture event: ${(_b = error == null ? void 0 : error.message) != null ? _b : error}`
+          `Failed to trigger event: ${(_b = error == null ? void 0 : error.message) != null ? _b : error}`
         );
       }
     });

package/package.json

@@ -1,7 +1,13 @@
 {
   "name": "@flowripple/sdk",
-  "version": "1.0.0",
+  "version": "3.0.0",
   "description": "FlowRipple SDK",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/FlowRipple/sdk.git"
@@ -31,6 +37,6 @@
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "test": "jest",
-    "ci:publish": "pnpm test && pnpm build && changeset publish --access public"
+    "ci:publish": "pnpm build && changeset publish --access public"
   }
 }

package/.changeset/README.md

@@ -1,8 +0,0 @@
-# Changesets
-
-Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
-with multi-package repos, or single-package repos to help you version and publish your code. You can
-find the full documentation for it [in our repository](https://github.com/changesets/changesets)
-
-We have a quick list of common questions to get you started engaging with this project in
-[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@3.0.5/schema.json",
-  "changelog": "@changesets/cli/changelog",
-  "commit": false,
-  "fixed": [],
-  "linked": [],
-  "access": "restricted",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}

package/.env.test

@@ -1,3 +0,0 @@
-FLOWRIPPLE_API_CLIENT_ID=1
-FLOWRIPPLE_API_KEY=f7add1c7-d147-470c-85fb-6c99da9a9e95
-FLOWRIPPLE_BASE_URL=https://api.flowripple.com

package/.env.test.example

@@ -1,3 +0,0 @@
-FLOWRIPPLE_API_KEY=
-FLOWRIPPLE_BASE_URL=
-FLOWRIPPLE_API_CLIENT_ID=

package/.github/workflows/release.yml

@@ -1,71 +0,0 @@
-name: Release CI/CD
-
-on:
-  push:
-    branches:
-      - main
-
-# Avoid overlapping runs on the same branch
-concurrency: ${{ github.workflow }}-${{ github.ref }}
-
-permissions:
-  contents: write # to push changes (e.g., tags or changeset PR)
-  pull-requests: write # to create or update release PR
-  packages: write # to publish to npm
-  id-token: write # for provenance (optional, requires Node 16+)
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - uses: pnpm/action-setup@v2 # Install pnpm first
-        with:
-          version: 9 # specify pnpm version (e.g., v8 or v9)
-
-      - name: Setup Node.js 20.x and pnpm
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          cache: "pnpm"
-          registry-url: "https://registry.npmjs.org" # use npm registry
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Build package
-        run: pnpm build
-
-      - name: Validate environment
-        run: |
-          if [ -z "${{ secrets.NPM_TOKEN }}" ]; then
-            echo "NPM_TOKEN is not set"
-            exit 1
-          fi
-          if [ -z "${{ secrets.FLOWRIPPLE_API_KEY }}" ]; then
-            echo "FLOWRIPPLE_API_KEY is not set"
-            exit 1
-          fi
-
-      - name: Run tests
-        run: |
-          echo "FLOWRIPPLE_API_CLIENT_ID=${{ secrets.FLOWRIPPLE_API_CLIENT_ID }}" >> .env.test
-          echo "FLOWRIPPLE_API_KEY=${{ secrets.FLOWRIPPLE_API_KEY }}" >> .env.test
-          echo "FLOWRIPPLE_BASE_URL=${{ secrets.FLOWRIPPLE_BASE_URL }}" >> .env.test
-          pnpm test # Runs Jest tests
-        env:
-          FLOWRIPPLE_API_CLIENT_ID: ${{ secrets.FLOWRIPPLE_API_CLIENT_ID }}
-          FLOWRIPPLE_API_KEY: ${{ secrets.FLOWRIPPLE_API_KEY }}
-          FLOWRIPPLE_BASE_URL: ${{ secrets.FLOWRIPPLE_BASE_URL }}
-
-    
-      - name: Create Release PR or Publish
-        id: changesets
-        uses: changesets/action@v1
-        with:
-          publish: pnpm run ci:publish # run publish script (defined in package.json)
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -1,14 +0,0 @@
-# @flowripple/sdk
-
-## 1.0.0
-
-### Major Changes
-
-- e9bc79c: Initial release of the @flowripple/sdk package featuring:
-
-  - Core FlowrippleClient class for event capture
-  - Secure API authentication with HMAC signatures
-  - Configurable base URL and API versioning
-  - Silent mode for error handling
-  - Comprehensive test coverage with both mock and actual API tests
-  - TypeScript support with full type definitions

package/test/actual.test.ts

@@ -1,94 +0,0 @@
-import { FlowrippleClient } from '../src/index';
-
-const baseUrl = process.env.FLOWRIPPLE_BASE_URL || 'http://localhost:3000';
-const validApiClientId = parseInt(process.env.FLOWRIPPLE_API_CLIENT_ID || '1');
-const validApiKey = process.env.FLOWRIPPLE_API_KEY || 'test-api-key';
-
-describe('FlowrippleClient', () => {
-  describe('constructor', () => {
-    it('should set default baseUrl if not provided', () => {
-      const client = new FlowrippleClient({
-        apiClientId: validApiClientId,
-        apiKey: validApiKey,
-      });
-      expect(client['baseUrl']).toBe('https://api.flowripple.com');
-    });
-
-    it('should use provided baseUrl', () => {
-      const client = new FlowrippleClient({
-        apiClientId: validApiClientId,
-        apiKey: validApiKey,
-        baseUrl: 'http://custom.url',
-      });
-      expect(client['baseUrl']).toBe('http://custom.url');
-    });
-  });
-
-  describe('capture method', () => {
-    describe('success cases', () => {
-      it('should successfully capture an event', async () => {
-        const client = new FlowrippleClient({
-          apiClientId: validApiClientId,
-          apiKey: validApiKey,
-          baseUrl,
-        });
-
-        const eventName = 'test.event';
-        const payload = { userId: '123', action: 'test' };
-
-        const result = await client.capture(eventName, payload);
-        expect(result).toBeUndefined();
-      });
-
-      it('should handle successful capture in silent mode', async () => {
-        const client = new FlowrippleClient({
-          apiClientId: validApiClientId,
-          apiKey: validApiKey,
-          baseUrl,
-          silent: true,
-        });
-
-        const result = await client.capture('test.event', { userId: '123' });
-        expect(result).toBeUndefined();
-      });
-    });
-
-    describe('error cases', () => {
-      it('should throw error with descriptive message in normal mode', async () => {
-        const client = new FlowrippleClient({
-          apiClientId: -1, // Invalid ID to force error
-          apiKey: validApiKey,
-          baseUrl,
-        });
-
-        await expect(client.capture('test.event', {})).rejects.toThrow(
-          'Failed to capture event',
-        );
-      });
-
-      it('should return false in silent mode on error', async () => {
-        const client = new FlowrippleClient({
-          apiClientId: -1, // Invalid ID to force error
-          apiKey: validApiKey,
-          baseUrl,
-          silent: true,
-        });
-
-        const result = await client.capture('test.event', {});
-        expect(result).toBe(false);
-      });
-
-      it('should handle invalid API responses', async () => {
-        const client = new FlowrippleClient({
-          apiClientId: validApiClientId,
-          apiKey: 'invalid-key', // Invalid key to force error
-          baseUrl,
-        });
-
-        await expect(client.capture('test.event', {})).rejects.toThrow(
-          'Failed to capture event',
-        );
-      });
-    });
-  });
-});

package/test/mock.test.ts

@@ -1,129 +0,0 @@
-import { FlowrippleClient } from '../src/index';
-import axios from 'axios';
-
-const baseUrl = process.env.FLOWRIPPLE_BASE_URL || 'http://localhost:3000';
-const validApiClientId = parseInt(process.env.FLOWRIPPLE_API_CLIENT_ID || '1');
-const validApiKey = process.env.FLOWRIPPLE_API_KEY || 'test-api-key';
-
-jest.mock('axios');
-const mockedAxios = axios as jest.Mocked<typeof axios>;
-
-describe('FlowrippleClient', () => {
-  beforeEach(() => {
-    jest.clearAllMocks();
-  });
-
-  describe('constructor', () => {
-    it('should set default baseUrl if not provided', () => {
-      const client = new FlowrippleClient({
-        apiClientId: validApiClientId,
-        apiKey: validApiKey,
-      });
-      expect(client['baseUrl']).toBe('https://api.flowripple.com');
-    });
-
-    it('should use provided baseUrl', () => {
-      const client = new FlowrippleClient({
-        apiClientId: validApiClientId,
-        apiKey: validApiKey,
-        baseUrl: 'http://custom.url',
-      });
-      expect(client['baseUrl']).toBe('http://custom.url');
-    });
-  });
-
-  describe('capture method', () => {
-    describe('success cases', () => {
-      beforeEach(() => {
-        mockedAxios.post.mockResolvedValue({ data: {} });
-      });
-
-      it('should send correct request payload and headers', async () => {
-        const client = new FlowrippleClient({
-          apiClientId: validApiClientId,
-          apiKey: validApiKey,
-          baseUrl,
-        });
-
-        const eventName = 'test.event';
-        const payload = { userId: '123', action: 'test' };
-
-        await client.capture(eventName, payload);
-
-        expect(mockedAxios.post).toHaveBeenCalledTimes(1);
-        const [url, body, config] = mockedAxios.post.mock.calls[0] ?? [];
-
-        expect(url).toBe(`${baseUrl}/sdk/v1/capture`);
-        expect(body).toEqual({ event: eventName, payload });
-        expect(config?.headers).toMatchObject({
-          'Content-Type': 'application/json',
-          'X-Flowripple-Api-Client-Id': validApiClientId,
-          'X-Flowripple-Signature': expect.any(String),
-          'X-Flowripple-Timestamp': expect.any(String),
-        });
-      });
-
-      it('should handle successful capture in silent mode', async () => {
-        const client = new FlowrippleClient({
-          apiClientId: validApiClientId,
-          apiKey: validApiKey,
-          baseUrl,
-          silent: true,
-        });
-
-        const result = await client.capture('test.event', { userId: '123' });
-        expect(result).toBeUndefined();
-      });
-    });
-
-    describe('error cases', () => {
-      beforeEach(() => {
-        mockedAxios.post.mockRejectedValue(new Error('Network error'));
-      });
-
-      it('should throw error with descriptive message in normal mode', async () => {
-        const client = new FlowrippleClient({
-          apiClientId: validApiClientId,
-          apiKey: validApiKey,
-          baseUrl,
-        });
-
-        await expect(client.capture('test.event', {})).rejects.toThrow(
-          'Failed to capture event: Network error',
-        );
-      });
-
-      it('should return false in silent mode on error', async () => {
-        const client = new FlowrippleClient({
-          apiClientId: validApiClientId,
-          apiKey: validApiKey,
-          baseUrl,
-          silent: true,
-        });
-
-        const result = await client.capture('test.event', {});
-        expect(result).toBe(false);
-      });
-
-      it('should handle malformed API responses', async () => {
-        mockedAxios.post.mockRejectedValue({
-          isAxiosError: true,
-          response: {
-            status: 400,
-            data: { message: 'Invalid payload' },
-          },
-        });
-
-        const client = new FlowrippleClient({
-          apiClientId: validApiClientId,
-          apiKey: validApiKey,
-          baseUrl,
-        });
-
-        await expect(client.capture('test.event', {})).rejects.toThrow(
-          'Failed to capture event',
-        );
-      });
-    });
-  });
-});

package/test/setup.ts

@@ -1,5 +0,0 @@
-import { config } from 'dotenv';
-import { resolve } from 'path';
-
-// Load test environment variables
-config({ path: resolve(__dirname, '../.env.test') });