Core SDK Functionality

This section covers the core functionality of the Qelos SDK, including initialization, custom headers management, and other base features that are available directly from the main SDK instance.

SDK Initialization

To use the Qelos SDK, you first need to initialize it with the appropriate options:

import { QelosSDK } from '@qelos/sdk';

const sdk = new QelosSDK({
  appUrl: 'https://your-qelos-app.com',
  forceRefresh: true, // Enable automatic token refresh
  // Optional: provide initial tokens if available
  accessToken: 'existing-access-token',
  refreshToken: 'existing-refresh-token',
});

SDK Options

The QelosSDKOptions interface supports the following properties:

• appUrl: The base URL of your Qelos application (required)
• forceRefresh: Whether to automatically refresh tokens when needed
• accessToken: An initial access token (optional)
• refreshToken: An initial refresh token (optional)
• getAccessToken: A function that returns the current access token (optional)
• extraHeaders: A function that returns additional headers for API requests (optional)

Managing Custom Headers

The SDK allows you to add custom headers to all API requests, which can be useful for adding tracking information, custom authentication, or other metadata.

Setting a Custom Header

To add a custom header to all API requests:

sdk.setCustomHeader('X-Custom-Header', 'custom-value');

This header will be included in all subsequent API requests made by the SDK.

Removing a Custom Header

To remove a previously set custom header:

sdk.removeCustomHeader('X-Custom-Header');

Token Management

The SDK automatically manages authentication tokens when using OAuth-based authentication. The tokens are stored internally and used for authenticating API requests.

Getting the Current Access Token

You can retrieve the current access token using the authentication module:

const currentToken = sdk.authentication.accessToken;

Automatic Token Refresh

When forceRefresh is enabled in the SDK options, the SDK will automatically refresh the access token when it expires. This happens transparently when making API requests.

If you need to manually refresh the token:

await sdk.authentication.refreshToken();

Available Modules

The Qelos SDK provides several modules for interacting with different aspects of your application:

• authentication: User authentication and session management
• workspaces: Multi-tenant workspace management
• invites: Workspace invitation management
• blueprints: Data model definition and entity management
• blocks: Content block management
• layouts: UI layout management
• appConfigurations: Application configuration management

Each module provides specific methods for interacting with its respective functionality. Refer to the dedicated documentation pages for each module for more details.

Example: Complete SDK Setup

Here's a complete example of initializing the SDK and setting up custom headers:

import { QelosSDK } from '@qelos/sdk';

// Initialize the SDK
const sdk = new QelosSDK({
  appUrl: 'https://your-qelos-app.com',
  forceRefresh: true,
});

// Add custom headers for tracking
sdk.setCustomHeader('X-Client-Version', '1.0.0');
sdk.setCustomHeader('X-Client-Platform', 'web');

// Authenticate the user
await sdk.authentication.oAuthSignin({
  username: 'user@example.com',
  password: 'password'
});

// Now you can use any of the SDK modules
const workspaces = await sdk.workspaces.getList();
const userProfile = await sdk.authentication.getLoggedInUser();