@hisptz/dhis2-analytics 1.0.5 → 1.0.7

package/build/types/components/Map/constants/colors.d.ts

@@ -0,0 +1,419 @@
+export declare const COLOR_PALETTES: {
+    YlGn: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    YlGnBu: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    GnBu: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    BuGn: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    PuBuGn: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    PuBu: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    BuPu: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    RdPu: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    PuRd: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    OrRd: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    YlOrRd: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    YlOrBr: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Purples: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Blues: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Greens: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Oranges: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Reds: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Greys: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    PuOr: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+    };
+    BrBG: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+    };
+    PRGn: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+    };
+    PiYG: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+    };
+    RdBu: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+    };
+    RdGy: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+    };
+    RdYlBu: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+    };
+    Spectral: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+    };
+    RdYlGn: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+    };
+    Accent: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+    };
+    Dark2: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+    };
+    Paired: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+        12: string[];
+    };
+    Pastel1: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Pastel2: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+    };
+    Set1: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Set2: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+    };
+    Set3: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+        11: string[];
+        12: string[];
+    };
+    YlOrBr_reverse: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Reds_reverse: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    YlGn_reverse: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Greens_reverse: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Blues_reverse: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    BuPu_reverse: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    RdPu_reverse: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    PuRd_reverse: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+    Greys_reverse: {
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+    };
+};
+export declare const qualitativeColors: string[];

package/build/types/components/Map/constants/legendSet.d.ts

@@ -0,0 +1,7 @@
+export declare const defaultLegendSet: {
+    legends: {
+        startValue: number;
+        endValue: number;
+        color: string;
+    }[];
+};

package/build/types/components/Map/hooks/map.d.ts

@@ -0,0 +1,9 @@
+import { LatLngTuple } from "leaflet";
+export declare function useMapBounds(): {
+    center: import("leaflet").LatLng;
+    bounds: any;
+};
+export declare function useCenterMap({ bounds }: {
+    bounds: LatLngTuple[];
+}): (node: HTMLDivElement | null) => void;
+export declare function usePrintMedia(): boolean;

package/build/types/components/Map/index.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { MapProps } from "./interfaces";
+import "leaflet/dist/leaflet.css";
+export declare const Map: React.FC<MapProps>;
+export * from "./components/EarthEngineLayerConfiguration";
+export * from "./components/ThematicLayerConfiguration";
+export * from "./interfaces";
+export * from "./constants/colors";

package/build/types/components/Map/interfaces/index.d.ts

@@ -0,0 +1,65 @@
+import type { OrgUnitSelection } from "@hisptz/dhis2-utils";
+import React from "react";
+import type { MapContainerProps } from "react-leaflet";
+import { MapControls, MapLegendConfig } from "../components/MapArea/interfaces";
+import { EarthEngineLayerConfig, ThematicLayerConfig } from "../components/MapLayer/interfaces";
+export interface MapProviderProps {
+    children: React.ReactNode;
+    orgUnitSelection: OrgUnitSelection;
+    periodSelection?: {
+        periods?: string[];
+        range?: {
+            start: Date;
+            end: Date;
+        };
+    };
+}
+export interface MapProps {
+    key?: string;
+    orgUnitSelection: OrgUnitSelection;
+    pointLayer?: {
+        enabled: boolean;
+        label?: string;
+        level?: number | string;
+        group?: string;
+        style?: {
+            icon?: string;
+            groupSet?: string;
+        };
+    };
+    boundaryLayer?: {
+        enabled: boolean;
+    };
+    controls?: MapControls[];
+    legends?: MapLegendConfig;
+    thematicLayers?: ThematicLayerConfig[];
+    earthEngineLayers?: EarthEngineLayerConfig[];
+    periodSelection?: {
+        periods?: string[];
+        range?: {
+            start: Date;
+            end: Date;
+        };
+    };
+    mapOptions?: MapContainerProps;
+}
+export interface MapOrgUnit {
+    id: string;
+    path: string;
+    name: string;
+    bounds: any[];
+    geoJSON: any;
+    children?: MapOrgUnit[];
+    level?: number;
+}
+export interface PointOrgUnit {
+    id: string;
+    path: string;
+    name: string;
+    bounds: any[];
+    geoJSON: any;
+    icon: {
+        type: "custom" | "groupIcon";
+        icon: string;
+    };
+}

