@choksheak/ts-utils 0.1.7 → 0.1.9

package/src/localStorageCache.ts

@@ -1,18 +1,63 @@
+import { Duration, durationToMs } from "./duration";
+
 /**
  * Simple local storage cache with support for auto-expiration.
  * Note that this works in the browser context only because nodejs does not
  * have local storage.
+ *
+ * Create a cache item accessor object with auto-expiration. The value will
+ * always be stored as a string by applying JSON.stringify(), and will be
+ * returned in the same object type by applying JSON.parse().
+ *
+ * In order to provide proper type-checking, please always specify the T
+ * type parameter. E.g. const item = storeItem<string>("name", 10_000);
+ *
+ * expires - Either a number in milliseconds, or a Duration object
  */
-export class LocalStorageCache {
-  public static setValue<T>(key: string, value: T, expireDeltaMs: number) {
-    const expireMs = Date.now() + expireDeltaMs;
+export function storeItem<T>(
+  key: string,
+  expires: number | Duration,
+  logError = true,
+  defaultValue?: T,
+) {
+  const expireDeltaMs =
+    typeof expires === "number" ? expires : durationToMs(expires);
+
+  return new CacheItem<T>(key, expireDeltaMs, logError, defaultValue);
+}
+
+class CacheItem<T> {
+  /**
+   * Create a cache item accessor object with auto-expiration.
+   */
+  public constructor(
+    public readonly key: string,
+    public readonly expireDeltaMs: number,
+    public readonly logError: boolean,
+    defaultValue: T | undefined,
+  ) {
+    if (defaultValue !== undefined) {
+      if (this.get() === undefined) {
+        this.set(defaultValue);
+      }
+    }
+  }
+
+  /**
+   * Set the value of this item with auto-expiration.
+   */
+  public set(value: T): void {
+    const expireMs = Date.now() + this.expireDeltaMs;
     const valueStr = JSON.stringify({ value, expireMs });
 
-    globalThis.localStorage.setItem(key, valueStr);
+    globalThis.localStorage.setItem(this.key, valueStr);
   }
 
-  public static getValue<T>(key: string, logError = true): T | undefined {
-    const jsonStr = globalThis.localStorage.getItem(key);
+  /**
+   * Get the value of this item, or undefined if value is not set or expired.
+   */
+  public get(): T | undefined {
+    const jsonStr = globalThis.localStorage.getItem(this.key);
 
     if (!jsonStr || typeof jsonStr !== "string") {
       return undefined;
@@ -29,41 +74,27 @@ export class LocalStorageCache {
         typeof obj.expireMs !== "number" ||
         Date.now() >= obj.expireMs
       ) {
-        globalThis.localStorage.removeItem(key);
+        globalThis.localStorage.removeItem(this.key);
         return undefined;
       }
 
       return obj.value;
     } catch (e) {
-      if (logError) {
-        console.error(`Found invalid storage value: ${key}=${jsonStr}:`, e);
+      if (this.logError) {
+        console.error(
+          `Found invalid storage value: ${this.key}=${jsonStr}:`,
+          e,
+        );
       }
-      globalThis.localStorage.removeItem(key);
+      globalThis.localStorage.removeItem(this.key);
       return undefined;
     }
   }
-}
 
-/** Same as above, but saves some config for reuse. */
-export class LocalStorageCacheItem<T> {
-  public constructor(
-    public readonly key: string,
-    public readonly expireDeltaMs: number,
-    public readonly logError = true,
-    defaultValue?: T,
-  ) {
-    if (defaultValue !== undefined) {
-      if (this.get() === undefined) {
-        this.set(defaultValue);
-      }
-    }
-  }
-
-  public set(value: T) {
-    LocalStorageCache.setValue(this.key, value, this.expireDeltaMs);
-  }
-
-  public get(): T | undefined {
-    return LocalStorageCache.getValue(this.key, this.logError);
+  /**
+   * Remove the value of this item.
+   */
+  public remove(): void {
+    globalThis.localStorage.removeItem(this.key);
   }
 }

package/src/safeBtoa.ts

@@ -0,0 +1,15 @@
+/**
+ * Base 64 encode the given input string, but safely.
+ */
+export function safeBtoa(input: string): string {
+  // Convert the string to a UTF-8 encoded binary-safe string
+  const utf8Bytes = new TextEncoder().encode(input);
+
+  // Convert the binary data to a string for btoa
+  const binaryString = Array.from(utf8Bytes)
+    .map((byte) => String.fromCodePoint(byte))
+    .join("");
+
+  // Use btoa to encode the binary-safe string
+  return btoa(binaryString);
+}

package/src/sha256.ts

@@ -0,0 +1,13 @@
+/**
+ * SHA-256 hash an input string into an ArrayBuffer.
+ */
+export async function sha256(input: string): Promise<ArrayBuffer> {
+  // Encode the input string as a Uint8Array
+  const encoder = new TextEncoder();
+  const uint8Array = encoder.encode(input);
+
+  // Compute the SHA-256 hash using the SubtleCrypto API
+  const arrayBuffer = await crypto.subtle.digest("SHA-256", uint8Array);
+
+  return arrayBuffer;
+}

package/src/timeConstants.ts

@@ -0,0 +1,22 @@
+/**
+ * Note that month and year do not have fixed durations, and hence are excluded
+ * from this file.
+ */
+
+export const MS_PER_SECOND = 1000;
+export const MS_PER_MINUTE = 60_000;
+export const MS_PER_HOUR = 3_600_000;
+export const MS_PER_DAY = 86_400_000;
+export const MS_PER_WEEK = 604_800_000;
+
+export const SECONDS_PER_MINUTE = 60;
+export const SECONDS_PER_HOUR = 3_600;
+export const SECONDS_PER_DAY = 86_400;
+export const SECONDS_PER_WEEK = 604_800;
+
+export const MINUTES_PER_HOUR = 60;
+export const MINUTES_PER_DAY = 1440;
+export const MINUTES_PER_WEEK = 10_080;
+
+export const HOURS_PER_DAY = 24;
+export const HOURS_PER_WEEK = 168;

package/timeConstants.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Note that month and year do not have fixed durations, and hence are excluded
+ * from this file.
+ */
+export declare const MS_PER_SECOND = 1000;
+export declare const MS_PER_MINUTE = 60000;
+export declare const MS_PER_HOUR = 3600000;
+export declare const MS_PER_DAY = 86400000;
+export declare const MS_PER_WEEK = 604800000;
+export declare const SECONDS_PER_MINUTE = 60;
+export declare const SECONDS_PER_HOUR = 3600;
+export declare const SECONDS_PER_DAY = 86400;
+export declare const SECONDS_PER_WEEK = 604800;
+export declare const MINUTES_PER_HOUR = 60;
+export declare const MINUTES_PER_DAY = 1440;
+export declare const MINUTES_PER_WEEK = 10080;
+export declare const HOURS_PER_DAY = 24;
+export declare const HOURS_PER_WEEK = 168;

package/timeConstants.js

@@ -0,0 +1,70 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/timeConstants.ts
+var timeConstants_exports = {};
+__export(timeConstants_exports, {
+  HOURS_PER_DAY: () => HOURS_PER_DAY,
+  HOURS_PER_WEEK: () => HOURS_PER_WEEK,
+  MINUTES_PER_DAY: () => MINUTES_PER_DAY,
+  MINUTES_PER_HOUR: () => MINUTES_PER_HOUR,
+  MINUTES_PER_WEEK: () => MINUTES_PER_WEEK,
+  MS_PER_DAY: () => MS_PER_DAY,
+  MS_PER_HOUR: () => MS_PER_HOUR,
+  MS_PER_MINUTE: () => MS_PER_MINUTE,
+  MS_PER_SECOND: () => MS_PER_SECOND,
+  MS_PER_WEEK: () => MS_PER_WEEK,
+  SECONDS_PER_DAY: () => SECONDS_PER_DAY,
+  SECONDS_PER_HOUR: () => SECONDS_PER_HOUR,
+  SECONDS_PER_MINUTE: () => SECONDS_PER_MINUTE,
+  SECONDS_PER_WEEK: () => SECONDS_PER_WEEK
+});
+module.exports = __toCommonJS(timeConstants_exports);
+var MS_PER_SECOND = 1e3;
+var MS_PER_MINUTE = 6e4;
+var MS_PER_HOUR = 36e5;
+var MS_PER_DAY = 864e5;
+var MS_PER_WEEK = 6048e5;
+var SECONDS_PER_MINUTE = 60;
+var SECONDS_PER_HOUR = 3600;
+var SECONDS_PER_DAY = 86400;
+var SECONDS_PER_WEEK = 604800;
+var MINUTES_PER_HOUR = 60;
+var MINUTES_PER_DAY = 1440;
+var MINUTES_PER_WEEK = 10080;
+var HOURS_PER_DAY = 24;
+var HOURS_PER_WEEK = 168;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  HOURS_PER_DAY,
+  HOURS_PER_WEEK,
+  MINUTES_PER_DAY,
+  MINUTES_PER_HOUR,
+  MINUTES_PER_WEEK,
+  MS_PER_DAY,
+  MS_PER_HOUR,
+  MS_PER_MINUTE,
+  MS_PER_SECOND,
+  MS_PER_WEEK,
+  SECONDS_PER_DAY,
+  SECONDS_PER_HOUR,
+  SECONDS_PER_MINUTE,
+  SECONDS_PER_WEEK
+});
+//# sourceMappingURL=timeConstants.js.map

package/timeConstants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/timeConstants.ts"],"sourcesContent":["/**\n * Note that month and year do not have fixed durations, and hence are excluded\n * from this file.\n */\n\nexport const MS_PER_SECOND = 1000;\nexport const MS_PER_MINUTE = 60_000;\nexport const MS_PER_HOUR = 3_600_000;\nexport const MS_PER_DAY = 86_400_000;\nexport const MS_PER_WEEK = 604_800_000;\n\nexport const SECONDS_PER_MINUTE = 60;\nexport const SECONDS_PER_HOUR = 3_600;\nexport const SECONDS_PER_DAY = 86_400;\nexport const SECONDS_PER_WEEK = 604_800;\n\nexport const MINUTES_PER_HOUR = 60;\nexport const MINUTES_PER_DAY = 1440;\nexport const MINUTES_PER_WEEK = 10_080;\n\nexport const HOURS_PER_DAY = 24;\nexport const HOURS_PER_WEEK = 168;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAKO,IAAM,gBAAgB;AACtB,IAAM,gBAAgB;AACtB,IAAM,cAAc;AACpB,IAAM,aAAa;AACnB,IAAM,cAAc;AAEpB,IAAM,qBAAqB;AAC3B,IAAM,mBAAmB;AACzB,IAAM,kBAAkB;AACxB,IAAM,mBAAmB;AAEzB,IAAM,mBAAmB;AACzB,IAAM,kBAAkB;AACxB,IAAM,mBAAmB;AAEzB,IAAM,gBAAgB;AACtB,IAAM,iBAAiB;","names":[]}