@sparted/shared-library 1.1.0 → 1.1.2

package/business/types/content.d.ts

@@ -91,3 +91,10 @@ export type Content = {
     statuses: ContentStatuses;
     game?: Game;
 };
+export declare const isGameMultipleChoiceQuestion: (game: Game) => game is MultipleChoiceQuestion;
+export declare const isGameErrorText: (game: Game) => game is ErrorText;
+export declare const isGameOpenQuestion: (game: Game) => game is OpenQuestion;
+export declare const isGameNoInteraction: (game: Game) => game is NoInteraction;
+export declare const isGamePictureSpot: (game: Game) => game is PictureSpot;
+export declare const isGameOrderingCards: (game: Game) => game is OrderingCards;
+export declare const isGameSwipingCards: (game: Game) => game is SwipingCards;

package/business/types/content.js

@@ -10,7 +10,21 @@ const GAME_TYPE = {
     PICTURE_SPOT: 'picture-spot',
     ORDERING_CARDS: 'ordering-cards',
     SWIPING_CARDS: 'swiping-cards',
-};
+};
+const isGameMultipleChoiceQuestion = (game) => game.type === GAME_TYPE.MCQ;
+const isGameErrorText = (game) => game.type === GAME_TYPE.ERROR_TEXT;
+const isGameOpenQuestion = (game) => game.type === GAME_TYPE.OPEN_QUESTION;
+const isGameNoInteraction = (game) => game.type === GAME_TYPE.NO_INTERACTION;
+const isGamePictureSpot = (game) => game.type === GAME_TYPE.PICTURE_SPOT;
+const isGameOrderingCards = (game) => game.type === GAME_TYPE.ORDERING_CARDS;
+const isGameSwipingCards = (game) => game.type === GAME_TYPE.SWIPING_CARDS;
 
 exports.GAME_TYPE = GAME_TYPE;
+exports.isGameErrorText = isGameErrorText;
+exports.isGameMultipleChoiceQuestion = isGameMultipleChoiceQuestion;
+exports.isGameNoInteraction = isGameNoInteraction;
+exports.isGameOpenQuestion = isGameOpenQuestion;
+exports.isGameOrderingCards = isGameOrderingCards;
+exports.isGamePictureSpot = isGamePictureSpot;
+exports.isGameSwipingCards = isGameSwipingCards;
 //# sourceMappingURL=content.js.map

package/business/types/content.js.map

