@dra2020/district-analytics 2.0.7 → 3.0.0

package/dist/src/_api.d.ts

@@ -1,4 +1,6 @@
-import { PlanAnalytics, DistrictStatistics } from './results';
+import * as Score from '@dra2020/dra-score';
+import { RequirementsChecklist } from './results';
+import { DistrictStatistics } from './results';
 import * as D from './_data';
 import * as T from './types';
 export declare class AnalyticsSession {
@@ -10,6 +12,8 @@ export declare class AnalyticsSession {
     bPostProcessingDone: boolean;
     testScales: T.TestScales;
     tests: T.TestEntries;
+    _profile?: Score.Profile;
+    _scorecard?: Score.Scorecard;
     state: D.State;
     counties: D.Counties;
     graph: D.Graph;
@@ -19,8 +23,10 @@ export declare class AnalyticsSession {
     constructor(SessionRequest: T.SessionRequest);
     processConfig(config: T.Dict): T.Dict;
     analyzePlan(bLog?: boolean): boolean;
-    getPlanAnalytics(bLog?: boolean): PlanAnalytics;
     getDistrictStatistics(bLog?: boolean): DistrictStatistics;
+    getPlanProfile(bLog?: boolean): Score.Profile;
+    getPlanScorecard(bLog?: boolean): Score.Scorecard;
+    getRequirementsChecklist(bLog?: boolean): RequirementsChecklist;
     getDiscontiguousDistrictFeatures(bLog?: boolean): T.GeoFeatureCollection;
     getTest(testID: T.Test): T.TestEntry;
     populationDeviationThreshold(): number;

package/dist/src/results.d.ts

@@ -1,5 +1,26 @@
 import * as T from './types';
 import { AnalyticsSession } from './_api';
+export declare type RequirementsChecklist = {
+    score: T.TriState;
+    metrics: {
+        complete: T.TriState;
+        contiguous: T.TriState;
+        freeOfHoles: T.TriState;
+        equalPopulation: T.TriState;
+    };
+    details: {
+        unassignedFeatures: string[];
+        emptyDistricts: number[];
+        discontiguousDistricts: number[];
+        embeddedDistricts: number[];
+        populationDeviation: number;
+        deviationThreshold: number;
+    };
+    datasets: T.Datasets;
+    resources: {
+        stateReqs: string;
+    };
+};
 export declare type RequirementsCategory = {
     score: T.TriState;
     metrics: {
@@ -90,7 +111,7 @@ export declare type PlanAnalytics = {
     minority: MinorityCategory;
 };
 export declare const samplePlanAnalytics: PlanAnalytics;
-export declare function preparePlanAnalytics(s: AnalyticsSession, bLog?: boolean): PlanAnalytics;
+export declare function prepareRequirementsChecklist(s: AnalyticsSession, bLog?: boolean): RequirementsChecklist;
 export declare const enum DistrictColumn {
     DistrictID = 0,
     TotalPop = 1,

package/dist/src/score.d.ts

@@ -0,0 +1,4 @@
+import * as Score from '@dra2020/dra-score';
+import { AnalyticsSession } from './_api';
+export declare function profilePlan(s: AnalyticsSession, bLog?: boolean): Score.Profile;
+export declare function scorePlan(p: Score.Profile, bLog?: boolean): Score.Scorecard;

package/dist/src/types.d.ts

@@ -99,11 +99,10 @@ export declare const enum DistrictShapeProperty {
     Perimeter = 2
 }
 export declare type GeoIDParts = {
-    state?: string;
-    county?: string;
-    tract?: string;
-    bg?: string;
-    block?: string;
+    vfeature?: boolean;
+    state: string;
+    county: string;
+    rest: string;
 };
 export declare type GeoIDTotal = {
     [geoID: string]: number;
@@ -122,3 +121,4 @@ export declare type Datasets = {
     vap?: string;
     election?: string;
 };
+export { Profile, Scorecard, PopulationProfile, ShapeProfile, SplittingProfile, PartisanProfile, sampleProfile, sampleScorecard } from '@dra2020/dra-score';

package/dist/src/utils.d.ts

@@ -3,7 +3,6 @@ export declare function isInState(geoID: string): boolean;
 export declare function isOutOfState(geoID: string): boolean;
 export declare function getDistrict(plan: T.PlanByGeoID, geoID: string): number | undefined;
 export declare function parseGeoID(geoID: string): T.GeoIDParts;
-export declare function getFIPSFromCountyGeoID(geoID: string): string;
 export declare function isWaterOnly(geoID: string): boolean;
 export declare function normalize(rawScore: number, testScale: T.TestScale): number;
 export declare function trim(fullFraction: number, digits?: number | undefined): number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dra2020/district-analytics",
-  "version": "2.0.7",
+  "version": "3.0.0",
   "description": "District analytics TypeScript package",
   "main": "dist/district-analytics.js",
   "files": [
@@ -48,6 +48,7 @@
     "yargs": "^12.0.5"
   },
   "dependencies": {
+    "@dra2020/dra-score": "^1.3.2",
     "@dra2020/poly": "1.0.9",
     "@dra2020/util": "1.0.24",
     "csv-parse": "^4.4.5",