@trycourier/courier-js 1.4.2 → 2.0.1-beta

package/dist/shared/authentication-listener.d.ts

@@ -0,0 +1,9 @@
+export declare class AuthenticationListener {
+    readonly callback: (props: {
+        userId?: string;
+    }) => void;
+    constructor(callback: (props: {
+        userId?: string;
+    }) => void);
+    remove(): void;
+}

package/dist/shared/courier.d.ts

@@ -0,0 +1,68 @@
+import { CourierClient, CourierProps } from '../client/courier-client';
+import { AuthenticationListener } from '../shared/authentication-listener';
+/**
+ * Courier is a singleton class that manages a shared Courier client instance and other resources.
+ * UI components will automatically syncronize with this instance.
+ * If you only need to call the Courier api, you should consider using the CourierClient directly.
+ */
+export declare class Courier {
+    /**
+     * The unique identifier for the Courier instance
+     */
+    readonly id: string;
+    /**
+     * The shared Courier instance
+     */
+    private static instance;
+    /**
+     * The Courier client instance
+     */
+    private instanceClient?;
+    /**
+     * The pagination limit (min: 1, max: 100)
+     */
+    private _paginationLimit;
+    get paginationLimit(): number;
+    set paginationLimit(value: number);
+    /**
+     * Get the Courier client instance
+     * @returns The Courier client instance or undefined if not signed in
+     */
+    get client(): CourierClient | undefined;
+    /**
+     * The authentication listeners
+     */
+    private authenticationListeners;
+    /**
+     * Get the shared Courier instance
+     * @returns The shared Courier instance
+     */
+    static get shared(): Courier;
+    /**
+     * Sign in to Courier
+     * @param options - The options for the Courier client
+     */
+    signIn(props: CourierProps): void;
+    /**
+     * Sign out of Courier
+     */
+    signOut(): void;
+    /**
+     * Register a callback to be notified of authentication state changes
+     * @param callback - Function to be called when authentication state changes
+     * @returns AuthenticationListener instance that can be used to remove the listener
+     */
+    addAuthenticationListener(callback: (props: {
+        userId?: string;
+    }) => void): AuthenticationListener;
+    /**
+     * Unregister an authentication state change listener
+     * @param listener - The AuthenticationListener instance to remove
+     */
+    removeAuthenticationListener(listener: AuthenticationListener): void;
+    /**
+     * Notify all authentication listeners
+     * @param props - The props to notify the listeners with
+     */
+    private notifyAuthenticationListeners;
+}

package/dist/socket/courier-socket.d.ts

@@ -0,0 +1,24 @@
+import { CourierClientOptions } from '../client/courier-client';
+export declare class CourierSocket {
+    private static readonly NORMAL_CLOSURE_STATUS;
+    private webSocket;
+    private pingInterval;
+    onOpen?: () => void;
+    onMessageReceived?: (message: string) => void;
+    onClose?: (code: number, reason?: string) => void;
+    onError?: (error: Error) => void;
+    private readonly url;
+    readonly options: CourierClientOptions;
+    constructor(url: string, options: CourierClientOptions);
+    /**
+     * Dynamically checks if the WebSocket is connected
+     */
+    get isConnected(): boolean;
+    connect(): Promise<void>;
+    disconnect(): void;
+    send(message: Record<string, any>): Promise<boolean>;
+    keepAlive(props?: {
+        intervalInMillis?: number;
+    }): void;
+    private stopPing;
+}

package/dist/socket/inbox-socket.d.ts

@@ -0,0 +1,19 @@
+import { CourierSocket } from './courier-socket';
+import { CourierClientOptions } from '../client/courier-client';
+import { InboxMessage } from '../types/inbox';
+export interface MessageEvent {
+    event: EventType;
+    messageId?: string;
+    type: string;
+}
+export type EventType = 'read' | 'unread' | 'mark-all-read' | 'opened' | 'unopened' | 'archive' | 'unarchive' | 'click';
+export declare class InboxSocket extends CourierSocket {
+    receivedMessage?: (message: InboxMessage) => void;
+    receivedMessageEvent?: (event: MessageEvent) => void;
+    constructor(options: CourierClientOptions);
+    private convertToType;
+    sendSubscribe(props?: {
+        version?: number;
+    }): Promise<void>;
+    private static buildUrl;
+}

