@flightlesslabs/time-utils 0.1.0 → 0.2.1

package/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
 
+## 0.2.1
+- Fix JSR errors
+
+## 0.2.0
+- Fix destructure in createDate.ts
+
 ## 0.1.0
 - First release

package/esm/date-creator/createDate/createDate.d.ts

@@ -1,19 +1,11 @@
-declare const createDate: {
-    (): ReturnType<typeof import("dayjs")>;
-    (date: import("../createDateFactory/types.js").CreateDateInput, format?: import("../createDateFactory/types.js").CreateDateFormat, options?: import("../createDateFactory/types.js").CreateDateOptions): ReturnType<typeof import("dayjs")>;
-};
 /**
- * Default preconfigured `createDate` function using a shared Dayjs instance.
- *
- * Provides a ready-to-use API with UTC, timezone, and custom parsing support
- * without requiring users to configure Dayjs manually.
+ * Default preconfigured createDate function.
  *
- * @example
- * ```ts
- * createDate();
- * createDate('2024-01-01');
- * createDate('2024-01-01', undefined, { utc: true });
- * ```
+ * This is a ready-to-use version of `createDate` that uses a shared,
+ * preconfigured Dayjs instance. No manual configuration is required.
  */
-export { createDate };
+export declare const createDate: {
+    (): ReturnType<typeof import("dayjs")>;
+    (date: import("../createDateFactory/types.js").CreateDateInput, format?: import("../createDateFactory/types.js").CreateDateFormat, options?: import("../createDateFactory/types.js").CreateDateOptions): ReturnType<typeof import("dayjs")>;
+};
 //# sourceMappingURL=createDate.d.ts.map

package/esm/date-creator/createDate/createDate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createDate.d.ts","sourceRoot":"","sources":["../../../src/date-creator/createDate/createDate.ts"],"names":[],"mappings":"AAGA,QAAA,MAAQ,UAAU;;;CAAoC,CAAC;AAEvD;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"createDate.d.ts","sourceRoot":"","sources":["../../../src/date-creator/createDate/createDate.ts"],"names":[],"mappings":"AAYA;;;;;GAKG;AACH,eAAO,MAAM,UAAU;;;CAAyB,CAAC"}

package/esm/date-creator/createDate/createDate.js

@@ -1,17 +1,16 @@
 import { createDateFactory } from '../createDateFactory/createDateFactory.js';
 import defaultDayjs from '../createDateFactory/dayjs.js';
-const { createDate } = createDateFactory(defaultDayjs);
 /**
- * Default preconfigured `createDate` function using a shared Dayjs instance.
+ * Preconfigured date factory instance using the default Dayjs setup.
  *
- * Provides a ready-to-use API with UTC, timezone, and custom parsing support
+ * This instance is shared internally to provide a consistent date API
  * without requiring users to configure Dayjs manually.
+ */
+const dateFactory = createDateFactory(defaultDayjs);
+/**
+ * Default preconfigured createDate function.
  *
- * @example
- * ```ts
- * createDate();
- * createDate('2024-01-01');
- * createDate('2024-01-01', undefined, { utc: true });
- * ```
+ * This is a ready-to-use version of `createDate` that uses a shared,
+ * preconfigured Dayjs instance. No manual configuration is required.
  */
-export { createDate };
+export const createDate = dateFactory.createDate;

package/esm/date-creator/createDateFactory/createDateFactory.d.ts

@@ -1,6 +1,28 @@
 import defaultDayjs from './dayjs.js';
 import type { CreateDateFormat, CreateDateInput, CreateDateOptions } from './types.js';
 type Dayjs = typeof defaultDayjs;
