@hebcal/rest-api 5.0.5 → 5.1.1

package/dist/rss.d.ts

@@ -0,0 +1,4 @@
+import { Event } from '@hebcal/core';
+import { RestApiOptions } from './common';
+export declare function eventsToRss2(events: Event[], options: RestApiOptions): string;
+export declare function eventToRssItem2(ev: Event, options: RestApiOptions): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/rest-api",
-  "version": "5.0.5",
+  "version": "5.1.1",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -15,12 +15,11 @@
   "exports": {
     "import": "./dist/index.mjs",
     "require": "./dist/index.cjs",
-    "types": "./rest-api.d.ts"
+    "types": "./dist/index.d.ts"
   },
-  "typings": "rest-api.d.ts",
+  "typings": "dist/index.d.ts",
   "files": [
-    "dist",
-    "rest-api.d.ts"
+    "dist"
   ],
   "repository": {
     "type": "git",
@@ -30,31 +29,35 @@
     "url": "https://github.com/hebcal/hebcal-rest-api/issues"
   },
   "dependencies": {
-    "@hebcal/core": "^5.4.4",
-    "@hebcal/leyning": "^8.1.9",
-    "@hebcal/triennial": "^5.0.5"
+    "@hebcal/core": "^5.4.9",
+    "@hebcal/leyning": "^8.2.2",
+    "@hebcal/triennial": "^5.1.1"
   },
   "scripts": {
     "build:rollup": "rollup -c",
-    "build:json2js": "for f in src/*.json; do echo 'export default' > $f.js && cat $f >> $f.js; done",
+    "build:json2js": "for f in src/*.json; do echo 'export default' > $f.ts && cat $f >> $f.ts; done",
     "build": "npm run build:json2js && npm run build:rollup",
     "prepublish": "npm run build",
     "pretest": "npm run build",
-    "readme": "npx jsdoc2md dist/index.js",
-    "test": "ava"
+    "docs": "typedoc",
+    "test": "jest"
   },
   "license": "BSD-2-Clause",
   "devDependencies": {
-    "@hebcal/learning": "^5.0.8",
-    "@rollup/plugin-commonjs": "^25.0.8",
+    "@babel/preset-env": "^7.24.7",
+    "@babel/preset-typescript": "^7.24.7",
+    "@hebcal/learning": "^5.1.1",
+    "@rollup/plugin-commonjs": "^26.0.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "ava": "^6.1.3",
-    "eslint": "^8.57.0",
-    "eslint-config-google": "^0.14.0",
-    "jsdoc": "^4.0.3",
-    "jsdoc-to-markdown": "^8.0.1",
-    "rollup": "^4.18.0"
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/jest": "^29.5.12",
+    "gts": "^5.3.1",
+    "jest": "^29.7.0",
+    "rollup": "^4.18.1",
+    "ts-jest": "^29.2.0",
+    "typedoc": "^0.26.3",
+    "typescript": "^5.5.3"
   }
 }

package/rest-api.d.ts

@@ -1,95 +0,0 @@
-/// <reference types="node"/>
-
-import {Event, Location, CalOptions} from '@hebcal/core';
-
-declare module '@hebcal/rest-api' {
-  /**
-   * Renders an Event as a string
-   */
-  export function eventToCsv(e: Event, options: CalOptions): string;
-  export function eventsToCsv(events: Event[], options: CalOptions): string;
-  /**
-   * Formats a list events for the classic Hebcal.com JSON API response
-   */
-  export function eventsToClassicApi(events: Event[], options: CalOptions, leyning?: boolean): any;
-  /**
-   * Converts a Hebcal event to a classic Hebcal.com JSON API object
-   */
-  export function eventToClassicApiObject(ev: Event, options: CalOptions, leyning?: boolean): any;
-  /**
-   * Converts a Hebcal event to a FullCalendar.io object
-   * @param tzid - timeZone identifier
-   * @param il - true if Israel
-   */
-  export function eventToFullCalendar(ev: Event, tzid: string, il: boolean): any;
-  /**
-   * Makes mulit-line text that summarizes Torah & Haftarah
-   */
-  export function makeTorahMemoText(ev: Event, il: boolean): string;
-  /**
-   * Appends utm_source and utm_medium parameters to a URL
-   */
-  export function appendIsraelAndTracking(url: string, il: boolean, utmSource: string, utmMedium: string, utmCampaign?: string): string;
-  /**
-   * @private
-   */
-  export function shouldRenderBrief(ev: Event): boolean;
-  /**
-   * Extends `CalOptions` with
-   * `lang` - language such as 'he' (default 'en-US')
-   * `evPubDate` - if true, use event time as pubDate (false uses lastBuildDate)
-   */
-  export function eventsToRss2(events: Event[], options: CalOptions): string;
-  export function eventToRssItem2(ev: Event, options: CalOptions): string;
-  export function getDownloadFilename(options: CalOptions): string;
-  export function pad2(number: number): string;
-  export function pad4(number: number): string;
-  /**
-   * Helper function to transform a string to make it more usable in a URL or filename.
-   * Converts to lowercase and replaces non-word characters with hyphen ('-').
-   */
-  export function makeAnchor(s: string): string;
-  /**
-   * Returns just the date portion as YYYY-MM-DD
-   */
-  export function toISOString(d: Date): string;
-  /**
-   * Returns a category and subcategory name
-   */
-  export function getEventCategories(ev: Event): string[];
-  /**
-   * Generates a title like "Hebcal 2020 Israel" or "Hebcal May 1993 Providence"
-   */
-  export function getCalendarTitle(events: Event[], options: CalOptions): string;
-
-  /**
-   * Returns an English language description of the holiday
-   * @param [firstSentence=false]
-   */
-  export function getHolidayDescription(ev: Event, firstSentence?: boolean): string;
-
-  export type LocationPlainObj = {
-    title: string;
-    city: string;
-    tzid: string;
-    latitude: number;
-    longitude: number;
-    cc: string;
-    country: string;
-    admin1?: string;
-    asciiname?: string;
-    geo?: string;
-    zip?: string;
-    state?: string;
-    stateName?: string;
-    geonameid?: number;
-  };
-
-  export function locationToPlainObj(location: Location): LocationPlainObj;
-
-  export interface StringMap {
-    [key: string]: string;
-  }
-  export const countryNames: StringMap;
-  export const holidayDescription: StringMap;
-}