package/build/types/components/Map/state/index.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import type { OrgUnitSelection } from "@hisptz/dhis2-utils";
+import { CustomMapLayer } from "../components/MapLayer/interfaces";
+import { MapOrgUnit } from "../interfaces";
+import { BasePeriod } from "@hisptz/dhis2-utils";
+export declare const MapOrgUnitContext: import("react").Context<{
+    orgUnitSelection: OrgUnitSelection;
+    orgUnits?: MapOrgUnit[] | undefined;
+}>;
+export declare const MapPeriodContext: import("react").Context<{
+    periods?: BasePeriod[] | undefined;
+    range?: {
+        start: Date;
+        end: Date;
+    } | undefined;
+} | undefined>;
+export declare const MapLayersContext: import("react").Context<{
+    layers: CustomMapLayer[];
+    updateLayer: (id: string, updatedLayer: CustomMapLayer) => void;
+}>;

package/build/types/components/Map/utils/colors.d.ts

@@ -0,0 +1,12 @@
+export declare const getColorPalette: (scale: string, classes: number) => any;
+export declare const getColorClasses: (palette: string) => number;
+export declare const getColorScale: (palette: string) => string | undefined;
+export declare const defaultColorScaleName = "YlOrBr";
+export declare const defaultClasses = 5;
+export declare const defaultColorScale: any;
+export declare const cssColor: (color: any) => any;
+export declare const getUniqueColor: (defaultColors: any) => (index: number) => any;
+export declare const isDarkColor: (color: string) => boolean;
+export declare const getContrastColor: (color: string) => "#fff" | "#000";
+export type LegendColorScale = typeof colorScales[number];
+export declare const colorScales: string[];

package/build/types/components/Map/utils/helpers.d.ts

@@ -0,0 +1,6 @@
+import L from "leaflet";
+export declare const getLongestTextLength: (array: Array<any>, key: string | number) => any;
+export declare function getIconUrl(icon: string, { baseUrl }: {
+    baseUrl: string;
+}): string;
+export declare function getIcon(url: string): L.Icon | undefined;

package/build/types/components/Map/utils/map.d.ts

@@ -0,0 +1,40 @@
+import type { Legend, OrgUnitSelection } from "@hisptz/dhis2-utils";
+import { LeafletMouseEvent } from "leaflet";
+export declare function highlightFeature(e: LeafletMouseEvent, style: any): void;
+export declare function resetHighlight(e: LeafletMouseEvent, defaultStyle: any): void;
+export declare function getColorFromLegendSet(legends: Legend[], value?: number): string;
+export declare function getLegendCount(legend: any, data: any): number;
+export declare function getOrgUnitsSelection(orgUnitSelection: OrgUnitSelection): string[];
+export declare function sanitizeOrgUnits(metaData: any): any;
+export declare function toGeoJson(organisationUnits: any): ({
+    type: string;
+    id: any;
+    geometry: {
+        type: string;
+        coordinates: any;
+    };
+    properties: {
+        type: string;
+        id: any;
+        name: any;
+        hasCoordinatesDown: any;
+        hasCoordinatesUp: any;
+        level: any;
+        grandParentParentGraph: string;
+        grandParentId: string;
+        parentGraph: any;
+        parentId: any;
+        parentName: any;
+        dimensions: any;
+    };
+} | {
+    type?: undefined;
+    id?: undefined;
+    geometry?: undefined;
+    properties?: undefined;
+})[];
+export declare function sanitizeDate(startDate: string): string;
+export declare function generateLegends(maxValue: number, minValue: number, { classesCount, colorClass }: {
+    classesCount: number;
+    colorClass: string;
+}): Array<Legend>;

