scout-types 1.0.0

package/dist/src/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./types/Scout.js";
+export * from "./types/ScoutDocument.js";
+export * from "./types/Conversation.js";
+export * from "./types/APIError.js";
+export * from "./types/ScoutConfig.js";
+export * from "./types/Jurisdiction.js";
+export * from "./types/JurisdictionDocument.js";
+export * from "./types/Message.js";
+export * from "./types/OfficeClass.js";
+export * from "./types/Party.js";
+export * from "./types/Sources.js";
+export * from "./types/State.js";
+export * from "./types/Tweet.js";
+export * from "./types/User.js";

package/dist/src/index.js

@@ -0,0 +1,14 @@
+export * from "./types/Scout.js";
+export * from "./types/ScoutDocument.js";
+export * from "./types/Conversation.js";
+export * from "./types/APIError.js";
+export * from "./types/ScoutConfig.js";
+export * from "./types/Jurisdiction.js";
+export * from "./types/JurisdictionDocument.js";
+export * from "./types/Message.js";
+export * from "./types/OfficeClass.js";
+export * from "./types/Party.js";
+export * from "./types/Sources.js";
+export * from "./types/State.js";
+export * from "./types/Tweet.js";
+export * from "./types/User.js";

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

@@ -0,0 +1,4 @@
+export declare class APIError extends Error {
+    status: number;
+    constructor(status: number, message?: string);
+}

package/dist/src/types/APIError.js

@@ -0,0 +1,19 @@
+const default_messages_by_status = {
+    400: "Bad Request",
+    401: "Unauthorized",
+    403: "Forbidden",
+    404: "Not Found",
+    405: "Method Not Allowed",
+    500: "Internal Server Error",
+    504: "Gateway Timeout",
+    600: "Failed to Parse Output"
+};
+export class APIError extends Error {
+    status;
+    constructor(status, message) {
+        const default_message = default_messages_by_status[status];
+        super(message !== undefined ? message : default_message !== undefined ? default_message : "Error");
+        this.name = "APIError";
+        this.status = status;
+    }
+}

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

@@ -0,0 +1,19 @@
+declare const bill_types: readonly ["HR", "S", "HJRES", "SJRES", "HCONRES", "SCONRES", "HRES", "SRES"];
+export type BillType = typeof bill_types[number];
+export declare function is_bill_type(bill_type: any): bill_type is BillType;
+export declare class Bill {
+    readonly congress_id: number;
+    readonly bill_id: string;
+    readonly type: string;
+    readonly number: number;
+    readonly title: string;
+    readonly intro_date?: string;
+    readonly policy_area_name?: string;
+    readonly committee_ids?: string[];
+    readonly xml_url?: string;
+    readonly s3_filename?: string;
+    readonly vector_keys?: string[];
+    constructor(bill: any);
+    static is(bill: any): bill is Bill;
+}
+export {};

package/dist/src/types/Bill.js

@@ -0,0 +1,47 @@
+const bill_types = ["HR", "S", "HJRES", "SJRES", "HCONRES", "SCONRES", "HRES", "SRES"];
+export function is_bill_type(bill_type) {
+    return bill_types.includes(bill_type);
+}
+export class Bill {
+    congress_id;
+    bill_id;
+    type;
+    number;
+    title;
+    intro_date;
+    policy_area_name;
+    committee_ids;
+    xml_url;
+    s3_filename;
+    vector_keys;
+    constructor(bill) {
+        if (!Bill.is(bill)) {
+            throw Error("Invalid input.");
+        }
+        this.congress_id = bill.congress_id;
+        this.bill_id = bill.bill_id;
+        this.type = bill.type;
+        this.number = bill.number;
+        this.title = bill.title;
+        this.intro_date = bill.intro_date;
+        this.policy_area_name = bill.policy_area_name;
+        this.committee_ids = bill.committee_ids;
+        this.xml_url = bill.xml_url;
+        this.s3_filename = bill.s3_filename;
+        this.vector_keys = bill.vector_keys;
+    }
+    static is(bill) {
+        return (bill !== undefined &&
+            typeof bill.congress_id === "number" &&
+            typeof bill.bill_id === "string" &&
+            typeof bill.type === "string" &&
+            typeof bill.number === "number" &&
+            typeof bill.title === "string" &&
+            (bill.intro_date === undefined || typeof bill.intro_date === "string") &&
+            (bill.policy_area_name === undefined || typeof bill.policy_area_name === "string") &&
+            (bill.committee_ids === undefined || Array.isArray(bill.committee_ids) && bill.committee_ids.every((committee_id) => typeof committee_id === "string")) &&
+            (bill.xml_url === undefined || typeof bill.xml_url === "string") &&
+            (bill.s3_filename === undefined || typeof bill.s3_filename === "string") &&
+            (bill.vector_keys === undefined || Array.isArray(bill.vector_keys) && bill.vector_keys.every((vector_key) => typeof vector_key === "string")));
+    }
+}

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

