calendaryjs-plugin-liturgical 0.1.0 → 0.1.2

package/README.md

@@ -1,200 +1,81 @@
-# calendaryjs-plugin-liturgical
+<p align="center">
+  <img src="https://cdn.jsdelivr.net/npm/calendaryjs/assets/logo.svg" alt="calendaryjs" width="380" />
+</p>
 
-Liturgical calendar plugin for [Calendary](https://github.com/calendaryjs/calendaryjs). Adds support for Easter calculation and offset-based events.
+# calendaryjs-plugin-liturgical
 
-## Features
+> **New to calendaryjs?** Start with the [core README](https://www.npmjs.com/package/calendaryjs) — this plugin builds on its engine.
 
-- **✝️ Easter Calculation** - Computus algorithm for accurate Easter dates
-- **📅 Offset Events** - Events relative to Easter or other base events
-- **⛪ Church Calendar** - Full liturgical year support
-- **🔧 Flexible** - Works with any Christian denomination
+Adds the **Roman Catholic liturgical calendar** to calendaryjs: Easter (via the Computus
+algorithm) plus the movable feasts declared as offsets from it, so the whole cycle
+follows automatically each year.
 
-## Installation
+## Install
 
 ```bash
-pnpm add calendaryjs calendaryjs-plugin-liturgical
+npm i calendaryjs calendaryjs-plugin-liturgical
 ```
 
-## Requirements
+## Use it
 
-- `calendaryjs` >= 0.1.0
+Register the plugin, then declare `easter` and `offset` events — an `offset` is placed
+relative to Easter (negative = before, positive = after):
 
-## Quick Start
-
-```typescript
+```ts
 import { calendary } from "calendaryjs";
 import { liturgical } from "calendaryjs-plugin-liturgical";
 
-const cal = calendary();
-cal.use(liturgical());
+const cal = calendary().use(liturgical());
 
 cal.addGroup({
   id: "church",
-  name: "Church Calendar",
   events: [
     { type: "easter", id: "easter", title: "Easter Sunday" },
-    { type: "offset", id: "ash-wed", baseEvent: "easter", offsetDays: -46, title: "Ash Wednesday" },
     {
       type: "offset",
-      id: "palm-sunday",
+      id: "ash-wednesday",
       baseEvent: "easter",
-      offsetDays: -7,
-      title: "Palm Sunday",
+      offsetDays: -46,
+      title: "Ash Wednesday",
     },
     {
       type: "offset",
-      id: "good-friday",
+      id: "palm-sunday",
       baseEvent: "easter",
-      offsetDays: -2,
-      title: "Good Friday",
+      offsetDays: -7,
+      title: "Palm Sunday",
     },
     { type: "offset", id: "pentecost", baseEvent: "easter", offsetDays: 49, title: "Pentecost" },
   ],
 });
 
-const events = cal.getEventsInRange("2025-01-01", "2025-12-31");
-```
-
-## Event Types
-
-### `easter`
-
-Easter Sunday, calculated using the Computus algorithm.
-
-```typescript
-{
-  type: 'easter';
-  id: string;
-  title?: string;
-  // ... other standard event properties
-}
+cal.getEventsInRange("2025-01-01", "2025-12-31");
 ```
 
-### `offset`
+Common feasts ship as ready-made presets:
 
-Events offset from a base event (typically Easter).
+```ts
+import { EASTER, ASH_WEDNESDAY, PALM_SUNDAY, PENTECOST } from "calendaryjs-plugin-liturgical";
 
-```typescript
-{
-  type: 'offset';
-  id: string;
-  baseEvent: string;    // ID of the base event
-  offsetDays: number;   // Days offset (negative = before, positive = after)
-  title?: string;
-  // ... other standard event properties
-}
+cal.addGroup({ id: "church", events: [EASTER, ASH_WEDNESDAY, PALM_SUNDAY, PENTECOST] });
 ```
 
-## Common Liturgical Offsets
-
-| Event          | Offset from Easter |
-| -------------- | ------------------ |
-| Ash Wednesday  | -46                |
-| Palm Sunday    | -7                 |
-| Holy Thursday  | -3                 |
-| Good Friday    | -2                 |
-| Holy Saturday  | -1                 |
-| Easter Monday  | +1                 |
-| Ascension      | +39                |
-| Pentecost      | +49                |
-| Trinity Sunday | +56                |
-| Corpus Christi | +60                |
-
-## Example: Full Liturgical Year
-
-```typescript
-import { calendary } from "calendaryjs";
-import { liturgical } from "calendaryjs-plugin-liturgical";
-
-const cal = calendary();
-cal.use(liturgical());
-
-cal.addGroup({
-  id: "liturgical",
-  name: "Liturgical Calendar",
-  events: [
-    // Easter
-    { type: "easter", id: "easter", title: "Easter Sunday" },
-
-    // Lent
-    { type: "offset", id: "ash-wed", baseEvent: "easter", offsetDays: -46, title: "Ash Wednesday" },
-
-    // Holy Week
-    {
-      type: "offset",
-      id: "palm-sunday",
-      baseEvent: "easter",
-      offsetDays: -7,
-      title: "Palm Sunday",
-    },
-    {
-      type: "offset",
-      id: "holy-thursday",
-      baseEvent: "easter",
-      offsetDays: -3,
-      title: "Holy Thursday",
-    },
-    {
-      type: "offset",
-      id: "good-friday",
-      baseEvent: "easter",
-      offsetDays: -2,
-      title: "Good Friday",
-    },
-    {
-      type: "offset",
-      id: "holy-saturday",
-      baseEvent: "easter",
-      offsetDays: -1,
-      title: "Holy Saturday",
-    },
+## Compute Easter directly
 
-    // Easter Season
-    {
-      type: "offset",
-      id: "easter-monday",
-      baseEvent: "easter",
-      offsetDays: 1,
-      title: "Easter Monday",
-    },
-    {
-      type: "offset",
-      id: "divine-mercy",
-      baseEvent: "easter",
-      offsetDays: 7,
-      title: "Divine Mercy Sunday",
-    },
-    { type: "offset", id: "ascension", baseEvent: "easter", offsetDays: 39, title: "Ascension" },
-    { type: "offset", id: "pentecost", baseEvent: "easter", offsetDays: 49, title: "Pentecost" },
+```ts
+import { computeEaster, easterRelativeDate } from "calendaryjs-plugin-liturgical";
 
-    // Ordinary Time
-    { type: "offset", id: "trinity", baseEvent: "easter", offsetDays: 56, title: "Trinity Sunday" },
-    {
-      type: "offset",
-      id: "corpus-christi",
-      baseEvent: "easter",
-      offsetDays: 60,
-      title: "Corpus Christi",
-    },
-  ],
-});
+computeEaster(2025); // → Date — Easter Sunday 2025
+easterRelativeDate(2025, 49); // → Date — Pentecost (Easter + 49)
 ```
 
-## Easter Calculation
-
-The plugin uses the Computus algorithm to calculate Easter dates:
-
-```typescript
-import { computeEaster } from "calendaryjs-plugin-liturgical";
-
-const easter2025 = computeEaster(2025);
-// Returns: Date object for Easter Sunday 2025
-```
+## Reference
 
-## Related Packages
+**Event types** — `easter` · `offset` (`baseEvent` + `offsetDays`), plus every standard
+[event property](https://www.npmjs.com/package/calendaryjs#event-properties).
 
-- [calendaryjs](https://github.com/calendaryjs/calendaryjs/tree/main/packages/calendaryjs) - Core package
-- [calendaryjs-plugin-lunar](https://github.com/calendaryjs/calendaryjs/tree/main/packages/lunar) - Lunar calendar
+**Exports** — `liturgical()` · presets (`EASTER`, `PENTECOST`, `GOOD_FRIDAY`…) ·
+`computeEaster` · `easterRelativeDate` · daily-calendar utils (`getLiturgicalDay`, `getSeason`…).
 
 ## License
 

package/dist/index.cjs

@@ -5,7 +5,7 @@ var calendaryjs = require('calendaryjs');
 // package.json
 var package_default = {
   name: "calendaryjs-plugin-liturgical",
-  version: "0.1.0"};
+  version: "0.1.2"};
 
 // src/computus.ts
 function computeEaster(year) {

package/dist/index.js

@@ -3,7 +3,7 @@ import { addDays, parseDate, formatDate, daysBetween, resolveConflict, getYear,
 // package.json
 var package_default = {
   name: "calendaryjs-plugin-liturgical",
-  version: "0.1.0"};
+  version: "0.1.2"};
 
 // src/computus.ts
 function computeEaster(year) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "calendaryjs-plugin-liturgical",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Catholic liturgical calendar plugin for calendaryjs — Easter computus and movable feasts.",
   "type": "module",
   "sideEffects": false,
@@ -39,7 +39,7 @@
     "date-easter": "^1.0.3",
     "typescript": "^5.3.2",
     "vitest": "^4.0.18",
-    "calendaryjs": "0.2.0"
+    "calendaryjs": "0.2.2"
   },
   "files": [
     "dist"
@@ -58,12 +58,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/calendaryjs/calendaryjs.git",
+    "url": "git+https://github.com/vbilltran68/calendaryjs.git",
     "directory": "packages/liturgical"
   },
-  "homepage": "https://github.com/calendaryjs/calendaryjs/tree/main/packages/liturgical#readme",
+  "homepage": "https://www.npmjs.com/package/calendaryjs-plugin-liturgical",
   "bugs": {
-    "url": "https://github.com/calendaryjs/calendaryjs/issues"
+    "url": "https://github.com/vbilltran68/calendaryjs/issues"
   },
   "scripts": {
     "typecheck": "tsc --noEmit",