@intellectif/lk-react 23.1.0 → 23.1.2

package/dist/ai/LkAiProvider.d.cts

@@ -1,83 +1,2 @@
-import { AiExplanationRequest, AiTextResult, AiHintRequest, AiWritingFeedbackRequest, AiWritingFeedbackResult, AiCoachingRequest, AiCoachingResult } from '@intellectif/lk-core';
-import { ReactNode } from 'react';
-
-/**
- * The model a host runs for learners, as the components call it. The SDK never
- * calls a model, holds a key or writes a prompt: each port is the host's
- * function — usually a request to its own server, which holds the key and the
- * prompt and chooses the model.
- *
- * A port is called only when the learner asks — a button, never on render —
- * and gets an `AbortSignal` that fires when the answer it was asked about goes
- * away. Whatever it resolves to is checked before a learner sees it: see
- * `checkAiExplanation` and `checkAiHint` in lk-core. A port that rejects, or
- * resolves to something refused, costs the learner the help, never the
- * question.
- *
- * Leave a port out to switch that feature off. Nothing AI renders in `exam`,
- * whatever is passed.
- */
-interface LearnerAi {
-    /** Explains a graded answer. */
-    explain?: (request: AiExplanationRequest, options: {
-        signal: AbortSignal;
-    }) => Promise<AiTextResult>;
-    /** Writes the next hint for an answer not yet submitted. */
-    hint?: (request: AiHintRequest, options: {
-        signal: AbortSignal;
-    }) => Promise<AiTextResult>;
-    /** The most hints a learner can ask for on one question. Default 3, at most 10. */
-    maxHints?: number;
-    /**
-     * Gives feedback on a draft of a written response, before the learner
-     * submits it: the overall feedback as text, corrections that quote the
-     * draft, and a judgement per rubric criterion. See `checkAiWritingFeedback`
-     * in lk-core for what is refused.
-     */
-    writingFeedback?: (request: AiWritingFeedbackRequest, options: {
-        signal: AbortSignal;
-    }) => Promise<AiWritingFeedbackResult>;
-    /** How many times a learner can ask for feedback on one written response. Default 3, at most 10. */
-    maxWritingFeedback?: number;
-    /**
-     * Coaches a learner on a graded reading aloud: what the speech engine's
-     * marks mean and how to practise, word by word. The marks are the engine's
-     * and are never re-scored; coaching on a word the engine did not mark, or a
-     * sound it did not report, is refused whole. See `checkAiCoaching` in
-     * lk-core. One coaching per reading.
-     */
-    pronunciationCoaching?: (request: AiCoachingRequest, options: {
-        signal: AbortSignal;
-    }) => Promise<AiCoachingResult>;
-    /**
-     * The language to write explanations, hints, feedback and coaching in, as a tag (`es`,
-     * `pt-BR`). Defaults to the component's `locale`: the interface language,
-     * which the buttons around the help are in, and usually the right one. In a
-     * language course it need not be the item's — English items, explained in
-     * Spanish — and the item's own language reaches your port as `facts.locale`.
-     */
-    learnerLocale?: string;
-}
-interface LkAiProviderProps {
-    ai: LearnerAi;
-    children: ReactNode;
-}
-/**
- * Supplies the host's AI ports to every activity beneath, as `LkIntlProvider`
- * supplies strings. A component's own `ai` prop wins over it, whole.
- *
- * ```tsx
- * <LkAiProvider ai={{
- *   explain: (request, { signal }) => api.explain(request, signal),
- *   hint: (request, { signal }) => api.hint(request, signal),
- *   learnerLocale: learner.language,
- * }}>
- *   <ActivitySequence … />
- * </LkAiProvider>
- * ```
- */
-declare function LkAiProvider({ ai, children }: LkAiProviderProps): React.JSX.Element;
-/** The ports in force: a component's own, else the provider's, else none. */
-declare function useLearnerAi(override?: LearnerAi): LearnerAi | undefined;
-
-export { type LearnerAi, LkAiProvider, type LkAiProviderProps, useLearnerAi };
+import { i as useLearnerAi, n as LkAiProvider, r as LkAiProviderProps, t as LearnerAi } from "../LkAiProvider-DAPpA3PQ.cjs";
+export { LearnerAi, LkAiProvider, LkAiProviderProps, useLearnerAi };

