magicbell-js 1.5.0 → 1.6.0

package/src/user-client/services/integrations/models/theme.ts

@@ -14,7 +14,9 @@ import {
 import { UnseenBadge, unseenBadge, unseenBadgeRequest, unseenBadgeResponse } from './unseen-badge.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Theme model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const theme = z.lazy(() => {
   return z.object({
@@ -29,21 +31,22 @@ export const theme = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Theme} theme
- * @property {Banner}
- * @property {Dialog}
- * @property {Footer}
- * @property {Header}
- * @property {Icon}
- * @property {ThemeNotification}
- * @property {UnseenBadge}
+ * Visual customization options for the hosted inbox widget.
+ * @typedef  {Theme} theme - Visual customization options for the hosted inbox widget. - Visual customization options for the hosted inbox widget.
+ * @property {Banner} - Top banner styling options.
+ * @property {Dialog} - Styling for confirmation and action dialogs.
+ * @property {Footer} - Footer styling for the inbox modal.
+ * @property {Header} - Header styling for the inbox modal.
+ * @property {Icon} - Launcher icon styling overrides.
+ * @property {ThemeNotification} - Styling overrides for notification list items.
+ * @property {UnseenBadge} - Badge styling for unseen notification counts.
  */
 export type Theme = z.infer<typeof theme>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the Theme application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const themeResponse = z.lazy(() => {
   return z
@@ -68,8 +71,9 @@ export const themeResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the Theme application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const themeRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/unread-hover.ts

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the UnreadHover model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const unreadHover = z.lazy(() => {
   return z.object({
@@ -10,15 +12,16 @@ export const unreadHover = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {UnreadHover} unreadHover
- * @property {string}
+ * Hover styles for unread notifications.
+ * @typedef  {UnreadHover} unreadHover - Hover styles for unread notifications. - Hover styles for unread notifications.
+ * @property {string} - Background color on hover for unread notifications.
  */
 export type UnreadHover = z.infer<typeof unreadHover>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the UnreadHover application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unreadHoverResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const unreadHoverResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the UnreadHover application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unreadHoverRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/unread-state.ts

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the UnreadState model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const unreadState = z.lazy(() => {
   return z.object({
@@ -10,15 +12,16 @@ export const unreadState = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {UnreadState} unreadState
- * @property {string}
+ * State indicator styling for unread notifications.
+ * @typedef  {UnreadState} unreadState - State indicator styling for unread notifications. - State indicator styling for unread notifications.
+ * @property {string} - Color for the unread state indicator.
  */
 export type UnreadState = z.infer<typeof unreadState>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the UnreadState application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unreadStateResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const unreadStateResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the UnreadState application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unreadStateRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/unread.ts

@@ -4,7 +4,9 @@ import { UnreadHover, unreadHover, unreadHoverRequest, unreadHoverResponse } fro
 import { UnreadState, unreadState, unreadStateRequest, unreadStateResponse } from './unread-state.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Unread model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const unread = z.lazy(() => {
   return z.object({
@@ -16,18 +18,19 @@ export const unread = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Unread} unread
- * @property {string}
- * @property {UnreadHover}
- * @property {UnreadState}
- * @property {string}
+ * Overrides for unread notifications.
+ * @typedef  {Unread} unread - Overrides for unread notifications. - Overrides for unread notifications.
+ * @property {string} - Background color applied to unread notifications.
+ * @property {UnreadHover} - Hover styles for unread notifications.
+ * @property {UnreadState} - State indicator styling for unread notifications.
+ * @property {string} - Text color used when a notification is unread.
  */
 export type Unread = z.infer<typeof unread>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the Unread application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unreadResponse = z.lazy(() => {
   return z
@@ -46,8 +49,9 @@ export const unreadResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the Unread application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unreadRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/unseen-badge.ts

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the UnseenBadge model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const unseenBadge = z.lazy(() => {
   return z.object({
@@ -10,15 +12,16 @@ export const unseenBadge = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {UnseenBadge} unseenBadge
- * @property {string}
+ * Badge styling for unseen notification counts.
+ * @typedef  {UnseenBadge} unseenBadge - Badge styling for unseen notification counts. - Badge styling for unseen notification counts.
+ * @property {string} - Badge background color.
  */
 export type UnseenBadge = z.infer<typeof unseenBadge>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the UnseenBadge application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unseenBadgeResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const unseenBadgeResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the UnseenBadge application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unseenBadgeRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/unseen-hover.ts

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the UnseenHover model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const unseenHover = z.lazy(() => {
   return z.object({
@@ -10,15 +12,16 @@ export const unseenHover = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {UnseenHover} unseenHover
- * @property {string}
+ * Hover styles for unseen notifications.
+ * @typedef  {UnseenHover} unseenHover - Hover styles for unseen notifications. - Hover styles for unseen notifications.
+ * @property {string} - Background color on hover for unseen notifications.
  */
 export type UnseenHover = z.infer<typeof unseenHover>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the UnseenHover application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unseenHoverResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const unseenHoverResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the UnseenHover application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unseenHoverRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/unseen-state.ts

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the UnseenState model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const unseenState = z.lazy(() => {
   return z.object({
@@ -10,15 +12,16 @@ export const unseenState = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {UnseenState} unseenState
- * @property {string}
+ * State indicator styling for unseen notifications.
+ * @typedef  {UnseenState} unseenState - State indicator styling for unseen notifications. - State indicator styling for unseen notifications.
+ * @property {string} - Color for the unseen state indicator.
  */
 export type UnseenState = z.infer<typeof unseenState>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the UnseenState application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unseenStateResponse = z.lazy(() => {
   return z
@@ -31,8 +34,9 @@ export const unseenStateResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the UnseenState application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unseenStateRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/unseen.ts

@@ -4,7 +4,9 @@ import { UnseenHover, unseenHover, unseenHoverRequest, unseenHoverResponse } fro
 import { UnseenState, unseenState, unseenStateRequest, unseenStateResponse } from './unseen-state.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Unseen model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const unseen = z.lazy(() => {
   return z.object({
@@ -16,18 +18,19 @@ export const unseen = z.lazy(() => {
 });
 
 /**
- *
- * @typedef  {Unseen} unseen
- * @property {string}
- * @property {UnseenHover}
- * @property {UnseenState}
- * @property {string}
+ * Overrides for unseen notifications.
+ * @typedef  {Unseen} unseen - Overrides for unseen notifications. - Overrides for unseen notifications.
+ * @property {string} - Background color applied to unseen notifications.
+ * @property {UnseenHover} - Hover styles for unseen notifications.
+ * @property {UnseenState} - State indicator styling for unseen notifications.
+ * @property {string} - Text color used when a notification is unseen.
  */
 export type Unseen = z.infer<typeof unseen>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the Unseen application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unseenResponse = z.lazy(() => {
   return z
@@ -46,8 +49,9 @@ export const unseenResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the Unseen application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const unseenRequest = z.lazy(() => {
   return z

package/src/user-client/services/integrations/models/web-push-start-installation-response.ts

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the WebPushStartInstallationResponse model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const webPushStartInstallationResponse = z.lazy(() => {
   return z.object({
@@ -13,14 +15,15 @@ export const webPushStartInstallationResponse = z.lazy(() => {
 /**
  *
  * @typedef  {WebPushStartInstallationResponse} webPushStartInstallationResponse
- * @property {string}
- * @property {string}
+ * @property {string} - Auth secret returned from PushSubscription.getKey('auth').
+ * @property {string} - VAPID public key generated for this web push installation.
  */
 export type WebPushStartInstallationResponse = z.infer<typeof webPushStartInstallationResponse>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the WebPushStartInstallationResponse application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const webPushStartInstallationResponseResponse = z.lazy(() => {
   return z
@@ -35,8 +38,9 @@ export const webPushStartInstallationResponseResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the WebPushStartInstallationResponse application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const webPushStartInstallationResponseRequest = z.lazy(() => {
   return z

package/src/user-client/services/notifications/models/count-response.ts

@@ -0,0 +1,49 @@
+import { z } from 'zod';
+
+/**
+ * Zod schema for the CountResponse model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
+ */
+export const countResponse = z.lazy(() => {
+  return z.object({
+    count: z.number(),
+  });
+});
+
+/**
+ *
+ * @typedef  {CountResponse} countResponse
+ * @property {number} - The count of notifications matching the query.
+ */
+export type CountResponse = z.infer<typeof countResponse>;
+
+/**
+ * Zod schema for mapping API responses to the CountResponse application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
+ */
+export const countResponseResponse = z.lazy(() => {
+  return z
+    .object({
+      count: z.number(),
+    })
+    .transform((data) => ({
+      count: data['count'],
+    }));
+});
+
+/**
+ * Zod schema for mapping the CountResponse application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
+ */
+export const countResponseRequest = z.lazy(() => {
+  return z
+    .object({
+      count: z.number(),
+    })
+    .transform((data) => ({
+      count: data['count'],
+    }));
+});

package/src/user-client/services/notifications/models/index.ts

@@ -1,2 +1,3 @@
+export type { CountResponse } from './count-response.js';
 export type { Notification } from './notification.js';
 export type { NotificationCollection } from './notification-collection.js';

package/src/user-client/services/notifications/models/notification-collection.ts

@@ -4,7 +4,9 @@ import { Links, links, linksRequest, linksResponse } from '../../common/links.js
 import { Notification, notification, notificationRequest, notificationResponse } from './notification.js';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the NotificationCollection model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const notificationCollection = z.lazy(() => {
   return z.object({
@@ -22,8 +24,9 @@ export const notificationCollection = z.lazy(() => {
 export type NotificationCollection = z.infer<typeof notificationCollection>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the NotificationCollection application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const notificationCollectionResponse = z.lazy(() => {
   return z
@@ -38,8 +41,9 @@ export const notificationCollectionResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the NotificationCollection application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const notificationCollectionRequest = z.lazy(() => {
   return z

package/src/user-client/services/notifications/models/notification.ts

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
 /**
- * The shape of the model inside the application code - what the users use
+ * Zod schema for the Notification model.
+ * Defines the structure and validation rules for this data type.
+ * This is the shape used in application code - what developers interact with.
  */
 export const notification = z.lazy(() => {
   return z.object({
@@ -26,27 +28,28 @@ export const notification = z.lazy(() => {
 /**
  *
  * @typedef  {Notification} notification
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {any}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
+ * @property {string} - The link associated with the notification.
+ * @property {string} - The timestamp when the notification was archived.
+ * @property {string} - The category grouping for the notification.
+ * @property {string} - The body content of the notification.
+ * @property {string} - The timestamp when the notification was created.
+ * @property {any} - The custom data stored with the notification.
+ * @property {string} - The timestamp when the notification was discarded.
+ * @property {string} - The unique identifier for the notification.
+ * @property {string} - The timestamp when the notification was marked as read.
+ * @property {string} - The timestamp when the notification was seen.
+ * @property {string} - The timestamp when the notification was sent.
+ * @property {string} - The title that is displayed to recipients.
+ * @property {string} - The topic for additional classification.
+ * @property {string} - The timestamp when the notification was last updated.
+ * @property {string} - The user that should receive the notification.
  */
 export type Notification = z.infer<typeof notification>;
 
 /**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping API responses to the Notification application shape.
+ * Handles any property name transformations from the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const notificationResponse = z.lazy(() => {
   return z
@@ -87,8 +90,9 @@ export const notificationResponse = z.lazy(() => {
 });
 
 /**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
+ * Zod schema for mapping the Notification application shape to API requests.
+ * Handles any property name transformations required by the API schema.
+ * If property names match the API schema exactly, this is identical to the application shape.
  */
 export const notificationRequest = z.lazy(() => {
   return z