@patientprism/snippet-sdk 1.0.0 → 1.1.0

package/README.md

@@ -1,4 +1,4 @@
-# Patient Prism SDK
+# Patient Prism Snippet SDK
 This package includes the Patient Prism Snippet SDK typings, used to assist you with integrating the Patient Prism Snippet into your custom application flow.
 
 # How to use
@@ -16,3 +16,34 @@ const data: Submission = {
 
 (window.$prism as PrismSDK).submission.send(data, 'elementId');
 ```
+
+# Form Tracking Control
+You can control which forms and fields are tracked by the snippet using data attributes:
+
+- `data-prism-exclude-form`: Add this attribute to any form element to exclude the entire form from tracking
+- `data-prism-exclude-input`: Add this attribute to any input element to exclude just that specific field from tracking
+- `data-prism-field-label`: Add this attribute to any input element to override the label used for tracking
+
+Example:
+```html
+<!-- This form will be tracked, but the password field will be excluded -->
+<form id="signup-form">
+    <input type="text" name="email" placeholder="Email">
+    <input type="password" name="password" data-prism-exclude-input placeholder="Password">
+    <button type="submit">Sign Up</button>
+</form>
+
+<!-- This entire form will be excluded from tracking -->
+<form id="login-form" data-prism-exclude-form>
+    <input type="text" name="username" placeholder="Username">
+    <input type="password" name="password" placeholder="Password">
+    <button type="submit">Login</button>
+</form>
+
+<!-- Override field labels for tracking -->
+<form id="contact-form">
+    <input type="text" name="name" data-prism-field-label="Patient Name" placeholder="Your Name">
+    <input type="email" name="email" data-prism-field-label="Patient Email" placeholder="Your Email">
+    <button type="submit">Submit</button>
+</form>
+```

package/package.json

@@ -2,7 +2,7 @@
   "name": "@patientprism/snippet-sdk",
   "type": "module",
   "types": "types/index.d.ts",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "scripts": {
     "test": "vitest run",
     "test:watch": "vitest watch",

package/package.json.backup

@@ -0,0 +1,26 @@
+{
+    "name": "@patientprism/snippet-sdk",
+    "type": "module",
+    "types": "types/index.d.ts",
+    "version": "1.1.0",
+    "scripts": {
+        "test": "vitest run",
+        "test:watch": "vitest watch",
+        "dev": "vite dev",
+        "build": "vite build",
+        "build:types": "sh ./build-type-declarations.sh"
+    },
+    "dependencies": {
+        "collect.js": "^4.36.1",
+        "js-cookie": "^3.0.5",
+        "jsdom": "^23.0.1",
+        "libphonenumber-js": "^1.10.51",
+        "vite": "^7.1.5",
+        "vitest": "^3.2.4",
+        "ziggy-js": "^2.5.0"
+    },
+    "devDependencies": {
+        "json": "^11.0.0",
+        "typescript": "^5.5.4"
+    }
+}

package/types/index.d.ts

@@ -1,3 +1,59 @@
+/**
+ * @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} 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.
+ */
+export default function handle(): void;
 export type SubmissionField = {
     type: string;
     value: string | number;
@@ -12,20 +68,33 @@ export type SwapSDK = {
     /**
      * Initializes the Swap functionality.
      */
-    init: () => void;
+    init: () => Promise<void>;
 };
 /**
  * Object containing methods related to Submission functionality.
  */
 export type SubmissionSDK = {
+    /**
+     * Indicates whether hidden fields should be captured in submissions.
+     */
+    captureHiddenFields: boolean;
     /**
      * Initialize the Submission functionality.
      */
-    init: () => void;
+    init: () => Promise<void>;
     /**
      * Send the form submission.
      */
-    send: (data: Submission, elementID: string | HTMLElement, options?: SubmissionOptions) => void;
+    send: (data: Submission, elementID: string | HTMLElement, options?: SubmissionOptions) => Promise<void>;
+};
+/**
+ * Object containing methods related to the Custom Field functionality.
+ */
+export type CustomFieldSDK = {
+    /**
+     * Recapture some or all of the custom fields.
+     */
+    recapture: (keys?: string | string[] | Set<string>) => Promise<void>;
 };
 /**
  * The global `$prism` object for managing Prism-related functionality.
@@ -51,6 +120,10 @@ export type PrismSDK = {
      * Object containing methods related to Submission functionality.
      */
     submission: SubmissionSDK;
+    /**
+     * Object containing methods related to the Custom Field functionality.
+     */
+    custom_fields: CustomFieldSDK;
 };
 
 declare global {