@hisptz/dhis2-analytics 1.0.5 → 1.0.7

package/build/types/components/Map/components/MapLayer/components/GoogleEngineLayer/services/engine.d.ts

@@ -0,0 +1,55 @@
+import { MapOrgUnit } from "../../../../../interfaces";
+import { EarthEngineOptions, EarthEngineToken, RefreshToken } from "../interfaces";
+export declare class EarthEngine {
+    token?: EarthEngineToken;
+    options: EarthEngineOptions;
+    refresh?: RefreshToken;
+    orgUnits?: MapOrgUnit[];
+    initialized: boolean;
+    period?: string | string[];
+    instance: any;
+    scale?: any;
+    image: any;
+    aggregationData: any;
+    constructor({ options }: {
+        options: EarthEngineOptions;
+    });
+    static setToken(token: EarthEngineToken, refresh: RefreshToken): Promise<void>;
+    setOrgUnits(orgUnits: MapOrgUnit[]): EarthEngine;
+    setPeriod(period: string): void;
+    getValue(geoJSON: any, type: string): Promise<unknown>;
+    getPeriod(): Promise<unknown>;
+    info(): Promise<unknown>;
+    getScale(): Promise<void>;
+    getFeatureCollectionAggregation(): Promise<any>;
+    getHistogramAggregations(): Promise<{
+        orgUnit: MapOrgUnit | undefined;
+        data: any;
+    }[]>;
+    getAggregations(): Promise<void>;
+    getAggregation(orgUnit: MapOrgUnit): any;
+    url(): Promise<string>;
+    protected applyPeriod(imageCollection: any): any;
+    protected applyMask(image: any): any;
+    protected applyBand(imageCollection: any): any;
+    protected getReducerByType(type: string): any;
+    protected getGeometryByType(geoJSON: any): any;
+    protected getFeatureByType(geoJSON: any): any;
+    protected getFeatureCollection(): unknown;
+    protected getParamsFromLegend(): {
+        min: number;
+        max: number;
+        palette: string;
+    } | undefined;
+    protected visualize(image: any): Promise<string>;
+    protected getImageCollectionInstance(): any;
+    protected getImageFromImageCollection(): any;
+    protected getImageInstance(): any;
+    protected getImageFromImage(): any;
+    protected getFeatureInstance(): any;
+    protected getImageFromFeature(): any;
+    protected getFeatureCollectionInstance(): any;
+    protected getImageFromFeatureCollection(): any;
+    protected getInstance(): void;
+    protected getImage(): any;
+}

package/build/types/components/Map/components/MapLayer/components/GoogleEngineLayer/utils/index.d.ts

@@ -0,0 +1,20 @@
+import { EarthEngineOptions } from "../interfaces";
+export declare const combineReducers: (ee: any) => (types: string[]) => any;
+export declare const getInfo: (instance: any) => Promise<unknown>;
+export declare const getFeatureCollectionProperties: (data: any) => any;
+export declare const getScale: (image: any) => Promise<any>;
+export declare const getClassifiedImage: (eeImage: any, { legend: legends, params }: EarthEngineOptions) => {
+    eeImage: any;
+    params: {
+        min: number;
+        max: number;
+        palette: string;
+    };
+};
+export declare const hasClasses: (type: string) => boolean;
+export declare const getHistogramStatistics: ({ data, scale, aggregationType, legend }: {
+    data: any;
+    scale: any;
+    aggregationType: string;
+    legend: any;
+}) => any;

package/build/types/components/Map/components/MapLayer/components/LegendArea/components/LegendCardHeader/index.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+export default function LegendCardHeader({ title, collapsible, onCollapse }: {
+    title: string;
+    onCollapse?: () => void;
+    collapsible?: boolean;
+}): JSX.Element;

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

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { ControlPosition } from "leaflet";
+import { MapLegendConfig } from "../../../MapArea/interfaces";
+import { CustomGoogleEngineLayer, CustomPointLayer, CustomThematicLayer } from "../../interfaces";
+export default function LegendArea({ layers, legends: legendConfig, }: {
+    layers: Array<CustomThematicLayer | CustomPointLayer | CustomGoogleEngineLayer>;
+    position: ControlPosition;
+    legends?: MapLegendConfig;
+}): JSX.Element;

