@pickaxeproject/react 6.18.1 → 6.19.0-beta.0

package/dist/esm/src/common/actionApproval.d.ts

@@ -0,0 +1,16 @@
+import type { PickaxeHistoryMessagePart } from "../types/history";
+export type ActionApprovalStatus = "pending" | "approved" | "declined" | "expired" | "cancelled";
+export type ActionApprovalData = {
+    id: string;
+    name: string;
+    kind: "action" | "mcp";
+    pickaxeId: string;
+    status: ActionApprovalStatus;
+    expiresAt: number;
+    arguments?: string;
+};
+export declare function parseActionApproval(content: string): ActionApprovalData | null;
+/** Replace an existing approval in place so decisions never duplicate cards. */
+export declare function upsertActionApprovalPart(parts: PickaxeHistoryMessagePart[], data: ActionApprovalData): void;
+/** Approval updates can arrive while a text/reasoning part is still streaming. */
+export declare function updateStreamTextPart(parts: PickaxeHistoryMessagePart[], type: "text" | "reasoning", content: string): void;

package/dist/esm/src/common/formInputOrder.d.ts

@@ -0,0 +1,4 @@
+/** Missing or invalid ranks retain legacy prompt order, after explicitly ranked fields. */
+export declare function sortFormInputs<T extends {
+    order?: number;
+}>(inputs: readonly T[]): T[];

package/dist/esm/src/common/formQuestionValidation.d.ts

@@ -0,0 +1,2 @@
+import type { MemoryStoredQuestionField } from "../types/form";
+export declare function getFormQuestionError(field: MemoryStoredQuestionField): "response-too-long" | "required-fields-missing" | null;

package/dist/esm/src/components/Pickaxe/Form/Questions/Submit.d.ts

@@ -1,8 +1,12 @@
+import type { ReactNode } from "react";
 import type { MemoryStoredQuestionField } from "../../../../types/form";
 interface SubmitProps {
+    navigation?: ReactNode;
+    paged?: boolean;
+    onInvalidQuestion?: (id: string) => void;
     questions: MemoryStoredQuestionField[];
     update: (questions: MemoryStoredQuestionField) => void;
     resetQuestions: () => void;
 }
-declare const Submit: ({ questions, resetQuestions }: SubmitProps) => import("react/jsx-runtime").JSX.Element;
+declare const Submit: ({ navigation, paged, questions, resetQuestions, onInvalidQuestion, }: SubmitProps) => import("react/jsx-runtime").JSX.Element;
 export default Submit;

package/dist/esm/src/components/Pickaxe/Provider.d.ts

