@kuroson/sydneydayjs 0.1.0

package/.prettierignore

@@ -0,0 +1,5 @@
+dist
+.turbo
+node_modules
+coverage
+logs

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Alvin Cherk
+
+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,74 @@
+# @kuroson/sydneydayjs
+
+A pre-configured [dayjs](https://day.js.org/) wrapper with Sydney (Australia/Sydney) timezone as the default.
+
+## Installation
+
+```bash
+npm install @kuroson/sydneydayjs
+# or
+pnpm add @kuroson/sydneydayjs
+# or
+yarn add @kuroson/sydneydayjs
+```
+
+## Usage
+
+```typescript
+import { sydneyDayjs } from '@kuroson/sydneydayjs';
+
+// Get current time in Sydney timezone
+const now = sydneyDayjs.now();
+console.log(now.format('YYYY-MM-DD HH:mm:ss')); // e.g., "2024-01-15 14:30:00"
+
+// Create a date in Sydney timezone
+const date = sydneyDayjs.create('2024-06-15');
+console.log(date.format('YYYY-MM-DD HH:mm:ss Z')); // "2024-06-15 00:00:00 +10:00"
+
+// All standard dayjs methods are available
+console.log(now.add(1, 'day').format('dddd')); // e.g., "Tuesday"
+console.log(now.startOf('month').format('YYYY-MM-DD')); // e.g., "2024-01-01"
+```
+
+## API
+
+### `sydneyDayjs.now()`
+
+Returns a dayjs instance representing the current time in Sydney timezone.
+
+```typescript
+const now = sydneyDayjs.now();
+```
+
+### `sydneyDayjs.create(date)`
+
+Creates a dayjs instance from the given date input, interpreted in Sydney timezone.
+
+```typescript
+// From string
+const date1 = sydneyDayjs.create('2024-06-15');
+
+// From Date object
+const date2 = sydneyDayjs.create(new Date());
+
+// From timestamp
+const date3 = sydneyDayjs.create(1718409600000);
+```
+
+## Why?
+
+When working with dates in Australia, you often need to ensure times are correctly handled in the `Australia/Sydney` timezone (AEST/AEDT). This package pre-configures dayjs with:
+
+- The `utc` plugin
+- The `timezone` plugin
+- Default timezone set to `Australia/Sydney`
+
+This means you don't have to remember to configure timezone handling every time - just import and use.
+
+## Requirements
+
+- Node.js >= 22
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,25 @@
+'use strict';
+
+var dayjs = require('dayjs');
+var timezone = require('dayjs/plugin/timezone');
+var utc = require('dayjs/plugin/utc');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var dayjs__default = /*#__PURE__*/_interopDefault(dayjs);
+var timezone__default = /*#__PURE__*/_interopDefault(timezone);
+var utc__default = /*#__PURE__*/_interopDefault(utc);
+
+// src/index.ts
+var TIME_ZONE = "Australia/Sydney";
+dayjs__default.default.extend(utc__default.default);
+dayjs__default.default.extend(timezone__default.default);
+dayjs__default.default.tz.setDefault(TIME_ZONE);
+var sydneyDayjs = {
+  now: () => dayjs__default.default.tz(/* @__PURE__ */ new Date(), TIME_ZONE).tz(TIME_ZONE),
+  create: (date) => dayjs__default.default.tz(date, TIME_ZONE)
+};
+
+exports.sydneyDayjs = sydneyDayjs;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":["dayjs","utc","timezone"],"mappings":";;;;;;;;;;;;;AAIA,IAAM,SAAA,GAAY,kBAAA;AAElBA,sBAAA,CAAM,OAAOC,oBAAG,CAAA;AAChBD,sBAAA,CAAM,OAAOE,yBAAQ,CAAA;AACrBF,sBAAA,CAAM,EAAA,CAAG,WAAW,SAAS,CAAA;AAEtB,IAAM,WAAA,GAAc;AAAA,EACzB,GAAA,EAAK,MAAMA,sBAAA,CAAM,EAAA,iBAAG,IAAI,MAAK,EAAG,SAAS,CAAA,CAAE,EAAA,CAAG,SAAS,CAAA;AAAA,EACvD,QAAQ,CAAC,IAAA,KAAsCA,sBAAA,CAAM,EAAA,CAAG,MAAM,SAAS;AACzE","file":"index.cjs","sourcesContent":["import dayjs from 'dayjs';\nimport timezone from 'dayjs/plugin/timezone';\nimport utc from 'dayjs/plugin/utc';\n\nconst TIME_ZONE = 'Australia/Sydney';\n\ndayjs.extend(utc);\ndayjs.extend(timezone);\ndayjs.tz.setDefault(TIME_ZONE);\n\nexport const sydneyDayjs = {\n  now: () => dayjs.tz(new Date(), TIME_ZONE).tz(TIME_ZONE),\n  create: (date: Parameters<typeof dayjs>[0]) => dayjs.tz(date, TIME_ZONE),\n};\n"]}

package/dist/index.d.cts

@@ -0,0 +1,8 @@
+import dayjs from 'dayjs';
+
+declare const sydneyDayjs: {
+    now: () => dayjs.Dayjs;
+    create: (date: Parameters<typeof dayjs>[0]) => dayjs.Dayjs;
+};
+
+export { sydneyDayjs };

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import dayjs from 'dayjs';
+
+declare const sydneyDayjs: {
+    now: () => dayjs.Dayjs;
+    create: (date: Parameters<typeof dayjs>[0]) => dayjs.Dayjs;
+};
+
+export { sydneyDayjs };

package/dist/index.js

@@ -0,0 +1,17 @@
+import dayjs from 'dayjs';
+import timezone from 'dayjs/plugin/timezone';
+import utc from 'dayjs/plugin/utc';
+
+// src/index.ts
+var TIME_ZONE = "Australia/Sydney";
+dayjs.extend(utc);
+dayjs.extend(timezone);
+dayjs.tz.setDefault(TIME_ZONE);
+var sydneyDayjs = {
+  now: () => dayjs.tz(/* @__PURE__ */ new Date(), TIME_ZONE).tz(TIME_ZONE),
+  create: (date) => dayjs.tz(date, TIME_ZONE)
+};
+
+export { sydneyDayjs };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAIA,IAAM,SAAA,GAAY,kBAAA;AAElB,KAAA,CAAM,OAAO,GAAG,CAAA;AAChB,KAAA,CAAM,OAAO,QAAQ,CAAA;AACrB,KAAA,CAAM,EAAA,CAAG,WAAW,SAAS,CAAA;AAEtB,IAAM,WAAA,GAAc;AAAA,EACzB,GAAA,EAAK,MAAM,KAAA,CAAM,EAAA,iBAAG,IAAI,MAAK,EAAG,SAAS,CAAA,CAAE,EAAA,CAAG,SAAS,CAAA;AAAA,EACvD,QAAQ,CAAC,IAAA,KAAsC,KAAA,CAAM,EAAA,CAAG,MAAM,SAAS;AACzE","file":"index.js","sourcesContent":["import dayjs from 'dayjs';\nimport timezone from 'dayjs/plugin/timezone';\nimport utc from 'dayjs/plugin/utc';\n\nconst TIME_ZONE = 'Australia/Sydney';\n\ndayjs.extend(utc);\ndayjs.extend(timezone);\ndayjs.tz.setDefault(TIME_ZONE);\n\nexport const sydneyDayjs = {\n  now: () => dayjs.tz(new Date(), TIME_ZONE).tz(TIME_ZONE),\n  create: (date: Parameters<typeof dayjs>[0]) => dayjs.tz(date, TIME_ZONE),\n};\n"]}

package/eslint.config.mjs

@@ -0,0 +1,97 @@
+import { fileURLToPath } from 'url';
+import { dirname } from 'path';
+import js from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import unusedImports from 'eslint-plugin-unused-imports';
+import prettier from 'eslint-config-prettier';
+import prettierPlugin from 'eslint-plugin-prettier';
+import { defineConfig } from 'eslint/config';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const config = defineConfig([
+  js.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  ...tseslint.configs.stylisticTypeChecked,
+  prettier,
+  {
+    ignores: [
+      'node_modules',
+      '**/node_modules',
+      '**/.cache',
+      'build',
+      'dist',
+      '.yarn',
+      '.turbo',
+      '**/.turbo',
+      '.out',
+    ],
+  },
+  {
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        project: './tsconfig.json',
+        tsconfigRootDir: __dirname,
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+      },
+    },
+    plugins: {
+      'unused-imports': unusedImports,
+      prettier: prettierPlugin,
+    },
+    rules: {
+      'unused-imports/no-unused-imports': 'warn',
+      'prettier/prettier': 'error',
+      // Allow both type and interface (prefer type)
+      '@typescript-eslint/consistent-type-definitions': 'off',
+      // Allow both Array<T> and T[] syntax
+      '@typescript-eslint/array-type': 'off',
+      // Allow both index signatures and Record types
+      '@typescript-eslint/consistent-indexed-object-style': 'off',
+      // Allow unused variables
+      '@typescript-eslint/no-unused-vars': 'off',
+      // Allow template literal expressions with any type
+      '@typescript-eslint/restrict-template-expressions': 'off',
+      // Allow explicit any types
+      '@typescript-eslint/no-explicit-any': 'off',
+      // Allow unsafe member access on any types
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      // Allow unsafe argument types
+      '@typescript-eslint/no-unsafe-argument': 'off',
+      // Allow promise rejections with non-Error values
+      '@typescript-eslint/prefer-promise-reject-errors': 'off',
+      // Strict boolean expressions
+      '@typescript-eslint/strict-boolean-expressions': 'warn',
+      // Code quality
+      '@typescript-eslint/prefer-nullish-coalescing': 'warn',
+      '@typescript-eslint/prefer-optional-chain': 'warn',
+      'prefer-const': 'error',
+      'no-var': 'error',
+    },
+  },
+  {
+    files: ['*.js', '*.cjs'],
+    languageOptions: {
+      parserOptions: {
+        ecmaVersion: 'latest',
+      },
+    },
+    ...tseslint.configs.disableTypeChecked,
+    rules: {
+      '@typescript-eslint/no-var-requires': 'off',
+    },
+  },
+  {
+    files: ['*.config.ts', '*.config.mjs'],
+    languageOptions: {
+      parserOptions: {
+        project: null,
+      },
+    },
+    ...tseslint.configs.disableTypeChecked,
+  },
+]);
+
+export default config;

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@kuroson/sydneydayjs",
+  "version": "0.1.0",
+  "description": "A pre-configured dayjs wrapper with Sydney (Australia/Sydney) timezone as the default",
+  "author": "Alvin Cherk <a.cherk@unsw.edu.au>",
+  "license": "MIT",
+  "type": "module",
+  "main": "./src/index.ts",
+  "module": "./src/index.ts",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "build": "tsup",
+    "build:all": "tsup",
+    "lint": "eslint './**/*.{ts,js}'",
+    "lint:fix": "eslint './**/*.{ts,js}' --fix",
+    "prepublishOnly": "pnpm run build",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "dayjs": "^1.11.10"
+  },
+  "devDependencies": {
+    "@eslint/js": "catalog:",
+    "@types/jest": "catalog:",
+    "@types/node": "catalog:",
+    "@typescript-eslint/eslint-plugin": "catalog:",
+    "@typescript-eslint/parser": "catalog:",
+    "eslint": "catalog:",
+    "eslint-config-prettier": "catalog:",
+    "eslint-plugin-prettier": "catalog:",
+    "eslint-plugin-unused-imports": "catalog:",
+    "prettier": "catalog:",
+    "tslib": "catalog:",
+    "tsup": "catalog:",
+    "typescript": "catalog:",
+    "typescript-eslint": "catalog:"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.7.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "./dist/index.cjs",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+      ".": {
+        "import": {
+          "types": "./dist/index.d.ts",
+          "default": "./dist/index.js"
+        },
+        "require": {
+          "types": "./dist/index.d.cts",
+          "default": "./dist/index.cjs"
+        }
+      },
+      "./package.json": "./package.json"
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,14 @@
+import dayjs from 'dayjs';
+import timezone from 'dayjs/plugin/timezone';
+import utc from 'dayjs/plugin/utc';
+
+const TIME_ZONE = 'Australia/Sydney';
+
+dayjs.extend(utc);
+dayjs.extend(timezone);
+dayjs.tz.setDefault(TIME_ZONE);
+
+export const sydneyDayjs = {
+  now: () => dayjs.tz(new Date(), TIME_ZONE).tz(TIME_ZONE),
+  create: (date: Parameters<typeof dayjs>[0]) => dayjs.tz(date, TIME_ZONE),
+};

package/tsconfig.build.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "baseUrl": "./src",
+    "target": "ESNext",
+    "verbatimModuleSyntax": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "declarationDir": "./dist",
+    "noEmit": false,
+    "incremental": true,
+    "tsBuildInfoFile": "./tsconfig.build.tsbuildinfo"
+  },
+  "exclude": ["dist", "**/__tests__/*", "node_modules"]
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "target": "ESNext",
+    "lib": ["ESNext"],
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": "./src",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "noEmit": true,
+    "incremental": true,
+    "resolveJsonModule": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "declarationMap": true
+  },
+  "exclude": ["**/node_modules", "**/.*/*", "dist", "tsup.config.ts"],
+  "include": ["src/**/*.ts"]
+}

package/tsup.config.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig(() => ({
+  entry: ['src/index.ts'],
+  format: ['esm', 'cjs'],
+  splitting: false,
+  clean: true,
+  dts: true,
+  platform: 'node',
+  target: 'node22',
+  tsconfig: new URL('tsconfig.build.json', import.meta.url).pathname,
+  sourcemap: true,
+  minify: false,
+  treeshake: true,
+  outDir: 'dist',
+}));