@rivium/push-node 0.1.0

package/dist/modules/segments.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Segments = void 0;
+class Segments {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a new segment.
+     */
+    async create(options) {
+        return this.client.post('/segments', options);
+    }
+    /**
+     * List all segments.
+     */
+    async list() {
+        return this.client.get('/segments');
+    }
+    /**
+     * Get a segment by ID.
+     */
+    async get(id) {
+        return this.client.get(`/segments/${id}`);
+    }
+    /**
+     * Update a segment.
+     */
+    async update(id, options) {
+        return this.client.put(`/segments/${id}`, options);
+    }
+    /**
+     * Delete a segment.
+     */
+    async delete(id) {
+        return this.client.delete(`/segments/${id}`);
+    }
+    /**
+     * Get devices in a segment.
+     */
+    async getDevices(id) {
+        return this.client.get(`/segments/${id}/devices`);
+    }
+    /**
+     * Recalculate segment membership.
+     */
+    async recalculate(id) {
+        return this.client.post(`/segments/${id}/recalculate`);
+    }
+    /**
+     * Recalculate all segments.
+     */
+    async recalculateAll() {
+        return this.client.post('/segments/recalculate-all');
+    }
+}
+exports.Segments = Segments;

package/dist/modules/templates.d.ts

@@ -0,0 +1,40 @@
+import { HttpClient } from '../client';
+import { Template, CreateTemplateOptions, UpdateTemplateOptions } from '../types';
+export declare class Templates {
+    private client;
+    constructor(client: HttpClient);
+    /**
+     * Create a new notification template.
+     */
+    create(options: CreateTemplateOptions): Promise<Template>;
+    /**
+     * List all templates.
+     */
+    list(): Promise<Template[]>;
+    /**
+     * Get a template by ID.
+     */
+    get(id: string): Promise<Template>;
+    /**
+     * Update a template.
+     */
+    update(id: string, options: UpdateTemplateOptions): Promise<Template>;
+    /**
+     * Delete a template.
+     */
+    delete(id: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Render a template with variables.
+     */
+    render(id: string, variables?: Record<string, string>, locale?: string): Promise<{
+        title: string;
+        body: string;
+        data?: Record<string, any>;
+    }>;
+    /**
+     * Duplicate a template.
+     */
+    duplicate(id: string): Promise<Template>;
+}

package/dist/modules/templates.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Templates = void 0;
+class Templates {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a new notification template.
+     */
+    async create(options) {
+        return this.client.post('/templates', options);
+    }
+    /**
+     * List all templates.
+     */
+    async list() {
+        return this.client.get('/templates');
+    }
+    /**
+     * Get a template by ID.
+     */
+    async get(id) {
+        return this.client.get(`/templates/${id}`);
+    }
+    /**
+     * Update a template.
+     */
+    async update(id, options) {
+        return this.client.put(`/templates/${id}`, options);
+    }
+    /**
+     * Delete a template.
+     */
+    async delete(id) {
+        return this.client.delete(`/templates/${id}`);
+    }
+    /**
+     * Render a template with variables.
+     */
+    async render(id, variables, locale) {
+        return this.client.post(`/templates/${id}/render`, { variables, locale });
+    }
+    /**
+     * Duplicate a template.
+     */
+    async duplicate(id) {
+        return this.client.post(`/templates/${id}/duplicate`);
+    }
+}
+exports.Templates = Templates;

package/dist/modules/webhooks.d.ts

@@ -0,0 +1,52 @@
+import { HttpClient } from '../client';
+import { Webhook, CreateWebhookOptions, UpdateWebhookOptions, WebhookEvent } from '../types';
+export declare class Webhooks {
+    private client;
+    constructor(client: HttpClient);
+    /**
+     * Create a new webhook.
+     */
+    create(options: CreateWebhookOptions): Promise<Webhook>;
+    /**
+     * List all webhooks.
+     */
+    list(): Promise<Webhook[]>;
+    /**
+     * Get available webhook events.
+     */
+    getEvents(): Promise<{
+        value: WebhookEvent;
+        label: string;
+    }[]>;
+    /**
+     * Get a webhook by ID.
+     */
+    get(id: string): Promise<Webhook>;
+    /**
+     * Update a webhook.
+     */
+    update(id: string, options: UpdateWebhookOptions): Promise<Webhook>;
+    /**
+     * Delete a webhook.
+     */
+    delete(id: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Regenerate webhook secret.
+     */
+    regenerateSecret(id: string): Promise<{
+        secret: string;
+    }>;
+    /**
+     * Get webhook delivery logs.
+     */
+    getLogs(id: string, limit?: number): Promise<any[]>;
+    /**
+     * Test a webhook.
+     */
+    test(id: string, event?: WebhookEvent): Promise<{
+        success: boolean;
+        response: any;
+    }>;
+}

package/dist/modules/webhooks.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Webhooks = void 0;
+class Webhooks {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a new webhook.
+     */
+    async create(options) {
+        return this.client.post('/webhooks', options);
+    }
+    /**
+     * List all webhooks.
+     */
+    async list() {
+        return this.client.get('/webhooks');
+    }
+    /**
+     * Get available webhook events.
+     */
+    async getEvents() {
+        return this.client.get('/webhooks/events');
+    }
+    /**
+     * Get a webhook by ID.
+     */
+    async get(id) {
+        return this.client.get(`/webhooks/${id}`);
+    }
+    /**
+     * Update a webhook.
+     */
+    async update(id, options) {
+        return this.client.put(`/webhooks/${id}`, options);
+    }
+    /**
+     * Delete a webhook.
+     */
+    async delete(id) {
+        return this.client.delete(`/webhooks/${id}`);
+    }
+    /**
+     * Regenerate webhook secret.
+     */
+    async regenerateSecret(id) {
+        return this.client.post(`/webhooks/${id}/regenerate-secret`);
+    }
+    /**
+     * Get webhook delivery logs.
+     */
+    async getLogs(id, limit) {
+        return this.client.get(`/webhooks/${id}/logs`, { limit });
+    }
+    /**
+     * Test a webhook.
+     */
+    async test(id, event) {
+        return this.client.post(`/webhooks/${id}/test`, { event });
+    }
+}
+exports.Webhooks = Webhooks;

package/dist/types.d.ts

@@ -0,0 +1,333 @@
+export interface RiviumPushConfig {
+    /** Your Rivium API key (rv_live_xxx or rv_test_xxx) */
+    apiKey: string;
+    /** Server secret for server-side authentication (rv_srv_xxx) - required for all server operations */
+    serverSecret: string;
+}
+export interface PaginationParams {
+    limit?: number;
+    offset?: number;
+}
+export interface BillingInfo {
+    messagesCharged: number;
+    remaining: number;
+}
+export interface SendResult {
+    success: number;
+    failed: number;
+    billing?: BillingInfo;
+}
+export interface NotificationAction {
+    id: string;
+    title: string;
+    action?: string;
+    icon?: string;
+    destructive?: boolean;
+    authRequired?: boolean;
+}
+export interface Localization {
+    locale: string;
+    title: string;
+    body: string;
+}
+export interface SendPushOptions {
+    title?: string;
+    body?: string;
+    templateId?: string;
+    templateVariables?: Record<string, string>;
+    locale?: string;
+    data?: Record<string, any>;
+    silent?: boolean;
+    imageUrl?: string;
+    iconUrl?: string;
+    actions?: NotificationAction[];
+    deepLink?: string;
+    badge?: number;
+    badgeAction?: 'set' | 'increment' | 'decrement' | 'clear';
+    sound?: string;
+    threadId?: string;
+    collapseKey?: string;
+    category?: string;
+    priority?: 'default' | 'high' | 'low';
+    ttl?: number;
+    localizations?: Localization[];
+    timezone?: string;
+    campaignId?: string;
+    /** Optional app identifier to scope delivery to a specific app on the same device */
+    appIdentifier?: string;
+}
+export interface SendToDeviceOptions extends SendPushOptions {
+    deviceId: string;
+}
+export interface SendToUserOptions extends SendPushOptions {
+    userId: string;
+}
+export interface SendToDevicesOptions extends SendPushOptions {
+    deviceIds: string[];
+}
+export interface SendToTopicOptions extends SendPushOptions {
+    topic: string;
+}
+export interface SendToSegmentOptions extends SendPushOptions {
+    segmentId: string;
+}
+export type Platform = 'android' | 'ios' | 'web';
+export interface Device {
+    id: string;
+    deviceId: string;
+    platform: Platform;
+    appId: string;
+    appIdentifier?: string;
+    userId?: string;
+    metadata?: Record<string, any>;
+    createdAt: string;
+}
+export interface CreateTemplateOptions {
+    name: string;
+    description?: string;
+    title: string;
+    body: string;
+    data?: Record<string, any>;
+    variables?: string[];
+    localizations?: Record<string, {
+        title: string;
+        body: string;
+    }>;
+}
+export interface UpdateTemplateOptions extends Partial<CreateTemplateOptions> {
+}
+export interface Template {
+    id: string;
+    name: string;
+    description?: string;
+    title: string;
+    body: string;
+    data?: Record<string, any>;
+    variables?: string[];
+    localizations?: Record<string, {
+        title: string;
+        body: string;
+    }>;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SegmentFilter {
+    field: string;
+    operator: 'equals' | 'contains' | 'starts_with' | 'in' | 'gt' | 'lt' | 'between';
+    value: string | number | string[];
+}
+export interface CreateSegmentOptions {
+    name: string;
+    description?: string;
+    color?: string;
+    filters?: SegmentFilter[];
+}
+export interface UpdateSegmentOptions extends Partial<CreateSegmentOptions> {
+}
+export interface Segment {
+    id: string;
+    name: string;
+    description?: string;
+    color?: string;
+    filters?: SegmentFilter[];
+    deviceCount?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateScheduledOptions {
+    title: string;
+    body: string;
+    data?: Record<string, any>;
+    targetType: 'all' | 'user' | 'device' | 'topic' | 'segment';
+    targetValue?: string;
+    scheduledAt: string;
+    timezone?: string;
+}
+export interface UpdateScheduledOptions extends Partial<CreateScheduledOptions> {
+}
+export interface ScheduledMessage {
+    id: string;
+    title: string;
+    body: string;
+    data?: Record<string, any>;
+    targetType: string;
+    targetValue?: string;
+    scheduledAt: string;
+    timezone?: string;
+    status: string;
+    createdAt: string;
+}
+export interface InboxContent {
+    title: string;
+    body: string;
+    imageUrl?: string;
+    iconUrl?: string;
+    deepLink?: string;
+    data?: Record<string, any>;
+}
+export interface InboxLocalization {
+    locale: string;
+    content: InboxContent;
+}
+export interface SendInboxOptions {
+    content: InboxContent;
+    localizations?: InboxLocalization[];
+    appIdentifier?: string;
+    category?: string;
+    expiresAt?: string;
+    campaignId?: string;
+}
+export interface SendToUserInboxOptions extends SendInboxOptions {
+    userId: string;
+}
+export interface SendToUsersInboxOptions extends SendInboxOptions {
+    userIds: string[];
+}
+export interface SendToDeviceInboxOptions extends SendInboxOptions {
+    deviceId: string;
+}
+export interface InboxMessage {
+    id: string;
+    content: InboxContent;
+    status: 'unread' | 'read' | 'archived' | 'deleted';
+    category?: string;
+    createdAt: string;
+}
+export type InboxStatus = 'unread' | 'read' | 'archived' | 'deleted';
+export interface GetInboxOptions extends PaginationParams {
+    userId?: string;
+    deviceId?: string;
+    status?: InboxStatus;
+    category?: string;
+    locale?: string;
+}
+export interface InAppButton {
+    id: string;
+    text: string;
+    action: 'dismiss' | 'deep_link' | 'url' | 'custom';
+    value?: string;
+    style?: 'primary' | 'secondary' | 'text' | 'destructive';
+}
+export interface InAppContent {
+    title: string;
+    body: string;
+    imageUrl?: string;
+    backgroundColor?: string;
+    textColor?: string;
+    buttons?: InAppButton[];
+}
+export interface CreateInAppOptions {
+    name: string;
+    type: 'modal' | 'banner' | 'card' | 'notification';
+    content: InAppContent;
+    localizations?: {
+        locale: string;
+        content: InAppContent;
+    }[];
+    triggerType?: 'on_app_open' | 'on_event' | 'on_screen_view' | 'manual';
+    triggerEvent?: string;
+    triggerConditions?: Record<string, any>;
+    segmentId?: string;
+    targetUserIds?: string[];
+    startDate?: string;
+    endDate?: string;
+    maxImpressions?: number;
+    minSessionCount?: number;
+    delaySeconds?: number;
+    priority?: number;
+}
+export interface UpdateInAppOptions extends Partial<CreateInAppOptions> {
+}
+export interface InAppMessage {
+    id: string;
+    name: string;
+    type: string;
+    content: InAppContent;
+    status: string;
+    createdAt: string;
+}
+export interface ABTestVariantDef {
+    name: string;
+    title: string;
+    body: string;
+    data?: Record<string, any>;
+    imageUrl?: string;
+    deepLink?: string;
+    actions?: NotificationAction[];
+    trafficPercentage: number;
+}
+export interface CreateABTestOptions {
+    name: string;
+    description?: string;
+    targetType?: string;
+    segmentId?: string;
+    targetPercentage?: number;
+    hasControlGroup?: boolean;
+    controlGroupPercentage?: number;
+    winningMetric?: string;
+    testDurationHours?: number;
+    autoSelectWinner?: boolean;
+    enableEarlyStopping?: boolean;
+    significanceThreshold?: number;
+    minimumSampleSize?: number;
+    variants: ABTestVariantDef[];
+}
+export interface ABTest {
+    id: string;
+    name: string;
+    status: string;
+    variants: any[];
+    createdAt: string;
+}
+export type WebhookEvent = 'message.sent' | 'message.delivered' | 'message.opened' | 'message.clicked' | 'device.registered' | 'device.unregistered';
+export interface CreateWebhookOptions {
+    name: string;
+    url: string;
+    secret?: string;
+    events: WebhookEvent[];
+    isActive?: boolean;
+    maxRetries?: number;
+    timeoutMs?: number;
+}
+export interface UpdateWebhookOptions extends Partial<CreateWebhookOptions> {
+}
+export interface Webhook {
+    id: string;
+    name: string;
+    url: string;
+    events: WebhookEvent[];
+    isActive: boolean;
+    createdAt: string;
+}
+export interface AnalyticsOverview {
+    totalDevices: number;
+    activeDevices: number;
+    totalMessages: number;
+    totalDelivered: number;
+    totalFailed: number;
+    totalPending: number;
+    totalNoTargets: number;
+    totalAttempts: number;
+    deliveryRate: number;
+    platformDistribution: {
+        android: number;
+        ios: number;
+        web: number;
+    };
+}
+export interface DailyStats {
+    date: string;
+    sent: number;
+    delivered: number;
+    opened: number;
+    clicked: number;
+}
+export interface AppStats {
+    totalDevices: number;
+    activeDevices: number;
+    androidDevices: number;
+    iosDevices: number;
+    totalTopics: number;
+    topics: string[];
+    totalUsers: number;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+// ─── Configuration ───────────────────────────────────────────────
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@rivium/push-node",
+  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rivium-co/rivium-push-nodejs-sdk.git"
+  },
+  "homepage": "https://rivium.co/cloud/rivium-push",
+  "bugs": {
+    "url": "https://github.com/Rivium-co/rivium-push-nodejs-sdk/issues"
+  },
+  "description": "RiviumPush Node.js SDK \u2014 server-side push notifications, inbox, in-app messages, and more",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "rivium-push",
+    "push-notifications",
+    "notifications",
+    "inbox",
+    "in-app-messages"
+  ],
+  "author": "Rivium <support@rivium.co>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=16"
+  },
+  "devDependencies": {
+    "@types/node": "^25.2.0",
+    "typescript": "^5.9.3"
+  }
+}