@patientprism/snippet-sdk 1.0.0 → 1.0.1

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.0.1",
   "scripts": {
     "test": "vitest run",
     "test:watch": "vitest watch",

package/types/index.d.ts

@@ -12,20 +12,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 +64,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 {