volleyballsimtypes 0.0.1

package/src/service/team/__stubs__/index.ts

@@ -0,0 +1,290 @@
+import { Team } from '../team'
+import { coaches } from '../../coach/__stubs__'
+import { Player, Role } from '../../player'
+import { country } from '../../country/__stubs__'
+
+export const roster: Player[] = [
+  new Player({
+    id: '7b2a8d9d-88fa-4446-8248-24ecf850ee2d',
+    jerseyNumber: 19,
+    name: { first: 'Scotti', last: 'Emmitt' }, country,
+    stats: {
+      setting: 45,
+      reception: 57,
+      pass: 57,
+      backAttack: 30,
+      jump: 66,
+      block: 35,
+      awareness: 37,
+      serve: 53,
+      spike: 55,
+      defense: 83,
+      stamina: 67
+    },
+    roles: Role.getRoles(),
+    traits: []
+  }),
+  new Player({
+    id: '02644d1a-ea42-43ee-8292-7d0e68655ba9',
+    jerseyNumber: 19,
+    name: { first: 'Sheri', last: 'Dowdall' }, country,
+    stats: {
+      setting: 78,
+      reception: 49,
+      pass: 49,
+      backAttack: 63,
+      jump: 96,
+      block: 41,
+      awareness: 38,
+      serve: 56,
+      spike: 79,
+      defense: 95,
+      stamina: 65
+    },
+    roles: [Role.SETTER, Role.OPPOSITE_HITTER, Role.OUTSIDE_HITTER, Role.MIDDLE_BLOCKER],
+    traits: []
+  }),
+  new Player({
+    id: 'f075311b-6155-4071-91e4-c41bfd3fca22',
+    jerseyNumber: 19,
+    name: { first: 'Alfi', last: 'Eaddy' }, country,
+    stats: {
+      setting: 77,
+      reception: 95,
+      pass: 95,
+      backAttack: 57,
+      jump: 92,
+      block: 58,
+      awareness: 55,
+      serve: 51,
+      spike: 61,
+      defense: 37,
+      stamina: 86
+    },
+    roles: [Role.SETTER, Role.OPPOSITE_HITTER, Role.OUTSIDE_HITTER, Role.MIDDLE_BLOCKER],
+    traits: []
+  }),
+  new Player({
+    id: '2b22931d-5cf5-4e3c-9fec-aa6d0910a911',
+    jerseyNumber: 19,
+    name: { first: 'Ofelia', last: 'Moseby' }, country,
+    stats: {
+      setting: 97,
+      reception: 91,
+      pass: 91,
+      backAttack: 48,
+      jump: 73,
+      block: 44,
+      awareness: 85,
+      serve: 62,
+      spike: 99,
+      defense: 63,
+      stamina: 51
+    },
+    roles: [Role.SETTER, Role.OPPOSITE_HITTER, Role.OUTSIDE_HITTER, Role.MIDDLE_BLOCKER],
+    traits: []
+  }),
+  new Player({
+    id: '7612d231-372d-41f4-9658-0ed6c11296ba',
+    jerseyNumber: 19,
+    name: { first: 'Arel', last: 'Marquis' }, country,
+    stats: {
+      setting: 30,
+      reception: 45,
+      pass: 45,
+      backAttack: 38,
+      jump: 92,
+      block: 34,
+      awareness: 64,
+      serve: 49,
+      spike: 92,
+      defense: 33,
+      stamina: 77
+    },
+    roles: [Role.SETTER, Role.OPPOSITE_HITTER, Role.OUTSIDE_HITTER, Role.MIDDLE_BLOCKER],
+    traits: []
+  }),
+  new Player({
+    id: '9b254ae4-ed58-4779-a5ce-7b61b1f10042',
+    jerseyNumber: 19,
+    name: { first: 'Inna', last: 'Mc Elory' }, country,
+    stats: {
+      setting: 42,
+      reception: 75,
+      pass: 75,
+      backAttack: 76,
+      jump: 36,
+      block: 46,
+      awareness: 78,
+      serve: 94,
+      spike: 58,
+      defense: 35,
+      stamina: 85
+    },
+    roles: [Role.SETTER, Role.OPPOSITE_HITTER, Role.OUTSIDE_HITTER, Role.MIDDLE_BLOCKER],
+    traits: []
+  }),
+  new Player({
+    id: '575df8e7-260e-4fb3-8384-106136608745',
+    jerseyNumber: 19,
+    name: { first: 'Fransisco', last: 'Bernardon' },
+    country,
+    stats: {
+      setting: 45,
+      reception: 87,
+      pass: 87,
+      backAttack: 96,
+      jump: 67,
+      block: 86,
+      awareness: 38,
+      serve: 51,
+      spike: 84,
+      defense: 75,
+      stamina: 53
+    },
+    roles: [Role.SETTER, Role.OPPOSITE_HITTER, Role.OUTSIDE_HITTER, Role.MIDDLE_BLOCKER],
+    traits: []
+  })
+]
+
+export const noLiberoRoster: Player[] = [
+  new Player({
+    id: '7b2a8d9d-88fa-4446-8248-24ecf850ee2d',
+    jerseyNumber: 19,
+    name: { first: 'Scotti', last: 'Emmitt' }, country,
+    stats: {
+      setting: 45,
+      pass: 57,
+      reception: 57,
+      backAttack: 30,
+      jump: 66,
+      block: 35,
+      awareness: 37,
+      serve: 53,
+      spike: 55,
+      defense: 83,
+      stamina: 67
+    },
+    roles: [Role.MIDDLE_BLOCKER],
+    traits: []
+  }),
+  new Player({
+    id: 'f075311b-6155-4071-91e4-c41bfd3fca22',
+    jerseyNumber: 19,
+    name: { first: 'Alfi', last: 'Eaddy' }, country,
+    stats: {
+      setting: 77,
+      pass: 95,
+      reception: 95,
+      backAttack: 57,
+      jump: 92,
+      block: 58,
+      awareness: 55,
+      serve: 51,
+      spike: 61,
+      defense: 37,
+      stamina: 86
+    },
+    roles: [Role.SETTER, Role.MIDDLE_BLOCKER],
+    traits: []
+  }),
+  new Player({
+    id: '2b22931d-5cf5-4e3c-9fec-aa6d0910a911',
+    jerseyNumber: 19,
+    name: { first: 'Ofelia', last: 'Moseby' }, country,
+    stats: {
+      setting: 97,
+      reception: 91,
+      pass: 91,
+      backAttack: 48,
+      jump: 73,
+      block: 44,
+      awareness: 85,
+      serve: 62,
+      spike: 99,
+      defense: 63,
+      stamina: 51
+    },
+    roles: [Role.SETTER, Role.OPPOSITE_HITTER],
+    traits: []
+  }),
+  new Player({
+    id: '7612d231-372d-41f4-9658-0ed6c11296ba',
+    jerseyNumber: 19,
+    name: { first: 'Arel', last: 'Marquis' }, country,
+    stats: {
+      setting: 30,
+      reception: 45,
+      pass: 45,
+      backAttack: 38,
+      jump: 92,
+      block: 34,
+      awareness: 64,
+      serve: 49,
+      spike: 92,
+      defense: 33,
+      stamina: 77
+    },
+    roles: [Role.OPPOSITE_HITTER, Role.OUTSIDE_HITTER],
+    traits: []
+  }),
+  new Player({
+    id: '9b254ae4-ed58-4779-a5ce-7b61b1f10042',
+    jerseyNumber: 19,
+    name: { first: 'Inna', last: 'Mc Elory' }, country,
+    stats: {
+      setting: 42,
+      reception: 75,
+      pass: 75,
+      backAttack: 76,
+      jump: 36,
+      block: 46,
+      awareness: 78,
+      serve: 94,
+      spike: 58,
+      defense: 35,
+      stamina: 85
+    },
+    roles: [Role.MIDDLE_BLOCKER, Role.OUTSIDE_HITTER],
+    traits: []
+  }),
+  new Player({
+    id: '575df8e7-260e-4fb3-8384-106136608745',
+    jerseyNumber: 19,
+    name: { first: 'Fransisco', last: 'Bernardon' },
+    country,
+    stats: {
+      setting: 45,
+      reception: 87,
+      pass: 87,
+      backAttack: 96,
+      jump: 67,
+      block: 86,
+      awareness: 38,
+      serve: 51,
+      spike: 84,
+      defense: 75,
+      stamina: 53
+    },
+    roles: [Role.SETTER, Role.OPPOSITE_HITTER, Role.OUTSIDE_HITTER, Role.MIDDLE_BLOCKER],
+    traits: []
+  })
+]
+
+export const team: Team = new Team({
+  id: '426b5b9b-5be7-4963-92eb-71b7a3b29ffd',
+  coach: coaches[0],
+  name: 'Yodo',
+  shortName: 'YOD',
+  country,
+  roster
+})
+
+export const noLiberoTeam: Team = new Team({
+  id: '426b5b9b-5be7-4963-92eb-71b7a3b29ffd',
+  coach: coaches[0],
+  roster: noLiberoRoster,
+  name: 'Rhynoodle',
+  shortName: 'RHY',
+  country
+})

