@greendrake/util 0.1.0 → 0.2.0

package/README.md

@@ -151,7 +151,7 @@ document.documentElement.dir = isRTLLocale(navigator.language) ? 'rtl' : 'ltr'
 
 ## DOM and geolocation
 
-Importable in Node; these touch `document`, `window` and `navigator` only when called.
+The `./browser` entry, apart from the rest because their types are the DOM lib's: a program that type-checks without it — a bun service reaching this package through `@greendrake/rpc` — never compiles them. Importable in Node all the same; they touch `document`, `window` and `navigator` only when called.
 
 - `getReadyStatePromise()` — resolves when `document.readyState` reaches `'complete'` (immediately if it already has); one shared promise per module instance.
 - `hasFinePointer()` — `matchMedia('(hover: hover) and (pointer: fine)')`: true where the primary input is a mouse or trackpad rather than a finger. Serves as a proxy for "focusing a field will not raise an on-screen keyboard", which no platform exposes directly.
@@ -159,7 +159,7 @@ Importable in Node; these touch `document`, `window` and `navigator` only when c
 - `getUserLocation(): Promise<UserLocation>` — `navigator.geolocation.getCurrentPosition` with `timeout: LOCATION_TIMEOUT_MS` (5000) and `maximumAge: LOCATION_MAX_AGE_MS` (60000); resolves `{ latitude, longitude }`, rejects with the geolocation error, or with `Error('Location unknown')` when the position carries no coords. The two constants are exported so an app that obtains the position from a platform API instead uses the same numbers.
 
 ```ts
-import { getReadyStatePromise, getUserLocation, hasFinePointer, toggleFullscreen } from '@greendrake/util'
+import { getReadyStatePromise, getUserLocation, hasFinePointer, toggleFullscreen } from '@greendrake/util/browser'
 
 await getReadyStatePromise()
 if (hasFinePointer()) input.focus()

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@greendrake/util",
-    "version": "0.1.0",
+    "version": "0.2.0",
     "description": "Framework-free, Node-safe utilities: typed event emitter, timing, retry, staleness, comparators, fetch helpers, misc",
     "license": "MIT",
     "author": "Eugene Greendrake <eugene@greendrake.nz>",
@@ -20,6 +20,10 @@
         ".": {
             "types": "./src/main.ts",
             "default": "./src/main.ts"
+        },
+        "./browser": {
+            "types": "./src/browser.ts",
+            "default": "./src/browser.ts"
         }
     },
     "files": [
@@ -34,7 +38,7 @@
     },
     "prettier": "@greendrake/dev-config/prettier",
     "devDependencies": {
-        "@greendrake/dev-config": "0.1.0",
+        "@greendrake/dev-config": "0.2.0",
         "typescript": "6.0.3"
     }
 }

package/src/StalenessDetector.ts

@@ -11,7 +11,7 @@ export interface StalenessEvents {
 // drops and 'stale' fires. Events fire only on transitions.
 export class StalenessDetector extends Emitter<StalenessEvents> {
     #ttlMs: number
-    #timeout?: ReturnType<typeof setTimeout>
+    #timeout: ReturnType<typeof setTimeout> | undefined
     #fresh = false
 
     constructor(ttlMs: number) {

package/src/browser.ts

@@ -0,0 +1,6 @@
+// The helpers that name the document, the window or the navigator. An entry of
+// their own rather than part of the main one: a program that type-checks
+// without the DOM lib — a bun service importing @greendrake/rpc — would
+// otherwise have to compile them, and fail to, for helpers it never calls.
+export { getReadyStatePromise, hasFinePointer, toggleFullscreen } from './dom'
+export { getUserLocation, LOCATION_TIMEOUT_MS, LOCATION_MAX_AGE_MS, type UserLocation } from './geo'

package/src/locale.ts

@@ -8,4 +8,4 @@
 // be able to disagree.
 export const RTL_LANGUAGES: readonly string[] = ['ar', 'fa', 'he', 'ur', 'ps', 'sd', 'ug', 'yi']
 
-export const isRTLLocale = (tag: string): boolean => RTL_LANGUAGES.includes(tag.split('-')[0])
+export const isRTLLocale = (tag: string): boolean => RTL_LANGUAGES.includes(tag.replace(/-.*/, ''))

package/src/main.ts

@@ -5,6 +5,4 @@ export { Retrier, RetryStopped, type RetrierOptions, type RetrierEvents } from '
 export { StalenessDetector, type StalenessEvents } from './StalenessDetector'
 export { composeComparators, byProp, byPreset, type Comparator } from './compare'
 export { NetworkError, HttpError, safeFetch, fetchJson } from './net'
-export { getReadyStatePromise, hasFinePointer, toggleFullscreen } from './dom'
-export { getUserLocation, LOCATION_TIMEOUT_MS, LOCATION_MAX_AGE_MS, type UserLocation } from './geo'
 export { RTL_LANGUAGES, isRTLLocale } from './locale'