firetender 0.11.1 → 0.11.2

package/dist/index.d.ts

@@ -3,5 +3,5 @@ import { Timestamp, where } from "./firestore-deps";
 import { FiretenderCollection } from "./FiretenderCollection";
 import type { FiretenderDocOptions } from "./FiretenderDoc";
 import { FiretenderDoc } from "./FiretenderDoc";
-import { futureTimestampDays, serverTimestamp, serverTimestampWithClientTime, timestampSchema } from "./timestamps";
-export { FiretenderCollection, FiretenderDoc, FiretenderDocOptions, FiretenderError, FiretenderInternalError, FiretenderIOError, FiretenderUsageError, futureTimestampDays, serverTimestamp, serverTimestampWithClientTime, Timestamp, timestampSchema, where, };
+import { futureTimestamp, serverTimestamp, serverTimestampWithClientTime, timestampSchema } from "./timestamps";
+export { FiretenderCollection, FiretenderDoc, FiretenderDocOptions, FiretenderError, FiretenderInternalError, FiretenderIOError, FiretenderUsageError, futureTimestamp, serverTimestamp, serverTimestampWithClientTime, Timestamp, timestampSchema, where, };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.where = exports.timestampSchema = exports.Timestamp = exports.serverTimestampWithClientTime = exports.serverTimestamp = exports.futureTimestampDays = exports.FiretenderUsageError = exports.FiretenderIOError = exports.FiretenderInternalError = exports.FiretenderError = exports.FiretenderDoc = exports.FiretenderCollection = void 0;
+exports.where = exports.timestampSchema = exports.Timestamp = exports.serverTimestampWithClientTime = exports.serverTimestamp = exports.futureTimestamp = exports.FiretenderUsageError = exports.FiretenderIOError = exports.FiretenderInternalError = exports.FiretenderError = exports.FiretenderDoc = exports.FiretenderCollection = void 0;
 const errors_1 = require("./errors");
 Object.defineProperty(exports, "FiretenderError", { enumerable: true, get: function () { return errors_1.FiretenderError; } });
 Object.defineProperty(exports, "FiretenderInternalError", { enumerable: true, get: function () { return errors_1.FiretenderInternalError; } });
