@shakerquiz/utilities 0.4.1 → 0.4.2

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@shakerquiz/utilities",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "author": "yurkimus <yurkimus@gmail.com>",
   "license": "ISC",
   "scripts": {
-    "type": "tsc --emitdeclarationonly --declaration --allowjs"
+    "type": "tsc --emitdeclarationonly --declaration --allowjs ./source/**/*"
   },
   "exports": {
     ".": {

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

@@ -1,3 +1,21 @@
+export const Domains: readonly ["Asset", "User", "Role", "City", "Venue", "Theme", "ThemeAsset", "Game", "GameAsset", "Registration", "Mailing"];
+/**
+ * @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>>;
 export const Features: ("Asset" | "User" | "Role" | "City" | "Venue" | "Theme" | "ThemeAsset" | "Game" | "GameAsset" | "Registration" | "Mailing")[];
 /**
  * @type {Record<Feature, Icon>}
@@ -7,7 +25,3 @@ export const FeatureIcon: Record<Feature, Icon>;
  * @type {Record<Feature, Record<Kind, string>>}
  */
 export const FeatureKindPathname: Record<Feature, Record<Kind, string>>;
-/**
- * @type {Record<Feature, Record<Method, Requirement>>}
- */
-export const FeatureMethodRequirements: Record<Feature, Record<Method, Requirement>>;

package/source/enumerations/core/features.js

@@ -1,6 +1,103 @@
-import { DomainIcon, DomainKindPathname, DomainMethodRequirements, Domains } from './domains.js'
+export var Domains = /** @type {const} */ ([
+  'Asset',
+  'User',
+  'Role',
+  'City',
+  'Venue',
+  'Theme',
+  'ThemeAsset',
+  'Game',
+  'GameAsset',
+  'Registration',
+  'Mailing',
+])
 
-import { ProcedureIcon, ProcedureKindPathname, ProcedureMethodRequirements, Procedures } from './procedures.js'
+/**
+ * @type {Record<Domain, Icon>}
+ */
+export var DomainIcon = {
+  'User': 'users',
+  'Role': 'identification',
+  '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 = {
+  'User': {
+    'Unit': '/user/:user?',
+    'Set': '/users',
+  },
+
+  'Role': {
+    'Unit': '/role/:role?',
+    'Set': '/roles',
+  },
+
+  'City': {
+    'Unit': '/city/:city?',
+    'Set': '/cities',
+  },
+
+  'Venue': {
+    'Unit': '/venue/:venue?',
+    'Set': '/venues',
+  },
+
+  'Theme': {
+    'Unit': '/theme/:theme?',
+    'Set': '/themes',
+  },
+
+  'Game': {
+    'Unit': '/game/:game?',
+    'Set': '/games',
+  },
+
+  '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 = {
+  'Checkin': {
+    'Unit': '/checkin',
+    'Set': '/checkins',
+  },
+
+  'Redirect': {
+    'Unit': '/redirect',
+    'Set': '/redirects',
+  },
+}
 
 export var Features = Domains.concat(Procedures)
 
@@ -19,11 +116,3 @@ export var FeatureKindPathname = {
   ...DomainKindPathname,
   ...ProcedureKindPathname,
 }
-
-/**
- * @type {Record<Feature, Record<Method, Requirement>>}
- */
-export var FeatureMethodRequirements = {
-  ...DomainMethodRequirements,
-  ...ProcedureMethodRequirements,
-}

package/source/index.d.ts

@@ -9,11 +9,9 @@
 /// <reference path='./user.d.ts' />
 /// <reference path='./venue.d.ts' />
 
-export * from './enumerations/core/domains.js'
 export * from './enumerations/core/features.js'
 export * from './enumerations/core/kinds.js'
 export * from './enumerations/core/methods.js'
-export * from './enumerations/core/procedures.js'
 export * from './enumerations/core/scopes.js'
 
 export * from './enumerations/misc/constants.js'

package/source/index.js

@@ -9,11 +9,9 @@
 /// <reference path='./user.d.ts' />
 /// <reference path='./venue.d.ts' />
 
-export * from './enumerations/core/domains.js'
 export * from './enumerations/core/features.js'
 export * from './enumerations/core/kinds.js'
 export * from './enumerations/core/methods.js'
-export * from './enumerations/core/procedures.js'
 export * from './enumerations/core/scopes.js'
 
 export * from './enumerations/misc/constants.js'

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

@@ -1,13 +0,0 @@
-export const Domains: readonly ["Asset", "User", "Role", "City", "Venue", "Theme", "ThemeAsset", "Game", "GameAsset", "Registration", "Mailing"];
-/**
- * @type {Record<Domain, Icon>}
- */
-export const DomainIcon: Record<Domain, Icon>;
-/**
- * @type {Record<Domain, Record<Kind, string>>}
- */
-export const DomainKindPathname: Record<Domain, Record<Kind, string>>;
-/**
- * @type {Record<Domain, Record<Method, Set<Requirement>>>}
- */
-export const DomainMethodRequirements: Record<Domain, Record<Method, Set<Requirement>>>;

package/source/enumerations/core/domains.js

@@ -1,149 +0,0 @@
-export var Domains = /** @type {const} */ ([
-  'Asset',
-  'User',
-  'Role',
-  'City',
-  'Venue',
-  'Theme',
-  'ThemeAsset',
-  'Game',
-  'GameAsset',
-  'Registration',
-  'Mailing',
-])
-
-/**
- * @type {Record<Domain, Icon>}
- */
-export var DomainIcon = {
-  'User': 'users',
-  'Role': 'identification',
-  '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 = {
-  'User': {
-    'Unit': '/user/:user?',
-    'Set': '/users',
-  },
-
-  'Role': {
-    'Unit': '/role/:role?',
-    'Set': '/roles',
-  },
-
-  'City': {
-    'Unit': '/city/:city?',
-    'Set': '/cities',
-  },
-
-  'Venue': {
-    'Unit': '/venue/:venue?',
-    'Set': '/venues',
-  },
-
-  'Theme': {
-    'Unit': '/theme/:theme?',
-    'Set': '/themes',
-  },
-
-  'Game': {
-    'Unit': '/game/:game?',
-    'Set': '/games',
-  },
-
-  'Registration': {
-    'Unit': '/registration/:registration?',
-    'Set': '/registrations',
-  },
-
-  'Mailing': {
-    'Unit': '/mailing/:mailing?',
-    'Set': '/mailings',
-  },
-}
-
-/**
- * @type {Record<Domain, Record<Method, Set<Requirement>>>}
- */
-export var DomainMethodRequirements = {
-  'User': {
-    'DELETE': new Set(['Checkin']),
-    'GET': new Set(['Checkin']),
-    'OPTIONS': new Set([]),
-    'PATCH': new Set(['Checkin', 'Body']),
-    'POST': new Set(['Checkin', 'Body']),
-    'PUT': new Set(['Checkin', 'Body']),
-  },
-
-  'Role': {
-    'DELETE': new Set(['Checkin']),
-    'GET': new Set(['Checkin']),
-    'OPTIONS': new Set([]),
-    'PATCH': new Set(['Checkin', 'Body']),
-    'POST': new Set(['Checkin', 'Body']),
-    'PUT': new Set(['Checkin', 'Body']),
-  },
-
-  'City': {
-    'DELETE': new Set(['Checkin']),
-    'GET': new Set(['Checkin']),
-    'OPTIONS': new Set([]),
-    'PATCH': new Set(['Checkin', 'Body']),
-    'POST': new Set(['Checkin', 'Body']),
-    'PUT': new Set(['Checkin', 'Body']),
-  },
-
-  'Venue': {
-    'DELETE': new Set(['Checkin']),
-    'GET': new Set(['Checkin']),
-    'OPTIONS': new Set([]),
-    'PATCH': new Set(['Checkin', 'Body']),
-    'POST': new Set(['Checkin', 'Body']),
-    'PUT': new Set(['Checkin', 'Body']),
-  },
-
-  'Theme': {
-    'DELETE': new Set(['Checkin']),
-    'GET': new Set(['Checkin']),
-    'OPTIONS': new Set([]),
-    'PATCH': new Set(['Checkin', 'Body']),
-    'POST': new Set(['Checkin', 'Body']),
-    'PUT': new Set(['Checkin', 'Body']),
-  },
-
-  'Game': {
-    'DELETE': new Set(['Checkin']),
-    'GET': new Set(['Checkin']),
-    'OPTIONS': new Set([]),
-    'PATCH': new Set(['Checkin', 'Body']),
-    'POST': new Set(['Checkin', 'Body']),
-    'PUT': new Set(['Checkin', 'Body']),
-  },
-
-  'Registration': {
-    'DELETE': new Set(['Checkin']),
-    'GET': new Set(['Checkin']),
-    'OPTIONS': new Set([]),
-    'PATCH': new Set(['Checkin', 'Body']),
-    'POST': new Set(['Checkin', 'Body']),
-    'PUT': new Set(['Checkin', 'Body']),
-  },
-
-  'Mailing': {
-    'DELETE': new Set(['Checkin']),
-    'GET': new Set(['Checkin']),
-    'OPTIONS': new Set([]),
-    'PATCH': new Set(['Checkin', 'Body']),
-    'POST': new Set(['Checkin', 'Body']),
-    'PUT': new Set(['Checkin', 'Body']),
-  },
-}

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

@@ -1,13 +0,0 @@
-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 {Record<Procedure, Record<Method, Set<Requirement>>>}
- */
-export const ProcedureMethodRequirements: Record<Procedure, Record<Method, Set<Requirement>>>;

package/source/enumerations/core/procedures.js

@@ -1,45 +0,0 @@
-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 = {
-  'Checkin': {
-    'Unit': '/checkin',
-    'Set': '/checkins',
-  },
-
-  'Redirect': {
-    'Unit': '/redirect',
-    'Set': '/redirects',
-  },
-}
-
-/**
- * @type {Record<Procedure, Record<Method, Set<Requirement>>>}
- */
-export var ProcedureMethodRequirements = {
-  'Checkin': {
-    'DELETE': new Set([]),
-    'GET': new Set([]),
-    'OPTIONS': new Set([]),
-    'PATCH': new Set([]),
-    'POST': new Set(['Body']),
-    'PUT': new Set([]),
-  },
-
-  'Redirect': {
-    'GET': new Set([]),
-  },
-}

package/source/functions/request.d.ts

@@ -1,3 +0,0 @@
-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

@@ -1,81 +0,0 @@
-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))
-}