@dra2020/district-analytics 17.0.1 → 17.1.0

package/dist/src/types.d.ts

@@ -15,7 +15,7 @@ export type SessionRequest = {
     counties: GeoFeatureCollection;
     config: {};
 };
-export declare const enum Dataset {
+export declare enum Dataset {
     SHAPES = "SHAPES",
     CENSUS = "CENSUS",
     VAP = "VAP",
@@ -27,6 +27,13 @@ export type DatasetKeys = {
     VAP: string;
     ELECTION: string;
 };
+export declare const fieldMap: {
+    [key: string]: {
+        [key: string]: string;
+    };
+};
+export declare const multiFieldPairs: [string, string][];
+export declare const multiFields: string[];
 export declare const enum FeatureField {
     TotalPop = 0,
     WhitePop = 1,
@@ -71,46 +78,24 @@ export type WeightedNeighbors = {
     [geoID: string]: number;
 };
 export type UnweightedNeighbors = string[];
-export type TestEntry = {
-    score?: number | boolean;
-    details: Dict;
-    normalizedScore?: number;
-};
-export type DistrictWIP = {
-    [districtID: number]: any;
-};
-export declare const enum Test {
-    Complete = 0,
-    Contiguous = 1,
-    FreeOfHoles = 2,
-    EqualPopulation = 3,// This is the legal/not legal assessment of the population 
-    PopulationDeviation = 4,// deviation % (when legal, less is still better).
-    UnexpectedCountySplits = 5,
-    VTDSplits = 6
-}
-export type TestEntries = {
-    [test: number]: TestEntry;
-};
-export type DistrictProperties = {
-    [districtID: number]: any;
-};
-export type DistrictShapeProperties = [number, number, number];
-export declare const enum DistrictShapeProperty {
-    Area = 0,
-    Diameter = 1,
-    Perimeter = 2
-}
-export type GeoIDParts = {
-    vfeature?: boolean;
-    state: string;
-    county: string;
-    rest: string;
-};
-export type GeoIDTotal = {
-    [geoID: string]: number;
-};
-export type Dict = {
-    [key: string]: any;
+export type RequirementsChecklist = {
+    score: boolean;
+    metrics: {
+        complete: boolean;
+        contiguous: boolean;
+        freeOfHoles: boolean;
+        equalPopulation: boolean;
+    };
+    details: {
+        unassignedFeatures: string[];
+        emptyDistricts: number[];
+        discontiguousDistricts: number[];
+        embeddedDistricts: number[];
+        populationDeviation: number;
+        deviationThreshold: number;
+    };
+    datasets: Datasets;
+    resources: {};
 };
 export type Datasets = {
     shapes?: string;
@@ -125,3 +110,63 @@ export type Ratings = {
     compactness: number;
     splitting: number;
 };
+export declare enum StatisticsFields {
+    districtID = "districtID",
+    totalPop = "totalPop",
+    popDevPct = "popDevPct",
+    bEqualPop = "bEqualPop",
+    bNotEmpty = "bNotEmpty",
+    bContiguous = "bContiguous",
+    bNotEmbedded = "bNotEmbedded",
+    demPct = "demPct",
+    repPct = "repPct",
+    othPct = "othPct",
+    totalVAP = "totalVAP",
+    whitePct = "whitePct",
+    minorityPct = "minorityPct",
+    blackPct = "blackPct",
+    hispanicPct = "hispanicPct",
+    pacificPct = "pacificPct",
+    asianPct = "asianPct",
+    nativePct = "nativePct"
+}
+export type DistrictRow = {
+    districtID: number;
+    totalPop: number;
+    popDevPct: number;
+    bEqualPop: boolean;
+    bNotEmpty: boolean;
+    bContiguous: boolean;
+    bNotEmbedded: boolean;
+    demPct: number;
+    repPct: number;
+    othPct: number;
+    totalVAP: number;
+    whitePct: number;
+    minorityPct: number;
+    blackPct: number;
+    hispanicPct: number;
+    pacificPct: number;
+    asianPct: number;
+    nativePct: number;
+};
+export type DistrictStatistics = {
+    table: DistrictRow[];
+    details: {};
+    datasets: Datasets;
+    resources: {};
+};
+export type TestEntry = {
+    score?: number | boolean;
+    details: Dict;
+    normalizedScore?: number;
+};
+export type GeoIDParts = {
+    vfeature?: boolean;
+    state: string;
+    county: string;
+    rest: string;
+};
+export type Dict = {
+    [key: string]: any;
+};

package/dist/src/utils.d.ts

@@ -1,9 +1,8 @@
-import { AnalyticsSession } from './_api';
+import * as D from './data';
 import * as T from './types';
-export declare function getDistrict(plan: T.PlanByGeoID, geoID: string): number | undefined;
 export declare function parseGeoID(geoID: string): T.GeoIDParts;
-export declare function isWaterOnly(geoID: string, s?: AnalyticsSession): boolean;
-export declare function isUninhabited(geoID: string, s: AnalyticsSession): boolean;
+export declare function isWaterOnly(geoID: string, container?: D.SessionData): boolean;
+export declare function isUninhabited(geoID: string, container: D.SessionData): boolean;
 export declare function trim(fullFraction: number, digits?: number | undefined): number;
 export declare function sumArray(arr: number[]): number;
 export declare function avgArray(arr: number[]): number;
@@ -11,6 +10,10 @@ export declare function minArray(arr: number[]): number;
 export declare function maxArray(arr: number[]): number;
 export declare function initArray(n: number, value: any): any[];
 export declare function andArray(arr: boolean[]): boolean;
+export declare function addArrays(a: number[], b: number[]): number[];
+export declare function subtractArrays(a: number[], b: number[]): number[];
+export declare function divideArrays(numerator: number[], denominator: number[]): number[];
+export declare function falseIndexes(booleans: boolean[]): number[];
 export declare function keyExists(k: string, o: object): boolean;
 export declare function isObjectEmpty(o: object): boolean;
 export declare function isSetEmpty(s: any): boolean;
@@ -20,7 +23,7 @@ export declare function getNumericObjectKeys(o: object): number[];
 export declare function getSelectObjectKeys(o: T.Dict, v: any[]): string[];
 export declare function arrayContains(a: any[], item: any): boolean;
 export declare function objectContains(o: object, key: any): boolean;
-export declare function countEnumValues(enumName: any): number;
 export declare function shallowCopy(src: any): any;
 export declare function deepCopy(src: any): any;
 export declare function depthof(a: any): number;
+export declare function deepEqual(obj1: any, obj2: any, path?: string): boolean;

package/dist/src/valid.d.ts

@@ -1,5 +0,0 @@
-import * as T from './types';
-import { AnalyticsSession } from './_api';
-export declare function doIsComplete(s: AnalyticsSession, bLog?: boolean): T.TestEntry;
-export declare function doIsContiguous(s: AnalyticsSession, bLog?: boolean): T.TestEntry;
-export declare function doIsFreeOfHoles(s: AnalyticsSession, bLog?: boolean): T.TestEntry;

package/dist/types.d.ts

@@ -15,7 +15,7 @@ export type SessionRequest = {
     counties: GeoFeatureCollection;
     config: {};
 };
-export declare const enum Dataset {
+export declare enum Dataset {
     SHAPES = "SHAPES",
     CENSUS = "CENSUS",
     VAP = "VAP",
@@ -27,6 +27,13 @@ export type DatasetKeys = {
     VAP: string;
     ELECTION: string;
 };
+export declare const fieldMap: {
+    [key: string]: {
+        [key: string]: string;
+    };
+};
+export declare const multiFieldPairs: [string, string][];
+export declare const multiFields: string[];
 export declare const enum FeatureField {
     TotalPop = 0,
     WhitePop = 1,
@@ -71,46 +78,24 @@ export type WeightedNeighbors = {
     [geoID: string]: number;
 };
 export type UnweightedNeighbors = string[];
-export type TestEntry = {
-    score?: number | boolean;
-    details: Dict;
-    normalizedScore?: number;
-};
-export type DistrictWIP = {
-    [districtID: number]: any;
-};
-export declare const enum Test {
-    Complete = 0,
-    Contiguous = 1,
-    FreeOfHoles = 2,
-    EqualPopulation = 3,// This is the legal/not legal assessment of the population 
-    PopulationDeviation = 4,// deviation % (when legal, less is still better).
-    UnexpectedCountySplits = 5,
-    VTDSplits = 6
-}
-export type TestEntries = {
-    [test: number]: TestEntry;
-};
-export type DistrictProperties = {
-    [districtID: number]: any;
-};
-export type DistrictShapeProperties = [number, number, number];
-export declare const enum DistrictShapeProperty {
-    Area = 0,
-    Diameter = 1,
-    Perimeter = 2
-}
-export type GeoIDParts = {
-    vfeature?: boolean;
-    state: string;
-    county: string;
-    rest: string;
-};
-export type GeoIDTotal = {
-    [geoID: string]: number;
-};
-export type Dict = {
-    [key: string]: any;
+export type RequirementsChecklist = {
+    score: boolean;
+    metrics: {
+        complete: boolean;
+        contiguous: boolean;
+        freeOfHoles: boolean;
+        equalPopulation: boolean;
+    };
+    details: {
+        unassignedFeatures: string[];
+        emptyDistricts: number[];
+        discontiguousDistricts: number[];
+        embeddedDistricts: number[];
+        populationDeviation: number;
+        deviationThreshold: number;
+    };
+    datasets: Datasets;
+    resources: {};
 };
 export type Datasets = {
     shapes?: string;
@@ -125,3 +110,63 @@ export type Ratings = {
     compactness: number;
     splitting: number;
 };
+export declare enum StatisticsFields {
+    districtID = "districtID",
+    totalPop = "totalPop",
+    popDevPct = "popDevPct",
+    bEqualPop = "bEqualPop",
+    bNotEmpty = "bNotEmpty",
+    bContiguous = "bContiguous",
+    bNotEmbedded = "bNotEmbedded",
+    demPct = "demPct",
+    repPct = "repPct",
+    othPct = "othPct",
+    totalVAP = "totalVAP",
+    whitePct = "whitePct",
+    minorityPct = "minorityPct",
+    blackPct = "blackPct",
+    hispanicPct = "hispanicPct",
+    pacificPct = "pacificPct",
+    asianPct = "asianPct",
+    nativePct = "nativePct"
+}
+export type DistrictRow = {
+    districtID: number;
+    totalPop: number;
+    popDevPct: number;
+    bEqualPop: boolean;
+    bNotEmpty: boolean;
+    bContiguous: boolean;
+    bNotEmbedded: boolean;
+    demPct: number;
+    repPct: number;
+    othPct: number;
+    totalVAP: number;
+    whitePct: number;
+    minorityPct: number;
+    blackPct: number;
+    hispanicPct: number;
+    pacificPct: number;
+    asianPct: number;
+    nativePct: number;
+};
+export type DistrictStatistics = {
+    table: DistrictRow[];
+    details: {};
+    datasets: Datasets;
+    resources: {};
+};
+export type TestEntry = {
+    score?: number | boolean;
+    details: Dict;
+    normalizedScore?: number;
+};
+export type GeoIDParts = {
+    vfeature?: boolean;
+    state: string;
+    county: string;
+    rest: string;
+};
+export type Dict = {
+    [key: string]: any;
+};

package/dist/utils.d.ts

@@ -1,9 +1,8 @@
-import { AnalyticsSession } from './_api';
+import * as D from './data';
 import * as T from './types';
-export declare function getDistrict(plan: T.PlanByGeoID, geoID: string): number | undefined;
 export declare function parseGeoID(geoID: string): T.GeoIDParts;
-export declare function isWaterOnly(geoID: string, s?: AnalyticsSession): boolean;
-export declare function isUninhabited(geoID: string, s: AnalyticsSession): boolean;
+export declare function isWaterOnly(geoID: string, container?: D.SessionData): boolean;
+export declare function isUninhabited(geoID: string, container: D.SessionData): boolean;
 export declare function trim(fullFraction: number, digits?: number | undefined): number;
 export declare function sumArray(arr: number[]): number;
 export declare function avgArray(arr: number[]): number;
@@ -11,6 +10,10 @@ export declare function minArray(arr: number[]): number;
 export declare function maxArray(arr: number[]): number;
 export declare function initArray(n: number, value: any): any[];
 export declare function andArray(arr: boolean[]): boolean;
+export declare function addArrays(a: number[], b: number[]): number[];
+export declare function subtractArrays(a: number[], b: number[]): number[];
+export declare function divideArrays(numerator: number[], denominator: number[]): number[];
+export declare function falseIndexes(booleans: boolean[]): number[];
 export declare function keyExists(k: string, o: object): boolean;
 export declare function isObjectEmpty(o: object): boolean;
 export declare function isSetEmpty(s: any): boolean;
@@ -20,7 +23,7 @@ export declare function getNumericObjectKeys(o: object): number[];
 export declare function getSelectObjectKeys(o: T.Dict, v: any[]): string[];
 export declare function arrayContains(a: any[], item: any): boolean;
 export declare function objectContains(o: object, key: any): boolean;
-export declare function countEnumValues(enumName: any): number;
 export declare function shallowCopy(src: any): any;
 export declare function deepCopy(src: any): any;
 export declare function depthof(a: any): number;
+export declare function deepEqual(obj1: any, obj2: any, path?: string): boolean;

package/dist/valid.d.ts

@@ -1,5 +0,0 @@
-import * as T from './types';
-import { AnalyticsSession } from './_api';
-export declare function doIsComplete(s: AnalyticsSession, bLog?: boolean): T.TestEntry;
-export declare function doIsContiguous(s: AnalyticsSession, bLog?: boolean): T.TestEntry;
-export declare function doIsFreeOfHoles(s: AnalyticsSession, bLog?: boolean): T.TestEntry;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dra2020/district-analytics",
-  "version": "17.0.1",
+  "version": "17.1.0",
   "description": "District analytics TypeScript package",
   "main": "dist/district-analytics.js",
   "files": [
@@ -48,8 +48,8 @@
   },
   "dependencies": {
     "@dra2020/baseclient": "^1.0.166",
-    "@dra2020/dra-analytics": "^4.1.8",
+    "@dra2020/dra-analytics": "^5.0.0",
     "@dra2020/dra-types": "^1.8.149",
     "geojson": "^0.5.0"
   }
-}
+}