package/dist/types/brands.d.ts

@@ -0,0 +1,36 @@
+export interface CourierBrand {
+    id: string;
+    name: string;
+    created: number;
+    updated: number;
+    published: number;
+    version: string;
+    settings?: CourierBrandSettings;
+}
+export interface CourierBrandSettings {
+    colors?: CourierBrandColors;
+    email?: CourierBrandEmail;
+    inapp?: CourierBrandInApp;
+}
+export interface CourierBrandColors {
+    primary?: string;
+    secondary?: string;
+    tertiary?: string;
+}
+export interface CourierBrandEmail {
+    header?: {
+        barColor?: string;
+    };
+    footer?: {
+        markdown?: string;
+    };
+    head?: {
+        inheritDefault?: boolean;
+    };
+}
+export interface CourierBrandInApp {
+    borderRadius?: string;
+    disableMessageIcon?: boolean;
+    placement?: string;
+    disableCourierFooter?: boolean;
+}

package/dist/types/courier-api-urls.d.ts

@@ -0,0 +1,11 @@
+export interface CourierApiUrls {
+    courier: {
+        rest: string;
+        graphql: string;
+    };
+    inbox: {
+        graphql: string;
+        webSocket: string;
+    };
+}
+export declare const getCourierApiUrls: (urls?: CourierApiUrls) => CourierApiUrls;

package/dist/types/inbox.d.ts

@@ -0,0 +1,43 @@
+export interface CourierGetInboxMessagesResponse {
+    data?: {
+        count?: number;
+        messages?: {
+            pageInfo?: {
+                startCursor?: string;
+                hasNextPage?: boolean;
+            };
+            nodes?: InboxMessage[];
+        };
+    };
+}
+export interface InboxAction {
+    content?: string;
+    href?: string;
+    data?: Record<string, any>;
+    background_color?: string;
+    style?: string;
+}
+export interface InboxMessage {
+    messageId: string;
+    title?: string;
+    body?: string;
+    preview?: string;
+    actions?: InboxAction[];
+    data?: Record<string, any>;
+    created?: string;
+    archived?: string;
+    read?: string;
+    opened?: string;
+    tags?: string[];
+    trackingIds?: {
+        archiveTrackingId?: string;
+        openTrackingId?: string;
+        clickTrackingId?: string;
+        deliverTrackingId?: string;
+        unreadTrackingId?: string;
+        readTrackingId?: string;
+    };
+}
+export interface CourierGetInboxMessageResponse {
+    message: InboxMessage;
+}

package/dist/types/pagination.d.ts

@@ -0,0 +1,4 @@
+export interface Paging {
+    cursor?: string;
+    more: boolean;
+}

package/dist/types/preference.d.ts

@@ -0,0 +1,37 @@
+export type CourierUserPreferencesStatus = 'OPTED_IN' | 'OPTED_OUT' | 'REQUIRED' | 'UNKNOWN';
+export type CourierUserPreferencesChannel = 'direct_message' | 'email' | 'push' | 'sms' | 'webhook' | 'unknown';
+export interface CourierUserPreferencesPaging {
+    cursor?: string;
+    more: boolean;
+}
+export interface CourierUserPreferencesTopic {
+    topicId: string;
+    topicName: string;
+    sectionId: string;
+    sectionName: string;
+    status: CourierUserPreferencesStatus;
+    defaultStatus: CourierUserPreferencesStatus;
+    hasCustomRouting: boolean;
+    customRouting: CourierUserPreferencesChannel[];
+}
+export interface CourierUserPreferences {
+    items: CourierUserPreferencesTopic[];
+    paging: CourierUserPreferencesPaging;
+}
+export interface CourierUserPreferencesTopicResponse {
+    topic: CourierUserPreferencesTopic;
+}
+export declare class PreferenceTransformer {
+    /**
+     * Transforms a single API response item to the CourierUserPreferencesTopic type
+     * @param item - The API response item
+     * @returns A CourierUserPreferencesTopic object
+     */
+    transformItem(item: any): CourierUserPreferencesTopic;
+    /**
+     * Transforms an array of API response items to CourierUserPreferencesTopic objects
+     * @param items - The API response items
+     * @returns A generator of CourierUserPreferencesTopic objects
+     */
+    transform(items: any[]): Generator<CourierUserPreferencesTopic>;
+}