@@ -1 +1 @@
-{"version":3,"file":"content.js","sources":["../../../src/business/types/content.ts"],"sourcesContent":["import { LanguageCode, MultilingualLabel } from './multilingual';\nimport { Image, Media } from './media';\nimport { Thematic } from './thematic';\n\nexport type ErrorText = {\n  type: 'error-text';\n  gameMedia?: Media;\n  explanationMedia?: Media;\n  explanation?: MultilingualLabel;\n  wrongText?: MultilingualLabel;\n  correctText?: MultilingualLabel;\n};\n\nexport type MultipleChoiceQuestion = {\n  type: 'mcq';\n  gameMedia?: Media;\n  question?: MultilingualLabel;\n  explanation?: MultilingualLabel;\n  explanationMedia?: Media;\n  multiselect?: boolean;\n  choices?: {\n    correct: boolean;\n    text: MultilingualLabel;\n  }[];\n};\n\nexport type NoInteraction = {\n  type: 'no-interaction';\n  firstMedia?: Media;\n  secondMedia?: Media;\n  title?: MultilingualLabel;\n  text?: MultilingualLabel;\n};\n\nexport type OpenQuestion = {\n  type: 'open-question';\n  gameMedia?: Media;\n  question?: MultilingualLabel;\n  answer?: MultilingualLabel;\n  explanation?: MultilingualLabel;\n  explanationMedia?: Media;\n  levenshteinDistance?: number;\n};\n\nexport type OrderingCards = {\n  type: 'ordering-cards';\n  explanation?: MultilingualLabel;\n  question?: MultilingualLabel;\n  topLabel?: MultilingualLabel;\n  bottomLabel?: MultilingualLabel;\n  cards: MultilingualLabel[];\n};\n\nexport type PictureSpot = {\n  type: 'picture-spot';\n  image?: Image;\n  explanation?: MultilingualLabel;\n  items?: {\n    x: number;\n    y: number;\n    r: number;\n    question: MultilingualLabel;\n    description: MultilingualLabel;\n  }[];\n};\n\nexport type SwipingCards = {\n  type: 'swiping-cards';\n  explanation?: MultilingualLabel;\n  question?: MultilingualLabel;\n  zones?: {\n    position: 'left' | 'right' | 'top' | 'bottom';\n    text: MultilingualLabel;\n  }[];\n  cards?: {\n    image?: Image;\n    text?: MultilingualLabel;\n    answer: 'left' | 'right' | 'top' | 'bottom';\n  }[];\n};\n\nexport type Game =\n  | ErrorText\n  | MultipleChoiceQuestion\n  | NoInteraction\n  | OpenQuestion\n  | OrderingCards\n  | PictureSpot\n  | SwipingCards;\n\nexport type GameType =\n  | 'error-text'\n  | 'mcq'\n  | 'open-question'\n  | 'no-interaction'\n  | 'picture-spot'\n  | 'swiping-cards'\n  | 'ordering-cards';\n\nexport const GAME_TYPE: Record<string, GameType> = {\n  MCQ: 'mcq',\n  ERROR_TEXT: 'error-text',\n  OPEN_QUESTION: 'open-question',\n  NO_INTERACTION: 'no-interaction',\n  PICTURE_SPOT: 'picture-spot',\n  ORDERING_CARDS: 'ordering-cards',\n  SWIPING_CARDS: 'swiping-cards',\n};\n\nexport type ContentStatuses = Partial<{\n  [languageCode in LanguageCode]: 'draft' | 'validated' | 'waiting-translation' | 'waiting-validation';\n}>;\n\nexport type Content = {\n  archived: boolean;\n  id: number;\n  metadata: {\n    coverImage: Image;\n    identifier?: string;\n    name: MultilingualLabel;\n    thematic: Thematic;\n    explanation?: string;\n    knowMore?: string;\n  };\n  statuses: ContentStatuses;\n  game?: Game;\n};\n"],"names":[],"mappings":";;;;AAmGa,MAAA,SAAS,GAA6B;AACjD,IAAA,GAAG,EAAE,KAAK;AACV,IAAA,UAAU,EAAE,YAAY;AACxB,IAAA,aAAa,EAAE,eAAe;AAC9B,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,YAAY,EAAE,cAAc;AAC5B,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,aAAa,EAAE,eAAe;;;;;"}
+{"version":3,"file":"content.js","sources":["../../../src/business/types/content.ts"],"sourcesContent":["import { LanguageCode, MultilingualLabel } from './multilingual';\nimport { Image, Media } from './media';\nimport { Thematic } from './thematic';\n\nexport type ErrorText = {\n  type: 'error-text';\n  gameMedia?: Media;\n  explanationMedia?: Media;\n  explanation?: MultilingualLabel;\n  wrongText?: MultilingualLabel;\n  correctText?: MultilingualLabel;\n};\n\nexport type MultipleChoiceQuestion = {\n  type: 'mcq';\n  gameMedia?: Media;\n  question?: MultilingualLabel;\n  explanation?: MultilingualLabel;\n  explanationMedia?: Media;\n  multiselect?: boolean;\n  choices?: {\n    correct: boolean;\n    text: MultilingualLabel;\n  }[];\n};\n\nexport type NoInteraction = {\n  type: 'no-interaction';\n  firstMedia?: Media;\n  secondMedia?: Media;\n  title?: MultilingualLabel;\n  text?: MultilingualLabel;\n};\n\nexport type OpenQuestion = {\n  type: 'open-question';\n  gameMedia?: Media;\n  question?: MultilingualLabel;\n  answer?: MultilingualLabel;\n  explanation?: MultilingualLabel;\n  explanationMedia?: Media;\n  levenshteinDistance?: number;\n};\n\nexport type OrderingCards = {\n  type: 'ordering-cards';\n  explanation?: MultilingualLabel;\n  question?: MultilingualLabel;\n  topLabel?: MultilingualLabel;\n  bottomLabel?: MultilingualLabel;\n  cards: MultilingualLabel[];\n};\n\nexport type PictureSpot = {\n  type: 'picture-spot';\n  image?: Image;\n  explanation?: MultilingualLabel;\n  items?: {\n    x: number;\n    y: number;\n    r: number;\n    question: MultilingualLabel;\n    description: MultilingualLabel;\n  }[];\n};\n\nexport type SwipingCards = {\n  type: 'swiping-cards';\n  explanation?: MultilingualLabel;\n  question?: MultilingualLabel;\n  zones?: {\n    position: 'left' | 'right' | 'top' | 'bottom';\n    text: MultilingualLabel;\n  }[];\n  cards?: {\n    image?: Image;\n    text?: MultilingualLabel;\n    answer: 'left' | 'right' | 'top' | 'bottom';\n  }[];\n};\n\nexport type Game =\n  | ErrorText\n  | MultipleChoiceQuestion\n  | NoInteraction\n  | OpenQuestion\n  | OrderingCards\n  | PictureSpot\n  | SwipingCards;\n\nexport type GameType =\n  | 'error-text'\n  | 'mcq'\n  | 'open-question'\n  | 'no-interaction'\n  | 'picture-spot'\n  | 'swiping-cards'\n  | 'ordering-cards';\n\nexport const GAME_TYPE: Record<string, GameType> = {\n  MCQ: 'mcq',\n  ERROR_TEXT: 'error-text',\n  OPEN_QUESTION: 'open-question',\n  NO_INTERACTION: 'no-interaction',\n  PICTURE_SPOT: 'picture-spot',\n  ORDERING_CARDS: 'ordering-cards',\n  SWIPING_CARDS: 'swiping-cards',\n};\n\nexport type ContentStatuses = Partial<{\n  [languageCode in LanguageCode]: 'draft' | 'validated' | 'waiting-translation' | 'waiting-validation';\n}>;\n\nexport type Content = {\n  archived: boolean;\n  id: number;\n  metadata: {\n    coverImage: Image;\n    identifier?: string;\n    name: MultilingualLabel;\n    thematic: Thematic;\n    explanation?: string;\n    knowMore?: string;\n  };\n  statuses: ContentStatuses;\n  game?: Game;\n};\n\nexport const isGameMultipleChoiceQuestion = (game: Game): game is MultipleChoiceQuestion => game.type === GAME_TYPE.MCQ;\nexport const isGameErrorText = (game: Game): game is ErrorText => game.type === GAME_TYPE.ERROR_TEXT;\nexport const isGameOpenQuestion = (game: Game): game is OpenQuestion => game.type === GAME_TYPE.OPEN_QUESTION;\nexport const isGameNoInteraction = (game: Game): game is NoInteraction => game.type === GAME_TYPE.NO_INTERACTION;\nexport const isGamePictureSpot = (game: Game): game is PictureSpot => game.type === GAME_TYPE.PICTURE_SPOT;\nexport const isGameOrderingCards = (game: Game): game is OrderingCards => game.type === GAME_TYPE.ORDERING_CARDS;\nexport const isGameSwipingCards = (game: Game): game is SwipingCards => game.type === GAME_TYPE.SWIPING_CARDS;\n"],"names":[],"mappings":";;;;AAmGa,MAAA,SAAS,GAA6B;AACjD,IAAA,GAAG,EAAE,KAAK;AACV,IAAA,UAAU,EAAE,YAAY;AACxB,IAAA,aAAa,EAAE,eAAe;AAC9B,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,YAAY,EAAE,cAAc;AAC5B,IAAA,cAAc,EAAE,gBAAgB;AAChC,IAAA,aAAa,EAAE,eAAe;EAC9B;AAqBW,MAAA,4BAA4B,GAAG,CAAC,IAAU,KAAqC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI;AAC3G,MAAA,eAAe,GAAG,CAAC,IAAU,KAAwB,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,WAAW;AACxF,MAAA,kBAAkB,GAAG,CAAC,IAAU,KAA2B,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,cAAc;AACjG,MAAA,mBAAmB,GAAG,CAAC,IAAU,KAA4B,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,eAAe;AACpG,MAAA,iBAAiB,GAAG,CAAC,IAAU,KAA0B,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,aAAa;AAC9F,MAAA,mBAAmB,GAAG,CAAC,IAAU,KAA4B,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,eAAe;AACpG,MAAA,kBAAkB,GAAG,CAAC,IAAU,KAA2B,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;;;;;;;;;;;"}

