@intellectif/lk-core 1.2.0 → 1.3.0

package/dist/ai-check.d.ts

@@ -1,18 +1,18 @@
-import { F as AiExplanationRequest, M as AiHintRequest, a2 as AiWritingFeedbackRequest, j as AiCoachingRequest, s as AiCritiqueRequest, D as AiDraftsRequest, T as AiRefusal, X as AiTextResult, a1 as AiWritingFeedback, i as AiCoaching, n as AiCritique, B as AiDrafts } from './activity-D705CXng.js';
-
+import { B as AiRefusal, E as AiExplanationRequest, N as AiHintRequest, S as AiDrafts, W as AiTextResult, X as AiWritingFeedback, Z as AiWritingFeedbackRequest, a as AiCoachingRequest, i as AiCoaching, l as AiCritique, m as AiCritiqueRequest, w as AiDraftsRequest } from "./ai-B222dtHH.js";
+//#region src/ai-check/cases.d.ts
 /**
  * One call to make against a host's port, and what a learner was looking at
  * when the SDK would have made it.
  */
 interface AiCheckCase {
-    /** Stable across releases, so a host can name one in an allow-list or a report. */
-    id: string;
-    /** Which port the case is for. */
-    feature: 'explanation' | 'hint' | 'writing-feedback' | 'pronunciation-coaching' | 'item-critique' | 'draft-generation';
-    /** What the learner did, in a few words, for a report a person reads. */
-    about: string;
-    /** The request, built by the SDK exactly as a component builds it. */
-    request: AiExplanationRequest | AiHintRequest | AiWritingFeedbackRequest | AiCoachingRequest | AiCritiqueRequest | AiDraftsRequest;
+  /** Stable across releases, so a host can name one in an allow-list or a report. */
+  id: string;
+  /** Which port the case is for. */
+  feature: 'explanation' | 'hint' | 'writing-feedback' | 'pronunciation-coaching' | 'item-critique' | 'draft-generation';
+  /** What the learner did, in a few words, for a report a person reads. */
+  about: string;
+  /** The request, built by the SDK exactly as a component builds it. */
+  request: AiExplanationRequest | AiHintRequest | AiWritingFeedbackRequest | AiCoachingRequest | AiCritiqueRequest | AiDraftsRequest;
 }
 /**
  * The cases {@link runAiCheck} runs: every type the SDK explains, answered
@@ -26,8 +26,9 @@ interface AiCheckCase {
  * A fresh array each call, so a caller may filter, slice or add to it without
  * changing what the next caller gets.
  */
-declare function aiCheckCases(): AiCheckCase[];
-
+export declare function aiCheckCases(): AiCheckCase[];
+//#endregion
+//#region src/ai-check/index.d.ts
 /**
  * Your ports, as this kit calls them. The same functions
  * `<LkAiProvider ai={…}>` takes, minus the `AbortSignal` a browser passes —
@@ -35,75 +36,75 @@ declare function aiCheckCases(): AiCheckCase[];
  *
  * Leave one out and its cases are skipped rather than failed.
  */
