@shakerquiz/utilities 4.0.1 → 4.0.3

package/source/entities/key.js

@@ -34,8 +34,10 @@ export const Keys = Object.freeze(
 )
 
 export const Key = Object.freeze(
-  /** @type {{ [x in typeof Keys[number]]: x }} */ (Keys.reduce(
-    (o, x) => (o[x] = x, o),
-    {},
-  )),
+  /** @type {{ [x in typeof Keys[number]]: x }} */ (
+    Keys.reduce(
+      (o, x) => (o[x] = x, o),
+      {},
+    )
+  ),
 )

package/source/entities/pattern.js

@@ -1,7 +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]+)?)+/,
+  COUNTRY_CODE: /[A-Z]{2}/,
+  CURRENCY_CODE: /[A-Z]{3}/,
+  TIMEZONE_NAME: /[A-Za-z]+\/(?:[A-Za-z]+(?:_[A-Za-z]+)?)+/,
 })

package/source/entities/{route.js → routes.js}

@@ -74,10 +74,3 @@ export const Routes = Object.freeze(
     'registrations/export',
   ]),
 )
-
-export const Route = Object.freeze(
-  /** @type {{ [x in typeof Routes[number]]: x }} */ (Routes.reduce(
-    (o, x) => (o[x] = x, o),
-    {},
-  )),
-)

package/source/entities/runtimes.js

@@ -0,0 +1,14 @@
+export const Runtimes = Object.freeze(
+  /** @type {const} */ ([
+    'Bun',
+    'Deno',
+    'Node',
+    'Vite',
+  ]),
+)
+
+export const Runtime = Object.freeze(
+  /** @type {{ [x in typeof Runtimes[number]]: x }} */ (
+    Runtimes.reduce((o, x) => (o[x] = x, o), {})
+  ),
+)

package/source/entities/segment.js

@@ -1,5 +1,6 @@
 import { Key } from './key.js'
