@shakerquiz/utilities 1.0.0 → 3.0.0

package/dprint.json

@@ -6,27 +6,19 @@
     "useTabs": false,
     "useBraces": "maintain",
     "arrowFunction.useParentheses": "preferNone",
-    "lineWidth": 80
+    "lineWidth": 120,
+    "importDeclaration.forceSingleLine": true
   },
-
   "json": {},
-
   "markdown": {},
-
   "dockerfile": {},
-
   "yaml": {},
-
   "excludes": [
     "**/node_modules",
     "**/*-lock.json"
   ],
-
   "plugins": [
     "https://plugins.dprint.dev/typescript-0.93.0.wasm",
-    "https://plugins.dprint.dev/json-0.19.3.wasm",
-    "https://plugins.dprint.dev/markdown-0.17.8.wasm",
-    "https://plugins.dprint.dev/dockerfile-0.3.2.wasm",
-    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.0.wasm"
+    "https://plugins.dprint.dev/json-0.19.3.wasm"
   ]
-}
+}

package/jsconfig.json

@@ -1,11 +1,18 @@
 {
   "compilerOptions": {
     "baseUrl": ".",
-
     "module": "NodeNext",
     "moduleResolution": "nodenext",
-
-    "strictBindCallApply": true,
-    "allowArbitraryExtensions": true
-  }
-}
+    "allowJs": true,
+    "emitDeclarationOnly": true,
+    "declaration": true,
+    "paths": {
+      "source/": [
+        "./source/*"
+      ]
+    }
+  },
+  "include": [
+    "source/**/*"
+  ]
+}

package/package.json

@@ -1,20 +1,17 @@
 {
+  "type": "module",
   "name": "@shakerquiz/utilities",
-  "version": "1.0.0",
+  "version": "3.0.0",
   "author": "yurkimus <yurkimus@gmail.com>",
   "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/shaker-quiz/utilities.git"
+  },
   "exports": {
     ".": {
-      "types": "./source/index.d.ts",
-      "import": "./source/index.js",
-      "edge-light": "./source/index.js"
-    }
-  },
-  "dependencies": {
-    "@yurkimus/cookies": "0.0.7",
-    "@yurkimus/errors": "0.1.3",
-    "@yurkimus/message": "0.0.13",
-    "@yurkimus/response-status": "0.1.0",
-    "@yurkimus/url": "0.2.7"
+      "default": "./source/index.js"
+    },
+    "./schemas/*.json": "./source/schemas/*.json"
   }
 }

package/source/enumerations/core/features.js

@@ -0,0 +1,56 @@
+export var Feature = /** @type {const} */ ({
+  'role': 'role',
+  'roles': 'roles',
+  'user': 'user',
+  'users': 'users',
+  'checkin': 'checkin',
+  'checkins': 'checkins',
+  'country': 'country',
+  'countries': 'countries',
+  'currency': 'currency',
+  'currencies': 'currencies',
+  'timezone': 'timezone',
+  'timezones': 'timezones',
+  'city': 'city',
+  'cities': 'cities',
+  'venue': 'venue',
+  'venues': 'venues',
+  'theme': 'theme',
+  'themes': 'themes',
+  'game': 'game',
+  'games': 'games',
+  'registration': 'registration',
+  'registrations': 'registrations',
+  'mailing': 'mailing',
+  'mailings': 'mailings',
+})
+
+export var Features = Object.values(Feature)
+
+/** @type {Record<Feature, Icon>} */
+export var FeatureIcon = {
+  [Feature.role]: 'hero/solid/identification',
+  [Feature.roles]: 'hero/solid/identification',
+  [Feature.user]: 'hero/solid/users',
+  [Feature.users]: 'hero/solid/users',
+  [Feature.checkin]: 'arrow-right-end-on-rectangle',
+  [Feature.checkins]: 'arrow-right-end-on-rectangle',
+  [Feature.country]: 'hero/outline/no-symbol',
+  [Feature.countries]: 'hero/outline/no-symbol',
+  [Feature.currency]: 'hero/outline/banknotes',
+  [Feature.currencies]: 'hero/outline/banknotes',
+  [Feature.timezone]: 'hero/outline/no-symbol',
+  [Feature.timezones]: 'hero/outline/no-symbol',
+  [Feature.city]: 'hero/outline/building-office',
+  [Feature.cities]: 'hero/outline/building-office',
+  [Feature.venue]: 'hero/outline/map-pin',
+  [Feature.venues]: 'hero/outline/map-pin',
+  [Feature.theme]: 'hero/outline/document-text',
+  [Feature.themes]: 'hero/outline/document-text',
+  [Feature.game]: 'hero/outline/newspaper',
+  [Feature.games]: 'hero/outline/newspaper',
+  [Feature.registration]: 'hero/outline/user-group',
+  [Feature.registrations]: 'hero/outline/user-group',
+  [Feature.mailing]: 'hero/outline/envelope',
+  [Feature.mailings]: 'hero/outline/envelope',
+}

