npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@egain/egain-api-typescript

v0.7.0

Published

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@egain/egain-api-typescript* API.

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

elohelohakumar_egainakumar_egain

Keywords

Readme

@egain/egain-api-typescript

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @egain/egain-api-typescript API.

Summary

Knowledge Portal Manager APIs:

License

The following licenses are required to use the Knowledge Access APIs:

  • If the user is an agent, then the Knowledge + AI license is required.
  • If the user is a customer, the Self-Service and Advanced Self-Service licenses must be available.

Tiers

| Tier |Tier Name| Named Users | Description | ---------- | ---------- | ---------- | ---------------------------- | Tier 1 | Starter | Up to 10| Designed for small-scale implementations or pilot environments | Tier 2 | Growth | Up to 1000| Suitable for mid-scale deployments requiring moderate scalability | Tier 3 | Enterprise | Greater than 1000| Supports large-scale environments with extended configuration options

API Resource Limits

The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.

| Resource | Limits | Starter | Growth | Enterprise | ---------------- | ---------------------------- | ---------- | ---------- | ---------- | Article Reference |Number of attachments used in any article | 25 | 50 |50 | |Number of custom attributes in an article | 10 | 25| 50 | |Number of publish views used in an article version | 20 | 20 | 20 | Topic Reference |User-defined topics in a department| 1000| 5000 | 50000 | |Depth of topics | 5 | 20 | 20 | |Topics at any level | 500 | 2500 | 2500 | |Number of custom attributes in a topic | 10 | 10 | 10 | Portal Reference | Tag categories in a portal | 15 | 15 | 15 | |Topics to be included in a portal | 100 | 500 | 5000 | |Number of articles to display in announcements | 10 | 25 | 25 | |Usage links and link groups setup for a portal | 5 | 10 | 25

For more information about the API: Full SDK Documentation

Table of Contents

SDK Installation

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

NPM

npm add @egain/egain-api-typescript

PNPM

pnpm add @egain/egain-api-typescript

Bun

bun add @egain/egain-api-typescript

Yarn

yarn add @egain/egain-api-typescript

[!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 { Egain } from "@egain/egain-api-typescript";

const egain = new Egain({
  accessToken: process.env["EGAIN_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await egain.aiservices.retrieve.retrieveChunks({
    q: "What is a loan?",
    portalID: "PROD-1000",
    filterUserProfileID: "PROD-1030",
    language: "en-US",
    filterTags: {
      "PROD-1234": [
        "PROD-2000",
        "PROD-2003",
      ],
      "PROD-2005": [
        "PROD-2007",
      ],
    },
    retrieveRequest: {
      channel: {
        name: "Eight Bank Website",
      },
      eventId: "6154589f-b43f-4471-b2c7-92c6c888a664",
      clientSessionId: "6154589f-b43f-4471-b2c7-92c6c888a643",
      sessionId: "6154589f-b43f-4471-b2c7-92c6c888a689",
    },
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | ------------- | ---- | ----------- | -------------------- | | accessToken | http | HTTP Bearer | EGAIN_ACCESS_TOKEN |

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

import { Egain } from "@egain/egain-api-typescript";

const egain = new Egain({
  accessToken: process.env["EGAIN_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await egain.aiservices.prompt.executePrompt({
    promptId: "<id>",
    executePrompt: {
      department: "Service",
      languageCode: "en-US",
      clientSessionId: "123e4567-e89b-12d3-a456-426614174000",
    },
  });

  console.log(result);
}

run();

Available Resources and Operations

aiservices.answers

aiservices.prompt

aiservices.retrieve

content.import

portal.article

portal.articlelists

portal.attachment

portal.bookmark

portal.connectorssearchevents

portal.export

portal.federatedsearchevent

portal.general

portal.guidedhelp

portal.populararticles

portal.search

portal.suggestion

portal.topic

portal.userdetails

portal.usermilestones

portal.userprofile

prompt

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.

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 { Egain } from "@egain/egain-api-typescript";

const egain = new Egain({
  accessToken: process.env["EGAIN_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await egain.aiservices.prompt.executePrompt({
    promptId: "<id>",
    executePrompt: {
      department: "Service",
      languageCode: "en-US",
      clientSessionId: "123e4567-e89b-12d3-a456-426614174000",
    },
  }, {
    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 { Egain } from "@egain/egain-api-typescript";

const egain = new Egain({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  accessToken: process.env["EGAIN_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await egain.aiservices.prompt.executePrompt({
    promptId: "<id>",
    executePrompt: {
      department: "Service",
      languageCode: "en-US",
      clientSessionId: "123e4567-e89b-12d3-a456-426614174000",
    },
  });

  console.log(result);
}

run();

Error Handling

EgainError 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 { Egain } from "@egain/egain-api-typescript";
import * as errors from "@egain/egain-api-typescript/models/errors";

const egain = new Egain({
  accessToken: process.env["EGAIN_ACCESS_TOKEN"] ?? "",
});

async function run() {
  try {
    const result = await egain.aiservices.prompt.executePrompt({
      promptId: "<id>",
      executePrompt: {
        department: "Service",
        languageCode: "en-US",
        clientSessionId: "123e4567-e89b-12d3-a456-426614174000",
      },
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.EgainError) {
      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.BadRequestError) {
        console.log(error.data$.code); // number
        console.log(error.data$.developerMessage); // string
      }
    }
  }
}

run();

Error Classes

Primary errors:

Network errors:

Inherit from EgainError:

  • SchemasWSErrorCommon: Not acceptable. Status code 406. Applicable to 4 of 83 methods.*
  • BadRequestError: Bad Request. Status code 400. Applicable to 1 of 83 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

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 { Egain } from "@egain/egain-api-typescript";

const egain = new Egain({
  serverURL: "https://api.aidev.egain.cloud/knowledge/portalmgr/v4",
  accessToken: process.env["EGAIN_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await egain.aiservices.prompt.executePrompt({
    promptId: "<id>",
    executePrompt: {
      department: "Service",
      languageCode: "en-US",
      clientSessionId: "123e4567-e89b-12d3-a456-426614174000",
    },
  });

  console.log(result);
}

run();

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

import { Egain } from "@egain/egain-api-typescript";

const egain = new Egain({
  accessToken: process.env["EGAIN_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await egain.aiservices.prompt.executePrompt({
    promptId: "<id>",
    executePrompt: {
      department: "Service",
      languageCode: "en-US",
      clientSessionId: "123e4567-e89b-12d3-a456-426614174000",
    },
  }, {
    serverURL: "https://api.aidev.egain.cloud/core/aiservices/v4",
  });

  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 { Egain } from "@egain/egain-api-typescript";
import { HTTPClient } from "@egain/egain-api-typescript/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 Egain({ 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 { Egain } from "@egain/egain-api-typescript";

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

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