package/dist/types/token.d.ts

@@ -0,0 +1,12 @@
+export interface CourierDevice {
+    appId?: string;
+    adId?: string;
+    deviceId?: string;
+    platform?: string;
+    manufacturer?: string;
+    model?: string;
+}
+export interface CourierToken {
+    provider_key: string;
+    device: CourierDevice;
+}

package/dist/types/tracking-event.d.ts

@@ -0,0 +1 @@
+export type CourierTrackingEvent = 'CLICKED' | 'DELIVERED' | 'OPENED' | 'READ' | 'UNREAD';

package/dist/utils/coding.d.ts

@@ -0,0 +1,2 @@
+export declare function decode(clientKey: string): string;
+export declare function encode(key: string): string;

package/dist/utils/logger.d.ts

@@ -0,0 +1,10 @@
+export declare class Logger {
+    private readonly showLogs;
+    private readonly PREFIX;
+    constructor(showLogs: boolean);
+    warn(message: string, ...args: any[]): void;
+    log(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+    debug(message: string, ...args: any[]): void;
+    info(message: string, ...args: any[]): void;
+}

package/dist/utils/request.d.ts

@@ -0,0 +1,21 @@
+import { CourierClientOptions } from '../client/courier-client';
+export declare class CourierRequestError extends Error {
+    code: number;
+    type?: string | undefined;
+    constructor(code: number, message: string, type?: string | undefined);
+}
+export declare function http(props: {
+    url: string;
+    options: CourierClientOptions;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    headers?: Record<string, string>;
+    body?: any;
+    validCodes?: number[];
+}): Promise<any>;
+export declare function graphql(props: {
+    url: string;
+    options: CourierClientOptions;
+    headers: Record<string, string>;
+    query: string;
+    variables?: Record<string, any>;
+}): Promise<any>;

package/dist/utils/uuid.d.ts

@@ -0,0 +1,3 @@
+export declare class UUID {
+    static generate(prefix?: string): string;
+}

package/package.json

@@ -1,28 +1,39 @@
 {
   "name": "@trycourier/courier-js",
-  "version": "1.4.2",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "sideEffects": false,
+  "version": "2.0.1-beta",
+  "description": "A browser-safe API wrapper",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "watch": "vite build --watch",
+    "preview": "vite preview",
+    "test": "jest",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "courier",
+    "api",
+    "wrapper",
+    "typescript",
+    "browser"
+  ],
+  "author": "Courier",
   "license": "MIT",
   "files": [
-    "dist/**"
+    "dist"
   ],
   "devDependencies": {
-    "eslint": "^7.32.0",
-    "tsup": "^5.10.1",
-    "typescript": "^4.5.3",
-    "eslint-config-courier": "1.0.0",
-    "@trycourier/tsconfig": "1.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts",
-    "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
-    "lint": "eslint \"src/**/*.ts*\"",
-    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
+    "@types/jest": "29.5.14",
+    "dotenv": "16.4.7",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "jest-fetch-mock": "^3.0.3",
+    "terser": "5.39.0",
+    "ts-jest": "29.1.1",
+    "vite": "6.2.6",
+    "vite-plugin-dts": "4.5.3"
   }
-}
+}

package/README.md