@@ -0,0 +1,28 @@
+import { OfficeClassID } from "./OfficeClass.js";
+import { Jurisdiction } from "./Jurisdiction.js";
+import { StateID } from "./State.js";
+import { PartyID } from "./Party.js";
+export declare class Bot {
+    readonly office_id: string;
+    readonly number: string;
+    readonly bot_id: string;
+    readonly name: string;
+    readonly active: boolean;
+    readonly state_id: StateID;
+    readonly district?: number;
+    readonly party_id: PartyID;
+    readonly tone_description_refresh: boolean;
+    readonly jurisdiction_ids: number[];
+    readonly office_class_id: OfficeClassID;
+    readonly office_name?: string;
+    readonly [x: string]: any;
+    constructor(bot: any);
+    static is(bot: any): bot is Bot;
+}
+export declare class BotAux extends Bot {
+    readonly jurisdictions: Jurisdiction[];
+    readonly photo_download_url?: string;
+    readonly tone_description?: string;
+    constructor(bot: any);
+    static is(bot: any): bot is BotAux;
+}

package/dist/src/types/Bot.js

@@ -0,0 +1,72 @@
+import { is_office_class_id } from "./OfficeClass.js";
+import { Jurisdiction } from "./Jurisdiction.js";
+import { is_state_id } from "./State.js";
+import { is_party_id } from "./Party.js";
+export class Bot {
+    office_id;
+    number;
+    bot_id;
+    name;
+    active;
+    state_id;
+    district;
+    party_id;
+    tone_description_refresh;
+    jurisdiction_ids;
+    office_class_id;
+    office_name;
+    constructor(bot) {
+        if (!Bot.is(bot)) {
+            throw Error("Invalid input.");
+        }
+        this.office_id = bot.office_id;
+        this.number = bot.number;
+        this.bot_id = bot.bot_id;
+        this.name = bot.name;
+        this.active = bot.active;
+        this.state_id = bot.state_id;
+        this.district = bot.district;
+        this.party_id = bot.party_id;
+        this.tone_description_refresh = bot.tone_description_refresh;
+        this.jurisdiction_ids = bot.jurisdiction_ids;
+        this.office_class_id = bot.office_class_id;
+        this.office_name = bot.office_name;
+    }
+    static is(bot) {
+        return (bot !== undefined &&
+            typeof bot.office_id === "string" &&
+            typeof bot.number === "string" &&
+            typeof bot.bot_id === "string" &&
+            typeof bot.name === "string" &&
+            typeof bot.active === "boolean" &&
+            is_state_id(bot.state_id) &&
+            (bot.district === undefined || typeof bot.district === "number") &&
+            is_party_id(bot.party_id) &&
+            typeof bot.tone_description_refresh === "boolean" &&
+            Array.isArray(bot.jurisdiction_ids) &&
+            bot.jurisdiction_ids.every((jurisdiction_id) => typeof jurisdiction_id === "number") &&
+            is_office_class_id(bot.office_class_id) &&
+            (bot.office_name === undefined || typeof bot.office_name === "string"));
+    }
+}
+export class BotAux extends Bot {
+    jurisdictions;
+    photo_download_url;
+    tone_description;
+    constructor(bot) {
+        if (!BotAux.is(bot)) {
+            throw Error("Invalid input.");
+        }
+        super(bot);
+        this.jurisdictions = bot.jurisdictions;
+        this.photo_download_url = bot.photo_download_url;
+        this.tone_description = bot.tone_description;
+    }
+    static is(bot) {
+        return (Bot.is(bot) &&
+            Array.isArray(bot.jurisdictions) &&
+            bot.jurisdictions.every(Jurisdiction.is) &&
+            (bot.photo_download_url === undefined || typeof bot.photo_download_url === "string") &&
+            (bot.tone_description === undefined || typeof bot.tone_description === "string"));
+    }
+}

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