package/build/types/components/Map/components/MapLayer/components/PointLayer/components/PointLegend/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+declare const _default: React.ForwardRefExoticComponent<Pick<any, string | number | symbol> & React.RefAttributes<HTMLDivElement>>;
+export default _default;

package/build/types/components/Map/components/MapLayer/components/PointLayer/hooks/index.d.ts

@@ -0,0 +1,2 @@
+import { CustomPointLayer } from "../../../interfaces";
+export declare function usePointLayer(): CustomPointLayer;

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

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function PointLayer(): JSX.Element;

package/build/types/components/Map/components/MapLayer/components/ThematicLayer/components/Bubble/components/BubbleLegend/components/Bubble.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+export interface BubbleProps {
+    radius: number;
+    maxRadius: number;
+    text?: string;
+    textAlign?: "left" | "right";
+    color?: string;
+    stroke?: string;
+    pattern?: string;
+    gap?: number;
+}
+declare const Bubble: ({ radius, maxRadius, text, textAlign, color, stroke, pattern }: BubbleProps) => JSX.Element;
+export default Bubble;

package/build/types/components/Map/components/MapLayer/components/ThematicLayer/components/Bubble/components/BubbleLegend/components/Bubbles.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+export declare const guideLength = 16;
+export declare const textPadding = 4;
+declare const _default: React.MemoExoticComponent<({ radiusLow, radiusHigh, color, classes }: {
+    radiusLow: number;
+    radiusHigh: number;
+    color?: string | undefined;
+    classes: any[];
+}) => JSX.Element | null>;
+export default _default;

package/build/types/components/Map/components/MapLayer/components/ThematicLayer/components/Bubble/components/BubbleLegend/index.d.ts

@@ -0,0 +1,16 @@
+import type { Legend } from "@hisptz/dhis2-utils";
+import React from "react";
+import { ThematicLayerData, ThematicLayerDataItem } from "../../../../../../interfaces";
+declare const _default: React.ForwardRefExoticComponent<{
+    radius: {
+        min: number;
+        max: number;
+    };
+    dataItem: ThematicLayerDataItem;
+    data: ThematicLayerData[];
+    name?: string | undefined;
+    collapsible?: boolean | undefined;
+    onCollapse?: (() => void) | undefined;
+    legends: Legend[];
+} & React.RefAttributes<HTMLDivElement>>;
+export default _default;

package/build/types/components/Map/components/MapLayer/components/ThematicLayer/components/Bubble/index.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import type { Legend } from "@hisptz/dhis2-utils";
+import { ThematicLayerData } from "../../../../interfaces";
+export default function Bubble({ data, highestData, legends, radius, }: {
+    data: ThematicLayerData;
+    highestData: number;
+    legends: Legend[];
+    radius?: {
+        min: number;
+        max: number;
+    };
+}): JSX.Element;

package/build/types/components/Map/components/MapLayer/components/ThematicLayer/components/Choropleth/components/ChoroplethLegend.d.ts

@@ -0,0 +1,21 @@
+import "../../../styles/legends.css";
+import type { Legend } from "@hisptz/dhis2-utils";
+import React from "react";
+import { ThematicLayerData, ThematicLayerDataItem } from "../../../../../interfaces";
+export declare function LegendItem({ legend, value }: {
+    legend: {
+        startValue: number;
+        endValue: number;
+        color: string;
+    };
+    value: number;
+}): JSX.Element;
+declare const _default: React.ForwardRefExoticComponent<{
+    data: ThematicLayerData[];
+    dataItem: ThematicLayerDataItem;
+    name?: string | undefined;
+    collapsible?: boolean | undefined;
+    onCollapse?: (() => void) | undefined;
+    legends: Legend[];
+} & React.RefAttributes<HTMLDivElement>>;
+export default _default;