package/src/service/team/index.ts

@@ -0,0 +1 @@
+export * from './team'

package/src/service/team/team.test.ts

@@ -0,0 +1,30 @@
+import { describe, expect, test } from '@jest/globals'
+import { team as t } from './__stubs__'
+import { libero, player } from '../player/__stubs__'
+import { Team } from './team'
+import { coaches } from '../coach/__stubs__'
+
+describe('Team Test Module', () => {
+  let team: Team
+
+  beforeEach(() => {
+    team = t
+  })
+
+  test('Should instantiate object properly', () => {
+    expect(team.id).toBe('426b5b9b-5be7-4963-92eb-71b7a3b29ffd')
+    expect(team.name).toEqual('Yodo')
+    expect(team.shortName).toEqual('YOD')
+    expect(team.country!.name).toEqual('Argentina')
+    expect(team.roster.length).toEqual(7)
+    expect(team.coach).toEqual(coaches[0])
+  })
+  // isPlayerInRoster Tests
+  test('Should return true when player is in roster', () => {
+    team.roster.push(player)
+    expect(team.isPlayerInRoster(player)).toBe(true)
+  })
+  test('Should return false when player is not in roster', () => {
+    expect(team.isPlayerInRoster(libero)).toBe(false)
+  })
+})

package/src/service/team/team.ts

