@roketus/loyalty-js-sdk 5.4.20 → 5.4.23

package/dist/esm5/interfaces/agent/agentInterfaces.d.ts

@@ -0,0 +1,88 @@
+import { IPaginationData } from '../requestFilterInterfaces';
+/**
+ * Agent conversations (threads) of an agentic endpoint — `/campaign/agent/{agent}/conversations`.
+ *
+ * The routes are agent-scoped, so the agent id is a parameter of every call and the next agent
+ * (campaign, referral) needs no new SDK group. These calls go out on `issuerClient`: the service
+ * keys the tenant off the issuer JWT's `identityId`.
+ *
+ * The AG-UI streaming endpoint (`POST /campaign/agent/{agent}/agui`) is NOT part of this namespace —
+ * it is driven by an AG-UI client (CopilotKit), not by the SDK.
+ */
+export type TAgentMessageRole = 'user' | 'assistant' | 'tool' | 'activity';
+export interface IAgentToolCallFunction {
+    name: string;
+    /** JSON text — the tool arguments as the model produced them (redacted by the service). */
+    arguments: string;
+}
+export interface IAgentToolCall {
+    id: string;
+    type: 'function';
+    function: IAgentToolCallFunction;
+}
+/**
+ * AG-UI Message shape (docs.ag-ui.com/concepts/messages) as the service persists it:
+ * user / assistant (with `toolCalls`) / tool (with `toolCallId`).
+ *
+ * `role: "activity"` is the AG-UI activity message (`activityType` + structured `content`).
+ * The service does not emit it yet; the field is here so a client can consume it without an
+ * SDK release the day it does.
+ */
+export interface IAgentMessage {
+    id: string;
+    role: TAgentMessageRole;
+    content?: string;
+    toolCalls?: IAgentToolCall[];
+    toolCallId?: string;
+    activityType?: string;
+}
+export interface IAgentConversationAttributes {
+    tenant_id: string;
+    title?: string;
+    turns?: number;
+    last_activity_at: string;
+    created_at?: string;
+    cohort_created_id?: string;
+}
+export interface IAgentThreadAttributes extends IAgentConversationAttributes {
+    messages: IAgentMessage[];
+}
+export interface IAgentConversationDTO {
+    id: string;
+    attributes: IAgentConversationAttributes;
+}
+export interface IAgentThreadDTO {
+    id: string;
+    attributes: IAgentThreadAttributes;
+}
+export interface IConversationsPageDTO {
+    data: IAgentConversationDTO[];
+    meta: IPaginationData;
+}
+export interface IListConversationsParams {
+    agent: string;
+    page?: number;
+    perPage?: number;
+}
+export interface IConversationParams {
+    agent: string;
+    threadId: string;
+}
+export type TListConversations = (params: IListConversationsParams) => Promise<IConversationsPageDTO>;
+export type TGetConversation = (params: IConversationParams) => Promise<IAgentThreadDTO>;
+export type TDeleteConversation = (params: IConversationParams) => Promise<void>;
+/** Raw service envelope — JSON:API-shaped, `data` is always an array. */
+export interface IAgentConversationsResponseDTO<A = IAgentConversationAttributes> {
+    data: Array<{
+        id: string;
+        type: string;
+        attributes: A;
+    }>;
+    meta?: {
+        current_page?: number;
+        limit: number;
+        offset: number;
+        total_items: number;
+        total_pages?: number;
+    };
+}

package/dist/esm5/interfaces/agent/index.d.ts

@@ -0,0 +1 @@
+export * from './agentInterfaces';

package/dist/esm5/interfaces/issuer/confirmationInterfaces.d.ts

@@ -0,0 +1,85 @@
+import type { IHTTPClientResponse } from '@roketus/web-toolkit';
+/**
+ * Designated-approver confirmation — the `loyalty-issuer` step-up 2FA surface.
+ *
+ * The envelope is the LoyaltyAPI JSON:API convention (`{ data: [{ id, type,
+ * attributes }] }`) and ATTRIBUTE KEYS ARE snake_case: the server emits Go-style
+ * json tags. Timestamps are unix SECONDS as numbers, not ISO strings.
+ *
+ * There is deliberately no confirm response type. The code is single-use, so a
+ * standalone confirm would spend it and leave the action to a second,
+ * unconfirmed request. Confirming and acting happen in ONE request against the
+ * action's own endpoint — see `confirmProtectedAction`.
+ */
+export interface IApproverAttributesDTO {
+    name: string;
+    card_number: string;
+    /** Already masked by the server. The full destination never leaves it. */
+    masked_destination: string;
+}
+export interface IApproverDTO {
+    id: string;
+    type: string;
+    attributes: IApproverAttributesDTO;
+}
+export interface IListApproversResponseDTO {
+    data: IApproverDTO[];
+}
+export interface IConfirmationChallengeAttributesDTO {
+    action: string;
+    approver_id: string;
+    approver_name: string;
+    masked_destination: string;
+    status: string;
+    /** unix seconds */
+    expires_at: number;
+    remaining_attempts: number;
+    /** unix seconds */
+    resend_available_at: number;
+    /** Server-decided: requester and approver are the same person. */
+    self_approval: boolean;
+}
+export interface IConfirmationChallengeDTO {
+    id: string;
+    type: string;
+    attributes: IConfirmationChallengeAttributesDTO;
+}
+export interface IConfirmationChallengeResponseDTO {
+    data: IConfirmationChallengeDTO[];
+}
+/**
+ * `requesterId` / `requesterName` are supplied by the CALLER, not derived from
+ * the token: the session names the issuer and never the person. The requesting
+ * admin named in the approver's SMS is therefore a claim, not proof.
+ */
+export interface IIssueConfirmationChallengePayload {
+    action: string;
+    approverId: string;
+    requesterId: string;
+    requesterName: string;
+}
+export interface IConfirmProtectedActionPayload {
+    /**
+     * The ACTION's own endpoint, which confirms and acts atomically — e.g.
+     * `/issuer/pii-export/request`.
+     *
+     * Deliberately a parameter rather than a map inside the SDK: adding a
+     * protected action is then a change in the calling app and the owning
+     * service, with no SDK release in between.
+     */
+    path: string;
+    confirmationId: string;
+    code: string;
+}
+export interface IListApprovers {
+    (action: string): Promise<IHTTPClientResponse<IListApproversResponseDTO>>;
+}
+export interface IIssueConfirmationChallenge {
+    (payload: IIssueConfirmationChallengePayload): Promise<IHTTPClientResponse<IConfirmationChallengeResponseDTO>>;
+}
+export interface IResendConfirmationChallenge {
+    (confirmationId: string): Promise<IHTTPClientResponse<IConfirmationChallengeResponseDTO>>;
+}
+export interface IConfirmProtectedAction {
+    (payload: IConfirmProtectedActionPayload): Promise<IHTTPClientResponse<unknown>>;
+}

package/dist/esm5/interfaces/issuer/index.d.ts

@@ -3,3 +3,4 @@ export * from './ISetIssuerSettingsPayload';
 export { IDispatchCustomEvent, IGetCardByPhone, ISetCardName, ECardType, ICardPromocode, IGetCardByIdResponseDTO } from './issuerInterface';
 export { IGetCardBonus } from './IGetCardBonuses';
 export { IGetCardSpendsResponseDTO } from './IGetCardSpends';
+export * from './confirmationInterfaces';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roketus/loyalty-js-sdk",
-  "version": "5.4.20",
+  "version": "5.4.23",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm5/index.js",
   "author": "Roket.us <info@roket.us>",