+/**
+ * Return type of `createDateFactory`.
+ *
+ * Contains the unified date creation function and the underlying Dayjs instance.
+ */
+export type CreateDateFactoryReturn = {
+    /**
+     * Unified date creation function.
+     *
+     * Overloads:
+     * - `createDate()` → current date/time
+     * - `createDate(input, format?, options?)` → parsed date
+     */
+    createDate: {
+        (): ReturnType<Dayjs>;
+        (date: CreateDateInput, format?: CreateDateFormat, options?: CreateDateOptions): ReturnType<Dayjs>;
+    };
+    /**
+     * Underlying Dayjs instance used by this factory.
+     */
+    dayjs: Dayjs;
+};
 /**
  * Creates a date factory bound to a specific Dayjs instance.
  *
@@ -15,7 +37,7 @@ type Dayjs = typeof defaultDayjs;
  *
  * @param customDayjs - Optional custom Dayjs instance (useful for testing or plugin overrides)
  *
- * @returns An object containing:
+ * @returns A factory object containing:
  * - `createDate`: Unified date creation function
  * - `dayjs`: The underlying Dayjs instance used by the factory
  *
@@ -23,17 +45,12 @@ type Dayjs = typeof defaultDayjs;
  * ```ts
  * const { createDate } = createDateFactory();
  *
+ * const now = createDate();
  * const date = createDate('2024-01-01');
  * const utcDate = createDate('2024-01-01', undefined, { utc: true });
  * const tzDate = createDate('2024-01-01', undefined, { timezone: 'Asia/Kolkata' });
  * ```
  */
-export declare function createDateFactory(customDayjs?: Dayjs): {
-    createDate: {
-        (): ReturnType<Dayjs>;
-        (date: CreateDateInput, format?: CreateDateFormat, options?: CreateDateOptions): ReturnType<Dayjs>;
-    };
-    dayjs: typeof import("dayjs");
-};
+export declare function createDateFactory(customDayjs?: Dayjs): CreateDateFactoryReturn;
 export {};
 //# sourceMappingURL=createDateFactory.d.ts.map