package/business/types/index.js

@@ -8,5 +8,12 @@ var multilingual = require('./multilingual.js');
 
 
 exports.GAME_TYPE = content.GAME_TYPE;
+exports.isGameErrorText = content.isGameErrorText;
+exports.isGameMultipleChoiceQuestion = content.isGameMultipleChoiceQuestion;
+exports.isGameNoInteraction = content.isGameNoInteraction;
+exports.isGameOpenQuestion = content.isGameOpenQuestion;
+exports.isGameOrderingCards = content.isGameOrderingCards;
+exports.isGamePictureSpot = content.isGamePictureSpot;
+exports.isGameSwipingCards = content.isGameSwipingCards;
 exports.Languages = multilingual.Languages;
 //# sourceMappingURL=index.js.map

package/business/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;"}

package/color/get-contrast-color.d.ts

@@ -0,0 +1 @@
+export declare const getContrastColor: (bgColor: string, lightColor?: string, darkColor?: string) => string;

package/color/get-contrast-color.js

@@ -0,0 +1,21 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const DEFAULT_LIGHT_COLOR = '#FFFFFF';
+const DEFAULT_DARK_COLOR = '#000000';
+// Based on https://stackoverflow.com/questions/11867545/change-text-color-based-on-brightness-of-the-covered-background-area
+const getContrastColor = (bgColor, lightColor = DEFAULT_LIGHT_COLOR, darkColor = DEFAULT_DARK_COLOR) => {
+    const color = bgColor.charAt(0) === '#' ? bgColor.substring(1, 7) : bgColor;
+    if (color.length !== 6) {
+        throw new Error(`Invalid HEX color "${bgColor}" in sparted mail manager.`);
+    }
+    const r = parseInt(color.substring(0, 2), 16); // hexToR
+    const g = parseInt(color.substring(2, 4), 16); // hexToG
+    const b = parseInt(color.substring(4, 6), 16); // hexToB
+    // Values from https://www.w3.org/TR/AERT/#color-contrast
+    return r * 0.299 + g * 0.587 + b * 0.114 > 186 ? darkColor : lightColor;
+};
+
+exports.getContrastColor = getContrastColor;
+//# sourceMappingURL=get-contrast-color.js.map

package/color/get-contrast-color.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-contrast-color.js","sources":["../../src/color/get-contrast-color.ts"],"sourcesContent":["const DEFAULT_LIGHT_COLOR = '#FFFFFF';\nconst DEFAULT_DARK_COLOR = '#000000';\n\n// Based on https://stackoverflow.com/questions/11867545/change-text-color-based-on-brightness-of-the-covered-background-area\nexport const getContrastColor = (bgColor: string, lightColor: string = DEFAULT_LIGHT_COLOR, darkColor: string = DEFAULT_DARK_COLOR): string => {\n  const color = bgColor.charAt(0) === '#' ? bgColor.substring(1, 7) : bgColor;\n\n  if (color.length !== 6) {\n    throw new Error(`Invalid HEX color \"${bgColor}\" in sparted mail manager.`);\n  }\n\n  const r = parseInt(color.substring(0, 2), 16); // hexToR\n  const g = parseInt(color.substring(2, 4), 16); // hexToG\n  const b = parseInt(color.substring(4, 6), 16); // hexToB\n\n  // Values from https://www.w3.org/TR/AERT/#color-contrast\n  return r * 0.299 + g * 0.587 + b * 0.114 > 186 ? darkColor : lightColor;\n};\n"],"names":[],"mappings":";;;;AAAA,MAAM,mBAAmB,GAAG,SAAS,CAAC;AACtC,MAAM,kBAAkB,GAAG,SAAS,CAAC;AAErC;AACO,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,UAAA,GAAqB,mBAAmB,EAAE,SAAoB,GAAA,kBAAkB,KAAY;IAC5I,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC;AAE5E,IAAA,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;AACtB,QAAA,MAAM,IAAI,KAAK,CAAC,sBAAsB,OAAO,CAAA,0BAAA,CAA4B,CAAC,CAAC;AAC5E,KAAA;AAED,IAAA,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAC9C,IAAA,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAC9C,IAAA,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;;IAG9C,OAAO,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,KAAK,GAAG,GAAG,GAAG,SAAS,GAAG,UAAU,CAAC;AAC1E;;;;"}

package/color/index.d.ts

@@ -0,0 +1 @@
+export * from './get-contrast-color';

package/color/index.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var getContrastColor = require('./get-contrast-color.js');
+
+
+
+exports.getContrastColor = getContrastColor.getContrastColor;
+//# sourceMappingURL=index.js.map

package/color/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/index.d.ts

@@ -12,3 +12,4 @@ export * from './predicates';
 export * from './promise';
 export * from './string';
 export * from './types';
+export * from './color';

package/index.js

@@ -37,6 +37,7 @@ var executeWithDelay = require('./promise/execute-with-delay.js');
 var delay = require('./promise/delay.js');
 var replaceInTemplate = require('./string/replace-in-template.js');
 var isStringLengthWithinRange = require('./string/is-string-length-within-range.js');
+var getContrastColor = require('./color/get-contrast-color.js');
 
 
 
@@ -82,4 +83,5 @@ exports.executeWithDelay = executeWithDelay.executeWithDelay;
 exports.delay = delay.delay;
 exports.replaceInTemplate = replaceInTemplate.replaceInTemplate;
 exports.isStringLengthWithinRange = isStringLengthWithinRange.isStringLengthWithinRange;
+exports.getContrastColor = getContrastColor.getContrastColor;
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sparted/shared-library",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "repository": "git@github.com:Sparted/shared-library.git",
   "author": {
     "name": "Sparted",