@@ -1,123 +0,0 @@
-[![Courier: Your Complete Communication Stack](https://www.courier.com/_next/image/?url=https%3A%2F%2Fimages.ctfassets.net%2Fz7iqk1q8njt4%2F1PZo9WNTdmoDoYH3yulXa0%2Fb10830f7bfb09af5e644a39ac3d20c41%2FCourierJS_header_alt2.png&w=1920&q=75)](https://courier.com)
-
-# Overview
-SDK used by client applications to interface with the Courier API.
- 
-<table>
-    <thead>
-        <tr>
-            <th width="880px" align="left">Requirements</th>
-            <th width="120px" align="center"></th>
-        </tr>
-    </thead>
-    <tbody>
-        <tr width="600px">
-            <td align="left">Courier Account</td>
-            <td align="center">
-                <a href="https://app.courier.com/signup">
-                    <code>Sign Up</code>
-                </a>
-            </td>
-        </tr>
-        <tr width="600px">
-            <td align="left">Client API Key</td>
-            <td align="center">
-                <a href="https://app.courier.com/settings/api-keys">
-                    <code>Get key</code>
-                </a>
-            </td>
-        </tr>
-    </tbody>
-</table>
-&emsp;
-
-# Supported Interfaces
-<table>
-    <thead>
-        <tr>
-            <th width="250px" align="left">Feature</th>
-            <th width="725px" align="left">Description</th>
-        </tr>
-    </thead>
-    <tbody>
-        <tr width="600px">
-            <td align="left">
-              <code>Identify</code>
-            </td>
-            <td align="left">
-                Event that triggers a user <a href="https://www.courier.com/docs/reference/profiles/create/"><code>Create</code></a> or <a href="https://www.courier.com/docs/reference/profiles/patch/"><code>Update</code></a> within Courier Profiles.
-            </td>
-        </tr>
-        <tr width="600px">
-            <td align="left">
-              <code>Track</code>
-            </td>
-            <td align="left">
-                Event ingested by Courier can be used to<a href="https://www.courier.com/docs/automations/designer/"> trigger an automation</a> or supply inline payloads within an <a href="https://app.courier.com/automations">existing</a> automation workflow.
-            </td>
-        </tr>
-        <tr width="600px">
-            <td align="left">
-                <code>GeneratePreferencesUrl</code>
-            </td>
-            <td align="left">
-                Generates URL that can be used to link users to <a href="https://www.courier.com/docs/courier-preferences/preference-center/introduction/">Preferences Center</a> to manage their notification preferences.
-            </td>
-        </tr>
-    </tbody>
-</table>
-
-# Installation
-
-```sh
-# npm
-npm install @trycourier/courier-js
-# yarn
-yarn add @trycourier/courier-js
-# pnpm
-pnpm add @trycourier/courier-js
-```
-&emsp;
-# Usage
-
-## Initializing Client
-```ts
-import courier from "@trycourier/courier-js";
-
-courier.init({
-  clientKey: "<REPLACE_WITH_YOUR_CLIENT_KEY>",
-  debug: true, // debug enables client side logs for error catching
-});
-```
-## Identify
-```ts
-await courierSDK.identify("purbleUserId", {
-      email: "customer@purbleplace.com",
-      favoriteColor: "purple",
-});
-```
-## Track
-### Basic
-```ts
-await courierSDK.track("user-signup");
-```
-### With data payload
-```ts
-await courierSDK.track("bake-cake", { 
-    cakeFlavor: "carrot", 
-    frosting: "cream cheese"
-});
-```
-## GeneratePreferencesUrl
-```ts
-const prefCenterLink = courier.generatePreferencesUrl("<user-id>", {
-  // optional
-  brandId: "<brand-id>",
-});
-```
-# **Share feedback with Courier**
-
-We are building the best SDKs for handling notifications! Have an idea or feedback about our SDKs? Here are some links to contact us:
-
-- [Courier Feedback](https://feedback.courier.com/)
-- [Courier JS Issues](https://github.com/trycourier/courier-js/issues)