package/build/types/components/Map/components/MapLayer/components/ThematicLayer/components/Choropleth/index.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import type { Legend } from "@hisptz/dhis2-utils";
+import { MapOrgUnit } from "../../../../../../interfaces";
+import { ThematicLayerDataItem } from "../../../../interfaces";
+export default function Choropleth({ data, legends }: {
+    data: {
+        orgUnit: MapOrgUnit;
+        data?: number;
+        dataItem: ThematicLayerDataItem;
+    };
+    legends: Legend[];
+}): JSX.Element;

package/build/types/components/Map/components/MapLayer/components/ThematicLayer/components/CustomTooltip/index.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { ThematicLayerData } from "../../../../interfaces";
+export default function CustomTooltip({ data: dataObject }: {
+    data: ThematicLayerData;
+}): JSX.Element;

package/build/types/components/Map/components/MapLayer/components/ThematicLayer/hooks/config.d.ts

@@ -0,0 +1,2 @@
+import { CustomThematicLayer } from "../../../interfaces";
+export default function useThematicLayer(layerId: string): CustomThematicLayer | undefined;

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

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export default function ThematicLayer({ layerId, index }: {
+    layerId: string;
+    index: number;
+}): JSX.Element | null;

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

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { CustomBoundaryLayer, CustomGoogleEngineLayer, CustomPointLayer, CustomThematicLayer } from "./interfaces";
+export default function MapLayer({ layer, index, }: {
+    layer: CustomThematicLayer | CustomBoundaryLayer | CustomPointLayer | CustomGoogleEngineLayer;
+    index: number;
+}): JSX.Element | null;

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

@@ -0,0 +1,123 @@
+import type { Legend } from "@hisptz/dhis2-utils";
+import { MapOrgUnit, PointOrgUnit } from "../../../interfaces";
+import { LegendColorScale } from "../../../utils/colors";
+import { EarthEngineOptions } from "../components/GoogleEngineLayer/interfaces";
+import { EarthEngine } from "../components/GoogleEngineLayer/services/engine";
+export type BoundaryLayerType = "basemap" | "overlay";
+export type ThematicLayerType = "choropleth" | "bubble";
+export declare const SUPPORTED_EARTH_ENGINE_LAYERS: string[];
+export type GoogleEngineLayerType = "population" | "footprints" | "elevation" | "landCover";
+export interface CustomBoundaryLayer extends CustomMapLayer {
+    id: string;
+    type: BoundaryLayerType;
+    enabled: boolean;
+}
+export interface EarthEngineLayerConfig extends CustomMapLayer {
+    type: GoogleEngineLayerType;
+    aggregations?: string[];
+    name?: string;
+    filters?: {
+        period: string;
+    };
+    params?: {
+        min: number;
+        max: number;
+        palette?: string;
+    };
+}
+export interface CustomGoogleEngineLayer extends CustomMapLayer {
+    type: GoogleEngineLayerType;
+    options: EarthEngineOptions;
+    aggregations?: string[];
+    name: string;
+    url: string;
+    engine?: EarthEngine;
+}
+export interface CustomPointLayer extends CustomMapLayer {
+    id: string;
+    type: "point";
+    label?: string;
+    level?: string | number;
+    group?: string;
+    style?: {
+        icon?: string;
+        groupSet?: string;
+        orgUnitGroups?: Array<{
+            name: string;
+            symbol: string;
+        }>;
+    };
+    points?: Array<PointOrgUnit>;
+}
+export type DataItemType = "dataElement" | "indicator" | "programIndicator";
+export interface ThematicLayerDataItem {
+    id: string;
+    displayName: string;
+    type: DataItemType;
+    legendSet?: string;
+    legendConfig?: {
+        colorClass: LegendColorScale;
+        scale: number;
+    };
+}
+export interface ThematicLayerControl {
+    position: "topleft" | "topright" | "bottomleft" | "bottomright";
+    enabled: boolean;
+}
+export interface ThematicLayerData {
+    orgUnit: MapOrgUnit;
+    data?: number;
+    dataItem: ThematicLayerDataItem;
+}
+export interface ThematicLayerRawData {
+    orgUnit: string;
+    data?: number;
+    dataItem: string;
+}
+export interface CustomChoroplethLayer extends CustomMapLayer {
+    enabled: boolean;
+    name?: string;
+    data: ThematicLayerData[];
+    dataItem: ThematicLayerDataItem;
+    type: "choropleth";
+    control?: ThematicLayerControl;
+    legends?: Legend[];
+}
+export interface CustomBubbleLayer extends CustomMapLayer {
+    enabled: boolean;
+    name?: string;
+    data: ThematicLayerData[];
+    dataItem: ThematicLayerDataItem;
+    type: "bubble";
+    control?: ThematicLayerControl;
+    legends?: Legend[];
+    radius?: {
+        min: number;
+        max: number;
+    };
+}
+export type CustomThematicLayer = CustomBubbleLayer | CustomChoroplethLayer;
+export interface ThematicLayerConfig {
+    id: string;
+    data?: ThematicLayerRawData[];
+    enabled: boolean;
+    name?: string;
+    dataItem: ThematicLayerDataItem;
+    type: ThematicLayerType;
+    control?: ThematicLayerControl;
+    radius?: {
+        min: number;
+        max: number;
+    };
+}
+export interface CustomMapLayer {
+    id: string;
+    type: string;
+    enabled: boolean;
+}
+export type MapLayer = CustomBoundaryLayer | ThematicLayerConfig | CustomPointLayer | CustomGoogleEngineLayer;
+export interface MapLayerProps {
+    enabled: boolean;
+    type: "boundary" | "thematic" | "external" | "point" | "earthEngine";
+    layer: MapLayer;
+}

