npm package: @superbuilders/clr
Description: TypeScript SDK for CLR (Comprehensive Learner Record) API
Author: Speakeasy
Latest version: 0.0.2

# clr

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

<div align="left">
    <a href="https://www.speakeasy.com/?utm_source=clr&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
    <a href="https://opensource.org/licenses/MIT">
        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
    </a>
</div>


<br /><br />
> [!IMPORTANT]
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/emu-farm/timeback). Delete this section before > publishing to a package manager.

<!-- Start Summary [summary] -->
## 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.
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [clr](#clr)
  * [SDK Installation](#sdk-installation)
  * [Requirements](#requirements)
  * [SDK Example Usage](#sdk-example-usage)
  * [Authentication](#authentication)
  * [Available Resources and Operations](#available-resources-and-operations)
  * [Standalone functions](#standalone-functions)
  * [Retries](#retries)
  * [Error Handling](#error-handling)
  * [Server Selection](#server-selection)
  * [Custom HTTP Client](#custom-http-client)
  * [Debugging](#debugging)
* [Development](#development)
  * [Maturity](#maturity)
  * [Contributions](#contributions)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

> [!TIP]
> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).


The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.

### NPM

```bash
npm add <UNSET>
```

### PNPM

```bash
pnpm add <UNSET>
```

### Bun

```bash
bun add <UNSET>
```

### Yarn

```bash
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.

<details>
<summary>Claude installation steps</summary>

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

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

</details>

<details>
<summary>Cursor installation steps</summary>

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

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

</details>

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

```bash
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}"`.


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

For a full list of server arguments, run:

```sh
npx -y --package clr -- mcp start --help
```
<!-- End SDK Installation [installation] -->

<!-- Start Requirements [requirements] -->
## Requirements

For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
<!-- End Requirements [requirements] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```typescript
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();

```
<!-- End SDK Example Usage [usage] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name                          | Type   | Scheme                         | Environment Variable                                        |
| ----------------------------- | ------ | ------------------------------ | ----------------------------------------------------------- |
| `clientID`<br/>`clientSecret` | oauth2 | OAuth2 Client Credentials Flow | `CLR_CLIENT_ID`<br/>`CLR_CLIENT_SECRET`<br/>`CLR_TOKEN_URL` |

You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
```typescript
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:
```typescript
import { Clr } from "clr";

const clr = new Clr();

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

  console.log(result);
}

run();

```
<!-- End Authentication [security] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [assertionsManager](docs/sdks/assertionsmanager/README.md)

* [getAssertion](docs/sdks/assertionsmanager/README.md#getassertion) - The REST read request message for the getAssertion() API call.


### [clrsManager](docs/sdks/clrsmanager/README.md)

* [getClrs](docs/sdks/clrsmanager/README.md#getclrs) - The REST read request message for the getClrs() API call.
* [postClr](docs/sdks/clrsmanager/README.md#postclr) - The REST createbp request message for the postClr() API call.
* [deleteClr](docs/sdks/clrsmanager/README.md#deleteclr) - The REST delete request message for the deleteClr() API call.
* [getClr](docs/sdks/clrsmanager/README.md#getclr) - The REST read request message for the getClr() API call.

### [discoveryManager](docs/sdks/discoverymanager/README.md)

* [getDiscoveryDocument](docs/sdks/discoverymanager/README.md#getdiscoverydocument) - The REST read request message for the getDiscoveryDocument() API call.

### [endorsementsManager](docs/sdks/endorsementsmanager/README.md)

* [getEndorsement](docs/sdks/endorsementsmanager/README.md#getendorsement) - The REST read request message for the getEndorsement() API call.

### [keysManager](docs/sdks/keysmanager/README.md)

* [getKey](docs/sdks/keysmanager/README.md#getkey) - The REST read request message for the getKey() API call.

### [revocationsManager](docs/sdks/revocationsmanager/README.md)

* [getRevocationList](docs/sdks/revocationsmanager/README.md#getrevocationlist) - The REST read request message for the getRevocationList() API call.

</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start Standalone functions [standalone-funcs] -->
## 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](./FUNCTIONS.md).

<details>

<summary>Available standalone functions</summary>

- [`assertionsManagerGetAssertion`](docs/sdks/assertionsmanager/README.md#getassertion) - The REST read request message for the getAssertion() API call.
- [`clrsManagerDeleteClr`](docs/sdks/clrsmanager/README.md#deleteclr) - The REST delete request message for the deleteClr() API call.
- [`clrsManagerGetClr`](docs/sdks/clrsmanager/README.md#getclr) - The REST read request message for the getClr() API call.
- [`clrsManagerGetClrs`](docs/sdks/clrsmanager/README.md#getclrs) - The REST read request message for the getClrs() API call.
- [`clrsManagerPostClr`](docs/sdks/clrsmanager/README.md#postclr) - The REST createbp request message for the postClr() API call.
- [`discoveryManagerGetDiscoveryDocument`](docs/sdks/discoverymanager/README.md#getdiscoverydocument) - The REST read request message for the getDiscoveryDocument() API call.
- [`endorsementsManagerGetEndorsement`](docs/sdks/endorsementsmanager/README.md#getendorsement) - The REST read request message for the getEndorsement() API call.
- [`keysManagerGetKey`](docs/sdks/keysmanager/README.md#getkey) - The REST read request message for the getKey() API call.
- [`revocationsManagerGetRevocationList`](docs/sdks/revocationsmanager/README.md#getrevocationlist) - The REST read request message for the getRevocationList() API call.

</details>
<!-- End Standalone functions [standalone-funcs] -->

<!-- Start Retries [retries] -->
## 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:
```typescript
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:
```typescript
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();

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

[`ClrError`](./src/models/errors/clrerror.ts) 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](#error-classes). |

### Example
```typescript
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`](./src/models/errors/clrerror.ts): The base class for HTTP error responses.
  * [`ImsxStatusInfoDTypeError`](docs/models/errors/imsxstatusinfodtypeerror.md): This is the container for the status code and associated information returned within the HTTP messages received from the Service Provider.

<details><summary>Less common errors (6)</summary>

<br />

**Network errors:**
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.


**Inherit from [`ClrError`](./src/models/errors/clrerror.ts)**:
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): 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.

</details>
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## 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:
```typescript
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();

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/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:

```typescript
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 });
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Debugging [debug] -->
## 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.

```typescript
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.
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

# 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](https://www.speakeasy.com/?utm_source=clr&utm_campaign=typescript)