triage-types 1.0.93 → 1.0.94

package/dist/src/index.d.ts

@@ -1,5 +1,7 @@
 export * from "./types/APIError.js";
 export * from "./types/State.js";
+export * from "./types/federal_register/FederalRegisterAgency.js";
+export * from "./types/federal_register/FederalRegisterDocument.js";
 export * from "./types/federal_dockets/FederalDocketAgency.js";
 export * from "./types/federal_dockets/FederalDocket.js";
 export * from "./types/federal_dockets/FederalDocketDocument.js";

package/dist/src/index.js

@@ -1,5 +1,7 @@
 export * from "./types/APIError.js";
 export * from "./types/State.js";
+export * from "./types/federal_register/FederalRegisterAgency.js";
+export * from "./types/federal_register/FederalRegisterDocument.js";
 export * from "./types/federal_dockets/FederalDocketAgency.js";
 export * from "./types/federal_dockets/FederalDocket.js";
 export * from "./types/federal_dockets/FederalDocketDocument.js";

package/dist/src/types/federal_register/FederalRegisterAgency.d.ts

@@ -0,0 +1,13 @@
+export declare class FederalRegisterAgency {
+    readonly federal_register_agency_id: number;
+    readonly name: string;
+    readonly short_name?: string;
+    readonly slug: string;
+    readonly federal_docket_agency_id?: string;
+    readonly sub_federal_register_agency_ids: number[];
+    readonly super_federal_register_agency_id?: number;
+    readonly description?: string;
+    readonly url?: string;
+    constructor(federal_register_agency: any);
+    static is(federal_register_agency: any): federal_register_agency is FederalRegisterAgency;
+}

package/dist/src/types/federal_register/FederalRegisterAgency.js

@@ -0,0 +1,37 @@
+export class FederalRegisterAgency {
+    federal_register_agency_id;
+    name;
+    short_name;
+    slug;
+    federal_docket_agency_id;
+    sub_federal_register_agency_ids;
+    super_federal_register_agency_id;
+    description;
+    url;
+    constructor(federal_register_agency) {
+        if (!FederalRegisterAgency.is(federal_register_agency)) {
+            throw Error("Invalid input.");
+        }
+        this.federal_register_agency_id = federal_register_agency.federal_register_agency_id;
+        this.name = federal_register_agency.name;
+        this.slug = federal_register_agency.slug;
+        this.short_name = federal_register_agency.short_name;
+        this.federal_docket_agency_id = federal_register_agency.federal_docket_agency_id;
+        this.sub_federal_register_agency_ids = federal_register_agency.sub_federal_register_agency_ids;
+        this.super_federal_register_agency_id = federal_register_agency.super_federal_register_agency_id;
+        this.description = federal_register_agency.description;
+        this.url = federal_register_agency.url;
+    }
+    static is(federal_register_agency) {
+        return (federal_register_agency !== undefined &&
+            typeof federal_register_agency.federal_register_agency_id === "number" &&
+            typeof federal_register_agency.name === "string" &&
+            typeof federal_register_agency.slug === "string" &&
+            (federal_register_agency.short_name === undefined || typeof federal_register_agency.short_name === "string") &&
+            (federal_register_agency.federal_docket_agency_id === undefined || typeof federal_register_agency.federal_docket_agency_id === "string") &&
+            Array.isArray(federal_register_agency.sub_federal_register_agency_ids) && federal_register_agency.sub_federal_register_agency_ids.every((sub_federal_register_agency_id) => typeof sub_federal_register_agency_id === "number") &&
+            (federal_register_agency.super_federal_register_agency_id === undefined || typeof federal_register_agency.super_federal_register_agency_id === "number") &&
+            (federal_register_agency.description === undefined || typeof federal_register_agency.description === "string") &&
+            (federal_register_agency.url === undefined || typeof federal_register_agency.url === "string"));
+    }
+}

package/dist/src/types/federal_register/FederalRegisterDocument.d.ts

@@ -0,0 +1,21 @@
+export declare const federal_register_document_type_ids: readonly ["NOTICE", "RULE", "PRORULE", "UNCATEGORIZED", "PRESDOCU", "SUNSHINE", "CORRECTION", "MISC", "NONE"];
+export type FederalRegisterDocumentTypeID = typeof federal_register_document_type_ids[number];
+export declare function is_federal_register_document_type_id(federal_register_document_type_id: any): federal_register_document_type_id is FederalRegisterDocumentTypeID;
+export declare class FederalRegisterDocument {
+    readonly federal_register_document_id: string;
+    readonly federal_register_agency_ids: number[];
+    readonly title: string;
+    readonly action?: string;
+    readonly type_id: FederalRegisterDocumentTypeID;
+    readonly volume: number;
+    readonly page_start?: number;
+    readonly page_end?: number;
+    readonly publish_date: string;
+    readonly abstract?: string;
+    readonly url: string;
+    readonly topics: string[];
+    readonly s3_filename?: string;
+    readonly vector_keys?: string[];
+    constructor(federal_register_document: any);
+    static is(federal_register_document: any): federal_register_document is FederalRegisterDocument;
+}

