rosario 0.1.2 → 0.2.1

package/README.md

@@ -11,11 +11,15 @@ npm install rosario
 ## Usage
 
 ```bash
-import rosario from "rosario";
+import rosario from 'rosario';
 
-const r = rosario({ mystery: "joyful" });
+const r = await rosario({
+  mystery: 'joyful',
+  lang: 'en',
+});
 
 console.log(r.current());
 
 r.next();
+console.log(r.current());
 ```

package/index.d.ts

@@ -6,16 +6,24 @@ export type Mystery =
 
 export interface RosarioOptions {
     mystery?: Mystery
+    lang?: string
+}
+
+export interface RosarioCurrent {
+    prayer: string
+    text: string
 }
 
 export interface RosarioSession {
     next(): void
 
-    current(): string
+    current(): RosarioCurrent
 
     done(): boolean
+
+    reset(): void
 }
 
 export default function rosario(
     options?: RosarioOptions
-): RosarioSession
+): Promise<RosarioSession>

package/index.js

@@ -1,5 +1,5 @@
 import { MYSTERIES } from './src/mysteries.js'
-import { PRAYERS } from './src/prayers.js'
+import { loadLang } from './src/lang/index.js'
 
 const DECADE = [
   'ourFather',
@@ -23,29 +23,41 @@ function buildOrder (mystery) {
   ]
 }
 