package/source/enumerations/core/methods.js

@@ -0,0 +1,16 @@
+/**
+ * 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} */ ({
+  'DELETE': 'DELETE',
+  'GET': 'GET',
+  'OPTIONS': 'OPTIONS',
+  'PATCH': 'PATCH',
+  'POST': 'POST',
+})
+
+export var Methods = Object.values(Method)

package/source/enumerations/core/networks.js

@@ -0,0 +1,6 @@
+export var Network = /** @type {const} */ ({
+  'Docker': 'Docker',
+  'Public': 'Public',
+})
+
+export var Networks = Object.values(Network)

package/source/enumerations/core/runtimes.js

@@ -0,0 +1,6 @@
+export var Runtime = /** @type {const} */ ({
+  'Next': 'Next',
+  'React': 'React',
+})
+
+export var Runtimes = Object.values(Runtime)

package/source/enumerations/entities/affilation.js

@@ -0,0 +1,91 @@
+export var Affilation = /** @type {const} */ ({
+  'Branch': 'Branch',
+  'Franchise': 'Franchise',
+  'Unknown': 'Unknown',
+})
+
+export var Affilations = Object.values(Affilation)
+
+export var AffilationWeight = {
+  [Affilation['Branch']]: 0,
+  [Affilation['Franchise']]: 1,
+  [Affilation['Unknown']]: 2,
+}
+
+export var AffilationTitle = {
+  [Affilation['Branch']]: 'Филиал',
+  [Affilation['Franchise']]: 'Франшиза',
+  [Affilation['Unknown']]: 'Неизвестно',
+}
+
+export var AffilationActionTitle = {
+  [Affilation['Branch']]: '',
+  [Affilation['Franchise']]: '',
+  [Affilation['Unknown']]: '',
+}
+
+export var AffilationActionDescpription = {
+  [Affilation['Branch']]: '',
+  [Affilation['Franchise']]: '',
+  [Affilation['Unknown']]: '',
+}
+
+export var AffilationColor = {
+  [Affilation['Branch']]: 'primary',
+  [Affilation['Franchise']]: 'secondary',
+  [Affilation['Unknown']]: 'danger',
+}
+
+export var AffilationTextColor = {
+  [Affilation['Branch']]: 'text-primary',
+  [Affilation['Franchise']]: 'text-secondary',
+  [Affilation['Unknown']]: 'text-danger',
+}
+
+/** @type {Record<Affilation, Icon>} */
+export var AffilationIcon = {
+  [Affilation['Branch']]: 'hero/outline/building-office-2',
+  [Affilation['Franchise']]: 'hero/outline/building-storefront',
+  [Affilation['Unknown']]: 'hero/outline/no-symbol',
+}
+
+/** @type {Record<Affilation, Pick<CityTable, 'is_franchise'>>} */
+export var AffilationShape = {
+  [Affilation['Branch']]: {
+    is_franchise: false,
+  },
+
+  [Affilation['Franchise']]: {
+    is_franchise: true,
+  },
+
+  [Affilation['Unknown']]: {
+    is_franchise: null,
+  },
+}
+
+export var AffilationShapes = Object.entries(AffilationShape)
+
+/**
+ * @param {Affilation | typeof AffilationShape[Affilation]} value
+ */
+export var getAffilation = value => {
+  if (value === null)
+    return Affilation['Unknown']
+
+  switch (typeof value) {
+    case 'object':
+      return AffilationShapes
+        .find(([, object]) => object.is_franchise === value.is_franchise)
+        ?.at(0)
+        ?? Affilation['Unknown']
+
+    case 'string':
+      return value in AffilationShape
+        ? AffilationShape[value]
+        : AffilationShape[Affilation['Unknown']]
+
+    default:
+      return Affilation['Unknown']
+  }
+}

