@codingfactory/notify-kit-client 0.1.0 → 0.2.0

package/dist/{useNotifyKitModals-BZ_NiTKw.d.ts → useNotifyKitModals-CUfVmBsN.d.ts}

@@ -3,28 +3,6 @@ import { InjectionKey, ComputedRef, Ref } from 'vue';
 /**
  * Modal-related type definitions for critical notification modals.
  */
-/**
- * Escape key behavior modes for modals.
- */
-type EscapeKeyBehavior = 'close' | 'snooze' | 'disabled';
-/**
- * Accessibility settings for modal notifications.
- * Ensures WCAG 2.1 AA compliance.
- */
-interface NotifyKitModalAccessibility {
-    /** Escape key behavior: close, snooze, or disabled */
-    readonly escape_key_behavior: EscapeKeyBehavior;
-    /** Whether focus is trapped inside the modal */
-    readonly focus_trap: boolean;
-    /** Whether to auto-focus the first action button */
-    readonly auto_focus_first_action: boolean;
-    /** ARIA role for the modal element */
-    readonly aria_role: string;
-    /** ID of the element that labels the modal (aria-labelledby) */
-    readonly aria_labelled_by: string | null;
-    /** ID of the element that describes the modal (aria-describedby) */
-    readonly aria_described_by: string | null;
-}
 /**
  * Modal specification included in notifications that require modal display.
  */
@@ -35,8 +13,6 @@ interface NotifyKitModalSpec {
     readonly requires_ack: boolean;
     /** Available snooze duration options in minutes */
     readonly snooze_options_minutes: readonly number[];
-    /** Accessibility settings for the modal */
-    readonly accessibility: NotifyKitModalAccessibility;
 }
 /**
  * Modal state tracking for a notification.
@@ -125,39 +101,58 @@ declare function isNotifyKitNotification(value: unknown): value is NotifyKitNoti
 declare function isModalEnabled(notification: NotifyKitNotification): boolean;
 
 /**
- * User notification preferences type definitions.
+ * User notification preference settings type definitions.
  */
 
