@modulus-learning/lti 0.0.0-stage → 0.11.1

package/dist/messages/platform-originating/resource-link-launch-request.d.ts

@@ -0,0 +1,33 @@
+import { z } from 'zod';
+export declare const resourceLinkLaunchRequestSchema: z.ZodObject<{
+    iss: z.ZodString;
+    aud: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+    sub: z.ZodString;
+    exp: z.ZodNumber;
+    iat: z.ZodNumber;
+    nonce: z.ZodString;
+    azp: z.ZodOptional<z.ZodString>;
+    given_name: z.ZodOptional<z.ZodString>;
+    family_name: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    locale: z.ZodOptional<z.ZodString>;
+    "https://purl.imsglobal.org/spec/lti/claim/version": z.ZodLiteral<"1.3.0">;
+    "https://purl.imsglobal.org/spec/lti/claim/deployment_id": z.ZodString;
+    "https://purl.imsglobal.org/spec/lti/claim/target_link_uri": z.ZodString;
+    "https://purl.imsglobal.org/spec/lti/claim/roles": z.ZodArray<z.ZodString>;
+    "https://purl.imsglobal.org/spec/lti-ags/claim/endpoint": z.ZodOptional<z.ZodObject<{
+        lineitems: z.ZodOptional<z.ZodString>;
+        lineitem: z.ZodOptional<z.ZodString>;
+        scope: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
+    "https://purl.imsglobal.org/spec/lti/claim/custom": z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>>>;
+    "https://purl.imsglobal.org/spec/lti/claim/message_type": z.ZodLiteral<"LtiResourceLinkRequest">;
+    "https://purl.imsglobal.org/spec/lti/claim/resource_link": z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type ResourceLinkLaunchRequest = z.infer<typeof resourceLinkLaunchRequestSchema>;
+//# sourceMappingURL=resource-link-launch-request.d.ts.map

package/dist/messages/platform-originating/resource-link-launch-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-link-launch-request.d.ts","sourceRoot":"","sources":["../../../src/messages/platform-originating/resource-link-launch-request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAO1C,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA"}

package/dist/messages/platform-originating/resource-link-launch-request.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { CLAIM_MESSAGE_TYPE, CLAIM_RESOURCE_LINK } from '../../constants.js';
+import { baseMessageSchema } from './base-message.js';
+export const resourceLinkLaunchRequestSchema = baseMessageSchema.extend({
+    [CLAIM_MESSAGE_TYPE]: z.literal('LtiResourceLinkRequest'),
+    [CLAIM_RESOURCE_LINK]: z.object({
+        id: z.string(),
+        title: z.string().nullable().optional(),
+        description: z.string().nullable().optional(),
+    }),
+});

package/dist/messages/tool-originating/deep-linking-response.d.ts

@@ -0,0 +1,103 @@
+import { z } from 'zod';
+declare const contentItemSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"ltiResourceLink">;
+    url: z.ZodOptional<z.ZodURL>;
+    title: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+    thumbnail: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+    window: z.ZodOptional<z.ZodObject<{
+        targetName: z.ZodOptional<z.ZodString>;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+        windowFeatures: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    iframe: z.ZodOptional<z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+    custom: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    lineItem: z.ZodOptional<z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        scoreMaximum: z.ZodNumber;
+        resourceId: z.ZodOptional<z.ZodString>;
+        tag: z.ZodOptional<z.ZodString>;
+        gradesReleased: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    available: z.ZodOptional<z.ZodObject<{
+        startDateTime: z.ZodOptional<z.ZodISODateTime>;
+        endDateTime: z.ZodOptional<z.ZodISODateTime>;
+    }, z.core.$strip>>;
+    submission: z.ZodOptional<z.ZodObject<{
+        startDateTime: z.ZodOptional<z.ZodISODateTime>;
+        endDateTime: z.ZodOptional<z.ZodISODateTime>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], "type">;
+export declare const deepLinkingResponseSchema: z.ZodObject<{
+    iss: z.ZodString;
+    aud: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+    nonce: z.ZodString;
+    azp: z.ZodOptional<z.ZodString>;
+    "https://purl.imsglobal.org/spec/lti/claim/message_type": z.ZodLiteral<"LtiDeepLinkingResponse">;
+    "https://purl.imsglobal.org/spec/lti/claim/version": z.ZodLiteral<"1.3.0">;
+    "https://purl.imsglobal.org/spec/lti/claim/deployment_id": z.ZodString;
+    "https://purl.imsglobal.org/spec/lti-dl/claim/data": z.ZodOptional<z.ZodAny>;
+    "https://purl.imsglobal.org/spec/lti-dl/claim/content_items": z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"ltiResourceLink">;
+        url: z.ZodOptional<z.ZodURL>;
+        title: z.ZodOptional<z.ZodString>;
+        text: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodObject<{
+            url: z.ZodURL;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>>;
+        thumbnail: z.ZodOptional<z.ZodObject<{
+            url: z.ZodURL;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>>;
+        window: z.ZodOptional<z.ZodObject<{
+            targetName: z.ZodOptional<z.ZodString>;
+            width: z.ZodOptional<z.ZodNumber>;
+            height: z.ZodOptional<z.ZodNumber>;
+            windowFeatures: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        iframe: z.ZodOptional<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>>;
+        custom: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        lineItem: z.ZodOptional<z.ZodObject<{
+            label: z.ZodOptional<z.ZodString>;
+            scoreMaximum: z.ZodNumber;
+            resourceId: z.ZodOptional<z.ZodString>;
+            tag: z.ZodOptional<z.ZodString>;
+            gradesReleased: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        available: z.ZodOptional<z.ZodObject<{
+            startDateTime: z.ZodOptional<z.ZodISODateTime>;
+            endDateTime: z.ZodOptional<z.ZodISODateTime>;
+        }, z.core.$strip>>;
+        submission: z.ZodOptional<z.ZodObject<{
+            startDateTime: z.ZodOptional<z.ZodISODateTime>;
+            endDateTime: z.ZodOptional<z.ZodISODateTime>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>], "type">>>;
+    "https://purl.imsglobal.org/spec/lti-dl/claim/msg": z.ZodOptional<z.ZodString>;
+    "https://purl.imsglobal.org/spec/lti-dl/claim/log": z.ZodOptional<z.ZodString>;
+    "https://purl.imsglobal.org/spec/lti-dl/claim/errormsg": z.ZodOptional<z.ZodString>;
+    "https://purl.imsglobal.org/spec/lti-dl/claim/errorlog": z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type DeepLinkingResponse = z.infer<typeof deepLinkingResponseSchema>;
+export type DeepLinkingContentItem = z.infer<typeof contentItemSchema>;
+export {};
+//# sourceMappingURL=deep-linking-response.d.ts.map

package/dist/messages/tool-originating/deep-linking-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deep-linking-response.d.ts","sourceRoot":"","sources":["../../../src/messages/tool-originating/deep-linking-response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAkEvB,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAAqD,CAAA;AAE5E,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiBpC,CAAA;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC3E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA"}

package/dist/messages/tool-originating/deep-linking-response.js

@@ -0,0 +1,60 @@
+import { z } from 'zod';
+import { CLAIM_DEEP_LINKING_CONTENT, CLAIM_DEEP_LINKING_DATA, CLAIM_DEEP_LINKING_ERRORLOG, CLAIM_DEEP_LINKING_ERRORMSG, CLAIM_DEEP_LINKING_LOG, CLAIM_DEEP_LINKING_MSG, CLAIM_DEPLOYMENT_ID, CLAIM_MESSAGE_TYPE, CLAIM_VERSION, } from '../../constants.js';
+const imageUrlSchema = z.object({
+    url: z.url(),
+    width: z.number().int(),
+    height: z.number().int(),
+});
+const resourceLinkSchema = z.object({
+    type: z.literal('ltiResourceLink'),
+    url: z.optional(z.url()),
+    title: z.optional(z.string()),
+    text: z.optional(z.string()),
+    icon: z.optional(imageUrlSchema),
+    thumbnail: z.optional(imageUrlSchema),
+    window: z.optional(z.object({
+        targetName: z.optional(z.string()),
+        width: z.optional(z.number().int()),
+        height: z.optional(z.number().int()),
+        windowFeatures: z.optional(z.string()),
+    })),
+    iframe: z.optional(z.object({
+        width: z.number().int(),
+        height: z.number().int(),
+    })),
+    custom: z.optional(z.record(z.string(), z.string())),
+    lineItem: z.optional(z.object({
+        label: z.optional(z.string()),
+        scoreMaximum: z.number(),
+        resourceId: z.optional(z.string()),
+        tag: z.optional(z.string()),
+        gradesReleased: z.optional(z.boolean()),
+    })),
+    available: z.optional(z.object({
+        startDateTime: z.optional(z.iso.datetime()),
+        endDateTime: z.optional(z.iso.datetime()),
+    })),
+    submission: z.optional(z.object({
+        startDateTime: z.optional(z.iso.datetime()),
+        endDateTime: z.optional(z.iso.datetime()),
+    })),
+});
+// TODO: Other content item types if we need them.
+const contentItemSchema = z.discriminatedUnion('type', [resourceLinkSchema]);
+export const deepLinkingResponseSchema = z.object({
+    iss: z.string(),
+    aud: z.union([z.string(), z.array(z.string())]),
+    // exp: z.number(),
+    // iat: z.number(),
+    nonce: z.string(),
+    azp: z.string().optional(),
+    [CLAIM_MESSAGE_TYPE]: z.literal('LtiDeepLinkingResponse'),
+    [CLAIM_VERSION]: z.literal('1.3.0'),
+    [CLAIM_DEPLOYMENT_ID]: z.string(),
+    [CLAIM_DEEP_LINKING_DATA]: z.optional(z.any()),
+    [CLAIM_DEEP_LINKING_CONTENT]: z.optional(z.array(contentItemSchema)),
+    [CLAIM_DEEP_LINKING_MSG]: z.optional(z.string()),
+    [CLAIM_DEEP_LINKING_LOG]: z.optional(z.string()),
+    [CLAIM_DEEP_LINKING_ERRORMSG]: z.optional(z.string()),
+    [CLAIM_DEEP_LINKING_ERRORLOG]: z.optional(z.string()),
+});

package/dist/score.d.ts

@@ -0,0 +1,84 @@
+import type { AccessToken, AccessTokenResult } from './access-token.js';
+/**
+ * Score passback (LTI Assignment and Grade Services, AGS): the outcome
+ * categories every adapter's client reports, and the client interface core's
+ * submission queue drives. The categories' meaning belongs to this contract;
+ * recognising a vendor's responses as one of them belongs to the adapter.
+ */
+export type SubmissionErrorCategory = 
+/** A newer score already reached the line item. */
+'superseded'
+/** The line item no longer exists; stop sending to it. */
+ | 'lineitem_dead'
+/** Retry later; nothing is wrong with the request. */
+ | 'transient'
+/** The registration or tool configuration is wrong. */
+ | 'platform_config'
+/** The access token was rejected. */
+ | 'platform_token'
+/** The platform is throttling. */
+ | 'rate_limit'
+/** The request itself was invalid. */
+ | 'malformed'
+/** Not recognised; follows the default failure policy. */
+ | 'unknown';
+export type SubmissionResult = {
+    ok: true;
+} | {
+    ok: false;
+    category: SubmissionErrorCategory;
+    description: string;
+    status?: number;
+    text?: string;
+};
+export type PublishScoreInput = {
+    lineitemUrl: string;
+    ltiUserId: string;
+    scoreGiven: number;
+};
+export type PublishScoreOutcome = {
+    result: SubmissionResult;
+    /**
+     * The response's scheduling signal for the adapter's own pacing policy.
+     * Opaque to core, which only passes it on.
+     */
+    reading?: unknown;
+};
+/**
+ * The transport for one registration's AGS requests: acquiring the access
+ * token, speaking the wire format, and classifying the response.
+ */
+export interface LtiAgsClient {
+    readonly issuer: string;
+    publishScore(input: PublishScoreInput): Promise<PublishScoreOutcome>;
+}
+/** An LMS registration, as plain values (core's registration record satisfies it). */
+export type LtiRegistration = {
+    id: string;
+    issuer: string;
+    name: string;
+    client_id: string;
+    authorization_endpoint: string;
+    token_endpoint: string;
+    jwks_uri: string;
+    authorization_server: string;
+};
+/**
+ * The registration values a platform connection is built from. Two snapshots of
+ * one registration with different fingerprints must not share cached tokens or
+ * score clients: a corrected client id or endpoint takes effect on the next use.
+ */
+export declare const registrationFingerprint: (registration: LtiRegistration) => string;
+/** Where a score client obtains, and returns rejected, access tokens. */
+export interface AccessTokenSource {
+    getAccessToken(registration: LtiRegistration): Promise<AccessTokenResult>;
+    invalidateAccessToken(registration: LtiRegistration, accessToken: AccessToken): void;
+}
+/** The logging an adapter may do: structured data plus a message. */
+export interface LtiLogger {
+    debug(data: Record<string, unknown>, message?: string): void;
+    info(data: Record<string, unknown>, message?: string): void;
+    warn(data: Record<string, unknown>, message?: string): void;
+    error(data: Record<string, unknown>, message?: string): void;
+}
+//# sourceMappingURL=score.d.ts.map

package/dist/score.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"score.d.ts","sourceRoot":"","sources":["../src/score.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAEvE;;;;;GAKG;AAEH,MAAM,MAAM,uBAAuB;AACjC,mDAAmD;AACjD,YAAY;AACd,0DAA0D;GACxD,eAAe;AACjB,sDAAsD;GACpD,WAAW;AACb,uDAAuD;GACrD,iBAAiB;AACnB,qCAAqC;GACnC,gBAAgB;AAClB,kCAAkC;GAChC,YAAY;AACd,sCAAsC;GACpC,WAAW;AACb,0DAA0D;GACxD,SAAS,CAAA;AAEb,MAAM,MAAM,gBAAgB,GACxB;IACE,EAAE,EAAE,IAAI,CAAA;CACT,GACD;IACE,EAAE,EAAE,KAAK,CAAA;IACT,QAAQ,EAAE,uBAAuB,CAAA;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAEL,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,gBAAgB,CAAA;IACxB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;CACrE;AAED,sFAAsF;AACtF,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,sBAAsB,EAAE,MAAM,CAAA;IAC9B,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,EAAE,MAAM,CAAA;CAC7B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,iBAAkB,eAAe,KAAG,MAQpE,CAAA;AAEJ,yEAAyE;AACzE,MAAM,WAAW,iBAAiB;IAChC,cAAc,CAAC,YAAY,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACzE,qBAAqB,CAAC,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,GAAG,IAAI,CAAA;CACrF;AAED,qEAAqE;AACrE,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5D,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3D,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3D,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7D"}

package/dist/score.js

@@ -0,0 +1,13 @@
+/**
+ * The registration values a platform connection is built from. Two snapshots of
+ * one registration with different fingerprints must not share cached tokens or
+ * score clients: a corrected client id or endpoint takes effect on the next use.
+ */
+export const registrationFingerprint = (registration) => JSON.stringify([
+    registration.issuer,
+    registration.client_id,
+    registration.authorization_endpoint,
+    registration.token_endpoint,
+    registration.jwks_uri,
+    registration.authorization_server,
+]);

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@modulus-learning/lti",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.11.1",
+  "private": false,
+  "description": "Shared LTI 1.3 vocabulary and the Modulus LMS adapter contract",
+  "license": "AGPL-3.0-only",
+  "type": "module",
+  "homepage": "https://github.com/Modulus-Learning/app.modulus-learning.org",
+  "bugs": {
+    "url": "https://github.com/Modulus-Learning/app.modulus-learning.org/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Modulus-Learning/app.modulus-learning.org.git",
+    "directory": "packages/lti"
+  },
+  "engines": {
+    "node": "^22.18.0 || ^24.11.0 || >=26.0.0"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "zod": "^4.6.7"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.6.4",
+    "@types/node": "^26.6.6",
+    "tsx": "^4.23.15",
+    "typescript": "^7.0.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rm -rf node_modules dist .turbo",
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "dev": "tsc -p tsconfig.build.json --watch",
+    "lint": "biome check --write --diagnostic-level=error",
+    "typecheck": "tsc --noEmit",
+    "test": "LOG_LEVEL=off tsx --test $(find src -name \"*.test.ts\")"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.