calendaryjs 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,11 +1,11 @@
1
1
  # calendaryjs
2
2
 
3
- A lightweight, plugin-based calendar system for managing events in TypeScript. Inspired by [Day.js](https://github.com/iamkun/dayjs).
3
+ A lightweight, plugin-based calendar system for managing events in TypeScript.
4
4
 
5
5
  ## Features
6
6
 
7
7
  - **ðŸŠķ Lightweight** - ~5KB core, tree-shakeable
8
- - **🔌 Plugin System** - Day.js-style `extend()` API
8
+ - **🔌 Plugin System** - chainable `extend()` API
9
9
  - **📅 Many Event Types** - const, fixed, monthly, weekly, nth-weekday, formula, relative (+ plugin types)
10
10
  - **🔍 Fluent Query API** - Chain methods for filtering
11
11
  - **ðŸ’ū Caching** - Memoized event generation
@@ -77,7 +77,7 @@ cal.load(jsonString);
77
77
 
78
78
  ### Class-based API
79
79
 
80
- > `Calendary` is an alias of the canonical `CalendaryInstance` class, kept for Day.js-style familiarity.
80
+ > `Calendary` is an alias of the canonical `CalendaryInstance` class, kept for backward compatibility.
81
81
 
82
82
  ```typescript
83
83
  import { Calendary } from "calendaryjs";
@@ -176,11 +176,11 @@ Every event shares `BaseEventProperties` (below) plus its type-specific date fie
176
176
 
177
177
  ## Plugins
178
178
 
179
- | Package | Description |
180
- | --------------------------------------------------------------------------------------------------------- | ---------------------- |
181
- | [calendaryjs-plugin-lunar](https://github.com/calendaryjs/calendaryjs/tree/main/packages/lunar) | Lunar calendar events |
182
- | [calendaryjs-plugin-liturgical](https://github.com/calendaryjs/calendaryjs/tree/main/packages/liturgical) | Easter & offset events |
183
- | [calendaryjs-plugin-hijri](https://github.com/calendaryjs/calendaryjs/tree/main/packages/hijri) | Islamic (Hijri) events |
179
+ | Package | Description |
180
+ | -------------------------------------------------------------------------------------------- | ---------------------- |
181
+ | [calendaryjs-plugin-lunar](https://www.npmjs.com/package/calendaryjs-plugin-lunar) | Lunar calendar events |
182
+ | [calendaryjs-plugin-liturgical](https://www.npmjs.com/package/calendaryjs-plugin-liturgical) | Easter & offset events |
183
+ | [calendaryjs-plugin-hijri](https://www.npmjs.com/package/calendaryjs-plugin-hijri) | Islamic (Hijri) events |
184
184
 
185
185
  ## License
186
186
 
package/dist/index.cjs CHANGED
@@ -1015,7 +1015,7 @@ var CalendaryInstance = class _CalendaryInstance {
1015
1015
  return cloned;
1016
1016
  }
1017
1017
  /**
1018
- * Register a plugin (Day.js style: use/extend)
1018
+ * Register a plugin (use/extend)
1019
1019
  */
1020
1020
  use(plugin) {
1021
1021
  for (const dep of plugin.dependencies || []) {
package/dist/index.d.cts CHANGED
@@ -1085,7 +1085,7 @@ declare class CalendaryInstance<TMetadata extends Record<string, unknown> = Reco
1085
1085
  */
1086
1086
  clone(): CalendaryInstance<TMetadata, TCategory>;
1087
1087
  /**
1088
- * Register a plugin (Day.js style: use/extend)
1088
+ * Register a plugin (use/extend)
1089
1089
  */
1090
1090
  use(plugin: CalendaryPlugin): this;
1091
1091
  hasPlugin(name: string): boolean;
@@ -1162,7 +1162,7 @@ interface CalendaryFn {
1162
1162
  isCalendary: typeof isCalendary;
1163
1163
  }
1164
1164
  /**
1165
- * Factory function (Day.js style) with generics support
1165
+ * Factory function with generics support
1166
1166
  *
1167
1167
  * @template TMetadata - Custom metadata type for events
1168
1168
  * @template TCategory - Category type for events
package/dist/index.d.ts CHANGED
@@ -1085,7 +1085,7 @@ declare class CalendaryInstance<TMetadata extends Record<string, unknown> = Reco
1085
1085
  */
1086
1086
  clone(): CalendaryInstance<TMetadata, TCategory>;
1087
1087
  /**
1088
- * Register a plugin (Day.js style: use/extend)
1088
+ * Register a plugin (use/extend)
1089
1089
  */
1090
1090
  use(plugin: CalendaryPlugin): this;
1091
1091
  hasPlugin(name: string): boolean;
@@ -1162,7 +1162,7 @@ interface CalendaryFn {
1162
1162
  isCalendary: typeof isCalendary;
1163
1163
  }
1164
1164
  /**
1165
- * Factory function (Day.js style) with generics support
1165
+ * Factory function with generics support
1166
1166
  *
1167
1167
  * @template TMetadata - Custom metadata type for events
1168
1168
  * @template TCategory - Category type for events
package/dist/index.js CHANGED
@@ -1013,7 +1013,7 @@ var CalendaryInstance = class _CalendaryInstance {
1013
1013
  return cloned;
1014
1014
  }
1015
1015
  /**
1016
- * Register a plugin (Day.js style: use/extend)
1016
+ * Register a plugin (use/extend)
1017
1017
  */
1018
1018
  use(plugin) {
1019
1019
  for (const dep of plugin.dependencies || []) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "calendaryjs",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "Composable calendar & recurrence engine with pluggable calendar systems.",
5
5
  "type": "module",
6
6
  "sideEffects": false,
@@ -59,12 +59,12 @@
59
59
  },
60
60
  "repository": {
61
61
  "type": "git",
62
- "url": "git+https://github.com/calendaryjs/calendaryjs.git",
62
+ "url": "git+https://github.com/vbilltran68/calendaryjs.git",
63
63
  "directory": "packages/calendaryjs"
64
64
  },
65
- "homepage": "https://github.com/calendaryjs/calendaryjs/tree/main/packages/calendaryjs#readme",
65
+ "homepage": "https://www.npmjs.com/package/calendaryjs",
66
66
  "bugs": {
67
- "url": "https://github.com/calendaryjs/calendaryjs/issues"
67
+ "url": "https://github.com/vbilltran68/calendaryjs/issues"
68
68
  },
69
69
  "scripts": {
70
70
  "typecheck": "tsc --noEmit",