saasco-sdk 0.2.3 → 0.2.5

package/dist/index.d.cts

@@ -259,8 +259,8 @@ declare global {
         saascoAutoPageTrackingActive?: boolean;
         saasco: Saasco;
         saascoLastIdentifyKey?: string;
-        /** Set once the lazy-loaded support-chat script has been injected. */
-        __saascoSupportChatInjected?: boolean;
+        /** Set once the lazy-loaded support script has been injected. */
+        __saascoSupportInjected?: boolean;
         /** Set once the lazy-loaded social-proof loader script has been injected. */
         __saascoSocialProofInjected?: boolean;
     }
@@ -287,25 +287,30 @@ type DoRequestResponse = {
 };
 type IntegrationsConfig = (FacebookPixelIntegrationConfig | PinterestTagIntegrationConfig | TikTokPixelIntegrationConfig)[];
 /**
- * Opt-in config for the support chat widget, set on the `Saasco` constructor.
- * The widget is a cross-origin iframe loaded by a lean host-page loader
- * (`saasco-support-chat-loader.js`); no React ships in this analytics entry,
- * which stays React-free by lazily injecting the loader rather than importing
- * it. Providing this object opts in; pass `enabled: false` to keep it off (e.g.
- * behind your own runtime flag). The projectId is shared from the analytics
- * config — you never declare it twice.
+ * Optional config for the support widget. Support is **always available
+ * wherever the analytics SDK runs** — you don't need to pass this object at
+ * all. Whether the widget actually renders is decided **server-side**: on init
+ * the SDK runs a cheap `{ enabled }` check and lazily injects the lean loader
+ * (`saasco-support-loader.js`) only when the project has the widget enabled
+ * in the dashboard, so pages where it's off never download it — and the
+ * dashboard toggle controls every install (CDN and npm) uniformly.
+ *
+ * The loader origin is resolved automatically: the CDN `<script>` origin for
+ * CDN installs, else the public Saasco CDN for npm/bundled installs. Pass this
+ * object only to override those defaults: `baseUrl`/`scriptUrl` point a
+ * same-origin, proxied, or self-hosted install at the right origin.
+ * The projectId is shared from the analytics config — you never declare it
+ * twice.
  */
