@imerss/inat-components 1.1.2 → 2.0.1

package/PUBLISH.md

@@ -0,0 +1,13 @@
+### Publishing new versions
+
+Here's how to publish a new version of this package.
+
+1. Go to the root of the monorepo and run `yarn install`, then `yarn boot`
+2. Update the version in `packages/inat-component`'s package.json
+3. Run `yarn build` to generate a fresh `/dist` folder (you can clean first, but the clean command currently also
+deletes __shared, so you'll need to rebuild from the root if you do that)
+
+Step 3 actually generates + copies over the result from the inat-components-standalone package, so in the dist folder 
+you should see a standalone.min.js file. All is good! 
+
+Now you can `npm publish`.

package/README.md

@@ -0,0 +1,12 @@
+# @imerss/inat-components
+
+The [inat-components repo](https://github.com/IMERSS/inat-components) contains some pre-built React components to
+display iNaturalist data on your own sites. The original goal was to provide add an 
+[interactive page to the BC Lepidoptera website](https://bcleps.weebly.com/inat.html) so visitors could see some
+high-level information about lepidoptera (butterflies and moths) spotted in British Columbia. But the code
+was written to allow it to be re-used by any website and for any taxon or place.
+
+This specific package is only the React components, plus a standalone.min.js file for 
+
+Please see the [main documentation](https://github.com/IMERSS/inat-components) for more information on the script, 
+including the standalone version.

package/dist/index.d.ts

@@ -2,7 +2,7 @@ declare type CommonTaxaCallProps = {
     year: string | number;
     taxonId: string | number;
     placeId: string | number;
-    perPage: number;
+    numResults: number;
 };
 declare type CommonTaxData = {
     id: number;
@@ -15,13 +15,13 @@ declare type CommonTaxaRespData = {
     totalResults: number;
     results: [CommonTaxData];
 };
-declare const getCommonTaxa: ({ year, taxonId, placeId, perPage }: CommonTaxaCallProps) => Promise<CommonTaxaRespData>;
+declare const getCommonTaxa: ({ year, taxonId, placeId, numResults }: CommonTaxaCallProps) => Promise<CommonTaxaRespData>;
 
 declare type FavouritesCallProps = {
     year: string | number;
     taxonId: string | number;
     placeId: string | number;
-    perPage: number;
+    numResults: number;
 };
 declare type FavouritesData = {
     id: number;
@@ -37,12 +37,12 @@ declare type FavouritesRespData = {
     totalResults: number;
     results: [FavouritesData];
 };
-declare const getFavourites: ({ year, taxonId, placeId, perPage }: FavouritesCallProps) => Promise<FavouritesRespData>;
+declare const getFavourites: ({ year, taxonId, placeId, numResults }: FavouritesCallProps) => Promise<FavouritesRespData>;
 
 declare type RecentObservationsCallProps = {
     taxonId: string | number;
     placeId: string | number;
-    perPage: number;
+    numResults: number;
 };
 declare type RecentObservationData = {
     id: number;
@@ -57,7 +57,7 @@ declare type RecentObservationsRespData = {
     totalResults: number;
     results: [RecentObservationData];
 };
-declare const getRecentObservations: ({ taxonId, placeId, perPage }: RecentObservationsCallProps) => Promise<RecentObservationsRespData>;
+declare const getRecentObservations: ({ taxonId, placeId, numResults }: RecentObservationsCallProps) => Promise<RecentObservationsRespData>;
 
 declare type SummaryApiProps = {
     taxonId: number;
@@ -86,61 +86,36 @@ declare type SeasonalityData = {
 };
 declare const getSeasonalityData: (taxonId: number, placeId: number, year: string | number) => Promise<SeasonalityData>;
 
-declare type ConfigFile = {
-    taxa: TaxaConfig[];
-    places: PlaceConfig[];
-    features: {
-        [Feature.commonTaxa]?: {
-            numResults?: number;
-        };
-        [Feature.favourites]?: {
-            numResults?: number;
-            numYears?: number;
-        };
-        [Feature.recentObservations]?: {
-            numResults?: number;
-            numYears?: number;
-        };
-        [Feature.stats]?: {
-            numTopObservers?: number;
-        };
-    };
-};
-declare enum DataSource {
-    autoLoad = "autoLoad",
-    dataProp = "dataProp",
-    url = "url"
-}
 declare enum Feature {
     commonTaxa = "commonTaxa",
     favourites = "favourites",
     recentObservations = "recentObservations",
     stats = "stats"
 }
-declare enum Tab {
-    recent = "recent",
-    commonTaxa = "commonTaxa",
-    favourites = "favourites",
-    stats = "stats"
+declare enum DataSourceEnum {
+    autoLoad = "autoLoad",
+    url = "url"
 }
-declare type BaseClasses = {
-    tabs?: string;
+declare type DataSource = `${DataSourceEnum}`;
+declare type ItemConfig = {
+    id: number;
+    str: string;
+};
+declare type GeneralClasses = {
+    tabsElement?: string;
     yearsDropdown?: string;
     pageHeadings?: string;
+    tabDesc?: string;
     observationLabelTitle?: string;
     observationLabelDate?: string;
     observationLabelName?: string;
-    observersList?: string;
-    statsCountSummary?: string;
-    tabDesc?: string;
+    observationCount?: string;
 };
 declare type BaseComponentProps = {
     taxonId?: number;
     placeId?: number;
-    filename?: string;
-    perPage?: number;
+    numResults?: number;
     source?: DataSource;
-    data?: any;
     dataUrl?: string;
     className?: string;
     itemWidth?: number;
@@ -149,27 +124,45 @@ declare type BaseComponentProps = {
         error?: any;
         loader?: any;
     };
-    classes?: BaseClasses;
+    generalClasses?: GeneralClasses;
     tabDesc?: string;
 };
-declare type TaxaConfig = {
-    label: string;
-    short: string;
-    taxonId: number;
+declare type RecentObservationsConfig = {
+    feature: Feature.recentObservations;
+    title?: string;
+    numResults?: number;
+    desc?: string;
+    className?: string;
 };
-declare type PlaceConfig = {
-    label: string;
-    short: string;
-    placeId: number;
+declare type CommonTaxaConfig = {
+    feature: Feature.commonTaxa;
+    title?: string;
+    numResults?: number;
+    numYears?: number;
+    desc?: string;
+    className?: string;
+};
+declare type FavouritesConfig = {
+    feature: Feature.favourites;
+    title?: string;
+    numResults?: number;
+    numYears?: number;
+    desc?: string;
+    className?: string;
 };
-declare type TabDescs = {
-    recentDesc?: string;
-    mostCommonDesc?: string;
-    mostFavouritedDesc?: string;
-    generalStatsDesc?: string;
+declare type StatsConfig = {
+    feature: Feature.stats;
+    title?: string;
+    numTopObservers?: number;
+    numYears?: number;
+    desc?: string;
+    className?: string;
+    observersListClass?: string;
+    statsCountSummaryClass?: string;
 };
+declare type TaxonPanelFeatures = (RecentObservationsConfig | CommonTaxaConfig | FavouritesConfig | StatsConfig)[];
 
-declare const getSourceFile: (api: Feature, taxonInfo?: TaxaConfig, placeInfo?: PlaceConfig, year?: string | number) => string;
+declare const getSourceFile: (api: Feature, taxon: ItemConfig, place: ItemConfig, year?: string | number) => string;
 
 declare const getCurrentYear: () => number;
 declare const formatDate: (date: string, dateFormat?: string) => any;
@@ -177,20 +170,23 @@ declare const formatDate: (date: string, dateFormat?: string) => any;
 declare const numberWithCommas: (x: number) => string;
 
 declare const BASE_API_URL = "https://api.inaturalist.org";
-declare const PER_PAGE = 100;
+declare const NUM_RESULTS = 100;
+declare const DEFAULT_NUM_YEARS = 10;
 declare const BASE_URL = "https://www.inaturalist.org";
 declare const ERROR_LOG_FILENAME = "inat-components-error.log";
 declare const DEFAULT_ITEM_WIDTH = 150;
 
 declare const constants_BASE_API_URL: typeof BASE_API_URL;
-declare const constants_PER_PAGE: typeof PER_PAGE;
+declare const constants_NUM_RESULTS: typeof NUM_RESULTS;
+declare const constants_DEFAULT_NUM_YEARS: typeof DEFAULT_NUM_YEARS;
 declare const constants_BASE_URL: typeof BASE_URL;
 declare const constants_ERROR_LOG_FILENAME: typeof ERROR_LOG_FILENAME;
 declare const constants_DEFAULT_ITEM_WIDTH: typeof DEFAULT_ITEM_WIDTH;
 declare namespace constants {
   export {
     constants_BASE_API_URL as BASE_API_URL,
-    constants_PER_PAGE as PER_PAGE,
+    constants_NUM_RESULTS as NUM_RESULTS,
+    constants_DEFAULT_NUM_YEARS as DEFAULT_NUM_YEARS,
     constants_BASE_URL as BASE_URL,
     constants_ERROR_LOG_FILENAME as ERROR_LOG_FILENAME,
     constants_DEFAULT_ITEM_WIDTH as DEFAULT_ITEM_WIDTH,
@@ -198,16 +194,21 @@ declare namespace constants {
 }
 
 declare type TaxonPanelProps = {
-    taxonId: number;
-    placeId: number;
+    taxon: {
+        id: number;
+        str: string;
+    };
+    place: {
+        id: number;
+        str: string;
+    };
+    dataSourceBaseUrl: string;
     dataSource: DataSource;
-    config: ConfigFile;
-    baseUrl: string;
+    features: TaxonPanelFeatures;
+    generalClasses: GeneralClasses;
     itemWidth?: number;
-    classes?: BaseClasses;
-    tabDescs?: TabDescs;
 };
-declare const TaxonPanel: ({ taxonId, placeId, dataSource, config, baseUrl, itemWidth, classes, tabDescs }: TaxonPanelProps) => JSX.Element;
+declare const TaxonPanel: ({ taxon, place, features, dataSource, dataSourceBaseUrl, itemWidth, generalClasses }: TaxonPanelProps) => JSX.Element;
 
 declare type ObservationProps = {
     imageUrl: string;
@@ -218,39 +219,41 @@ declare type ObservationProps = {
 declare const Observation: ({ imageUrl, linkUrl, itemWidth, children }: ObservationProps) => JSX.Element;
 
 declare type CommonTaxaProps = BaseComponentProps & {
-    year: string | number;
+    year: number;
 };
 declare const CommonTaxaLabel: (data: CommonTaxData & {
-    classes: BaseClasses;
+    classes: GeneralClasses;
 }) => JSX.Element;
-declare const CommonTaxa: ({ year, source, taxonId, placeId, perPage, itemWidth, data, dataUrl, components, classes, className, tabDesc }: CommonTaxaProps) => JSX.Element;
+declare const CommonTaxa: ({ year, source, taxonId, placeId, numResults, itemWidth, dataUrl, components, generalClasses, className, tabDesc }: CommonTaxaProps) => JSX.Element;
 
 declare type RecentObservationsProps = BaseComponentProps;
 declare const RecentObservationLabel: (obs: RecentObservationData & {
-    classes: BaseClasses;
+    classes: GeneralClasses;
 }) => JSX.Element;
-declare const RecentObservations: ({ taxonId, placeId, data, dataUrl, source, perPage, itemWidth, components, className, classes, tabDesc }: RecentObservationsProps) => JSX.Element;
+declare const RecentObservations: ({ taxonId, placeId, dataUrl, components, className, generalClasses, tabDesc, source, numResults, itemWidth }: RecentObservationsProps) => JSX.Element;
 
 declare type FavouritesProps = BaseComponentProps & {
-    year: string | number;
+    year: number | string;
 };
 declare const FavouritesLabel: (data: FavouritesData & {
-    classes: BaseClasses;
+    classes: GeneralClasses;
 }) => JSX.Element;
-declare const Favourites: ({ year, source, taxonId, placeId, data, dataUrl, components, className, tabDesc, classes, itemWidth, perPage }: FavouritesProps) => JSX.Element;
+declare const Favourites: ({ year, source, taxonId, placeId, dataUrl, components, className, tabDesc, generalClasses, itemWidth, numResults }: FavouritesProps) => JSX.Element;
 
 declare const SeasonalityGraph: ({ data }: any) => JSX.Element;
 
 declare type SummaryProps = {
-    source: DataSource;
     taxonId: number;
     placeId: number;
-    year: string | number;
-    data?: FavouritesRespData;
+    year: number;
+    source: DataSource;
     dataUrl?: string;
-    classes?: BaseClasses;
+    generalClasses?: GeneralClasses;
+    className?: string;
     tabDesc?: string;
+    observersListClass?: string;
+    statsCountSummaryClass?: string;
 };
-declare const Summary: ({ source, data, dataUrl, taxonId, placeId, year, classes, tabDesc }: SummaryProps) => JSX.Element;
+declare const Summary: ({ source, dataUrl, taxonId, placeId, year, generalClasses, className, tabDesc, observersListClass, statsCountSummaryClass }: SummaryProps) => JSX.Element;
 
-export { BaseClasses, BaseComponentProps, constants as C, CommonTaxData, CommonTaxa, CommonTaxaCallProps, CommonTaxaLabel, CommonTaxaProps, CommonTaxaRespData, ConfigFile, DataSource, Favourites, FavouritesCallProps, FavouritesData, FavouritesLabel, FavouritesProps, FavouritesRespData, Feature, Observation, ObservationProps, Observer, PlaceConfig, RecentObservationData, RecentObservationLabel, RecentObservations, RecentObservationsCallProps, RecentObservationsProps, RecentObservationsRespData, SeasonalityData, SeasonalityGraph, Summary, SummaryApiProps, SummaryData, SummaryProps, Tab, TabDescs, TaxaConfig, TaxonPanelProps, TaxonPanel as default, formatDate, getCommonTaxa, getCurrentYear, getFavourites, getObservationSummary, getObserverSummary, getRecentObservations, getSeasonalityData, getSourceFile, getSummary, numberWithCommas };
+export { BaseComponentProps, constants as C, CommonTaxData, CommonTaxa, CommonTaxaCallProps, CommonTaxaConfig, CommonTaxaLabel, CommonTaxaProps, CommonTaxaRespData, DataSource, DataSourceEnum, Favourites, FavouritesCallProps, FavouritesConfig, FavouritesData, FavouritesLabel, FavouritesProps, FavouritesRespData, Feature, GeneralClasses, ItemConfig, Observation, ObservationProps, Observer, RecentObservationData, RecentObservationLabel, RecentObservations, RecentObservationsCallProps, RecentObservationsConfig, RecentObservationsProps, RecentObservationsRespData, SeasonalityData, SeasonalityGraph, StatsConfig, Summary, SummaryApiProps, SummaryData, SummaryProps, TaxonPanelFeatures, TaxonPanelProps, TaxonPanel as default, formatDate, getCommonTaxa, getCurrentYear, getFavourites, getObservationSummary, getObserverSummary, getRecentObservations, getSeasonalityData, getSourceFile, getSummary, numberWithCommas };