@flowripple/sdk 0.1.0 → 1.0.1

package/package.json

@@ -1,7 +1,13 @@
 {
   "name": "@flowripple/sdk",
-  "version": "0.1.0",
+  "version": "1.0.1",
   "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"

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/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') });