@pushary/server 1.3.3 → 1.4.0

package/dist/util-Ihfh4f82.d.ts

@@ -0,0 +1,419 @@
+interface PusharyConfig {
+    readonly apiKey: string;
+    readonly baseUrl?: string;
+}
+interface ListParams {
+    readonly limit?: number;
+    readonly cursor?: string;
+}
+interface PaginatedResponse<T> {
+    readonly data: readonly T[];
+    readonly nextCursor?: string;
+    readonly hasMore: boolean;
+}
+interface Subscriber {
+    readonly id: string;
+    readonly siteId: string;
+    readonly endpoint: string;
+    readonly status: 'active' | 'unsubscribed' | 'expired' | 'bounced';
+    readonly browser?: string;
+    readonly os?: string;
+    readonly deviceType?: string;
+    readonly country?: string;
+    readonly city?: string;
+    readonly timezone?: string;
+    readonly language?: string;
+    readonly tags?: readonly string[];
+    readonly externalId?: string;
+    readonly createdAt: string;
+    readonly lastActiveAt?: string;
+}
+interface SubscriberListParams extends ListParams {
+    readonly status?: 'active' | 'unsubscribed' | 'expired' | 'bounced';
+    readonly tags?: readonly string[];
+    readonly externalId?: string;
+}
+interface UpdateSubscriber {
+    readonly tags?: readonly string[];
+    readonly externalId?: string;
+    readonly customData?: Readonly<Record<string, unknown>>;
+}
+interface Campaign {
+    readonly id: string;
+    readonly siteId: string;
+    readonly name: string;
+    readonly title: string;
+    readonly body: string;
+    readonly iconUrl?: string;
+    readonly imageUrl?: string;
+    readonly actionUrl?: string;
+    readonly status: 'draft' | 'scheduled' | 'sending' | 'active' | 'paused' | 'completed' | 'cancelled';
+    readonly scheduledAt?: string;
+    readonly totalTargeted: number;
+    readonly totalSent: number;
+    readonly totalDelivered: number;
+    readonly totalClicked: number;
+    readonly createdAt: string;
+}
+interface CreateCampaign {
+    readonly name: string;
+    readonly title: string;
+    readonly body: string;
+    readonly iconUrl?: string;
+    readonly imageUrl?: string;
+    readonly actionUrl?: string;
+    readonly scheduledAt?: string;
+    readonly segmentId?: string;
+    readonly tags?: readonly string[];
+}
+interface UpdateCampaign {
+    readonly name?: string;
+    readonly title?: string;
+    readonly body?: string;
+    readonly iconUrl?: string;
+    readonly imageUrl?: string;
+    readonly actionUrl?: string;
+    readonly scheduledAt?: string;
+    readonly status?: 'draft' | 'paused' | 'cancelled';
+}
+interface Template {
+    readonly id: string;
+    readonly siteId: string;
+    readonly name: string;
+    readonly title: string;
+    readonly body: string;
+    readonly iconUrl?: string;
+    readonly imageUrl?: string;
+    readonly actionUrl?: string;
+    readonly createdAt: string;
+}
+interface CreateTemplate {
+    readonly name: string;
+    readonly title: string;
+    readonly body: string;
+    readonly iconUrl?: string;
+    readonly imageUrl?: string;
+    readonly actionUrl?: string;
+}
+interface UpdateTemplate {
+    readonly name?: string;
+    readonly title?: string;
+    readonly body?: string;
+    readonly iconUrl?: string;
+    readonly imageUrl?: string;
+    readonly actionUrl?: string;
+}
+interface SendNotification {
+    readonly title: string;
+    readonly body: string;
+    readonly iconUrl?: string;
+    readonly imageUrl?: string;
+    readonly url?: string;
+    readonly subscriberIds?: readonly string[];
+    readonly externalIds?: readonly string[];
+    readonly tags?: readonly string[];
+    readonly data?: Readonly<Record<string, unknown>>;
+    readonly metadata?: Readonly<Record<string, unknown>>;
+    /** Stable across retries of one logical send. Maximum 200 characters. */
+    readonly idempotencyKey?: string;
+}
+interface SendResult {
+    readonly success: boolean;
+    readonly campaignId?: string;
+    readonly status?: 'queued';
+    readonly queued?: number;
+    readonly duplicate?: boolean;
+    /** @deprecated This is the queued recipient count, not a device receipt. */
+    readonly sent: number;
+    readonly limits: {
+        readonly remaining: number;
+        readonly limit: number;
+    };
+}
+interface SubscriberCount {
+    readonly total: number;
+    readonly active: number;
+    readonly unsubscribed: number;
+}
+interface CampaignStats {
+    readonly totalSent: number;
+    readonly totalDelivered: number;
+    readonly totalClicked: number;
+    readonly totalFailed: number;
+    readonly deliveryRate: number;
+    readonly clickRate: number;
+}
+type FlowTriggerType = 'notification_click' | 'notification_impression' | 'notification_dismiss' | 'subscription' | 'unsubscription';
+type FlowStepType = 'send_notification' | 'delay' | 'exit';
+type FlowStatus = 'draft' | 'active' | 'paused' | 'archived';
+interface FlowStepConfig {
+    readonly notification?: {
+        readonly title: string;
+        readonly body: string;
+        readonly iconUrl?: string;
+        readonly imageUrl?: string;
+        readonly actionUrl?: string;
+    };
+    readonly delay?: {
+        readonly value: number;
+        readonly unit: 'seconds' | 'minutes' | 'hours' | 'days';
+    };
+}
+interface FlowStep {
+    readonly id: string;
+    readonly flowId: string;
+    readonly stepOrder: number;
+    readonly stepType: FlowStepType;
+    readonly config: FlowStepConfig;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+interface Flow {
+    readonly id: string;
+    readonly siteId: string;
+    readonly name: string;
+    readonly description?: string;
+    readonly triggerType: FlowTriggerType;
+    readonly triggerCampaignId?: string;
+    readonly status: FlowStatus;
+    readonly executionCount: number;
+    readonly createdBy?: string;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+    readonly steps?: readonly FlowStep[];
+}
+interface FlowStepInput {
+    readonly stepType: FlowStepType;
+    readonly config: FlowStepConfig;
+}
+interface CreateFlow {
+    readonly name: string;
+    readonly description?: string;
+    readonly triggerType: FlowTriggerType;
+    readonly triggerCampaignId?: string;
+    readonly steps?: readonly FlowStepInput[];
+}
+interface UpdateFlow {
+    readonly name?: string;
+    readonly description?: string;
+    readonly triggerType?: FlowTriggerType;
+    readonly triggerCampaignId?: string;
+    readonly status?: FlowStatus;
+    readonly steps?: readonly FlowStepInput[];
+}
+interface FlowListParams extends ListParams {
+    readonly status?: FlowStatus;
+}
+type DecisionType = 'confirm' | 'select' | 'input';
+type DecisionStatus = 'pending' | 'answered' | 'expired' | 'cancelled';
+interface CreateDecision {
+    readonly question: string;
+    readonly type?: DecisionType;
+    readonly options?: readonly string[];
+    readonly externalId?: string;
+    readonly email?: string;
+    readonly callbackUrl?: string;
+    readonly agentName?: string;
+    readonly context?: string;
+    readonly placeholder?: string;
+    readonly expiresInSeconds?: number;
+    readonly wait?: boolean;
+    readonly timeoutSeconds?: number;
+    readonly idempotencyKey?: string;
+    readonly poweredBy?: boolean;
+    readonly requireReachable?: boolean;
+}
+interface DecisionReachability {
+    readonly reachable?: boolean;
+    readonly reachableChannels?: number;
+    readonly deviceCount?: number;
+}
+interface DecisionResult extends DecisionReachability {
+    readonly decisionId: string;
+    readonly status: DecisionStatus;
+    readonly answered: boolean;
+    readonly value?: string | null;
+    readonly type?: DecisionType;
+    readonly question?: string;
+    readonly pollUrl?: string;
+    readonly decisionPageUrl?: string;
+    readonly expiresInSeconds?: number;
+    readonly idempotent?: boolean;
+    readonly hint?: string;
+}
+interface Decision {
+    readonly decisionId: string;
+    readonly status: DecisionStatus;
+    readonly answered: boolean;
+    readonly value: string | null;
+    readonly type: DecisionType;
+    readonly question: string;
+    readonly options: readonly string[] | null;
+    readonly externalId: string | null;
+    readonly context: string | null;
+    readonly createdAt: string;
+    readonly answeredAt: string | null;
+    readonly expiresAt: string | null;
+}
+interface DecisionAnswerResult {
+    readonly decisionId: string;
+    readonly status: DecisionStatus;
+    readonly answered: boolean;
+    readonly value?: string | null;
+}
+interface CancelDecisionResult {
+    readonly decisionId: string;
+    readonly cancelled: boolean;
+    readonly status: string;
+}
+interface WebhookSecret {
+    readonly webhookSecret: string;
+}
+interface DecisionCallback {
+    readonly correlationId: string;
+    readonly answer: string;
+    readonly value: string;
+    readonly answeredAt: string;
+    readonly context?: string;
+}
+interface EnrollResult {
+    readonly externalId: string;
+    readonly token: string;
+    readonly deepLink: string;
+    readonly universalLink: string;
+    readonly expiresInSeconds: number;
+}
+interface AskDecision {
+    readonly question: string;
+    readonly type?: DecisionType;
+    readonly options?: readonly string[];
+    readonly externalId?: string;
+    readonly email?: string;
+    readonly agentName?: string;
+    readonly context?: string;
+    readonly placeholder?: string;
+    readonly expiresInSeconds?: number;
+    readonly idempotencyKey?: string;
+    readonly poweredBy?: boolean;
+    readonly callbackUrl?: string;
+    readonly requireReachable?: boolean;
+    readonly timeoutMs?: number;
+}
+interface AskResult extends DecisionReachability {
+    readonly decisionId: string;
+    readonly status: DecisionStatus;
+    readonly answered: boolean;
+    readonly value: string | null;
+    readonly type: DecisionType;
+    readonly approved: boolean;
+}
+interface IssueBoundKey {
+    readonly externalId: string;
+    readonly name?: string;
+    readonly expiresInSeconds?: number;
+}
+interface BoundKeyResult {
+    readonly apiKey: string;
+    readonly keyPrefix: string;
+    readonly scope: 'bound';
+    readonly boundExternalId: string;
+    readonly expiresAt: string | null;
+}
+interface BoundKeySummary {
+    readonly keyPrefix: string;
+    readonly name: string;
+    readonly boundExternalId: string | null;
+    readonly isActive: boolean;
+    readonly lastUsedAt: string | null;
+    readonly expiresAt: string | null;
+    readonly createdAt: string;
+}
+interface RevokeKeyResult {
+    readonly keyPrefix: string;
+    readonly revoked: boolean;
+}
+
+interface SubscribersResource {
+    readonly list: (params?: SubscriberListParams) => Promise<PaginatedResponse<Subscriber>>;
+    readonly get: (id: string) => Promise<Subscriber>;
+    readonly update: (id: string, data: UpdateSubscriber) => Promise<Subscriber>;
+    readonly delete: (id: string) => Promise<void>;
+    readonly count: () => Promise<SubscriberCount>;
+}
+
+interface CampaignsResource {
+    readonly list: (params?: ListParams) => Promise<PaginatedResponse<Campaign>>;
+    readonly create: (data: CreateCampaign) => Promise<Campaign>;
+    readonly get: (id: string) => Promise<Campaign>;
+    readonly update: (id: string, data: UpdateCampaign) => Promise<Campaign>;
+    readonly delete: (id: string) => Promise<void>;
+    readonly send: (id: string) => Promise<Campaign>;
+    readonly pause: (id: string) => Promise<Campaign>;
+    readonly resume: (id: string) => Promise<Campaign>;
+    readonly stats: (id: string) => Promise<CampaignStats>;
+}
+
+interface TemplatesResource {
+    readonly list: (params?: ListParams) => Promise<PaginatedResponse<Template>>;
+    readonly create: (data: CreateTemplate) => Promise<Template>;
+    readonly get: (id: string) => Promise<Template>;
+    readonly update: (id: string, data: UpdateTemplate) => Promise<Template>;
+    readonly delete: (id: string) => Promise<void>;
+}
+
+interface NotificationsResource {
+    readonly send: (data: SendNotification) => Promise<SendResult>;
+}
+
+interface FlowsResource {
+    readonly list: (params?: FlowListParams) => Promise<PaginatedResponse<Flow>>;
+    readonly create: (data: CreateFlow) => Promise<Flow>;
+    readonly get: (id: string) => Promise<Flow>;
+    readonly update: (id: string, data: UpdateFlow) => Promise<Flow>;
+    readonly delete: (id: string) => Promise<void>;
+    readonly activate: (id: string) => Promise<Flow>;
+    readonly pause: (id: string) => Promise<Flow>;
+}
+
+interface DecisionsResource {
+    readonly create: (data: CreateDecision) => Promise<DecisionResult>;
+    readonly get: (id: string, opts?: {
+        readonly wait?: number;
+    }) => Promise<Decision>;
+    readonly ask: (data: AskDecision) => Promise<AskResult>;
+    readonly answer: (id: string, answer: string) => Promise<DecisionAnswerResult>;
+    readonly cancel: (id: string) => Promise<CancelDecisionResult>;
+    readonly getWebhookSecret: () => Promise<WebhookSecret>;
+    readonly rotateWebhookSecret: () => Promise<WebhookSecret>;
+}
+
+interface KeysResource {
+    readonly issue: (data: IssueBoundKey) => Promise<BoundKeyResult>;
+    readonly list: () => Promise<readonly BoundKeySummary[]>;
+    readonly revoke: (keyPrefix: string) => Promise<RevokeKeyResult>;
+}
+
+interface PusharyServer {
+    readonly subscribers: SubscribersResource;
+    readonly campaigns: CampaignsResource;
+    readonly templates: TemplatesResource;
+    readonly notifications: NotificationsResource;
+    readonly flows: FlowsResource;
+    readonly decisions: DecisionsResource;
+    readonly keys: KeysResource;
+    readonly enroll: (externalId: string) => Promise<EnrollResult>;
+}
+declare const createPusharyServer: (config: PusharyConfig) => PusharyServer;
+
+declare const SIGNATURE_HEADER = "x-pushary-signature";
+declare const verifyWebhookSignature: (rawBody: string, signature: string | null | undefined, secret: string) => boolean;
+declare const parseDecisionCallback: (rawBody: string) => DecisionCallback | null;
+
+declare const deterministicKey: (parts: readonly string[]) => string;
+declare const isApproved: (decision: {
+    readonly status: DecisionStatus;
+    readonly type?: DecisionType;
+    readonly value: string | null;
+}) => boolean;
+
+export { parseDecisionCallback as $, type DecisionAnswerResult as A, type CancelDecisionResult as B, type Campaign as C, type DecisionType as D, type DecisionCallback as E, type Flow as F, type EnrollResult as G, type AskDecision as H, type AskResult as I, type IssueBoundKey as J, type BoundKeyResult as K, type ListParams as L, type BoundKeySummary as M, type SubscribersResource as N, type CampaignsResource as O, type PusharyServer as P, type TemplatesResource as Q, type RevokeKeyResult as R, type Subscriber as S, type Template as T, type UpdateSubscriber as U, type NotificationsResource as V, type WebhookSecret as W, type FlowsResource as X, type DecisionsResource as Y, type KeysResource as Z, verifyWebhookSignature as _, type PusharyConfig as a, SIGNATURE_HEADER as a0, deterministicKey as a1, isApproved as a2, type SubscriberListParams as b, createPusharyServer as c, type SubscriberCount as d, type CreateCampaign as e, type UpdateCampaign as f, type CampaignStats as g, type CreateTemplate as h, type UpdateTemplate as i, type SendNotification as j, type SendResult as k, type CreateFlow as l, type UpdateFlow as m, type FlowListParams as n, type FlowTriggerType as o, type FlowStepType as p, type FlowStatus as q, type FlowStep as r, type FlowStepConfig as s, type FlowStepInput as t, type PaginatedResponse as u, type DecisionStatus as v, type CreateDecision as w, type DecisionReachability as x, type DecisionResult as y, type Decision as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushary/server",
-  "version": "1.3.3",
+  "version": "1.4.0",
   "description": "Pushary Server SDK: send push notifications and add human-in-the-loop approvals to your AI agent (pause on a decision until a specific human answers).",
   "author": "Pushary <business@pushary.com>",
   "homepage": "https://pushary.com",
@@ -17,6 +17,11 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
+    },
+    "./adapters": {
+      "types": "./dist/adapters.d.ts",
+      "import": "./dist/adapters.js",
+      "require": "./dist/adapters.cjs"
     }
   },
   "files": [