package/source/enumerations/entities/cities-mode.js

@@ -0,0 +1,49 @@
+export var CitiesMode = /** @type {const} */ ({
+  'all': 'all',
+  'many': 'many',
+  'single': 'single',
+  'none': 'none',
+  'unknown': 'unknown',
+})
+
+export var CitiesModes = Object.values(CitiesMode)
+
+export var CitiesModeTitle = {
+  [CitiesMode.all]: 'Все',
+  [CitiesMode.many]: 'Несколько',
+  [CitiesMode.single]: 'Один',
+  [CitiesMode.none]: 'Пусто',
+  [CitiesMode.unknown]: 'Не назначено',
+}
+
+export var CitiesModeWeigth = {
+  [CitiesMode.all]: 0,
+  [CitiesMode.many]: 1,
+  [CitiesMode.single]: 2,
+  [CitiesMode.none]: 3,
+  [CitiesMode.unknown]: 4,
+}
+
+/**
+ * @param {keyof typeof CitiesMode} value
+ */
+var getter = value =>
+  value in CitiesMode
+    ? value
+    : CitiesMode['unknown']
+
+export var getCitiesMode = value => {
+  if (value === null)
+    return getter(undefined)
+
+  switch (typeof value) {
+    case 'string':
+      return getter(value)
+
+    case 'object':
+      return getter(value?.mode)
+
+    default:
+      return getter(undefined)
+  }
+}

package/source/enumerations/entities/city/timezone-mode.js

@@ -0,0 +1,44 @@
+export var CityTimezoneMode = /** @type {const} */ ({
+  'Any': 'Any',
+  'Known': 'Known',
+  'Unknown': 'Unknown',
+})
+
+export var CityTimezoneModes = [
+  CityTimezoneMode['Any'],
+  CityTimezoneMode['Known'],
+  CityTimezoneMode['Unknown'],
+]
+
+export var CityTimezoneModeTitle = {
+  [CityTimezoneMode['Any']]: 'Любой',
+  [CityTimezoneMode['Known']]: 'Назначено',
+  [CityTimezoneMode['Unknown']]: 'Неизвестно',
+}
+
+export var CityTimezoneModeIcon = {
+  [CityTimezoneMode['Any']]: 'hero/outline/square-2-stack',
+  [CityTimezoneMode['Known']]: 'hero/outline/check',
+  [CityTimezoneMode['Unknown']]: 'hero/outline/no-symbol',
+}
+
+/**
+ * @returns {keyof typeof CityTimezoneMode} value
+ */
+var inferString = value =>
+  value in CityTimezoneMode
+    ? value
+    : CityTimezoneMode['Unknown']
+
+export var inferCityTimezoneMode = value => {
+  switch (typeof value) {
+    case 'string':
+      return inferString(value)
+
+    case 'object':
+      return inferString(value?.mode)
+
+    default:
+      return CityTimezoneMode['Unknown']
+  }
+}

package/source/enumerations/entities/city/venues-mode.js

@@ -0,0 +1,60 @@
+export var CityVenuesMode = /** @type {const} */ ({
+  'Any': 'Any',
+  'None': 'None',
+  'Single': 'Single',
+  'Many': 'Many',
+  'Unknown': 'Unknown',
+})
+
+export var CityVenuesModes = [
+  CityVenuesMode['Any'],
+  CityVenuesMode['None'],
+  CityVenuesMode['Single'],
+  CityVenuesMode['Many'],
+  CityVenuesMode['Unknown'],
+]
+
+export var CityVenuesModeTitle = {
+  [CityVenuesMode['None']]: 'Любые',
+  [CityVenuesMode['None']]: 'Пусто',
+  [CityVenuesMode['Single']]: 'Одно',
+  [CityVenuesMode['Many']]: 'Несколько',
+  [CityVenuesMode['Unknown']]: 'Неизвестно',
+}
+
+export var CityVenuesModeIcon = {
+  [CityVenuesMode['Any']]: 'hero/outline/square-2-stack',
+  [CityVenuesMode['None']]: 'hero/outline/no-symbol',
+  [CityVenuesMode['Single']]: 'hero/outline/no-symbol',
+  [CityVenuesMode['Many']]: 'hero/outline/no-symbol',
+  [CityVenuesMode['Unknown']]: 'hero/outline/no-symbol',
+}
+
+/**
+ * @returns {keyof typeof CityVenuesMode} value
+ */
+var fromString = value =>
+  value in CityVenuesMode
+    ? value
+    : CityVenuesMode['Unknown']
+
+/**
+ * @returns {keyof typeof CityVenuesMode} value
+ */
+var fromObject = value =>
+  value?.mode in CityVenuesMode
+    ? value.mode
+    : CityVenuesMode['Unknown']
+
+export var inferCityVenuesMode = value => {
+  switch (typeof value) {
+    case 'string':
+      return fromString(value)
+
+    case 'object':
+      return fromObject(value)
+
+    default:
+      return CityVenuesMode['Unknown']
+  }
+}

