@intellectif/lk-react 23.0.1 → 23.1.1

package/dist/chunk-RX3A6KIY.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/ai/LkAiProvider.tsx"],"names":[],"mappings":";;;;AA2DA,IAAM,WAAA,GAAc,cAAgC,IAAI,CAAA;AAqBjD,SAAS,YAAA,CAAa,EAAE,EAAA,EAAI,QAAA,EAAS,EAAyC;AACnF,EAAA,2BAAQ,WAAA,CAAY,QAAA,EAAZ,EAAqB,KAAA,EAAO,IAAK,QAAA,EAAS,CAAA;AACpD;AAGO,SAAS,aAAa,QAAA,EAA6C;AACxE,EAAA,MAAM,OAAA,GAAU,WAAW,WAAW,CAAA;AACtC,EAAA,OAAO,YAAY,OAAA,IAAW,MAAA;AAChC","file":"chunk-RX3A6KIY.js","sourcesContent":["'use client';\n\nimport type {\n  AiExplanationRequest,\n  AiHintRequest,\n  AiTextResult,\n  AiWritingFeedbackRequest,\n  AiWritingFeedbackResult,\n} from '@intellectif/lk-core';\nimport { createContext, type ReactNode, useContext } from 'react';\n\n/**\n * The model a host runs for learners, as the components call it. The SDK never\n * calls a model, holds a key or writes a prompt: each port is the host's\n * function — usually a request to its own server, which holds the key and the\n * prompt and chooses the model.\n *\n * A port is called only when the learner asks — a button, never on render —\n * and gets an `AbortSignal` that fires when the answer it was asked about goes\n * away. Whatever it resolves to is checked before a learner sees it: see\n * `checkAiExplanation` and `checkAiHint` in lk-core. A port that rejects, or\n * resolves to something refused, costs the learner the help, never the\n * question.\n *\n * Leave a port out to switch that feature off. Nothing AI renders in `exam`,\n * whatever is passed.\n */\nexport interface LearnerAi {\n  /** Explains a graded answer. */\n  explain?: (\n    request: AiExplanationRequest,\n    options: { signal: AbortSignal },\n  ) => Promise<AiTextResult>;\n  /** Writes the next hint for an answer not yet submitted. */\n  hint?: (request: AiHintRequest, options: { signal: AbortSignal }) => Promise<AiTextResult>;\n  /** The most hints a learner can ask for on one question. Default 3, at most 10. */\n  maxHints?: number;\n  /**\n   * Gives feedback on a draft of a written response, before the learner\n   * submits it: the overall feedback as text, corrections that quote the\n   * draft, and a judgement per rubric criterion. See `checkAiWritingFeedback`\n   * in lk-core for what is refused.\n   */\n  writingFeedback?: (\n    request: AiWritingFeedbackRequest,\n    options: { signal: AbortSignal },\n  ) => Promise<AiWritingFeedbackResult>;\n  /** How many times a learner can ask for feedback on one written response. Default 3, at most 10. */\n  maxWritingFeedback?: number;\n  /**\n   * The language to write explanations and hints in, as a tag (`es`,\n   * `pt-BR`). Defaults to the component's `locale`: the interface language,\n   * which the buttons around the help are in, and usually the right one. In a\n   * language course it need not be the item's — English items, explained in\n   * Spanish — and the item's own language reaches your port as `facts.locale`.\n   */\n  learnerLocale?: string;\n}\n\nconst LkAiContext = createContext<LearnerAi | null>(null);\n\nexport interface LkAiProviderProps {\n  ai: LearnerAi;\n  children: ReactNode;\n}\n\n/**\n * Supplies the host's AI ports to every activity beneath, as `LkIntlProvider`\n * supplies strings. A component's own `ai` prop wins over it, whole.\n *\n * ```tsx\n * <LkAiProvider ai={{\n *   explain: (request, { signal }) => api.explain(request, signal),\n *   hint: (request, { signal }) => api.hint(request, signal),\n *   learnerLocale: learner.language,\n * }}>\n *   <ActivitySequence … />\n * </LkAiProvider>\n * ```\n */\nexport function LkAiProvider({ ai, children }: LkAiProviderProps): React.JSX.Element {\n  return <LkAiContext.Provider value={ai}>{children}</LkAiContext.Provider>;\n}\n\n/** The ports in force: a component's own, else the provider's, else none. */\nexport function useLearnerAi(override?: LearnerAi): LearnerAi | undefined {\n  const context = useContext(LkAiContext);\n  return override ?? context ?? undefined;\n}\n"]}