package/dist/src/types/federal_register/FederalRegisterDocument.js

@@ -0,0 +1,56 @@
+export const federal_register_document_type_ids = ["NOTICE", "RULE", "PRORULE", "UNCATEGORIZED", "PRESDOCU", "SUNSHINE", "CORRECTION", "MISC", "NONE"];
+export function is_federal_register_document_type_id(federal_register_document_type_id) {
+    return federal_register_document_type_ids.includes(federal_register_document_type_id);
+}
+export class FederalRegisterDocument {
+    federal_register_document_id;
+    federal_register_agency_ids;
+    title;
+    action;
+    type_id;
+    volume;
+    page_start;
+    page_end;
+    publish_date;
+    abstract;
+    url;
+    topics;
+    s3_filename;
+    vector_keys;
+    constructor(federal_register_document) {
+        if (!FederalRegisterDocument.is(federal_register_document)) {
+            throw Error("Invalid input.");
+        }
+        this.federal_register_document_id = federal_register_document.federal_register_document_id;
+        this.federal_register_agency_ids = federal_register_document.federal_register_agency_ids;
+        this.title = federal_register_document.title;
+        this.action = federal_register_document.action;
+        this.type_id = federal_register_document.type_id;
+        this.volume = federal_register_document.volume;
+        this.page_start = federal_register_document.page_start;
+        this.page_end = federal_register_document.page_end;
+        this.publish_date = federal_register_document.publish_date;
+        this.abstract = federal_register_document.abstract;
+        this.url = federal_register_document.url;
+        this.topics = federal_register_document.topics;
+        this.s3_filename = federal_register_document.s3_filename;
+        this.vector_keys = federal_register_document.vector_keys;
+    }
+    static is(federal_register_document) {
+        return (federal_register_document !== undefined &&
+            typeof federal_register_document.federal_register_document_id === "string" &&
+            Array.isArray(federal_register_document.federal_register_agency_ids) && federal_register_document.federal_register_agency_ids.every((federal_register_agency_id) => typeof federal_register_agency_id === "number") &&
+            typeof federal_register_document.title === "string" &&
+            (federal_register_document.action === undefined || typeof federal_register_document.action === "string") &&
+            is_federal_register_document_type_id(federal_register_document.type_id) &&
+            typeof federal_register_document.volume === "number" &&
+            (federal_register_document.page_start === undefined || typeof federal_register_document.page_start === "number") &&
+            (federal_register_document.page_end === undefined || typeof federal_register_document.page_end === "number") &&
+            typeof federal_register_document.publish_date === "string" &&
+            (federal_register_document.abstract === undefined || typeof federal_register_document.abstract === "string") &&
+            typeof federal_register_document.url === "string" &&
+            Array.isArray(federal_register_document.topics) && federal_register_document.topics.every((topic) => typeof topic === "string") &&
+            (federal_register_document.s3_filename === undefined || typeof federal_register_document.s3_filename === "string") &&
+            (federal_register_document.vector_keys === undefined || Array.isArray(federal_register_document.vector_keys) && federal_register_document.vector_keys.every((topic) => typeof topic === "string")));
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "triage-types",
-    "version": "1.0.93",
+    "version": "1.0.94",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
     "directories": {

package/src/index.ts

@@ -1,6 +1,9 @@
 export * from "./types/APIError"
 export * from "./types/State"
 
+export * from "./types/federal_register/FederalRegisterAgency"
+export * from "./types/federal_register/FederalRegisterDocument"
+
 export * from "./types/federal_dockets/FederalDocketAgency"
 export * from "./types/federal_dockets/FederalDocket"
 export * from "./types/federal_dockets/FederalDocketDocument"

package/src/types/federal_register/FederalRegisterAgency.ts

@@ -0,0 +1,41 @@
+export class FederalRegisterAgency {
+    readonly federal_register_agency_id : number
+    readonly name : string
+    readonly short_name? : string
+    readonly slug : string
+    readonly federal_docket_agency_id? : string
+    readonly sub_federal_register_agency_ids : number[]
+    readonly super_federal_register_agency_id? : number
+    readonly description? : string
+    readonly url? : string
+
+    constructor(federal_register_agency : any) {
+        if (!FederalRegisterAgency.is(federal_register_agency)) {
+            throw Error("Invalid input.")
+        }
+        this.federal_register_agency_id = federal_register_agency.federal_register_agency_id
+        this.name = federal_register_agency.name
+        this.slug = federal_register_agency.slug
+        this.short_name = federal_register_agency.short_name
+        this.federal_docket_agency_id = federal_register_agency.federal_docket_agency_id
+        this.sub_federal_register_agency_ids = federal_register_agency.sub_federal_register_agency_ids
+        this.super_federal_register_agency_id = federal_register_agency.super_federal_register_agency_id
+        this.description = federal_register_agency.description
+        this.url = federal_register_agency.url
+    }
+
+    static is(federal_register_agency : any) : federal_register_agency is FederalRegisterAgency {
+        return (
+            federal_register_agency !== undefined &&
+            typeof federal_register_agency.federal_register_agency_id === "number" &&
+            typeof federal_register_agency.name === "string" &&
+            typeof federal_register_agency.slug === "string" &&
+            (federal_register_agency.short_name === undefined || typeof federal_register_agency.short_name === "string") &&
+            (federal_register_agency.federal_docket_agency_id === undefined || typeof federal_register_agency.federal_docket_agency_id === "string") &&
+            Array.isArray(federal_register_agency.sub_federal_register_agency_ids) && federal_register_agency.sub_federal_register_agency_ids.every((sub_federal_register_agency_id : any) => typeof sub_federal_register_agency_id === "number") &&
+            (federal_register_agency.super_federal_register_agency_id === undefined || typeof federal_register_agency.super_federal_register_agency_id === "number") &&
+            (federal_register_agency.description === undefined || typeof federal_register_agency.description === "string")  &&
+            (federal_register_agency.url === undefined || typeof federal_register_agency.url === "string")
+        )
+    }
+}

package/src/types/federal_register/FederalRegisterDocument.ts

@@ -0,0 +1,64 @@
+export const federal_register_document_type_ids = ["NOTICE", "RULE", "PRORULE", "UNCATEGORIZED", "PRESDOCU", "SUNSHINE", "CORRECTION", "MISC", "NONE"] as const
+
+export type FederalRegisterDocumentTypeID = typeof federal_register_document_type_ids[number]
+
+export function is_federal_register_document_type_id(federal_register_document_type_id : any) : federal_register_document_type_id is FederalRegisterDocumentTypeID {
+    return federal_register_document_type_ids.includes(federal_register_document_type_id)
+}
+
+export class FederalRegisterDocument {
+    readonly federal_register_document_id : string
+    readonly federal_register_agency_ids : number[]
+    readonly title : string
+    readonly action? : string
+    readonly type_id : FederalRegisterDocumentTypeID
+    readonly volume : number
+    readonly page_start? : number
+    readonly page_end? : number
+    readonly publish_date : string
+    readonly abstract? : string
+    readonly url : string
+    readonly topics : string[]
+    readonly s3_filename? : string
+    readonly vector_keys? : string[]
+
+    constructor(federal_register_document : any) {
+        if (!FederalRegisterDocument.is(federal_register_document)) {
+            throw Error("Invalid input.")
+        }
+        this.federal_register_document_id = federal_register_document.federal_register_document_id
+        this.federal_register_agency_ids = federal_register_document.federal_register_agency_ids
+        this.title = federal_register_document.title
+        this.action = federal_register_document.action
+        this.type_id = federal_register_document.type_id
+        this.volume = federal_register_document.volume
+        this.page_start = federal_register_document.page_start
+        this.page_end = federal_register_document.page_end
+        this.publish_date = federal_register_document.publish_date
+        this.abstract = federal_register_document.abstract
+        this.url = federal_register_document.url
+        this.topics = federal_register_document.topics
+        this.s3_filename = federal_register_document.s3_filename
+        this.vector_keys = federal_register_document.vector_keys
+    }
+
+    static is(federal_register_document : any) : federal_register_document is FederalRegisterDocument {
+        return (
+            federal_register_document !== undefined &&
+            typeof federal_register_document.federal_register_document_id === "string" &&
+            Array.isArray(federal_register_document.federal_register_agency_ids) && federal_register_document.federal_register_agency_ids.every((federal_register_agency_id : any) => typeof federal_register_agency_id === "number") &&
+            typeof federal_register_document.title === "string" &&
+            (federal_register_document.action === undefined || typeof federal_register_document.action === "string") &&
+            is_federal_register_document_type_id(federal_register_document.type_id) &&
+            typeof federal_register_document.volume === "number" &&
+            (federal_register_document.page_start === undefined || typeof federal_register_document.page_start === "number") &&
+            (federal_register_document.page_end === undefined || typeof federal_register_document.page_end === "number") &&
+            typeof federal_register_document.publish_date === "string" &&
+            (federal_register_document.abstract === undefined || typeof federal_register_document.abstract === "string") &&
+            typeof federal_register_document.url === "string" &&
+            Array.isArray(federal_register_document.topics) && federal_register_document.topics.every((topic : any) => typeof topic === "string") &&
+            (federal_register_document.s3_filename === undefined || typeof federal_register_document.s3_filename === "string") &&
+            (federal_register_document.vector_keys === undefined || Array.isArray(federal_register_document.vector_keys) && federal_register_document.vector_keys.every((topic : any) => typeof topic === "string"))
+        )
+    }
+}