clr

Developer-friendly & type-safe Typescript SDK specifically catered to leverage clr API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Comprehensive Learner Record Standard OpenAPI (YAML) Definition: The Comprehensive Learner Record Standard enables the exchange of data about users and their achievements between a Comprehensive Learner Record Standard provider and the consumers of the associated data. This standard has been described using the IMS Model Driven Specification development approach, this being the Platform Specific Model (PSM) of the service.

Table of Contents

• clr
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add <UNSET>

PNPM

pnpm add <UNSET>

Bun

bun add <UNSET>

Yarn

yarn add <UNSET> zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "Clr": {
      "command": "npx",
      "args": [
        "-y", "--package", "clr",
        "--",
        "mcp", "start",
        "--client-id", "...",
        "--client-secret", "...",
        "--token-url", "..."
      ]
    }
  }
}

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "Clr": {
      "command": "npx",
      "args": [
        "-y", "--package", "clr",
        "--",
        "mcp", "start",
        "--client-id", "...",
        "--client-secret", "...",
        "--token-url", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package clr -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Clr } from "clr";

const clr = new Clr({
  security: {
    clientID: process.env["CLR_CLIENT_ID"] ?? "",
    clientSecret: process.env["CLR_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await clr.assertionsManager.getAssertion({
    sourcedId: "<id>",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | ----------------------------- | ------ | ------------------------------ | ----------------------------------------------------------- | | clientIDclientSecret | oauth2 | OAuth2 Client Credentials Flow | CLR_CLIENT_IDCLR_CLIENT_SECRETCLR_TOKEN_URL |

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { Clr } from "clr";

const clr = new Clr({
  security: {
    clientID: process.env["CLR_CLIENT_ID"] ?? "",
    clientSecret: process.env["CLR_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await clr.assertionsManager.getAssertion({
    sourcedId: "<id>",
  });

  console.log(result);
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { Clr } from "clr";

const clr = new Clr();

async function run() {
  const result = await clr.clrsManager.getClrs({}, {});

  console.log(result);
}

run();

Available Resources and Operations

assertionsManager

• getAssertion - The REST read request message for the getAssertion() API call.

clrsManager

• getClrs - The REST read request message for the getClrs() API call.
• postClr - The REST createbp request message for the postClr() API call.
• deleteClr - The REST delete request message for the deleteClr() API call.
• getClr - The REST read request message for the getClr() API call.

discoveryManager

• getDiscoveryDocument - The REST read request message for the getDiscoveryDocument() API call.

endorsementsManager

• getEndorsement - The REST read request message for the getEndorsement() API call.

keysManager

• getKey - The REST read request message for the getKey() API call.

revocationsManager

• getRevocationList - The REST read request message for the getRevocationList() API call.

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• assertionsManagerGetAssertion - The REST read request message for the getAssertion() API call.
• clrsManagerDeleteClr - The REST delete request message for the deleteClr() API call.
• clrsManagerGetClr - The REST read request message for the getClr() API call.
• clrsManagerGetClrs - The REST read request message for the getClrs() API call.
• clrsManagerPostClr - The REST createbp request message for the postClr() API call.
• discoveryManagerGetDiscoveryDocument - The REST read request message for the getDiscoveryDocument() API call.
• endorsementsManagerGetEndorsement - The REST read request message for the getEndorsement() API call.
• keysManagerGetKey - The REST read request message for the getKey() API call.
• revocationsManagerGetRevocationList - The REST read request message for the getRevocationList() API call.

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Clr } from "clr";

const clr = new Clr({
  security: {
    clientID: process.env["CLR_CLIENT_ID"] ?? "",
    clientSecret: process.env["CLR_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await clr.assertionsManager.getAssertion({
    sourcedId: "<id>",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Clr } from "clr";

const clr = new Clr({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    clientID: process.env["CLR_CLIENT_ID"] ?? "",
    clientSecret: process.env["CLR_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await clr.assertionsManager.getAssertion({
    sourcedId: "<id>",
  });

  console.log(result);
}

run();

Error Handling

ClrError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Clr } from "clr";
import * as errors from "clr/models/errors";

const clr = new Clr({
  security: {
    clientID: process.env["CLR_CLIENT_ID"] ?? "",
    clientSecret: process.env["CLR_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  try {
    const result = await clr.assertionsManager.getAssertion({
      sourcedId: "<id>",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.ClrError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ImsxStatusInfoDTypeError) {
        console.log(error.data$.imsxCodeMajor); // models.ImsxCodeMajor
        console.log(error.data$.imsxSeverity); // models.ImsxSeverity
        console.log(error.data$.imsxDescription); // string
        console.log(error.data$.imsxCodeMinor); // models.ImsxCodeMinorDType
      }
    }
  }
}

run();

Error Classes

Primary errors:

• ClrError: The base class for HTTP error responses.
  • ImsxStatusInfoDTypeError: This is the container for the status code and associated information returned within the HTTP messages received from the Service Provider.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from ClrError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Clr } from "clr";

const clr = new Clr({
  serverURL: "https://www.imsglobal.org/ims/clr/v1p0/",
  security: {
    clientID: process.env["CLR_CLIENT_ID"] ?? "",
    clientSecret: process.env["CLR_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await clr.assertionsManager.getAssertion({
    sourcedId: "<id>",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Clr } from "clr";
import { HTTPClient } from "clr/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Clr({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Clr } from "clr";

const sdk = new Clr({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable CLR_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy