@quesmed/types 1.0.2 → 1.0.6

package/utils/uuid4.js

@@ -0,0 +1,287 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Uuid4 {
+    /**
+     * Generate a custom base 64 encoded UUID v4 (random).
+     *
+     * @param {Uint8Array} [data] Should normally be `undefined` to create a
+     *                            truly random v4 UUID.
+     * @returns {string} Returns a custom base 64 encoded UUID v4.
+     */
+    static asBase64(data) {
+        // Add an initial 4 bit zero pad so result is always 22 chars long.
+        const binString = '0000' + Uuid4._asBinString(data);
+        let result = '';
+        let pieces = [
+            0, 6, 12, 18, 24, 30, 36, 42, 48, 54, 60, 66, 72, 78, 84, 90, 96, 102,
+            108, 114, 120, 126,
+        ];
+        for (const piece of pieces) {
+            result += Uuid4._base64[binString.substr(piece, 6)];
+        }
+        return result;
+    }
+    /**
+     * Generate a hexadecimal encoded UUID v4 (random).
+     *
+     * @param {Uint8Array} [data] Should normally be `undefined` to create a
+     *                            truly random v4 UUID.
+     * @returns {string} Returns a hexadecimal encoded UUID v4.
+     */
+    static asHexString(data) {
+        const binString = Uuid4._asBinString(data);
+        let hexString = '';
+        const pieces = [0, 16, 32, 48, 64, 80, 96, 112];
+        for (const piece of pieces) {
+            hexString += parseInt(binString.substr(piece, 16), 2)
+                .toString(16)
+                .padStart(4, '0');
+        }
+        return hexString;
+    }
+    /**
+     * Generate a standard UUID v4 (random).
+     *
+     * @param {Uint8Array} [data] Should normally be `undefined` to create a
+     *                            truly random v4 UUID.
+     * @returns {string} Returns a standard UUID v4.
+     */
+    static asUuid(data) {
+        const hex = Uuid4.asHexString(data);
+        return Uuid4.fromHexStringToUuid(hex);
+    }
+    /**
+     * Convert from a base 64 encoded to a hexadecimal encoded UUID.
+     *
+     * NOTE: This method does not verify input is valid UUID.
+     *
+     * @param {string} data A base 64 encoded UUID.
+     * @returns {string} Returns a hexadecimal encoded UUID.
+     */
+    static fromBase64ToHexString(data) {
+        if (22 !== data.length) {
+            const mess = `Expected base 64 number length of 22 characters but was given length: ${data.length}`;
+            throw new RangeError(mess);
+        }
+        // Need switched keys and values so reverse lookups can be done.
+        let flipped = {};
+        for (const [key, value] of Object.entries(Uuid4._base64)) {
+            flipped[value] = key;
+        }
+        let binString = '';
+        for (let i = 0, len = data.length; i < len; ++i) {
+            binString += flipped[data[i]];
+        }
+        // Cut off 4 bit zero padding.
+        binString = binString.substr(-128);
+        let hexString = '';
+        const pieces = [0, 32, 64, 96];
+        for (const piece of pieces) {
+            hexString += parseInt(binString.substr(piece, 32), 2)
+                .toString(16)
+                .padStart(8, '0');
+        }
+        return hexString;
+    }
+    /**
+     * Convert from a base 64 encoded to a standard UUID.
+     *
+     * NOTE: This method does not verify input is valid UUID.
+     *
+     * @param {string} data The base 64 encoded UUID.
+     * @returns {string} Returns a standard UUID.
+     */
+    static fromBase64ToUuid(data) {
+        const hexString = Uuid4.fromBase64ToHexString(data);
+        return Uuid4.fromHexStringToUuid(hexString);
+    }
+    /**
+     * Convert from a hexadecimal encoded to a base 64 encoded UUID.
+     *
+     * NOTE: This method does not verify input is valid UUID.
+     *
+     * @param {string} data The hexadecimal encoded UUID.
+     * @returns {string} Returns base 64 encoded UUID.
+     */
+    static fromHexStringToBase64(data) {
+        if (32 !== data.length) {
+            const mess = `Expected hex string length of 32 characters but was given length: ${data.length}`;
+            throw new RangeError(mess);
+        }
+        let pieces = [0, 4, 8, 12, 16, 20, 24, 28];
+        let binString = '0000';
+        for (const piece of pieces) {
+            binString += parseInt(data.substr(piece, 4), 16)
+                .toString(2)
+                .padStart(16, '0');
+        }
+        let result = '';
+        pieces = [
+            0, 6, 12, 18, 24, 30, 36, 42, 48, 54, 60, 66, 72, 78, 84, 90, 96, 102,
+            108, 114, 120, 126,
+        ];
+        for (const piece of pieces) {
+            result += Uuid4._base64[binString.substr(piece, 6)];
+        }
+        return result;
+    }
+    /**
+     * Convert from a hexadecimal encoded to a standard UUID.
+     *
+     * NOTE: This method does not verify input is valid UUID.
+     *
+     * @param {string} data The hexadecimal encoded UUID.
+     * @returns {string} Returns a standard UUID.
+     */
+    static fromHexStringToUuid(data) {
+        if (32 !== data.length) {
+            const mess = `Expected hex string length of 32 characters but was given length: ${data.length}`;
+            throw new RangeError(mess);
+        }
+        const pieces = [8, 4, 4, 4, 12];
+        let start = 0;
+        let hexArray = [];
+        for (const piece of pieces) {
+            hexArray.push(data.substr(start, piece));
+            start += piece;
+        }
+        return hexArray.join('-');
+    }
+    /**
+     * Convert from a standard UUID to a base 64 encoded UUID.
+     *
+     * NOTE: This method does not verify input is valid UUID.
+     *
+     * @param {string} data The standard UUID.
+     * @returns {string} Returns base 64 encoded UUID.
+     */
+    static fromUuidToBase64(data) {
+        const hexString = data.replace(/-/g, '');
+        return Uuid4.fromHexStringToBase64(hexString);
+    }
+    /**
+     * Convert from a standard UUID to a hexadecimal encoded UUID.
+     *
+     * NOTE: This method does not verify input is valid UUID.
+     *
+     * @param {string} data The standard UUID.
+     * @returns {string} Returns a hexadecimal encoded UUID.
+     */
+    static fromUuidToHexString(data) {
+        return data.replace(/-/g, '');
+    }
+    get [Symbol.toStringTag]() {
+        return 'Uuid4';
+    }
+    /**
+     * Helper method for the common parts of creating new UUID encoded as a binary string.
+     *
+     * @param {Uint8Array} [data] Should normally be `undefined` to create a
+     *                            truly random v4 UUID.
+     * @returns {string} Returns an UUID encoded as a binary string.
+     * @private
+     */
+    static _asBinString(data) {
+        let binArray = data !== null && data !== void 0 ? data : Uuid4._getRandomArray();
+        if (16 !== binArray.length) {
+            const mess = `Expected data array length of 16 but was given length: ${binArray.length}`;
+            throw new RangeError(mess);
+        }
+        binArray[6] = (binArray[6] & 0x0f) | 0x40;
+        binArray[8] = (binArray[8] & 0x3f) | 0x80;
+        let binary = '';
+        for (const piece of binArray) {
+            binary += piece.toString(2).padStart(8, '0');
+        }
+        return binary;
+    }
+    /**
+     * Used to paste over differences in browser vs node secure random number generation.
+     *
+     * @returns {Uint8Array} Returns a new random number filled Uint8Array.
+     * @private
+     */
+    static _getRandomArray() {
+        if (typeof window === 'undefined') {
+            let crypto = require('crypto');
+            return Uint8Array.from(crypto.randomBytes(16));
+        }
+        // `result` is modified in place.
+        let result = new Uint8Array(16);
+        window.crypto.getRandomValues(result);
+        return result;
+    }
+}
+/**
+ * Used in mapping from binary to base 64 during encoding.
+ *
+ * @type {object}
+ * @private
+ */
+Uuid4._base64 = {
+    '000000': 'A',
+    '000001': 'B',
+    '000010': 'C',
+    '000011': 'D',
+    '000100': 'E',
+    '000101': 'F',
+    '000110': 'G',
+    '000111': 'H',
+    '001000': 'I',
+    '001001': 'J',
+    '001010': 'K',
+    '001011': 'L',
+    '001100': 'M',
+    '001101': 'N',
+    '001110': 'O',
+    '001111': 'P',
+    '010000': 'Q',
+    '010001': 'R',
+    '010010': 'S',
+    '010011': 'T',
+    '010100': 'U',
+    '010101': 'V',
+    '010110': 'W',
+    '010111': 'X',
+    '011000': 'Y',
+    '011001': 'Z',
+    '011010': 'a',
+    '011011': 'b',
+    '011100': 'c',
+    '011101': 'd',
+    '011110': 'e',
+    '011111': 'f',
+    '100000': 'g',
+    '100001': 'h',
+    '100010': 'i',
+    '100011': 'j',
+    '100100': 'k',
+    '100101': 'l',
+    '100110': 'm',
+    '100111': 'n',
+    '101000': 'o',
+    '101001': 'p',
+    '101010': 'q',
+    '101011': 'r',
+    '101100': 's',
+    '101101': 't',
+    '101110': 'u',
+    '101111': 'v',
+    '110000': 'w',
+    '110001': 'x',
+    '110010': 'y',
+    '110011': 'z',
+    '110100': '0',
+    '110101': '1',
+    '110110': '2',
+    '110111': '3',
+    '111000': '4',
+    '111001': '5',
+    '111010': '6',
+    '111011': '7',
+    '111100': '8',
+    '111101': '9',
+    '111110': '-',
+    '111111': '_',
+};
+exports.default = Uuid4;

package/gql_input_output_types/User.ts

@@ -1,12 +0,0 @@
-export interface ILoginUserRes {
-  token: string;
-  stripeCustomerPortalUrl: string;
-  message: string;
-}
-export interface IWithToken {
-  token: string;
-}
-export interface ILoginWithExpiredSupportRes {
-  activeUser: IWithToken | null;
-  expiredUser: IWithToken | null;
-}

package/gql_input_output_types/index.ts

@@ -1,87 +0,0 @@
-import { IChapter, Id, IVideo } from '../models';
-import { RegisterUserInput } from '../resolvers/mutation/users';
-
-export interface TokenI {
-  firstName: string;
-  lastName: string;
-  username: string;
-  iat: number;
-  exp: number;
-}
-
-export interface UserTopicQuestionsInfo {
-  question: number;
-  correctQuestions: number;
-  incorrectQuestions: number;
-}
-
-export interface UserTopicCardsInfo {
-  cardCount: number;
-  ConfidentCards: number;
-  ReviewCards: number;
-  LearnCards: number;
-}
-
-export interface TodoInfo {
-  todoId: Id;
-  cardId: Id;
-  question: string;
-  explanation: string;
-  score: number;
-  timeTaken: number;
-  dailyTask: boolean;
-  source: string;
-}
-
-export interface ISearchConcepts {
-  id: number;
-  name: string;
-  chapter: IChapter;
-  topicId: number;
-  videos: IVideo[];
-}
-
-export interface IQuesBook {
-  id: number;
-  name: string;
-  concepts: ISearchConcepts[];
-}
-
-export interface LineItemI {
-  price: string;
-  quantity: number;
-}
-
-export interface CheckoutSessionArgsI {
-  priceId: string;
-  data: RegisterUserInput;
-}
-
-export interface IUniversityCalculation {
-  universityId: number;
-  specialityTopicId: number;
-  specialityTopicCorrect: number;
-  totalCorrect: number;
-  totalIncorrect: number;
-  totalCount: number;
-  rank: number;
-}
-
-export interface IUniversityCalculationMap {
-  [key: number]: IUniversityCalculation;
-}
-
-export interface IQuestionLike {
-  like: number;
-  dislike: number;
-}
-
-export interface ICheckoutSessionRes {
-  sessionId: string;
-  tempUserId: number;
-}
-
-export interface WithError {
-  error: string;
-  isError: boolean;
-}

package/index.ts

@@ -1,18 +0,0 @@
-export const ERRORS = {
-  TOKEN_INVALID: 'Invalid token.',
-  TOKEN_MISSING: 'Missing token.',
-  TOKEN_EXPIRED: 'Expired token.',
-  SUBSCRIPTION_EXPIRED: 'Expired subscription.',
-  PERMISSION_INVALID: 'Invalid permission.',
-};
-
-export const FCM_TOPICS = {
-  GLOBAL: 'global',
-  QBANK: 'qbank',
-  OSCE: 'osce',
-};
-
-export enum EPlatformId {
-  QBANK,
-  OSCE,
-}

package/models/Card.ts

@@ -1,16 +0,0 @@
-import { IConcept } from './Concept';
-import { ICardPicture } from './Picture';
-import { ITopic } from './Topic';
-import { Id } from './Type';
-
-export interface ICard {
-  id: Id;
-  createdAt: Date | string;
-  updatedAt: Date | string;
-  topic: ITopic;
-  conceptId: Id;
-  concept: IConcept;
-  question: string;
-  explanation: string;
-  pictures: ICardPicture[];
-}

package/models/Chapter.ts

@@ -1,13 +0,0 @@
-import { IFile } from './File';
-import { IChapterPicture } from './Picture';
-import { Id } from './Type';
-
-export interface IChapter {
-  id: Id;
-  createdAt: string | Date;
-  updatedAt: string | Date;
-  explanation: string;
-  clinical: boolean;
-  pictures: IChapterPicture[];
-  files: IFile[];
-}

