@superbuilders/powerpath

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @superbuilders/powerpath 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

PowerPath API: TimeBack PowerPath 100 API

Authentication

All endpoints require authentication using the Authorization: Bearer header.

The token can be obtained with:

``
curl -X POST https://alpha-auth-production-idp.auth.us-west-2.amazoncognito.com/oauth2/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials&client_id=&client_secret="
`

Use the correct IDP server depending on the environment you're using:

- Production Server:

https://alpha-auth-production-idp.auth.us-west-2.amazoncognito.com
- Staging Server:

https://alpha-auth-development-idp.auth.us-west-2.amazoncognito.com

Reach out to the platform team to get a client/secret pair for your application.

Pagination

Our API uses offset pagination for list endpoints. Paginated responses include the following fields:

- offset: Offset for the next page of results
- limit: Number of items per page (default: 100)

Example request:

`
GET /ims/oneroster/rostering/v1p2/users?offset=20&limit=20
`

All listing endpoints support offset pagination.

Filtering

All listing endpoints support filtering using the filter query parameter, following 1EdTech's filtering specification.

The filter should be a string with the following format:

`
?filter=[field][operator][value]
`

Example request:

`
GET /ims/oneroster/rostering/v1p2/users?filter=status='active'
`

Example request with multiple filters:

`
GET /ims/oneroster/rostering/v1p2/users?filter=status='active' AND name='John'
`

Filtering by nested relations is not supported.

Sorting

All listing endpoints support sorting using the sort and orderBy query parameters, following 1EdTech's sorting specification

Example request:

`
GET /ims/oneroster/rostering/v1p2/users?sort=lastName&orderBy=asc
`





Table of Contents

* @superbuilders/powerpath
* Authentication
* Pagination
* Filtering
* Sorting
* 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

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

$3

`bash
npm add @superbuilders/powerpath
`

$3

`bash
pnpm add @superbuilders/powerpath
`

$3

`bash
bun add @superbuilders/powerpath
`

$3

`bash
yarn add @superbuilders/powerpath 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.

$3

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.

Claude installation steps

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

`json
{
"mcpServers": {
"PowerPath": {
"command": "npx",
"args": [
"-y", "--package", "@superbuilders/powerpath",
"--",
"mcp", "start",
"--client-id", "...",
"--client-secret", "...",
"--token-url", "..."
]
}
}
}
`

Cursor installation steps

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

`json
{
"mcpServers": {
"PowerPath": {
"command": "npx",
"args": [
"-y", "--package", "@superbuilders/powerpath",
"--",
"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:

`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 @superbuilders/powerpath -- mcp start --help
`





Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.





SDK Example Usage

$3

`typescript
import { PowerPath } from "@superbuilders/powerpath";

const powerPath = new PowerPath({
security: {
clientID: process.env["POWERPATH_CLIENT_ID"] ?? "",
clientSecret: process.env["POWERPATH_CLIENT_SECRET"] ?? "",
},
});

async function run() {
const result = await powerPath.powerPathPlacement.getAllPlacementTests({
student: "",
subject: "",
});

console.log(result);
}

run();

`





Authentication

$3

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable |
| ----------------------------- | ------ | ------------------------------ | ----------------------------------------------------------------------------- |
| clientID
clientSecret | oauth2 | OAuth2 Client Credentials Flow | POWERPATH_CLIENT_ID
POWERPATH_CLIENT_SECRET
POWERPATH_TOKEN_URL |

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:
`typescript
import { PowerPath } from "@superbuilders/powerpath";

const powerPath = new PowerPath({
security: {
clientID: process.env["POWERPATH_CLIENT_ID"] ?? "",
clientSecret: process.env["POWERPATH_CLIENT_SECRET"] ?? "",
},
});

async function run() {
const result = await powerPath.powerPathPlacement.getAllPlacementTests({
student: "",
subject: "",
});

console.log(result);
}

run();

