@objectstack/client 3.0.7 → 3.0.9

package/src/client.feed.test.ts

@@ -0,0 +1,273 @@
+// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
+
+import { describe, it, expect, vi } from 'vitest';
+import { ObjectStackClient } from './index';
+
+/** Helper: create a client with mocked fetch */
+function createMockClient(body: any, status = 200) {
+  const fetchMock = vi.fn().mockResolvedValue({
+    ok: status >= 200 && status < 300,
+    status,
+    statusText: status === 200 ? 'OK' : 'Error',
+    json: async () => body,
+    headers: new Headers()
+  });
+  const client = new ObjectStackClient({
+    baseUrl: 'http://localhost:3000',
+    fetch: fetchMock
+  });
+  return { client, fetchMock };
+}
+
+describe('ObjectStackClient - Feed Namespace', () => {
+  // ==========================================
+  // Feed CRUD
+  // ==========================================
+
+  it('feed.list should GET /api/v1/data/:object/:recordId/feed', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { items: [], total: 0, hasMore: false }
+    });
+
+    const result = await client.feed.list('account', 'rec_123', { type: 'all', limit: 10 });
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/feed?type=all&limit=10',
+      expect.objectContaining({ headers: expect.any(Object) })
+    );
+    expect(result.items).toEqual([]);
+    expect(result.hasMore).toBe(false);
+  });
+
+  it('feed.create should POST /api/v1/data/:object/:recordId/feed', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { id: 'feed_1', type: 'comment', body: 'Hello' }
+    });
+
+    const result = await client.feed.create('account', 'rec_123', {
+      type: 'comment',
+      body: 'Hello'
+    });
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/feed',
+      expect.objectContaining({
+        method: 'POST',
+        body: JSON.stringify({ type: 'comment', body: 'Hello' })
+      })
+    );
+    expect(result.id).toBe('feed_1');
+  });
+
+  it('feed.update should PUT /api/v1/data/:object/:recordId/feed/:feedId', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { id: 'feed_1', type: 'comment', body: 'Updated' }
+    });
+
+    const result = await client.feed.update('account', 'rec_123', 'feed_1', {
+      body: 'Updated'
+    });
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/feed/feed_1',
+      expect.objectContaining({
+        method: 'PUT',
+        body: JSON.stringify({ body: 'Updated' })
+      })
+    );
+    expect(result.body).toBe('Updated');
+  });
+
+  it('feed.delete should DELETE /api/v1/data/:object/:recordId/feed/:feedId', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { feedId: 'feed_1' }
+    });
+
+    const result = await client.feed.delete('account', 'rec_123', 'feed_1');
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/feed/feed_1',
+      expect.objectContaining({ method: 'DELETE' })
+    );
+    expect(result.feedId).toBe('feed_1');
+  });
+
+  // ==========================================
+  // Reactions
+  // ==========================================
+
+  it('feed.addReaction should POST reactions endpoint', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { reactions: [{ emoji: '👍', count: 1 }] }
+    });
+
+    const result = await client.feed.addReaction('account', 'rec_123', 'feed_1', '👍');
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/feed/feed_1/reactions',
+      expect.objectContaining({
+        method: 'POST',
+        body: JSON.stringify({ emoji: '👍' })
+      })
+    );
+    expect(result.reactions).toHaveLength(1);
+  });
+
+  it('feed.removeReaction should DELETE reactions/:emoji endpoint', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { reactions: [] }
+    });
+
+    await client.feed.removeReaction('account', 'rec_123', 'feed_1', '👍');
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      expect.stringContaining('/api/v1/data/account/rec_123/feed/feed_1/reactions/'),
+      expect.objectContaining({ method: 'DELETE' })
+    );
+  });
+
+  // ==========================================
+  // Pin / Star
+  // ==========================================
+
+  it('feed.pin should POST pin endpoint', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { feedId: 'feed_1', pinned: true, pinnedAt: '2026-01-01T00:00:00Z' }
+    });
+
+    const result = await client.feed.pin('account', 'rec_123', 'feed_1');
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/feed/feed_1/pin',
+      expect.objectContaining({ method: 'POST' })
+    );
+    expect(result.pinned).toBe(true);
+  });
+
+  it('feed.unpin should DELETE pin endpoint', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { feedId: 'feed_1', pinned: false }
+    });
+
+    const result = await client.feed.unpin('account', 'rec_123', 'feed_1');
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/feed/feed_1/pin',
+      expect.objectContaining({ method: 'DELETE' })
+    );
+    expect(result.pinned).toBe(false);
+  });
+
+  it('feed.star should POST star endpoint', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { feedId: 'feed_1', starred: true, starredAt: '2026-01-01T00:00:00Z' }
+    });
+
+    const result = await client.feed.star('account', 'rec_123', 'feed_1');
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/feed/feed_1/star',
+      expect.objectContaining({ method: 'POST' })
+    );
+    expect(result.starred).toBe(true);
+  });
+
+  it('feed.unstar should DELETE star endpoint', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { feedId: 'feed_1', starred: false }
+    });
+
+    const result = await client.feed.unstar('account', 'rec_123', 'feed_1');
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/feed/feed_1/star',
+      expect.objectContaining({ method: 'DELETE' })
+    );
+    expect(result.starred).toBe(false);
+  });
+
+  // ==========================================
+  // Search & Changelog
+  // ==========================================
+
+  it('feed.search should GET search endpoint with query params', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { items: [], total: 0, hasMore: false }
+    });
+
+    await client.feed.search('account', 'rec_123', 'follow up', { limit: 10 });
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      expect.stringContaining('/api/v1/data/account/rec_123/feed/search?query=follow+up'),
+      expect.any(Object)
+    );
+  });
+
+  it('feed.getChangelog should GET changelog endpoint', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { entries: [], total: 0, hasMore: false }
+    });
+
+    await client.feed.getChangelog('account', 'rec_123', { field: 'status' });
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/changelog?field=status',
+      expect.any(Object)
+    );
+  });
+
+  // ==========================================
+  // Subscriptions
+  // ==========================================
+
+  it('feed.subscribe should POST subscribe endpoint', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { object: 'account', recordId: 'rec_123', events: ['all'], channels: ['in_app'] }
+    });
+
+    const result = await client.feed.subscribe('account', 'rec_123', {
+      events: ['comment', 'field_change'],
+      channels: ['in_app', 'email']
+    });
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/subscribe',
+      expect.objectContaining({
+        method: 'POST',
+        body: JSON.stringify({
+          events: ['comment', 'field_change'],
+          channels: ['in_app', 'email']
+        })
+      })
+    );
+    expect(result.object).toBe('account');
+  });
+
+  it('feed.unsubscribe should DELETE subscribe endpoint', async () => {
+    const { client, fetchMock } = createMockClient({
+      success: true,
+      data: { object: 'account', recordId: 'rec_123', unsubscribed: true }
+    });
+
+    const result = await client.feed.unsubscribe('account', 'rec_123');
+
+    expect(fetchMock).toHaveBeenCalledWith(
+      'http://localhost:3000/api/v1/data/account/rec_123/subscribe',
+      expect.objectContaining({ method: 'DELETE' })
+    );
+    expect(result.unsubscribed).toBe(true);
+  });
+});