package/models/Concept.ts

@@ -1,25 +0,0 @@
-import { IChapter } from './Chapter';
-import { ITopic } from './Topic';
-import { Id } from './Type';
-import { IVideo } from './Video';
-
-export interface IConcept {
-  id: Id;
-  createdAt: string | Date;
-  updatedAt: string | Date;
-  name: string;
-  chapterId: Id;
-  chapter: IChapter;
-  topicId: Id;
-  topic?: ITopic;
-  videos?: IVideo[];
-}
-
-export interface IAnatomyConcept {
-  id: number;
-  name: string;
-  totalCards: number;
-  ConfidentCards: number;
-  ReviewCards: number;
-  LearnCards: number;
-}

package/models/File.ts

@@ -1,11 +0,0 @@
-import { Id } from './Type';
-
-export interface IFile {
-  id: Id;
-  createdAt: string | Date;
-  updatedAt: string | Date;
-  title: string;
-  url: string;
-  videoId?: number;
-  chapterId?: number;
-}

package/models/Marksheet.ts

@@ -1,48 +0,0 @@
-import { IQuestion } from './Question';
-import { Id } from './Type';
-
-export interface IMarksheet {
-  id: Id;
-  createdAt: Date | string;
-  endedAt: Date | string;
-  source: string;
-  marks: IMarksheetMark[];
-}
-
-export enum EQuestionLike {
-  LIKE,
-  DISLIKE,
-  REMOVE,
-}
-
-export interface IMarksheetMark {
-  id: Id;
-  index: number;
-  questionChoiceId: Id;
-  timeTaken: number;
-  question: IQuestion;
-  mark?: string;
-  flagged: boolean;
-  like: number;
-  dislike: number;
-  isLikeByMe: string;
-  discussion: IDiscussion[];
-}
-
-export interface IDiscussion {
-  username: string;
-  userId: Id;
-  createdAt: Date | string;
-  comment: string;
-  like: number;
-  dislike: number;
-  isLikeByMe: string;
-  commentId: number;
-  questionId: number;
-  reply: IDiscussion[];
-}
-
-export interface ILikeDislikeCount {
-  like: number;
-  dislike: number;
-}

package/models/MockTest.ts

@@ -1,20 +0,0 @@
-import { IQuestion } from './Question';
-import { Id } from './Type';
-
-export interface IMockTest {
-  id: Id;
-  title: string;
-  clinical: boolean;
-  questions: IQuestion[];
-}
-
-export interface IUserMockTest {
-  id: Id;
-  title: string;
-  correct: number;
-  incorrect: number;
-  totalQuestions: number;
-  lastMarksheetId?: Id;
-  lastMarksheetStartedAt?: Date | string;
-  lastMarksheetEndedAt?: Date | string;
-}

