@shakerquiz/utilities 0.3.45 → 0.4.1

package/source/enumerations/misc/icons.js

@@ -0,0 +1,326 @@
+export var Icons = /** @type {const} */ ([
+  'academic-cap',
+  'adjustments-horizontal',
+  'adjustments-vertical',
+  'archive-box-arrow-down',
+  'archive-box-x-mark',
+  'archive-box',
+  'arrow-down-circle',
+  'arrow-down-left',
+  'arrow-down-on-square-stack',
+  'arrow-down-on-square',
+  'arrow-down-right',
+  'arrow-down-tray',
+  'arrow-down',
+  'arrow-left-circle',
+  'arrow-left-end-on-rectangle',
+  'arrow-left-on-rectangle',
+  'arrow-left-start-on-rectangle',
+  'arrow-left',
+  'arrow-long-down',
+  'arrow-long-left',
+  'arrow-long-right',
+  'arrow-long-up',
+  'arrow-path-rounded-square',
+  'arrow-path',
+  'arrow-right-circle',
+  'arrow-right-end-on-rectangle',
+  'arrow-right-on-rectangle',
+  'arrow-right-start-on-rectangle',
+  'arrow-right',
+  'arrow-small-down',
+  'arrow-small-left',
+  'arrow-small-right',
+  'arrow-small-up',
+  'arrow-top-right-on-square',
+  'arrow-trending-down',
+  'arrow-trending-up',
+  'arrow-turn-down-left',
+  'arrow-turn-down-right',
+  'arrow-turn-left-down',
+  'arrow-turn-left-up',
+  'arrow-turn-right-down',
+  'arrow-turn-right-up',
+  'arrow-turn-up-left',
+  'arrow-turn-up-right',
+  'arrow-up-circle',
+  'arrow-up-left',
+  'arrow-up-on-square-stack',
+  'arrow-up-on-square',
+  'arrow-up-right',
+  'arrow-up-tray',
+  'arrow-up',
+  'arrow-uturn-down',
+  'arrow-uturn-left',
+  'arrow-uturn-right',
+  'arrow-uturn-up',
+  'arrows-pointing-in',
+  'arrows-pointing-out',
+  'arrows-right-left',
+  'arrows-up-down',
+  'at-symbol',
+  'backspace',
+  'backward',
+  'banknotes',
+  'bars-2',
+  'bars-3-bottom-left',
+  'bars-3-bottom-right',
+  'bars-3-center-left',
+  'bars-3',
+  'bars-4',
+  'bars-arrow-down',
+  'bars-arrow-up',
+  'battery-0',
+  'battery-100',
+  'battery-50',
+  'beaker',
+  'bell-alert',
+  'bell-slash',
+  'bell-snooze',
+  'bell',
+  'bold',
+  'bolt-slash',
+  'bolt',
+  'book-open',
+  'bookmark-slash',
+  'bookmark-square',
+  'bookmark',
+  'briefcase',
+  'bug-ant',
+  'building-library',
+  'building-office-2',
+  'building-office',
+  'building-storefront',
+  'cake',
+  'calculator',
+  'calendar-date-range',
+  'calendar-days',
+  'calendar',
+  'camera',
+  'chart-bar-square',
+  'chart-bar',
+  'chart-pie',
+  'chat-bubble-bottom-center-text',
+  'chat-bubble-bottom-center',
+  'chat-bubble-left-ellipsis',
+  'chat-bubble-left-right',
+  'chat-bubble-left',
+  'chat-bubble-oval-left-ellipsis',
+  'chat-bubble-oval-left',
+  'check-badge',
+  'check-circle',
+  'check',
+  'chevron-double-down',
+  'chevron-double-left',
+  'chevron-double-right',
+  'chevron-double-up',
+  'chevron-down',
+  'chevron-left',
+  'chevron-right',
+  'chevron-up-down',
+  'chevron-up',
+  'circle-stack',
+  'clipboard-document-check',
+  'clipboard-document-list',
+  'clipboard-document',
+  'clipboard',
+  'clock',
+  'cloud-arrow-down',
+  'cloud-arrow-up',
+  'cloud',
+  'code-bracket-square',
+  'code-bracket',
+  'cog-6-tooth',
+  'cog-8-tooth',
+  'cog',
+  'command-line',
+  'computer-desktop',
+  'cpu-chip',
+  'credit-card',
+  'cube-transparent',
+  'cube',
+  'currency-bangladeshi',
+  'currency-dollar',
+  'currency-euro',
+  'currency-pound',
+  'currency-rupee',
+  'currency-yen',
+  'cursor-arrow-rays',
+  'cursor-arrow-ripple',
+  'device-phone-mobile',
+  'device-tablet',
+  'divide',
+  'document-arrow-down',
+  'document-arrow-up',
+  'document-chart-bar',
+  'document-check',
+  'document-currency-bangladeshi',
+  'document-currency-dollar',
+  'document-currency-euro',
+  'document-currency-pound',
+  'document-currency-rupee',
+  'document-currency-yen',
+  'document-duplicate',
+  'document-magnifying-glass',
+  'document-minus',
+  'document-plus',
+  'document-text',
+  'document',
+  'ellipsis-horizontal-circle',
+  'ellipsis-horizontal',
+  'ellipsis-vertical',
+  'envelope-open',
+  'envelope',
+  'equals',
+  'exclamation-circle',
+  'exclamation-triangle',
+  'eye-dropper',
+  'eye-slash',
+  'eye',
+  'face-frown',
+  'face-smile',
+  'film',
+  'finger-print',
+  'fire',
+  'flag',
+  'folder-arrow-down',
+  'folder-minus',
+  'folder-open',
+  'folder-plus',
+  'folder',
+  'forward',
+  'funnel',
+  'gif',
+  'gift-top',
+  'gift',
+  'globe-alt',
+  'globe-americas',
+  'globe-asia-australia',
+  'globe-europe-africa',
+  'h1',
+  'h2',
+  'h3',
+  'hand-raised',
+  'hand-thumb-down',
+  'hand-thumb-up',
+  'hashtag',
+  'heart',
+  'home-modern',
+  'home',
+  'identification',
+  'inbox-arrow-down',
+  'inbox-stack',
+  'inbox',
+  'information-circle',
+  'italic',
+  'key',
+  'language',
+  'lifebuoy',
+  'light-bulb',
+  'link-slash',
+  'link',
+  'list-bullet',
+  'lock-closed',
+  'lock-open',
+  'magnifying-glass-circle',
+  'magnifying-glass-minus',
+  'magnifying-glass-plus',
+  'magnifying-glass',
+  'map-pin',
+  'map',
+  'megaphone',
+  'microphone',
+  'minus-circle',
+  'minus-small',
+  'minus',
+  'moon',
+  'musical-note',
+  'newspaper',
+  'no-symbol',
+  'numbered-list',
+  'paint-brush',
+  'paper-airplane',
+  'paper-clip',
+  'pause-circle',
+  'pause',
+  'pencil-square',
+  'pencil',
+  'percent-badge',
+  'phone-arrow-down-left',
+  'phone-arrow-up-right',
+  'phone-x-mark',
+  'phone',
+  'photo',
+  'play-circle',
+  'play-pause',
+  'play',
+  'plus-circle',
+  'plus-small',
+  'plus',
+  'power',
+  'presentation-chart-bar',
+  'presentation-chart-line',
+  'printer',
+  'puzzle-piece',
+  'qr-code',
+  'question-mark-circle',
+  'queue-list',
+  'radio',
+  'receipt-percent',
+  'receipt-refund',
+  'rectangle-group',
+  'rectangle-stack',
+  'rocket-launch',
+  'rss',
+  'scale',
+  'scissors',
+  'server-stack',
+  'server',
+  'share',
+  'shield-check',
+  'shield-exclamation',
+  'shopping-bag',
+  'shopping-cart',
+  'signal-slash',
+  'signal',
+  'slash',
+  'sparkles',
+  'speaker-wave',
+  'speaker-x-mark',
+  'square-2-stack',
+  'square-3-stack-3d',
+  'squares-2x2',
+  'squares-plus',
+  'star',
+  'stop-circle',
+  'stop',
+  'strikethrough',
+  'sun',
+  'swatch',
+  'table-cells',
+  'tag',
+  'ticket',
+  'trash',
+  'trophy',
+  'truck',
+  'tv',
+  'underline',
+  'user-circle',
+  'user-group',
+  'user-minus',
+  'user-plus',
+  'user',
+  'users',
+  'variable',
+  'video-camera-slash',
+  'video-camera',
+  'view-columns',
+  'viewfinder-circle',
+  'wallet',
+  'wifi',
+  'window',
+  'wrench-screwdriver',
+  'wrench',
+  'x-circle',
+  'x-mark',
+])

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

