@tsed/json-mapper 8.32.2 → 8.33.0

package/lib/esm/components/TemporalMapper.js

@@ -0,0 +1,34 @@
+import { isBoolean } from "@tsed/core";
+import { JsonMapper } from "../decorators/jsonMapper.js";
+/**
+ * Older runtimes (e.g. Node < 24) don't expose it, so it may be `undefined` at import time.
+ */
+const Temporal = globalThis.Temporal;
+/**
+ * Mapper for the `Temporal.*` types (`Instant`, `ZonedDateTime`, `PlainDate`, `PlainDateTime`,
+ * `PlainTime`, `PlainYearMonth`, `PlainMonthDay`, `Duration`).
+ *
+ * Every Temporal type exposes a static `from(string)` factory and an ISO-8601 `toString()`, so a
+ * single mapper handles all of them: `serialize()` calls `toString()`, and `deserialize()` rebuilds
+ * the concrete type read from `ctx.type` (the deserializer sets it to the registered constructor).
+ *
+ * Registration is guarded by a runtime `Temporal` check so importing `@tsed/json-mapper` stays safe
+ * on runtimes that don't expose the global `Temporal` object.
+ *
+ * @jsonmapper
+ * @component
+ */
+export class TemporalMapper {
+    deserialize(data, ctx) {
+        if (isBoolean(data) || data === null || data === undefined) {
+            return data;
+        }
+        return ctx.type.from(data);
+    }
+    serialize(object) {
+        return object ? object.toString() : object;
+    }
+}
+if (Temporal) {
+    JsonMapper(Temporal.Instant, Temporal.ZonedDateTime, Temporal.PlainDate, Temporal.PlainDateTime, Temporal.PlainTime, Temporal.PlainYearMonth, Temporal.PlainMonthDay, Temporal.Duration)(TemporalMapper);
+}

package/lib/esm/index.js

@@ -4,6 +4,7 @@
 export * from "./components/DateMapper.js";
 export * from "./components/PrimitiveMapper.js";
 export * from "./components/SymbolMapper.js";
+export * from "./components/TemporalMapper.js";
 export * from "./decorators/afterDeserialize.js";
 export * from "./decorators/beforeDeserialize.js";
 export * from "./decorators/jsonMapper.js";

package/lib/types/components/TemporalMapper.d.ts

@@ -0,0 +1,22 @@
+import { JsonMapperCtx, JsonMapperMethods } from "../interfaces/JsonMapperMethods.js";
+/**
+ * Mapper for the `Temporal.*` types (`Instant`, `ZonedDateTime`, `PlainDate`, `PlainDateTime`,
+ * `PlainTime`, `PlainYearMonth`, `PlainMonthDay`, `Duration`).
+ *
+ * Every Temporal type exposes a static `from(string)` factory and an ISO-8601 `toString()`, so a
+ * single mapper handles all of them: `serialize()` calls `toString()`, and `deserialize()` rebuilds
+ * the concrete type read from `ctx.type` (the deserializer sets it to the registered constructor).
+ *
+ * Registration is guarded by a runtime `Temporal` check so importing `@tsed/json-mapper` stays safe
+ * on runtimes that don't expose the global `Temporal` object.
+ *
+ * @jsonmapper
+ * @component
+ */
+export declare class TemporalMapper implements JsonMapperMethods {
+    deserialize(data: string | number, ctx: JsonMapperCtx): unknown;
+    deserialize(data: boolean | null | undefined, ctx: JsonMapperCtx): boolean | null | undefined;
+    serialize(object: {
+        toString(): string;
+    } | null | undefined): any;
+}

package/lib/types/index.d.ts

@@ -4,6 +4,7 @@
 export * from "./components/DateMapper.js";
 export * from "./components/PrimitiveMapper.js";
 export * from "./components/SymbolMapper.js";
+export * from "./components/TemporalMapper.js";
 export * from "./decorators/afterDeserialize.js";
 export * from "./decorators/beforeDeserialize.js";
 export * from "./decorators/jsonMapper.js";

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/json-mapper",
   "description": "Json mapper module for Ts.ED Framework",
   "type": "module",
-  "version": "8.32.2",
+  "version": "8.33.0",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -41,11 +41,12 @@
     "tslib": ">=2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.32.2",
-    "@tsed/core": "8.32.2",
-    "@tsed/schema": "8.32.2",
-    "@tsed/typescript": "8.32.2",
+    "@tsed/barrels": "8.33.0",
+    "@tsed/core": "8.33.0",
+    "@tsed/schema": "8.33.0",
+    "@tsed/typescript": "8.33.0",
     "eslint": "9.12.0",
+    "temporal-polyfill": "1.0.1",
     "typescript": "6.0.2",
     "vitest": "4.1.4"
   },

package/vitest.setup.ts

@@ -0,0 +1,6 @@
+import {Temporal} from "temporal-polyfill";
+
+// Provide the global `Temporal` on runtimes that don't ship it natively yet (e.g. Node < 24),
+// so `TemporalMapper` registers and its spec runs in CI instead of being skipped. Native
+// `Temporal` (Node >= 24/26) takes precedence and the polyfill is a no-op there.
+(globalThis as {Temporal?: unknown}).Temporal ??= Temporal;