@aurora-interactive/sensei-productivity

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @aurora-interactive/sensei-productivity 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

Sensei Productivity REST API: REST API for the Sensei Productivity social media app.

Table of Contents

• @aurora-interactive/sensei-productivity
  • 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>

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

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { SenseiProductivity } from "@aurora-interactive/sensei-productivity";

const senseiProductivity = new SenseiProductivity({
  bearerAuth: process.env["SENSEIPRODUCTIVITY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await senseiProductivity.users.login({
    username: "Kacey40",
    password: "fbdGuMZsSr2v5wZ",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | ------------ | ---- | ----------- | -------------------------------- | | bearerAuth | http | HTTP Bearer | SENSEIPRODUCTIVITY_BEARER_AUTH |

To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:

import { SenseiProductivity } from "@aurora-interactive/sensei-productivity";

const senseiProductivity = new SenseiProductivity({
  bearerAuth: process.env["SENSEIPRODUCTIVITY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await senseiProductivity.users.login({
    username: "Kacey40",
    password: "fbdGuMZsSr2v5wZ",
  });

  console.log(result);
}

run();

Available Resources and Operations

Categories

• getAll - List all categories
• create - Create a new category (school admins only)
• update - Update a category (school admins only)
• delete - Delete a category (school admins only)

Schools

• getAll - List all schools with user counts
• get - Get a school's details by ID

Users

• login - Login the user and also return an access token the API client can use for further authentication
• signup - Signup the given user
• me - Get the currently authenticated user's profile
• get - Get a user's public profile by ID
• update - Update a user's profile (own profile only)
• delete - Soft delete a user account (own account only)

Users.Activities

• getAllOfUser - Get another user's activities (respects privacy)
• me - List the authenticated user's activities
• create - Create a new activity
• get - Get a specific activity by ID
• update - Update an activity (mark complete, edit details or deadline)
• delete - Delete an activity

Users.Friends

• list - List a user's friends
• pending - Get all pending friend requests
• sendRequest - Send a friend request to a user
• accept - Accept a pending friend request
• reject - Reject a pending friend request
• remove - Remove a friend

Users.Posts

• getByUserId - Get a user's posts (respects post visibility)
• feed - Get the social feed of posts from the authenticated user's friends
• getByPostId - Get a specific post by ID
• update - Update a post's caption or visibility
• delete - Delete a post

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.

• categoriesCreate - Create a new category (school admins only)
• categoriesDelete - Delete a category (school admins only)
• categoriesGetAll - List all categories
• categoriesUpdate - Update a category (school admins only)
• schoolsGet - Get a school's details by ID
• schoolsGetAll - List all schools with user counts
• usersActivitiesCreate - Create a new activity
• usersActivitiesDelete - Delete an activity
• usersActivitiesGet - Get a specific activity by ID
• usersActivitiesGetAllOfUser - Get another user's activities (respects privacy)
• usersActivitiesMe - List the authenticated user's activities
• usersActivitiesUpdate - Update an activity (mark complete, edit details or deadline)
• usersDelete - Soft delete a user account (own account only)
• usersFriendsAccept - Accept a pending friend request
• usersFriendsList - List a user's friends
• usersFriendsPending - Get all pending friend requests
• usersFriendsReject - Reject a pending friend request
• usersFriendsRemove - Remove a friend
• usersFriendsSendRequest - Send a friend request to a user
• usersGet - Get a user's public profile by ID
• usersLogin - Login the user and also return an access token the API client can use for further authentication
• usersMe - Get the currently authenticated user's profile
• usersPostsDelete - Delete a post
• usersPostsFeed - Get the social feed of posts from the authenticated user's friends
• usersPostsGetByPostId - Get a specific post by ID
• usersPostsGetByUserId - Get a user's posts (respects post visibility)
• usersPostsUpdate - Update a post's caption or visibility
• usersSignup - Signup the given user
• usersUpdate - Update a user's profile (own profile only)

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 { SenseiProductivity } from "@aurora-interactive/sensei-productivity";

const senseiProductivity = new SenseiProductivity({
  bearerAuth: process.env["SENSEIPRODUCTIVITY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await senseiProductivity.users.login({
    username: "Kacey40",
    password: "fbdGuMZsSr2v5wZ",
  }, {
    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 { SenseiProductivity } from "@aurora-interactive/sensei-productivity";

const senseiProductivity = new SenseiProductivity({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: process.env["SENSEIPRODUCTIVITY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await senseiProductivity.users.login({
    username: "Kacey40",
    password: "fbdGuMZsSr2v5wZ",
  });

  console.log(result);
}

run();

Error Handling

SenseiProductivityError 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 |

Example

import { SenseiProductivity } from "@aurora-interactive/sensei-productivity";
import * as errors from "@aurora-interactive/sensei-productivity/models/errors";

const senseiProductivity = new SenseiProductivity({
  bearerAuth: process.env["SENSEIPRODUCTIVITY_BEARER_AUTH"] ?? "",
});

async function run() {
  try {
    const result = await senseiProductivity.users.login({
      username: "Kacey40",
      password: "fbdGuMZsSr2v5wZ",
    });

    console.log(result);
  } catch (error) {
    if (error instanceof errors.SenseiProductivityError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• SenseiProductivityError: The base class for HTTP error responses.

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 SenseiProductivityError:

• 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 { SenseiProductivity } from "@aurora-interactive/sensei-productivity";

const senseiProductivity = new SenseiProductivity({
  serverURL: "https://csds393-group17-rest-api.aurora-interactive.online",
  bearerAuth: process.env["SENSEIPRODUCTIVITY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await senseiProductivity.users.login({
    username: "Kacey40",
    password: "fbdGuMZsSr2v5wZ",
  });

  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:

• route requests through a proxy server using undici's ProxyAgent
• use the "beforeRequest" hook to add a custom header and a timeout to requests
• use the "requestError" hook to log errors

import { SenseiProductivity } from "@aurora-interactive/sensei-productivity";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@aurora-interactive/sensei-productivity/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

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 SenseiProductivity({ httpClient: 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 { SenseiProductivity } from "@aurora-interactive/sensei-productivity";

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

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