@timestamp-js/core 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jeff Galbraith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+# Timestamp
+
+Framework-agnostic TypeScript utilities for date-only, time-only, date-time, interval, and range workflows in browsers, Node.js, and modern JavaScript runtimes.
+
+Timestamp focuses on immutable plain objects and small utility functions. It is intentionally independent of any UI framework, backend framework, or application platform.
+
+## Install
+
+```bash
+pnpm add @timestamp-js/core
+```
+
+## Basic Usage
+
+```ts
+import { addToDate, getDateTime, parseTimestamp } from "@timestamp-js/core";
+
+const start = parseTimestamp("2026-06-08T09:30:15.250Z");
+const end = start ? addToDate(start, { day: 2, minute: 45 }) : null;
+
+console.log(end ? getDateTime(end) : "Invalid date");
+```
+
+## Timestamp Values
+
+Timestamp objects are immutable. Parsers and update helpers return frozen objects, and functions that change date/time fields return a new Timestamp instead of mutating the original.
+
+```ts
+const start = parseTimestamp("2026-06-08 09:30")!;
+const next = addToDate(start, { day: 1 });
+
+console.log(start.date); // 2026-06-08
+console.log(next.date); // 2026-06-09
+```
+
+## Supported Input Shape
+
+The parser accepts compact calendar inputs and fuller ISO-style date-time inputs:
+
+- `2026-06-08`
+- `2026-06-08 09:30`
+- `2026-06-08T09:30`
+- `2026-06-08T09:30:15`
+- `2026-06-08T09:30:15.250Z`
+- `2026-06-08T09:30:15.250-07:00`
+
+Seconds, milliseconds, and timezone suffixes are optional. Timezone suffixes are preserved on the Timestamp object, but the parser does not convert the wall-clock values into another zone.
+
+## SSR And Runtime Compatibility
+
+Timestamp is designed for server-rendered and client-rendered applications. The package is ESM, side-effect free, and does not depend on browser globals such as `window`, `document`, `navigator`, or storage APIs.
+
+The library relies on standard JavaScript runtime APIs such as `Date` and `Intl.DateTimeFormat`, so it works in modern Node.js, browser, serverless, and edge-style runtimes that provide those APIs.
+
+For deterministic SSR output, prefer passing explicit timestamps into helpers instead of calling `today()` during render. `today()` intentionally uses the host runtime clock and timezone.
+
+## Current Scope
+
+- Parse date strings and ISO-like date-time strings into Timestamp objects.
+- Convert native `Date` objects into Timestamp objects.
+- Compare dates, times, date-times, and timestamp ranges, including optional second and millisecond precision.
+- Generate day and interval lists for calendar-style views.
+- Format weekday and month names through `Intl.DateTimeFormat`.
+- Keep the public surface small, typed, immutable, and runtime-agnostic while the package stabilizes.
+
+## Future Scope
+
+The package is intentionally not trying to become a full general-purpose date library on day one. Planned evaluations include Temporal support, explicit timezone behavior, alternate calendar systems, duration helpers, Unix timestamp helpers, compact formatting masks, and a script-tag/browser build if CodePen-style demos need it.
+
+## Development
+
+```bash
+pnpm install
+pnpm verify
+```