@patientprism/snippet-sdk 1.1.1 → 1.1.2

package/package.json

@@ -2,7 +2,7 @@
   "name": "@patientprism/snippet-sdk",
   "type": "module",
   "types": "types/index.d.ts",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "scripts": {
     "test": "vitest run",
     "test:watch": "vitest watch",
@@ -10,6 +10,9 @@
     "build": "vite build",
     "build:types": "sh ./build-type-declarations.sh"
   },
+  "files": [
+    "types/"
+  ],
   "dependencies": {},
   "devDependencies": {}
 }

package/types/index.d.ts

@@ -1,3 +1,68 @@
+/**
+ * @typedef {Object} SubmissionField
+ *
+ * @property {string} type
+ * @property {string|number} value
+ * @property {string} label
+ */
+/**
+ * @typedef {Record<string, string|number|null>} SubmissionOptions
+ */
+/**
+ * @typedef {Record<string, SubmissionField>} Submission
+ */
+/**
+ * @typedef {Object} SwapSDK
+ *
+ * Object containing methods related to Swap functionality.
+ *
+ * @property {() => Promise<void>} init Initializes the Swap functionality.
+ */
+/**
+ * @typedef {Object} SubmissionSDK
+ *
+ * Object containing methods related to Submission functionality.
+ *
+ * @property {boolean} captureHiddenFields Indicates whether hidden fields should be captured in submissions.
+ * @property {() => Promise<void>} init Initialize the Submission functionality.
+ * @property {(data: Submission, elementID: string|HTMLElement, options?: SubmissionOptions) => Promise<void>} send Send the form submission.
+ */
+/**
+ * @typedef {Object} CustomFieldSDK
+ *
+ * Object containing methods related to the Custom Field functionality.
+ *
+ * @property {(keys?: string|string[]|Set<string>) => Promise<void>} recapture Recapture some or all of the custom fields.
+ */
+/**
+ * @typedef {Object} CustomFieldSDK
+ *
+ * Object containing methods related to the Custom Field functionality.
+ *
+ * @property {(keys?: string|string[]|Set<string>) => Promise<void>} recapture Recapture some or all of the custom fields.
+ */
+/**
+ * @typedef {Object} BookingSDK
+ *
+ * Object containing methods related to Online Booking functionality.
+ *
+ * @property {(source: string, options?: Object) => Object} create Create a booking session
+ * @property {(formElement: HTMLElement, source: string, options?: Object) => Object} track Track a form for booking lifecycle (convenience method)
+ */
+/**
+ * @typedef {Object} PrismSDK
+ *
+ * The global `$prism` object for managing Prism-related functionality.
+ *
+ * @property {boolean} loaded Indicates whether Prism has been loaded or not.
+ * @property {boolean} debug Indicates whether Prism is in debug mode or not.
+ * @property {(message: string) => void} log Logs a message to the console if debug mode is enabled.
+ * @property {SwapSDK} swap Object containing methods related to Swap functionality.
+ * @property {SubmissionSDK} submission Object containing methods related to Submission functionality.
+ * @property {CustomFieldSDK} custom_fields Object containing methods related to the Custom Field functionality.
+ * @property {BookingSDK} bookings Object containing methods related to Online Booking functionality.
+ */
+export default function handle(): void;
 export type SubmissionField = {
     type: string;
     value: string | number;
@@ -40,6 +105,19 @@ export type CustomFieldSDK = {
      */
     recapture: (keys?: string | string[] | Set<string>) => Promise<void>;
 };
+/**
+ * Object containing methods related to Online Booking functionality.
+ */
+export type BookingSDK = {
+    /**
+     * Create a booking session
+     */
+    create: (source: string, options?: any) => any;
+    /**
+     * Track a form for booking lifecycle (convenience method)
+     */
+    track: (formElement: HTMLElement, source: string, options?: any) => any;
+};
 /**
  * The global `$prism` object for managing Prism-related functionality.
  */
@@ -68,6 +146,10 @@ export type PrismSDK = {
      * Object containing methods related to the Custom Field functionality.
      */
     custom_fields: CustomFieldSDK;
+    /**
+     * Object containing methods related to Online Booking functionality.
+     */
+    bookings: BookingSDK;
 };
 
 declare global {