Merge pull request #8 from chemmedia/7-provide-context-where-asset-is…

…-embedded add context
chemmedia · Apr 19, 2023 · ad03e8e · ad03e8e
2 parents 528060e + 652348c
commit ad03e8e
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -219,13 +219,29 @@ interface LMSData {
   learnerName: string;
 }
 
+export enum ContextType {
+  MEDIUM = 'medium',
+  QUESTION = 'question',
+  SECTION = 'section',
+  CONTENT = 'content',
+  CHAPTER = 'chapter',
+  SITE = 'site',
+}
+
+export interface Context {
+  uid: string;
+  type: ContextType;
+  title?: string; // HTML string
+}
+
 interface Configuration {
     suspendData: string;
     sharedData: string;
     assetType: AssetType;
     isEvaluated: boolean;
     lmsData: LMSData;
     design: Design; // see https://github.com/chemmedia/knowledgeworker-embedded-asset-api-ui
+    context: Context[];
 }
 ```
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "knowledgeworker-embedded-asset-api",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "author": "chemmedia AG",
   "description": "A javascript library to integrate rich content packages into responsive Knowledgeworker Create contents.",
   "keywords": [

diff --git a/src/model.ts b/src/model.ts
@@ -46,13 +46,29 @@ export interface LMSData {
     learnerName: string;
 }
 
+export enum ContextType {
+    MEDIUM = 'medium',
+    QUESTION = 'question',
+    SECTION = 'section',
+    CONTENT = 'content',
+    CHAPTER = 'chapter',
+    SITE = 'site',
+}
+
+export interface Context {
+    uid: string;
+    type: ContextType;
+    title?: string; // HTML string
+}
+
 export interface Configuration {
     suspendData: string;
     sharedData: string;
     assetType: AssetType;
     isEvaluated: boolean;
     lmsData: LMSData;
     design: Design;
+    context: Context[];
 }
 
 export interface InternalConfiguration extends Configuration {
@@ -78,4 +94,4 @@ export interface Listeners {
     reset?: () => void;
     setDesign?: (design: Design) => void;
     setSharedData?: (sharedData: string) => void;
-}
+}