@@ -0,0 +1,45 @@
+import { Coach } from '../coach'
+import { validateUUID } from '../utils'
+import { Player } from '../player'
+import { Country } from '../country'
+import { League } from '../league'
+
+export interface TeamOpts {
+  readonly id: string
+  readonly name: string
+  readonly shortName: string
+  readonly roster: Player[]
+  readonly country?: Country
+  readonly league?: League
+  readonly coach?: Coach
+}
+
+export class Team {
+  readonly id: string
+  readonly roster: Player[]
+  readonly name: string
+  readonly shortName: string
+  readonly coach?: Coach
+  readonly league?: League
+  readonly country?: Country
+
+  constructor ({ id, name, shortName, country, roster, coach, league }: TeamOpts) {
+    validateUUID(id)
+
+    this.id = id
+    this.roster = roster
+    this.coach = coach
+    this.name = name
+    this.shortName = shortName
+    this.country = country
+    this.league = league
+  }
+
+  public isPlayerInRoster (player: Player): boolean {
+    return this.roster.some(p => p.id === player.id)
+  }
+
+  toString (): string {
+    return `${this.name} [${this.shortName}] (${this.country?.name})`
+  }
+}

package/src/service/utils/enum-utils.test.ts

@@ -0,0 +1,10 @@
+import { getRandomEnumValue } from './index'
+import { describe, expect, test } from '@jest/globals'
+
+describe('EnumUtils Test Module', () => {
+  enum TestEnum {singleValue = 0}
+
+  test('Should get random value from enum', () => {
+    expect(getRandomEnumValue(TestEnum)).toBe(TestEnum.singleValue)
+  })
+})

package/src/service/utils/enum-utils.ts

@@ -0,0 +1,6 @@
+export function getRandomEnumValue (enumeration: any): any {
+  const values = Object.keys(enumeration).filter(k => isNaN(Number(k)))
+  const enumKey = values[Math.floor(Math.random() * values.length)]
+
+  return enumeration[enumKey]
+}

package/src/service/utils/index.ts

@@ -0,0 +1,4 @@
+export * from './enum-utils'
+export * from './string-utils'
+export * from './object-utils'
+export * from './rng-utils'

package/src/service/utils/object-utils.ts

@@ -0,0 +1 @@
+export const getKeys = Object.keys as <T extends object>(obj: T) => Array<keyof T>

package/src/service/utils/rng-utils.test.ts

