@stackable-labs/sdk-extension-contracts 1.72.0 → 1.74.0

package/dist/index.d.ts

@@ -414,8 +414,28 @@ interface ToastPayload {
 type MessengerCommand = 'open' | 'close' | 'show' | 'hide';
 /** Widget-only actions handled by WidgetComponent (not forwarded to Zendesk) */
 type WidgetAction = 'toggle';
+/** Conversation tags — array of string labels */
+type ConversationTags = string[];
+/** Conversation field — Zendesk custom field ID + value */
+interface ConversationField {
+    id: string;
+    value: string | number | boolean;
+}
 /** Known actions for actions.invoke capability */
-type InvokeAction = 'newConversation' | MessengerCommand | WidgetAction;
+type InvokeAction = 'newConversation' | 'setConversationTags' | 'setConversationFields' | MessengerCommand | WidgetAction;
+/** Typed payload for newConversation action */
+interface NewConversationPayload {
+    metadata?: Record<string, unknown>;
+    tags?: ConversationTags;
+    fields?: ConversationField[];
+    [key: string]: unknown;
+}
+/** Maps known action names to their typed payloads */
+interface ActionPayloadMap {
+    newConversation: NewConversationPayload;
+    setConversationTags: ConversationTags;
+    setConversationFields: ConversationField[];
+}
 /** Payload for actions.invoke capability */
 interface ActionInvokePayload {
     action: InvokeAction;
@@ -493,7 +513,7 @@ 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 = 'page_view' | 'click' | 'product_view' | 'add_to_cart' | 'purchase' | 'search' | 'form_submit';
+type WellKnownActivityEvent = 'click' | 'page_view' | 'form_submit' | 'product_view' | 'add_to_cart' | 'purchase' | 'search';
 /** Domain-stripped activity event names. Hooks accept these directly (e.g., useActivityEvent('product_view', ...)). */
 type ActivityEventType = WellKnownActivityEvent | string;
 /** Normalized activity event payload */
@@ -552,9 +572,19 @@ interface InstanceOption {
 declare const PERMISSIONS: readonly ["context:read", "data:query", "data:fetch", "actions:toast", "actions:invoke", "events:identity", "events:messaging", "events:activity", "extend:identity"];
 type Permission = (typeof PERMISSIONS)[number];
 /**
- * Maps capability types to the permission required to use them.
+ * Maps capability types (dot notation, used in code) to the permission
+ * required to use them (colon notation, used in manifest).
  */
-declare const CAPABILITY_PERMISSION_MAP: Record<string, Permission>;
+declare const CAPABILITY_PERMISSION_MAP: {
+    readonly 'context.read': "context:read";
+    readonly 'data.query': "data:query";
+    readonly 'data.fetch': "data:fetch";
+    readonly 'actions.toast': "actions:toast";
+    readonly 'actions.invoke': "actions:invoke";
+    readonly 'extend.identity': "extend:identity";
+};
+/** Capability key type — dot-notation API names (e.g., 'data.query', 'actions.toast') */
+type Capability = keyof typeof CAPABILITY_PERMISSION_MAP;
 
 /**
  * Extension Manifest Schema
@@ -927,4 +957,4 @@ interface Order {
     display_status?: OrderStatus;
 }
 
-export { ALLOWED_ICONS, type ActionInvokePayload, type ActivityEvent, type ActivityEventHandler, type ActivityEventType, type Address, type AllowedIconName, type ApiError, type ApiRequest, type ApiResponse, CAPABILITY_PERMISSION_MAP, type CapabilityCall, type CapabilityRequest, type CapabilityResponse, type CapabilityType, type ContextData, 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 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 { 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 };

package/package.json

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