@shakerquiz/utilities 3.0.0 → 4.0.1

package/source/entities/segment.js

@@ -0,0 +1,255 @@
+import { Key } from './key.js'
+import { Service } from './service.js'
+
+export const Segments = Object.freeze(
+  /** @type {const} */ ([
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['checkin'],
+        cardinality: '1',
+        relation: undefined,
+        service: Service['Checkin'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['user'],
+        cardinality: '1',
+        relation: Key['users'],
+        service: Service['Users'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['users'],
+        cardinality: 'n',
+        relation: Key['user'],
+        service: Service['Users'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['role'],
+        cardinality: '1',
+        relation: Key['roles'],
+        service: Service['Roles'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['roles'],
+        cardinality: 'n',
+        relation: Key['role'],
+        service: Service['Roles'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['country'],
+        cardinality: '1',
+        relation: Key['countries'],
+        service: Service['Locations'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['countries'],
+        cardinality: 'n',
+        relation: Key['country'],
+        service: Service['Locations'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['currency'],
+        cardinality: '1',
+        relation: Key['currencies'],
+        service: Service['Locations'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['currencies'],
+        cardinality: 'n',
+        relation: Key['currency'],
+        service: Service['Locations'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['timezone'],
+        cardinality: '1',
+        relation: Key['timezones'],
+        service: Service['Locations'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['timezones'],
+        cardinality: 'n',
+        relation: Key['timezone'],
+        service: Service['Locations'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['city'],
+        cardinality: '1',
+        relation: Key['cities'],
+        service: Service['Cities'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['cities'],
+        cardinality: 'n',
+        relation: Key['city'],
+        service: Service['Cities'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['venue'],
+        cardinality: '1',
+        relation: Key['venues'],
+        service: Service['Venues'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['venues'],
+        cardinality: 'n',
+        relation: Key['venue'],
+        service: Service['Venues'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['theme'],
+        cardinality: '1',
+        relation: Key['themes'],
+        service: Service['Themes'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['themes'],
+        cardinality: 'n',
+        relation: Key['theme'],
+        service: Service['Themes'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['cover'],
+        cardinality: '1',
+        relation: undefined,
+        service: undefined,
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['game'],
+        cardinality: '1',
+        relation: Key['games'],
+        service: Service['Games'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['games'],
+        cardinality: 'n',
+        relation: Key['game'],
+        service: Service['Games'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['registration'],
+        cardinality: '1',
+        relation: Key['registrations'],
+        service: Service['Registrations'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['registrations'],
+        cardinality: 'n',
+        relation: Key['registration'],
+        service: Service['Registrations'],
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['export'],
+        cardinality: '1',
+        relation: undefined,
+        service: undefined,
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['password'],
+        cardinality: '1',
+        relation: undefined,
+        service: undefined,
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['vk_group_token'],
+        cardinality: '1',
+        relation: undefined,
+        service: undefined,
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['summary'],
+        cardinality: '1',
+        relation: undefined,
+        service: undefined,
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['mailing'],
+        cardinality: '1',
+        relation: undefined,
+        service: undefined,
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['channel'],
+        cardinality: '1',
+        relation: undefined,
+        service: undefined,
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['confirmation'],
+        cardinality: '1',
+        relation: undefined,
+        service: undefined,
+      }),
+    ),
+    Object.freeze(
+      /** @type {const} */ ({
+        key: Key['cancellation'],
+        cardinality: '1',
+        relation: undefined,
+        service: undefined,
+      }),
+    ),
+  ]),
+)
+
+export const Segment = Object.freeze(
+  /** @type {{ [x in typeof Segments[number]['key']]: Extract<typeof Segments[number], { key: x }> }} */ (Segments
+    .reduce(
+      (o, x) => (o[x.key] = x, o),
+      {},
+    )),
+)

package/source/entities/service-runtime.js

@@ -0,0 +1,22 @@
+import { Runtime } from './runtime.js'
+import { Service } from './service.js'
+
+export const ServiceRuntime = Object.freeze({
+  [Service['Users']]: Runtime['Bun'],
+  [Service['Roles']]: Runtime['Bun'],
+  [Service['Checkin']]: Runtime['Bun'],
+  [Service['Locations']]: Runtime['Bun'],
+  [Service['Cities']]: Runtime['Bun'],
+  [Service['Venues']]: Runtime['Bun'],
+  [Service['Themes']]: Runtime['Bun'],
+  [Service['Games']]: Runtime['Bun'],
+  [Service['Registrations']]: Runtime['Bun'],
+  [Service['Files']]: Runtime['Bun'],
+  [Service['Procedures']]: Runtime['Bun'],
+  [Service['Integrations']]: Runtime['Bun'],
+  [Service['Updates']]: Runtime['Bun'],
+  [Service['Hub']]: Runtime['Node'],
+  [Service['Landing']]: Runtime['Node'],
+  [Service['Telegram']]: Runtime['Node'],
+  [Service['Vkma']]: Runtime['Vite'],
+})

package/source/entities/service.js

@@ -0,0 +1,22 @@
+export const Service = Object.freeze({
+  'Users': 'Users',
+  'Roles': 'Roles',
+  'Checkin': 'Checkin',
+  'Locations': 'Locations',
+  'Cities': 'Cities',
+  'Venues': 'Venues',
+  'Themes': 'Themes',
+  'Games': 'Games',
+  'Registrations': 'Registrations',
+  'Files': 'Files',
+  'Procedures': 'Procedures',
+  'Integrations': 'Integrations',
+  'Updates': 'Updates',
+  'Hub': 'Hub',
+  'Landing': 'Landing',
+  'Telegram': 'Telegram',
+  'Vkma': 'Vkma',
+  'Minio': 'Minio',
+})
+
+export const Services = Object.freeze(Object.values(Service))

package/source/entities/theme-status.js

@@ -0,0 +1,9 @@
+export const ThemeStatus = Object.freeze({
+  'Active': 'Active',
+  'Archive': 'Archive',
+})
+
+export const ThemeStatuses = Object.freeze([
+  'Active',
+  'Archive',
+])

package/source/entities/venue-audience.js

@@ -0,0 +1,9 @@
+export const VenueAudience = Object.freeze({
+  'Open': 'Open',
+  'Adults': 'Adults',
+})
+
+export const VenueAudiences = Object.freeze([
+  'Open',
+  'Adults',
+])

package/source/entities/venue-status.js

@@ -0,0 +1,9 @@
+export const VenueStatus = Object.freeze({
+  'Active': 'Active',
+  'Archive': 'Archive',
+})
+
+export const VenueStatuses = Object.freeze([
+  'Active',
+  'Archive',
+])

package/source/helpers/access.js

@@ -0,0 +1,161 @@
+import { Blend } from '../entities/blend.js'
+import { Cardinality } from '../entities/cardinality.js'
+import { Category } from '../entities/category.js'
+import { CityAffilation } from '../entities/city-affilation.js'
+import { CityChatappVersion } from '../entities/city-chatapp-version.js'
+import { Constants } from '../entities/constants.js'
+import { Display } from '../entities/display.js'
+import { GameStatus } from '../entities/game-status.js'
+import { Gender } from '../entities/gender.js'
+import { Icon } from '../entities/icon.js'
+import { Method } from '../entities/method.js'
+import { Mode } from '../entities/mode.js'
+import { Network } from '../entities/network.js'
+import { Numerosity } from '../entities/numerosity.js'
+import { Pattern } from '../entities/pattern.js'
+import { Phase } from '../entities/phase.js'
+import { Quantifier } from '../entities/quantifier.js'
+import { RegistrationChannel } from '../entities/registration-channel.js'
+import { RegistrationLineup } from '../entities/registration-lineup.js'
+import { RegistrationMailing } from '../entities/registration-mailing.js'
+import { RegistrationStatus } from '../entities/registration-status.js'
+import { Role } from '../entities/role.js'
+import { RouteCardinality } from '../entities/route-cardinality.js'
+import { RouteParameter } from '../entities/route-parameter.js'
+import { RoutePathname } from '../entities/route-pathname.js'
+import { RouteService, ServiceRoutes } from '../entities/route-service.js'
+import { Route } from '../entities/route.js'
+import { Runtime } from '../entities/runtime.js'
+import { ServiceRuntime } from '../entities/service-runtime.js'
+import { Service } from '../entities/service.js'
+import { ThemeStatus } from '../entities/theme-status.js'
+import { VenueAudience } from '../entities/venue-audience.js'
+import { VenueStatus } from '../entities/venue-status.js'
+
+const Node = new Map([
+  [CityAffilation, 'city'],
+  [CityChatappVersion, 'city'],
+  [GameStatus, 'game'],
+  [RegistrationChannel, 'registration'],
+  [RegistrationLineup, 'registration'],
+  [RegistrationMailing, 'registration'],
+  [RegistrationStatus, 'registration'],
+  [Role, 'role'],
+  [ThemeStatus, 'theme'],
+  [VenueAudience, 'venue'],
+  [VenueStatus, 'venue'],
+])
+
+const Prop = new Map([
+  [Blend, 'blend'],
+  [Cardinality, 'cardinality'],
+  [Category, 'category'],
+  [CityAffilation, 'affilation'],
+  [CityChatappVersion, 'version'],
+  [Constants, 'constants'],
+  [Display, 'display'],
+  [GameStatus, 'status'],
+  [Gender, 'gender'],
+  [Icon, 'icon'],
+  [Method, 'method'],
+  [Mode, 'mode'],
+  [Network, 'network'],
+  [Numerosity, 'numerosity'],
+  [Pattern, 'pattern'],
+  [Phase, 'phase'],
+  [Quantifier, 'quantifier'],
+  [RegistrationChannel, 'channel'],
+  [RegistrationLineup, 'lineup'],
+  [RegistrationMailing, 'mailing'],
+  [RegistrationStatus, 'status'],
+  [Role, 'name'],
+  [RouteCardinality, 'cardinality'],
+  [RouteParameter, 'parameter'],
+  [RoutePathname, 'pathname'],
+  [RouteService, 'service'],
+  [Route, 'route'],
+  [Runtime, 'runtime'],
+  [ServiceRoutes, 'routes'],
+  [ServiceRuntime, 'runtime'],
+  [Service, 'service'],
+  [ThemeStatus, 'status'],
+  [VenueAudience, 'audience'],
+  [VenueStatus, 'status'],
+])
+
+const Tag = new Map([
+  [Blend, 'Blend'],
+  [Cardinality, 'Cardinality'],
+  [Category, 'Category'],
+  [CityAffilation, 'CityAffilation'],
+  [CityChatappVersion, 'CityChatappVersion'],
+  [Constants, 'Constants'],
+  [Display, 'Display'],
+  [GameStatus, 'GameStatus'],
+  [Gender, 'Gender'],
+  [Icon, 'Icon'],
+  [Method, 'Method'],
+  [Mode, 'Mode'],
+  [Network, 'Network'],
+  [Numerosity, 'Numerosity'],
+  [Pattern, 'Pattern'],
+  [Phase, 'Phase'],
+  [Quantifier, 'Quantifier'],
+  [RegistrationChannel, 'RegistrationChannel'],
+  [RegistrationLineup, 'RegistrationLineup'],
+  [RegistrationMailing, 'RegistrationMailing'],
+  [RegistrationStatus, 'RegistrationStatus'],
+  [Role, 'Role'],
+  [RouteCardinality, 'RouteCardinality'],
+  [RouteParameter, 'RouteParameter'],
+  [RoutePathname, 'RoutePathname'],
+  [RouteService, 'RouteService'],
+  [Route, 'Route'],
+  [Runtime, 'Runtime'],
+  [ServiceRuntime, 'ServiceRuntime'],
+  [Service, 'Service'],
+  [ThemeStatus, 'ThemeStatus'],
+  [VenueAudience, 'VenueAudience'],
+  [VenueStatus, 'VenueStatus'],
+])
+
+/**
+ * @template Relation
+ * @template {keyof Relation} Key
+ *
+ * @param {Relation} relation
+ * @param {Key} value
+ *
+ * @returns {Relation[Key]}
+ *
+ * @throws {TypeError}
+ */
+export const access = (relation, value) => {
+  const node = Node.get(relation)
+
+  const prop = Prop.get(relation)
+
+  const read = value?.[node]?.[prop] ?? value?.[prop] ?? value
+
+  if (Object.hasOwn(relation, read))
+    return relation[read]
+  else
+    throw TypeError(`Could not require key '${value}' from '${Tag.get(relation)}'.`)
+}
+
+/**
+ * @template Relation
+ * @template {keyof Relation} Key
+ *
+ * @param {Relation} relation
+ * @param {Key} value
+ *
+ * @returns {Relation[Key] | 'Unknown'}
+ */
+export const tryAccess = (relation, value) => {
+  try {
+    return access(relation, value)
+  } catch (error) {
+    return 'Unknown'
+  }
+}

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

@@ -0,0 +1,29 @@
+import { RouteParameter } from '../entities/route-parameter.js'
+import { RoutePathname } from '../entities/route-pathname.js'
+import { Route } from '../entities/route.js'
+
+import { access } from './access.js'
+
+export const hydrateRoutePathname = Object.freeze(
+  /**
+   * @template {keyof typeof import('../system/route.js').Route} RouteTemplate
+   *
+   * @param {RouteTemplate} maybeRoute
+   * @param {any[]} maybeParams
+   */
+  (maybeRoute, maybeParams) => {
+    if (!Array.isArray(maybeParams))
+      throw TypeError(`Parameter 'params' must be 'Array'.`)
+
+    var route = access(Route, maybeRoute)
+
+    var pathname = access(RoutePathname, route)
+
+    var params = access(RouteParameter, route)
+
+    return params
+      .split('/')
+      .filter(Boolean)
+      .reduce((pathname, param, index) => pathname.replace(param, maybeParams[index]), pathname)
+  },
+)

package/source/helpers/tag.js

@@ -0,0 +1,35 @@
+import { Method } from '../entities/method.js'
+
+import { access } from './access.js'
+import { hydrateRoutePathname } from './hydrate-route-pathname.js'
+
+export const tag = Object.freeze(
+  /**
+   * @template {keyof typeof import('../system/method.js').Method} MethodTemplate
+   * @template {keyof typeof import('../system/route.js').Route} RouteTemplate
+   * @template {typeof import('../system/route.js').RoutePathname[RouteTemplate]} RoutePathnameTemplate
+   *
+   * @param {MethodTemplate} maybeMethod
+   * @param {RouteTemplate} maybeRoute
+   * @param {any[]} maybeParams
+   *
+   * @returns {`${MethodTemplate}/${RoutePathnameTemplate}`}
+   */
+  (maybeMethod, maybeRoute, maybeParams) => {
+    var method = access(Method, maybeMethod)
+
+    return method + '/' + hydrateRoutePathname(maybeRoute, maybeParams)
+  },
+)
+
+export const tagexp = Object.freeze(
+  /**
+   * @template {keyof typeof import('../system/method.js').Method} MethodTemplate
+   * @template {keyof typeof import('../system/route.js').Route} RouteTemplate
+   *
+   * @param {MethodTemplate} maybeMethod
+   * @param {RouteTemplate} maybeRoute
+   * @param {any[]} maybeParams
+   */
+  (maybeMethod, maybeRoute, maybeParams) => new RegExp(`^${tag(maybeMethod, maybeRoute, maybeParams)}$`),
+)

package/source/index.js

@@ -1,34 +1,40 @@
-export * from './enumerations/core/features.js'
-export * from './enumerations/core/methods.js'
-export * from './enumerations/core/networks.js'
-export * from './enumerations/core/runtimes.js'
-
-export * from './enumerations/misc/constants.js'
-export * from './enumerations/misc/icons.js'
-export * from './enumerations/misc/keys.js'
-export * from './enumerations/misc/phases.js'
-export * from './enumerations/misc/regexps.js'
-export * from './enumerations/misc/routes.js'
-
-export * from './enumerations/entities/affilation.js'
-export * from './enumerations/entities/cities-mode.js'
-export * from './enumerations/entities/game-status.js'
-export * from './enumerations/entities/password-mode.js'
-export * from './enumerations/entities/registration-attribute.js'
-export * from './enumerations/entities/registration-channel.js'
-export * from './enumerations/entities/registration-lineup.js'
-export * from './enumerations/entities/registration-mailing.js'
-export * from './enumerations/entities/registration-status.js'
-export * from './enumerations/entities/role-mode.js'
-export * from './enumerations/entities/role.js'
-
-export * from './enumerations/entities/city/timezone-mode.js'
-export * from './enumerations/entities/city/venues-mode.js'
-
-export * from './enumerations/entities/venue/audience.js'
-export * from './enumerations/entities/venue/city-mode.js'
-export * from './enumerations/entities/venue/status.js'
-
-export * from './enumerations/entities/version.js'
-
-export * from './functions/tag.js'
+export * from './entities/blend.js'
+export * from './entities/cardinality.js'
+export * from './entities/category.js'
+export * from './entities/city-affilation.js'
+export * from './entities/city-chatapp-version.js'
+export * from './entities/constants.js'
+export * from './entities/display.js'
+export * from './entities/game-status.js'
+export * from './entities/gender.js'
+export * from './entities/icon.js'
+export * from './entities/key.js'
+export * from './entities/method.js'
+export * from './entities/mode.js'
+export * from './entities/network.js'
+export * from './entities/numerosity.js'
+export * from './entities/pattern.js'
+export * from './entities/phase.js'
+export * from './entities/quantifier.js'
+export * from './entities/registration-attribute.js'
+export * from './entities/registration-channel.js'
+export * from './entities/registration-lineup.js'
+export * from './entities/registration-mailing.js'
+export * from './entities/registration-status.js'
+export * from './entities/role.js'
+export * from './entities/route-cardinality.js'
+export * from './entities/route-parameter.js'
+export * from './entities/route-pathname.js'
+export * from './entities/route-relation.js'
+export * from './entities/route-service.js'
+export * from './entities/route.js'
+export * from './entities/runtime.js'
+export * from './entities/segment.js'
+export * from './entities/service-runtime.js'
+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/tag.js'