@sebspark/promise-cache 3.4.0 → 3.6.0

package/README.md

@@ -173,7 +173,7 @@ The basic functionality of this new implementation is:
 3. You call the cache's wrap function to wrap your original function(s)
 4. You call the wrapped function(s) instead of the originals
 
-** Why the change? **
+**Why the change?**
 
 When trying to add support for caching _to_ a specified time in addition to _for_ a specified time, it tuyrned out to be hard given the original implementation. Changing the implementation proved hard without breaking changes. So a new implementation is is.
 
@@ -276,6 +276,18 @@ const cachedGetById = cache.wrap(myApiCall, {
   key: (id) => `getById:${id}`,
   expires: time.seconds(100),
 })
+
+// Fixed at today 20:00:00 UTC
+const cachedGetById = cache.wrap(myApiCall, {
+  key: (id) => `getById:${id}`,
+  expires: time.today(20),
+})
+
+// Fixed at tomorrow 00:00:00
+const cachedGetById = cache.wrap(myApiCall, {
+  key: (id) => `getById:${id}`,
+  expires: time.tomorrow(),
+})
 ```
 
 If expiry is not set or yields an unusable value, it will default to 1 sec.

package/dist/index.d.mts

@@ -2,7 +2,7 @@ import { RedisClientOptions, createClient, SetOptions } from 'redis';
 export { RedisClientOptions } from 'redis';
 import { Logger } from 'winston';
 import { UUID } from 'node:crypto';
-import { add } from 'date-fns';
+import { add, sub } from 'date-fns';
 
 type GetType<T> = {
     value: T;
@@ -304,6 +304,8 @@ declare const minutes: (num: number) => number;
 declare const hours: (num: number) => number;
 declare const days: (num: number) => number;
 declare const weeks: (num: number) => number;
+declare const today: (hours?: number, minutes?: number, seconds?: number) => Date;
+declare const tomorrow: (hours?: number, minutes?: number, seconds?: number) => Date;
 
 declare const time_DAY: typeof DAY;
 declare const time_HOUR: typeof HOUR;
@@ -315,9 +317,21 @@ declare const time_days: typeof days;
 declare const time_hours: typeof hours;
 declare const time_minutes: typeof minutes;
 declare const time_seconds: typeof seconds;
+declare const time_sub: typeof sub;
+declare const time_today: typeof today;
+declare const time_tomorrow: typeof tomorrow;
 declare const time_weeks: typeof weeks;
 declare namespace time {
-  export { time_DAY as DAY, time_HOUR as HOUR, time_MINUTE as MINUTE, time_SECOND as SECOND, time_WEEK as WEEK, time_add as add, time_days as days, time_hours as hours, time_minutes as minutes, time_seconds as seconds, time_weeks as weeks };
+  export { time_DAY as DAY, time_HOUR as HOUR, time_MINUTE as MINUTE, time_SECOND as SECOND, time_WEEK as WEEK, time_add as add, time_days as days, time_hours as hours, time_minutes as minutes, time_seconds as seconds, time_sub as sub, time_today as today, time_tomorrow as tomorrow, time_weeks as weeks };
 }
 
-export { type Cache, type CachingOptions, type IPersistor, InMemoryPersistor, Persistor, type PersistorConstructorType, PromiseCache, type PromiseCacheOptions, createCache, time };
+declare const serialize: <T>(data: T) => string;
+declare const deserialize: <T>(serialized: string) => T;
+
+declare const serializer_deserialize: typeof deserialize;
+declare const serializer_serialize: typeof serialize;
+declare namespace serializer {
+  export { serializer_deserialize as deserialize, serializer_serialize as serialize };
+}
+
+export { type Cache, type CachingOptions, type IPersistor, InMemoryPersistor, Persistor, type PersistorConstructorType, PromiseCache, type PromiseCacheOptions, createCache, serializer, time };

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { RedisClientOptions, createClient, SetOptions } from 'redis';
 export { RedisClientOptions } from 'redis';
 import { Logger } from 'winston';
 import { UUID } from 'node:crypto';
-import { add } from 'date-fns';
+import { add, sub } from 'date-fns';
 
 type GetType<T> = {
     value: T;
@@ -304,6 +304,8 @@ declare const minutes: (num: number) => number;
 declare const hours: (num: number) => number;
 declare const days: (num: number) => number;
 declare const weeks: (num: number) => number;
+declare const today: (hours?: number, minutes?: number, seconds?: number) => Date;
+declare const tomorrow: (hours?: number, minutes?: number, seconds?: number) => Date;
 
 declare const time_DAY: typeof DAY;
 declare const time_HOUR: typeof HOUR;
@@ -315,9 +317,21 @@ declare const time_days: typeof days;
 declare const time_hours: typeof hours;
 declare const time_minutes: typeof minutes;
 declare const time_seconds: typeof seconds;
+declare const time_sub: typeof sub;
+declare const time_today: typeof today;
+declare const time_tomorrow: typeof tomorrow;
 declare const time_weeks: typeof weeks;
 declare namespace time {
-  export { time_DAY as DAY, time_HOUR as HOUR, time_MINUTE as MINUTE, time_SECOND as SECOND, time_WEEK as WEEK, time_add as add, time_days as days, time_hours as hours, time_minutes as minutes, time_seconds as seconds, time_weeks as weeks };
+  export { time_DAY as DAY, time_HOUR as HOUR, time_MINUTE as MINUTE, time_SECOND as SECOND, time_WEEK as WEEK, time_add as add, time_days as days, time_hours as hours, time_minutes as minutes, time_seconds as seconds, time_sub as sub, time_today as today, time_tomorrow as tomorrow, time_weeks as weeks };
 }
 
-export { type Cache, type CachingOptions, type IPersistor, InMemoryPersistor, Persistor, type PersistorConstructorType, PromiseCache, type PromiseCacheOptions, createCache, time };
+declare const serialize: <T>(data: T) => string;
+declare const deserialize: <T>(serialized: string) => T;
+
+declare const serializer_deserialize: typeof deserialize;
+declare const serializer_serialize: typeof serialize;
+declare namespace serializer {
+  export { serializer_deserialize as deserialize, serializer_serialize as serialize };
+}
+
+export { type Cache, type CachingOptions, type IPersistor, InMemoryPersistor, Persistor, type PersistorConstructorType, PromiseCache, type PromiseCacheOptions, createCache, serializer, time };

package/dist/index.js

@@ -24,6 +24,7 @@ __export(index_exports, {
   Persistor: () => Persistor,
   PromiseCache: () => PromiseCache,
   createCache: () => createCache,
+  serializer: () => serializer_exports,
   time: () => time_exports
 });
 module.exports = __toCommonJS(index_exports);
@@ -356,6 +357,11 @@ var PromiseCache = class {
 };
 
 // src/serializer.ts
+var serializer_exports = {};
+__export(serializer_exports, {
+  deserialize: () => deserialize,
+  serialize: () => serialize
+});
 var fixESM2 = require("fix-esm");
 var superjson2 = fixESM2.require("superjson");
 var serialize = (data) => {
@@ -590,6 +596,9 @@ __export(time_exports, {
   hours: () => hours,
   minutes: () => minutes,
   seconds: () => seconds,
+  sub: () => import_date_fns.sub,
+  today: () => today,
+  tomorrow: () => tomorrow,
   weeks: () => weeks
 });
 var import_date_fns = require("date-fns");
@@ -603,11 +612,25 @@ var minutes = (num) => num * MINUTE;
 var hours = (num) => num * HOUR;
 var days = (num) => num * DAY;
 var weeks = (num) => num * WEEK;
+var today = (hours2 = 0, minutes2 = 0, seconds2 = 0) => {
+  const local = /* @__PURE__ */ new Date();
+  const utc = Date.UTC(
+    local.getUTCFullYear(),
+    local.getUTCMonth(),
+    local.getUTCDate(),
+    hours2,
+    minutes2,
+    seconds2
+  );
+  return new Date(utc);
+};
+var tomorrow = (hours2 = 0, minutes2 = 0, seconds2 = 0) => (0, import_date_fns.add)(today(hours2, minutes2, seconds2), { days: 1 });
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   InMemoryPersistor,
   Persistor,
   PromiseCache,
   createCache,
+  serializer,
   time
 });

package/dist/index.mjs

@@ -338,6 +338,11 @@ var PromiseCache = class {
 };
 
 // src/serializer.ts
+var serializer_exports = {};
+__export(serializer_exports, {
+  deserialize: () => deserialize,
+  serialize: () => serialize
+});
 var fixESM2 = __require("fix-esm");
 var superjson2 = fixESM2.require("superjson");
 var serialize = (data) => {
@@ -572,9 +577,12 @@ __export(time_exports, {
   hours: () => hours,
   minutes: () => minutes,
   seconds: () => seconds,
+  sub: () => sub,
+  today: () => today,
+  tomorrow: () => tomorrow,
   weeks: () => weeks
 });
-import { add } from "date-fns";
+import { add, sub } from "date-fns";
 var SECOND = 1e3;
 var MINUTE = 60 * SECOND;
 var HOUR = 60 * MINUTE;
@@ -585,10 +593,24 @@ var minutes = (num) => num * MINUTE;
 var hours = (num) => num * HOUR;
 var days = (num) => num * DAY;
 var weeks = (num) => num * WEEK;
+var today = (hours2 = 0, minutes2 = 0, seconds2 = 0) => {
+  const local = /* @__PURE__ */ new Date();
+  const utc = Date.UTC(
+    local.getUTCFullYear(),
+    local.getUTCMonth(),
+    local.getUTCDate(),
+    hours2,
+    minutes2,
+    seconds2
+  );
+  return new Date(utc);
+};
+var tomorrow = (hours2 = 0, minutes2 = 0, seconds2 = 0) => add(today(hours2, minutes2, seconds2), { days: 1 });
 export {
   InMemoryPersistor,
   Persistor,
   PromiseCache,
   createCache,
+  serializer_exports as serializer,
   time_exports as time
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/promise-cache",
-  "version": "3.4.0",
+  "version": "3.6.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",