@hebcal/rest-api 5.2.0 → 6.0.1

package/dist/module.d.ts

@@ -1,117 +0,0 @@
-import { CalOptions, Location, Event } from '@hebcal/core';
-export { pad2, pad4 } from '@hebcal/hdate';
-
-interface StringMap {
-    [key: string]: string;
-}
-type RestApiEventOptions = {
-    utmSource?: string;
-    utmMedium?: string;
-    utmCampaign?: string;
-    appendHebrewToSubject?: boolean;
-    yahrzeit?: boolean;
-    subscribe?: string | number | boolean;
-    heDateParts?: boolean;
-    includeEvent?: boolean;
-    euro?: boolean;
-    title?: string;
-    description?: string;
-    dayFormat?: Intl.DateTimeFormat;
-    mainUrl?: string;
-    selfUrl?: string;
-    buildDate?: Date;
-    lastBuildDate?: string;
-    evPubDate?: boolean;
-    lang?: string;
-    preferAsciiName?: boolean;
-};
-type RestApiOptions = CalOptions & RestApiEventOptions;
-/**
- * Location information
- */
-type LocationPlainObj = {
-    title?: string | null;
-    city?: string | null;
-    tzid?: string;
-    latitude?: number;
-    longitude?: number;
-    cc?: string;
-    country?: string;
-    admin1?: string;
-    asciiname?: string;
-    geo?: string;
-    zip?: string;
-    state?: string;
-    stateName?: string;
-    geonameid?: number;
-};
-declare const holidayDescription: StringMap;
-declare const countryNames: StringMap;
-/**
- * Converts a @hebcal/core `Location` to a plain JS object.
- */
-declare function locationToPlainObj(location: Location | undefined): LocationPlainObj;
-declare function getDownloadFilename(options: RestApiOptions): string;
-/**
- * Returns just the date portion as YYYY-MM-DD
- */
-declare function toISOString(d: Date): string;
-/**
- * Returns a category and subcategory name
- */
-declare function getEventCategories(ev: Event): string[];
-/**
- * Renders the event title in default locale, but strips off time
- */
-declare function renderTitleWithoutTime(ev: Event): string;
-/**
- * Generates a title like "Hebcal 2020 Israel" or "Hebcal May 1993 Providence"
- */
-declare function getCalendarTitle(events: Event[], options: RestApiOptions): string;
-/**
- * Returns an English language description of the holiday
- */
-declare function getHolidayDescription(ev: Event, firstSentence?: boolean): string;
-/**
- * Makes mulit-line text that summarizes Torah & Haftarah
- */
-declare function makeTorahMemoText(ev: Event, il: boolean): string;
-declare function makeMemo(ev: Event, il: boolean): string;
-/**
- * Appends utm_source and utm_medium parameters to a URL
- */
-declare function appendIsraelAndTracking(url: string, il: boolean, utmSource: string, utmMedium: string, utmCampaign?: string): string;
-declare function shouldRenderBrief(ev: Event): boolean;
-
-/**
- * Renders an Event as a string
- */
-declare function eventToCsv(ev: Event, options: RestApiOptions): string;
-declare function eventsToCsv(events: Event[], options: RestApiOptions): 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 ('-').
- * @example
- * makeAnchor('Rosh Chodesh Adar II') // 'rosh-chodesh-adar-ii'
- */
-declare function makeAnchor(s: string): string;
-
-/**
- * Formats a list events for the classic Hebcal.com JSON API response
- */
-declare function eventsToClassicApi(events: Event[], options: RestApiOptions, leyning?: boolean): any;
-/**
- * Converts a Hebcal event to a classic Hebcal.com JSON API object
- */
-declare function eventToClassicApiObject(ev: Event, options: RestApiOptions, leyning?: boolean): any;
-
-declare function eventsToRss2(events: Event[], options: RestApiOptions): string;
-declare function eventToRssItem2(ev: Event, options: RestApiOptions): string;
-
-/**
- * Converts a Hebcal event to a FullCalendar.io object
- */
-declare function eventToFullCalendar(ev: Event, tzid: string, il: boolean): any;
-
-export { type LocationPlainObj, type RestApiEventOptions, type RestApiOptions, type StringMap, appendIsraelAndTracking, countryNames, eventToClassicApiObject, eventToCsv, eventToFullCalendar, eventToRssItem2, eventsToClassicApi, eventsToCsv, eventsToRss2, getCalendarTitle, getDownloadFilename, getEventCategories, getHolidayDescription, holidayDescription, locationToPlainObj, makeAnchor, makeMemo, makeTorahMemoText, renderTitleWithoutTime, shouldRenderBrief, toISOString };