@flowripple/sdk 1.0.1 → 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,6 +1,6 @@
 {
   "name": "@flowripple/sdk",
-  "version": "1.0.1",
+  "version": "3.0.0",
   "description": "FlowRipple SDK",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -37,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"
   }
 }