package/build/types/components/Map/components/MapProvider/components/MapLayerProvider/hooks/index.d.ts

@@ -0,0 +1,9 @@
+import { CustomGoogleEngineLayer, CustomPointLayer, EarthEngineLayerConfig } from "../../../../MapLayer/interfaces";
+export declare function useThematicLayers(): any;
+export declare function usePointLayer(): {
+    loading: boolean;
+    sanitizeLayer: (layer: CustomPointLayer) => Promise<CustomPointLayer | undefined>;
+};
+export declare function useGoogleEngineLayers(): {
+    sanitizeLayers: (layers: EarthEngineLayerConfig[]) => Promise<CustomGoogleEngineLayer[]>;
+};

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

@@ -0,0 +1,6 @@
+import React from "react";
+import { MapLayerConfig } from "../../../MapArea/interfaces";
+export declare function MapLayersProvider({ layers, children }: {
+    layers: MapLayerConfig;
+    children: React.ReactNode;
+}): JSX.Element;

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

@@ -0,0 +1,15 @@
+export declare function useMapOrganisationUnit(): {
+    orgUnitSelection: import("@hisptz/dhis2-utils").OrgUnitSelection;
+    orgUnits?: import("../../..").MapOrgUnit[] | undefined;
+};
+export declare function useMapPeriods(): {
+    periods?: import("@hisptz/dhis2-utils").BasePeriod[] | undefined;
+    range?: {
+        start: Date;
+        end: Date;
+    } | undefined;
+} | undefined;
+export declare function useMapLayers(): {
+    layers: import("../../MapLayer/interfaces").CustomMapLayer[];
+    updateLayer: (id: string, updatedLayer: import("../../MapLayer/interfaces").CustomMapLayer) => void;
+};

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

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { MapProviderProps } from "../../interfaces";
+export declare function MapProvider({ children, orgUnitSelection, periodSelection }: MapProviderProps): JSX.Element | null;

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

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { LatLngTuple } from "leaflet";
+export default function MapUpdater({ bounds }: {
+    bounds: LatLngTuple[];
+}): JSX.Element;

package/build/types/components/Map/components/ThematicLayerConfiguration/components/ColorScaleSelect/components/ColorScale/index.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+declare const ColorScale: ({ scale, bins, width, onClick }: {
+    scale: string;
+    bins: number;
+    width: number;
+    onClick: (scale: string) => void;
+}) => JSX.Element;
+export default ColorScale;