package/source/enumerations/entities/game-status.js

@@ -0,0 +1,130 @@
+import { Role } from './role.js'
+
+export var GameStatus = /** @type {const} */ ({
+  'REJECTED': 'REJECTED',
+  'MODERATION': 'MODERATION',
+  'APPROVED': 'APPROVED',
+  'CLOSED': 'CLOSED',
+  'FORINVITES': 'FORINVITES',
+  'PUBLISHED': 'PUBLISHED',
+  'IS_RESERVE': 'IS_RESERVE',
+  'FINISHED': 'FINISHED',
+  'ARCHIVE': 'ARCHIVE',
+})
+
+export var GameStatuses = Object.values(GameStatus)
+
+export var GameStatusWeight = {
+  [GameStatus.REJECTED]: 0,
+  [GameStatus.MODERATION]: 1,
+  [GameStatus.APPROVED]: 2,
+  [GameStatus.CLOSED]: 3,
+  [GameStatus.FORINVITES]: 4,
+  [GameStatus.PUBLISHED]: 5,
+  [GameStatus.IS_RESERVE]: 6,
+  [GameStatus.FINISHED]: 7,
+  [GameStatus.ARCHIVE]: 8,
+}
+
+export var GameStatusTitle = {
+  [GameStatus.REJECTED]: 'Отклонено',
+  [GameStatus.MODERATION]: 'На проверке',
+  [GameStatus.APPROVED]: 'Одобрено',
+  [GameStatus.CLOSED]: 'Закрыта',
+  [GameStatus.FORINVITES]: 'По приглашению',
+  [GameStatus.PUBLISHED]: 'Опубликовано',
+  [GameStatus.IS_RESERVE]: 'В резерве',
+  [GameStatus.FINISHED]: 'Завершено',
+  [GameStatus.ARCHIVE]: 'В архиве',
+}
+
+export var GameStatusColor = {
+  [GameStatus.REJECTED]: 'danger',
+  [GameStatus.MODERATION]: 'primary',
+  [GameStatus.APPROVED]: 'success',
+  [GameStatus.CLOSED]: 'warning',
+  [GameStatus.FORINVITES]: 'current',
+  [GameStatus.PUBLISHED]: 'secondary',
+  [GameStatus.IS_RESERVE]: 'blue-900',
+  [GameStatus.FINISHED]: 'success',
+  [GameStatus.ARCHIVE]: 'current',
+}
+
+export var GameStatusTextColor = {
+  [GameStatus.REJECTED]: 'text-danger',
+  [GameStatus.MODERATION]: 'text-primary',
+  [GameStatus.APPROVED]: 'text-success',
+  [GameStatus.CLOSED]: 'text-warning',
+  [GameStatus.FORINVITES]: 'text-current',
+  [GameStatus.PUBLISHED]: 'text-secondary',
+  [GameStatus.IS_RESERVE]: 'text-blue-900',
+  [GameStatus.FINISHED]: 'text-success',
+  [GameStatus.ARCHIVE]: 'text-current',
+}
+
+/** @type {Record<GameStatus, Icon>} */
+export var GameStatusIcon = {
+  [GameStatus.REJECTED]: 'hero/outline/x-mark',
+  [GameStatus.MODERATION]: 'hero/outline/clock',
+  [GameStatus.APPROVED]: 'hero/outline/hand-thumb-up',
+  [GameStatus.CLOSED]: 'hero/outline/exclamation-triangle',
+  [GameStatus.FORINVITES]: 'hero/outline/lock-closed',
+  [GameStatus.PUBLISHED]: 'hero/outline/check-circle',
+  [GameStatus.IS_RESERVE]: 'hero/outline/user-plus',
+  [GameStatus.FINISHED]: 'hero/outline/check',
+  [GameStatus.ARCHIVE]: 'hero/outline/archive-box',
+}
+
+/** @type {{ [Key in Role]: Partial<Record<GameStatus, GameStatus[]>> }} */
+export var RoleGameStatusGameStatuses = {
+  [Role.admin]: {},
+
+  [Role.organizer]: {
+    [GameStatus.APPROVED]: [
+      GameStatus.APPROVED,
+      GameStatus.CLOSED,
+      GameStatus.FORINVITES,
+      GameStatus.PUBLISHED,
+      GameStatus.IS_RESERVE,
+      GameStatus.FINISHED,
+      GameStatus.ARCHIVE,
+    ],
+
+    [GameStatus.MODERATION]: [
+      GameStatus.MODERATION,
+    ],
+
+    [GameStatus.REJECTED]: [
+      GameStatus.REJECTED,
+      GameStatus.MODERATION,
+    ],
+  },
+
+  [Role.default]: {},
+}
+
+/** @type {{ [Key in Role]: GameStatus[] }} */
+export var RoleDefaultGameStatuses = {
+  [Role.admin]: [
+    'APPROVED',
+    'ARCHIVE',
+    'CLOSED',
+    'FINISHED',
+    'FORINVITES',
+    'IS_RESERVE',
+    'MODERATION',
+    'PUBLISHED',
+    'REJECTED',
+  ],
+
+  [Role.organizer]: [
+    'ARCHIVE',
+    'CLOSED',
+    'FINISHED',
+    'FORINVITES',
+    'IS_RESERVE',
+    'PUBLISHED',
+  ],
+
+  [Role.default]: [],
+}