`





Available Resources and Operations

Available methods

$3

* getStudentCourseProgress - Get course progress
* updateStudentResponse - Update student item response
* getSyllabus - Get course syllabus

$3

* createAttempt - Create new attempt
* finalizeResponse - Finalize a test assessments
* getProgress - Get assessment progress
* getAttempts - Get all attempts
* getNextQuestion - Get next question
* resetAttempt - Reset attempt
* updateStudentResponse - Update student question response

$3

* createExternalPlacementTest - Create an External Placement Test
* createExternalTestOut - Create an External TestOut
* importExternalTestAssignmentResults - Import external test assignment results
* makeExternalTestAssignment - Make external test assignment
* testOut - Test out

$3

* createLessonPlan - Create a lesson plan
* getTree - Returns the lesson plan tree for a course and student
* deleteLessonPlan - Delete a lesson plan
* attachComponent - Create a lesson plan item to attach a component to a lesson plan
* attachResource - Create a lesson plan item to attach a resource to a lesson plan
* updateLessonPlanItem - Update a lesson plan item
* deleteLessonPlanItem - Delete a lesson plan item

$3

* getAllPlacementTests - Get all placement tests
* getCurrentLevel - Get current level
* getNextPlacementTest - Get next placement test
* getSubjectProgress - Get subject progress

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.

Available standalone functions

- lessonPlansGetStudentCourseProgress - Get course progress
- lessonPlansGetSyllabus - Get course syllabus
- lessonPlansUpdateStudentResponse - Update student item response
- lessonsCreateAttempt - Create new attempt
- lessonsFinalizeResponse - Finalize a test assessments
- lessonsGetAttempts - Get all attempts
- lessonsGetNextQuestion - Get next question
- lessonsGetProgress - Get assessment progress
- lessonsResetAttempt - Reset attempt
- lessonsUpdateStudentResponse - Update student question response
- powerPathCourseMasteryCreateExternalPlacementTest - Create an External Placement Test
- powerPathCourseMasteryCreateExternalTestOut - Create an External TestOut
- powerPathCourseMasteryImportExternalTestAssignmentResults - Import external test assignment results
- powerPathCourseMasteryMakeExternalTestAssignment - Make external test assignment
- powerPathCourseMasteryTestOut - Test out
- powerPathLessonPlansAttachComponent - Create a lesson plan item to attach a component to a lesson plan
- powerPathLessonPlansAttachResource - Create a lesson plan item to attach a resource to a lesson plan
- powerPathLessonPlansCreateLessonPlan - Create a lesson plan
- powerPathLessonPlansDeleteLessonPlan - Delete a lesson plan
- powerPathLessonPlansDeleteLessonPlanItem - Delete a lesson plan item
- powerPathLessonPlansGetTree - Returns the lesson plan tree for a course and student
- powerPathLessonPlansUpdateLessonPlanItem - Update a lesson plan item
- powerPathPlacementGetAllPlacementTests - Get all placement tests
- powerPathPlacementGetCurrentLevel - Get current level
- powerPathPlacementGetNextPlacementTest - Get next placement test
- powerPathPlacementGetSubjectProgress - Get subject progress

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 { PowerPath } from "@superbuilders/powerpath";

const powerPath = new PowerPath({
security: {
clientID: process.env["POWERPATH_CLIENT_ID"] ?? "",
clientSecret: process.env["POWERPATH_CLIENT_SECRET"] ?? "",
},
});

async function run() {
const result = await powerPath.powerPathPlacement.getAllPlacementTests({
student: "",
subject: "",
}, {
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 { PowerPath } from "@superbuilders/powerpath";

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

async function run() {
const result = await powerPath.powerPathPlacement.getAllPlacementTests({
student: "",
subject: "",
});

console.log(result);
}

run();

`





Error Handling

PowerPathError 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. |

$3


`typescript
import { PowerPath } from "@superbuilders/powerpath";
import * as errors from "@superbuilders/powerpath/models/errors";

const powerPath = new PowerPath({
security: {
clientID: process.env["POWERPATH_CLIENT_ID"] ?? "",
clientSecret: process.env["POWERPATH_CLIENT_SECRET"] ?? "",
},
});

async function run() {
try {
const result = await powerPath.powerPathPlacement.getAllPlacementTests({
student: "",
subject: "",
});

console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.PowerPathError) {
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.BadRequestResponseError) {
console.log(error.data$.imsxCodeMajor); // string
console.log(error.data$.imsxSeverity); // string
console.log(error.data$.imsxDescription); // string
console.log(error.data$.imsxCodeMinor); // errors.BadRequestResponseImsxCodeMinor
console.log(error.data$.imsxErrorDetails); // { [k: string]: string }[]
}
}
}
}

run();

`

$3


Primary errors:
* PowerPathError: The base class for HTTP error responses.
* UnauthorizedRequestResponseError: Unauthorized. Status code 401.
* ForbiddenResponseError: Forbidden. Status code 403.

Less common errors (11)

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 PowerPathError:
BadRequestResponseError: Bad Request. Status code 400. Applicable to 19 of 26 methods.
NotFoundResponseError: Not Found. Status code 404. Applicable to 19 of 26 methods.
UnprocessableEntityResponseError: Unprocessable Entity / Validation Error. Status code 422. Applicable to 19 of 26 methods.
TooManyRequestsResponseError: Too Many Requests. Status code 429. Applicable to 19 of 26 methods.
InternalServerErrorResponse: Internal Server Error. Status code 500. Applicable to 19 of 26 methods.
* 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.

\* Check the method documentation to see if the error is applicable.





Server Selection

$3

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 { PowerPath } from "@superbuilders/powerpath";

const powerPath = new PowerPath({
serverURL: "https://api.alpha-1edtech.com",
security: {
clientID: process.env["POWERPATH_CLIENT_ID"] ?? "",
clientSecret: process.env["POWERPATH_CLIENT_SECRET"] ?? "",
},
});

async function run() {
const result = await powerPath.powerPathPlacement.getAllPlacementTests({
student: "",
subject: "",
});

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:

`typescript
import { PowerPath } from "@superbuilders/powerpath";
import { HTTPClient } from "@superbuilders/powerpath/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 PowerPath({ 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.

`typescript
import { PowerPath } from "@superbuilders/powerpath";

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

You can also enable a default debug logger by setting an environment variable POWERPATH_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.

$3