wt-api-client

TypeScript client for WebSoft WebTutor endpoints:

• extjs_json_collection_data.html (collections)
• lpapi.html (catalog metadata and remote actions)

Installation

npm install wt-api-client

Quick Start

import { WTApiClient } from 'wt-api-client';

const client = new WTApiClient({
  baseUrl: 'https://your-domain.com',
  requestInit: {
    headers: {
      Authorization: 'Bearer <token>'
    }
  }
});

const users = await client.evalCollectionByCode('users_list', {
  limit: 20,
  start: 0,
  parameters: { active: '1' },
  sortBy: 'fullname',
  direction: 'asc'
});

console.log(users.results);

Public API

Class: WTApiClient

new WTApiClient(options?: WTApiClientOptions)

Options:

• baseUrl?: string
• requestInit?: SafeRequestInit

Methods:

• evalCollectionByCode<T>(collectionCode, options?)
• evalCollectionById<T>(collectionId, options?)
• evalAction<T>(remoteActionId, params)
• fetchCollections(catalogName?)
• fetchCollection(objectId?)
• fetchActions(catalogName?)
• fetchAction(objectId?)
• fetchObjectFields(catalogName?)

Standalone functions

Also exported from package root:

• evalCollection
• evalAction
• fetchCollections
• fetchCollection
• fetchActions
• fetchObjectFields
• lpapi
• createParametersString
• WTApiError

Key types

• CollectionRequestParams
• CollectionResponse<T>
• EvalActionParams
• WTApiClientOptions
• Lpapi* response/request types

Collection Request Example

import { evalCollection } from 'wt-api-client';

const response = await evalCollection<{ id: string; name: string }>(
  'https://your-domain.com',
  {
    collectionCode: 'users_list',
    parameters: {
      department: 'IT',
      active: '1'
    },
    userId: '123',
    limit: 100,
    start: 0,
    sortBy: 'name',
    direction: 'asc'
  }
);

console.log(response.total, response.results);

Remote Action Example

import { evalAction } from 'wt-api-client';

const result = await evalAction(
  '5709302381483599564',
  'https://your-domain.com',
  {
    command: 'run',
    form_fields: {
      object_id: '123'
    },
    wvars: [
      { name: 'user_id', value: 456 }
    ],
    page_url: '/view_doc.html?mode=...' 
  }
);

console.log(result);

Publishing

Release checklist:

1. Update version in package.json.
2. Run npm ci.
3. Run npm run test:unit.
4. Optional: run npm run test:integration in environment with available WebTutor API.
5. Run npm run build.
6. Run npm run check:package and verify tarball content includes dist/*.
7. Publish with npm publish.

prepack and prepublishOnly automatically rebuild dist before packaging/publishing.

License

MIT