firetender 0.8.6 → 0.9.0

package/dist/index.d.ts

@@ -2,5 +2,5 @@ import { FiretenderError, FiretenderInternalError, FiretenderIOError, Firetender
 import { FiretenderCollection } from "./FiretenderCollection";
 import type { FiretenderDocOptions } from "./FiretenderDoc";
 import { FiretenderDoc } from "./FiretenderDoc";
-export { FiretenderCollection, FiretenderDoc, FiretenderDocOptions, FiretenderError, FiretenderInternalError, FiretenderIOError, FiretenderUsageError, };
-export * from "./Timestamps";
+import { futureTimestampDays, timestampSchema } from "./timestamps";
+export { FiretenderCollection, FiretenderDoc, FiretenderDocOptions, FiretenderError, FiretenderInternalError, FiretenderIOError, FiretenderUsageError, futureTimestampDays, timestampSchema, };

package/dist/index.js

@@ -1,20 +1,6 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FiretenderUsageError = exports.FiretenderIOError = exports.FiretenderInternalError = exports.FiretenderError = exports.FiretenderDoc = exports.FiretenderCollection = void 0;
+exports.timestampSchema = exports.futureTimestampDays = 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; } });
@@ -24,7 +10,7 @@ const FiretenderCollection_1 = require("./FiretenderCollection");
 Object.defineProperty(exports, "FiretenderCollection", { enumerable: true, get: function () { return FiretenderCollection_1.FiretenderCollection; } });
 const FiretenderDoc_1 = require("./FiretenderDoc");
 Object.defineProperty(exports, "FiretenderDoc", { enumerable: true, get: function () { return FiretenderDoc_1.FiretenderDoc; } });