-type SupportChatInit = {
-    /** Defaults to `true` when the `supportChat` object is provided. */
-    enabled?: boolean;
-    /** Origin of the saasco app hosting the support-chat API. Defaults server-side to where the widget bundle is served from. */
+type SupportInit = {
+    /** Origin of the saasco app hosting the support API. Defaults server-side to where the widget bundle is served from. */
     baseUrl?: string;
     /** Input placeholder for the chat composer. */
     placeholder?: string;
     /**
      * URL the loader is loaded from. Accepts either the analytics
      * `saasco-sdk.js` URL (the loader URL is derived from it) or the
-     * `saasco-support-chat-loader.js` URL directly. Defaults to deriving from the
+     * `saasco-support-loader.js` URL directly. Defaults to deriving from the
      * loaded analytics `<script>` tag, so CDN installs can omit it.
      */
     scriptUrl?: string;
@@ -323,19 +328,11 @@ type SupportChatInit = {
  * The loader + widget-payload origin is resolved automatically: the CDN
  * `<script>` origin for CDN installs, else the public Saasco CDN for
  * npm/bundled installs (which carry no script tag on the page). Pass this object
- * only to override those defaults or to opt out: `enabled: false` (or
- * `data-social-proof-enabled="false"` on the CDN tag) is a client kill-switch
- * that skips the check entirely; `baseUrl`/`scriptUrl` point a same-origin,
+ * only to override those defaults: `baseUrl`/`scriptUrl` point a same-origin,
  * proxied, or self-hosted install at the right origin. The projectId is shared
  * from the analytics config — you never declare it twice.
  */
 type SocialProofInit = {
-    /**
-     * Client kill-switch. Defaults to `true`. When `false`, the SDK skips the
-     * server check and never injects the loader, regardless of the dashboard
-     * setting.
-     */
-    enabled?: boolean;
     /**
      * Origin of the saasco app hosting the social-proof widget-payload API.
      * Defaults to the loader bundle's origin — the CDN `<script>` origin for CDN
@@ -356,13 +353,13 @@ declare class Saasco {
     private isInitialized;
     private integrationManager;
     private logger;
-    private lastSupportChatIdentity;
+    private lastSupportIdentity;
     /**
      * Creates an instance of the Saasco SDK.
      * @param config Configuration options.
      * @param config.projectId The unique identifier for the project.
      * @param config.proxy The URL of the proxy server to use, if any.
-     * @param config.autoPageTracking Whether to automatically track page views. Default is false.
+     * @param config.autoPageTracking Whether to automatically track page views. Default is true.
      * @param config.enabled Whether analytics is enabled. Default is true. Set to false for development and staging envioronments. Will still allow debug mode to be true, just no events will be sent
      * @param config.debug Whether to log debug information. Default is false.
      * @param config.trackUrlParams Whether to track URL parameters. Default is true.
@@ -381,26 +378,12 @@ declare class Saasco {
         debug?: boolean;
         debugVerbose?: boolean;
         integrations?: IntegrationsConfig;
-        supportChat?: SupportChatInit;
+        support?: SupportInit;
         socialProof?: SocialProofInit;
     });
     init(): void;
     disableDebug(): void;
     enableDebug(): void;
-    /**
-     * Enables and injects the support chat widget when it was constructed with
-     * `supportChat: { enabled: false }`. Safe to call multiple times.
-     */
-    enableSupportChat(): void;
-    /**
-     * Enables and injects the social-proof widget (e.g. after constructing with
-     * `socialProof: { enabled: false }`, or when no `socialProof` block was
-     * passed). Injection still runs the server check, so the loader only
-     * downloads when the project has the app enabled in the dashboard.
-     * Safe to call multiple times — the loader injection is guarded against
-     * double-injection.
-     */
-    enableSocialProof(): void;
     /**
      * Initialize third-party integrations
      */
@@ -414,7 +397,7 @@ declare class Saasco {
     track(payload: TrackPayload): Promise<DoRequestResponse>;
     /**
      * The page method lets you record page views on your website
-     * This records the page title and path and names the event useing the reserved property "Page Viewed"
+     * This records the page title and path and names the event using the reserved name "Page View"
      *
      * Before implementing this make sure you have disabled the autoPageTracking in the config or you will get duplicate page views
      */
@@ -465,33 +448,38 @@ declare class Saasco {
         readyCount: number;
     };
     /**
-     * Lazily injects the support-chat **loader** from the same `/sdk/` origin as
-     * the analytics bundle, forwarding the shared `projectId` and the widget
-     * config as `data-*` attributes. The loader (no React) injects the
-     * cross-origin embed iframe. Deferred (`async`) and guarded against
-     * double-injection so re-running `init()` is a no-op.
+     * Lazily injects the support **loader** (server-gated). See
+     * {@link injectSupportLoader}. Replays identity once the script loads.
      */
-    private injectSupportChat;
+    private injectSupport;
     /**
      * Lazily injects the social-proof loader (server-gated). See
      * {@link injectSocialProofLoader}.
      */
     private injectSocialProof;
     /**
-     * Records the latest CRM identity and forwards it to the support-chat widget.
-     * No-op when support chat isn't enabled.
+     * Records the latest CRM identity and forwards it to the support widget.
      */
-    private updateSupportChatIdentity;
+    private updateSupportIdentity;
     /**
-     * Pushes the current identity onto `window.SaascoSupportChat.identify`. The
+     * Pushes the current identity onto `window.SaascoSupport.identify`. The
      * widget bundle publishes that global asynchronously, so this short-polls for
-     * it (same approach as tool registration); the load handler also calls this,
-     * so a fresh page load with a stored distinctId still identifies the chat.
+     * it (same approach as tool registration). `injectSupport` calls this on
+     * script load (or immediately when the loader is already present).
      */
-    private pushSupportChatIdentity;
+    private pushSupportIdentity;
 }
 
-declare const browserContextSchema: z.ZodObject<{
+/**
+ * Browser-collected context attached to track payloads by `getBrowserContext()`.
+ *
+ * Defined here rather than in `libs/analytics/sdk` because server and worker
+ * code validates it too. The SDK re-exports it, so `saasco-sdk`'s public API is
+ * unchanged — but a shared module importing the SDK barrel would drag the whole
+ * DOM-dependent bundle into every consumer's program, including the Cloudflare
+ * Worker, which has no DOM lib.
+ */
+declare const BrowserContextSchema: z.ZodObject<{
     $href: z.ZodString;
     $locale: z.ZodString;
     $location: z.ZodString;
@@ -516,11 +504,11 @@ declare const browserContextSchema: z.ZodObject<{
     $utmSourcePlatform: z.ZodNullable<z.ZodString>;
     $utmTerm: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
-type BrowserContext = z.infer<typeof browserContextSchema>;
+type BrowserContext = z.infer<typeof BrowserContextSchema>;
 type SuperContext = Record<string, unknown>;
 
 declare function getBrowserContext(): BrowserContext;
 
 declare const timezones: Record<string, string>;
 
-export { type AnalyticsContext, type BrowserContext, type EventEnvelope, type EventType, type FacebookEventMapping, type FacebookPixelConfig, type FacebookPixelIntegrationConfig, type Integration, type IntegrationConfigBase, type IntegrationEnvironment, IntegrationManager, type IntegrationState, type IntegrationStatus, type IntegrationsConfig, type ManagerConfig, type PinterestEventMapping, type PinterestTagConfig, type PinterestTagIntegrationConfig, Saasco, type SocialProofInit, type StandardFacebookEvent, type StandardPinterestEvent, type StandardTikTokEvent, type SuperContext, type SupportChatInit, type TikTokEventMapping, type TikTokPixelConfig, type TikTokPixelIntegrationConfig, browserContextSchema, createFacebookPixelIntegration, createPinterestTagIntegration, createTikTokPixelIntegration, getBrowserContext, standardFacebookEvents, standardPinterestEvents, standardTikTokEvents, timezones };
+export { type AnalyticsContext, type BrowserContext, BrowserContextSchema, type EventEnvelope, type EventType, type FacebookEventMapping, type FacebookPixelConfig, type FacebookPixelIntegrationConfig, type Integration, type IntegrationConfigBase, type IntegrationEnvironment, IntegrationManager, type IntegrationState, type IntegrationStatus, type IntegrationsConfig, type ManagerConfig, type PinterestEventMapping, type PinterestTagConfig, type PinterestTagIntegrationConfig, Saasco, type SocialProofInit, type StandardFacebookEvent, type StandardPinterestEvent, type StandardTikTokEvent, type SuperContext, type SupportInit, type TikTokEventMapping, type TikTokPixelConfig, type TikTokPixelIntegrationConfig, createFacebookPixelIntegration, createPinterestTagIntegration, createTikTokPixelIntegration, getBrowserContext, standardFacebookEvents, standardPinterestEvents, standardTikTokEvents, timezones };

package/dist/index.d.ts

@@ -259,8 +259,8 @@ declare global {
         saascoAutoPageTrackingActive?: boolean;
         saasco: Saasco;
         saascoLastIdentifyKey?: string;
-        /** Set once the lazy-loaded support-chat script has been injected. */
-        __saascoSupportChatInjected?: boolean;
+        /** Set once the lazy-loaded support script has been injected. */
+        __saascoSupportInjected?: boolean;
         /** Set once the lazy-loaded social-proof loader script has been injected. */
         __saascoSocialProofInjected?: boolean;
     }
@@ -287,25 +287,30 @@ type DoRequestResponse = {
 };
 type IntegrationsConfig = (FacebookPixelIntegrationConfig | PinterestTagIntegrationConfig | TikTokPixelIntegrationConfig)[];
 /**
- * Opt-in config for the support chat widget, set on the `Saasco` constructor.
- * The widget is a cross-origin iframe loaded by a lean host-page loader
- * (`saasco-support-chat-loader.js`); no React ships in this analytics entry,
- * which stays React-free by lazily injecting the loader rather than importing
- * it. Providing this object opts in; pass `enabled: false` to keep it off (e.g.
- * behind your own runtime flag). The projectId is shared from the analytics
- * config — you never declare it twice.
+ * Optional config for the support widget. Support is **always available
+ * wherever the analytics SDK runs** — you don't need to pass this object at
+ * all. Whether the widget actually renders is decided **server-side**: on init
+ * the SDK runs a cheap `{ enabled }` check and lazily injects the lean loader
+ * (`saasco-support-loader.js`) only when the project has the widget enabled
+ * in the dashboard, so pages where it's off never download it — and the
+ * dashboard toggle controls every install (CDN and npm) uniformly.
+ *
+ * The loader origin is resolved automatically: the CDN `<script>` origin for
+ * CDN installs, else the public Saasco CDN for npm/bundled installs. Pass this
+ * object only to override those defaults: `baseUrl`/`scriptUrl` point a
+ * same-origin, proxied, or self-hosted install at the right origin.
+ * The projectId is shared from the analytics config — you never declare it
+ * twice.
  */
-type SupportChatInit = {
-    /** Defaults to `true` when the `supportChat` object is provided. */
-    enabled?: boolean;
-    /** Origin of the saasco app hosting the support-chat API. Defaults server-side to where the widget bundle is served from. */
+type SupportInit = {
+    /** Origin of the saasco app hosting the support API. Defaults server-side to where the widget bundle is served from. */
     baseUrl?: string;
     /** Input placeholder for the chat composer. */
     placeholder?: string;
     /**
      * URL the loader is loaded from. Accepts either the analytics
      * `saasco-sdk.js` URL (the loader URL is derived from it) or the
-     * `saasco-support-chat-loader.js` URL directly. Defaults to deriving from the
+     * `saasco-support-loader.js` URL directly. Defaults to deriving from the
      * loaded analytics `<script>` tag, so CDN installs can omit it.
      */
     scriptUrl?: string;
@@ -323,19 +328,11 @@ type SupportChatInit = {
  * The loader + widget-payload origin is resolved automatically: the CDN
  * `<script>` origin for CDN installs, else the public Saasco CDN for
  * npm/bundled installs (which carry no script tag on the page). Pass this object
- * only to override those defaults or to opt out: `enabled: false` (or
- * `data-social-proof-enabled="false"` on the CDN tag) is a client kill-switch
- * that skips the check entirely; `baseUrl`/`scriptUrl` point a same-origin,
+ * only to override those defaults: `baseUrl`/`scriptUrl` point a same-origin,
  * proxied, or self-hosted install at the right origin. The projectId is shared
  * from the analytics config — you never declare it twice.
  */
 type SocialProofInit = {
-    /**
-     * Client kill-switch. Defaults to `true`. When `false`, the SDK skips the
-     * server check and never injects the loader, regardless of the dashboard
-     * setting.
-     */
-    enabled?: boolean;
     /**
      * Origin of the saasco app hosting the social-proof widget-payload API.
      * Defaults to the loader bundle's origin — the CDN `<script>` origin for CDN
@@ -356,13 +353,13 @@ declare class Saasco {
     private isInitialized;
     private integrationManager;
     private logger;
-    private lastSupportChatIdentity;
+    private lastSupportIdentity;
     /**
      * Creates an instance of the Saasco SDK.
      * @param config Configuration options.
      * @param config.projectId The unique identifier for the project.
      * @param config.proxy The URL of the proxy server to use, if any.
-     * @param config.autoPageTracking Whether to automatically track page views. Default is false.
+     * @param config.autoPageTracking Whether to automatically track page views. Default is true.
      * @param config.enabled Whether analytics is enabled. Default is true. Set to false for development and staging envioronments. Will still allow debug mode to be true, just no events will be sent
      * @param config.debug Whether to log debug information. Default is false.
      * @param config.trackUrlParams Whether to track URL parameters. Default is true.
@@ -381,26 +378,12 @@ declare class Saasco {
         debug?: boolean;
         debugVerbose?: boolean;
         integrations?: IntegrationsConfig;
-        supportChat?: SupportChatInit;
+        support?: SupportInit;
         socialProof?: SocialProofInit;
     });
     init(): void;
     disableDebug(): void;
     enableDebug(): void;
-    /**
-     * Enables and injects the support chat widget when it was constructed with
-     * `supportChat: { enabled: false }`. Safe to call multiple times.
-     */
-    enableSupportChat(): void;
-    /**
-     * Enables and injects the social-proof widget (e.g. after constructing with
-     * `socialProof: { enabled: false }`, or when no `socialProof` block was
-     * passed). Injection still runs the server check, so the loader only
-     * downloads when the project has the app enabled in the dashboard.
-     * Safe to call multiple times — the loader injection is guarded against
-     * double-injection.
-     */
-    enableSocialProof(): void;
     /**
      * Initialize third-party integrations
      */
@@ -414,7 +397,7 @@ declare class Saasco {
     track(payload: TrackPayload): Promise<DoRequestResponse>;
     /**
      * The page method lets you record page views on your website
-     * This records the page title and path and names the event useing the reserved property "Page Viewed"
+     * This records the page title and path and names the event using the reserved name "Page View"
      *
      * Before implementing this make sure you have disabled the autoPageTracking in the config or you will get duplicate page views
      */
@@ -465,33 +448,38 @@ declare class Saasco {
         readyCount: number;
     };
     /**
-     * Lazily injects the support-chat **loader** from the same `/sdk/` origin as
-     * the analytics bundle, forwarding the shared `projectId` and the widget
-     * config as `data-*` attributes. The loader (no React) injects the
-     * cross-origin embed iframe. Deferred (`async`) and guarded against
-     * double-injection so re-running `init()` is a no-op.
+     * Lazily injects the support **loader** (server-gated). See
+     * {@link injectSupportLoader}. Replays identity once the script loads.
      */
-    private injectSupportChat;
+    private injectSupport;
     /**
      * Lazily injects the social-proof loader (server-gated). See
      * {@link injectSocialProofLoader}.
      */
     private injectSocialProof;
     /**
-     * Records the latest CRM identity and forwards it to the support-chat widget.
-     * No-op when support chat isn't enabled.
+     * Records the latest CRM identity and forwards it to the support widget.
      */
-    private updateSupportChatIdentity;
+    private updateSupportIdentity;
     /**
-     * Pushes the current identity onto `window.SaascoSupportChat.identify`. The
+     * Pushes the current identity onto `window.SaascoSupport.identify`. The
      * widget bundle publishes that global asynchronously, so this short-polls for
-     * it (same approach as tool registration); the load handler also calls this,
-     * so a fresh page load with a stored distinctId still identifies the chat.
+     * it (same approach as tool registration). `injectSupport` calls this on
+     * script load (or immediately when the loader is already present).
      */
-    private pushSupportChatIdentity;
+    private pushSupportIdentity;
 }
 
-declare const browserContextSchema: z.ZodObject<{
+/**
+ * Browser-collected context attached to track payloads by `getBrowserContext()`.
+ *
+ * Defined here rather than in `libs/analytics/sdk` because server and worker
+ * code validates it too. The SDK re-exports it, so `saasco-sdk`'s public API is
+ * unchanged — but a shared module importing the SDK barrel would drag the whole
+ * DOM-dependent bundle into every consumer's program, including the Cloudflare
+ * Worker, which has no DOM lib.
+ */
+declare const BrowserContextSchema: z.ZodObject<{
     $href: z.ZodString;
     $locale: z.ZodString;
     $location: z.ZodString;
@@ -516,11 +504,11 @@ declare const browserContextSchema: z.ZodObject<{
     $utmSourcePlatform: z.ZodNullable<z.ZodString>;
     $utmTerm: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
-type BrowserContext = z.infer<typeof browserContextSchema>;
+type BrowserContext = z.infer<typeof BrowserContextSchema>;
 type SuperContext = Record<string, unknown>;
 
 declare function getBrowserContext(): BrowserContext;
 
 declare const timezones: Record<string, string>;
 
-export { type AnalyticsContext, type BrowserContext, type EventEnvelope, type EventType, type FacebookEventMapping, type FacebookPixelConfig, type FacebookPixelIntegrationConfig, type Integration, type IntegrationConfigBase, type IntegrationEnvironment, IntegrationManager, type IntegrationState, type IntegrationStatus, type IntegrationsConfig, type ManagerConfig, type PinterestEventMapping, type PinterestTagConfig, type PinterestTagIntegrationConfig, Saasco, type SocialProofInit, type StandardFacebookEvent, type StandardPinterestEvent, type StandardTikTokEvent, type SuperContext, type SupportChatInit, type TikTokEventMapping, type TikTokPixelConfig, type TikTokPixelIntegrationConfig, browserContextSchema, createFacebookPixelIntegration, createPinterestTagIntegration, createTikTokPixelIntegration, getBrowserContext, standardFacebookEvents, standardPinterestEvents, standardTikTokEvents, timezones };
+export { type AnalyticsContext, type BrowserContext, BrowserContextSchema, type EventEnvelope, type EventType, type FacebookEventMapping, type FacebookPixelConfig, type FacebookPixelIntegrationConfig, type Integration, type IntegrationConfigBase, type IntegrationEnvironment, IntegrationManager, type IntegrationState, type IntegrationStatus, type IntegrationsConfig, type ManagerConfig, type PinterestEventMapping, type PinterestTagConfig, type PinterestTagIntegrationConfig, Saasco, type SocialProofInit, type StandardFacebookEvent, type StandardPinterestEvent, type StandardTikTokEvent, type SuperContext, type SupportInit, type TikTokEventMapping, type TikTokPixelConfig, type TikTokPixelIntegrationConfig, createFacebookPixelIntegration, createPinterestTagIntegration, createTikTokPixelIntegration, getBrowserContext, standardFacebookEvents, standardPinterestEvents, standardTikTokEvents, timezones };