package/src/client.test.ts

@@ -648,3 +648,182 @@ describe('FilterBuilder enhancements', () => {
         expect(f).toEqual(['phone', 'is_not_null', null]);
     });
 });
+
+// ==========================================
+// Automation Client Tests
+// ==========================================
+
+describe('ObjectStackClient.automation', () => {
+    it('should list flows', async () => {
+        const { client, fetchMock } = createMockClient({
+            success: true,
+            data: { flows: ['flow_a', 'flow_b'], total: 2, hasMore: false },
+        });
+
+        const result = await client.automation.list();
+        expect(fetchMock).toHaveBeenCalledWith(
+            'http://localhost:3000/api/v1/automation',
+            expect.any(Object),
+        );
+        expect(result.flows).toEqual(['flow_a', 'flow_b']);
+    });
+
+    it('should get a flow by name', async () => {
+        const { client, fetchMock } = createMockClient({
+            success: true,
+            data: { name: 'my_flow', label: 'My Flow' },
+        });
+
+        const result = await client.automation.get('my_flow');
+        expect(fetchMock).toHaveBeenCalledWith(
+            'http://localhost:3000/api/v1/automation/my_flow',
+            expect.any(Object),
+        );
+        expect(result.name).toBe('my_flow');
+    });
+
+    it('should create a flow', async () => {
+        const { client, fetchMock } = createMockClient({
+            success: true,
+            data: { name: 'new_flow' },
+        });
+
+        await client.automation.create('new_flow', { label: 'New' });
+        expect(fetchMock).toHaveBeenCalledWith(
+            'http://localhost:3000/api/v1/automation',
+            expect.objectContaining({ method: 'POST' }),
+        );
+    });
+
+    it('should update a flow', async () => {
+        const { client, fetchMock } = createMockClient({
+            success: true,
+            data: { name: 'my_flow', label: 'Updated' },
+        });
+
+        await client.automation.update('my_flow', { label: 'Updated' });
+        expect(fetchMock).toHaveBeenCalledWith(
+            'http://localhost:3000/api/v1/automation/my_flow',
+            expect.objectContaining({ method: 'PUT' }),
+        );
+    });
+
+    it('should delete a flow', async () => {
+        const { client, fetchMock } = createMockClient({
+            success: true,
+            data: { name: 'old_flow', deleted: true },
+        });
+
+        const result = await client.automation.delete('old_flow');
+        expect(fetchMock).toHaveBeenCalledWith(
+            'http://localhost:3000/api/v1/automation/old_flow',
+            expect.objectContaining({ method: 'DELETE' }),
+        );
+        expect(result.deleted).toBe(true);
+    });
+
+    it('should toggle a flow', async () => {
+        const { client, fetchMock } = createMockClient({
+            success: true,
+            data: { name: 'my_flow', enabled: false },
+        });
+
+        const result = await client.automation.toggle('my_flow', false);
+        expect(fetchMock).toHaveBeenCalledWith(
+            'http://localhost:3000/api/v1/automation/my_flow/toggle',
+            expect.objectContaining({ method: 'POST' }),
+        );
+        expect(result.enabled).toBe(false);
+    });
+
+    it('should list runs for a flow', async () => {
+        const { client, fetchMock } = createMockClient({
+            success: true,
+            data: { runs: [{ id: 'run_1' }], hasMore: false },
+        });
+
+        const result = await client.automation.runs.list('my_flow');
+        expect(fetchMock).toHaveBeenCalledWith(
+            'http://localhost:3000/api/v1/automation/my_flow/runs',
+            expect.any(Object),
+        );
+        expect(result.runs).toHaveLength(1);
+    });
+
+    it('should list runs with pagination options', async () => {
+        const { client, fetchMock } = createMockClient({
+            success: true,
+            data: { runs: [], hasMore: false },
+        });
+
+        await client.automation.runs.list('my_flow', { limit: 5, cursor: 'abc' });
+        expect(fetchMock).toHaveBeenCalledWith(
+            'http://localhost:3000/api/v1/automation/my_flow/runs?limit=5&cursor=abc',
+            expect.any(Object),
+        );
+    });
+
+    it('should get a single run', async () => {
+        const { client, fetchMock } = createMockClient({
+            success: true,
+            data: { id: 'run_1', status: 'completed' },
+        });
+
+        const result = await client.automation.runs.get('my_flow', 'run_1');
+        expect(fetchMock).toHaveBeenCalledWith(
+            'http://localhost:3000/api/v1/automation/my_flow/runs/run_1',
+            expect.any(Object),
+        );
+        expect(result.id).toBe('run_1');
+    });
+
+    it('should still support legacy trigger', async () => {
+        const { client, fetchMock } = createMockClient({ success: true, data: { result: 'ok' } });
+
+        await client.automation.trigger('my_flow', { key: 'val' });
+        expect(fetchMock).toHaveBeenCalledWith(
+            'http://localhost:3000/api/v1/automation/trigger/my_flow',
+            expect.objectContaining({ method: 'POST' }),
+        );
+    });
+
+    // ==========================================
+    // capabilities getter
+    // ==========================================
+
+    it('should return undefined capabilities before connect', () => {
+        const client = new ObjectStackClient({ baseUrl: 'http://localhost:3000' });
+        expect(client.capabilities).toBeUndefined();
+    });
+
+    it('should expose capabilities after connect', async () => {
+        const caps = {
+            feed: true,
+            comments: true,
+            automation: false,
+            cron: false,
+            search: true,
+            export: false,
+            chunkedUpload: false,
+        };
+        const fetchMock = vi.fn().mockResolvedValue({
+            ok: true,
+            json: async () => ({
+                version: 'v1',
+                apiName: 'ObjectStack API',
+                capabilities: caps,
+            }),
+        });
+
+        const client = new ObjectStackClient({
+            baseUrl: 'http://localhost:3000',
+            fetch: fetchMock,
+        });
+
+        await client.connect();
+        expect(client.capabilities).toBeDefined();
+        expect(client.capabilities!.feed).toBe(true);
+        expect(client.capabilities!.automation).toBe(false);
+        expect(client.capabilities!.search).toBe(true);
+    });
+});