package/esm/date-creator/createDateFactory/createDateFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createDateFactory.d.ts","sourceRoot":"","sources":["../../../src/date-creator/createDateFactory/createDateFactory.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB,KAAK,KAAK,GAAG,OAAO,YAAY,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,CAAC,EAAE,KAAK;;YAG5B,UAAU,CAAC,KAAK,CAAC;eAEhC,eAAe,WACZ,gBAAgB,YACf,iBAAiB,GAC1B,UAAU,CAAC,KAAK,CAAC;;;EA6DrB"}
+{"version":3,"file":"createDateFactory.d.ts","sourceRoot":"","sources":["../../../src/date-creator/createDateFactory/createDateFactory.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB,KAAK,KAAK,GAAG,OAAO,YAAY,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;;;;;OAMG;IACH,UAAU,EAAE;QACV,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;QACtB,CACE,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,gBAAgB,EACzB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,UAAU,CAAC,KAAK,CAAC,CAAC;KACtB,CAAC;IAEF;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,CAAC,EAAE,KAAK,GAClB,uBAAuB,CA4CzB"}

package/esm/date-creator/createDateFactory/createDateFactory.js

@@ -13,7 +13,7 @@ import defaultDayjs from './dayjs.js';
  *
  * @param customDayjs - Optional custom Dayjs instance (useful for testing or plugin overrides)
  *
- * @returns An object containing:
+ * @returns A factory object containing:
  * - `createDate`: Unified date creation function
  * - `dayjs`: The underlying Dayjs instance used by the factory
  *
@@ -21,6 +21,7 @@ import defaultDayjs from './dayjs.js';
  * ```ts
  * const { createDate } = createDateFactory();
  *
+ * const now = createDate();
  * const date = createDate('2024-01-01');
  * const utcDate = createDate('2024-01-01', undefined, { utc: true });
  * const tzDate = createDate('2024-01-01', undefined, { timezone: 'Asia/Kolkata' });
@@ -28,31 +29,6 @@ import defaultDayjs from './dayjs.js';
  */
 export function createDateFactory(customDayjs) {
     const d = customDayjs ?? defaultDayjs;
-    /**
-     * Creates a Dayjs date instance with optional parsing rules.
-     *
-     * Overloads:
-     * - `createDate()` → current date/time
-     * - `createDate(input, format?, options?)` → parsed date
-     *
-     * @param date - Date input (string, number, Date, Dayjs, etc.)
-     * @param format - Optional format string for parsing
-     * @param options - Parsing and behavior options
-     *
-     * @returns A Dayjs instance
-     *
-     * @throws Error if `throwOnInvalid` is true and the date is invalid
-     *
-     * @example
-     * ```ts
-     * createDate(); // now
-     * createDate('2024-01-01');
-     * createDate('01-01-2024', 'DD-MM-YYYY');
-     *
-     * createDate('2024-01-01', undefined, { utc: true });
-     * createDate('2024-01-01', undefined, { timezone: 'UTC' });
-     * ```
-     */
     function createDate(date, format, options = {}) {
         const { timezone, utc, strict = false, throwOnInvalid = false } = options;
         const input = date ?? undefined;

package/esm/mod.d.ts

@@ -1,5 +1,5 @@
 export { timeout } from './timeout/timeout.js';
 export { createDate } from './date-creator/createDate/createDate.js';
-export { createDateFactory } from './date-creator/createDateFactory/createDateFactory.js';
+export { createDateFactory, type CreateDateFactoryReturn, } from './date-creator/createDateFactory/createDateFactory.js';
 export type { CreateDateFormat, CreateDateInput, CreateDateOptions, } from './date-creator/createDateFactory/types.js';
 //# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAErE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uDAAuD,CAAC;AAC1F,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,GAClB,MAAM,2CAA2C,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAErE,OAAO,EACL,iBAAiB,EACjB,KAAK,uBAAuB,GAC7B,MAAM,uDAAuD,CAAC;AAE/D,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,GAClB,MAAM,2CAA2C,CAAC"}

package/esm/mod.js

@@ -1,3 +1,3 @@
 export { timeout } from './timeout/timeout.js';
 export { createDate } from './date-creator/createDate/createDate.js';
-export { createDateFactory } from './date-creator/createDateFactory/createDateFactory.js';
+export { createDateFactory, } from './date-creator/createDateFactory/createDateFactory.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flightlesslabs/time-utils",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Date and time utilities at your disposable",
   "repository": {
     "type": "git",

package/script/date-creator/createDate/createDate.d.ts

@@ -1,19 +1,11 @@
-declare const createDate: {
-    (): ReturnType<typeof import("dayjs")>;
-    (date: import("../createDateFactory/types.js").CreateDateInput, format?: import("../createDateFactory/types.js").CreateDateFormat, options?: import("../createDateFactory/types.js").CreateDateOptions): ReturnType<typeof import("dayjs")>;
-};
 /**
- * Default preconfigured `createDate` function using a shared Dayjs instance.
- *
- * Provides a ready-to-use API with UTC, timezone, and custom parsing support
- * without requiring users to configure Dayjs manually.
+ * Default preconfigured createDate function.
  *
- * @example
- * ```ts
- * createDate();
- * createDate('2024-01-01');
- * createDate('2024-01-01', undefined, { utc: true });
- * ```
+ * This is a ready-to-use version of `createDate` that uses a shared,
+ * preconfigured Dayjs instance. No manual configuration is required.
  */
-export { createDate };
+export declare const createDate: {
+    (): ReturnType<typeof import("dayjs")>;
+    (date: import("../createDateFactory/types.js").CreateDateInput, format?: import("../createDateFactory/types.js").CreateDateFormat, options?: import("../createDateFactory/types.js").CreateDateOptions): ReturnType<typeof import("dayjs")>;
+};
 //# sourceMappingURL=createDate.d.ts.map

package/script/date-creator/createDate/createDate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createDate.d.ts","sourceRoot":"","sources":["../../../src/date-creator/createDate/createDate.ts"],"names":[],"mappings":"AAGA,QAAA,MAAQ,UAAU;;;CAAoC,CAAC;AAEvD;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"createDate.d.ts","sourceRoot":"","sources":["../../../src/date-creator/createDate/createDate.ts"],"names":[],"mappings":"AAYA;;;;;GAKG;AACH,eAAO,MAAM,UAAU;;;CAAyB,CAAC"}

package/script/date-creator/createDate/createDate.js

@@ -6,5 +6,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDate = void 0;
 const createDateFactory_js_1 = require("../createDateFactory/createDateFactory.js");
 const dayjs_js_1 = __importDefault(require("../createDateFactory/dayjs.js"));
-const { createDate } = (0, createDateFactory_js_1.createDateFactory)(dayjs_js_1.default);
-exports.createDate = createDate;
+/**
+ * Preconfigured date factory instance using the default Dayjs setup.
+ *
+ * This instance is shared internally to provide a consistent date API
+ * without requiring users to configure Dayjs manually.
+ */
+const dateFactory = (0, createDateFactory_js_1.createDateFactory)(dayjs_js_1.default);
+/**
+ * Default preconfigured createDate function.
+ *
+ * This is a ready-to-use version of `createDate` that uses a shared,
+ * preconfigured Dayjs instance. No manual configuration is required.
+ */
+exports.createDate = dateFactory.createDate;

package/script/date-creator/createDateFactory/createDateFactory.d.ts

@@ -1,6 +1,28 @@
 import defaultDayjs from './dayjs.js';
 import type { CreateDateFormat, CreateDateInput, CreateDateOptions } from './types.js';
 type Dayjs = typeof defaultDayjs;
+/**
+ * Return type of `createDateFactory`.
+ *
+ * Contains the unified date creation function and the underlying Dayjs instance.
+ */
+export type CreateDateFactoryReturn = {
+    /**
+     * Unified date creation function.
+     *
+     * Overloads:
+     * - `createDate()` → current date/time
+     * - `createDate(input, format?, options?)` → parsed date
+     */
+    createDate: {
+        (): ReturnType<Dayjs>;
+        (date: CreateDateInput, format?: CreateDateFormat, options?: CreateDateOptions): ReturnType<Dayjs>;
+    };
+    /**
+     * Underlying Dayjs instance used by this factory.
+     */
+    dayjs: Dayjs;
+};
 /**
  * Creates a date factory bound to a specific Dayjs instance.
  *
@@ -15,7 +37,7 @@ type Dayjs = typeof defaultDayjs;
  *
  * @param customDayjs - Optional custom Dayjs instance (useful for testing or plugin overrides)
  *
- * @returns An object containing:
+ * @returns A factory object containing:
  * - `createDate`: Unified date creation function
  * - `dayjs`: The underlying Dayjs instance used by the factory
  *
@@ -23,17 +45,12 @@ type Dayjs = typeof defaultDayjs;
  * ```ts
  * const { createDate } = createDateFactory();
  *
+ * const now = createDate();
  * const date = createDate('2024-01-01');
  * const utcDate = createDate('2024-01-01', undefined, { utc: true });
  * const tzDate = createDate('2024-01-01', undefined, { timezone: 'Asia/Kolkata' });
  * ```
  */
-export declare function createDateFactory(customDayjs?: Dayjs): {
-    createDate: {
-        (): ReturnType<Dayjs>;
-        (date: CreateDateInput, format?: CreateDateFormat, options?: CreateDateOptions): ReturnType<Dayjs>;
-    };
-    dayjs: typeof import("dayjs");
-};
+export declare function createDateFactory(customDayjs?: Dayjs): CreateDateFactoryReturn;
 export {};
 //# sourceMappingURL=createDateFactory.d.ts.map

package/script/date-creator/createDateFactory/createDateFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createDateFactory.d.ts","sourceRoot":"","sources":["../../../src/date-creator/createDateFactory/createDateFactory.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB,KAAK,KAAK,GAAG,OAAO,YAAY,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,CAAC,EAAE,KAAK;;YAG5B,UAAU,CAAC,KAAK,CAAC;eAEhC,eAAe,WACZ,gBAAgB,YACf,iBAAiB,GAC1B,UAAU,CAAC,KAAK,CAAC;;;EA6DrB"}
+{"version":3,"file":"createDateFactory.d.ts","sourceRoot":"","sources":["../../../src/date-creator/createDateFactory/createDateFactory.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB,KAAK,KAAK,GAAG,OAAO,YAAY,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;;;;;OAMG;IACH,UAAU,EAAE;QACV,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;QACtB,CACE,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,gBAAgB,EACzB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,UAAU,CAAC,KAAK,CAAC,CAAC;KACtB,CAAC;IAEF;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,CAAC,EAAE,KAAK,GAClB,uBAAuB,CA4CzB"}

package/script/date-creator/createDateFactory/createDateFactory.js

@@ -19,7 +19,7 @@ const dayjs_js_1 = __importDefault(require("./dayjs.js"));
  *
  * @param customDayjs - Optional custom Dayjs instance (useful for testing or plugin overrides)
  *
- * @returns An object containing:
+ * @returns A factory object containing:
  * - `createDate`: Unified date creation function
  * - `dayjs`: The underlying Dayjs instance used by the factory
  *
@@ -27,6 +27,7 @@ const dayjs_js_1 = __importDefault(require("./dayjs.js"));
  * ```ts
  * const { createDate } = createDateFactory();
  *
+ * const now = createDate();
  * const date = createDate('2024-01-01');
  * const utcDate = createDate('2024-01-01', undefined, { utc: true });
  * const tzDate = createDate('2024-01-01', undefined, { timezone: 'Asia/Kolkata' });
@@ -34,31 +35,6 @@ const dayjs_js_1 = __importDefault(require("./dayjs.js"));
  */
 function createDateFactory(customDayjs) {
     const d = customDayjs ?? dayjs_js_1.default;
-    /**
-     * Creates a Dayjs date instance with optional parsing rules.
-     *
-     * Overloads:
-     * - `createDate()` → current date/time
-     * - `createDate(input, format?, options?)` → parsed date
-     *
-     * @param date - Date input (string, number, Date, Dayjs, etc.)
-     * @param format - Optional format string for parsing
-     * @param options - Parsing and behavior options
-     *
-     * @returns A Dayjs instance
-     *
-     * @throws Error if `throwOnInvalid` is true and the date is invalid
-     *
-     * @example
-     * ```ts
-     * createDate(); // now
-     * createDate('2024-01-01');
-     * createDate('01-01-2024', 'DD-MM-YYYY');
-     *
-     * createDate('2024-01-01', undefined, { utc: true });
-     * createDate('2024-01-01', undefined, { timezone: 'UTC' });
-     * ```
-     */
     function createDate(date, format, options = {}) {
         const { timezone, utc, strict = false, throwOnInvalid = false } = options;
         const input = date ?? undefined;

package/script/mod.d.ts

@@ -1,5 +1,5 @@
 export { timeout } from './timeout/timeout.js';
 export { createDate } from './date-creator/createDate/createDate.js';
-export { createDateFactory } from './date-creator/createDateFactory/createDateFactory.js';
+export { createDateFactory, type CreateDateFactoryReturn, } from './date-creator/createDateFactory/createDateFactory.js';
 export type { CreateDateFormat, CreateDateInput, CreateDateOptions, } from './date-creator/createDateFactory/types.js';
 //# sourceMappingURL=mod.d.ts.map

package/script/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAErE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uDAAuD,CAAC;AAC1F,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,GAClB,MAAM,2CAA2C,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAErE,OAAO,EACL,iBAAiB,EACjB,KAAK,uBAAuB,GAC7B,MAAM,uDAAuD,CAAC;AAE/D,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,GAClB,MAAM,2CAA2C,CAAC"}