@stackable-labs/sdk-extension-contracts 1.75.0 → 1.76.0

package/dist/index.d.ts

@@ -330,8 +330,15 @@ type AllowedIconName = (typeof ALLOWED_ICONS)[number];
  * Types for the identity/auth event system.
  */
 
-/** Domain-stripped identity event names. Hooks accept these directly (e.g., useIdentityEvent('login', ...)). */
-type IdentityEventType = 'login' | 'logout' | 'refresh' | 'expired';
+/** Well-known identity event names. Hooks accept these directly (e.g., useIdentityEvent('login', ...)). */
+declare const IDENTITY_EVENTS: {
+    readonly LOGIN: "login";
+    readonly LOGOUT: "logout";
+    readonly REFRESH: "refresh";
+    readonly EXPIRED: "expired";
+};
+/** Domain-stripped identity event names — derived from IDENTITY_EVENTS. */
+type IdentityEventType = typeof IDENTITY_EVENTS[keyof typeof IDENTITY_EVENTS];
 interface UserIdentity {
     id: string;
     email?: string;
@@ -422,7 +429,12 @@ interface ConversationField {
     value: string | number | boolean;
 }
 /** Known actions for actions.invoke capability */
-type InvokeAction = 'newConversation' | 'setConversationTags' | 'setConversationFields' | MessengerCommand | WidgetAction;
+declare const INVOKE_ACTIONS: {
+    readonly NEW_CONVERSATION: "newConversation";
+    readonly SET_CONVERSATION_TAGS: "setConversationTags";
+    readonly SET_CONVERSATION_FIELDS: "setConversationFields";
+};
+type InvokeAction = typeof INVOKE_ACTIONS[keyof typeof INVOKE_ACTIONS] | MessengerCommand | WidgetAction;
 /** Typed payload for newConversation action */
 interface NewConversationPayload {
     metadata?: Record<string, unknown>;
@@ -513,7 +525,16 @@ type MessagingEventHandler = (event: MessagingEvent) => void;
  * Types for the activity event system (host-to-extension push events).
  */
 /** Well-known activity event names (aligned with GA conventions). Hosts can emit any custom string. */
-type WellKnownActivityEvent = 'click' | 'page_view' | 'form_submit' | 'product_view' | 'add_to_cart' | 'purchase' | 'search';
+declare const ACTIVITY_EVENTS: {
+    readonly CLICK: "click";
+    readonly PAGE_VIEW: "page_view";
+    readonly FORM_SUBMIT: "form_submit";
+    readonly PRODUCT_VIEW: "product_view";
+    readonly ADD_TO_CART: "add_to_cart";
+    readonly PURCHASE: "purchase";
+    readonly SEARCH: "search";
+};
+type WellKnownActivityEvent = typeof ACTIVITY_EVENTS[keyof typeof ACTIVITY_EVENTS];
 /** Domain-stripped activity event names. Hooks accept these directly (e.g., useActivityEvent('product_view', ...)). */
 type ActivityEventType = WellKnownActivityEvent | string;
 /** Normalized activity event payload */
@@ -596,6 +617,14 @@ type Capability = keyof typeof CAPABILITY_PERMISSION_MAP;
  * Apps define which targets they expose; this is not a fixed list.
  */
 type Target = string;
+/** Well-known surface target slots provided by the Stackable platform. */
+declare const SURFACE_TARGETS: {
+    readonly HEADER: "slot.header";
+    readonly CONTENT: "slot.content";
+    readonly FOOTER: "slot.footer";
+    readonly FOOTER_LINKS: "slot.footer-links";
+};
+type SurfaceTarget = typeof SURFACE_TARGETS[keyof typeof SURFACE_TARGETS];
 interface ExtensionManifest {
     /** Human-readable extension name */
     name: string;
@@ -605,7 +634,7 @@ interface ExtensionManifest {
     targets: string[];
     /** Permissions required by this extension */
     permissions: Permission[];
-    /** Specific events this extension listens for (e.g. ["identity:login", "messaging:postback:add_to_cart"]) */
+    /** Specific events this extension listens for (e.g. ["identity:login", "messaging:postback:Buy Now"]) */
     events?: EventType[];
     /**
      * Hostnames this extension is permitted to reach via data.fetch.
@@ -957,4 +986,4 @@ interface Order {
     display_status?: OrderStatus;
 }
 
-export { ALLOWED_ICONS, type ActionInvokePayload, type ActionPayloadMap, type ActivityEvent, type ActivityEventHandler, type ActivityEventType, type Address, type AllowedIconName, type ApiError, type ApiRequest, type ApiResponse, CAPABILITY_PERMISSION_MAP, type Capability, type CapabilityCall, type CapabilityRequest, type CapabilityResponse, type CapabilityType, type ContextData, type ConversationField, type ConversationTags, type Customer, type DataField, type DataFieldType, type EncryptedPayload, type EventDomain, type EventType, type ExtendIdentityHandler, type ExtendIdentityRequest, type ExtendIdentityResponse, type ExtensionManifest, type ExtensionRegistryEntry, type FetchRequest, type FetchRequestInit, type FetchResponse, type HostToSandboxMessage, type IdentityBaseClaims, type IdentityEvent, type IdentityEventType, type IdentityState, type InstanceConfig, type InstanceOption, type InvokeAction, type MarketplaceExtension, type MessagingContext, type MessagingEvent, type MessagingEventHandler, type MessagingEventType, type MessagingPostbackEvent, type MessengerCommand, type NamedEntity, type NewConversationPayload, type Order, type OrderAction, type OrderItem, type OrderStatus, type OrderStatuses, PERMISSIONS, type Permission, type Price, RESERVED_CONTEXT_KEYS, type ReservedContextKey, type SandboxToHostMessage, type Shipment, type SurfaceContext, type SurfaceLifecycleMessage, type Target, type Theme, type ToastPayload, type UITag, type UITagCategory, UI_TAGS, UI_TAG_ATTRIBUTES, UI_TAG_ATTRIBUTE_VALUES, UI_TAG_CATEGORIES, UI_TAG_CHILDREN, UI_TAG_DEFINITIONS, type UserIdentity, type WellKnownActivityEvent, type WidgetAction, tagToComponentName };
+export { ACTIVITY_EVENTS, ALLOWED_ICONS, type ActionInvokePayload, type ActionPayloadMap, type ActivityEvent, type ActivityEventHandler, type ActivityEventType, type Address, type AllowedIconName, type ApiError, type ApiRequest, type ApiResponse, CAPABILITY_PERMISSION_MAP, type Capability, type CapabilityCall, type CapabilityRequest, type CapabilityResponse, type CapabilityType, type ContextData, type ConversationField, type ConversationTags, type Customer, type DataField, type DataFieldType, type EncryptedPayload, type EventDomain, type EventType, type ExtendIdentityHandler, type ExtendIdentityRequest, type ExtendIdentityResponse, type ExtensionManifest, type ExtensionRegistryEntry, type FetchRequest, type FetchRequestInit, type FetchResponse, type HostToSandboxMessage, IDENTITY_EVENTS, INVOKE_ACTIONS, type IdentityBaseClaims, type IdentityEvent, type IdentityEventType, type IdentityState, type InstanceConfig, type InstanceOption, type InvokeAction, type MarketplaceExtension, type MessagingContext, type MessagingEvent, type MessagingEventHandler, type MessagingEventType, type MessagingPostbackEvent, type MessengerCommand, type NamedEntity, type NewConversationPayload, type Order, type OrderAction, type OrderItem, type OrderStatus, type OrderStatuses, PERMISSIONS, type Permission, type Price, RESERVED_CONTEXT_KEYS, type ReservedContextKey, SURFACE_TARGETS, type SandboxToHostMessage, type Shipment, type SurfaceContext, type SurfaceLifecycleMessage, type SurfaceTarget, type Target, type Theme, type ToastPayload, type UITag, type UITagCategory, UI_TAGS, UI_TAG_ATTRIBUTES, UI_TAG_ATTRIBUTE_VALUES, UI_TAG_CATEGORIES, UI_TAG_CHILDREN, UI_TAG_DEFINITIONS, type UserIdentity, type WellKnownActivityEvent, type WidgetAction, tagToComponentName };

package/dist/index.js

@@ -334,8 +334,32 @@ var ALLOWED_ICONS = [
 ];
 
 // src/capabilities.ts
+var INVOKE_ACTIONS = {
+  NEW_CONVERSATION: "newConversation",
+  SET_CONVERSATION_TAGS: "setConversationTags",
+  SET_CONVERSATION_FIELDS: "setConversationFields"
+};
 var RESERVED_CONTEXT_KEYS = ["identity", "messaging"];
 
+// src/identity.ts
+var IDENTITY_EVENTS = {
+  LOGIN: "login",
+  LOGOUT: "logout",
+  REFRESH: "refresh",
+  EXPIRED: "expired"
+};
+
+// src/activity.ts
+var ACTIVITY_EVENTS = {
+  CLICK: "click",
+  PAGE_VIEW: "page_view",
+  FORM_SUBMIT: "form_submit",
+  PRODUCT_VIEW: "product_view",
+  ADD_TO_CART: "add_to_cart",
+  PURCHASE: "purchase",
+  SEARCH: "search"
+};
+
 // src/permissions.ts
 var PERMISSIONS = [
   "context:read",
@@ -357,4 +381,12 @@ var CAPABILITY_PERMISSION_MAP = {
   "extend.identity": "extend:identity"
 };
 
-export { ALLOWED_ICONS, CAPABILITY_PERMISSION_MAP, EXTENSION_CATEGORIES, EXTENSION_VISIBILITIES, PERMISSIONS, RESERVED_CONTEXT_KEYS, UI_TAGS, UI_TAG_ATTRIBUTES, UI_TAG_ATTRIBUTE_VALUES, UI_TAG_CATEGORIES, UI_TAG_CHILDREN, UI_TAG_DEFINITIONS, asClerkOrgId, asClerkUserId, asISOTimestamp, tagToComponentName };
+// src/manifest.ts
+var SURFACE_TARGETS = {
+  HEADER: "slot.header",
+  CONTENT: "slot.content",
+  FOOTER: "slot.footer",
+  FOOTER_LINKS: "slot.footer-links"
+};
+
+export { ACTIVITY_EVENTS, ALLOWED_ICONS, CAPABILITY_PERMISSION_MAP, EXTENSION_CATEGORIES, EXTENSION_VISIBILITIES, IDENTITY_EVENTS, INVOKE_ACTIONS, PERMISSIONS, RESERVED_CONTEXT_KEYS, SURFACE_TARGETS, UI_TAGS, UI_TAG_ATTRIBUTES, UI_TAG_ATTRIBUTE_VALUES, UI_TAG_CATEGORIES, UI_TAG_CHILDREN, UI_TAG_DEFINITIONS, asClerkOrgId, asClerkUserId, asISOTimestamp, tagToComponentName };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackable-labs/sdk-extension-contracts",
-  "version": "1.75.0",
+  "version": "1.76.0",
   "private": false,
   "type": "module",
   "main": "./dist/index.js",