@@ -0,0 +1,14 @@
+import { Tweet } from "./Tweet.js";
+export declare class BotDocument {
+    readonly bot_id: string;
+    readonly document_id: string;
+    readonly type: "URL" | "TWEET" | "TWITTER";
+    readonly s3_filename?: string;
+    readonly url?: string;
+    readonly username?: string;
+    readonly vector_keys?: string[];
+    readonly tweet?: Tweet;
+    readonly text?: string;
+    constructor(bot_document: any);
+    static is(bot_document: any): bot_document is BotDocument;
+}

package/dist/src/types/BotDocument.js

@@ -0,0 +1,38 @@
+import { Tweet } from "./Tweet.js";
+export class BotDocument {
+    bot_id;
+    document_id;
+    type;
+    s3_filename;
+    url;
+    username;
+    vector_keys;
+    tweet;
+    text;
+    constructor(bot_document) {
+        if (!BotDocument.is(bot_document)) {
+            throw Error("Invalid input.");
+        }
+        this.bot_id = bot_document.bot_id;
+        this.document_id = bot_document.document_id;
+        this.type = bot_document.type;
+        this.s3_filename = bot_document.s3_filename;
+        this.url = bot_document.url;
+        this.username = bot_document.username;
+        this.vector_keys = bot_document.vector_keys;
+        this.tweet = bot_document.tweet;
+        this.text = bot_document.text;
+    }
+    static is(bot_document) {
+        return (bot_document !== undefined &&
+            typeof bot_document.bot_id === "string" &&
+            typeof bot_document.document_id === "string" &&
+            typeof bot_document.type === "string" &&
+            (bot_document.s3_filename === undefined || typeof bot_document.s3_filename === "string") &&
+            (bot_document.url === undefined || typeof bot_document.url === "string") &&
+            (bot_document.username === undefined || typeof bot_document.username === "string") &&
+            (bot_document.vector_keys === undefined || Array.isArray(bot_document.vector_keys) && bot_document.vector_keys.every((vector_key) => typeof vector_key === "string")) &&
+            (bot_document.tweet === undefined || Tweet.is(bot_document.tweet)) &&
+            (bot_document.text === undefined || typeof bot_document.text === "string"));
+    }
+}

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

@@ -0,0 +1,16 @@
+import { Message } from "./Message.js";
+export declare class Conversation {
+    readonly user_id: string;
+    readonly conversation_id: string;
+    readonly scout_id: string;
+    readonly time: string;
+    readonly [x: string]: any;
+    constructor(conversation: any);
+    static is(conversation: any): conversation is Conversation;
+}
+export declare class ConversationAux extends Conversation {
+    readonly messages: Message[];
+    readonly max_action_time: string;
+    constructor(conversation: any);
+    static is(conversation: any): conversation is ConversationAux;
+}

package/dist/src/types/Conversation.js

@@ -0,0 +1,41 @@
+import { Message } from "./Message.js";
+export class Conversation {
+    user_id;
+    conversation_id;
+    scout_id;
+    time;
+    constructor(conversation) {
+        if (!Conversation.is(conversation)) {
+            throw Error("Invalid input.");
+        }
+        this.user_id = conversation.user_id;
+        this.conversation_id = conversation.conversation_id;
+        this.scout_id = conversation.scout_id;
+        this.time = conversation.time;
+    }
+    static is(conversation) {
+        return (conversation !== undefined &&
+            typeof conversation.user_id === "string" &&
+            typeof conversation.conversation_id === "string" &&
+            typeof conversation.scout_id === "string" &&
+            typeof conversation.time === "string");
+    }
+}
+export class ConversationAux extends Conversation {
+    messages;
+    max_action_time;
+    constructor(conversation) {
+        if (!ConversationAux.is(conversation)) {
+            throw Error("Invalid input.");
+        }
+        super(conversation);
+        this.messages = conversation.messages;
+        this.max_action_time = conversation.max_action_time;
+    }
+    static is(conversation) {
+        return (Conversation.is(conversation) &&
+            Array.isArray(conversation.messages) &&
+            conversation.messages.every(Message.is) &&
+            typeof conversation.max_action_time === "string");
+    }
+}

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

