@builder.io/sdk-svelte 0.0.5 → 0.0.7

package/src/functions/track.ts

@@ -8,11 +8,30 @@ import { isEditing } from './is-editing.js';
 interface Event {
   type: 'click' | 'impression';
   data: {
+    /**
+     * (Optional) The content's ID. Useful if this event pertains to a specific piece of content.
+     */
     contentId?: string;
+    /**
+     * This is the ID of the space that the content belongs to.
+     */
     ownerId: string;
+    /**
+     * Stringified JSON object containing any additional metadata you want to track.
+     */
     metadata?: string;
+    /**
+     * Session ID of the user. This is provided by the SDK by checking session storage.
+     */
     sessionId: string | undefined;
+    /**
+     * Visitor ID of the user. This is provided by the SDK by checking cookies.
+     */
     visitorId: string | undefined;
+    /**
+     * (Optional) If running an A/B test, the ID of the variation that the user is in.
+     */
+    variationId?: string;
     [index: string]: any;
   };
 }
@@ -38,32 +57,44 @@ const getTrackingEventData = async ({
   };
 };
 
-type EventProperties = {
-  type: Event['type'];
-  orgId: Event['data']['ownerId'];
-  contentId: Event['data']['contentId'];
-  [index: string]: any;
-};
+type EventProperties = Pick<Event, 'type'> &
+  Pick<Event['data'], 'contentId' | 'variationId'> & {
+    /**
+     * Your organization's API key.
+     */
+    apiKey: Event['data']['ownerId'];
+    /**
+     * (Optional) metadata that you want to provide with your event.
+     */
+    metadata?: {
+      [index: string]: any;
+    };
+
+    /**
+     * (Optional) Any additional (non-metadata) properties to add to the event.
+     */
+    [index: string]: any;
+  };
 
 export type EventProps = EventProperties & CanTrack;
 
 const createEvent = async ({
   type: eventType,
   canTrack,
-  orgId,
-  contentId,
+  apiKey,
+  metadata,
   ...properties
 }: EventProps): Promise<Event> => ({
   type: eventType,
   data: {
     ...properties,
+    metadata: JSON.stringify(metadata),
     ...(await getTrackingEventData({ canTrack })),
-    ownerId: orgId,
-    contentId,
+    ownerId: apiKey,
   },
 });
 
-export async function track(eventProps: EventProps) {
+export async function _track(eventProps: EventProps) {
   if (!eventProps.canTrack) {
     return;
   }
@@ -88,3 +119,6 @@ export async function track(eventProps: EventProps) {
     console.error('Failed to track: ', err);
   });
 }
+
+export const track = (args: EventProperties) =>
+  _track({ ...args, canTrack: true });

package/src/index.ts

@@ -1,4 +1,4 @@
-import './index-helpers/top-of-file.js';
+export * from './index-helpers/top-of-file.js';
 import './scripts/init-editing.js';
 
 export * from './index-helpers/blocks-exports.js';
@@ -10,3 +10,6 @@ export * from './functions/register.js';
 export * from './functions/set-editor-settings.js';
 export * from './functions/get-content/index.js';
 export * from './functions/get-builder-search-params/index.js';
+export { track } from './functions/track';
+export type { RegisteredComponent } from './context/types';
+export type { ComponentInfo } from './types/components';

package/src/scripts/init-editing.ts

@@ -23,7 +23,12 @@ export const registerInsertMenu = () => {
   });
 };
 
+let isSetupForEditing = false;
 export const setupBrowserForEditing = () => {
+  if (isSetupForEditing) {
+    return;
+  }
+  isSetupForEditing = true;
   if (isBrowser()) {
     window.parent?.postMessage(
       {
@@ -37,6 +42,7 @@ export const setupBrowserForEditing = () => {
           // Supports builder-model="..." attribute which is needed to
           // scope our '+ add block' button styling
           supportsAddBlockScoping: true,
+          supportsCustomBreakpoints: true,
         },
       },
       '*'

package/src/types/builder-content.ts

@@ -17,6 +17,13 @@ export interface BuilderContentVariation {
   name?: string;
   testRatio?: number;
   id?: string;
+  meta?: {
+    breakpoints?: {
+      small: number;
+      medium: number;
+    };
+    [key: string]: any;
+  };
 }
 
 // TODO: separate full and partial versions