@@ -88,6 +88,8 @@ type PickaxeContextType = {
     portalId?: string;
     accessGroup?: AccessGroup | null;
     pickaxe: LimitedPickaxe | null;
+    selectedModel: string;
+    setSelectedModel: SetState<string>;
     styles: PickaxeProviderStyles;
     colors: PickaxeProviderColors;
     misc: PickaxeMisc;

package/dist/esm/src/components/Pickaxe/ResponseProvider.d.ts

@@ -1,3 +1,4 @@
+import { useActionApprovals } from "../../hooks/pickaxe/useActionApprovals";
 import type { SetState } from "../../types/common";
 import type { MemoryStoredChatMessage, MemoryStoredFormResponse } from "../../types/response";
 import { type ReactNode } from "react";
@@ -27,6 +28,8 @@ type ResponseContextType = {
     setStatus: SetState<ResponseStatus>;
     setLimitData: SetState<PickaxeLimitData | null>;
     setError: SetState<string>;
+    actionApproval: ReturnType<typeof useActionApprovals>;
+    setActionApprovalToken: (token: string | null) => void;
     setIsGuestLimitReached: SetState<boolean>;
     setIsSwitchedToChat: SetState<boolean>;
 };

package/dist/esm/src/components/Pickaxe/common/EndUserModelPicker.d.ts

@@ -0,0 +1,3 @@
+export default function EndUserModelPicker({ compact, }: {
+    compact?: boolean;
+}): import("react/jsx-runtime").JSX.Element | null;

package/dist/esm/src/components/Pickaxe/common/PickaxeMessageParts/ActionApprovalPart.d.ts

@@ -0,0 +1,6 @@
+import type { useActionApprovals } from "../../../../hooks/pickaxe/useActionApprovals";
+export declare function ActionApprovalPart({ content, isStreaming, approval, }: {
+    content: string;
+    isStreaming?: boolean;
+    approval?: ReturnType<typeof useActionApprovals>;
+}): import("react/jsx-runtime").JSX.Element | null;

package/dist/esm/src/components/Pickaxe/common/PickaxeMessageParts/index.d.ts

@@ -1,10 +1,13 @@
+import type { useActionApprovals } from "../../../../hooks/pickaxe/useActionApprovals";
 import type { PickaxeHistoryMessagePart } from "../../../../types/history";
 import { type SuppressedRichPreviewUrls } from "../PickaxeMarkdown/Components/A/FilePreview";
 interface PickaxeMessagePartsProps {
     className?: string;
     parts: PickaxeHistoryMessagePart[];
     isStreaming?: boolean;
+    /** Supply the host response controller when rendering outside ResponseProvider. */
+    actionApproval?: ReturnType<typeof useActionApprovals>;
 }
 export declare const getSuppressedRichPreviewUrls: (parts: PickaxeHistoryMessagePart[]) => SuppressedRichPreviewUrls;
-declare const PickaxeMessageParts: ({ className, parts, isStreaming, }: PickaxeMessagePartsProps) => import("react/jsx-runtime").JSX.Element;
+declare const PickaxeMessageParts: ({ className, parts, isStreaming, actionApproval: suppliedActionApproval, }: PickaxeMessagePartsProps) => import("react/jsx-runtime").JSX.Element;
 export default PickaxeMessageParts;

package/dist/esm/src/hooks/pickaxe/useActionApprovals.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+/** The decision capability stays in memory, never in saved response parts. */
+export declare function useActionApprovals(active: boolean): {
+    setToken: import("react").Dispatch<import("react").SetStateAction<string | null>>;
+    enabled: boolean;
+    busyId: string | null;
+    errors: Record<string, string>;
+    decisions: Record<string, "approved" | "declined">;
+    decide: (id: string, decision: "approved" | "declined") => Promise<void>;
+};

package/dist/esm/src/hooks/pickaxe/useEndUserModel.d.ts

@@ -0,0 +1,10 @@
+export declare function useEndUserModel(): {
+    options: {
+        id: string;
+        label: string;
+    }[];
+    enabled: boolean;
+    value: string;
+    setValue: import("../../types/common").SetState<string>;
+    defaultModel: import("../../types/pickaxe").PickaxeModel | undefined;
+};

package/dist/esm/src/hooks/pickaxe/usePickaxeContext.d.ts

@@ -16,6 +16,8 @@ export declare const usePickaxeContext: () => {
     portalId?: string | undefined;
     accessGroup?: import("../../components/Pickaxe/Provider").AccessGroup | null | undefined;
     pickaxe: import("../../types/pickaxe").LimitedPickaxe | null;
+    selectedModel: string;
+    setSelectedModel: import("../../types/common").SetState<string>;
     styles: import("../../components/Pickaxe/Provider").PickaxeProviderStyles;
     colors: import("../../components/Pickaxe/Provider").PickaxeProviderColors;
     misc: import("../../components/Pickaxe/Provider").PickaxeMisc;

package/dist/esm/src/hooks/pickaxe/useResponseContext.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 export declare const useResponseContext: () => {
     messages: import("../../types/response").MemoryStoredChatMessage[];
     response: import("../../types/response").MemoryStoredFormResponse | null;
@@ -13,6 +14,15 @@ export declare const useResponseContext: () => {
     setStatus: import("../../types/common").SetState<import("../../components/Pickaxe/ResponseProvider").ResponseStatus>;
     setLimitData: import("../../types/common").SetState<import("../../components/Pickaxe/ResponseProvider").PickaxeLimitData | null>;
     setError: import("../../types/common").SetState<string>;
+    actionApproval: {
+        setToken: import("react").Dispatch<import("react").SetStateAction<string | null>>;
+        enabled: boolean;
+        busyId: string | null;
+        errors: Record<string, string>;
+        decisions: Record<string, "approved" | "declined">;
+        decide: (id: string, decision: "approved" | "declined") => Promise<void>;
+    };
+    setActionApprovalToken: (token: string | null) => void;
     setIsGuestLimitReached: import("../../types/common").SetState<boolean>;
     setIsSwitchedToChat: import("../../types/common").SetState<boolean>;
 };

package/dist/esm/src/index.d.ts

@@ -22,3 +22,5 @@ export { default as PickaxeArtifactRenderer } from "./components/Pickaxe/Addons/
 export * from "./components/Pickaxe/Addons/Artifact/Provider";
 export * from "./components/Pickaxe/Addons/Artifact/hooks/useArtifactContext";
 export * from "./components/Pickaxe/Addons/Artifact/hooks/useArtifact";
+export { ActionApprovalPart } from "./components/Pickaxe/common/PickaxeMessageParts/ActionApprovalPart";
+export type { ActionApprovalData, ActionApprovalStatus, } from "./common/actionApproval";

package/dist/esm/src/types/form.d.ts

@@ -1,5 +1,7 @@
 export type PickaxeQuestionType = "Short Answer" | "short" | "Long Answer" | "long" | "Multiple Choice" | "multiple" | "Checkbox" | "Knowledge Upload";
 export type PickaxeQuestion = {
+    /** Optional form display order; prompt placement stays independent. */
+    order?: number;
     id: string;
     answerlength: string;
     example: string;

package/dist/esm/src/types/history.d.ts

@@ -1,3 +1,4 @@
+import type { ActionApprovalData } from "../common/actionApproval";
 export type PickaxeHistoryOriginType = "TEST" | "BUILDER" | "PICKAXE" | "STUDIO" | "EMBED" | "EMAIL" | "WHATSAPP" | "MAKE" | "SLACK" | "API";
 export type PickaxeHistoryPickaxeType = "CHAT" | "FORM";
 export type PickaxeHistorySenderType = "PICKAXE_USER" | "STUDIO_USER" | "DEPLOYMENT_USER";
@@ -36,7 +37,7 @@ export type PickaxeHistoryMessage = {
     createdAt: string;
     area?: PickaxeHistoryMessageArea;
 };
-export type PickaxeHistoryMessagePartsType = "text" | "reasoning" | "data-action-tool-caption" | "data-reasoning-caption" | "data-tool-assets";
+export type PickaxeHistoryMessagePartsType = "text" | "reasoning" | "data-action-tool-caption" | "data-reasoning-caption" | "data-tool-assets" | "data-action-approval";
 export type PickaxeHistoryMessagePart = {
     type: PickaxeHistoryMessagePartsType;
     content: string;
@@ -66,6 +67,10 @@ export type PickaxeHistoryStreamDataReasoningCaption = {
         caption: string;
     };
 };
-export type PickaxeHistoryStreamData = PickaxeHistoryStreamDataActionToolCaption | PickaxeHistoryStreamDataReasoningCaption;
+export type PickaxeHistoryStreamDataActionApproval = {
+    type: "data-action-approval";
+    data: ActionApprovalData;
+};
+export type PickaxeHistoryStreamData = PickaxeHistoryStreamDataActionApproval | PickaxeHistoryStreamDataActionToolCaption | PickaxeHistoryStreamDataReasoningCaption;
 export type PickaxeHistoryStream = PickaxeHistoryStreamPartStartEnd | PickaxeHistoryStreamPartDelta | PickaxeHistoryStreamData;
 export {};

package/dist/esm/src/types/pickaxe.d.ts

@@ -2,6 +2,8 @@ import type { PickaxeQuestion } from "./form";
 export type PickaxeImageOrText = "text" | "image";
 export type PickaxePrivacySetting = "public" | "unlisted" | "private" | "deleted";
 export type PickaxeCloneable = "true" | "false";
+export type PickaxeFormLayout = "single" | "paged";
+export type PickaxeEndUserModelSelectionMode = "all" | "select";
 export type PickaxeDocumentUploadType = "ownerupload" | "enduserupload" | "enduserupload-user";
 export type PickaxeModel = "gpt-3.5-turbo" | "gpt-4-1106-preview" | "mistral-small" | "gpt-5.1" | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | "gpt-5-chat-latest" | "gpt-4.1" | "gpt-4.1-mini" | "gpt-4.1-nano" | "gpt-4o-mini" | "gpt-4o" | "gpt-4" | "o3-mini" | "o1" | "o3" | "o4-mini" | "gemini-3-pro" | "gemini-2.5-flash" | "gemini-2.5-flash-preview-05-20" | "gemini-2.5-pro" | "gemini-2.5-pro-preview-05-06" | "gemini-2.0-flash" | "gemini-2.0-flash-lite" | "gemini-1.5-pro" | "gemini-1.5-flash" | "deepseek-chat" | "mistral-large-latest" | "claude-sonnet-4-5-20250929" | "claude-haiku-4-5-20251001" | "claude-opus-4-1-20250805" | "claude-opus-4-20250514" | "claude-opus-4-5-20251101" | "claude-sonnet-4-20250514" | "claude-3-7-sonnet-20250219" | "claude-3-opus-20240229" | "grok-4-fast-reasoning-latest" | "grok-4-fast-non-reasoning-latest" | "grok-4-1-fast-reasoning" | "grok-4-1-fast-non-reasoning" | "grok-4-latest" | "grok-3-latest" | "llama-3-uncensored" | "sonar" | "sonar-pro" | "sonar-reasoning" | "sonar-reasoning-pro" | "sonar-deep-research";
 export type Pickaxe = {
@@ -36,6 +38,14 @@ export type Pickaxe = {
     maxlength: number;
     membuffer: number;
     model: PickaxeModel;
+    formLayout?: PickaxeFormLayout;
+    allowEndUserModelSelection?: boolean;
+    endUserModelSelectionMode?: PickaxeEndUserModelSelectionMode;
+    allowedEndUserModels?: string[];
+    availableEndUserModels?: {
+        id: string;
+        label: string;
+    }[];
     owner: string;
     placeholdertext: string;
     prespenalty: number;
@@ -80,6 +90,14 @@ export type LimitedPickaxe = {
     formtitle: string;
     intromessage?: string;
     model: PickaxeModel;
+    formLayout?: PickaxeFormLayout;
+    allowEndUserModelSelection?: boolean;
+    endUserModelSelectionMode?: PickaxeEndUserModelSelectionMode;
+    allowedEndUserModels?: string[];
+    availableEndUserModels?: {
+        id: string;
+        label: string;
+    }[];
     placeholdertext: string;
     icebreakers: string[];
     submittext?: string;