-export default function rosario ({ mystery = 'joyful' } = {}) {
+export default async function rosario ({
+  mystery = 'joyful',
+  lang = 'en',
+} = {}) {
+  const locale =
+    typeof lang === 'string'
+      ? await loadLang(lang)
+      : lang
+
+  if (!locale || !locale.prayers) {
+    throw new Error('Invalid language object: missing `prayers`')
+  }
+
   const order = buildOrder(mystery)
   let index = 0
 
   return {
-    next() {
+    next () {
       if (index < order.length - 1) index++
     },
 
-    current() {
+    current () {
       const key = order[index]
       return {
         prayer: key,
-        text: PRAYERS[key]
+        text: locale.prayers[key],
       }
     },
 
-    done() {
+    done () {
       return index >= order.length - 1
     },
 
-    reset() {
+    reset () {
       index = 0
-    }
+    },
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rosario",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "A tiny Catholic rosary prayer engine for web apps",
   "keywords": [
     "rosary",

package/src/lang/en.js

@@ -0,0 +1,35 @@
+export default {
+  prayers: {
+    apostlesCreed: 'I believe in God, the Father Almighty, Creator of Heaven and earth; and in Jesus Christ, His only Son, Our Lord, Who was conceived by the Holy Ghost, born of the Virgin Mary, suffered under Pontius Pilate, was crucified; died, and was buried. He descended into Hell; the third day He arose again from the dead; He ascended into Heaven, sitteth at the right hand of God, the Father Almighty; from thence He shall come to judge the living and the dead. I believe in the Holy Spirit, the holy Catholic Church, the communion of saints, the forgiveness of sins, the resurrection of the body, and the life everlasting. Amen.',
+    ourFather: 'Our Father, Who art in heaven, hallowed be Thy name; Thy kingdom come; Thy will be done on earth as it is in heaven. Give us this day our daily bread; and forgive us our trespasses as we forgive those who trespass against us; and lead us not into temptation, but deliver us from evil, Amen.',
+    hailMary: 'Hail Mary, full of grace. The Lord is with thee. Blessed art thou amongst women, and blessed is the fruit of thy womb, Jesus. Holy Mary, Mother of God, pray for us sinners, now and at the hour of our death, Amen.',
+    gloryBe: 'Glory be to the Father, and to the Son, and to the Holy Spirit. As it was in the beginning, is now, and ever shall be, world without end. Amen.',
+    fatimaPrayer: 'O my Jesus, forgive us our sins, save us from the fires of hell, lead all souls to Heaven, especially those in most need of Thy mercy.',
+  },
+
+  mysteries: {
+    annunciation: 'The Annunciation',
+    visitation: 'The Visitation',
+    nativity: 'The Birth of Jesus',
+    presentation: 'The Presentation',
+    findingInTemple: 'Finding the Child Jesus in the Temple',
+
+    baptism: 'Baptism of Jesus',
+    weddingAtCana: 'Wedding at Cana',
+    proclaimingKingdom: 'Proclaiming the Kingdom',
+    transfiguration: 'Transfiguration',
+    institutionEucharist: 'Institution of the Eucharist',
+
+    agonyInGarden: 'The Agony in the Garden',
+    scourgingAtPillar: 'The Scourging at the Pillar',
+    crowningWithThorns: 'Crowning With Thorns',
+    carryingCross: 'Carrying of the Cross',
+    crucifixion: 'The Crucifixion',
+
+    resurrection: 'The Resurrection',
+    ascension: 'The Ascension',
+    descentHolySpirit: 'Descent of the Holy Spirit',
+    assumption: 'The Assumption',
+    coronation: 'The Coronation'
+  },
+}

package/src/lang/index.js

@@ -0,0 +1,8 @@
+export async function loadLang (code) {
+  switch (code) {
+    case 'en':
+      return import('./en.js').then(m => m.default)
+    default:
+      throw new Error(`Unsupported language: ${code}`)
+  }
+}

package/src/mysteries.js

@@ -1,30 +1,30 @@
 export const MYSTERIES = {
   joyful: [
-    'The Annunciation',
-    'The Visitation',
-    'The Birth of Jesus',
-    'The Presentation',
-    'Finding the Child Jesus in the Temple'
+    'annunciation',
+    'visitation',
+    'nativity',
+    'presentation',
+    'findingInTemple',
   ],
   luminous: [
-    'Baptism of Jesus',
-    'Wedding at Cana',
-    'Proclaiming the Kingdom',
-    'Transfiguration',
-    'Institution of the Eucharist'
+    'baptism',
+    'weddingAtCana',
+    'proclaimingKingdom',
+    'transfiguration',
+    'institutionEucharist',
   ],
   sorrowful: [
-    'The Agony in the Garden',
-    'The Scourging at the Pillar',
-    'Crowning With Thorns',
-    'Carrying of the Cross',
-    'The Crucifixion',
+    'agonyInGarden',
+    'scourgingAtPillar',
+    'crowningWithThorns',
+    'carryingCross',
+    'crucifixion',
   ],
   glorious: [
-    'The Resurrection',
-    'The Ascension',
-    'Descent of the Holy Spirit',
-    'The Assumption',
-    'The Coronation',
+    'resurrection',
+    'ascension',
+    'descentHolySpirit',
+    'assumption',
+    'coronation',
   ],
 }

package/src/prayers.js

@@ -1,7 +0,0 @@
-export const PRAYERS = {
-  apostlesCreed: 'I believe in God, the Father Almighty, Creator of Heaven and earth; and in Jesus Christ, His only Son, Our Lord, Who was conceived by the Holy Ghost, born of the Virgin Mary, suffered under Pontius Pilate, was crucified; died, and was buried. He descended into Hell; the third day He arose again from the dead; He ascended into Heaven, sitteth at the right hand of God, the Father Almighty; from thence He shall come to judge the living and the dead. I believe in the Holy Spirit, the holy Catholic Church, the communion of saints, the forgiveness of sins, the resurrection of the body, and the life everlasting. Amen.',
-  ourFather: 'Our Father, Who art in heaven, hallowed be Thy name; Thy kingdom come; Thy will be done on earth as it is in heaven. Give us this day our daily bread; and forgive us our trespasses as we forgive those who trespass against us; and lead us not into temptation, but deliver us from evil, Amen.',
-  hailMary: 'Hail Mary, full of grace. The Lord is with thee. Blessed art thou amongst women, and blessed is the fruit of thy womb, Jesus. Holy Mary, Mother of God, pray for us sinners, now and at the hour of our death, Amen.',
-  gloryBe: 'Glory be to the Father, and to the Son, and to the Holy Spirit. As it was in the beginning, is now, and ever shall be, world without end. Amen.',
-  fatimaPrayer: 'O my Jesus, forgive us our sins, save us from the fires of hell, lead all souls to Heaven, especially those in most need of Thy mercy.',
-}