@shakerquiz/utilities 0.6.3 → 0.6.4

package/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish
+
+on:
+  pull_request:
+    types: [ closed ]
+    branches:
+      - main
+
+permissions:
+  id-token: write
+  contents: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v6
+        with:
+          node-version: '24'
+      - run: npm install -g npm@latest
+      - run: git config user.name "github-actions[bot]"
+      - run: git config user.email "github-actions[bot]@users.noreply.github.com"
+      - run: npm version patch
+      - run: npm ci
+      - run: npm publish
+      - run: git push --follow-tags

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@shakerquiz/utilities",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "author": "yurkimus <yurkimus@gmail.com>",
   "license": "ISC",
   "repository": {

package/source/entities/city-affilation.js

@@ -8,9 +8,3 @@ export const CityAffilations = Object.freeze([
   'Branch',
   'Franchise',
 ])
-
-/** @satisfies {Record<keyof typeof CityAffilation, string>} */
-export const CityAffilationIcon = Object.freeze({
-  'Branch': 'hero/outline/building-office-2',
-  'Franchise': 'hero/outline/building-storefront',
-})

package/source/entities/game-status.js

@@ -16,18 +16,6 @@ export const GameStatus = Object.freeze({
 
 export const GameStatuses = Object.freeze(Object.values(GameStatus))
 
-export const GameStatusIcon = Object.freeze({
-  'REJECTED': 'hero/outline/x-mark',
-  'MODERATION': 'hero/outline/clock',
-  'APPROVED': 'hero/outline/hand-thumb-up',
-  'CLOSED': 'hero/outline/exclamation-triangle',
-  'FORINVITES': 'hero/outline/lock-closed',
-  'PUBLISHED': 'hero/outline/check-circle',
-  'IS_RESERVE': 'hero/outline/user-plus',
-  'FINISHED': 'hero/outline/check',
-  'ARCHIVE': 'hero/outline/archive-box',
-})
-
 export const RoleGameStatusGameStatuses = Object.freeze({
   [Role['admin']]: Object.freeze({}),
 

package/source/entities/mode.js

@@ -7,8 +7,3 @@ export const Modes = Object.freeze([
   'Known',
   'Unknown',
 ])
-
-export const ModeIcon = Object.freeze({
-  'Known': 'hero/outline/check',
-  'Unknown': 'hero/outline/no-symbol',
-})

package/source/entities/phase.js

@@ -13,11 +13,3 @@ export const Phases = Object.freeze([
   'Aborted',
   'Failed',
 ])
-
-export const PhaseIcon = Object.freeze({
-  'Idle': 'hero/outline/clock',
-  'Loading': 'hero/outline/clock',
-  'Loaded': 'hero/outline/check',
-  'Aborted': 'hero/outline/signal-slash',
-  'Failed': 'hero/outline/x-mark',
-})

package/source/entities/registration-attribute.js

@@ -9,13 +9,6 @@ export const RegistrationAttribute = Object.freeze({
 
 export const RegistrationAttributes = Object.freeze(Object.values(RegistrationAttribute))
 
-export const RegistrationAttributeIcon = Object.freeze({
-  [RegistrationAttribute.Alone]: 'hero/outline/user',
-  [RegistrationAttribute.Newcomer]: 'hero/outline/sparkles',
-  [RegistrationAttribute.Birthday]: 'hero/outline/cake',
-  [RegistrationAttribute.Public]: 'hero/outline/user-plus',
-})
-
 export const RegistrationAttributeEmoji = Object.freeze({
   [RegistrationAttribute.Alone]: '👤',
   [RegistrationAttribute.Newcomer]: '✨',

package/source/entities/registration-channel.js

@@ -9,9 +9,3 @@ export const RegistrationChannels = Object.freeze([
   'telegramBot',
   'email',
 ])
-
-export const RegistrationChannelIcon = Object.freeze({
-  'vkontakte': 'brand/solid/vk',
-  'telegramBot': 'brand/solid/telegram',
-  'email': 'hero/solid/at-symbol',
-})

package/source/entities/registration-lineup.js

@@ -8,11 +8,6 @@ export const RegistrationLineups = Object.freeze([
   'Reserve',
 ])
 
-export const RegistrationLineupIcon = Object.freeze({
-  'Main': 'hero/outline/user-circle',
-  'Reserve': 'hero/outline/pause-circle',
-})
-
 export const RegistrationLineupEmoji = Object.freeze({
   'Main': '🟢',
   'Reserve': '🟡',

package/source/entities/registration-status.js

@@ -11,13 +11,6 @@ export const RegistrationStatuses = Object.freeze([
   'Cancelled',
 ])
 
-/** @satisfies {Record<keyof typeof RegistrationStatus, string>} */
-export const RegistrationStatusIcon = Object.freeze({
-  'Confirmed': 'hero/outline/check-circle',
-  'Created': 'hero/outline/check',
-  'Cancelled': 'hero/outline/x-mark',
-})
-
 /** @satisfies {Record<keyof typeof RegistrationStatus, string>} */
 export const RegistrationStatusEmoji = Object.freeze({
   'Confirmed': '✅',

package/source/entities/role.js

@@ -14,12 +14,3 @@ export const Roles = Object.freeze([
   'user',
   'manager',
 ])
-
-export const RoleIcon = Object.freeze({
-  'admin': 'hero/outline/user',
-  'organizer': 'hero/outline/user',
-  'captain': 'hero/outline/user',
-  'player': 'hero/outline/user',
-  'user': 'hero/outline/user',
-  'manager': 'hero/outline/user',
-})

package/source/entities/route-cardinality.js

@@ -64,112 +64,3 @@ export const RouteCardinality = Object.freeze({
   [Route['venues/city']]: Cardinality['N-1'],
 })
 
-export const RouteCardinalityRoute = Object.freeze({
-  [Route['cities']]: {
-    [Cardinality['1']]: Route['city'],
-  },
-
-  [Route['cities/country']]: {
-    [Cardinality['1-1']]: Route['city/country'],
-  },
-
-  [Route['cities/currency']]: {
-    [Cardinality['1-1']]: Route['city/currency'],
-  },
-
-  [Route['cities/timezone']]: {
-    [Cardinality['1-1']]: Route['city/timezone'],
-  },
-
-  [Route['cities/venues']]: {
-    [Cardinality['1-N']]: Route['city/venues'],
-  },
-
-  [Route['countries']]: {
-    [Cardinality['1']]: Route['country'],
-  },
-
-  [Route['currencies']]: {
-    [Cardinality['1']]: Route['currency'],
-  },
-
-  [Route['games']]: {
-    [Cardinality['1']]: Route['game'],
-  },
-
-  [Route['games/city']]: {
-    [Cardinality['1-1']]: Route['game/city'],
-  },
-
-  [Route['games/registrations']]: {
-    [Cardinality['1']]: Route['game/registrations'],
-  },
-
-  [Route['games/summary']]: {
-    [Cardinality['1']]: Route['game/summary'],
-  },
-
-  [Route['games/theme']]: {
-    [Cardinality['1-1']]: Route['game/theme'],
-  },
-
-  [Route['games/venue']]: {
-    [Cardinality['1-1']]: Route['game/venue'],
-  },
-
-  [Route['registrations']]: {
-    [Cardinality['1']]: Route['registration'],
-  },
-
-  [Route['registrations/city']]: {
-    [Cardinality['1-1']]: Route['registration/city'],
-  },
-
-  [Route['registrations/game']]: {
-    [Cardinality['1-1']]: Route['registration/game'],
-  },
-
-  [Route['registrations/game/theme']]: {
-    [Cardinality['1-1']]: Route['registration/game/theme'],
-  },
-
-  [Route['roles']]: {
-    [Cardinality['1']]: Route['role'],
-  },
-
-  [Route['themes']]: {
-    [Cardinality['1']]: Route['theme'],
-  },
-
-  [Route['themes/cover']]: {
-    [Cardinality['1']]: Route['theme/cover'],
-  },
-
-  [Route['timezones']]: {
-    [Cardinality['1']]: Route['timezone'],
-  },
-
-  [Route['user/cities']]: {
-    [Cardinality['1']]: Route['user/cities'],
-  },
-
-  [Route['users']]: {
-    [Cardinality['1']]: Route['user'],
-  },
-
-  [Route['users/cities']]: {
-    [Cardinality['1']]: Route['user/cities'],
-  },
-
-  [Route['users/role']]: {
-    [Cardinality['1']]: Route['user/role'],
-  },
-
-  [Route['venues']]: {
-    [Cardinality['1']]: Route['venue'],
-  },
-
-  [Route['venues/city']]: {
-    [Cardinality['1']]: Route['venue/city'],
-  },
-})

package/source/entities/theme-status.js

@@ -7,8 +7,3 @@ export const ThemeStatuses = Object.freeze([
   'Active',
   'Archive',
 ])
-
-export const ThemeStatusIcon = Object.freeze({
-  'Active': 'hero/outline/check',
-  'Archive': 'hero/outline/archive-box',
-})

package/source/entities/venue-audience.js

@@ -7,8 +7,3 @@ export const VenueAudiences = Object.freeze([
   'Open',
   'Adults',
 ])
-
-export const VenueAudienceIcon = Object.freeze({
-  'Open': 'hero/outline/lock-open',
-  'Adults': 'hero/outline/lock-closed',
-})

package/source/entities/venue-status.js

@@ -7,9 +7,3 @@ export const VenueStatuses = Object.freeze([
   'Active',
   'Archive',
 ])
-
-/** @satisfies {Record<keyof typeof VenueStatus, string>} */
-export const VenueStatusIcon = Object.freeze({
-  'Active': 'hero/outline/check',
-  'Archive': 'hero/outline/archive-box',
-})

package/source/helpers/access.js

@@ -0,0 +1,14 @@
+export const access = (value, key) => {
+  if (Object.hasOwn(this.value, key))
+    return value[key]
+  else
+    throw TypeError(`Could not require key '${key}' from Relation '${JSON.stringify(value)}'.`)
+}
+
+export const tryAccess = (value, key) => {
+  try {
+    return access(value, key)
+  } catch (error) {
+    return 'Unknown'
+  }
+}

package/source/helpers/hydrate-route-pathname.js

@@ -1,7 +1,7 @@
 import { RoutePathnameParams } from '../entities/route-pathname-params.js'
 import { RoutePathname } from '../entities/route-pathname.js'
 import { Route } from '../entities/route.js'
-import { Relation } from '../prototypes/relation.js'
+import { access } from '../helpers/access.js'
 
 export const hydrateRoutePathname = Object.freeze(
   /**
@@ -14,17 +14,11 @@ export const hydrateRoutePathname = Object.freeze(
     if (!Array.isArray(params))
       throw TypeError(`Parameter 'params' must be 'Array'.`)
 
-    var r = Relation
-      .of(Route)
-      .require(route)
+    var r = access(Route, route)
 
-    var rp = Relation
-      .of(RoutePathname)
-      .require(r)
+    var rp = access(RoutePathname, r)
 
-    var rpp = Relation
-      .of(RoutePathnameParams)
-      .require(r)
+    var rpp = access(RoutePathnameParams, r)
 
     return rpp.reduce((rp, rpp, i) => rp.replace(rpp, params[i]), rp)
   },

package/source/helpers/tag.js

@@ -1,6 +1,6 @@
 import { Method } from '../entities/method.js'
-import { Relation } from '../prototypes/relation.js'
 import { hydrateRoutePathname } from './hydrate-route-pathname.js'
+import { access } from '../helpers/access.js'
 
 export const tag = Object.freeze(
   /**
@@ -15,9 +15,7 @@ export const tag = Object.freeze(
    * @returns {`${MethodTemplate}/${RoutePathnameTemplate}`}
    */
   (method, route, params) => {
-    var m = Relation
-      .of(Method)
-      .require(method)
+    var m = access(Method, method)
 
     return m + '/' + hydrateRoutePathname(route, params)
   },

package/source/index.js

@@ -35,7 +35,7 @@ export * from './entities/service.js'
 export * from './entities/theme-status.js'
 export * from './entities/venue-audience.js'
 export * from './entities/venue-status.js'
+export * from './helpers/access.js'
 export * from './helpers/hydrate-route-pathname.js'
 export * from './helpers/string-tag.js'
 export * from './helpers/tag.js'
-export * from './prototypes/relation.js'

package/source/prototypes/relation.js

@@ -1,53 +0,0 @@
-/**
- * @template {*} Value
- *
- * @param {Value} value
- */
-export function Relation(value) {
-  this.value = value
-}
-
-/**
- * @template {*} Value
- *
- * @param {Value} value
- */
-Relation.of = function(value) {
-  return new Relation(value)
-}
-
-/**
- * @template {keyof Value} Key
- *
- * @this {Relation<Value>}
- *
- * @param {*} key
- *
- * @returns {Value[Key] | 'Unknown'}
- */
-Relation.prototype.expect = function(key) {
-  if (Object.hasOwn(this.value, key))
-    return this.value[key]
-  else
-    return 'Unknown'
-}
-
-/**
- * @template {keyof Value} Key
- *
- * @this {Relation<Value>}
- *
- * @param {*} key
- *
- * @returns {Value[Key]}
- *
- * @throws {TypeError}
- */
-Relation.prototype.require = function(key) {
-  if (Object.hasOwn(this.value, key))
-    return this.value[key]
-  else
-    throw TypeError(`Could not require key '${key}' from Relation '${JSON.stringify(this.value)}'.`)
-}
-
-Relation.prototype[Symbol.toStringTag] = 'Relation'