package/dist/ai/LkAiProvider.d.ts

@@ -1,83 +1,2 @@
-import { AiExplanationRequest, AiTextResult, AiHintRequest, AiWritingFeedbackRequest, AiWritingFeedbackResult, AiCoachingRequest, AiCoachingResult } from '@intellectif/lk-core';
-import { ReactNode } from 'react';
-
-/**
- * The model a host runs for learners, as the components call it. The SDK never
- * calls a model, holds a key or writes a prompt: each port is the host's
- * function — usually a request to its own server, which holds the key and the
- * prompt and chooses the model.
- *
- * A port is called only when the learner asks — a button, never on render —
- * and gets an `AbortSignal` that fires when the answer it was asked about goes
- * away. Whatever it resolves to is checked before a learner sees it: see
- * `checkAiExplanation` and `checkAiHint` in lk-core. A port that rejects, or
- * resolves to something refused, costs the learner the help, never the
- * question.
- *
- * Leave a port out to switch that feature off. Nothing AI renders in `exam`,
- * whatever is passed.
- */
-interface LearnerAi {
-    /** Explains a graded answer. */
-    explain?: (request: AiExplanationRequest, options: {
-        signal: AbortSignal;
-    }) => Promise<AiTextResult>;
-    /** Writes the next hint for an answer not yet submitted. */
-    hint?: (request: AiHintRequest, options: {
-        signal: AbortSignal;
-    }) => Promise<AiTextResult>;
-    /** The most hints a learner can ask for on one question. Default 3, at most 10. */
-    maxHints?: number;
-    /**
-     * Gives feedback on a draft of a written response, before the learner
-     * submits it: the overall feedback as text, corrections that quote the
-     * draft, and a judgement per rubric criterion. See `checkAiWritingFeedback`
-     * in lk-core for what is refused.
-     */
-    writingFeedback?: (request: AiWritingFeedbackRequest, options: {
-        signal: AbortSignal;
-    }) => Promise<AiWritingFeedbackResult>;
-    /** How many times a learner can ask for feedback on one written response. Default 3, at most 10. */
-    maxWritingFeedback?: number;
-    /**
-     * Coaches a learner on a graded reading aloud: what the speech engine's
-     * marks mean and how to practise, word by word. The marks are the engine's
-     * and are never re-scored; coaching on a word the engine did not mark, or a
-     * sound it did not report, is refused whole. See `checkAiCoaching` in
-     * lk-core. One coaching per reading.
-     */
-    pronunciationCoaching?: (request: AiCoachingRequest, options: {
-        signal: AbortSignal;
-    }) => Promise<AiCoachingResult>;
-    /**
-     * The language to write explanations, hints, feedback and coaching in, as a tag (`es`,
-     * `pt-BR`). Defaults to the component's `locale`: the interface language,
-     * which the buttons around the help are in, and usually the right one. In a
-     * language course it need not be the item's — English items, explained in
-     * Spanish — and the item's own language reaches your port as `facts.locale`.
-     */
-    learnerLocale?: string;
-}
-interface LkAiProviderProps {
-    ai: LearnerAi;
-    children: ReactNode;
-}
-/**
- * Supplies the host's AI ports to every activity beneath, as `LkIntlProvider`
- * supplies strings. A component's own `ai` prop wins over it, whole.
- *
- * ```tsx
- * <LkAiProvider ai={{
- *   explain: (request, { signal }) => api.explain(request, signal),
- *   hint: (request, { signal }) => api.hint(request, signal),
- *   learnerLocale: learner.language,
- * }}>
- *   <ActivitySequence … />
- * </LkAiProvider>
- * ```
- */
-declare function LkAiProvider({ ai, children }: LkAiProviderProps): React.JSX.Element;
-/** The ports in force: a component's own, else the provider's, else none. */
-declare function useLearnerAi(override?: LearnerAi): LearnerAi | undefined;
-
-export { type LearnerAi, LkAiProvider, type LkAiProviderProps, useLearnerAi };
+import { i as useLearnerAi, n as LkAiProvider, r as LkAiProviderProps, t as LearnerAi } from "../LkAiProvider-QdEcIhoo.js";
+export { LearnerAi, LkAiProvider, LkAiProviderProps, useLearnerAi };

package/dist/ai/LkAiProvider.js

@@ -1,4 +1,35 @@
 'use client';