package/models/OsceMarksheet.ts

@@ -1,61 +0,0 @@
-import { IOsceGroup } from '../resolvers/subscription';
-import { IOsceStation, IOsceStationMark, IOsceType } from './OsceStation';
-import { Id } from './Type';
-
-export interface IOsceMarksheetMark {
-  id: Id;
-  mark: boolean;
-  osceMarksheetId: Id;
-  osceMarksheet?: IOsceMarksheet;
-  osceStationMarkId: Id;
-  osceStationMark?: IOsceStationMark;
-}
-
-export enum EOsceRoles {
-  CANDIDATE,
-  ACTOR,
-  EXAMINER,
-  OBSERVER,
-}
-
-export enum EOsceMarksheetAction {
-  START,
-  PAUSE,
-  END,
-  CONNECT,
-  DISCONNECT,
-  SELECT,
-}
-
-export interface IOsceMarksheet {
-  id: Id;
-  createdAt: Date | string;
-  updatedAt: Date | string;
-  timeTaken: number;
-  osceStationId: Id;
-  osceStation?: IOsceStation;
-  userId: Id;
-  solo: boolean;
-  role: EOsceRoles;
-  score: number;
-  globalScore: number;
-  feedback: string;
-  agoraId: string;
-  readingTime: number;
-  stationTime: number;
-  feedbackTime: number;
-  marks: IOsceMarksheetMark[];
-  users: IOsceGroup['members'];
-}
-
-export interface IDashboardOsce {
-  types: IOsceTypeDashboard[];
-  avgScore: number;
-  completed: number;
-  total: number;
-}
-
-export interface IOsceTypeDashboard extends IOsceType {
-  completed: number;
-  total: number;
-}

package/models/OsceStation.ts

@@ -1,44 +0,0 @@
-import { IConcept } from './Concept';
-import { Id } from './Type';
-
-export interface IOsceType {
-  id: Id;
-  name: string;
-}
-
-export interface IOsceStationMark {
-  id: Id;
-  osceStationId: Id;
-  header: string;
-  name: string;
-}
-
-export enum EOsceType {
-  HISTORY_TAKING = 1,
-  COMMUNICATION_SKILLS,
-  CLINICAL,
-  PRACTICAL,
-  DATA_INTERPRETATION,
-  INTEGRATED,
-}
-
-export interface IOsceStation {
-  id: Id;
-  createdAt: Date | string;
-  updatedAt: Date | string;
-  name: string;
-  osceTypeId: Id;
-  osceType?: IOsceType;
-  difficulty: number;
-  candidateBrief: string;
-  examinerBrief: string;
-  actorBrief: string;
-  explanation: string;
-  marks: IOsceStationMark[];
-  concepts?: IConcept[];
-}
-
-export interface IOsceStationItem extends IOsceStation {
-  attempted: boolean;
-  score: number;
-}

package/models/Picture.ts

@@ -1,37 +0,0 @@
-import { ITopic } from './Topic';
-import { Id } from './Type';
-
-export interface IPicture {
-  id: Id;
-  createdAt: string | Date;
-  updatedAt: string | Date;
-  name: string;
-  caption: string;
-  path: string;
-  path512: string;
-  path256: string;
-  topicId: Id;
-  topic: ITopic;
-}
-
-export interface IQuestionPicture {
-  id: Id;
-  pictureId: Id;
-  questionId: Id;
-  choiceId: Id | null;
-  picture: IPicture;
-}
-
-export interface ICardPicture {
-  id: Id;
-  pictureId: Id;
-  cardId: Id;
-  picture: IPicture;
-}
-
-export interface IChapterPicture {
-  id: Id;
-  pictureId: Id;
-  chapterId: Id;
-  picture: IPicture;
-}

package/models/Promo.ts

@@ -1,16 +0,0 @@
-import { Id } from './Type';
-
-export interface ICoupon {
-  id: Id;
-  createdAt: string | Date;
-  name: string;
-  affiliateId: Id;
-}
-
-export interface IPromoReport {
-  id: Id;
-  date: string | Date;
-  couponId: Id;
-  userId: Id;
-  subscriptionId: Id;
-}