@shakerquiz/utilities 4.0.81 → 4.0.83

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@shakerquiz/utilities",
-  "version": "4.0.81",
+  "version": "4.0.83",
   "author": "yurkimus <yurkimus@gmail.com>",
   "license": "ISC",
   "repository": {
@@ -9,13 +9,19 @@
     "url": "https://github.com/shaker-quiz/utilities.git"
   },
   "exports": {
-    "default": "./source/index.js"
+    ".": {
+      "default": "./source/index.js"
+    },
+    "./helpers/*": {
+      "default": "./source/helpers/*.js"
+    }
   },
   "scripts": {
     "prepublishOnly": "bun scripts/codegen.js && dprint fmt --includes-override source/codegen/autogenerated.js"
   },
   "devDependencies": {
-    "@types/bun": "1.3.8",
-    "dprint": "0.51.1"
+    "@types/bun": "1.3.10",
+    "dprint": "0.51.1",
+    "typescript": "5.9.3"
   }
 }

package/source/entities/method.js

@@ -11,6 +11,7 @@ export const Methods = Object.freeze(
     'PATCH',
     'POST',
     'PUT',
+    'HEAD',
   ]),
 )
 

package/source/helpers/map.js

@@ -0,0 +1,21 @@
+/**
+ * @param {Map} collection
+ */
+export const set = (collection, key, value) => {
+  var result = new Map(collection)
+
+  result.set(key, value)
+
+  return result
+}
+
+/**
+ * @param {Map} collection
+ */
+export const remove = (collection, key) => {
+  var result = new Map(collection)
+
+  result.delete(key)
+
+  return result
+}

package/source/helpers/next-router.js

@@ -0,0 +1,29 @@
+/**
+ * @param {object} router
+ * @param {string | Partial<URL>} input
+ * @param {{ shallow?: boolean }} [transition]
+ */
+export const push = (router, input, transition) => {
+  if (!Object.hasOwn(router, 'push'))
+    throw TypeError(`Parameter 'router.push' is not defined.`)
+
+  if (typeof router.push !== 'function')
+    throw TypeError(`Parameter 'router.push' is not a function.`)
+
+  return router.push(input, undefined, transition)
+}
+
+/**
+ * @param {object} router
+ * @param {string | Partial<URL>} input
+ * @param {{ shallow?: boolean }} [transition]
+ */
+export const replace = (router, input, transition) => {
+  if (!Object.hasOwn(router, 'replace'))
+    throw TypeError(`Parameter 'router.replace' is not defined.`)
+
+  if (typeof router.replace !== 'function')
+    throw TypeError(`Parameter 'router.replace' is not a function.`)
+
+  return router.replace(input, undefined, transition)
+}

package/source/helpers/object.js

@@ -7,7 +7,7 @@ export const hasOwn = Object.hasOwn
  * @param {object} o
  * @param {PropertyKey} v
  *
- * @returns {any}
+ * @returns {*}
  */
 export const tryOwn = (o, v) => hasOwn(o, v) ? o[v] : undefined
 
@@ -28,3 +28,19 @@ export const getOwn = (o, v) => {
 
   return o[v]
 }
+
+export const set = (object, key, value) => {
+  var result = { ...object }
+
+  result[key] = value
+
+  return result
+}
+
+export const remove = (object, key) => {
+  var result = { ...object }
+
+  delete result[key]
+
+  return result
+}

package/source/helpers/promise.js

@@ -2,14 +2,17 @@ export let settle = value =>
   Promise
     .resolve(value)
     .then(
-      value => ({ status: 'fulfilled', value }),
-      reason => ({ status: 'rejected', reason }),
+      value => (/** @type {const} */ ({ status: 'fulfilled', value })),
+      reason => (/** @type {const} */ ({ status: 'rejected', reason })),
     )
 
+/**
+ * @param {Parameters<typeof Promise.try>[0]} fn
+ */
 export let trySettle = (fn, ...args) =>
   Promise
     .try(fn, ...args)
     .then(
-      value => ({ status: 'fulfilled', value }),
-      reason => ({ status: 'rejected', reason }),
+      value => (/** @type {const} */ ({ status: 'fulfilled', value })),
+      reason => (/** @type {const} */ ({ status: 'rejected', reason })),
     )

package/source/helpers/url-search-params.js

@@ -0,0 +1,21 @@
+/**
+ * @param {URLSearchParams} collection
+ */
+export const set = (collection, key, value) => {
+  var result = new URLSearchParams(collection)
+
+  result.set(key, value)
+
+  return result
+}
+
+/**
+ * @param {URLSearchParams} collection
+ */
+export const remove = (collection, key) => {
+  var result = new URLSearchParams(collection)
+
+  result.delete(key)
+
+  return result
+}

package/source/index.js

@@ -38,9 +38,5 @@ 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/array.js'
-export * from './helpers/object.js'
-export * from './helpers/promise.js'
 export * from './helpers/route.js'
 export * from './helpers/tag.js'

package/source/helpers/access.js

@@ -1,160 +0,0 @@
-import { ParameterPattern, PathnameParameters, 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'
-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 { Route } from '../entities/routes.js'
-import { Runtime } from '../entities/runtimes.js'
-import { ServiceRuntime } from '../entities/service-runtime.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'
-
-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'],
-  [ParameterPattern, 'pattern'],
-  [PathnameParameters, 'parameters'],
-  [Pattern, 'pattern'],
-  [Phase, 'phase'],
-  [Quantifier, 'quantifier'],
-  [RegistrationChannel, 'channel'],
-  [RegistrationLineup, 'lineup'],
-  [RegistrationMailing, 'mailing'],
-  [RegistrationStatus, 'status'],
-  [Role, 'name'],
-  [Route, 'route'],
-  [RouteCardinality, 'cardinality'],
-  [RoutePathname, 'pathname'],
-  [RouteService, 'service'],
-  [Runtime, 'runtime'],
-  [Service, 'service'],
-  [ServiceRoutes, 'routes'],
-  [ServiceRuntime, 'runtime'],
-  [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'],
-  [ParameterPattern, 'ParameterPattern'],
-  [PathnameParameters, 'PathnameParameters'],
-  [Pattern, 'Pattern'],
-  [Phase, 'Phase'],
-  [Quantifier, 'Quantifier'],
-  [RegistrationChannel, 'RegistrationChannel'],
-  [RegistrationLineup, 'RegistrationLineup'],
-  [RegistrationMailing, 'RegistrationMailing'],
-  [RegistrationStatus, 'RegistrationStatus'],
-  [Role, 'Role'],
-  [Route, 'Route'],
-  [RouteCardinality, 'RouteCardinality'],
-  [RoutePathname, 'RoutePathname'],
-  [RouteService, 'RouteService'],
-  [Runtime, 'Runtime'],
-  [Service, 'Service'],
-  [ServiceRuntime, 'ServiceRuntime'],
-  [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'
-  }
-}