-// TODO #6, #9, #10: stop using a direct export after the timestamp module gets
-// cleaned up.
-__exportStar(require("./Timestamps"), exports);
+const timestamps_1 = require("./timestamps");
+Object.defineProperty(exports, "futureTimestampDays", { enumerable: true, get: function () { return timestamps_1.futureTimestampDays; } });
+Object.defineProperty(exports, "timestampSchema", { enumerable: true, get: function () { return timestamps_1.timestampSchema; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,qCAKkB;AAShB,gGAbA,wBAAe,OAaA;AACf,wGAbA,gCAAuB,OAaA;AACvB,kGAbA,0BAAiB,OAaA;AACjB,qGAbA,6BAAoB,OAaA;AAXtB,iEAA8D;AAK5D,qGALO,2CAAoB,OAKP;AAHtB,mDAAgD;AAI9C,8FAJO,6BAAa,OAIP;AAQf,+EAA+E;AAC/E,cAAc;AACd,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAKkB;AAUhB,gGAdA,wBAAe,OAcA;AACf,wGAdA,gCAAuB,OAcA;AACvB,kGAdA,0BAAiB,OAcA;AACjB,qGAdA,6BAAoB,OAcA;AAZtB,iEAA8D;AAM5D,qGANO,2CAAoB,OAMP;AAJtB,mDAAgD;AAK9C,8FALO,6BAAa,OAKP;AAJf,6CAAoE;AAUlE,oGAVO,gCAAmB,OAUP;AACnB,gGAX4B,4BAAe,OAW5B"}

package/dist/timestamps.d.ts

@@ -0,0 +1,30 @@
+import { FieldValue, Timestamp } from "firebase/firestore";
+import { z } from "zod";
+/**
+ * Timestamp representation used by Firestore: seconds and nanoseconds since the
+ * epoch.
+ */
+export declare const timestampSchema: z.ZodUnion<[z.ZodEffects<z.ZodObject<{
+    seconds: z.ZodNumber;
+    nanoseconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    seconds: number;
+    nanoseconds: number;
+}, {
+    seconds: number;
+    nanoseconds: number;
+}>, Timestamp, {
+    seconds: number;
+    nanoseconds: number;
+}>, z.ZodType<FieldValue, z.ZodTypeDef, FieldValue>]>;
+/**
+ * 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.
+ *
+ * @param daysFromNow days in the future to set this Timestamp.
+ */
+export declare function futureTimestampDays(daysFromNow: number): Timestamp;

package/dist/timestamps.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.futureTimestampDays = exports.timestampSchema = void 0;
+const firestore_1 = require("firebase/firestore");
+const zod_1 = require("zod");
+/**
+ * Timestamp representation used by Firestore: seconds and nanoseconds since the
+ * epoch.
+ */
+exports.timestampSchema = zod_1.z.union([
+    zod_1.z
+        .object({
+        seconds: zod_1.z.number().positive().int(),
+        nanoseconds: zod_1.z.number().nonnegative().int(),
+    })
+        .transform(({ seconds, nanoseconds }) => new firestore_1.Timestamp(seconds, nanoseconds)),
+    zod_1.z.custom((value) => value._methodName === "serverTimestamp"),
+]);
+/**
+ * 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.
+ *
+ * @param daysFromNow days in the future to set this Timestamp.
+ */
+function futureTimestampDays(daysFromNow) {
+    return firestore_1.Timestamp.fromMillis(Date.now() + daysFromNow * 24 * 60 * 60 * 1000);
+}
+exports.futureTimestampDays = futureTimestampDays;
+//# sourceMappingURL=timestamps.js.map

package/dist/timestamps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timestamps.js","sourceRoot":"","sources":["../src/timestamps.ts"],"names":[],"mappings":";;;AAAA,kDAA2D;AAC3D,6BAAwB;AAExB;;;GAGG;AACU,QAAA,eAAe,GAAG,OAAC,CAAC,KAAK,CAAC;IACrC,OAAC;SACE,MAAM,CAAC;QACN,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE;QACpC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE;KAC5C,CAAC;SACD,SAAS,CACR,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,IAAI,qBAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAClE;IACH,OAAC,CAAC,MAAM,CAAa,CAAC,KAAU,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,KAAK,iBAAiB,CAAC;CAC9E,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,SAAgB,mBAAmB,CAAC,WAAmB;IACrD,OAAO,qBAAS,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AAC9E,CAAC;AAFD,kDAEC"}

package/package.json

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

package/src/index.ts

@@ -7,6 +7,7 @@ import {
 import { FiretenderCollection } from "./FiretenderCollection";
 import type { FiretenderDocOptions } from "./FiretenderDoc";
 import { FiretenderDoc } from "./FiretenderDoc";
+import { futureTimestampDays, timestampSchema } from "./timestamps";
 
 export {
   FiretenderCollection,
@@ -16,8 +17,6 @@ export {
   FiretenderInternalError,
   FiretenderIOError,
   FiretenderUsageError,
+  futureTimestampDays,
+  timestampSchema,
 };
-
-// TODO #6, #9, #10: stop using a direct export after the timestamp module gets
-// cleaned up.
-export * from "./Timestamps";

package/src/timestamps.ts

@@ -0,0 +1,32 @@
+import { FieldValue, Timestamp } from "firebase/firestore";
+import { z } from "zod";
+
+/**
+ * Timestamp representation used by Firestore: seconds and nanoseconds since the
+ * epoch.
+ */
+export const timestampSchema = z.union([
+  z
+    .object({
+      seconds: z.number().positive().int(),
+      nanoseconds: z.number().nonnegative().int(),
+    })
+    .transform(
+      ({ seconds, nanoseconds }) => new Timestamp(seconds, nanoseconds)
+    ),
+  z.custom<FieldValue>((value: any) => value._methodName === "serverTimestamp"),
+]);
+
+/**
+ * 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.
+ *
+ * @param daysFromNow days in the future to set this Timestamp.
+ */
+export function futureTimestampDays(daysFromNow: number) {
+  return Timestamp.fromMillis(Date.now() + daysFromNow * 24 * 60 * 60 * 1000);
+}

package/dist/Timestamps.d.ts

@@ -1,27 +0,0 @@
-import { z } from "zod";
-/**
- * Timestamp representation used by Firestore: seconds and nanoseconds since the
- * epoch.
- */
-export declare const timestampSchema: z.ZodObject<{
-    seconds: z.ZodNumber;
-    nanoseconds: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    seconds: number;
-    nanoseconds: number;
-}, {
-    seconds: number;
-    nanoseconds: number;
-}>;
-export type TimestampData = z.infer<typeof timestampSchema>;
-export declare function dateFromTimestamp(timestamp: TimestampData): Date;
-export declare function makeTTL(daysFromNow?: number): {
-    seconds: number;
-    nanoseconds: number;
-};
-export declare function timestampFromDate(date: Date): TimestampData;
-export declare function timestampFromUnixMillis(msSinceEpoch: number): TimestampData;
-export declare function nowTimestamp(): {
-    seconds: number;
-    nanoseconds: number;
-};

package/dist/Timestamps.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.nowTimestamp = exports.timestampFromUnixMillis = exports.timestampFromDate = exports.makeTTL = exports.dateFromTimestamp = exports.timestampSchema = void 0;
-const zod_1 = require("zod");
-/**
- * Timestamp representation used by Firestore: seconds and nanoseconds since the
- * epoch.
- */
-exports.timestampSchema = zod_1.z.object({
-    seconds: zod_1.z.number().positive().int(),
-    nanoseconds: zod_1.z.number().nonnegative().int(),
-});
-function dateFromTimestamp(timestamp) {
-    return new Date(timestamp.seconds * 1e3 + timestamp.nanoseconds / 1e6);
-}
-exports.dateFromTimestamp = dateFromTimestamp;
-function makeTTL(daysFromNow = 30) {
-    // TODO: #10 is there a way to use the server time rather than Date.now()?
-    return timestampFromUnixMillis(Date.now() + daysFromNow * 24 * 60 * 60 * 1000);
-}
-exports.makeTTL = makeTTL;
-function timestampFromDate(date) {
-    return timestampFromUnixMillis(date.getTime());
-}
-exports.timestampFromDate = timestampFromDate;
-function timestampFromUnixMillis(msSinceEpoch) {
-    return {
-        seconds: Math.floor(msSinceEpoch / 1000),
-        nanoseconds: Math.floor((msSinceEpoch % 1000) * 1000000),
-    };
-}
-exports.timestampFromUnixMillis = timestampFromUnixMillis;
-function nowTimestamp() {
-    // TODO: #9 is there a way to use the server time rather than Date.now()?
-    return timestampFromUnixMillis(Date.now());
-}
-exports.nowTimestamp = nowTimestamp;
-//# sourceMappingURL=Timestamps.js.map

package/dist/Timestamps.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Timestamps.js","sourceRoot":"","sources":["../src/Timestamps.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;;GAGG;AACU,QAAA,eAAe,GAAG,OAAC,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE;IACpC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE;CAC5C,CAAC,CAAC;AAGH,SAAgB,iBAAiB,CAAC,SAAwB;IACxD,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,GAAG,GAAG,SAAS,CAAC,WAAW,GAAG,GAAG,CAAC,CAAC;AACzE,CAAC;AAFD,8CAEC;AAED,SAAgB,OAAO,CAAC,WAAW,GAAG,EAAE;IACtC,0EAA0E;IAC1E,OAAO,uBAAuB,CAC5B,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAC/C,CAAC;AACJ,CAAC;AALD,0BAKC;AAED,SAAgB,iBAAiB,CAAC,IAAU;IAC1C,OAAO,uBAAuB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACjD,CAAC;AAFD,8CAEC;AAED,SAAgB,uBAAuB,CAAC,YAAoB;IAC1D,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QACxC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC;KACzD,CAAC;AACJ,CAAC;AALD,0DAKC;AAED,SAAgB,YAAY;IAC1B,yEAAyE;IACzE,OAAO,uBAAuB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;AAC7C,CAAC;AAHD,oCAGC"}

package/src/Timestamps.ts

@@ -1,38 +0,0 @@
-import { z } from "zod";
-
-/**
- * Timestamp representation used by Firestore: seconds and nanoseconds since the
- * epoch.
- */
-export const timestampSchema = z.object({
-  seconds: z.number().positive().int(),
-  nanoseconds: z.number().nonnegative().int(),
-});
-export type TimestampData = z.infer<typeof timestampSchema>;
-
-export function dateFromTimestamp(timestamp: TimestampData): Date {
-  return new Date(timestamp.seconds * 1e3 + timestamp.nanoseconds / 1e6);
-}
-
-export function makeTTL(daysFromNow = 30) {
-  // TODO: #10 is there a way to use the server time rather than Date.now()?
-  return timestampFromUnixMillis(
-    Date.now() + daysFromNow * 24 * 60 * 60 * 1000
-  );
-}
-
-export function timestampFromDate(date: Date): TimestampData {
-  return timestampFromUnixMillis(date.getTime());
-}
-
-export function timestampFromUnixMillis(msSinceEpoch: number): TimestampData {
-  return {
-    seconds: Math.floor(msSinceEpoch / 1000),
-    nanoseconds: Math.floor((msSinceEpoch % 1000) * 1000000),
-  };
-}
-
-export function nowTimestamp() {
-  // TODO: #9 is there a way to use the server time rather than Date.now()?
-  return timestampFromUnixMillis(Date.now());
-}