package/source/enumerations/entities/password-mode.js

@@ -0,0 +1,40 @@
+export var PasswordMode = /** @type {const} */ ({
+  'known': 'known',
+  'unknown': 'unknown',
+})
+
+export var PasswordModes = Object.values(PasswordMode)
+
+export var PasswordModeTitle = {
+  [PasswordMode.known]: 'Назначен',
+  [PasswordMode.unknown]: 'Неизвестно',
+}
+
+export var PasswordModeWeight = {
+  [PasswordMode.known]: 0,
+  [PasswordMode.unknown]: 1,
+}
+
+/**
+ * @param {keyof typeof PasswordMode} value
+ */
+var getter = value =>
+  value in PasswordMode
+    ? value
+    : PasswordMode['unknown']
+
+export var getPasswordMode = value => {
+  if (value === null)
+    return getter(undefined)
+
+  switch (typeof value) {
+    case 'string':
+      return getter(value)
+
+    case 'object':
+      return getter(value?.mode)
+
+    default:
+      return getter(undefined)
+  }
+}

package/source/enumerations/entities/registration-attribute.js

@@ -0,0 +1,83 @@
+import { getTag } from '../../functions/tag.js'
+
+export var RegistrationAttribute = /** @type {const} */ ({
+  'Alone': 'Alone',
+  'Newcomer': 'Newcomer',
+  'Birthday': 'Birthday',
+  'Public': 'Public',
+})
+
+export var RegistrationAttributes = Object.values(RegistrationAttribute)
+
+export var RegistrationAttributeWeight = {
+  [RegistrationAttribute.Alone]: 0,
+  [RegistrationAttribute.Newcomer]: 1,
+  [RegistrationAttribute.Birthday]: 2,
+  [RegistrationAttribute.Public]: 3,
+}
+
+export var RegistrationAttributeTitle = {
+  [RegistrationAttribute.Alone]: 'Без команды',
+  [RegistrationAttribute.Newcomer]: 'Новичок',
+  [RegistrationAttribute.Birthday]: 'День рождения',
+  [RegistrationAttribute.Public]: 'Принимаем людей',
+}
+
+/** @type {Record<RegistrationAttribute, Icon>} */
+export var RegistrationAttributeIcon = {
+  [RegistrationAttribute.Alone]: 'hero/outline/user',
+  [RegistrationAttribute.Newcomer]: 'hero/outline/sparkles',
+  [RegistrationAttribute.Birthday]: 'hero/outline/cake',
+  [RegistrationAttribute.Public]: 'hero/outline/user-plus',
+}
+
+export var RegistrationAttributeEmoji = {
+  [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 (getTag(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'.`,
+      )
+  }
+}