@intellectif/lk-core 0.2.0

package/dist/xapi.d.ts

@@ -0,0 +1,88 @@
+import { X as XAPIActor, i as ScoringResult, l as XAPIContext, o as XAPIResult, q as XAPIStatement } from './activity-D5tqgx8A.js';
+
+/**
+ * The set of xAPI verbs emitted by SDK activities, keyed by a stable
+ * identifier mapped to its canonical xAPI verb IRI (xAPI 1.0.3 / ADL registry).
+ */
+declare const XAPIVerb: {
+    readonly ANSWERED: "http://adlnet.gov/expapi/verbs/answered";
+    readonly COMPLETED: "http://adlnet.gov/expapi/verbs/completed";
+    readonly EXPERIENCED: "http://adlnet.gov/expapi/verbs/experienced";
+    readonly INTERACTED: "http://adlnet.gov/expapi/verbs/interacted";
+    readonly ATTEMPTED: "http://adlnet.gov/expapi/verbs/attempted";
+    readonly PASSED: "http://adlnet.gov/expapi/verbs/passed";
+    readonly FAILED: "http://adlnet.gov/expapi/verbs/failed";
+    readonly WATCHED: "https://w3id.org/xapi/video/verbs/watched";
+};
+/** Union of the valid `XAPIVerb` keys. */
+type XAPIVerbKey = keyof typeof XAPIVerb;
+/**
+ * Default `en-US` display label for each verb, used to populate
+ * `XAPIVerbObject.display` when the builder resolves a verb key.
+ */
+declare const XAPI_VERB_DISPLAY: Record<XAPIVerbKey, Record<string, string>>;
+
+/** Caller-supplied activity object descriptor (mapped to an xAPI Activity). */
+interface XAPIObjectParams {
+    /** Activity IRI. */
+    id: string;
+    name?: Record<string, string>;
+    description?: Record<string, string>;
+    /** Activity type IRI. */
+    type?: string;
+}
+/** Parameters for the generic {@link xAPIBuilder.buildStatement}. */
+interface XAPIStatementParams {
+    actor: XAPIActor;
+    verb: XAPIVerbKey;
+    object: XAPIObjectParams;
+    result?: XAPIResult;
+    context?: XAPIContext;
+}
+/** Parameters for {@link xAPIBuilder.buildAnsweredStatement} (verb = ANSWERED). */
+interface AnsweredStatementParams {
+    actor: XAPIActor;
+    object: XAPIObjectParams;
+    scoringResult: ScoringResult;
+    timeSpentMs: number;
+    /** Serialized learner response string. */
+    response?: string;
+    context?: XAPIContext;
+    resultExtensions?: Record<string, unknown>;
+}
+/** Parameters for {@link xAPIBuilder.buildCompletedStatement} (verb = COMPLETED). */
+interface CompletedStatementParams {
+    actor: XAPIActor;
+    object: XAPIObjectParams;
+    scoringResult?: ScoringResult;
+    timeSpentMs: number;
+    context?: XAPIContext;
+    resultExtensions?: Record<string, unknown>;
+}
+/**
+ * Constructs xAPI 1.0.3 Statements. Every call stamps a fresh UUID v4 `id`,
+ * an ISO 8601 `timestamp`, and `version: '1.0.3'`. Not pure by design —
+ * statements are unique events.
+ */
+declare const xAPIBuilder: {
+    buildStatement(params: XAPIStatementParams): XAPIStatement;
+    buildAnsweredStatement(params: AnsweredStatementParams): XAPIStatement;
+    buildCompletedStatement(params: CompletedStatementParams): XAPIStatement;
+};
+
+/**
+ * Validates a constructed {@link XAPIStatement} against the xAPI 1.0.3
+ * structural contract.
+ *
+ * In development a structural failure throws (caught early); in production it
+ * logs a warning and returns (the statement is still sent — see the design's
+ * Error Handling table). Uses a `zod/v4` schema rather than `ajv` + an
+ * external JSON Schema to keep `lk-core` dependency-free.
+ *
+ * NOTE: `ActivitySchemaError` is reused here per the task spec; its
+ * `activityType` field carries the sentinel `'xAPIStatement'`. A dedicated
+ * `XAPIValidationError` would be semantically cleaner — flagged for review.
+ */
+declare function validateXAPIStatement(statement: XAPIStatement): void;
+
+export { type AnsweredStatementParams, type CompletedStatementParams, type XAPIObjectParams, type XAPIStatementParams, XAPIVerb, type XAPIVerbKey, XAPI_VERB_DISPLAY, validateXAPIStatement, xAPIBuilder };

package/dist/xapi.js

@@ -0,0 +1,14 @@
+import {
+  XAPIVerb,
+  XAPI_VERB_DISPLAY,
+  validateXAPIStatement,
+  xAPIBuilder
+} from "./chunk-ZHOX6TO4.js";
+import "./chunk-6VOCV4EX.js";
+export {
+  XAPIVerb,
+  XAPI_VERB_DISPLAY,
+  validateXAPIStatement,
+  xAPIBuilder
+};
+//# sourceMappingURL=xapi.js.map

package/dist/xapi.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@intellectif/lk-core",
+  "version": "0.2.0",
+  "description": "Schemas, scoring engine, and xAPI builder for learning-kit",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./scoring": {
+      "types": "./dist/scoring.d.ts",
+      "import": "./dist/scoring.js",
+      "require": "./dist/scoring.cjs"
+    },
+    "./xapi": {
+      "types": "./dist/xapi.d.ts",
+      "import": "./dist/xapi.js",
+      "require": "./dist/xapi.cjs"
+    },
+    "./schemas": {
+      "types": "./dist/schemas.d.ts",
+      "import": "./dist/schemas.js",
+      "require": "./dist/schemas.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "zod": "^3.25.0"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.6",
+    "fast-check": "^3.22.0",
+    "tsup": "^8.3.0",
+    "vitest": "^4.1.6"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage",
+    "lint": "biome check ."
+  }
+}