triangle-types 1.0.18 → 1.0.20

package/dist/src/index.d.ts

@@ -41,6 +41,7 @@ export * from "./types/federal_rules/FederalRuleTitle.js";
 export * from "./types/federal_rules/FederalRuleSection.js";
 export * from "./types/scout/Scout.js";
 export * from "./types/scout/ScoutDocument.js";
+export * from "./types/scout/ScoutSubScout.js";
 export * from "./types/scout/ScoutTag.js";
 export * from "./types/scout/UserScout.js";
 export * from "./types/scout/UserScoutConversation.js";

package/dist/src/index.js

@@ -41,6 +41,7 @@ export * from "./types/federal_rules/FederalRuleTitle.js";
 export * from "./types/federal_rules/FederalRuleSection.js";
 export * from "./types/scout/Scout.js";
 export * from "./types/scout/ScoutDocument.js";
+export * from "./types/scout/ScoutSubScout.js";
 export * from "./types/scout/ScoutTag.js";
 export * from "./types/scout/UserScout.js";
 export * from "./types/scout/UserScoutConversation.js";

package/dist/src/types/federal_rules/FederalRuleSection.d.ts

@@ -3,7 +3,7 @@ export declare class FederalRuleSection {
     readonly federal_rule_title_id: number;
     readonly section_id: string;
     readonly part_id: string;
-    readonly sub_part_id?: string;
+    readonly subpart_id?: string;
     readonly name: string;
     readonly is_substantive: boolean;
     readonly is_removed: boolean;

package/dist/src/types/federal_rules/FederalRuleSection.js

@@ -3,7 +3,7 @@ export class FederalRuleSection {
     federal_rule_title_id;
     section_id;
     part_id;
-    sub_part_id;
+    subpart_id;
     name;
     is_substantive;
     is_removed;
@@ -16,7 +16,7 @@ export class FederalRuleSection {
         this.federal_rule_title_id = federal_rule_section.federal_rule_title_id;
         this.section_id = federal_rule_section.section_id;
         this.part_id = federal_rule_section.part_id;
-        this.sub_part_id = federal_rule_section.sub_part_id;
+        this.subpart_id = federal_rule_section.subpart_id;
         this.name = federal_rule_section.name;
         this.is_substantive = federal_rule_section.is_substantive;
         this.is_removed = federal_rule_section.is_removed;
@@ -28,7 +28,7 @@ export class FederalRuleSection {
             typeof federal_rule_section.federal_rule_title_id === "number" && !isNaN(federal_rule_section.federal_rule_title_id) &&
             typeof federal_rule_section.section_id === "string" &&
             typeof federal_rule_section.part_id === "string" &&
-            (federal_rule_section.sub_part_id === undefined || typeof federal_rule_section.sub_part_id === "string") &&
+            (federal_rule_section.subpart_id === undefined || typeof federal_rule_section.subpart_id === "string") &&
             typeof federal_rule_section.name === "string" &&
             typeof federal_rule_section.is_substantive === "boolean" &&
             typeof federal_rule_section.is_removed === "boolean" &&

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

@@ -1,3 +1,4 @@
+import { StateID } from "../State.js";
 declare const scout_type_ids: readonly ["I", "O"];
 export type ScoutTypeID = typeof scout_type_ids[number];
 export declare function is_scout_type_id(scout_type_id: any): scout_type_id is ScoutTypeID;
@@ -10,4 +11,19 @@ export declare class Scout {
     constructor(scout: any);
     static is(scout: any): scout is Scout;
 }
+export declare class ScoutAux extends Scout {
+    readonly s3_url_jpeg?: string;
+    constructor(scout: any);
+    static is(scout: any): scout is ScoutAux;
+}
+declare const scout_office_ids: readonly ["USP", "USH", "USS", "STG", "STH", "STS"];
+export type ScoutOfficeID = typeof scout_office_ids[number];
+export declare function is_scout_office_id(scout_office_id: any): scout_office_id is ScoutOfficeID;
+export declare class IndividualScout extends Scout {
+    readonly office_id: ScoutOfficeID;
+    readonly state_id?: StateID;
+    readonly district?: number;
+    constructor(scout: any);
+    static is(scout: any): scout is ScoutAux;
+}
 export {};

package/dist/src/types/scout/Scout.js

@@ -24,19 +24,41 @@ export class Scout {
             (scout.s3_id_jpeg === undefined || typeof scout.s3_id_jpeg === "string"));
     }
 }
-// export class ScoutAux extends Scout {
-//     readonly photo_url? : string
-//     constructor(scout : any) {
-//         if (!ScoutAux.is(scout)) {
-//             throw Error("Invalid input.")
-//         }
-//         super(scout)
-//         this.photo_url = scout.photo_url
-//     }
-//     static is(scout : any) : scout is ScoutAux {
-//         return (
-//             Scout.is(scout) &&
-//             (scout.photo_url === undefined || typeof scout.photo_url === "string")
-//         )
-//     }
-// }
+export class ScoutAux extends Scout {
+    s3_url_jpeg;
+    constructor(scout) {
+        if (!ScoutAux.is(scout)) {
+            throw Error("Invalid input.");
+        }
+        super(scout);
+        this.s3_url_jpeg = scout.s3_url_jpeg;
+    }
+    static is(scout) {
+        return (Scout.is(scout) &&
+            (scout.s3_url_jpeg === undefined || typeof scout.s3_url_jpeg === "string"));
+    }
+}
+const scout_office_ids = ["USP", "USH", "USS", "STG", "STH", "STS"];
+export function is_scout_office_id(scout_office_id) {
+    return scout_office_ids.includes(scout_office_id);
+}
+export class IndividualScout extends Scout {
+    office_id;
+    state_id;
+    district;
+    constructor(scout) {
+        if (!ScoutAux.is(scout)) {
+            throw Error("Invalid input.");
+        }
+        super(scout);
+        this.office_id = scout.office_id;
+        this.state_id = scout.state_id;
+        this.district = scout.district;
+    }
+    static is(scout) {
+        return (Scout.is(scout) &&
+            is_scout_office_id(scout.office_id) &&
+            (scout.state_id === undefined || typeof scout.state_id === "string") &&
+            (scout.district === undefined || typeof scout.district === "number"));
+    }
+}

package/dist/src/types/scout/ScoutSubScout.d.ts

@@ -0,0 +1,7 @@
+export declare class ScoutSubScout {
+    readonly scout_id: string;
+    readonly sub_scout_id: string;
+    readonly [x: string]: any;
+    constructor(scout_sub_scout: ScoutSubScout);
+    static is(scout_sub_scout: any): scout_sub_scout is ScoutSubScout;
+}

package/dist/src/types/scout/ScoutSubScout.js

@@ -0,0 +1,16 @@
+export class ScoutSubScout {
+    scout_id;
+    sub_scout_id;
+    constructor(scout_sub_scout) {
+        if (!ScoutSubScout.is(scout_sub_scout)) {
+            throw Error("Invalid input.");
+        }
+        this.scout_id = scout_sub_scout.scout_id;
+        this.sub_scout_id = scout_sub_scout.sub_scout_id;
+    }
+    static is(scout_sub_scout) {
+        return (scout_sub_scout !== undefined &&
+            typeof scout_sub_scout.scout_id === "string" &&
+            typeof scout_sub_scout.sub_scout_id === "string");
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "triangle-types",
-    "version": "1.0.18",
+    "version": "1.0.20",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
     "scripts": {

package/src/index.ts

@@ -49,6 +49,7 @@ export * from "./types/federal_rules/FederalRuleSection"
 
 export * from "./types/scout/Scout"
 export * from "./types/scout/ScoutDocument"
+export * from "./types/scout/ScoutSubScout"
 export * from "./types/scout/ScoutTag"
 export * from "./types/scout/UserScout"
 export * from "./types/scout/UserScoutConversation"

package/src/types/federal_rules/FederalRuleSection.ts

@@ -3,7 +3,7 @@ export class FederalRuleSection {
     readonly federal_rule_title_id : number
     readonly section_id : string
     readonly part_id : string
-    readonly sub_part_id? : string
+    readonly subpart_id? : string
     readonly name : string
     readonly is_substantive : boolean
     readonly is_removed : boolean
@@ -18,7 +18,7 @@ export class FederalRuleSection {
         this.federal_rule_title_id = federal_rule_section.federal_rule_title_id
         this.section_id = federal_rule_section.section_id
         this.part_id = federal_rule_section.part_id
-        this.sub_part_id = federal_rule_section.sub_part_id
+        this.subpart_id = federal_rule_section.subpart_id
         this.name = federal_rule_section.name
         this.is_substantive = federal_rule_section.is_substantive
         this.is_removed = federal_rule_section.is_removed
@@ -32,7 +32,7 @@ export class FederalRuleSection {
             typeof federal_rule_section.federal_rule_title_id === "number" && !isNaN(federal_rule_section.federal_rule_title_id) &&
             typeof federal_rule_section.section_id === "string" &&
             typeof federal_rule_section.part_id === "string" &&
-            (federal_rule_section.sub_part_id === undefined || typeof federal_rule_section.sub_part_id === "string") &&
+            (federal_rule_section.subpart_id === undefined || typeof federal_rule_section.subpart_id === "string") &&
             typeof federal_rule_section.name === "string" &&
             typeof federal_rule_section.is_substantive === "boolean" &&
             typeof federal_rule_section.is_removed === "boolean" &&

package/src/types/scout/Scout.ts

@@ -1,3 +1,5 @@
+import { StateID } from "../State"
+
 const scout_type_ids = ["I", "O"] as const
 
 export type ScoutTypeID = typeof scout_type_ids[number]
@@ -34,21 +36,54 @@ export class Scout {
     }
 }
 
-// export class ScoutAux extends Scout {
-//     readonly photo_url? : string
-
-//     constructor(scout : any) {
-//         if (!ScoutAux.is(scout)) {
-//             throw Error("Invalid input.")
-//         }
-//         super(scout)
-//         this.photo_url = scout.photo_url
-//     }
-
-//     static is(scout : any) : scout is ScoutAux {
-//         return (
-//             Scout.is(scout) &&
-//             (scout.photo_url === undefined || typeof scout.photo_url === "string")
-//         )
-//     }
-// }
+export class ScoutAux extends Scout {
+    readonly s3_url_jpeg? : string
+
+    constructor(scout : any) {
+        if (!ScoutAux.is(scout)) {
+            throw Error("Invalid input.")
+        }
+        super(scout)
+        this.s3_url_jpeg = scout.s3_url_jpeg
+    }
+
+    static is(scout : any) : scout is ScoutAux {
+        return (
+            Scout.is(scout) &&
+            (scout.s3_url_jpeg === undefined || typeof scout.s3_url_jpeg === "string")
+        )
+    }
+}
+
+const scout_office_ids = ["USP", "USH", "USS", "STG", "STH", "STS"] as const
+
+export type ScoutOfficeID = typeof scout_office_ids[number]
+
+export function is_scout_office_id(scout_office_id : any) : scout_office_id is ScoutOfficeID {
+    return scout_office_ids.includes(scout_office_id)
+}
+
+export class IndividualScout extends Scout {
+    readonly office_id : ScoutOfficeID
+    readonly state_id? : StateID
+    readonly district? : number
+
+    constructor(scout : any) {
+        if (!ScoutAux.is(scout)) {
+            throw Error("Invalid input.")
+        }
+        super(scout)
+        this.office_id = scout.office_id
+        this.state_id = scout.state_id
+        this.district = scout.district
+    }
+
+    static is(scout : any) : scout is ScoutAux {
+        return (
+            Scout.is(scout) &&
+            is_scout_office_id(scout.office_id) &&
+            (scout.state_id === undefined || typeof scout.state_id === "string") &&
+            (scout.district === undefined || typeof scout.district === "number")
+        )
+    }
+}

package/src/types/scout/ScoutSubScout.ts

@@ -0,0 +1,21 @@
+export class ScoutSubScout {
+    readonly scout_id : string
+    readonly sub_scout_id : string
+    readonly [x : string] : any
+
+    constructor(scout_sub_scout : ScoutSubScout) {
+        if (!ScoutSubScout.is(scout_sub_scout)) {
+            throw Error("Invalid input.")
+        }
+        this.scout_id = scout_sub_scout.scout_id
+        this.sub_scout_id = scout_sub_scout.sub_scout_id
+    }
+
+    static is(scout_sub_scout : any) : scout_sub_scout is ScoutSubScout {
+        return (
+            scout_sub_scout !== undefined &&
+            typeof scout_sub_scout.scout_id === "string" &&
+            typeof scout_sub_scout.sub_scout_id === "string"
+        )
+    }
+}