-export { LkAiProvider, useLearnerAi } from '../chunk-ZPI6Q42R.js';
-//# sourceMappingURL=LkAiProvider.js.map
+"use client";
+import { createContext, useContext } from "react";
+import { jsx } from "react/jsx-runtime";
+//#region src/ai/LkAiProvider.tsx
+const LkAiContext = createContext(null);
+/**
+* Supplies the host's AI ports to every activity beneath, as `LkIntlProvider`
+* supplies strings. A component's own `ai` prop wins over it, whole.
+*
+* ```tsx
+* <LkAiProvider ai={{
+*   explain: (request, { signal }) => api.explain(request, signal),
+*   hint: (request, { signal }) => api.hint(request, signal),
+*   learnerLocale: learner.language,
+* }}>
+*   <ActivitySequence … />
+* </LkAiProvider>
+* ```
+*/
+function LkAiProvider({ ai, children }) {
+	return /* @__PURE__ */ jsx(LkAiContext.Provider, {
+		value: ai,
+		children
+	});
+}
+/** The ports in force: a component's own, else the provider's, else none. */
+function useLearnerAi(override) {
+	const context = useContext(LkAiContext);
+	return override ?? context ?? void 0;
+}
+//#endregion
+export { LkAiProvider, useLearnerAi };
+
 //# sourceMappingURL=LkAiProvider.js.map

package/dist/ai/LkAiProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"LkAiProvider.js"}
+{"version":3,"file":"LkAiProvider.js","names":[],"sources":["../../src/ai/LkAiProvider.tsx"],"sourcesContent":["'use client';\n\nimport type {\n  AiCoachingRequest,\n  AiCoachingResult,\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   * Coaches a learner on a graded reading aloud: what the speech engine's\n   * marks mean and how to practise, word by word. The marks are the engine's\n   * and are never re-scored; coaching on a word the engine did not mark, or a\n   * sound it did not report, is refused whole. See `checkAiCoaching` in\n   * lk-core. One coaching per reading.\n   */\n  pronunciationCoaching?: (\n    request: AiCoachingRequest,\n    options: { signal: AbortSignal },\n  ) => Promise<AiCoachingResult>;\n  /**\n   * The language to write explanations, hints, feedback and coaching 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"],"mappings":";;;;AAwEA,MAAM,cAAc,cAAgC,IAAI;;;;;;;;;;;;;;;AAqBxD,SAAgB,aAAa,EAAE,IAAI,YAAkD;CACnF,OAAO,oBAAC,YAAY,UAAb;EAAsB,OAAO;EAAK;CAA+B,CAAA;AAC1E;;AAGA,SAAgB,aAAa,UAA6C;CACxE,MAAM,UAAU,WAAW,WAAW;CACtC,OAAO,YAAY,WAAW,KAAA;AAChC"}

package/dist/ai/useAiHelp.cjs

@@ -1,26 +1,8 @@
 'use client';
-'use strict';
-
-var chunkLPUWXIPR_cjs = require('../chunk-LPUWXIPR.cjs');
-require('../chunk-TUVENMXB.cjs');
-
-
-
-Object.defineProperty(exports, "useAiCoaching", {
-  enumerable: true,
-  get: function () { return chunkLPUWXIPR_cjs.useAiCoaching; }
-});
-Object.defineProperty(exports, "useAiExplanation", {
-  enumerable: true,
-  get: function () { return chunkLPUWXIPR_cjs.useAiExplanation; }
-});
-Object.defineProperty(exports, "useAiHints", {
-  enumerable: true,
-  get: function () { return chunkLPUWXIPR_cjs.useAiHints; }
-});
-Object.defineProperty(exports, "useAiWritingFeedback", {
-  enumerable: true,
-  get: function () { return chunkLPUWXIPR_cjs.useAiWritingFeedback; }
-});
-//# sourceMappingURL=useAiHelp.cjs.map
-//# sourceMappingURL=useAiHelp.cjs.map
+"use client";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_useAiHelp = require("../useAiHelp-h9yOLFqt.cjs");
+exports.useAiCoaching = require_useAiHelp.useAiCoaching;
+exports.useAiExplanation = require_useAiHelp.useAiExplanation;
+exports.useAiHints = require_useAiHelp.useAiHints;
+exports.useAiWritingFeedback = require_useAiHelp.useAiWritingFeedback;