@@ -0,0 +1 @@
+export const Phases: readonly ["Aborted", "Failed", "Idle", "Loaded", "Loading"];

package/source/enumerations/misc/phases.js

@@ -0,0 +1,7 @@
+export var Phases = /** @type {const} */ ([
+  'Aborted',
+  'Failed',
+  'Idle',
+  'Loaded',
+  'Loading',
+])

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

@@ -0,0 +1 @@
+export const Requirements: readonly ["Checkin", "Body"];

package/source/enumerations/misc/requirements.js

@@ -0,0 +1,4 @@
+export var Requirements = /** @type {const} */ ([
+  'Checkin',
+  'Body',
+])

package/source/enumerations/schemas.d.ts

@@ -1,4 +1,4 @@
-export namespace Schemas {
+export namespace DomainSchema {
     export { UserSchema as User };
     export { RoleSchema as Role };
     export { CitySchema as City };

package/source/enumerations/schemas.js

@@ -1,5 +1,3 @@
-import { Domains } from '../enumerations/domains.js'
-
 import { CitySchema } from '../schemas/city.js'
 import { GameSchema } from '../schemas/game.js'
 import { RegistrationSchema } from '../schemas/registration.js'
@@ -8,12 +6,12 @@ import { ThemeSchema } from '../schemas/theme.js'
 import { UserSchema } from '../schemas/user.js'
 import { VenueSchema } from '../schemas/venue.js'
 
-export var Schemas = /** @type {const} */ ({
-  [Domains.User]: UserSchema,
-  [Domains.Role]: RoleSchema,
-  [Domains.City]: CitySchema,
-  [Domains.Venue]: VenueSchema,
-  [Domains.Theme]: ThemeSchema,
-  [Domains.Game]: GameSchema,
-  [Domains.Registration]: RegistrationSchema,
+export var DomainSchema = /** @type {const} */ ({
+  'User': UserSchema,
+  'Role': RoleSchema,
+  'City': CitySchema,
+  'Venue': VenueSchema,
+  'Theme': ThemeSchema,
+  'Game': GameSchema,
+  'Registration': RegistrationSchema,
 })

package/source/functions/pathname.d.ts

@@ -1 +1 @@
-export function getFeaturePathname(feature: Feature, kind?: Kind): string;
+export function scopePathname(scope: Scope): string;

package/source/functions/pathname.js

@@ -1,40 +1,35 @@
 import { is } from '@yurkimus/types'
 
-import { FeatureKindPathnames, Features } from '../enumerations/features.js'
-import { Kinds } from '../enumerations/kinds.js'
+import { FeatureKindPathname } from '../enumerations/core/features.js'
+import { Scopes } from '../enumerations/core/scopes.js'
 
 /**
- * @param {Feature} feature
- * @param {Kind} [kind]
+ * @param {Scope} scope
  */
-export var getFeaturePathname = (
-  feature,
-  kind = Kinds.Unit,
-) => {
-  if (!(feature in Features))
+export var scopePathname = scope => {
+  if (!Scopes.includes(scope))
     throw TypeError(
-      `[getFeaturePathname] Parameter 'feature' must be a member of 'Features'.`,
+      `[scopePathname] Unknown scope '${scope}': not present in 'Scopes'.`,
     )
 
-  if (!(kind in Kinds))
-    throw TypeError(
-      `[getFeaturePathname] Parameter 'kind' must be a member of 'Kinds'.`,
-    )
+  var [method, feature, kind] = scope.split('/')
 
-  if (!(feature in FeatureKindPathnames))
+  if (!(feature in FeatureKindPathname))
     throw TypeError(
-      `[getFeaturePathname] Feature '${feature}' is not defined in 'FeatureKindPathnames'.`,
+      `[scopePathname] Feature '${feature}' is not defined in 'FeatureKindPathname'.`,
     )
 
-  if (!(kind in FeatureKindPathnames[feature]))
+  if (!(kind in FeatureKindPathname[feature]))
     throw TypeError(
-      `[getFeaturePathname] Feature's '${feature}' Kind '${kind}' is not defined in 'FeatureKindPathnames[${feature}]'.`,
+      `[scopePathname] Kind '${kind}' is not defined under Feature '${feature}' in 'FeatureKindPathname'.`,
     )
 
-  if (!is('String', FeatureKindPathnames[feature][kind]))
+  if (!is('String', FeatureKindPathname[feature][kind]))
     throw TypeError(
-      `[getFeaturePathname] Feature's '${feature}' Kind '${kind}' must be a 'String'.`,
+      `[scopePathname] Invalid value at FeatureKindPathname['${feature}']['${kind}']: expected a string, got '${typeof FeatureKindPathname[
+        feature
+      ][kind]}'.`,
     )
 
-  return FeatureKindPathnames[feature][kind]
+  return FeatureKindPathname[feature][kind]
 }

package/source/functions/request.d.ts

@@ -0,0 +1,3 @@
+export function parseResponse(response: Response): any;
+export function resolveResponse(scope: Scope, [response, value]: [Response, any]): any;
+export function scopeRequest<R>(scope: Scope, input: RequestInfo, init: RequestInit): Promise<R>;

package/source/functions/request.js

@@ -0,0 +1,81 @@
+import { Methods } from '../enumerations/core/methods.js'
+import { Scopes } from '../enumerations/core/scopes.js'
+
+/**
+ * @param {Response} response
+ */
+export var parseResponse = response => {
+  let mime = response.headers.get('Content-Type') ?? ''
+
+  if (mime.includes('application/json'))
+    return Promise.all([
+      response,
+      response.json(),
+    ])
+  else if (mime.includes('multipart/form-data'))
+    return Promise.all([
+      response,
+      response.formData(),
+    ])
+  else
+    return Promise.all([
+      response,
+      response.text(),
+    ])
+}
+
+/**
+ * @param {Scope} scope
+ * @param {[Response, any]} param1
+ */
+export var resolveResponse = (scope, [response, value]) => {
+  let [method, feature, kind] = scope.split('/')
+
+  if (response.ok) {
+    switch (response.status) {
+      case 204:
+        switch (kind) {
+          case 'Unit':
+            return null
+
+          case 'Set':
+            return []
+        }
+
+      default:
+        return value
+    }
+  } else
+    throw value
+}
+
+/**
+ * @template R
+ *
+ * @param {Scope} scope
+ * @param {RequestInfo} input
+ * @param {RequestInit} init
+ *
+ * @returns {Promise<R>}
+ */
+export var scopeRequest = (scope, input, init) => {
+  if (!Scopes.includes(scope))
+    throw TypeError(
+      `Parameter 'scope' must be listed in 'Scopes'.`,
+    )
+
+  let [method, feature, kind] = scope.split('/')
+
+  if (!('method' in init))
+    init.method = method
+
+  if (!Methods.includes(init.method))
+    throw TypeError(
+      `[featureFetch] Method '${init.method}' is not listed in 'Methods'.`,
+    )
+
+  return globalThis
+    .fetch(input, init)
+    .then(parseResponse)
+    .then(resolveResponse.bind(null, scope))
+}

package/source/functions/schema.js

@@ -1,16 +1,16 @@
-import { Schemas } from '../enumerations/schemas.js'
+import { DomainSchema } from '../enumerations/schemas.js'
 
 /**
  * @param {Feature} feature
  * @param {*} object
  */
 export function validateSchema(feature, object) {
-  if (!(feature in Schemas))
+  if (!(feature in DomainSchema))
     throw TypeError(
       `[validateSchema] Parameter 'feature' '${feature}' must be a member of 'Schemas'.`,
     )
 
-  let schema = Schemas[feature]
+  let schema = DomainSchema[feature]
 
   for (let property in object)
     if (!(property in schema))

package/source/globals.d.ts

@@ -7,14 +7,6 @@ interface RequestInit {
    * @description A method string defined by RFC7231 @see {@link https://datatracker.ietf.org/doc/html/rfc7231#section-4.3}
    */
   method?: Method
-  /**
-   * @description Target network to where send the request
-   */
-  network?: Network
-  /**
-   * @description A string to declaratively set the Authorization header.
-   */
-  cookie?: string
 }
 
 /**
@@ -27,60 +19,69 @@ type UseState<Type> = [
 ]
 
 /**
- * General
+ * Core
  */
 
-type Method = keyof typeof import('./enumerations/methods.js').Methods
+type Method = typeof import('./enumerations/core/methods.js').Methods[number]
 
-type Kind = keyof typeof import('./enumerations/kinds.js').Kinds
+type Domain = typeof import('./enumerations/core/domains.js').Domains[number]
 
-type Network = keyof typeof import('./enumerations/networks.js').Networks
+type Procedure =
+  typeof import('./enumerations/core/procedures.js').Procedures[number]
 
-type Phase = keyof typeof import('./enumerations/phases.js').Phases
+type Feature = Domain | Procedure
 
-type Requirement =
-  keyof typeof import('./enumerations/requirements.d.ts').Requirements
-
-/**
- * Domain
- */
+type Kind = typeof import('./enumerations/core/kinds.js').Kinds[number]
 
-type Domain = keyof typeof import('./enumerations/domains.js').Domains
-type Page = keyof typeof import('./enumerations/pages.js').Pages
-type Procedure = keyof typeof import('./enumerations/procedures.js').Procedures
-type Feature = Domain | Page | Procedure
+type Scope = `${Method}/${Feature}/${Kind}`
 
-type Backend = keyof typeof import('./enumerations/backends.js').Backends
-type Frontend = keyof typeof import('./enumerations/frontends.js').Frontends
-type Service = Backend | Frontend
+type Requirement =
+  typeof import('./enumerations/misc/requirements.js').Requirements[number]
 
-type Role = keyof typeof import('./enumerations/roles.js').Roles
+type Role = keyof typeof import('./enumerations/entities/roles.js').Roles
 
 type GameStatus =
-  keyof typeof import('./enumerations/game-statuses.js').GameStatuses
+  keyof typeof import('./enumerations/entities/game-statuses.js').GameStatuses
 
 type RegistrationStatus =
-  keyof typeof import('./enumerations/registration-statuses.js').RegistrationStatuses
+  keyof typeof import('./enumerations/entities/registration-statuses.js').RegistrationStatuses
 
-type Lineup = keyof typeof import('./enumerations/lineups.js').Lineups
+type Lineup = keyof typeof import('./enumerations/entities/lineups.js').Lineups
 
 type Affilation =
-  keyof typeof import('./enumerations/affilations.js').Affilations
+  keyof typeof import('./enumerations/entities/affilations.js').Affilations
+
+/**
+ * Misc
+ */
+
+type Icon = typeof import('./enumerations/misc/icons.js').Icons[number]
+
+type Phase = typeof import('./enumerations/misc/phases.js').Phases[number]
+
+/**
+ * Products
+ */
+
+type ScopePhase = Record<Scope, Phase>
+
+type ScopeState = Record<Scope, any>
+
+type ScopeController = Record<Scope, AbortController | null>
 
 /**
  * Schemas
  */
 
 type CityColumn = keyof typeof import('./schemas/city.js').CityColumns
+
 type GameColumn = keyof typeof import('./schemas/game.js').GameColumns
+
 type RegistrationColumn =
   keyof typeof import('./schemas/registration.js').RegistrationColumns
+
 type ThemeColumn = keyof typeof import('./schemas/theme.js').ThemeColumns
-type UserColumn = keyof typeof import('./schemas/user.js').UserColumns
-type VenueColumn = keyof typeof import('./schemas/venue.js').VenueColumns
 
-/**
- * Misc
- */
+type UserColumn = keyof typeof import('./schemas/user.js').UserColumns
 
-type Icon = keyof typeof import('./enumerations/icons.js').Icons
+type VenueColumn = keyof typeof import('./schemas/venue.js').VenueColumns