@shakerquiz/utilities 3.0.0 → 4.0.1

package/source/entities/key.js

@@ -0,0 +1,41 @@
+export const Keys = Object.freeze(
+  /** @type {const} */ ([
+    'checkin',
+    'user',
+    'users',
+    'role',
+    'roles',
+    'country',
+    'countries',
+    'currency',
+    'currencies',
+    'timezone',
+    'timezones',
+    'city',
+    'cities',
+    'venue',
+    'venues',
+    'theme',
+    'themes',
+    'cover',
+    'game',
+    'games',
+    'registration',
+    'registrations',
+    'export',
+    'password',
+    'vk_group_token',
+    'summary',
+    'mailing',
+    'channel',
+    'confirmation',
+    'cancellation',
+  ]),
+)
+
+export const Key = Object.freeze(
+  /** @type {{ [x in typeof Keys[number]]: x }} */ (Keys.reduce(
+    (o, x) => (o[x] = x, o),
+    {},
+  )),
+)

package/source/{enumerations/core/methods.js → entities/method.js}

@@ -2,15 +2,21 @@
  * Related specifications:
  *  - HTTP/1.1 (Core Methods): {@link https://datatracker.ietf.org/doc/html/rfc7231#section-4.3}
  *  - PATCH: {@link https://datatracker.ietf.org/doc/html/rfc5789}
- *  - CONNECT: {@link https://datatracker.ietf.org/doc/html/rfc9110}
- *  - WebDAV Extensions {@link https://datatracker.ietf.org/doc/html/rfc4918}
  */
-export var Method = /** @type {const} */ ({
+export const Method = Object.freeze({
   'DELETE': 'DELETE',
   'GET': 'GET',
   'OPTIONS': 'OPTIONS',
   'PATCH': 'PATCH',
   'POST': 'POST',
+  'PUT': 'PUT',
 })
 
-export var Methods = Object.values(Method)
+export const Methods = Object.freeze([
+  'DELETE',
+  'GET',
+  'OPTIONS',
+  'PATCH',
+  'POST',
+  'PUT',
+])

package/source/entities/mode.js

@@ -0,0 +1,9 @@
+export const Mode = Object.freeze({
+  'Known': 'Known',
+  'Unknown': 'Unknown',
+})
+
+export const Modes = Object.freeze([
+  'Known',
+  'Unknown',
+])

package/source/entities/network.js

@@ -0,0 +1,9 @@
+export const Network = Object.freeze({
+  'Docker': 'Docker',
+  'Public': 'Public',
+})
+
+export const Networks = Object.freeze([
+  'Docker',
+  'Public',
+])

package/source/entities/numerosity.js

@@ -0,0 +1,5 @@
+export const Numerosity = Object.freeze({
+  'Singular': 'Singular',
+  'Dual': 'Dual',
+  'Plural': 'Plural',
+})

package/source/entities/pattern.js

@@ -0,0 +1,7 @@
+export const Pattern = Object.freeze({
+  UUID: /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/,
+  JWT: /^[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9-_.+/=]*$/,
+  COUNTRY: /[A-Z]{2}/,
+  CURRENCY: /[A-Z]{3}/,
+  ZONE: /[A-Za-z]+\/(?:[A-Za-z]+(?:_[A-Za-z]+)?)+/,
+})

package/source/entities/phase.js

@@ -0,0 +1,15 @@
+export const Phase = Object.freeze({
+  'Idle': 'Idle',
+  'Loading': 'Loading',
+  'Loaded': 'Loaded',
+  'Aborted': 'Aborted',
+  'Failed': 'Failed',
+})
+
+export const Phases = Object.freeze([
+  'Idle',
+  'Loading',
+  'Loaded',
+  'Aborted',
+  'Failed',
+])

package/source/entities/quantifier.js

@@ -0,0 +1,41 @@
+export const Quantifier = Object.freeze({
+  'Any': 'Any',
+  'None': 'None',
+  'Single': 'Single',
+  'Many': 'Many',
+  'All': 'All',
+})
+
+export const Quantifiers = Object.freeze([
+  'Any',
+  'None',
+  'Single',
+  'Many',
+  'All',
+])
+
+export const QuantifierQuantifiers = Object.freeze({
+  'Any': Object.freeze([
+    'Any',
+    'None',
+    'Single',
+    'Many',
+    'All',
+  ]),
+
+  'None': Object.freeze([
+    'None',
+  ]),
+
+  'Single': Object.freeze([
+    'Single',
+  ]),
+
+  'Many': Object.freeze([
+    'Many',
+  ]),
+
+  'All': Object.freeze([
+    'All',
+  ]),
+})

package/source/entities/registration-attribute.js

@@ -0,0 +1,61 @@
+// import { toStringTag } from '../helpers/string-tag.js'
+
+export const RegistrationAttribute = Object.freeze({
+  'Alone': 'Alone',
+  'Newcomer': 'Newcomer',
+  'Birthday': 'Birthday',
+  'Public': 'Public',
+})
+
+export const RegistrationAttributes = Object.freeze(Object.values(RegistrationAttribute))
+
+export const RegistrationAttributeEmoji = Object.freeze({
+  [RegistrationAttribute.Alone]: '👤',
+  [RegistrationAttribute.Newcomer]: '✨',
+  [RegistrationAttribute.Birthday]: '🎂',
+  [RegistrationAttribute.Public]: '🫂',
+})
+
+// export var RegistrationAttributeRegistrationProperty = /** @type {const} */ ({
+//   [RegistrationAttribute.Alone]: 'is_alone',
+//   [RegistrationAttribute.Newcomer]: 'is_first',
+//   [RegistrationAttribute.Birthday]: 'is_birthday',
+//   [RegistrationAttribute.Public]: 'is_extensible',
+// })
+
+// export var RegistrationAttributeRegistrationProperties = Object.values(RegistrationAttributeRegistrationProperty)
+
+// export var RegistrationPropertyRegistrationAttribute = {
+//   [RegistrationAttributeRegistrationProperty[RegistrationAttribute.Alone]]: RegistrationAttribute.Alone,
+//   [RegistrationAttributeRegistrationProperty[RegistrationAttribute.Newcomer]]: RegistrationAttribute.Newcomer,
+//   [RegistrationAttributeRegistrationProperty[RegistrationAttribute.Birthday]]: RegistrationAttribute.Birthday,
+//   [RegistrationAttributeRegistrationProperty[RegistrationAttribute.Public]]: RegistrationAttribute.Public,
+// }
+
+// /**
+//  * @param {RegistrationAttribute[] | Partial<Pick<RegistrationTable, 'is_alone' | 'is_birthday' | 'is_extensible' | 'is_first'>>} value
+//  */
+// export var getRegistrationAttributes = value => {
+//   switch (toStringTag(value)) {
+//     case 'Object':
+//       return RegistrationAttributeRegistrationProperties
+//         .map(property => value[property] ? RegistrationPropertyRegistrationAttribute[property] : '')
+//         .filter(Boolean)
+
+//     case 'Array':
+//       if (!value.every(attribute => RegistrationAttributes.includes(attribute)))
+//         throw TypeError(
+//           `[Function: getRegistrationAttributes] Parameter 'value': '${value}' of type 'Array' must include only members of 'RegistrationAttributes'.`,
+//         )
+
+//       return value.reduce((attributes, attribute) => {
+//         attributes[RegistrationAttributeRegistrationProperty[attribute]] = true
+//         return attributes
+//       }, {})
+
+//     default:
+//       throw TypeError(
+//         `[Function: getRegistrationAttributes] Parameter 'value': '${value}' must be of types: 'Object', 'Array'.`,
+//       )
+//   }
+// }

package/source/entities/registration-channel.js

@@ -0,0 +1,11 @@
+export const RegistrationChannel = Object.freeze({
+  'vkontakte': 'vkontakte',
+  'telegramBot': 'telegramBot',
+  'email': 'email',
+})
+
+export const RegistrationChannels = Object.freeze([
+  'vkontakte',
+  'telegramBot',
+  'email',
+])

package/source/entities/registration-lineup.js

@@ -0,0 +1,14 @@
+export const RegistrationLineup = Object.freeze({
+  'Main': 'Main',
+  'Reserve': 'Reserve',
+})
+
+export const RegistrationLineups = Object.freeze([
+  'Main',
+  'Reserve',
+])
+
+export const RegistrationLineupEmoji = Object.freeze({
+  'Main': '🟢',
+  'Reserve': '🟡',
+})

package/source/entities/registration-mailing.js

@@ -0,0 +1,20 @@
+export const RegistrationMailing = Object.freeze({
+  'Idle': 'Idle',
+  'Pending': 'Pending',
+  'Delivered': 'Delivered',
+  'Failed': 'Failed',
+})
+
+export const RegistrationMailings = Object.freeze([
+  'Idle',
+  'Pending',
+  'Delivered',
+  'Failed',
+])
+
+export const RegistrationMailingColor = Object.freeze({
+  'Idle': 'default',
+  'Pending': 'warning',
+  'Delivered': 'success',
+  'Failed': 'danger',
+})

package/source/entities/registration-status.js

@@ -0,0 +1,19 @@
+export const RegistrationStatus = Object.freeze({
+  'Created': 'Created',
+  'Confirmed': 'Confirmed',
+  'Cancelled': 'Cancelled',
+})
+
+/** @satisfies {Array<keyof typeof RegistrationStatus>} */
+export const RegistrationStatuses = Object.freeze([
+  'Created',
+  'Confirmed',
+  'Cancelled',
+])
+
+/** @satisfies {Record<keyof typeof RegistrationStatus, string>} */
+export const RegistrationStatusEmoji = Object.freeze({
+  'Confirmed': '✅',
+  'Created': '📝',
+  'Cancelled': '❌',
+})

package/source/entities/role.js

@@ -0,0 +1,16 @@
+export const Role = Object.freeze({
+  'admin': 'admin',
+  'organizer': 'organizer',
+  'captain': 'captain',
+  'player': 'player',
+  'user': 'user',
+  'manager': 'manager',
+})
+
+export const Roles = Object.freeze([
+  'admin',
+  'captain',
+  'player',
+  'user',
+  'manager',
+])

package/source/entities/route-cardinality.js

@@ -0,0 +1,151 @@
+/* --- AUTOGENERATED --- */
+
+export const RouteCardinalities = Object.freeze( /** @type {const} */ ([
+  "1",
+  "n",
+  "1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/n",
+  "n",
+  "n/1",
+  "n/1",
+  "n/n",
+  "1",
+  "n",
+  "n/1",
+  "n/1",
+  "n/1",
+  "n/n",
+  "1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/n",
+  "1",
+  "n",
+  "1",
+  "n",
+  "1",
+  "n",
+  "1",
+  "1/1",
+  "n",
+  "n/1",
+  "1",
+  "1/1",
+  "n",
+  "n/1",
+  "n/n",
+  "1",
+  "1/1",
+  "1/1",
+  "1/n",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "n",
+  "n/1",
+  "n/n",
+  "n/1",
+  "n/1",
+  "n/1",
+  "n/1",
+  "n/1",
+  "1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "1/1",
+  "n",
+  "n/1",
+  "n/1",
+  "n/1",
+  "n/1"
+]))
+
+export const RouteCardinality = Object.freeze(/** @type {const} */ ({
+  "role": "1",
+  "roles": "n",
+  "user": "1",
+  "user/password": "1/1",
+  "user/role": "1/1",
+  "user/city": "1/1",
+  "user/cities": "1/n",
+  "users": "n",
+  "users/password": "n/1",
+  "users/role": "n/1",
+  "users/cities": "n/n",
+  "checkin": "1",
+  "cities": "n",
+  "cities/country": "n/1",
+  "cities/currency": "n/1",
+  "cities/timezone": "n/1",
+  "cities/venues": "n/n",
+  "city": "1",
+  "city/vk_group_token": "1/1",
+  "city/country": "1/1",
+  "city/currency": "1/1",
+  "city/timezone": "1/1",
+  "city/venue": "1/1",
+  "city/venues": "1/n",
+  "country": "1",
+  "countries": "n",
+  "currency": "1",
+  "currencies": "n",
+  "timezone": "1",
+  "timezones": "n",
+  "venue": "1",
+  "venue/city": "1/1",
+  "venues": "n",
+  "venues/city": "n/1",
+  "theme": "1",
+  "theme/cover": "1/1",
+  "themes": "n",
+  "themes/cover": "n/1",
+  "themes/games": "n/n",
+  "game": "1",
+  "game/city": "1/1",
+  "game/registration": "1/1",
+  "game/registrations": "1/n",
+  "game/registrations/export": "1/1",
+  "game/summary": "1/1",
+  "game/theme": "1/1",
+  "game/theme/cover": "1/1",
+  "game/venue": "1/1",
+  "games": "n",
+  "games/city": "n/1",
+  "games/registrations": "n/n",
+  "games/registrations/export": "n/1",
+  "games/summary": "n/1",
+  "games/theme": "n/1",
+  "games/theme/cover": "n/1",
+  "games/venue": "n/1",
+  "registration": "1",
+  "registration/cancellation": "1/1",
+  "registration/channel": "1/1",
+  "registration/confirmation": "1/1",
+  "registration/export": "1/1",
+  "registration/city": "1/1",
+  "registration/game": "1/1",
+  "registration/game/theme": "1/1",
+  "registration/game/theme/cover": "1/1",
+  "registration/game/venue": "1/1",
+  "registration/mailing": "1/1",
+  "registrations": "n",
+  "registrations/city": "n/1",
+  "registrations/game": "n/1",
+  "registrations/game/theme": "n/1",
+  "registrations/export": "n/1"
+}))

package/source/entities/route-parameter.js

@@ -0,0 +1,151 @@
+/* --- AUTOGENERATED --- */
+
+export const RouteParameters = Object.freeze( /** @type {const} */ ([
+  ":role",
+  "",
+  ":user",
+  ":user/:password",
+  ":user/:role",
+  ":user/:city",
+  ":user",
+  "",
+  ":password",
+  ":role",
+  "",
+  ":checkin",
+  "",
+  ":country",
+  ":currency",
+  ":timezone",
+  "",
+  ":city",
+  ":city/:vk_group_token",
+  ":city/:country",
+  ":city/:currency",
+  ":city/:timezone",
+  ":city/:venue",
+  ":city",
+  ":country",
+  "",
+  ":currency",
+  "",
+  ":timezone",
+  "",
+  ":venue",
+  ":venue/:city",
+  "",
+  ":city",
+  ":theme",
+  ":theme/:cover",
+  "",
+  ":cover",
+  "",
+  ":game",
+  ":game/:city",
+  ":game/:registration",
+  ":game",
+  ":game/:export",
+  ":game/:summary",
+  ":game/:theme",
+  ":game/:theme/:cover",
+  ":game/:venue",
+  "",
+  ":city",
+  "",
+  ":export",
+  ":summary",
+  ":theme",
+  ":theme/:cover",
+  ":venue",
+  ":registration",
+  ":registration/:cancellation",
+  ":registration/:channel",
+  ":registration/:confirmation",
+  ":registration/:export",
+  ":registration/:city",
+  ":registration/:game",
+  ":registration/:game/:theme",
+  ":registration/:game/:theme/:cover",
+  ":registration/:game/:venue",
+  ":registration/:mailing",
+  "",
+  ":city",
+  ":game",
+  ":game/:theme",
+  ":export"
+]))
+
+export const RouteParameter = Object.freeze(/** @type {const} */ ({
+  "role": ":role",
+  "roles": "",
+  "user": ":user",
+  "user/password": ":user/:password",
+  "user/role": ":user/:role",
+  "user/city": ":user/:city",
+  "user/cities": ":user",
+  "users": "",
+  "users/password": ":password",
+  "users/role": ":role",
+  "users/cities": "",
+  "checkin": ":checkin",
+  "cities": "",
+  "cities/country": ":country",
+  "cities/currency": ":currency",
+  "cities/timezone": ":timezone",
+  "cities/venues": "",
+  "city": ":city",
+  "city/vk_group_token": ":city/:vk_group_token",
+  "city/country": ":city/:country",
+  "city/currency": ":city/:currency",
+  "city/timezone": ":city/:timezone",
+  "city/venue": ":city/:venue",
+  "city/venues": ":city",
+  "country": ":country",
+  "countries": "",
+  "currency": ":currency",
+  "currencies": "",
+  "timezone": ":timezone",
+  "timezones": "",
+  "venue": ":venue",
+  "venue/city": ":venue/:city",
+  "venues": "",
+  "venues/city": ":city",
+  "theme": ":theme",
+  "theme/cover": ":theme/:cover",
+  "themes": "",
+  "themes/cover": ":cover",
+  "themes/games": "",
+  "game": ":game",
+  "game/city": ":game/:city",
+  "game/registration": ":game/:registration",
+  "game/registrations": ":game",
+  "game/registrations/export": ":game/:export",
+  "game/summary": ":game/:summary",
+  "game/theme": ":game/:theme",
+  "game/theme/cover": ":game/:theme/:cover",
+  "game/venue": ":game/:venue",
+  "games": "",
+  "games/city": ":city",
+  "games/registrations": "",
+  "games/registrations/export": ":export",
+  "games/summary": ":summary",
+  "games/theme": ":theme",
+  "games/theme/cover": ":theme/:cover",
+  "games/venue": ":venue",
+  "registration": ":registration",
+  "registration/cancellation": ":registration/:cancellation",
+  "registration/channel": ":registration/:channel",
+  "registration/confirmation": ":registration/:confirmation",
+  "registration/export": ":registration/:export",
+  "registration/city": ":registration/:city",
+  "registration/game": ":registration/:game",
+  "registration/game/theme": ":registration/:game/:theme",
+  "registration/game/theme/cover": ":registration/:game/:theme/:cover",
+  "registration/game/venue": ":registration/:game/:venue",
+  "registration/mailing": ":registration/:mailing",
+  "registrations": "",
+  "registrations/city": ":city",
+  "registrations/game": ":game",
+  "registrations/game/theme": ":game/:theme",
+  "registrations/export": ":export"
+}))