@talentdigital/kit v0.31.0

TalentKit

A batteries-included SDK for developing episode formats for the talent::digital platform

Intstallation

Install the @talentdigital/kit package and it's peer dependency keycloak-js.

npm

npm install @talentdigital/kit keycloak-js

yarn

yarn add @talentdigital/kit keycloak-js

pnpm

pnpm add @talentdigital/kit keycloak-js

Usage

The TalentKit can be run in development or production mode.

Modes

Development Mode

The kit can be run in development mode by providing the season definition as a parameter to the create method.

When run on development mode, nothing is written to the talent::digital API.

// season is imported from season.yml
import TalentKit from "@talentdigital/kit";

const kit = await TalentKit.create({
  seasonDefinition: season,
});

Production Mode

The kit can be run in production mode by omiting the season definition and providing the tenant id. The tenant id can be obtained from talent::digital.

When run on production mode data a connection is made to the talent::digital API.

import TalentKit from "@talentdigital/kit";

const kit = await TalentKit.create({
  tenant: "tenantId",
});

Loading an Episode

The season and episode ids are provided as URL Parameters in the form ?sid=X&eid=Y where sid is the season identifer and eid is the episode identifyer (specified in the season.yml). For testing purposes, the season and episode ids can be provided as a parameter to the TalentKit.create method.

import TalentKit from "@talentdigital/kit";

const kit = await TalentKit.create({
  id: { season: "my-handle/my-repo", episode: "my-episode" }
});

Reading Format Configuration for Loaded Episode

When the kit is created, the season id sid, episode id eid and redirectUrl are taken from the respective URL parameters.

The episode's format configuration (specified in season.yaml) is then downloaded and parsed. The format configuration can be accessed via the formatConfiguration property.

The type for formatConfiguration can be provided as a type parameter when the kit is created.

The file configuration specified under formatConfiguration for that episode in season.yaml is downloaded and parsed. The following files types are supported: md, json, toml, yaml, yml

The type for formatConfiguration can be provided then the kit is created.

e1_config.toml

intro = "This is some intro text"
color = "#FF0000"

season.yaml

episodes:
  "1":
    title: ...
    description: ...
    ...
    formatConfiguration: e1_config.toml

index.tsx

import TalentKit from "@talentdigital/kit";

interface FormatConfiguration {
  intro: string;
  color: string;
}

const kit = await TalentKit.create<FormatConfiguration>({
  tenant: "tenantId",
});

...


const intro = kit.formatConfiguration.intro;

Features

Test Events

Tests for the given episode are instantiated when the kit is created. Tests have the following methods:

Passing a test

await kit.tests["testId"].pass();

Failing a test

await kit.tests["testId"].fail();

Badges

Badges available in the given episode are instantiated when the kit is created.

Awarding a badge

await kit.badges["badgeId"].award();

Check if a badge has been awarded.

if (kit.badges["badgeId"].awarded) {
  // do something
}

Savegame

Each episode has its own savegame storage available.

Saving

To write an object to the savegame storage

await kit.savegame.save(obj);

Loading

To load an object from the episode savegame.

const obj = kit.savegame.load();

Feedback questions

Feedback questions for the given episode are instantiated when the kit is created.

Getting the text for a feedback question

const { en, de } = kit.feedbackQuestions["questionId"].question;

Getting the answer options

const { en, de } = kit.feedbackQuestions["questionId"].answers["answerId"];

Submitting a feedback question

kit.feedbackQuestions["questionId"].submit("answerId");

Assets

Getting an asset URL

/**
 * Returns the full URL, using the base defined as
 * assetsURL in season.yaml
 */
const src = kit.assets.getUrl("image.png");

//...

<img src={src} />;

Getting the parsed content of an asset

The following file types are automatically parsed based on the file extension:

// season.yaml

title: Season Title

// index.ts
const season = kit.assets.get("season.yaml");

const title = season.title;