@@ -0,0 +1,4 @@
+export declare class DoersAPIError extends Error {
+    status: number;
+    constructor(status: number, message?: string);
+}

package/dist/src/types/DoersAPIError.js

@@ -0,0 +1,19 @@
+const default_messages_by_status = {
+    400: "Bad Request",
+    401: "Unauthorized",
+    403: "Forbidden",
+    404: "Not Found",
+    405: "Method Not Allowed",
+    500: "Internal Server Error",
+    504: "Gateway Timeout",
+    600: "Failed to Parse Output"
+};
+export class DoersAPIError extends Error {
+    status;
+    constructor(status, message) {
+        const default_message = default_messages_by_status[status];
+        super(message !== undefined ? message : default_message !== undefined ? default_message : "Error");
+        this.name = "DoersAPIError";
+        this.status = status;
+    }
+}

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

@@ -0,0 +1,27 @@
+export interface DoersIQUtilsConfig {
+    region: string;
+    scraping_bee_api_key?: string;
+    xai_api_key?: string;
+    citizenportal_api_key?: string;
+    [key: string]: any;
+}
+export interface DoersIQConfig extends DoersIQUtilsConfig {
+    port: number;
+    api_url: string;
+    client_url: string;
+    auth_url: string;
+    cognito_user_pool_id: string;
+    cognito_client_id: string;
+    cognito_client_secret: string;
+    secret_key: string;
+    admin_key: string;
+    dynamodb_bots: string;
+    dynamodb_bot_documents: string;
+    dynamodb_conversations: string;
+    dynamodb_jurisdictions: string;
+    dynamodb_jurisdiction_documents: string;
+    dynamodb_messages: string;
+    dynamodb_users: string;
+    s3_bucket: string;
+    s3vectors_bucket: string;
+}

package/dist/src/types/DoersIQConfig.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,24 @@
+export declare enum JurisdictionLevel {
+    OTHER = 0,
+    NATION = 1,
+    STATE = 2,
+    COUNTY = 3,
+    CITY = 4,
+    SCHOOL = 5
+}
+export declare function is_jurisdiction_level(jurisdiction_level: any): jurisdiction_level is JurisdictionLevel;
+export declare class Jurisdiction {
+    readonly jurisdiction_id: number;
+    readonly name: string;
+    readonly path: number[];
+    readonly sub_jurisdiction_ids: number[];
+    readonly super_jurisdiction_id?: number;
+    readonly level: JurisdictionLevel;
+    readonly state_jurisdiction_id?: number;
+    readonly county_jurisdiction_id?: number;
+    readonly city_jurisdiction_id?: number;
+    readonly school_jurisdiction_id?: number;
+    readonly geographic: boolean;
+    constructor(jurisdiction: any);
+    static is(jurisdiction: any): jurisdiction is Jurisdiction;
+}

package/dist/src/types/Jurisdiction.js