@@ -14,7 +14,7 @@ Object.defineProperty(exports, "FiretenderCollection", { enumerable: true, get:
 const FiretenderDoc_1 = require("./FiretenderDoc");
 Object.defineProperty(exports, "FiretenderDoc", { enumerable: true, get: function () { return FiretenderDoc_1.FiretenderDoc; } });
 const timestamps_1 = require("./timestamps");
-Object.defineProperty(exports, "futureTimestampDays", { enumerable: true, get: function () { return timestamps_1.futureTimestampDays; } });
+Object.defineProperty(exports, "futureTimestamp", { enumerable: true, get: function () { return timestamps_1.futureTimestamp; } });
 Object.defineProperty(exports, "serverTimestamp", { enumerable: true, get: function () { return timestamps_1.serverTimestamp; } });
 Object.defineProperty(exports, "serverTimestampWithClientTime", { enumerable: true, get: function () { return timestamps_1.serverTimestampWithClientTime; } });
 Object.defineProperty(exports, "timestampSchema", { enumerable: true, get: function () { return timestamps_1.timestampSchema; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAKkB;AAgBhB,gGApBA,wBAAe,OAoBA;AACf,wGApBA,gCAAuB,OAoBA;AACvB,kGApBA,0BAAiB,OAoBA;AACjB,qGApBA,6BAAoB,OAoBA;AAlBtB,qDAAoD;AAsBlD,0FAtBO,0BAAS,OAsBP;AAET,sFAxBkB,sBAAK,OAwBlB;AAvBP,iEAA8D;AAW5D,qGAXO,2CAAoB,OAWP;AATtB,mDAAgD;AAU9C,8FAVO,6BAAa,OAUP;AATf,6CAKsB;AAUpB,oGAdA,gCAAmB,OAcA;AACnB,gGAdA,4BAAe,OAcA;AACf,8GAdA,0CAA6B,OAcA;AAE7B,gGAfA,4BAAe,OAeA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAKkB;AAgBhB,gGApBA,wBAAe,OAoBA;AACf,wGApBA,gCAAuB,OAoBA;AACvB,kGApBA,0BAAiB,OAoBA;AACjB,qGApBA,6BAAoB,OAoBA;AAlBtB,qDAAoD;AAsBlD,0FAtBO,0BAAS,OAsBP;AAET,sFAxBkB,sBAAK,OAwBlB;AAvBP,iEAA8D;AAW5D,qGAXO,2CAAoB,OAWP;AATtB,mDAAgD;AAU9C,8FAVO,6BAAa,OAUP;AATf,6CAKsB;AAUpB,gGAdA,4BAAe,OAcA;AACf,gGAdA,4BAAe,OAcA;AACf,8GAdA,0CAA6B,OAcA;AAE7B,gGAfA,4BAAe,OAeA"}

package/dist/timestamps.d.ts

@@ -9,13 +9,22 @@ export declare const timestampSchema: z.ZodType<Timestamp, z.ZodTypeDef, Timesta
  * Returns a Firestore Timestamp for some future date.  The result is typically
  * used for writing TTLs.
  *
- * The client's clock (specifically `Date.now()`) is used to generate the
- * timestamp.  For TTLs days in the future, this is generally not a concern.
- * However, this function should not be depended on for short offsets.
+ * The client's clock is used to generate the timestamp.  For TTLs days in the
+ * future, this is generally not a concern.  However, this function should not
+ * be depended on for short offsets.
  *
- * @param daysFromNow days in the future to set this Timestamp.
+ * @param interval how far in the future to set the timestamp.  It can be any
+ *   combination of `days`, `hours`, `minutes`, `seconds`, and `millis`.
+ *
+ * @example const timestamp = futureTimestamp({days: 30});
  */
-export declare function futureTimestampDays(daysFromNow: number): Timestamp;
+export declare function futureTimestamp(interval: {
+    days?: number;
+    hours?: number;
+    minutes?: number;
+    seconds?: number;
+    millis?: number;
+}): Timestamp;
 /**
  * Returns a sentinel to include a server-generated timestamp in the written
  * data.

package/dist/timestamps.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serverTimestampWithClientTime = exports.serverTimestamp = exports.futureTimestampDays = exports.timestampSchema = void 0;
+exports.serverTimestampWithClientTime = exports.serverTimestamp = exports.futureTimestamp = exports.timestampSchema = void 0;
 const zod_1 = require("zod");
 const firestore_deps_1 = require("./firestore-deps");
 /**
@@ -12,16 +12,30 @@ exports.timestampSchema = zod_1.z.custom((data) => data instanceof firestore_dep
  * Returns a Firestore Timestamp for some future date.  The result is typically
  * used for writing TTLs.
  *
- * The client's clock (specifically `Date.now()`) is used to generate the
- * timestamp.  For TTLs days in the future, this is generally not a concern.
- * However, this function should not be depended on for short offsets.
+ * The client's clock is used to generate the timestamp.  For TTLs days in the
+ * future, this is generally not a concern.  However, this function should not
+ * be depended on for short offsets.
  *
- * @param daysFromNow days in the future to set this Timestamp.
+ * @param interval how far in the future to set the timestamp.  It can be any
+ *   combination of `days`, `hours`, `minutes`, `seconds`, and `millis`.
+ *
+ * @example const timestamp = futureTimestamp({days: 30});
  */
-function futureTimestampDays(daysFromNow) {
-    return firestore_deps_1.Timestamp.fromMillis(Date.now() + daysFromNow * 24 * 60 * 60 * 1000);
+function futureTimestamp(interval) {
+    let utcMillis = Date.now();
+    if (interval.days)
+        utcMillis += interval.days * 24 * 60 * 60 * 1000;
+    if (interval.hours)
+        utcMillis += interval.hours * 60 * 60 * 1000;
+    if (interval.minutes)
+        utcMillis += interval.minutes * 60 * 1000;
+    if (interval.seconds)
+        utcMillis += interval.seconds * 1000;
+    if (interval.millis)
+        utcMillis += interval.millis;
+    return firestore_deps_1.Timestamp.fromMillis(utcMillis);
 }
-exports.futureTimestampDays = futureTimestampDays;
+exports.futureTimestamp = futureTimestamp;
 /**
  * Returns a sentinel to include a server-generated timestamp in the written
  * data.

package/dist/timestamps.js.map

@@ -1 +1 @@
-{"version":3,"file":"timestamps.js","sourceRoot":"","sources":["../src/timestamps.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,qDAI0B;AAE1B;;;GAGG;AACU,QAAA,eAAe,GAAG,OAAC,CAAC,MAAM,CACrC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,YAAY,0BAAS,IAAI,IAAA,kCAAiB,EAAC,IAAI,CAAC,CACpE,CAAC;AAEF;;;;;;;;;GASG;AACH,SAAgB,mBAAmB,CAAC,WAAmB;IACrD,OAAO,0BAAS,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AAC9E,CAAC;AAFD,kDAEC;AAED;;;;;;;GAOG;AACH,SAAgB,eAAe;IAC7B,OAAO,IAAA,gCAAwB,GAAe,CAAC;AACjD,CAAC;AAFD,0CAEC;AAED;;;;;;;;GAQG;AACH,SAAgB,6BAA6B;IAC3C,MAAM,QAAQ,GAAG,IAAA,gCAAwB,GAAE,CAAC;IAC5C,MAAM,SAAS,GAAG,0BAAS,CAAC,GAAG,EAAE,CAAC;IAClC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAClC,QAAgB,CAAC,OAAO,GAAG,CAAC,KAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1E,QAAgB,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;IACnD,QAAgB,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;IACvD,QAAgB,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;IACvD,QAAgB,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IACtD,+DAA+D;IAC/D,iFAAiF;IACjF,sEAAsE;IACtE,OAAO,QAAqB,CAAC;AAC/B,CAAC;AAbD,sEAaC"}
+{"version":3,"file":"timestamps.js","sourceRoot":"","sources":["../src/timestamps.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,qDAI0B;AAE1B;;;GAGG;AACU,QAAA,eAAe,GAAG,OAAC,CAAC,MAAM,CACrC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,YAAY,0BAAS,IAAI,IAAA,kCAAiB,EAAC,IAAI,CAAC,CACpE,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAgB,eAAe,CAAC,QAM/B;IACC,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC3B,IAAI,QAAQ,CAAC,IAAI;QAAE,SAAS,IAAI,QAAQ,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACpE,IAAI,QAAQ,CAAC,KAAK;QAAE,SAAS,IAAI,QAAQ,CAAC,KAAK,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACjE,IAAI,QAAQ,CAAC,OAAO;QAAE,SAAS,IAAI,QAAQ,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC;IAChE,IAAI,QAAQ,CAAC,OAAO;QAAE,SAAS,IAAI,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;IAC3D,IAAI,QAAQ,CAAC,MAAM;QAAE,SAAS,IAAI,QAAQ,CAAC,MAAM,CAAC;IAClD,OAAO,0BAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AACzC,CAAC;AAdD,0CAcC;AAED;;;;;;;GAOG;AACH,SAAgB,eAAe;IAC7B,OAAO,IAAA,gCAAwB,GAAe,CAAC;AACjD,CAAC;AAFD,0CAEC;AAED;;;;;;;;GAQG;AACH,SAAgB,6BAA6B;IAC3C,MAAM,QAAQ,GAAG,IAAA,gCAAwB,GAAE,CAAC;IAC5C,MAAM,SAAS,GAAG,0BAAS,CAAC,GAAG,EAAE,CAAC;IAClC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAClC,QAAgB,CAAC,OAAO,GAAG,CAAC,KAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1E,QAAgB,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;IACnD,QAAgB,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;IACvD,QAAgB,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;IACvD,QAAgB,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IACtD,+DAA+D;IAC/D,iFAAiF;IACjF,sEAAsE;IACtE,OAAO,QAAqB,CAAC;AAC/B,CAAC;AAbD,sEAaC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "firetender",
   "displayName": "Firetender",
   "description": "Typescript wrapper for Firestore documents",
-  "version": "0.11.1",
+  "version": "0.11.2",
   "author": "Jake Hartman",
   "license": "MIT",
   "homepage": "https://github.com/jakes-space/firetender",

package/src/index.ts

@@ -9,7 +9,7 @@ import { FiretenderCollection } from "./FiretenderCollection";
 import type { FiretenderDocOptions } from "./FiretenderDoc";
 import { FiretenderDoc } from "./FiretenderDoc";
 import {
-  futureTimestampDays,
+  futureTimestamp,
   serverTimestamp,
   serverTimestampWithClientTime,
   timestampSchema,
@@ -23,7 +23,7 @@ export {
   FiretenderInternalError,
   FiretenderIOError,
   FiretenderUsageError,
-  futureTimestampDays,
+  futureTimestamp,
   serverTimestamp,
   serverTimestampWithClientTime,
   Timestamp,

package/src/timestamps.ts

@@ -18,14 +18,29 @@ export const timestampSchema = z.custom<Timestamp>(
  * Returns a Firestore Timestamp for some future date.  The result is typically
  * used for writing TTLs.
  *
- * The client's clock (specifically `Date.now()`) is used to generate the
- * timestamp.  For TTLs days in the future, this is generally not a concern.
- * However, this function should not be depended on for short offsets.
+ * The client's clock is used to generate the timestamp.  For TTLs days in the
+ * future, this is generally not a concern.  However, this function should not
+ * be depended on for short offsets.
  *
- * @param daysFromNow days in the future to set this Timestamp.
+ * @param interval how far in the future to set the timestamp.  It can be any
+ *   combination of `days`, `hours`, `minutes`, `seconds`, and `millis`.
+ *
+ * @example const timestamp = futureTimestamp({days: 30});
  */
-export function futureTimestampDays(daysFromNow: number) {
-  return Timestamp.fromMillis(Date.now() + daysFromNow * 24 * 60 * 60 * 1000);
+export function futureTimestamp(interval: {
+  days?: number;
+  hours?: number;
+  minutes?: number;
+  seconds?: number;
+  millis?: number;
+}) {
+  let utcMillis = Date.now();
+  if (interval.days) utcMillis += interval.days * 24 * 60 * 60 * 1000;
+  if (interval.hours) utcMillis += interval.hours * 60 * 60 * 1000;
+  if (interval.minutes) utcMillis += interval.minutes * 60 * 1000;
+  if (interval.seconds) utcMillis += interval.seconds * 1000;
+  if (interval.millis) utcMillis += interval.millis;
+  return Timestamp.fromMillis(utcMillis);
 }
 
 /**