package/build/types/components/SingleValueContainer/components/SingleValueItem/SingleValueItem.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { SingleValue } from "../../types/props";
+interface SingleValueProps extends SingleValue {
+    globalAnimationDelay?: number;
+    globalAnimationDuration?: number;
+}
+export default function SingleValueItem({ label, value, color, percentage, animationDuration, animationDelay, globalAnimationDelay, decimalPlaces, globalAnimationDuration, }: SingleValueProps): React.ReactElement;
+export {};

package/build/types/components/SingleValueContainer/components/SingleValueItem/SingleValuePercentage.d.ts

@@ -0,0 +1,2 @@
+import React from "react";
+export default function SingleValuePercentage({ percentage, color }: any): React.ReactElement;

package/build/types/components/SingleValueContainer/index.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+import SingleValueItem from "./components/SingleValueItem/SingleValueItem";
+import { SingleValueContainerProps } from "./types/props";
+export declare function SingleValueContainer({ title, singleValueItems, animationDuration, animationDelay }: SingleValueContainerProps): React.ReactElement;
+export { SingleValueItem };

package/build/types/components/SingleValueContainer/types/props.d.ts

@@ -0,0 +1,15 @@
+export type SingleValueContainerProps = {
+    title: string;
+    singleValueItems: Array<SingleValue>;
+    animationDuration?: number;
+    animationDelay?: number;
+};
+export type SingleValue = {
+    label: string;
+    value: number;
+    percentage?: number;
+    decimalPlaces?: number;
+    color?: string;
+    animationDuration?: number;
+    animationDelay?: number;
+};

package/build/types/dataProviders/map.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+export default function MapDataProvider({ children }: {
+    children: React.ReactNode;
+}): React.ReactElement;

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@hisptz/dhis2-analytics",
-  "version": "1.0.5",
-  "description": "",
+  "version": "1.0.7",
+  "description": "A collection of reusable react components for visualizing analytics data from DHIS2",
   "license": "BSD-3-Clause",
   "scripts": {
     "build": "d2-app-scripts build --no-verify",
+    "build:types": "tsc --project tsconfig.build.json",
+    "postbuild": "yarn build:types",
     "start": "d2-app-scripts start",
     "test": "d2-app-scripts test --passWithNoTests",
     "deploy": "d2-app-scripts deploy",
@@ -16,17 +18,19 @@
     "@dhis2/cypress-commands": "^9.0.2",
     "@dhis2/cypress-plugins": "^9.0.2",
     "@google/earthengine": "^0.1.336",
+    "@types/d3-color": "^3.1.0",
     "@types/d3-scale": "^4.0.3",
     "@types/leaflet": "^1.9.0",
     "@types/lodash": "^4.14.191",
     "@types/react-helmet": "^6.1.6",
     "cypress": "^12.3.0",
     "lodash": "^4.17.21",
-    "react-hook-form": "^7.42.1"
+    "react-hook-form": "^7.42.1",
+    "typescript": "^4.9.5"
   },
   "dependencies": {
     "@dhis2/app-runtime": "^3.7.0",
-    "@hisptz/dhis2-ui": "^1.0.5",
+    "@hisptz/dhis2-ui": "^1.0.6",
     "async-es": "^3.2.4",
     "d3-color": "^3.1.0",
     "d3-scale": "^4.0.2",
@@ -49,9 +53,26 @@
     "import": "./build/es/index.js",
     "require": "./build/cjs/index.js"
   },
+  "keywords": [
+    "react",
+    "dhis2",
+    "dhis2-analytics",
+    "hisptz"
+  ],
+  "author": "HISP Tanzania",
+  "files": [
+    "build/**"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hisptz/dhis2-utils.git"
+  },
+  "bugs": {
+    "url": "https://github.com/hisptz/dhis2-utils/issues"
+  },
   "peerDependencies": {
     "lodash": "^4",
     "react-hook-form": "^7"
   },
-  "gitHead": "4a3654c90bffc9cab1bd764d68ef107033ec47f6"
+  "gitHead": "d4e85275f43ae34d42a9f3b6a75a51293ceb6c47"
 }