@lessonkit/xapi 0.1.0

package/README.md

@@ -0,0 +1,25 @@
+# `@lessonkit/xapi`
+
+xAPI statement generation primitives.
+
+## Install
+
+```bash
+npm install @lessonkit/xapi
+```
+
+## Quick example
+
+```ts
+import { createXAPIClient } from "@lessonkit/xapi";
+
+const xapi = createXAPIClient({
+  transport: (statement) => {
+    // Send to your LRS (or queue offline).
+    console.log(statement);
+  },
+});
+
+xapi.completeLesson({ lessonId: "phishing-101" });
+```
+

package/dist/index.cjs

@@ -0,0 +1,64 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createXAPIClient: () => createXAPIClient
+});
+module.exports = __toCommonJS(index_exports);
+var import_core = require("@lessonkit/core");
+function createXAPIClient(opts) {
+  const transport = opts?.transport;
+  const baseId = opts?.baseId ?? "urn:lessonkit";
+  return {
+    send: (statement) => {
+      void transport?.(statement);
+    },
+    startedLesson: ({ lessonId }) => {
+      const statement = statementFor(`${baseId}:lesson:${lessonId}`, "started");
+      void transport?.(statement);
+    },
+    completeLesson: ({ lessonId }) => {
+      const statement = statementFor(`${baseId}:lesson:${lessonId}`, "completed");
+      void transport?.(statement);
+    },
+    completeCourse: () => {
+      const statement = statementFor(`${baseId}:course`, "completed");
+      void transport?.(statement);
+    }
+  };
+}
+function statementFor(objectId, verb) {
+  return {
+    id: cryptoRandomId(),
+    timestamp: (0, import_core.nowIso)(),
+    verb,
+    object: { id: objectId }
+  };
+}
+function cryptoRandomId() {
+  const g = globalThis;
+  if (g.crypto?.randomUUID) return g.crypto.randomUUID();
+  return Math.random().toString(16).slice(2);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createXAPIClient
+});

package/dist/index.d.cts

@@ -0,0 +1,30 @@
+import { LessonId } from '@lessonkit/core';
+
+type XAPIStatement = {
+    id: string;
+    timestamp: string;
+    verb: string;
+    object: {
+        id: string;
+        definition?: Record<string, unknown>;
+    };
+    result?: Record<string, unknown>;
+    context?: Record<string, unknown>;
+};
+type XAPITransport = (statement: XAPIStatement) => void | Promise<void>;
+type XAPIClient = {
+    send: (statement: XAPIStatement) => void;
+    completeLesson: (opts: {
+        lessonId: LessonId;
+    }) => void;
+    startedLesson: (opts: {
+        lessonId: LessonId;
+    }) => void;
+    completeCourse: (opts: {}) => void;
+};
+declare function createXAPIClient(opts?: {
+    transport?: XAPITransport;
+    baseId?: string;
+}): XAPIClient;
+
+export { type XAPIClient, type XAPIStatement, type XAPITransport, createXAPIClient };

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import { LessonId } from '@lessonkit/core';
+
+type XAPIStatement = {
+    id: string;
+    timestamp: string;
+    verb: string;
+    object: {
+        id: string;
+        definition?: Record<string, unknown>;
+    };
+    result?: Record<string, unknown>;
+    context?: Record<string, unknown>;
+};
+type XAPITransport = (statement: XAPIStatement) => void | Promise<void>;
+type XAPIClient = {
+    send: (statement: XAPIStatement) => void;
+    completeLesson: (opts: {
+        lessonId: LessonId;
+    }) => void;
+    startedLesson: (opts: {
+        lessonId: LessonId;
+    }) => void;
+    completeCourse: (opts: {}) => void;
+};
+declare function createXAPIClient(opts?: {
+    transport?: XAPITransport;
+    baseId?: string;
+}): XAPIClient;
+
+export { type XAPIClient, type XAPIStatement, type XAPITransport, createXAPIClient };

package/dist/index.js

@@ -0,0 +1,39 @@
+// src/index.ts
+import { nowIso } from "@lessonkit/core";
+function createXAPIClient(opts) {
+  const transport = opts?.transport;
+  const baseId = opts?.baseId ?? "urn:lessonkit";
+  return {
+    send: (statement) => {
+      void transport?.(statement);
+    },
+    startedLesson: ({ lessonId }) => {
+      const statement = statementFor(`${baseId}:lesson:${lessonId}`, "started");
+      void transport?.(statement);
+    },
+    completeLesson: ({ lessonId }) => {
+      const statement = statementFor(`${baseId}:lesson:${lessonId}`, "completed");
+      void transport?.(statement);
+    },
+    completeCourse: () => {
+      const statement = statementFor(`${baseId}:course`, "completed");
+      void transport?.(statement);
+    }
+  };
+}
+function statementFor(objectId, verb) {
+  return {
+    id: cryptoRandomId(),
+    timestamp: nowIso(),
+    verb,
+    object: { id: objectId }
+  };
+}
+function cryptoRandomId() {
+  const g = globalThis;
+  if (g.crypto?.randomUUID) return g.crypto.randomUUID();
+  return Math.random().toString(16).slice(2);
+}
+export {
+  createXAPIClient
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@lessonkit/xapi",
+  "version": "0.1.0",
+  "private": false,
+  "description": "xAPI statement generation primitives for LessonKit.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eddiethedean/lessonkit.git",
+    "directory": "packages/xapi"
+  },
+  "homepage": "https://github.com/eddiethedean/lessonkit",
+  "bugs": {
+    "url": "https://github.com/eddiethedean/lessonkit/issues"
+  },
+  "keywords": [
+    "lessonkit",
+    "xapi",
+    "tincan",
+    "learning",
+    "training",
+    "lrs"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "dev": "tsup src/index.ts --format esm,cjs --dts --watch",
+    "prepublishOnly": "npm run build",
+    "typecheck": "tsc -p tsconfig.json",
+    "test": "vitest run --passWithNoTests",
+    "lint": "echo \"(no lint configured yet)\""
+  },
+  "dependencies": {
+    "@lessonkit/core": "0.1.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4"
+  }
+}