@rivium/push-node 0.1.1 → 0.1.2

package/dist/modules/segments.d.ts

@@ -1,5 +1,5 @@
 import { HttpClient } from '../client';
-import { Segment, CreateSegmentOptions, UpdateSegmentOptions, Device } from '../types';
+import { Segment, CreateSegmentOptions, UpdateSegmentOptions, Device, SegmentPreviewOptions, SegmentPreviewResult } from '../types';
 export declare class Segments {
     private client;
     constructor(client: HttpClient);
@@ -41,4 +41,21 @@ export declare class Segments {
     recalculateAll(): Promise<{
         success: boolean;
     }>;
+    /**
+     * Preview a set of filters without saving. Returns the total match count
+     * plus a small sample of matching devices — useful for validating filters
+     * before creating a segment.
+     *
+     * @example
+     * ```ts
+     * const { count, preview } = await rivium.segments.preview({
+     *   filters: [
+     *     { field: 'platform', operator: 'equals', value: 'ios' },
+     *     { field: 'metadata.plan', operator: 'equals', value: 'premium' },
+     *   ],
+     * });
+     * console.log(`${count} devices match`);
+     * ```
+     */
+    preview(options?: SegmentPreviewOptions): Promise<SegmentPreviewResult>;
 }

package/dist/modules/segments.js

@@ -53,5 +53,26 @@ class Segments {
     async recalculateAll() {
         return this.client.post('/segments/recalculate-all');
     }
+    /**
+     * Preview a set of filters without saving. Returns the total match count
+     * plus a small sample of matching devices — useful for validating filters
+     * before creating a segment.
+     *
+     * @example
+     * ```ts
+     * const { count, preview } = await rivium.segments.preview({
+     *   filters: [
+     *     { field: 'platform', operator: 'equals', value: 'ios' },
+     *     { field: 'metadata.plan', operator: 'equals', value: 'premium' },
+     *   ],
+     * });
+     * console.log(`${count} devices match`);
+     * ```
+     */
+    async preview(options = {}) {
+        const { limit, ...body } = options;
+        const path = limit ? `/segments/preview?limit=${limit}` : '/segments/preview';
+        return this.client.post(path, body);
+    }
 }
 exports.Segments = Segments;

package/dist/types.d.ts

@@ -112,10 +112,11 @@ export interface Template {
     createdAt: string;
     updatedAt: string;
 }
+export type SegmentFilterOperator = 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'greater_than' | 'less_than' | 'in' | 'not_in' | 'exists';
 export interface SegmentFilter {
     field: string;
-    operator: 'equals' | 'contains' | 'starts_with' | 'in' | 'gt' | 'lt' | 'between';
-    value: string | number | string[];
+    operator: SegmentFilterOperator;
+    value: string | number | boolean | string[];
 }
 export interface CreateSegmentOptions {
     name: string;
@@ -135,6 +136,23 @@ export interface Segment {
     createdAt: string;
     updatedAt: string;
 }
+export interface SegmentPreviewOptions {
+    filters?: SegmentFilter[];
+    /** Number of sample devices to return (max 50, default 20). */
+    limit?: number;
+}
+export interface SegmentPreviewResult {
+    /** Total number of devices matching the filters. */
+    count: number;
+    /** Small sample of matching devices (up to `limit`). */
+    preview: Array<{
+        deviceId: string;
+        platform: string;
+        userId: string | null;
+        topics: string[] | null;
+        metadata: Record<string, any> | null;
+    }>;
+}
 export interface CreateScheduledOptions {
     title: string;
     body: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivium/push-node",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/Rivium-co/rivium-push-nodejs-sdk.git"