@lti-tool/core 0.9.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @lti-tool/core
+
+## 0.9.0
+
+### Minor Changes
+
+- 5257caa: Initial release of LTI Tool library
+  - Complete LTI 1.3 implementation with security validation
+  - Hono framework integration for serverless deployments
+  - DynamoDB storage adapter with caching
+  - In-memory storage adapter for development
+  - Cookie-free session management
+  - Assignment and Grade Services (AGS) support
+  - Deep Linking support
+  - Comprehensive TypeScript support

package/README.md

@@ -0,0 +1,60 @@
+# lti-tool core
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@lti-tool/core"><img alt="npm" src="https://img.shields.io/npm/dm/%40lti-tool%2Fcore?style=flat-square" /></a>
+  <a href="https://github.com/lti-tool/lti-tool/actions/workflows/release.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/lti-tool/lti-tool/ci.yml?style=flat-square&branch=dev" /></a>
+</p>
+<p align="center">Modern LTI 1.3 toolkit, built for TypeScript.</p>
+
+## Core Features
+
+- **LTI 1.3 OIDC Flow** - Complete authentication and launch verification
+- **Security** - JWT verification, nonce validation, replay attack prevention
+- **Assignment and Grade Services (AGS)** - Score submission to LMS
+- **Session Management** - Secure session creation and retrieval
+- **Client Management** - Platform and deployment configuration
+
+## Installation
+
+```bash
+npm install @lti-tool/core
+```
+
+## Quick Start
+
+```typescript
+import { LTITool } from '@lti-tool/core';
+
+const ltiTool = new LTITool({
+  stateSecret: new TextEncoder().encode('your-secret-key'),
+  keyPair, // Your RSA keypair
+  storage: new MemoryStorage(),
+});
+
+// Configure your LMS
+const clientId = await ltiTool.addClient({
+  /* ... */
+});
+await ltiTool.addDeployment(clientId, {
+  /* ... */
+});
+
+// Handle LTI flow
+const authUrl = await ltiTool.handleLogin(loginParams);
+const payload = await ltiTool.verifyLaunch(idToken, state);
+const session = await ltiTool.createSession(payload);
+```
+
+## Documentation
+
+- [API Reference](https://lti-tool.dev/docs) - (Coming soon) Complete API documentation
+- [Examples](https://github.com/lti-tool/lti-tool-examples) - (Coming soon) Working examples
+
+## Security
+
+Production security features
+
+- JWT signature verification using platform JWKS
+- Nonce validation prevents replay attacks
+- State verification prevents CSRF
+- Client ID and deployment validation

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './interfaces/index.js';
+export * from './schemas/index.js';
+export { LTITool } from './ltiTool.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './interfaces/index.js';
+export * from './schemas/index.js';
+export { LTITool } from './ltiTool.js';

package/dist/interfaces/index.d.ts

@@ -0,0 +1,7 @@
+export type { LTIClient } from './ltiClient.js';
+export type { LTIConfig } from './ltiConfig.js';
+export type { LTIDeployment } from './ltiDeployment.js';
+export type { LTILaunchConfig } from './ltiLaunchConfig.js';
+export type { LTISession } from './ltiSession.js';
+export type { LTIStorage } from './ltiStorage.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/interfaces/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/interfaces/index.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/jwks.d.ts

@@ -0,0 +1,18 @@
+/**
+ * JSON Web Key Set (JWKS) structure as defined by RFC 7517.
+ * Used to expose public keys for JWT signature verification.
+ */
+export interface JWKS {
+    /** Array of JSON Web Key (JWK) objects */
+    keys: Array<{
+        /** Key usage - typically 'sig' for signature verification */
+        use: string;
+        /** Algorithm intended for use with this key - typically 'RS256' for LTI */
+        alg: string;
+        /** Key identifier used to match keys in JWT headers */
+        kid: string;
+        /** Additional JWK parameters (kty, n, e, etc.) as defined by RFC 7517 */
+        [key: string]: unknown;
+    }>;
+}
+//# sourceMappingURL=jwks.d.ts.map

package/dist/interfaces/jwks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jwks.d.ts","sourceRoot":"","sources":["../../src/interfaces/jwks.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,0CAA0C;IAC1C,IAAI,EAAE,KAAK,CAAC;QACV,6DAA6D;QAC7D,GAAG,EAAE,MAAM,CAAC;QAEZ,2EAA2E;QAC3E,GAAG,EAAE,MAAM,CAAC;QAEZ,uDAAuD;QACvD,GAAG,EAAE,MAAM,CAAC;QAEZ,yEAAyE;QACzE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC,CAAC;CACJ"}

package/dist/interfaces/jwks.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/ltiClient.d.ts

@@ -0,0 +1,24 @@
+import type { LTIDeployment } from './ltiDeployment';
+/**
+ * Represents an LTI (Learning Tools Interoperability) platform configuration.
+ * Contains all necessary endpoints and identifiers for LTI 1.3 integration.
+ */
+export interface LTIClient {
+    /** Unique identifier for the client */
+    id: string;
+    /** human-readable name for the platform */
+    name: string;
+    /** Platform issuer (unique identifier) */
+    iss: string;
+    /** Your app's client ID on this platform */
+    clientId: string;
+    /** Platform's auth endpoint */
+    authUrl: string;
+    /** Platform's token endpoint */
+    tokenUrl: string;
+    /** Platform's JWKS endpoint */
+    jwksUrl: string;
+    /** Array of deployment IDs associated with this platform */
+    deployments: LTIDeployment[];
+}
+//# sourceMappingURL=ltiClient.d.ts.map

package/dist/interfaces/ltiClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ltiClient.d.ts","sourceRoot":"","sources":["../../src/interfaces/ltiClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,4DAA4D;IAC5D,WAAW,EAAE,aAAa,EAAE,CAAC;CAC9B"}

package/dist/interfaces/ltiClient.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/ltiConfig.d.ts

@@ -0,0 +1,26 @@
+import type { Logger } from 'pino';
+import type { LTIStorage } from './ltiStorage.js';
+/**
+ * Configuration object for initializing an LTI Tool instance.
+ * Contains cryptographic keys, secrets, and storage adapter.
+ */
+export interface LTIConfig {
+    /** Secret key used for signing state JWTs during OIDC flow (minimum 32 bytes recommended) */
+    stateSecret: Uint8Array;
+    /** RSA key pair for signing JWTs and providing JWKS endpoint */
+    keyPair: CryptoKeyPair;
+    /** Storage adapter for persisting platforms, sessions, and nonces */
+    storage: LTIStorage;
+    /** Optional pino logger */
+    logger?: Logger;
+    /** Security configuration options */
+    security?: {
+        /** Key ID for JWKS and JWT signing (defaults to 'main') */
+        keyId?: string;
+        /** State JWT expiration time in seconds (defaults to 600 = 10 minutes) */
+        stateExpirationSeconds?: number;
+        /** Nonce expiration time in seconds (defaults to 600 = 10 minutes) */
+        nonceExpirationSeconds?: number;
+    };
+}
+//# sourceMappingURL=ltiConfig.d.ts.map

package/dist/interfaces/ltiConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ltiConfig.d.ts","sourceRoot":"","sources":["../../src/interfaces/ltiConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAEnC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,6FAA6F;IAC7F,WAAW,EAAE,UAAU,CAAC;IAExB,gEAAgE;IAChE,OAAO,EAAE,aAAa,CAAC;IAEvB,qEAAqE;IACrE,OAAO,EAAE,UAAU,CAAC;IAEpB,2BAA2B;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,qCAAqC;IACrC,QAAQ,CAAC,EAAE;QACT,2DAA2D;QAC3D,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,0EAA0E;QAC1E,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAChC,sEAAsE;QACtE,sBAAsB,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;CACH"}

package/dist/interfaces/ltiConfig.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/ltiDeployment.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Represents a specific deployment of your LTI tool within a platform/LMS.
+ * Each platform can have multiple deployments (e.g., different courses, contexts).
+ */
+export interface LTIDeployment {
+    /** Internal stable UUID for this deployment configuration */
+    id: string;
+    /** LMS-provided deployment identifier used in LTI launch requests */
+    deploymentId: string;
+    /** Optional human-readable name for this deployment */
+    name?: string;
+    /** Optional description of what this deployment is used for */
+    description?: string;
+}
+//# sourceMappingURL=ltiDeployment.d.ts.map

package/dist/interfaces/ltiDeployment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ltiDeployment.d.ts","sourceRoot":"","sources":["../../src/interfaces/ltiDeployment.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,6DAA6D;IAC7D,EAAE,EAAE,MAAM,CAAC;IAEX,qEAAqE;IACrE,YAAY,EAAE,MAAM,CAAC;IAErB,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/interfaces/ltiDeployment.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/ltiLaunchConfig.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Configuration required for LTI 1.3 launch authentication flow.
+ * Contains platform endpoints and identifiers needed for OIDC authentication.
+ */
+export interface LTILaunchConfig {
+    /** Platform issuer URL that uniquely identifies the LMS */
+    iss: string;
+    /** OAuth2 client identifier assigned to your tool by the platform */
+    clientId: string;
+    /** Deployment identifier within the platform context */
+    deploymentId: string;
+    /** Platform's OIDC authentication endpoint URL */
+    authUrl: string;
+    /** Platform's OAuth2 token endpoint URL for service access */
+    tokenUrl: string;
+    /** Platform's JSON Web Key Set endpoint URL for JWT verification */
+    jwksUrl: string;
+}
+//# sourceMappingURL=ltiLaunchConfig.d.ts.map

package/dist/interfaces/ltiLaunchConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ltiLaunchConfig.d.ts","sourceRoot":"","sources":["../../src/interfaces/ltiLaunchConfig.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,2DAA2D;IAC3D,GAAG,EAAE,MAAM,CAAC;IAEZ,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IAEjB,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC;IAErB,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAEhB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAC;IAEjB,oEAAoE;IACpE,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/interfaces/ltiLaunchConfig.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/ltiSession.d.ts

@@ -0,0 +1,110 @@
+import type { JWTPayload } from 'jose';
+/**
+ * Represents an active LTI session containing user information, context data,
+ * and available services after successful launch verification.
+ */
+export interface LTISession {
+    /** Original JWT payload from the platform for reference */
+    jwtPayload: JWTPayload;
+    /** Unique session identifier (UUID) */
+    id: string;
+    /** User information extracted from LTI claims */
+    user: {
+        /** Unique user identifier from the platform */
+        id: string;
+        /** User's display name */
+        name?: string;
+        /** User's email address */
+        email?: string;
+        /** User's family/last name */
+        familyName?: string;
+        /** User's given/first name */
+        givenName?: string;
+        /** Array of LTI role URIs (e.g., 'http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor') */
+        roles: string[];
+    };
+    /** Course/context information */
+    context: {
+        /** Unique context identifier from the platform */
+        id: string;
+        /** Short context label (e.g., course code) */
+        label: string;
+        /** Full context title (e.g., course name) */
+        title: string;
+    };
+    /** Platform identification */
+    platform: {
+        /** Platform issuer URL */
+        issuer: string;
+        /** OAuth2 client identifier */
+        clientId: string;
+        /** Deployment identifier */
+        deploymentId: string;
+        /** Human-readable platform name */
+        name: string;
+    };
+    /** Launch target information */
+    launch: {
+        /** Target link URI where user should be directed */
+        target: string;
+    };
+    /** Resource link information (if applicable) */
+    resourceLink?: {
+        /** Unique resource link identifier */
+        id: string;
+        /** Resource link title */
+        title?: string;
+    };
+    /** Available LTI Advantage services */
+    services?: {
+        /** Assignment and Grade Services (AGS) configuration */
+        ags?: {
+            /** Single line item endpoint URL */
+            lineitem?: string;
+            /** Line items collection endpoint URL */
+            lineitems?: string;
+            /** Available AGS scopes */
+            scopes: string[];
+        };
+        /** Names and Role Provisioning Services (NRPS) configuration */
+        nrps?: {
+            /** Membership endpoint URL */
+            membershipUrl: string;
+            /** Supported NRPS versions */
+            versions: string[];
+        };
+        /** Deep Linking configuration */
+        deepLinking?: {
+            /** URL to return deep linking response */
+            returnUrl: string;
+            /** Accepted content types */
+            acceptTypes: string[];
+            /** Accepted presentation targets */
+            acceptPresentationDocumentTargets: string[];
+            /** Accepted media types */
+            acceptMediaTypes?: string;
+            /** Whether multiple items can be selected */
+            acceptMultiple: boolean;
+            /** Whether items should be auto-created */
+            autoCreate: boolean;
+            /** Platform-specific data to return */
+            data?: string;
+        };
+    };
+    /** Custom parameters passed from platform */
+    customParameters: Record<string, string>;
+    /** Convenience flags for role checking */
+    /** True if user has administrator privileges */
+    isAdmin: boolean;
+    /** True if user has instructor/teacher role */
+    isInstructor: boolean;
+    /** True if user has student/learner role */
+    isStudent: boolean;
+    /** True if Assignment and Grade Services are available */
+    isAssignmentAndGradesAvailable: boolean;
+    /** True if Deep Linking is available */
+    isDeepLinkingAvailable: boolean;
+    /** True if Names and Role Provisioning Services are available */
+    isNameAndRolesAvailable: boolean;
+}
+//# sourceMappingURL=ltiSession.d.ts.map

package/dist/interfaces/ltiSession.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ltiSession.d.ts","sourceRoot":"","sources":["../../src/interfaces/ltiSession.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,2DAA2D;IAC3D,UAAU,EAAE,UAAU,CAAC;IAEvB,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAC;IAEX,iDAAiD;IACjD,IAAI,EAAE;QACJ,+CAA+C;QAC/C,EAAE,EAAE,MAAM,CAAC;QACX,0BAA0B;QAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,2BAA2B;QAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,8BAA8B;QAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,8BAA8B;QAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,oGAAoG;QACpG,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IAEF,iCAAiC;IACjC,OAAO,EAAE;QACP,kDAAkD;QAClD,EAAE,EAAE,MAAM,CAAC;QACX,8CAA8C;QAC9C,KAAK,EAAE,MAAM,CAAC;QACd,6CAA6C;QAC7C,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IAEF,8BAA8B;IAC9B,QAAQ,EAAE;QACR,0BAA0B;QAC1B,MAAM,EAAE,MAAM,CAAC;QACf,+BAA+B;QAC/B,QAAQ,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,YAAY,EAAE,MAAM,CAAC;QACrB,mCAAmC;QACnC,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAEF,gCAAgC;IAChC,MAAM,EAAE;QACN,oDAAoD;QACpD,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF,gDAAgD;IAChD,YAAY,CAAC,EAAE;QACb,sCAAsC;QACtC,EAAE,EAAE,MAAM,CAAC;QACX,0BAA0B;QAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF,uCAAuC;IACvC,QAAQ,CAAC,EAAE;QACT,wDAAwD;QACxD,GAAG,CAAC,EAAE;YACJ,oCAAoC;YACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,yCAAyC;YACzC,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,2BAA2B;YAC3B,MAAM,EAAE,MAAM,EAAE,CAAC;SAClB,CAAC;QACF,gEAAgE;QAChE,IAAI,CAAC,EAAE;YACL,8BAA8B;YAC9B,aAAa,EAAE,MAAM,CAAC;YACtB,8BAA8B;YAC9B,QAAQ,EAAE,MAAM,EAAE,CAAC;SACpB,CAAC;QACF,iCAAiC;QACjC,WAAW,CAAC,EAAE;YACZ,0CAA0C;YAC1C,SAAS,EAAE,MAAM,CAAC;YAClB,6BAA6B;YAC7B,WAAW,EAAE,MAAM,EAAE,CAAC;YACtB,oCAAoC;YACpC,iCAAiC,EAAE,MAAM,EAAE,CAAC;YAC5C,2BAA2B;YAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAC1B,6CAA6C;YAC7C,cAAc,EAAE,OAAO,CAAC;YACxB,2CAA2C;YAC3C,UAAU,EAAE,OAAO,CAAC;YACpB,uCAAuC;YACvC,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IAEF,6CAA6C;IAC7C,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC,0CAA0C;IAC1C,gDAAgD;IAChD,OAAO,EAAE,OAAO,CAAC;IACjB,+CAA+C;IAC/C,YAAY,EAAE,OAAO,CAAC;IACtB,4CAA4C;IAC5C,SAAS,EAAE,OAAO,CAAC;IACnB,0DAA0D;IAC1D,8BAA8B,EAAE,OAAO,CAAC;IACxC,wCAAwC;IACxC,sBAAsB,EAAE,OAAO,CAAC;IAChC,iEAAiE;IACjE,uBAAuB,EAAE,OAAO,CAAC;CAClC"}

package/dist/interfaces/ltiSession.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/ltiStorage.d.ts

@@ -0,0 +1,122 @@
+import type { LTIClient } from './ltiClient.js';
+import type { LTIDeployment } from './ltiDeployment.js';
+import type { LTILaunchConfig } from './ltiLaunchConfig.js';
+import type { LTISession } from './ltiSession.js';
+/**
+ * Storage interface for persisting LTI Client configurations, user sessions, and security nonces.
+ * Implement this interface to use different storage backends (memory, database, Redis, etc.).
+ */
+export interface LTIStorage {
+    /**
+     * Retrieves all clients configured in the system.
+     *
+     * @returns Array of all client configurations
+     */
+    listClients(): Promise<Omit<LTIClient, 'deployments'>[]>;
+    /**
+     * Retrieves client configuration by its unique id.
+     *
+     * @param clientId - Unique client identifier
+     * @returns Client configuration if found, undefined otherwise
+     */
+    getClientById(clientId: string): Promise<LTIClient | undefined>;
+    /**
+     * Adds a new client configuration to storage.
+     *
+     * @param client - Partial client configuration object
+     */
+    addClient(client: Omit<LTIClient, 'id' | 'deployments'>): Promise<string>;
+    /**
+     * Updates an existing client configuration.
+     *
+     * @param clientId - Unique client identifier
+     * @param client - Partial client object with fields to update
+     */
+    updateClient(clientId: string, client: Partial<Omit<LTIClient, 'id' | 'deployments'>>): Promise<void>;
+    /**
+     * Removes a client configuration from storage.
+     *
+     * @param clientId - Unique client identifier
+     */
+    deleteClient(clientId: string): Promise<void>;
+    /**
+     * Lists all deployments for a specific client.
+     *
+     * @param clientId - Client identifier
+     * @returns Array of deployment configurations
+     */
+    listDeployments(clientId: string): Promise<LTIDeployment[]>;
+    /**
+     * Retrieves deployment configuration by client ID and deployment ID (admin use).
+     *
+     * @param clientId - Unique client identifier
+     * @param deploymentId - Deployment identifier
+     * @returns Deployment configuration if found, undefined otherwise
+     */
+    getDeployment(clientId: string, deploymentId: string): Promise<LTIDeployment | undefined>;
+    /**
+     * Adds a new deployment to an existing client.
+     *
+     * @param clientId - Client identifier
+     * @param deployment - Deployment configuration to add
+     */
+    addDeployment(clientId: string, deployment: Omit<LTIDeployment, 'id'>): Promise<string>;
+    /**
+     * Updates an existing deployment configuration.
+     * @param clientId - Client identifier
+     * @param deploymentId - Deployment identifier to update
+     * @param deployment - Partial deployment object with fields to update
+     */
+    updateDeployment(clientId: string, deploymentId: string, deployment: Partial<LTIDeployment>): Promise<void>;
+    /**
+     * Removes a deployment from a Client.
+     *
+     * @param clientId - Client identifier
+     * @param deploymentId - Deployment identifier to remove
+     */
+    deleteDeployment(clientId: string, deploymentId: string): Promise<void>;
+    /**
+     * Retrieves an active user session by session ID.
+     *
+     * @param sessionId - Unique session identifier (typically a UUID)
+     * @returns Session object if found and valid, undefined otherwise
+     */
+    getSession(sessionId: string): Promise<LTISession | undefined>;
+    /**
+     * Stores a new user session after successful LTI launch.
+     *
+     * @param session - Complete session object with user, context, and service data
+     * @returns The session ID for reference
+     */
+    addSession(session: LTISession): Promise<string>;
+    /**
+     * Stores a nonce with expiration time for replay attack prevention.
+     *
+     * @param nonce - Unique nonce value (typically a UUID)
+     * @param expiresAt - When this nonce should be considered expired
+     */
+    storeNonce(nonce: string, expiresAt: Date): Promise<void>;
+    /**
+     * Validates a nonce and marks it as used to prevent replay attacks.
+     *
+     * @param nonce - Nonce value to validate
+     * @returns true if nonce is valid and unused, false if already used or expired
+     */
+    validateNonce(nonce: string): Promise<boolean>;
+    /**
+     * Retrieves launch configuration for LTI authentication flow.
+     *
+     * @param iss - Platform issuer URL (identifies the LMS)
+     * @param clientId - OAuth2 client identifier for this tool
+     * @param deploymentId - Deployment identifier within the platform
+     * @returns Launch configuration if found, undefined otherwise
+     */
+    getLaunchConfig(iss: string, clientId: string, deploymentId: string): Promise<LTILaunchConfig | undefined>;
+    /**
+     * Stores launch configuration for platform authentication.
+     *
+     * @param launchConfig - Complete launch configuration with auth URLs and keys
+     */
+    saveLaunchConfig(launchConfig: LTILaunchConfig): Promise<void>;
+}
+//# sourceMappingURL=ltiStorage.d.ts.map

package/dist/interfaces/ltiStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ltiStorage.d.ts","sourceRoot":"","sources":["../../src/interfaces/ltiStorage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,UAAU;IAGzB;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;IAEzD;;;;;OAKG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,GAAG,aAAa,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1E;;;;;OAKG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,GAAG,aAAa,CAAC,CAAC,GACrD,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;OAIG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAI9C;;;;;OAKG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAE5D;;;;;;OAMG;IACH,aAAa,CACX,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAEtC;;;;;OAKG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAExF;;;;;OAKG;IACH,gBAAgB,CACd,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,GACjC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAIxE;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAE/D;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAIjD;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;;;OAKG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAI/C;;;;;;;OAOG;IACH,eAAe,CACb,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC;IAExC;;;;OAIG;IACH,gBAAgB,CAAC,YAAY,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE"}

package/dist/interfaces/ltiStorage.js

@@ -0,0 +1 @@
+export {};