WRAL Digital Content API SDK

The wral-content-sdk is a JavaScript SDK (Software Development Kit) designed to interact with the WRAL Digital Content API. It provides a straightforward way to integrate WRAL Digital's content services into JavaScript applications.

Installation

You can install the @wral/sdk-content package via npm:

npm install @wral/sdk-content

Usage

To use the @wral/sdk-content, you first need to import it into your JavaScript project:

import { createClient } from '@wral/sdk-content/v1';

Then, you can create a client instance with your configuration:

const config = {
  baseUrl: 'YOUR_BASE_URL', // Base URL of the Content API
  apiKey: 'YOUR_API_KEY', // API key for authentication
};

const client = createClient(config);

After creating the client instance, you can use its methods to interact with the API. Here are some examples:

Fetching Models

let models = await client.getModels();

Getting a Model by Type

let model = await client.getModelByType('news');

Fetching Content by ID

let content = await client.getContentById('12345');

Updating Content by ID

let updatedContent = await client.updateContentById('12345', { content: 'Updated content' });

Deleting Content by ID

await client.deleteContentById('12345');

Fetching Content History by ID

let history = await client.getContentHistoryById('12345');

Searching for Content

const query = 'foo'; // accepts lucene query
let results = await client.searchContent(query);

API

The SDK provides the following methods:

• getModels(): Fetches all models.
• getModelByType(type): Retrieves a specific model by its type.
• getContentById(id,version): Fetches content data by ID and optional version
• updateContentById(id, contentData): Updates content data by ID.
• deleteContentById(id): Deletes content data by ID.
• getContentHistoryById(id): Fetches the content's history by ID.
• searchContent(query): Searches content based on a query string.
• contentUrl({id, version}): Generates a content URL by ID and optional version.