-import { Service } from './service.js'
+import { Pattern } from './pattern.js'
+import { Service } from './services.js'
 
 export const Segments = Object.freeze(
   /** @type {const} */ ([
@@ -9,6 +10,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: undefined,
         service: Service['Checkin'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -17,6 +19,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: Key['users'],
         service: Service['Users'],
+        pattern: Pattern.UUID.source,
       }),
     ),
     Object.freeze(
@@ -25,6 +28,7 @@ export const Segments = Object.freeze(
         cardinality: 'n',
         relation: Key['user'],
         service: Service['Users'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -33,6 +37,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: Key['roles'],
         service: Service['Roles'],
+        pattern: Pattern.UUID.source,
       }),
     ),
     Object.freeze(
@@ -41,6 +46,7 @@ export const Segments = Object.freeze(
         cardinality: 'n',
         relation: Key['role'],
         service: Service['Roles'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -49,6 +55,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: Key['countries'],
         service: Service['Locations'],
+        pattern: Pattern.COUNTRY_CODE.source,
       }),
     ),
     Object.freeze(
@@ -57,6 +64,7 @@ export const Segments = Object.freeze(
         cardinality: 'n',
         relation: Key['country'],
         service: Service['Locations'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -65,6 +73,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: Key['currencies'],
         service: Service['Locations'],
+        pattern: Pattern.CURRENCY_CODE.source,
       }),
     ),
     Object.freeze(
@@ -73,6 +82,7 @@ export const Segments = Object.freeze(
         cardinality: 'n',
         relation: Key['currency'],
         service: Service['Locations'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -81,6 +91,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: Key['timezones'],
         service: Service['Locations'],
+        pattern: Pattern.TIMEZONE_NAME.source,
       }),
     ),
     Object.freeze(
@@ -89,6 +100,7 @@ export const Segments = Object.freeze(
         cardinality: 'n',
         relation: Key['timezone'],
         service: Service['Locations'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -97,6 +109,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: Key['cities'],
         service: Service['Cities'],
+        pattern: Pattern.UUID.source,
       }),
     ),
     Object.freeze(
@@ -105,6 +118,7 @@ export const Segments = Object.freeze(
         cardinality: 'n',
         relation: Key['city'],
         service: Service['Cities'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -113,6 +127,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: Key['venues'],
         service: Service['Venues'],
+        pattern: Pattern.UUID.source,
       }),
     ),
     Object.freeze(
@@ -121,6 +136,7 @@ export const Segments = Object.freeze(
         cardinality: 'n',
         relation: Key['venue'],
         service: Service['Venues'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -129,6 +145,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: Key['themes'],
         service: Service['Themes'],
+        pattern: Pattern.UUID.source,
       }),
     ),
     Object.freeze(
@@ -137,6 +154,7 @@ export const Segments = Object.freeze(
         cardinality: 'n',
         relation: Key['theme'],
         service: Service['Themes'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -145,6 +163,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: undefined,
         service: undefined,
+        pattern: Pattern.UUID.source,
       }),
     ),
     Object.freeze(
@@ -153,6 +172,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: Key['games'],
         service: Service['Games'],
+        pattern: Pattern.UUID.source,
       }),
     ),
     Object.freeze(
@@ -161,6 +181,7 @@ export const Segments = Object.freeze(
         cardinality: 'n',
         relation: Key['game'],
         service: Service['Games'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -169,6 +190,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: Key['registrations'],
         service: Service['Registrations'],
+        pattern: Pattern.UUID.source,
       }),
     ),
     Object.freeze(
@@ -177,6 +199,7 @@ export const Segments = Object.freeze(
         cardinality: 'n',
         relation: Key['registration'],
         service: Service['Registrations'],
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -185,6 +208,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: undefined,
         service: undefined,
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -193,6 +217,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: undefined,
         service: undefined,
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -201,6 +226,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: undefined,
         service: undefined,
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -209,6 +235,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: undefined,
         service: undefined,
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -217,6 +244,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: undefined,
         service: undefined,
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -225,6 +253,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: undefined,
         service: undefined,
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -233,6 +262,7 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: undefined,
         service: undefined,
+        pattern: undefined,
       }),
     ),
     Object.freeze(
@@ -241,15 +271,17 @@ export const Segments = Object.freeze(
         cardinality: '1',
         relation: undefined,
         service: undefined,
+        pattern: undefined,
       }),
     ),
   ]),
 )
 
 export const Segment = Object.freeze(
-  /** @type {{ [x in typeof Segments[number]['key']]: Extract<typeof Segments[number], { key: x }> }} */ (Segments
-    .reduce(
+  /** @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

@@ -1,5 +1,5 @@
-import { Runtime } from './runtime.js'
-import { Service } from './service.js'
+import { Runtime } from './runtimes.js'
+import { Service } from './services.js'
 
 export const ServiceRuntime = Object.freeze({
   [Service['Users']]: Runtime['Bun'],

package/source/entities/services.js

@@ -0,0 +1,28 @@
+export const Services = Object.freeze(
+  /** @type {const} */ ([
+    'Users',
+    'Roles',
+    'Checkin',
+    'Locations',
+    'Cities',
+    'Venues',
+    'Themes',
+    'Games',
+    'Registrations',
+    'Files',
+    'Procedures',
+    'Integrations',
+    'Updates',
+    'Hub',
+    'Landing',
+    'Telegram',
+    'Vkma',
+    'Minio',
+  ]),
+)
+
+export const Service = Object.freeze(
+  /** @type {{ [x in typeof Services[number]]: x }} */ (
+    Services.reduce((o, x) => (o[x] = x, o), {})
+  ),
+)

package/source/helpers/access.js

@@ -1,3 +1,4 @@
+import { ParameterPattern, PathnameParameters, Route, RouteCardinality, RoutePathname, RouteService, ServiceRoutes } from '../codegen/autogenerated.js'
 import { Blend } from '../entities/blend.js'
 import { Cardinality } from '../entities/cardinality.js'
 import { Category } from '../entities/category.js'
@@ -20,14 +21,9 @@ 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 { Runtime } from '../entities/runtimes.js'
 import { ServiceRuntime } from '../entities/service-runtime.js'
-import { Service } from '../entities/service.js'
+import { Service } from '../entities/services.js'
 import { ThemeStatus } from '../entities/theme-status.js'
 import { VenueAudience } from '../entities/venue-audience.js'
 import { VenueStatus } from '../entities/venue-status.js'
@@ -61,6 +57,8 @@ const Prop = new Map([
   [Mode, 'mode'],
   [Network, 'network'],
   [Numerosity, 'numerosity'],
+  [ParameterPattern, 'pattern'],
+  [PathnameParameters, 'parameters'],
   [Pattern, 'pattern'],
   [Phase, 'phase'],
   [Quantifier, 'quantifier'],
@@ -69,15 +67,14 @@ const Prop = new Map([
   [RegistrationMailing, 'mailing'],
   [RegistrationStatus, 'status'],
   [Role, 'name'],
+  [Route, 'route'],
   [RouteCardinality, 'cardinality'],
-  [RouteParameter, 'parameter'],
   [RoutePathname, 'pathname'],
   [RouteService, 'service'],
-  [Route, 'route'],
   [Runtime, 'runtime'],
+  [Service, 'service'],
   [ServiceRoutes, 'routes'],
   [ServiceRuntime, 'runtime'],
-  [Service, 'service'],
   [ThemeStatus, 'status'],
   [VenueAudience, 'audience'],
   [VenueStatus, 'status'],
@@ -98,6 +95,8 @@ const Tag = new Map([
   [Mode, 'Mode'],
   [Network, 'Network'],
   [Numerosity, 'Numerosity'],
+  [ParameterPattern, 'ParameterPattern'],
+  [PathnameParameters, 'PathnameParameters'],
   [Pattern, 'Pattern'],
   [Phase, 'Phase'],
   [Quantifier, 'Quantifier'],
@@ -106,14 +105,13 @@ const Tag = new Map([
   [RegistrationMailing, 'RegistrationMailing'],
   [RegistrationStatus, 'RegistrationStatus'],
   [Role, 'Role'],
+  [Route, 'Route'],
   [RouteCardinality, 'RouteCardinality'],
-  [RouteParameter, 'RouteParameter'],
   [RoutePathname, 'RoutePathname'],
   [RouteService, 'RouteService'],
-  [Route, 'Route'],
   [Runtime, 'Runtime'],
-  [ServiceRuntime, 'ServiceRuntime'],
   [Service, 'Service'],
+  [ServiceRuntime, 'ServiceRuntime'],
   [ThemeStatus, 'ThemeStatus'],
   [VenueAudience, 'VenueAudience'],
   [VenueStatus, 'VenueStatus'],

package/source/helpers/route-pathname.js

@@ -0,0 +1,26 @@
+import { PathnameParameters, Route, RoutePathname } from '../codegen/autogenerated.js'
+import { access } from './access.js'
+
+/**
+ * @template {keyof typeof import('@shakerquiz/utilities').Route} R
+ *
+ * @param {R} maybeRoute
+ * @param {any[]} maybeParams
+ *
+ * @returns {typeof import('@shakerquiz/utilities').RoutePathname[R]}
+ */
+export const hydrateRoutePathname = (maybeRoute, maybeParams) => {
+  if (!Array.isArray(maybeParams))
+    throw TypeError(`Parameter 'params' must be 'Array'.`)
+
+  var route = access(Route, maybeRoute)
+
+  var pathname = access(RoutePathname, route)
+
+  var pathnameParameters = access(PathnameParameters, pathname)
+
+  return pathnameParameters.reduce((pathname, parameter, index) =>
+    Object.hasOwn(maybeParams, index)
+      ? pathname.replace(parameter, maybeParams[index])
+      : pathname, pathname)
+}

package/source/helpers/tag.js

@@ -1,35 +1,38 @@
 import { Method } from '../entities/method.js'
 
 import { access } from './access.js'
-import { hydrateRoutePathname } from './hydrate-route-pathname.js'
+import { hydrateRoutePathname } from './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)
+/**
+ * @template {keyof typeof  import('@shakerquiz/utilities').Method} M
+ * @template {keyof typeof  import('@shakerquiz/utilities').Route} R
+ *
+ * @param {M} maybeMethod
+ * @param {R} maybeRoute
+ * @param {any[]} maybeParams
+ *
+ * @returns {`${M}/${ReturnType<typeof hydrateRoutePathname<R>>}`}
+ *
+ * @example
+ * tag('GET', 'cities', []) // => 'GET/cities'
+ *
+ * tag('GET', 'game/theme/cover', ['<g>']) // => 'GET/game/<g>/theme/:theme/:cover'
+ *
+ * tag('POST', 'city', []) // => 'POST/city/:city'
+ */
+export const tag = (maybeMethod, maybeRoute, maybeParams) => {
+  var method = access(Method, maybeMethod)
 
-    return method + '/' + hydrateRoutePathname(maybeRoute, maybeParams)
-  },
-)
+  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)}$`),
-)
+/**
+ * @template {keyof typeof  import('@shakerquiz/utilities').Method} M
+ * @template {keyof typeof  import('@shakerquiz/utilities').Route} R
+ *
+ * @param {M} maybeMethod
+ * @param {R} maybeRoute
+ * @param {any[]} maybeParams
+ */
+export const tagexp = (maybeMethod, maybeRoute, maybeParams) =>
+  new RegExp(`^${tag(maybeMethod, maybeRoute, maybeParams)}$`)

package/source/index.js

@@ -1,3 +1,4 @@
+export * from './codegen/autogenerated.js'
 export * from './entities/blend.js'
 export * from './entities/cardinality.js'
 export * from './entities/category.js'
@@ -22,19 +23,14 @@ 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/routes.js'
+export * from './entities/runtimes.js'
 export * from './entities/segment.js'
 export * from './entities/service-runtime.js'
-export * from './entities/service.js'
+export * from './entities/services.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/route-pathname.js'
 export * from './helpers/tag.js'

package/scripts/route-cardinality.js

@@ -1,23 +0,0 @@
-import template from './templates/route-cardinality.js' with { type: 'text' }
-
-import { Routes } from '../source/entities/route.js'
-import { Segment } from '../source/entities/segment.js'
-
-let cardinalities = Routes.map(route => {
-  const cardinalities = route.split('/').map(key => Segment[key].cardinality)
-
-  return cardinalities.length > 1
-    ? cardinalities.at(0) + '/' + cardinalities.at(-1)
-    : cardinalities.at(0)
-})
-
-let RouteCardinalities = JSON.stringify(cardinalities, undefined, 2)
-
-let RouteCardinality = JSON.stringify(Routes.reduce((o, x, i) => (o[x] = cardinalities[i], o), {}), null, 2)
-
-Bun.write(
-  './source/entities/route-cardinality.js',
-  template
-    .replace('/* RouteCardinalities */', RouteCardinalities)
-    .replace('/* RouteCardinality */', RouteCardinality),
-)

package/scripts/route-parameter.js

@@ -1,29 +0,0 @@
-import template from './templates/route-parameter.js' with { type: 'text' }
-
-import { Routes } from '../source/entities/route.js'
-import { Segment } from '../source/entities/segment.js'
-
-let pathnames = Routes.map(route =>
-  route
-    .split('/')
-    .map(key => Segment[key].cardinality === '1' ? key + '/:' + key : key)
-    .join('/')
-)
-
-let parameters = pathnames.map(pathname =>
-  pathname
-    .split('/')
-    .filter(key => key.includes(':'))
-    .join('/')
-)
-
-let RouteParameters = JSON.stringify(parameters, undefined, 2)
-
-let RouteParameter = JSON.stringify(Routes.reduce((o, x, i) => (o[x] = parameters[i], o), {}), null, 2)
-
-Bun.write(
-  './source/entities/route-parameter.js',
-  template
-    .replace('/* RouteParameters */', RouteParameters)
-    .replace('/* RouteParameter */', RouteParameter),
-)

package/scripts/route-pathname.js

@@ -1,37 +0,0 @@
-import template from './templates/route-pathname.js' with { type: 'text' }
-
-import { Routes } from '../source/entities/route.js'
-import { Segment } from '../source/entities/segment.js'
-
-let pathnames = Routes.map(route =>
-  route
-    .split('/')
-    .map(key => Segment[key].cardinality === '1' ? key + '/:' + key : key)
-    .join('/')
-)
-
-let RoutePathnames = JSON.stringify(
-  pathnames,
-  undefined,
-  2,
-)
-
-let RoutePathname = JSON.stringify(
-  Routes.reduce((o, x, i) => (o[x] = pathnames[i], o), {}),
-  null,
-  2,
-)
-
-let PathnameRoute = JSON.stringify(
-  pathnames.reduce((o, x, i) => (o[x] = Routes[i], o), {}),
-  null,
-  2,
-)
-
-Bun.write(
-  './source/entities/route-pathname.js',
-  template
-    .replace('/* RoutePathnames */', RoutePathnames)
-    .replace('/* RoutePathname */', RoutePathname)
-    .replace('/* PathnameRoute */', PathnameRoute),
-)

package/scripts/route-relation.js

@@ -1,26 +0,0 @@
-import template from './templates/route-relation.js' with { type: 'text' }
-
-import { Routes } from '../source/entities/route.js'
-import { Segment } from '../source/entities/segment.js'
-
-let relations = Routes.map(route =>
-  route
-    .split('/')
-    .map((key, index) =>
-      Segment[key].cardinality === '1' || index > 0
-        ? key
-        : Segment[key].relation ?? key
-    )
-    .join('/')
-)
-
-let RouteRelations = JSON.stringify(relations, undefined, 2)
-
-let RouteRelation = JSON.stringify(Routes.reduce((o, x, i) => (o[x] = relations[i], o), {}), null, 2)
-
-Bun.write(
-  './source/entities/route-relation.js',
-  template
-    .replace('/* RouteRelations */', RouteRelations)
-    .replace('/* RouteRelation */', RouteRelation),
-)