@jam.dev/recording-links 0.1.0 → 0.1.3

package/README.md

@@ -56,6 +56,7 @@ jam.initialize(); // Automatically loads recorder and opens recording "abc123"
 jam.initialize({
   teamId: "team-123,team-456", // Manually provide team ID(s); default: reads `<meta name="jam:team">` from the page
   openImmediately: false, // Don't auto-open recorder from URL params
+  //           OR: "recording-123" to auto-open a recording by ID
   parseJamData: (href) => {
     // Custom logic to extract recording data from URL
     const url = new URL(href);
@@ -93,7 +94,7 @@ Initializes the SDK with optional configuration.
 
 **Parameters:**
 - `options.teamId?: string` - Team ID for recording validation
-- `options.openImmediately?: boolean` - Whether to auto-open from URL (default: `true`)
+- `options.openImmediately?: boolean | string` - Whether to auto-open from URL (default: `true`), or a recording ID string to open immediately
 - `options.parseJamData?: (input: string) => SerializableJamData | null` - Custom URL parser
 - `options.applyJamData?: (data: SerializableJamData) => string` - Custom URL applier
 - `options.recorderRefCounter?: RefCounter` - Custom reference counter (advanced)
@@ -106,8 +107,7 @@ Initializes the SDK with optional configuration.
 Loads the Jam recorder module and returns a promise that resolves to the recorder interface.
 
 **Parameters:**
-- `options.recordingId?: string` - Recording ID to open immediately
-- Plus all options from `InitializeOptions`
+- `Omit<InitializeOptions, "recorderRefCounter">`
 
 **Returns:**
 - `Promise<RecorderSingleton>` - The Recorder singleton
@@ -115,6 +115,13 @@ Loads the Jam recorder module and returns a promise that resolves to the recorde
 **Throws:**
 - Error if SDK is not initialized
 
+### `isInitialized()`
+
+Returns whether the SDK has been initialized.
+
+**Returns:**
+- `boolean` - True if the SDK has been initialized, false otherwise
+
 ### `addEventListener(type, listener, options?)`
 
 Add an event listener for SDK events.
@@ -159,7 +166,7 @@ type SerializableJamData = {
 ```typescript
 type InitializeOptions = {
   teamId?: string;
-  openImmediately?: boolean;
+  openImmediately?: boolean | string | undefined | null;
   parseJamData?(input: string): SerializableJamData | null;
   applyJamData?(data: SerializableJamData): string;
   recorderRefCounter?: RefCounter;

package/lib/sdk.d.ts

@@ -48,9 +48,11 @@ type InitializeOptions = {
     teamId?: string;
     /**
      * Whether to open the JamRecorder immediately on initialization.
+     * May be provided a recording ID as a string, in which case we will open it.
+     * If the value resolves to `undefined` or `null`, we will default to `true`.
      * Default: `true`
      */
-    openImmediately?: boolean;
+    openImmediately?: boolean | string | undefined | null;
     /**
      * Extract a `recordingId` and `jamTitle` from the provided string.
      * Defaults to reading the `jam-recording` and `jam-title` QSPs off the URL.
@@ -86,6 +88,8 @@ export declare const addEventListener: <K extends "loaded">(type: K, listener: (
  * @param options - Optional event listener configuration
  */
 export declare const removeEventListener: <K extends "loaded">(type: K, listener: (event: CustomEvent<Events[K]>) => void, options?: boolean | AddEventListenerOptions) => void;
+/** Whether the SDK has been initialized. */
+export declare const isInitialized: () => false;
 /**
  * The loaded Recorder singleton instance. Will be null until loadRecorder() is called successfully.
  */
@@ -101,6 +105,7 @@ export declare let Recorder: RecorderSingleton | null;
  * @param options.recorderRefCounter - Custom reference counter for managing recorder instances across tabs
  * @param options.teamId - Team ID for validating recording IDs
  * @param options.openImmediately - Whether to automatically open recorder from URL parameters (default: true)
+ *                                  Can be set to a specific recording ID as a string to open that recording.
  * @param options.parseJamData - Custom function to extract recording data from URLs
  * @param options.applyJamData - Custom function to apply recording data to URLs
  *
@@ -114,7 +119,7 @@ export declare let Recorder: RecorderSingleton | null;
  * // Custom configuration
  * jam.initialize({
  *   teamId: "team-123",
- *   openImmediately: false
+ *   openImmediately: false // or "abc-123" to open a specific recording
  * });
  * ```
  */
@@ -127,9 +132,9 @@ export declare function initialize({ recorderRefCounter, ...config }?: Initializ
  * for cross-tab coordination.
  *
  * @param options - Configuration options for loading the recorder
- * @param options.recordingId - Optional recording ID to open immediately after loading
  * @param options.teamId - Team ID for validating recording IDs
  * @param options.openImmediately - Whether to automatically open the recorder (default: true)
+ *                                  Can be set to a specific recording ID as a string to open that recording.
  * @param options.parseJamData - Custom function to extract recording data from URLs
  * @param options.applyJamData - Custom function to apply recording data to URLs
  *
@@ -145,18 +150,13 @@ export declare function initialize({ recorderRefCounter, ...config }?: Initializ
  *
  * // Load recorder and open a specific recording
  * const recorder = await jam.loadRecorder({
- *   recordingId: "recording-abc123"
+ *   openImmediately: false, // or "recording-abc123"
  * });
  *
  * // Use the recorder
  * recorder.open("recording-xyz789", { jamTitle: "Bug Report" });
  * ```
  */
-export declare function loadRecorder({ recordingId, ...config }?: Omit<InitializeOptions, "recorderRefCounter"> & {
-    /**
-     * An optional recording ID; if provided, a recorder will to open the recorder with.
-     */
-    recordingId?: string | null;
-}): Promise<RecorderSingleton>;
+export declare function loadRecorder({ ...config }?: Omit<InitializeOptions, "recorderRefCounter">): Promise<RecorderSingleton>;
 export {};
 //# sourceMappingURL=sdk.d.ts.map

package/lib/sdk.js

@@ -1,5 +1,5 @@
-function e(){const e=new EventTarget;return{addEventListener(r,t,n){e.addEventListener(r,t,n)},removeEventListener(r,t,n){e.removeEventListener(r,t,n)},dispatch:(r,t)=>e.dispatchEvent(new CustomEvent(r,{detail:t}))}}const r=r=>{const t=`jam:${r}`,n=e();let i=Number.parseInt(localStorage.getItem(t)??"0",10)||0;return window.addEventListener("storage",e=>{if(e.storageArea===localStorage&&e.key===t){const r=Number.parseInt(e.newValue??"",10);Number.isNaN(r)||r===i||(i=r,n.dispatch("update",i))}}),{count:i,addEventListener:n.addEventListener.bind(n),removeEventListener:n.removeEventListener.bind(n),update(e){const r=i;switch(e){case"increment":i+=1;break;case"decrement":i-=1;break;default:i=e}return i<0&&(i=0),i!==r&&(localStorage.setItem(t,`${i}`),n.dispatch("update",i)),i}}},t=e=>{try{const r=new URL(e);return{recordingId:r.searchParams.get("jam-recording"),jamTitle:r.searchParams.get("jam-title")}}catch(e){}return null},n={isInitialized:!1},i=e(),a=i.addEventListener.bind(i),d=i.removeEventListener.bind(i);let o=null;function c({recorderRefCounter:e=r("numRecorders"),...i}={}){if(n.isInitialized)throw new Error("SDK already initialized.");Object.assign(n,{isInitialized:!0,recorderRefCounter:e,config:i}),e.count>0?u("capture"):e.addEventListener("update",()=>u("capture"),{once:!0});const a=i?.parseJamData??t,d=a(window.location.href)?.recordingId;d&&s({recordingId:d})}async function s({recordingId:e,...r}={}){if(o)return o;if(!n.isInitialized)throw new Error("SDK not initialized. Call initialize() first.");if(({Recorder:o}=await u("recorder")),!o)throw new Error("Failed to load recorder script.");const{openImmediately:t,...i}={...n.config,...r};return o.initialize({...i,openImmediately:!e&&t}),n.recorderRefCounter.update("increment"),window.addEventListener("pagehide",()=>{n.recorderRefCounter.update("decrement")}),e&&!1!==t&&o.open(e,i),o}async function u(e){const r=`https://js.jam.dev/${e}.js`,t=await import(
+function e(){const e=new EventTarget;return{addEventListener(t,r,n){e.addEventListener(t,r,n)},removeEventListener(t,r,n){e.removeEventListener(t,r,n)},dispatch:(t,r)=>e.dispatchEvent(new CustomEvent(t,{detail:r}))}}const t=t=>{const r=`jam:${t}`,n=e();let i=Number.parseInt(localStorage.getItem(r)??"0",10)||0;return window.addEventListener("storage",e=>{if(e.storageArea===localStorage&&e.key===r){const t=Number.parseInt(e.newValue??"",10);Number.isNaN(t)||t===i||(i=t,n.dispatch("update",i))}}),{count:i,addEventListener:n.addEventListener.bind(n),removeEventListener:n.removeEventListener.bind(n),update(e){const t=i;switch(e){case"increment":i+=1;break;case"decrement":i-=1;break;default:i=e}return i<0&&(i=0),i!==t&&(localStorage.setItem(r,`${i}`),n.dispatch("update",i)),i}}},r=e=>{try{const t=new URL(e);return{recordingId:t.searchParams.get("jam-recording"),jamTitle:t.searchParams.get("jam-title")}}catch(e){}return null},n={isInitialized:!1},i=e(),a=i.addEventListener.bind(i),o=i.removeEventListener.bind(i),d=()=>n.isInitialized;let c=null;function s({recorderRefCounter:e=t("numRecorders"),...i}={}){if(n.isInitialized)throw new Error("SDK already initialized.");Object.assign(n,{isInitialized:!0,recorderRefCounter:e,config:i}),e.count>0?p("capture"):e.addEventListener("update",()=>p("capture"),{once:!0}),window.addEventListener("popstate",o);const a={apply(e,t,r){const n=Reflect.apply(e,t,r);return o(),n}};function o(){if(c)return;const e=n.config?.parseJamData??r,t="string"==typeof n.config?.openImmediately?n.config.openImmediately:e(window.location.href)?.recordingId;t&&l({openImmediately:!1!==n.config?.openImmediately&&t})}history.pushState=new Proxy(history.pushState,a),history.replaceState=new Proxy(history.replaceState,a),o()}async function l({...e}={}){if(c)return c;if(!n.isInitialized)throw new Error("SDK not initialized. Call initialize() first.");if(({Recorder:c}=await p("recorder")),!c)throw new Error("Failed to load recorder script.");const{openImmediately:t,...r}={...n.config,...e},i="string"==typeof t?t:null;return c.initialize({...r,openImmediately:!i&&(t??!0)}),n.recorderRefCounter.update("increment"),window.addEventListener("pagehide",()=>{n.recorderRefCounter.update("decrement")}),i&&c.open(i,r),c}async function p(e){const t=`https://js.jam.dev/${e}.js`,r=await import(
 /* webpackIgnore: true */
 /* @vite-ignore */
 /* @rollup/plugin-dynamic-import-vars ignore */
-r);if("recorder"===e){if(!t.Recorder)throw new Error("Loaded recorder script, but Recorder not found.");i.dispatch("loaded",{type:"script",name:e,Recorder:t.Recorder})}else i.dispatch("loaded",{type:"script",name:e});return t}export{o as Recorder,a as addEventListener,c as initialize,s as loadRecorder,d as removeEventListener};//# sourceMappingURL=sdk.js.map
+t);if("recorder"===e){if(!r.Recorder)throw new Error("Loaded recorder script, but Recorder not found.");i.dispatch("loaded",{type:"script",name:e,Recorder:r.Recorder})}else i.dispatch("loaded",{type:"script",name:e});return r}export{c as Recorder,a as addEventListener,s as initialize,d as isInitialized,l as loadRecorder,o as removeEventListener};//# sourceMappingURL=sdk.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jam.dev/recording-links",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "Capture bug reports from your users with the Jam recording links SDK",
   "keywords": [
     "jam",
@@ -25,6 +25,10 @@
     "./sdk": {
       "types": "./lib/sdk.d.ts",
       "import": "./lib/sdk.js"
+    },
+    "./lib/sdk": {
+      "types": "./lib/sdk.d.ts",
+      "import": "./lib/sdk.js"
     }
   },
   "files": [