@@ -0,0 +1,57 @@
+export var JurisdictionLevel;
+(function (JurisdictionLevel) {
+    JurisdictionLevel[JurisdictionLevel["OTHER"] = 0] = "OTHER";
+    JurisdictionLevel[JurisdictionLevel["NATION"] = 1] = "NATION";
+    JurisdictionLevel[JurisdictionLevel["STATE"] = 2] = "STATE";
+    JurisdictionLevel[JurisdictionLevel["COUNTY"] = 3] = "COUNTY";
+    JurisdictionLevel[JurisdictionLevel["CITY"] = 4] = "CITY";
+    JurisdictionLevel[JurisdictionLevel["SCHOOL"] = 5] = "SCHOOL";
+})(JurisdictionLevel || (JurisdictionLevel = {}));
+export function is_jurisdiction_level(jurisdiction_level) {
+    return [0, 1, 2, 3, 4, 5].includes(jurisdiction_level);
+}
+export class Jurisdiction {
+    jurisdiction_id;
+    name;
+    path;
+    sub_jurisdiction_ids;
+    super_jurisdiction_id;
+    level;
+    state_jurisdiction_id;
+    county_jurisdiction_id;
+    city_jurisdiction_id;
+    school_jurisdiction_id;
+    geographic;
+    constructor(jurisdiction) {
+        if (!Jurisdiction.is(jurisdiction)) {
+            throw Error("Invalid input.");
+        }
+        this.jurisdiction_id = jurisdiction.jurisdiction_id;
+        this.name = jurisdiction.name;
+        this.path = jurisdiction.path;
+        this.sub_jurisdiction_ids = jurisdiction.sub_jurisdiction_ids;
+        this.super_jurisdiction_id = jurisdiction.super_jurisdiction_id;
+        this.level = jurisdiction.level;
+        this.state_jurisdiction_id = jurisdiction.state_jurisdiction_id;
+        this.county_jurisdiction_id = jurisdiction.county_jurisdiction_id;
+        this.city_jurisdiction_id = jurisdiction.city_jurisdiction_id;
+        this.school_jurisdiction_id = jurisdiction.school_jurisdiction_id;
+        this.geographic = jurisdiction.geographic;
+    }
+    static is(jurisdiction) {
+        return (jurisdiction !== undefined &&
+            typeof jurisdiction.jurisdiction_id === "number" &&
+            typeof jurisdiction.name === "string" &&
+            Array.isArray(jurisdiction.path) &&
+            jurisdiction.path.every((jurisdiction_id) => typeof jurisdiction_id === "number") &&
+            Array.isArray(jurisdiction.sub_jurisdiction_ids) &&
+            jurisdiction.sub_jurisdiction_ids.every((jurisdiction_id) => typeof jurisdiction_id === "number") &&
+            is_jurisdiction_level(jurisdiction.level) &&
+            typeof jurisdiction.geographic === "boolean" &&
+            (jurisdiction.super_jurisdiction_id === undefined || typeof jurisdiction.super_jurisdiction_id === "number") &&
+            (jurisdiction.state_jurisdiction_id === undefined || typeof jurisdiction.state_jurisdiction_id === "number") &&
+            (jurisdiction.county_jurisdiction_id === undefined || typeof jurisdiction.county_jurisdiction_id === "number") &&
+            (jurisdiction.city_jurisdiction_id === undefined || typeof jurisdiction.city_jurisdiction_id === "number") &&
+            (jurisdiction.school_jurisdiction_id === undefined || typeof jurisdiction.school_jurisdiction_id === "number"));
+    }
+}

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

@@ -0,0 +1,15 @@
+export declare class JurisdictionDocument {
+    readonly jurisdiction_id: number;
+    readonly document_id: string;
+    readonly media_id: string;
+    readonly origin: string;
+    readonly s3_filename?: string;
+    readonly time?: string;
+    readonly title: string;
+    readonly type: string;
+    readonly url: string;
+    readonly vector_keys?: string[];
+    readonly location?: string;
+    constructor(jurisdiction_document: any);
+    static is(jurisdiction_document: any): jurisdiction_document is JurisdictionDocument;
+}

package/dist/src/types/JurisdictionDocument.js

@@ -0,0 +1,44 @@
+export class JurisdictionDocument {
+    jurisdiction_id;
+    document_id;
+    media_id;
+    origin;
+    s3_filename;
+    time;
+    title;
+    type;
+    url;
+    vector_keys;
+    location;
+    constructor(jurisdiction_document) {
+        if (!JurisdictionDocument.is(jurisdiction_document)) {
+            throw Error("Invalid input.");
+        }
+        this.jurisdiction_id = jurisdiction_document.jurisdiction_id;
+        this.document_id = jurisdiction_document.document_id;
+        this.media_id = jurisdiction_document.media_id;
+        this.origin = jurisdiction_document.origin;
+        this.s3_filename = jurisdiction_document.s3_filename;
+        this.time = jurisdiction_document.time;
+        this.title = jurisdiction_document.title;
+        this.type = jurisdiction_document.type;
+        this.url = jurisdiction_document.url;
+        this.vector_keys = jurisdiction_document.vector_keys;
+        this.location = jurisdiction_document.location;
+    }
+    static is(jurisdiction_document) {
+        return (jurisdiction_document !== undefined &&
+            typeof jurisdiction_document.jurisdiction_id === "number" &&
+            typeof jurisdiction_document.document_id === "string" &&
+            typeof jurisdiction_document.media_id === "string" &&
+            typeof jurisdiction_document.origin === "string" &&
+            (jurisdiction_document.s3_filename === undefined || typeof jurisdiction_document.s3_filename === "string") &&
+            (jurisdiction_document.time === undefined || typeof jurisdiction_document.time === "string") &&
+            typeof jurisdiction_document.title === "string" &&
+            typeof jurisdiction_document.type === "string" &&
+            typeof jurisdiction_document.url === "string" &&
+            (jurisdiction_document.vector_keys === undefined || Array.isArray(jurisdiction_document.vector_keys) &&
+                jurisdiction_document.vector_keys.every((vector_key) => typeof vector_key === "string")) &&
+            (jurisdiction_document.location === undefined || typeof jurisdiction_document.location === "string"));
+    }
+}

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