@@ -0,0 +1,32 @@
+import { generateModifier, randomNumber, shuffle } from './index'
+import { describe, expect, test } from '@jest/globals'
+
+describe('RNGUtils Test Module', () => {
+  afterEach(() => { jest.spyOn(global.Math, 'random').mockRestore() })
+
+  // randomNumber Tests
+  test('Should get random value from provided range', () => {
+    const n = randomNumber(99, 100)
+
+    expect(n).toBeGreaterThanOrEqual(99)
+    expect(n).toBeLessThanOrEqual(100)
+  })
+  // generateModifier Tests
+  test('Should get 0.9 when RNG is within range', () => {
+    jest.spyOn(global.Math, 'random').mockReturnValue(0.1)
+    expect(generateModifier()).toBe(0.9)
+  })
+  test('Should get 1 when RNG is within range', () => {
+    jest.spyOn(global.Math, 'random').mockReturnValue(0.5)
+    expect(generateModifier()).toBe(1)
+  })
+  test('Should get 1.1 when RNG is within range', () => {
+    jest.spyOn(global.Math, 'random').mockReturnValue(0.99)
+    expect(generateModifier()).toBe(1.1)
+  })
+  // shuffle Tests
+  test('Should shuffle array properly', () => {
+    jest.spyOn(global.Math, 'random').mockReturnValue(0.1)
+    expect(JSON.stringify(shuffle([1, 2, 3]))).toBe(JSON.stringify([2, 3, 1]))
+  })
+})

package/src/service/utils/rng-utils.ts

@@ -0,0 +1,41 @@
+export function randomNumber (min: number, max: number): number {
+  return Math.random() * (max - min) + min
+}
+
+export function generateModifier (): number {
+  const n: number = Math.random()
+
+  switch (true) {
+    case (n >= 0.95):
+      return 1.1
+    case (n < 0.15):
+      return 0.9
+    case (n < 0.95):
+    default:
+      return 1
+  }
+}
+
+/**
+ * Fisher-Yates shuffle algorithm
+ * Shuffles array IN-PLACE
+ * @param {any[]} array
+ */
+export function shuffle<Type> (array: Type[]): Type[] {
+  let m = array.length
+  let t
+  let i
+
+  // While there remain elements to shuffle…
+  while (m > 0) {
+    // Pick a remaining element…
+    i = Math.floor(Math.random() * m--)
+
+    // And swap it with the current element.
+    t = array[m]
+    array[m] = array[i]
+    array[i] = t
+  }
+
+  return array
+}

package/src/service/utils/string-utils.test.ts

@@ -0,0 +1,28 @@
+import { formatNumber, validateUUID } from './index'
+import { describe, expect, test } from '@jest/globals'
+
+describe('StringUtils Test Module', () => {
+  // formatNumber Tests
+  test('Single digit number should by prefixed by 0', () => {
+    expect(formatNumber(1)).toBe('01')
+    expect(formatNumber(0)).toBe('00')
+  })
+  test('A number of two or more digits should be returned as is', () => {
+    expect(formatNumber(11)).toBe('11')
+    expect(formatNumber(123)).toBe('123')
+  })
+  test('A negative number should throw an exception', () => {
+    function formatNegative (): void { formatNumber(-2) }
+
+    expect(formatNegative).toThrow(/^UNEXPECTED_NEGATIVE_NUMBER$/)
+  })
+  // isValidUUID Tests
+  test('Should return true when receiving a valid UUID', () => {
+    expect(validateUUID('e46cb767-3c7c-492a-924a-ce3a28813dbc')).toBe(true)
+  })
+  test('Should throw Error when receiving an invalid UUID', () => {
+    function validate (): void { validateUUID('z46cb767-3g7c-492a-924a-ce3z28813dbc') }
+
+    expect(validate).toThrow(/^INVALID_UUID$/)
+  })
+})

package/src/service/utils/string-utils.ts

@@ -0,0 +1,13 @@
+export function formatNumber (n: number): string {
+  if (n < 0) throw new Error('UNEXPECTED_NEGATIVE_NUMBER')
+
+  return n < 10 ? `0${n}` : `${n}`
+}
+
+export function validateUUID (uuid: string): boolean {
+  const regex = /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/
+
+  if (!regex.test(uuid)) throw new Error('INVALID_UUID')
+
+  return true
+}

package/src/service/utils/testing-utils.ts

@@ -0,0 +1,2 @@
+import { Player, Role } from '../player'
+