scout-types 1.0.8 → 1.0.10

package/dist/src/types/OfficeClass.d.ts

@@ -1,5 +1,5 @@
 import { JurisdictionLevel } from "./Jurisdiction.js";
-declare const office_class_ids: readonly ["ORG", "USH", "USS", "STG", "STH", "STS", "STB", "COG", "CIG", "LOB"];
+declare const office_class_ids: readonly ["NOR", "LOR", "USH", "USS", "STG", "STH", "STS", "STB", "COG", "CIG", "LOB"];
 export type OfficeClassID = typeof office_class_ids[number];
 export declare function is_office_class_id(office_class_id: any): office_class_id is OfficeClassID;
 export interface OfficeClass {

package/dist/src/types/OfficeClass.js

@@ -1,12 +1,22 @@
 import { JurisdictionLevel } from "./Jurisdiction.js";
-const office_class_ids = ["ORG", "USH", "USS", "STG", "STH", "STS", "STB", "COG", "CIG", "LOB"];
+const office_class_ids = ["NOR", "LOR", "USH", "USS", "STG", "STH", "STS", "STB", "COG", "CIG", "LOB"];
 export function is_office_class_id(office_class_id) {
     return office_class_ids.includes(office_class_id);
 }
 export const office_classes_by_office_class_id = {
-    "ORG": {
-        office_class_id: "ORG",
-        name: "Organization",
+    "NOR": {
+        office_class_id: "NOR",
+        name: "National Organization",
+        type: "organization",
+        office_id_template: "O-US",
+        jurisdiction_level: JurisdictionLevel.NATION,
+        jurisdictions_mutable: true,
+        require_district: false,
+        require_initial_jurisdiction: false
+    },
+    "LOR": {
+        office_class_id: "LOR",
+        name: "Local Organization",
         type: "organization",
         office_id_template: "O-[state_id]",
         jurisdictions_mutable: true,

package/dist/src/types/Scout.d.ts

@@ -13,6 +13,7 @@ export declare class Scout {
     readonly party_id: PartyID;
     readonly tone_description_refresh: boolean;
     readonly jurisdiction_ids: number[];
+    readonly sub_scout_ids: string[];
     readonly office_class_id: OfficeClassID;
     readonly office_name?: string;
     readonly [x: string]: any;
@@ -21,6 +22,7 @@ export declare class Scout {
 }
 export declare class ScoutAux extends Scout {
     readonly jurisdictions: Jurisdiction[];
+    readonly sub_scouts: Jurisdiction[];
     readonly photo_download_url?: string;
     readonly tone_description?: string;
     constructor(scout: any);

package/dist/src/types/Scout.js

@@ -13,6 +13,7 @@ export class Scout {
     party_id;
     tone_description_refresh;
     jurisdiction_ids;
+    sub_scout_ids;
     office_class_id;
     office_name;
     constructor(scout) {
@@ -29,6 +30,7 @@ export class Scout {
         this.party_id = scout.party_id;
         this.tone_description_refresh = scout.tone_description_refresh;
         this.jurisdiction_ids = scout.jurisdiction_ids;
+        this.sub_scout_ids = scout.sub_scout_ids;
         this.office_class_id = scout.office_class_id;
         this.office_name = scout.office_name;
     }
@@ -45,12 +47,15 @@ export class Scout {
             typeof scout.tone_description_refresh === "boolean" &&
             Array.isArray(scout.jurisdiction_ids) &&
             scout.jurisdiction_ids.every((jurisdiction_id) => typeof jurisdiction_id === "number") &&
+            Array.isArray(scout.sub_scout_ids) &&
+            scout.sub_scout_ids.every((sub_scout_id) => typeof sub_scout_id === "string") &&
             is_office_class_id(scout.office_class_id) &&
             (scout.office_name === undefined || typeof scout.office_name === "string"));
     }
 }
 export class ScoutAux extends Scout {
     jurisdictions;
+    sub_scouts;
     photo_download_url;
     tone_description;
     constructor(scout) {
@@ -59,6 +64,7 @@ export class ScoutAux extends Scout {
         }
         super(scout);
         this.jurisdictions = scout.jurisdictions;
+        this.sub_scouts = scout.sub_scouts;
         this.photo_download_url = scout.photo_download_url;
         this.tone_description = scout.tone_description;
     }
@@ -66,6 +72,8 @@ export class ScoutAux extends Scout {
         return (Scout.is(scout) &&
             Array.isArray(scout.jurisdictions) &&
             scout.jurisdictions.every(Jurisdiction.is) &&
+            Array.isArray(scout.sub_scouts) &&
+            scout.sub_scouts.every(Scout.is) &&
             (scout.photo_download_url === undefined || typeof scout.photo_download_url === "string") &&
             (scout.tone_description === undefined || typeof scout.tone_description === "string"));
     }

package/dist/src/types/Sources.d.ts

@@ -21,7 +21,7 @@ export declare class JurisdictionDocumentSource {
     constructor(jurisdiction_document_source: any);
     static is(jurisdiction_document_source: any): jurisdiction_document_source is JurisdictionDocumentSource;
 }
-export declare class BillSource {
+export declare class BillDocumentSource {
     readonly chunk_text: string;
     readonly description: string;
     readonly label: string;
@@ -29,7 +29,7 @@ export declare class BillSource {
     readonly vector_key: string;
     readonly bill: Bill;
     constructor(bill_document_source: any);
-    static is(bill_document_source: any): bill_document_source is BillSource;
+    static is(bill_document_source: any): bill_document_source is BillDocumentSource;
 }
 export declare class GrokSource {
     readonly title: string;
@@ -41,7 +41,7 @@ export declare class GrokSource {
     static is(grok_source: any): grok_source is GrokSource;
 }
 export declare class Sources {
-    readonly B: BillSource[];
+    readonly B: BillDocumentSource[];
     readonly S: ScoutDocumentSource[];
     readonly J: JurisdictionDocumentSource[];
     readonly G: GrokSource[];

package/dist/src/types/Sources.js

@@ -57,7 +57,7 @@ export class JurisdictionDocumentSource {
             JurisdictionDocument.is(jurisdiction_document_source.document));
     }
 }
-export class BillSource {
+export class BillDocumentSource {
     chunk_text;
     description;
     label;
@@ -65,7 +65,7 @@ export class BillSource {
     vector_key;
     bill;
     constructor(bill_document_source) {
-        if (!BillSource.is(bill_document_source)) {
+        if (!BillDocumentSource.is(bill_document_source)) {
             throw Error("Invalid input.");
         }
         this.chunk_text = bill_document_source.chunk_text;
@@ -127,7 +127,7 @@ export class Sources {
     static is(sources) {
         return (sources !== undefined &&
             Array.isArray(sources.B) &&
-            sources.B.every(BillSource.is) &&
+            sources.B.every(BillDocumentSource.is) &&
             Array.isArray(sources.S) &&
             sources.S.every(ScoutDocumentSource.is) &&
             Array.isArray(sources.J) &&

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "scout-types",
-    "version": "1.0.8",
+    "version": "1.0.10",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
     "directories": {

package/src/types/OfficeClass.ts

@@ -1,6 +1,6 @@
 import { JurisdictionLevel } from "./Jurisdiction"
 
-const office_class_ids = ["ORG", "USH", "USS", "STG", "STH", "STS", "STB", "COG", "CIG", "LOB"] as const
+const office_class_ids = ["NOR", "LOR", "USH", "USS", "STG", "STH", "STS", "STB", "COG", "CIG", "LOB"] as const
 
 export type OfficeClassID = typeof office_class_ids[number]
 
@@ -22,9 +22,19 @@ export interface OfficeClass {
 }
 
 export const office_classes_by_office_class_id : Record<OfficeClassID, OfficeClass> = {
-    "ORG" : {
-        office_class_id : "ORG",
-        name : "Organization",
+    "NOR" : {
+        office_class_id : "NOR",
+        name : "National Organization",
+        type : "organization",
+        office_id_template : "O-US",
+        jurisdiction_level : JurisdictionLevel.NATION,
+        jurisdictions_mutable : true,
+        require_district : false,
+        require_initial_jurisdiction : false
+    },
+    "LOR" : {
+        office_class_id : "LOR",
+        name : "Local Organization",
         type : "organization",
         office_id_template : "O-[state_id]",
         jurisdictions_mutable : true,

package/src/types/Scout.ts

@@ -14,6 +14,7 @@ export class Scout {
     readonly party_id : PartyID
     readonly tone_description_refresh : boolean
     readonly jurisdiction_ids : number[]
+    readonly sub_scout_ids : string[]
     readonly office_class_id : OfficeClassID
     readonly office_name? : string
     readonly [x : string] : any
@@ -32,6 +33,7 @@ export class Scout {
         this.party_id = scout.party_id
         this.tone_description_refresh = scout.tone_description_refresh
         this.jurisdiction_ids = scout.jurisdiction_ids
+        this.sub_scout_ids = scout.sub_scout_ids
         this.office_class_id = scout.office_class_id
         this.office_name = scout.office_name
     }
@@ -50,6 +52,8 @@ export class Scout {
             typeof scout.tone_description_refresh === "boolean" &&
             Array.isArray(scout.jurisdiction_ids) &&
             scout.jurisdiction_ids.every((jurisdiction_id : any) => typeof jurisdiction_id === "number") &&
+            Array.isArray(scout.sub_scout_ids) &&
+            scout.sub_scout_ids.every((sub_scout_id : any) => typeof sub_scout_id === "string") &&
             is_office_class_id(scout.office_class_id) &&
             (scout.office_name === undefined || typeof scout.office_name === "string")
         )
@@ -58,6 +62,7 @@ export class Scout {
 
 export class ScoutAux extends Scout {
     readonly jurisdictions : Jurisdiction[]
+    readonly sub_scouts : Jurisdiction[]
     readonly photo_download_url? : string
     readonly tone_description? : string
 
@@ -67,6 +72,7 @@ export class ScoutAux extends Scout {
         }
         super(scout)
         this.jurisdictions = scout.jurisdictions
+        this.sub_scouts = scout.sub_scouts
         this.photo_download_url = scout.photo_download_url
         this.tone_description = scout.tone_description
     }
@@ -76,6 +82,8 @@ export class ScoutAux extends Scout {
             Scout.is(scout) &&
             Array.isArray(scout.jurisdictions) &&
             scout.jurisdictions.every(Jurisdiction.is) &&
+            Array.isArray(scout.sub_scouts) &&
+            scout.sub_scouts.every(Scout.is) &&
             (scout.photo_download_url === undefined || typeof scout.photo_download_url === "string") &&
             (scout.tone_description === undefined || typeof scout.tone_description === "string")
         )

package/src/types/Sources.ts

@@ -68,7 +68,7 @@ export class JurisdictionDocumentSource {
     }
 }
 
-export class BillSource {
+export class BillDocumentSource {
     readonly chunk_text : string
     readonly description : string
     readonly label : string
@@ -77,7 +77,7 @@ export class BillSource {
     readonly bill : Bill
 
     constructor(bill_document_source : any) {
-        if (!BillSource.is(bill_document_source)) {
+        if (!BillDocumentSource.is(bill_document_source)) {
             throw Error("Invalid input.")
         }
         this.chunk_text = bill_document_source.chunk_text
@@ -88,7 +88,7 @@ export class BillSource {
         this.bill = bill_document_source.bill
     }
 
-    static is(bill_document_source : any) : bill_document_source is BillSource {
+    static is(bill_document_source : any) : bill_document_source is BillDocumentSource {
         return (
             bill_document_source !== undefined &&
             typeof bill_document_source.chunk_text === "string" &&
@@ -132,7 +132,7 @@ export class GrokSource {
 }
 
 export class Sources {
-    readonly B : BillSource[]
+    readonly B : BillDocumentSource[]
     readonly S : ScoutDocumentSource[]
     readonly J : JurisdictionDocumentSource[]
     readonly G : GrokSource[]
@@ -151,7 +151,7 @@ export class Sources {
         return (
             sources !== undefined &&
             Array.isArray(sources.B) &&
-            sources.B.every(BillSource.is) &&
+            sources.B.every(BillDocumentSource.is) &&
             Array.isArray(sources.S) &&
             sources.S.every(ScoutDocumentSource.is) &&
             Array.isArray(sources.J) &&