@@ -0,0 +1,23 @@
+import { Sources } from "./Sources.js";
+export declare class Fragment {
+    readonly text: string;
+    readonly sources: Sources;
+    constructor(fragment: any);
+    static is(fragment: any): fragment is Fragment;
+}
+export declare class Message {
+    readonly user_id: string;
+    readonly message_id: string;
+    readonly scout_id: string;
+    readonly conversation_id: string;
+    readonly time: string;
+    readonly mode: "chat" | "write";
+    readonly role: "user" | "scout";
+    readonly system_prompt?: string;
+    readonly grok_text?: string;
+    readonly fragments?: Fragment[];
+    readonly sources?: Sources;
+    readonly text: string;
+    constructor(message: any);
+    static is(message: any): message is Message;
+}

package/dist/src/types/Message.js

@@ -0,0 +1,63 @@
+import { Sources } from "./Sources.js";
+export class Fragment {
+    text;
+    sources;
+    constructor(fragment) {
+        if (!Fragment.is(fragment)) {
+            throw Error("Invalid input.");
+        }
+        this.text = fragment.text;
+        this.sources = fragment.sources;
+    }
+    static is(fragment) {
+        return (fragment !== undefined &&
+            typeof fragment.text === "string" &&
+            Sources.is(fragment.sources));
+    }
+}
+export class Message {
+    user_id;
+    message_id;
+    scout_id;
+    conversation_id;
+    time;
+    mode;
+    role;
+    system_prompt;
+    grok_text;
+    fragments;
+    sources;
+    text;
+    constructor(message) {
+        if (!Message.is(message)) {
+            throw Error("Invalid input.");
+        }
+        this.user_id = message.user_id;
+        this.message_id = message.message_id;
+        this.scout_id = message.scout_id;
+        this.conversation_id = message.conversation_id;
+        this.time = message.time;
+        this.mode = message.mode;
+        this.role = message.role;
+        this.system_prompt = message.system_prompt;
+        this.grok_text = message.grok_text;
+        this.fragments = message.fragments;
+        this.sources = message.sources;
+        this.text = message.text;
+    }
+    static is(message) {
+        return (message !== undefined &&
+            typeof message.user_id === "string" &&
+            typeof message.message_id === "string" &&
+            typeof message.scout_id === "string" &&
+            typeof message.conversation_id === "string" &&
+            typeof message.time === "string" &&
+            ["chat", "write"].includes(message.mode) &&
+            ["user", "scout"].includes(message.role) &&
+            (message.system_prompt === undefined || typeof message.system_prompt === "string") &&
+            (message.grok_text === undefined || typeof message.grok_text === "string") &&
+            (message.fragments === undefined || Array.isArray(message.fragments) && message.fragments.every(Fragment.is)) &&
+            (message.sources === undefined || Sources.is(message.sources)) &&
+            typeof message.text === "string");
+    }
+}

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

@@ -0,0 +1,17 @@
+import { JurisdictionLevel } from "./Jurisdiction.js";
+declare const office_class_ids: readonly ["ORG", "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 {
+    office_class_id: OfficeClassID;
+    name: string;
+    type: "candidate" | "organization";
+    office_id_template: string;
+    jurisdiction_level?: JurisdictionLevel;
+    jurisdictions_mutable: Boolean;
+    require_district: Boolean;
+    require_initial_jurisdiction: Boolean;
+    office_names?: string[];
+}
+export declare const office_classes_by_office_class_id: Record<OfficeClassID, OfficeClass>;
+export {};