clockey 0.1.0

package/README.md

@@ -0,0 +1,3 @@
+## Clockey
+
+API-first time utilities for backend developers

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "clockey",
+  "version": "0.1.0",
+  "description": "API-first time utilities for backend developers",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsup"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yasasbanukaofficial/clockey.git"
+  },
+  "keywords": [
+    "clockey",
+    "api",
+    "time",
+    "timestamp",
+    "backend",
+    "server",
+    "clock",
+    "utc",
+    "helper",
+    "response",
+    "clock",
+    "date"
+  ],
+  "author": "Yasas Banu",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/yasasbanukaofficial/clockey/issues"
+  },
+  "homepage": "https://github.com/yasasbanukaofficial/clockey#readme",
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  }
+}

package/src/core/date.ts

@@ -0,0 +1,40 @@
+export function formatCurrentDate() {
+  const currentDate = new Date();
+  const dayAsString = [
+    "Sunday",
+    "Monday",
+    "Tuesday",
+    "Wednesday",
+    "Thursday",
+    "Friday",
+    "Saturday",
+  ];
+
+  const monthAsString = [
+    "January",
+    "February",
+    "March",
+    "April",
+    "May",
+    "June",
+    "July",
+    "August",
+    "September",
+    "October",
+    "November",
+    "December",
+  ];
+
+  const yr = currentDate.getFullYear();
+  const month = monthAsString[currentDate.getMonth()];
+  const day = dayAsString[currentDate.getDay()];
+  const date = currentDate.getDate();
+  const ordinal =
+    date === 1 ? "st" : date === 2 ? "nd" : date === 3 ? "rd" : "th";
+
+  const fullDate = `${month} ${date}${ordinal}, ${day}, ${yr}`;
+
+  return {
+    date: { yr, month, day, date, ordinal, fullDate },
+  };
+}

package/src/core/time.ts

@@ -0,0 +1,28 @@
+export function formatCurrentTime() {
+  const currentTime = new Date();
+
+  let hrs24 = currentTime.getHours();
+  const min = currentTime.getMinutes();
+  const sec = currentTime.getSeconds();
+
+  const period = hrs24 >= 12 ? "PM" : "AM";
+  let hrs12 = hrs24 % 12;
+  if (hrs12 === 0) hrs12 = 12;
+
+  const pad = (n: number) => n.toString().padStart(2, "0");
+
+  const timeAsString24 = `${pad(hrs24)}:${pad(min)}:${pad(sec)}`;
+  const timeAsString12 = `${pad(hrs12)}:${pad(min)}:${pad(sec)} ${period}`;
+
+  return {
+    time: {
+      hrs24,
+      hrs12,
+      min,
+      sec,
+      period,
+      timeAsString24,
+      timeAsString12,
+    },
+  };
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./response/timeResponse";
+export * from "./response/dateResponse";

package/src/response/dateResponse.ts

@@ -0,0 +1,13 @@
+import { formatCurrentDate } from "../core/date";
+import { ClockeyDateResponse } from "../types/date";
+
+export function getCurrentDate() {
+  const { date } = formatCurrentDate();
+  const response: ClockeyDateResponse = {
+    success: true,
+    code: 200,
+    msg: "Current date fetched successfully",
+    data: date,
+  };
+  return response;
+}

package/src/response/timeResponse.ts

@@ -0,0 +1,13 @@
+import { formatCurrentTime } from "../core/time";
+import { ClockeyTimeResponse } from "../types/time";
+
+export function getCurrentTime() {
+  const { time } = formatCurrentTime();
+  const response: ClockeyTimeResponse = {
+    success: true,
+    code: 200,
+    msg: "Current time fetched successfully",
+    data: time,
+  };
+  return response;
+}

package/src/types/date.d.ts

@@ -0,0 +1,15 @@
+export interface DateData {
+  yr: number;
+  month: string;
+  day: string;
+  date: number;
+  ordinal: string;
+  fullDate: string;
+}
+
+export interface ClockeyDateResponse {
+  success: boolean;
+  code: number;
+  msg: string;
+  data: DateData;
+}

package/src/types/time.d.ts

@@ -0,0 +1,16 @@
+export interface TimeData {
+  hrs24: number;
+  hrs12: number;
+  min: number;
+  sec: number;
+  period: "AM" | "PM" | string;
+  timeAsString24: string;
+  timeAsString12: string;
+}
+
+export interface ClockeyTimeResponse {
+  success: boolean;
+  code: number;
+  msg: string;
+  data: TimeData;
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "noImplicitAny": true,
+    "esModuleInterop": true,
+    "strictNullChecks": true,
+    "target": "es2022",
+    "moduleResolution": "Node10",
+    "module": "es2022",
+    "declaration": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "outDir": "dist"
+  },
+  "include": ["src"],
+  "exclude": ["node_modules"]
+}

package/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  format: ["cjs", "esm"],
+  entry: ["./src/index.ts"],
+  dts: true,
+  shims: true,
+  skipNodeModulesBundle: true,
+  clean: true,
+});