-interface AiCheckPorts {
-    explain?(request: AiExplanationRequest): Promise<unknown> | unknown;
-    hint?(request: AiHintRequest): Promise<unknown> | unknown;
-    writingFeedback?(request: AiWritingFeedbackRequest): Promise<unknown> | unknown;
-    pronunciationCoaching?(request: AiCoachingRequest): Promise<unknown> | unknown;
-    /** Reviews an item for its author: the port an editor's "Review with AI" calls. */
-    critique?(request: AiCritiqueRequest): Promise<unknown> | unknown;
-    /** Drafts items from a source, for an author to approve. */
-    drafts?(request: AiDraftsRequest): Promise<unknown> | unknown;
+export interface AiCheckPorts {
+  explain?(request: AiExplanationRequest): Promise<unknown> | unknown;
+  hint?(request: AiHintRequest): Promise<unknown> | unknown;
+  writingFeedback?(request: AiWritingFeedbackRequest): Promise<unknown> | unknown;
+  pronunciationCoaching?(request: AiCoachingRequest): Promise<unknown> | unknown;
+  /** Reviews an item for its author: the port an editor's "Review with AI" calls. */
+  critique?(request: AiCritiqueRequest): Promise<unknown> | unknown;
+  /** Drafts items from a source, for an author to approve. */
+  drafts?(request: AiDraftsRequest): Promise<unknown> | unknown;
 }
 /** What happened on one case. */
-interface AiCheckResult {
-    case: AiCheckCase;
-    /** Whether a learner would have been shown what came back. */
-    ok: boolean;
-    /** Why it would not have been shown. */
-    refusal?: AiRefusal;
-    /** The port threw or rejected. Its message, as a string. */
-    error?: string;
-    /**
-     * What came back, once the SDK had read it — so a refusal can be read beside
-     * the text that caused it. Absent when the port failed or answered with
-     * nothing the SDK could read.
-     */
-    result?: AiTextResult;
-    /** For a writing case a learner would have been shown: the feedback, as the SDK accepted it. */
-    feedback?: AiWritingFeedback;
-    /** For a coaching case a learner would have been shown: the coaching, as the SDK accepted it. */
-    coaching?: AiCoaching;
-    /** For a critique case an author would have been shown: the findings, as the SDK accepted them. */
-    critique?: AiCritique;
-    /**
-     * For a drafts case the SDK read: the drafts, each with what `validateDraft`
-     * and the item critic say of it. A reply read is not a good one — check how
-     * many came back `complete` and without warnings.
-     */
-    drafts?: AiDrafts;
-    /** How long the call took, in milliseconds. */
-    ms: number;
+export interface AiCheckResult {
+  case: AiCheckCase;
+  /** Whether a learner would have been shown what came back. */
+  ok: boolean;
+  /** Why it would not have been shown. */
+  refusal?: AiRefusal;
+  /** The port threw or rejected. Its message, as a string. */
+  error?: string;
+  /**
+   * What came back, once the SDK had read it — so a refusal can be read beside
+   * the text that caused it. Absent when the port failed or answered with
+   * nothing the SDK could read.
+   */
+  result?: AiTextResult;
+  /** For a writing case a learner would have been shown: the feedback, as the SDK accepted it. */
+  feedback?: AiWritingFeedback;
+  /** For a coaching case a learner would have been shown: the coaching, as the SDK accepted it. */
+  coaching?: AiCoaching;
+  /** For a critique case an author would have been shown: the findings, as the SDK accepted them. */
+  critique?: AiCritique;
+  /**
+   * For a drafts case the SDK read: the drafts, each with what `validateDraft`
+   * and the item critic say of it. A reply read is not a good one — check how
+   * many came back `complete` and without warnings.
+   */
+  drafts?: AiDrafts;
+  /** How long the call took, in milliseconds. */
+  ms: number;
 }
 /** What a run came to. */
-interface AiCheckReport {
-    /** Cases run: the ones a port was supplied for. */
-    total: number;
-    /** Cases whose answer a learner would have been shown. */
-    shown: number;
-    /** Cases whose answer the SDK refused. */
-    refused: number;
-    /** Cases where the port itself failed. */
-    errors: number;
-    /** Cases skipped because no port was supplied for that feature. */
-    skipped: number;
-    /** How many refusals of each reason. */
-    byRefusal: Record<AiRefusal, number>;
-    results: AiCheckResult[];
+export interface AiCheckReport {
+  /** Cases run: the ones a port was supplied for. */
+  total: number;
+  /** Cases whose answer a learner would have been shown. */
+  shown: number;
+  /** Cases whose answer the SDK refused. */
+  refused: number;
+  /** Cases where the port itself failed. */
+  errors: number;
+  /** Cases skipped because no port was supplied for that feature. */
+  skipped: number;
+  /** How many refusals of each reason. */
+  byRefusal: Record<AiRefusal, number>;
+  results: AiCheckResult[];
 }
-interface AiCheckOptions {
-    /**
-     * The cases to run. Defaults to {@link aiCheckCases}. Pass a filtered list to
-     * run one type, or your own cases — built with `aiExplanationRequest` and
-     * `aiHintRequest` on your own items, which is how you test a prompt against
-     * the content your learners actually see.
-     */
-    cases?: readonly AiCheckCase[];
-    /**
-     * How many cases to have in flight at once. Default 1: a run in CI hits a
-     * rate limit far more often than it runs out of patience.
-     */
-    concurrency?: number;
+export interface AiCheckOptions {
+  /**
+   * The cases to run. Defaults to {@link aiCheckCases}. Pass a filtered list to
+   * run one type, or your own cases — built with `aiExplanationRequest` and
+   * `aiHintRequest` on your own items, which is how you test a prompt against
+   * the content your learners actually see.
+   */
+  cases?: readonly AiCheckCase[];
+  /**
+   * How many cases to have in flight at once. Default 1: a run in CI hits a
+   * rate limit far more often than it runs out of patience.
+   */
+  concurrency?: number;
 }
 /**
  * Calls your ports on every case and reports what a learner would have seen.
@@ -111,7 +112,7 @@ interface AiCheckOptions {
  * It never throws for a failing case: a port that rejects is an `error` in the
  * report, so one bad call cannot hide the rest.
  */
-declare function runAiCheck(ports: AiCheckPorts, options?: AiCheckOptions): Promise<AiCheckReport>;
+export declare function runAiCheck(ports: AiCheckPorts, options?: AiCheckOptions): Promise<AiCheckReport>;
 /**
  * The report as a few lines for a CI log: the counts, then every case that
  * failed, with what came back.
@@ -120,6 +121,7 @@ declare function runAiCheck(ports: AiCheckPorts, options?: AiCheckOptions): Prom
  * screen, and a hint that gives the answer away is only fixable if you can
  * read it.
  */
-declare function formatAiCheckReport(report: AiCheckReport): string;
-
-export { type AiCheckCase, type AiCheckOptions, type AiCheckPorts, type AiCheckReport, type AiCheckResult, aiCheckCases, formatAiCheckReport, runAiCheck };
+export declare function formatAiCheckReport(report: AiCheckReport): string;
+//#endregion
+export type { AiCheckCase };
+//# sourceMappingURL=ai-check.d.ts.map

package/dist/ai-check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-check.d.ts","names":[],"sources":["../src/ai-check/cases.ts","../src/ai-check/index.ts"],"mappings":";;;;;;UAyMiB;;EAEf;;EAEA;;EAQA;;EAEA,SACI,uBACA,gBACA,2BACA,oBACA,oBACA;;;;;;;;;;;;;;wBA+MU,gBAAgB;;;;;;;;;;iBCxWf;EACf,SAAS,SAAS,uBAAuB;EACzC,MAAM,SAAS,gBAAgB;EAC/B,iBAAiB,SAAS,2BAA2B;EACrD,uBAAuB,SAAS,oBAAoB;;EAEpD,UAAU,SAAS,oBAAoB;;EAEvC,QAAQ,SAAS,kBAAkB;;;iBAIpB;EACf,MAAM;;EAEN;;EAEA,UAAU;;EAEV;;;;;;EAMA,SAAS;;EAET,WAAW;;EAEX,WAAW;;EAEX,WAAW;;;;;;EAMX,SAAS;;EAET;;;iBAIe;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA,WAAW,OAAO;EAClB,SAAS;;iBAGM;;;;;;;EAOf,iBAAiB;;;;;EAKjB;;;;;;;;wBA4IoB,WACpB,OAAO,cACP,UAAS,iBACR,QAAQ;;;;;;;;;wBAwDK,oBAAoB,QAAQ"}