-/**
- * Channel preference settings for a single category.
- */
-interface ChannelPreferences {
-    /** Whether to store in database (notification center) */
-    readonly database: boolean;
-    /** Whether to broadcast in real-time */
-    readonly broadcast: boolean;
-    /** Whether to send via email */
-    readonly mail: boolean;
+type NotifyKitPreferenceBooleanMap = Readonly<Record<string, boolean>>;
+type NotifyKitPreferenceModeMap = Readonly<Record<string, string>>;
+interface NotifyKitQuietHours {
+    readonly start: string;
+    readonly end: string;
 }
-/**
- * User's notification preferences organized by category.
- */
-interface NotifyKitPreferences {
-    /** Preferences per category */
-    readonly categories: Readonly<Record<NotificationCategory, ChannelPreferences>>;
+interface NotifyKitDigestPreferences {
+    readonly enabled: boolean;
+    readonly frequency: 'daily' | 'weekly';
+    readonly categories: readonly NotificationCategory[] | null;
+    readonly workspace_id: string | null;
+    readonly timezone: string | null;
+    readonly hour: number;
+    readonly quiet_hours: NotifyKitQuietHours | null;
 }
-/**
- * Partial preferences update request.
- * Only categories/channels that need updating should be included.
- */
-interface NotifyKitPreferencesUpdate {
-    /** Partial category preferences to update */
-    readonly categories?: Partial<Record<NotificationCategory, Partial<ChannelPreferences>>>;
+interface NotifyKitPreferenceSettings {
+    readonly channels: NotifyKitPreferenceBooleanMap;
+    readonly channel_modes: NotifyKitPreferenceModeMap;
+    readonly topics: NotifyKitPreferenceBooleanMap;
+    readonly email_preferences: NotifyKitPreferenceBooleanMap;
+    readonly keyword_rules: readonly string[];
+    readonly digest: NotifyKitDigestPreferences;
+    readonly available_channels: readonly string[];
+    readonly available_topics: readonly string[];
+    readonly available_email_preferences: readonly string[];
 }
-/**
- * Type guard to validate if a value is valid ChannelPreferences.
- */
-declare function isChannelPreferences(value: unknown): value is ChannelPreferences;
+interface NotifyKitPreferenceSettingsQuery {
+    readonly workspace_id?: string | null;
+}
+interface NotifyKitPreferenceSettingsUpdate {
+    readonly workspace_id?: string | null;
+    readonly channels?: Record<string, boolean>;
+    readonly channel_modes?: Record<string, string>;
+    readonly topics?: Record<string, boolean>;
+    readonly email_preferences?: Record<string, boolean>;
+    readonly keyword_rules?: readonly string[];
+    readonly digest?: {
+        readonly enabled?: boolean;
+        readonly frequency?: 'daily' | 'weekly';
+        readonly categories?: readonly NotificationCategory[] | null;
+        readonly timezone?: string | null;
+        readonly hour?: number;
+        readonly quiet_hours?: NotifyKitQuietHours | null;
+    };
+}
+type NotifyKitPreferences = NotifyKitPreferenceSettings;
+type NotifyKitPreferencesUpdate = NotifyKitPreferenceSettingsUpdate;
+declare function isNotifyKitQuietHours(value: unknown): value is NotifyKitQuietHours;
+declare function isNotifyKitPreferenceSettings(value: unknown): value is NotifyKitPreferenceSettings;
 
 /**
  * API response type definitions for Notify Kit endpoints.
@@ -230,6 +225,27 @@ interface NotifyKitModalsResponse {
     /** Array of outstanding modal notifications */
     readonly data: readonly NotifyKitNotification[];
 }
+/**
+ * Response from GET /notifications/:id endpoint.
+ */
+interface NotifyKitSingleNotificationResponse {
+    /** The requested notification */
+    readonly data: NotifyKitNotification;
+}
+/**
+ * Generic message response from mutation endpoints.
+ */
+interface NotifyKitMutationResponse {
+    /** Human-readable result message */
+    readonly message: string;
+}
+/**
+ * Response from read actions that also return the updated unread count.
+ */
+interface NotifyKitReadMutationResponse extends NotifyKitMutationResponse {
+    /** Updated unread count when supplied by the backend */
+    readonly unread_count?: number;
+}
 /**
  * Parameters for listing notifications.
  */
@@ -277,6 +293,75 @@ declare function isMeResponse(value: unknown): value is NotifyKitMeResponse;
  * Type guard to validate NotifyKitUnreadCountResponse.
  */
 declare function isUnreadCountResponse(value: unknown): value is NotifyKitUnreadCountResponse;
+/**
+ * Filters for bulk operations.
+ */
+interface BulkFilters {
+    /** Filter by category */
+    readonly category?: NotificationCategory;
+    /** Filter to unread only */
+    readonly unread_only?: boolean;
+}
+/**
+ * Request body for bulk actions.
+ */
+interface BulkActionRequest {
+    /** Specific notification IDs to act on */
+    readonly notification_ids?: readonly string[];
+    /** Act on all matching notifications */
+    readonly all?: boolean;
+    /** Filters to apply when all=true */
+    readonly filters?: BulkFilters;
+}
+/**
+ * Response from bulk action endpoints.
+ */
+interface BulkActionResult {
+    /** Number of notifications affected */
+    readonly affected: number;
+    /** Number of failures */
+    readonly failed: number;
+}
+/**
+ * Search filters for notification search.
+ */
+interface SearchFilters {
+    /** Filter by category */
+    readonly category?: NotificationCategory;
+    /** Filter to unread only */
+    readonly unread?: boolean;
+    /** Filter by level */
+    readonly level?: string;
+}
+/**
+ * Response from search endpoint.
+ */
+interface SearchResult {
+    /** Array of matching notifications */
+    readonly data: readonly NotifyKitNotification[];
+    /** Total number of matches */
+    readonly total: number;
+}
+/**
+ * A saved filter preset.
+ */
+interface SavedFilter {
+    /** Unique filter ID */
+    readonly id: string;
+    /** Display name */
+    readonly name: string;
+    /** Filter configuration */
+    readonly filters: Readonly<Record<string, unknown>>;
+    /** Whether this is a system-provided preset */
+    readonly system: boolean;
+}
+/**
+ * Response from saved filters endpoint.
+ */
+interface SavedFiltersResponse {
+    /** Array of saved filters */
+    readonly data: readonly SavedFilter[];
+}
 
 /**
  * Notify Kit HTTP Client
@@ -301,8 +386,9 @@ interface NotifyKitClientConfig {
 declare class NotifyKitApiError extends Error {
     readonly status: number;
     readonly errors?: Readonly<Record<string, readonly string[]>> | undefined;
+    readonly headers?: Readonly<Record<string, string>> | undefined;
     readonly name = "NotifyKitApiError";
-    constructor(message: string, status: number, errors?: Readonly<Record<string, readonly string[]>> | undefined);
+    constructor(message: string, status: number, errors?: Readonly<Record<string, readonly string[]>> | undefined, headers?: Readonly<Record<string, string>> | undefined);
 }
 /**
  * HTTP Client for the Notify Kit API.
@@ -324,10 +410,14 @@ declare class NotifyKitClient {
      * Get the count of unread notifications.
      */
     getUnreadCount(): Promise<NotifyKitUnreadCountResponse>;
+    /**
+     * Get a single notification for the current user.
+     */
+    getNotification(id: string): Promise<NotifyKitNotification>;
     /**
      * Mark a notification as read.
      */
-    markRead(id: string): Promise<void>;
+    markRead(id: string): Promise<NotifyKitReadMutationResponse>;
     /**
      * Mark all notifications as read.
      */
@@ -357,13 +447,69 @@ declare class NotifyKitClient {
      */
     snoozeModal(id: string, minutes: number): Promise<void>;
     /**
-     * Get the current user's notification preferences.
+     * Get the current user's notification preference settings.
+     */
+    getPreferenceSettings(query?: NotifyKitPreferenceSettingsQuery): Promise<NotifyKitPreferences>;
+    /**
+     * Alias for getPreferenceSettings.
+     */
+    getPreferences(query?: NotifyKitPreferenceSettingsQuery): Promise<NotifyKitPreferences>;
+    /**
+     * Update the current user's notification preference settings.
+     */
+    updatePreferenceSettings(preferences: NotifyKitPreferencesUpdate): Promise<NotifyKitPreferences>;
+    /**
+     * Alias for updatePreferenceSettings.
+     */
+    updatePreferences(preferences: NotifyKitPreferencesUpdate): Promise<NotifyKitPreferences>;
+    /**
+     * Bulk mark notifications as read.
+     */
+    bulkMarkRead(ids: readonly string[]): Promise<BulkActionResult>;
+    /**
+     * Bulk mark all matching notifications as read.
+     */
+    bulkMarkAllRead(filters?: BulkFilters): Promise<BulkActionResult>;
+    /**
+     * Bulk archive notifications.
+     */
+    bulkArchive(ids: readonly string[]): Promise<BulkActionResult>;
+    /**
+     * Bulk archive all matching notifications.
+     */
+    bulkArchiveAll(filters?: BulkFilters): Promise<BulkActionResult>;
+    /**
+     * Bulk delete notifications.
+     */
+    bulkDelete(ids: readonly string[]): Promise<BulkActionResult>;
+    /**
+     * Bulk delete all matching notifications.
+     */
+    bulkDeleteAll(filters?: BulkFilters): Promise<BulkActionResult>;
+    /**
+     * Search notifications by query.
+     */
+    search(query: string, filters?: SearchFilters, limit?: number): Promise<SearchResult>;
+    /**
+     * Get saved filters (system + custom).
+     */
+    getSavedFilters(): Promise<readonly SavedFilter[]>;
+    /**
+     * Save a custom filter.
+     */
+    saveFilter(name: string, filters: Record<string, unknown>): Promise<SavedFilter>;
+    /**
+     * Delete a custom filter.
+     */
+    deleteFilter(filterId: string): Promise<void>;
+    /**
+     * Archive a notification.
      */
-    getPreferences(): Promise<NotifyKitPreferences>;
+    archiveNotification(id: string): Promise<void>;
     /**
-     * Update the current user's notification preferences.
+     * Unarchive a notification.
      */
-    updatePreferences(preferences: NotifyKitPreferencesUpdate): Promise<void>;
+    unarchiveNotification(id: string): Promise<void>;
     private buildNotificationParams;
     private request;
 }
@@ -583,4 +729,4 @@ declare function provideNotifyKitModals(options: UseNotifyKitModalsOptions): Use
  */
 declare function useNotifyKitModals(options: UseNotifyKitModalsOptions): UseNotifyKitModalsReturn;
 
-export { createNotifyKitClient as A, isChannelPreferences as B, type ConnectionState as C, isMeResponse as D, isModalEnabled as E, isModalSpec as F, isNotifyKitNotification as G, isPaginationMeta as H, InvalidSnoozeDurationError as I, isUnreadCountResponse as J, isValidCategory as K, type ListNotificationsParams as L, isValidLevel as M, NotifyKitClient as N, provideNotifyKitModals as O, type PaginationParams as P, provideNotifyKitStore as Q, resetNotifyKitStore as R, useNotifyKitModals as S, useNotifyKitStore as T, type UseNotifyKitModalsOptions as U, type NotifyKitMeResponse as a, type NotifyKitListResponse as b, type NotifyKitUnreadCountResponse as c, type NotifyKitNotification as d, type NotifyKitPreferences as e, type NotifyKitPreferencesUpdate as f, type NotifyKitClientConfig as g, type NotificationCategory as h, type NotificationLevel as i, type ChannelPreferences as j, NOTIFICATION_CATEGORIES as k, NOTIFICATION_LEVELS as l, NOTIFY_KIT_MODALS_KEY as m, NOTIFY_KIT_STORE_KEY as n, NotifyKitApiError as o, type NotifyKitErrorResponse as p, type NotifyKitGroupedEntry as q, type NotifyKitGroupedListResponse as r, type NotifyKitModalSpec as s, type NotifyKitModalState as t, type NotifyKitModalsClientLike as u, type NotifyKitModalsResponse as v, type NotifyKitStoreState as w, type PaginationMeta as x, type UseNotifyKitModalsReturn as y, type UseNotifyKitStoreReturn as z };
+export { isNotifyKitQuietHours as $, type NotifyKitModalsResponse as A, type BulkActionResult as B, type ConnectionState as C, type NotifyKitMutationResponse as D, type NotifyKitPreferenceBooleanMap as E, type NotifyKitPreferenceModeMap as F, type NotifyKitPreferenceSettings as G, type NotifyKitPreferenceSettingsUpdate as H, InvalidSnoozeDurationError as I, type NotifyKitSingleNotificationResponse as J, type NotifyKitStoreState as K, type ListNotificationsParams as L, type PaginationMeta as M, NotifyKitClient as N, type SavedFiltersResponse as O, type PaginationParams as P, type SearchResult as Q, type UseNotifyKitModalsReturn as R, type SearchFilters as S, type UseNotifyKitStoreReturn as T, type UseNotifyKitModalsOptions as U, createNotifyKitClient as V, isMeResponse as W, isModalEnabled as X, isModalSpec as Y, isNotifyKitNotification as Z, isNotifyKitPreferenceSettings as _, type NotifyKitMeResponse as a, isPaginationMeta as a0, isUnreadCountResponse as a1, isValidCategory as a2, isValidLevel as a3, provideNotifyKitModals as a4, provideNotifyKitStore as a5, resetNotifyKitStore as a6, useNotifyKitModals as a7, useNotifyKitStore as a8, type NotifyKitListResponse as b, type NotifyKitUnreadCountResponse as c, type NotifyKitNotification as d, type NotifyKitReadMutationResponse as e, type NotifyKitPreferenceSettingsQuery as f, type NotifyKitPreferences as g, type NotifyKitPreferencesUpdate as h, type NotifyKitClientConfig as i, type BulkFilters as j, type SavedFilter as k, type NotificationCategory as l, type NotificationLevel as m, type BulkActionRequest as n, NOTIFICATION_CATEGORIES as o, NOTIFICATION_LEVELS as p, NOTIFY_KIT_MODALS_KEY as q, NOTIFY_KIT_STORE_KEY as r, NotifyKitApiError as s, type NotifyKitDigestPreferences as t, type NotifyKitErrorResponse as u, type NotifyKitGroupedEntry as v, type NotifyKitGroupedListResponse as w, type NotifyKitModalSpec as x, type NotifyKitModalState as y, type NotifyKitModalsClientLike as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codingfactory/notify-kit-client",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Headless Vue 3/Nuxt client for Notify Kit notifications",
   "type": "module",
   "main": "./dist/index.js",
@@ -20,9 +20,7 @@
     "dist"
   ],
   "scripts": {
-    "generate:types": "npx tsx ../../scripts/generate-types.ts",
     "dev": "tsup --watch",
-    "prebuild": "npm run generate:types",
     "build": "tsup",
     "typecheck": "tsc --noEmit",
     "lint": "eslint src tests",
@@ -70,8 +68,5 @@
     "type": "git",
     "url": "https://github.com/coding-factory/notify-kit.git",
     "directory": "packages/notify-kit-client"
-  },
-  "publishConfig": {
-    "access": "restricted"
   }
 }