@shakerquiz/utilities 0.6.18 → 2.0.0

package/dprint.json

@@ -19,6 +19,9 @@
   ],
   "plugins": [
     "https://plugins.dprint.dev/typescript-0.93.0.wasm",
-    "https://plugins.dprint.dev/json-0.19.3.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"
   ]
 }

package/package.json

@@ -1,17 +1,23 @@
 {
   "type": "module",
   "name": "@shakerquiz/utilities",
-  "version": "0.6.18",
+  "version": "2.0.0",
   "author": "yurkimus <yurkimus@gmail.com>",
   "license": "ISC",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/shaker-quiz/utilities.git"
+  "scripts": {
+    "type": "tsc --declaration --emitdeclarationonly --allowjs"
   },
   "exports": {
-    "default": "./source/index.js"
+    ".": {
+      "types": "./source/index.d.ts",
+      "default": "./source/index.js"
+    },
+    "./schemas/*.json": "./source/schemas/*.json"
   },
-  "scripts": {
-    "prepublishOnly": "bun ./scripts/route-cardinality.js && bun ./scripts/route-parameter.js && bun ./scripts/route-pathname.js && bun ./scripts/route-relation.js && bun ./scripts/route-service.js"
+  "dependencies": {
+    "urlpattern-polyfill": "10.1.0"
+  },
+  "devDependencies": {
+    "typescript": "5.8.3"
   }
 }

package/source/enumerations/core/features.d.ts

@@ -0,0 +1,40 @@
+export const Domains: readonly ["User", "Role", "Country", "Currency", "City", "Venue", "Theme", "Game", "Registration"];
+/**
+ * @type {Record<Domain, Icon>}
+ */
+export const DomainIcon: Record<Domain, Icon>;
+/**
+ * @type {Record<Domain, Record<Kind, string>>}
+ */
+export const DomainKindPathname: Record<Domain, Record<Kind, string>>;
+export const Procedures: readonly ["Checkin", "Redirect"];
+/**
+ * @type {Record<Procedure, Icon>}
+ */
+export const ProcedureIcon: Record<Procedure, Icon>;
+/**
+ * @type {Record<Procedure, Record<Kind, string>>}
+ */
+export const ProcedureKindPathname: Record<Procedure, Record<Kind, string>>;
+/**
+ * @type {Array<Domain | Procedure>}
+ */
+export const Features: Array<Domain | Procedure>;
+/**
+ * @type {Record<Feature, Icon>}
+ */
+export const FeatureIcon: Record<Feature, Icon>;
+/**
+ * @type {Record<Feature, Record<Kind, string>>}
+ */
+export const FeatureKindPathname: Record<Feature, Record<Kind, string>>;
+/**
+ * @type {Array<[feature: Feature, kind: Kind, pathname: string]>}
+ */
+export const FeatureKindPathnames: Array<[feature: Feature, kind: Kind, pathname: string]>;
+/**
+ * @type {Array<[feature: Feature, kind: Kind, pattern: URLPattern]>}
+ */
+export const FeatureKindPatterns: Array<[feature: Feature, kind: Kind, pattern: URLPattern]>;
+export function getPathname(feature: Feature, kind: Kind): string;
+export function getPattern(feature: Feature, kind: Kind): any;

package/source/enumerations/core/features.js

@@ -0,0 +1,205 @@
+import { Kinds } from './kinds.js'
+
+export var Domains = /** @type {const} */ ([
+  // 'Asset',
+  'User',
+  'Role',
+  'Country',
+  'Currency',
+  'City',
+  'Venue',
+  'Theme',
+  // 'ThemeAsset',
+  'Game',
+  // 'GameAsset',
+  'Registration',
+  'Mailing',
+])
+
+/**
+ * @type {Record<Domain, Icon>}
+ */
+export var DomainIcon = {
+  'User': 'users',
+  'Role': 'identification',
+  'Country': 'no-symbol',
+  'Currency': 'no-symbol',
+  'City': 'building-office',
+  'Venue': 'map-pin',
+  'Theme': 'document-text',
+  'Game': 'newspaper',
+  'Registration': 'user-group',
+  'Mailing': 'envelope',
+}
+
+/**
+ * @type {Record<Domain, Record<Kind, string>>}
+ */
+export var DomainKindPathname = /** @type {const} */ ({
+  'User': {
+    'Unit': '/user/:user?',
+    'Set': '/users',
+  },
+
+  'Role': {
+    'Unit': '/role/:role?',
+    'Set': '/roles',
+  },
+
+  'Country': {
+    'Unit': '/country/:country?',
+    'Set': '/countries',
+  },
+
+  'Currency': {
+    'Unit': '/currency/:currency?',
+    'Set': '/currencies',
+  },
+
+  'City': {
+    'Unit': '/city/:city?',
+    'Set': '/cities',
+  },
+
+  'Venue': {
+    'Unit': '/venue/:venue?',
+    'Set': '/venues',
+  },
+
+  'Theme': {
+    'Unit': '/theme/:theme?',
+    'Set': '/themes',
+  },
+
+  'Game': {
+    /**
+     * Parameter "game" can be one of:
+     * - UUID of a Game,
+     * - Game alias combined with City (UUID, alias or VK group ID),
+     * - UUID of a Registration
+     */
+    'Unit': '/game/:game?',
+    'Set': '/games',
+  },
+
+  'Registration': {
+    /**
+     * Parameter "registration" can be one of:
+     * - UUID of a Registration,
+     * - VK identifier of a Registration
+     */
+    'Unit': '/registration/:registration?',
+    'Set': '/registrations',
+  },
+
+  'Mailing': {
+    'Unit': '/mailing/:mailing?',
+    'Set': '/mailings',
+  },
+})
+
+export var Procedures = /** @type {const} */ ([
+  'Checkin',
+  'Redirect',
+])
+
+/**
+ * @type {Record<Procedure, Icon>}
+ */
+export var ProcedureIcon = {
+  'Checkin': 'arrow-right-end-on-rectangle',
+  'Redirect': 'no-symbol',
+}
+
+/**
+ * @type {Record<Procedure, Record<Kind, string>>}
+ */
+export var ProcedureKindPathname = /** @type {const} */ ({
+  'Checkin': {
+    'Unit': '/checkin',
+    'Set': '/checkins',
+  },
+
+  'Redirect': {
+    'Unit': '/redirect',
+    'Set': '/redirects',
+  },
+})
+
+/**
+ * @type {Array<Domain | Procedure>}
+ */
+export var Features = Domains.concat(Procedures)
+
+/**
+ * @type {Record<Feature, Icon>}
+ */
+export var FeatureIcon = {
+  ...DomainIcon,
+  ...ProcedureIcon,
+}
+
+/**
+ * @type {Record<Feature, Record<Kind, string>>}
+ */
+export var FeatureKindPathname = {
+  ...DomainKindPathname,
+  ...ProcedureKindPathname,
+}
+
+/**
+ * @type {Array<[feature: Feature, kind: Kind, pathname: string]>}
+ */
+export var FeatureKindPathnames = Object
+  .keys(FeatureKindPathname)
+  .flatMap(feature =>
+    Object
+      .keys(FeatureKindPathname[feature])
+      .map(kind => [feature, kind, FeatureKindPathname[feature][kind]])
+  )
+
+/**
+ * @type {Array<[feature: Feature, kind: Kind, pattern: URLPattern]>}
+ */
+export var FeatureKindPatterns = FeatureKindPathnames
+  .map(([feature, kind, pathname]) => [
+    feature,
+    kind,
+    new URLPattern({ pathname }),
+  ])
+
+/**
+ * @param {Feature} feature
+ * @param {Kind} kind
+ */
+export var getPathname = (feature, kind) => {
+  if (!Features.includes(feature))
+    throw TypeError(
+      `[getPathname] Feature '${feature}' must be listed in 'Features'.`,
+    )
+
+  if (!Kinds.includes(kind))
+    throw TypeError(
+      `[getPathname] Kind '${kind}' must be listed in 'Kinds'.`,
+    )
+
+  return FeatureKindPathname[feature][kind]
+}
+
+/**
+ * @param {Feature} feature
+ * @param {Kind} kind
+ */
+export var getPattern = (feature, kind) => {
+  if (!Features.includes(feature))
+    throw TypeError(
+      `[getPattern] Feature '${feature}' must be listed in 'Features'.`,
+    )
+
+  if (!Kinds.includes(kind))
+    throw TypeError(
+      `[getPattern] Kind '${kind}' must be listed in 'Kinds'.`,
+    )
+
+  return FeatureKindPatterns.find(([f, k]) => f == feature && k == kind)[2]
+}

package/source/enumerations/core/kinds.d.ts

@@ -0,0 +1 @@
+export const Kinds: readonly ["Unit", "Set"];

package/source/enumerations/core/kinds.js

@@ -0,0 +1,4 @@
+export var Kinds = /** @type {const} */ ([
+  'Unit',
+  'Set',
+])

package/source/enumerations/core/methods.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 const Methods: readonly ["DELETE", "GET", "OPTIONS", "PATCH", "POST", "PUT"];

package/source/enumerations/core/methods.js

@@ -0,0 +1,25 @@
+/**
+ * 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 Methods = /** @type {const} */ ([
+  // 'CONNECT',
+  // 'COPY',
+  'DELETE',
+  'GET',
+  // 'HEAD',
+  // 'LOCK',
+  // 'MKCOL',
+  // 'MOVE',
+  'OPTIONS',
+  'PATCH',
+  'POST',
+  // 'PROPFIND',
+  // 'PROPPATCH',
+  'PUT',
+  // 'TRACE',
+  // 'UNLOCK',
+])

package/source/enumerations/core/networks.d.ts

@@ -0,0 +1 @@
+export const Networks: readonly ["Docker", "Public"];

package/source/enumerations/core/networks.js

@@ -0,0 +1,4 @@
+export var Networks = /** @type {const} */ ([
+  'Docker',
+  'Public',
+])

package/source/enumerations/core/runtimes.d.ts

@@ -0,0 +1 @@
+export const Runtimes: readonly ["Next", "React"];

package/source/enumerations/core/runtimes.js

@@ -0,0 +1,4 @@
+export var Runtimes = /** @type {const} */ ([
+  'Next',
+  'React',
+])

package/source/enumerations/core/scopes.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @type {Scope[]}
+ */
+export const Scopes: Scope[];
+export function getScope(request: Request): Scope | "";

package/source/enumerations/core/scopes.js

@@ -0,0 +1,27 @@
+import { FeatureKindPatterns, Features } from './features.js'
+import { Kinds } from './kinds.js'
+import { Methods } from './methods.js'
+
+/**
+ * @type {Scope[]}
+ */
+export var Scopes = Object
+  .values(Methods)
+  .flatMap(method => Object.values(Features).map(feature => [method, feature]))
+  .flatMap(array => Object.values(Kinds).map(kind => array.concat(kind)))
+  .map(array => array.join('/'))
+
+/**
+ * @param {Request} request
+ *
+ * @returns {Scope | ''}
+ */
+export var getScope = request => {
+  var found = FeatureKindPatterns
+    .find(([, , pattern]) => pattern.test(request.url))
+    ?.slice(0, -1)
+
+  return found
+    ? request.method + '/' + found[0] + '/' + found[1]
+    : ''
+}

package/source/enumerations/entities/city-affilations.d.ts

@@ -0,0 +1 @@
+export const CityAffilations: readonly ["Branch", "Franchise"];

package/source/enumerations/entities/city-affilations.js

@@ -0,0 +1,4 @@
+export var CityAffilations = /** @type {const} */ ([
+  'Branch',
+  'Franchise',
+])

package/source/enumerations/entities/game-statuses.d.ts

@@ -0,0 +1 @@
+export const GameStatuses: readonly ["APPROVED", "ARCHIVE", "CLOSED", "FINISHED", "FORINVITES", "MODERATION", "PUBLISHED", "REJECTED", "IS_RESERVE"];

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

@@ -0,0 +1,11 @@
+export var GameStatuses = /** @type {const} */ ([
+  'APPROVED',
+  'ARCHIVE',
+  'CLOSED',
+  'FINISHED',
+  'FORINVITES',
+  'MODERATION',
+  'PUBLISHED',
+  'REJECTED',
+  'IS_RESERVE',
+])

package/source/enumerations/entities/registration-attributes.d.ts

@@ -0,0 +1,2 @@
+export const RegistrationAttributes: readonly ["Alone", "Birthday", "Newcomer", "Public"];
+export function getRegistrationAttributes(value: RegistrationAttribute[] | Partial<Pick<RegistrationTable, "is_alone" | "is_birthday" | "is_extensible" | "is_first">>): any;

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

@@ -0,0 +1,57 @@
+import { getTag } from '../../functions/tag.js'
+
+export var RegistrationAttributes = /** @type {const} */ ([
+  'Alone',
+  'Birthday',
+  'Newcomer',
+  'Public',
+])
+
+var RegistrationAttributeRegistrationProperties = /** @type {const} */ ([
+  'is_alone',
+  'is_birthday',
+  'is_first',
+  'is_extensible',
+])
+
+var RegistrationAttributeRegistrationProperty = /** @type {const} */ ({
+  'Alone': 'is_alone',
+  'Birthday': 'is_birthday',
+  'Newcomer': 'is_first',
+  'Public': 'is_extensible',
+})
+
+var RegistrationPropertyRegistrationAttribute = /** @type {const} */ ({
+  'is_alone': 'Alone',
+  'is_birthday': 'Birthday',
+  'is_first': 'Newcomer',
+  'is_extensible': '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'.`,
+      )
+  }
+}

package/source/enumerations/entities/registration-channels.d.ts

@@ -0,0 +1 @@
+export const RegistrationChannels: readonly ["email", "telegramBot", "vkontakte"];

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

@@ -0,0 +1,5 @@
+export var RegistrationChannels = /** @type {const} */ ([
+  'email',
+  'telegramBot',
+  'vkontakte',
+])

package/source/enumerations/entities/registration-lineups.d.ts

@@ -0,0 +1,5 @@
+export const RegistrationLineups: readonly ["Main", "Reserve"];
+export function getRegistrationLineup(value: RegistrationLineup | (typeof RegistrationLineupShape)[RegistrationLineup]): any;
+/** @type {Record<RegistrationLineup, Pick<RegistrationTable, 'is_reserve'>>} */
+declare let RegistrationLineupShape: Record<RegistrationLineup, Pick<RegistrationTable, "is_reserve">>;
+export {};

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

@@ -0,0 +1,43 @@
+export var RegistrationLineups = /** @type {const} */ ([
+  'Main',
+  'Reserve',
+])
+
+/** @type {Record<RegistrationLineup, Pick<RegistrationTable, 'is_reserve'>>} */
+let RegistrationLineupShape = {
+  'Main': {
+    is_reserve: false,
+  },
+
+  'Reserve': {
+    is_reserve: true,
+  },
+}
+
+/**
+ * @param {RegistrationLineup | typeof RegistrationLineupShape[RegistrationLineup]} value
+ */
+export var getRegistrationLineup = value => {
+  switch (typeof value) {
+    case 'object':
+      let found = Object
+        .entries(RegistrationLineupShape)
+        .find(([, object]) => object.is_reserve === value.is_reserve)
+        ?.at(0)
+
+      if (!RegistrationLineups.includes(found))
+        throw TypeError(
+          `[Function: getRegistrationLineup] Parameter 'found': '${found}' must be a member of 'Lineups'.`,
+        )
+
+      return found
+
+    case 'string':
+      if (!RegistrationLineups.includes(value))
+        throw TypeError(
+          `[Function: getRegistrationLineup] Parameter 'value': '${value}' must be a member of 'Lineups'.`,
+        )
+
+      return RegistrationLineupShape[value]
+  }
+}

package/source/enumerations/entities/registration-mailings.d.ts

@@ -0,0 +1 @@
+export const RegistrationMailings: readonly ["Idle", "Pending", "Delivered", "Failed"];

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

@@ -0,0 +1,6 @@
+export var RegistrationMailings = /** @type {const} */ ([
+  'Idle',
+  'Pending',
+  'Delivered',
+  'Failed',
+])

package/source/enumerations/entities/registration-statuses.d.ts

@@ -0,0 +1,5 @@
+export const RegistrationStatuses: readonly ["Created", "Confirmed", "Cancelled"];
+export function getRegistrationStatus(value: RegistrationStatus | (typeof RegistrationStatusShape)[RegistrationStatus]): any;
+/** @type {Record<RegistrationStatus, Pick<RegistrationTable, 'is_canceled' | 'is_confirm'>>} */
+declare let RegistrationStatusShape: Record<RegistrationStatus, Pick<RegistrationTable, "is_canceled" | "is_confirm">>;
+export {};

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

@@ -0,0 +1,54 @@
+export var RegistrationStatuses = /** @type {const} */ ([
+  'Created',
+  'Confirmed',
+  'Cancelled',
+])
+
+/** @type {Record<RegistrationStatus, Pick<RegistrationTable, 'is_canceled' | 'is_confirm'>>} */
+let RegistrationStatusShape = {
+  'Created': {
+    is_canceled: false,
+    is_confirm: false,
+  },
+
+  'Confirmed': {
+    is_canceled: false,
+    is_confirm: true,
+  },
+
+  'Cancelled': {
+    is_canceled: true,
+    is_confirm: false,
+  },
+}
+
+/**
+ * @param {RegistrationStatus | typeof RegistrationStatusShape[RegistrationStatus]} value
+ */
+export let getRegistrationStatus = value => {
+  switch (typeof value) {
+    case 'object':
+      let found = Object
+        .entries(RegistrationStatusShape)
+        .find(([, object]) =>
+          object.is_canceled === value.is_canceled
+          && object.is_confirm === value.is_confirm
+        )
+        ?.at(0)
+
+      if (!RegistrationStatuses.includes(found))
+        throw TypeError(
+          `[Function: getRegistrationStatus] Parameter 'found': '${found}' must be a member of 'RegistrationStatuses'.`,
+        )
+
+      return found
+
+    case 'string':
+      if (!RegistrationStatuses.includes(value))
+        throw TypeError(
+          `[Function: getRegistrationStatus] Parameter 'value': '${value}' must be a member of 'RegistrationStatuses'.`,
+        )
+
+      return RegistrationStatusShape[value]
+  }
+}

package/source/enumerations/entities/roles.d.ts

@@ -0,0 +1 @@
+export const Roles: readonly ["admin", "default", "organizer"];

package/source/enumerations/entities/roles.js

@@ -0,0 +1,5 @@
+export var Roles = /** @type {const} */ ([
+  'admin',
+  'default',
+  'organizer',
+])

package/source/enumerations/entities/venue-statuses.d.ts

@@ -0,0 +1 @@
+export const VenueStatuses: readonly ['ACTIVE', 'ARCHIVE']

package/source/enumerations/entities/venue-statuses.js

@@ -0,0 +1,4 @@
+export var VenueStatuses = /** @type {const} */ ([
+  'ACTIVE',
+  'ARCHIVE',
+])

package/source/enumerations/misc/constants.d.ts

@@ -0,0 +1,3 @@
+export namespace Constants {
+    let NilUuid: "00000000-0000-0000-0000-000000000000";
+}

package/source/{entities → enumerations/misc}/constants.js

@@ -1,4 +1,4 @@
-export const Constants = Object.freeze({
+export var Constants = /** @type {const} */ ({
   /**
    * @see https://www.rfc-editor.org/rfc/rfc9562.html#name-nil-uuid
    */

package/source/enumerations/misc/cookies.d.ts

@@ -0,0 +1,5 @@
+export namespace Cookies {
+    let Token: "shaker-quiz-token";
+    let Refresh: "shaker-quiz-refresh-token";
+    let Role: "shaker-quiz-user-role";
+}

package/source/enumerations/misc/cookies.js

@@ -0,0 +1,5 @@
+export var Cookies = /** @type {const} */ ({
+  Token: 'shaker-quiz-token',
+  Refresh: 'shaker-quiz-refresh-token',
+  Role: 'shaker-quiz-user-role',
+})