triage-types 1.0.93 → 1.0.95

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/dist/src/index.d.ts +2 -0
  2. package/dist/src/index.js +2 -0
  3. package/dist/src/types/federal_dockets/FederalDocketCommentAttachment.d.ts +1 -1
  4. package/dist/src/types/federal_dockets/FederalDocketCommentAttachment.js +3 -3
  5. package/dist/src/types/federal_dockets/FederalDocketDocument.d.ts +1 -1
  6. package/dist/src/types/federal_dockets/FederalDocketDocument.js +3 -3
  7. package/dist/src/types/federal_register/FederalRegisterAgency.d.ts +13 -0
  8. package/dist/src/types/federal_register/FederalRegisterAgency.js +37 -0
  9. package/dist/src/types/federal_register/FederalRegisterDocument.d.ts +21 -0
  10. package/dist/src/types/federal_register/FederalRegisterDocument.js +56 -0
  11. package/dist/src/types/state_permits/StatePermitDocument.d.ts +2 -2
  12. package/dist/src/types/state_permits/StatePermitDocument.js +6 -6
  13. package/package.json +1 -1
  14. package/src/index.ts +3 -0
  15. package/src/types/federal_dockets/FederalDocketCommentAttachment.ts +3 -3
  16. package/src/types/federal_dockets/FederalDocketDocument.ts +3 -3
  17. package/src/types/federal_register/FederalRegisterAgency.ts +41 -0
  18. package/src/types/federal_register/FederalRegisterDocument.ts +64 -0
  19. package/src/types/state_permits/StatePermitDocument.ts +6 -6
package/dist/src/index.d.ts CHANGED
@@ -1,5 +1,7 @@
1
1
  export * from "./types/APIError.js";
2
2
  export * from "./types/State.js";
3
+ export * from "./types/federal_register/FederalRegisterAgency.js";
4
+ export * from "./types/federal_register/FederalRegisterDocument.js";
3
5
  export * from "./types/federal_dockets/FederalDocketAgency.js";
4
6
  export * from "./types/federal_dockets/FederalDocket.js";
5
7
  export * from "./types/federal_dockets/FederalDocketDocument.js";
package/dist/src/index.js CHANGED
@@ -1,5 +1,7 @@
1
1
  export * from "./types/APIError.js";
2
2
  export * from "./types/State.js";
3
+ export * from "./types/federal_register/FederalRegisterAgency.js";
4
+ export * from "./types/federal_register/FederalRegisterDocument.js";
3
5
  export * from "./types/federal_dockets/FederalDocketAgency.js";
4
6
  export * from "./types/federal_dockets/FederalDocket.js";
5
7
  export * from "./types/federal_dockets/FederalDocketDocument.js";
package/dist/src/types/federal_dockets/FederalDocketCommentAttachment.d.ts CHANGED
@@ -3,7 +3,7 @@ export declare class FederalDocketCommentAttachment {
3
3
  readonly federal_docket_comment_id: string;
4
4
  readonly attachment_number: number;
5
5
  readonly urls: string[];
6
- readonly s3_filenames?: string[];
6
+ readonly s3_ids?: string[];
7
7
  constructor(federal_docket_comment_attachment: any);
8
8
  static is(federal_docket_comment_attachment: any): federal_docket_comment_attachment is FederalDocketCommentAttachment;
9
9
  }
package/dist/src/types/federal_dockets/FederalDocketCommentAttachment.js CHANGED
@@ -3,7 +3,7 @@ export class FederalDocketCommentAttachment {
3
3
  federal_docket_comment_id;
4
4
  attachment_number;
5
5
  urls;
6
- s3_filenames;
6
+ s3_ids;
7
7
  constructor(federal_docket_comment_attachment) {
8
8
  if (!FederalDocketCommentAttachment.is(federal_docket_comment_attachment)) {
9
9
  throw Error("Invalid input.");
@@ -12,7 +12,7 @@ export class FederalDocketCommentAttachment {
12
12
  this.attachment_number = federal_docket_comment_attachment.attachment_number;
13
13
  this.federal_docket_comment_id = federal_docket_comment_attachment.federal_docket_comment_id;
14
14
  this.urls = federal_docket_comment_attachment.urls;
15
- this.s3_filenames = federal_docket_comment_attachment.s3_filenames;
15
+ this.s3_ids = federal_docket_comment_attachment.s3_ids;
16
16
  }
17
17
  static is(federal_docket_comment_attachment) {
18
18
  return (federal_docket_comment_attachment !== undefined &&
@@ -20,6 +20,6 @@ export class FederalDocketCommentAttachment {
20
20
  typeof federal_docket_comment_attachment.federal_docket_comment_id === "string" &&
21
21
  typeof federal_docket_comment_attachment.attachment_number === "number" &&
22
22
  Array.isArray(federal_docket_comment_attachment.urls) && federal_docket_comment_attachment.urls.every((url) => typeof url === "string") &&
23
- (federal_docket_comment_attachment.s3_filenames === undefined || Array.isArray(federal_docket_comment_attachment.s3_filenames) && federal_docket_comment_attachment.s3_filenames.every((s3_filename) => typeof s3_filename === "string")));
23
+ (federal_docket_comment_attachment.s3_ids === undefined || Array.isArray(federal_docket_comment_attachment.s3_ids) && federal_docket_comment_attachment.s3_ids.every((s3_id) => typeof s3_id === "string")));
24
24
  }
25
25
  }
package/dist/src/types/federal_dockets/FederalDocketDocument.d.ts CHANGED
@@ -21,7 +21,7 @@ export declare class FederalDocketDocument {
21
21
  readonly media_type_id?: string;
22
22
  readonly abstract?: string;
23
23
  readonly urls: string[];
24
- readonly s3_filenames?: string[];
24
+ readonly s3_ids?: string[];
25
25
  constructor(federal_docket_document: any);
26
26
  static is(federal_docket_document: any): federal_docket_document is FederalDocketDocument;
27
27
  }
package/dist/src/types/federal_dockets/FederalDocketDocument.js CHANGED
@@ -22,7 +22,7 @@ export class FederalDocketDocument {
22
22
  media_type_id;
23
23
  abstract;
24
24
  urls;
25
- s3_filenames;
25
+ s3_ids;
26
26
  constructor(federal_docket_document) {
27
27
  if (!FederalDocketDocument.is(federal_docket_document)) {
28
28
  throw Error("Invalid input.");
@@ -46,7 +46,7 @@ export class FederalDocketDocument {
46
46
  this.media_type_id = federal_docket_document.media_type_id;
47
47
  this.abstract = federal_docket_document.abstract;
48
48
  this.urls = federal_docket_document.urls;
49
- this.s3_filenames = federal_docket_document.s3_filenames;
49
+ this.s3_ids = federal_docket_document.s3_ids;
50
50
  }
51
51
  static is(federal_docket_document) {
52
52
  return (federal_docket_document !== undefined &&
@@ -69,6 +69,6 @@ export class FederalDocketDocument {
69
69
  (federal_docket_document.media_type_id === undefined || typeof federal_docket_document.media_type_id === "string") &&
70
70
  (federal_docket_document.abstract === undefined || typeof federal_docket_document.abstract === "string") &&
71
71
  Array.isArray(federal_docket_document.urls) && federal_docket_document.urls.every((url) => typeof url === "string") &&
72
- (federal_docket_document.s3_filenames === undefined || Array.isArray(federal_docket_document.s3_filenames) && federal_docket_document.s3_filenames.every((s3_filename) => typeof s3_filename === "string")));
72
+ (federal_docket_document.s3_ids === undefined || Array.isArray(federal_docket_document.s3_ids) && federal_docket_document.s3_ids.every((s3_id) => typeof s3_id === "string")));
73
73
  }
74
74
  }
package/dist/src/types/federal_register/FederalRegisterAgency.d.ts ADDED
@@ -0,0 +1,13 @@
1
+ export declare class FederalRegisterAgency {
2
+ readonly federal_register_agency_id: number;
3
+ readonly name: string;
4
+ readonly short_name?: string;
5
+ readonly slug: string;
6
+ readonly federal_docket_agency_id?: string;
7
+ readonly sub_federal_register_agency_ids: number[];
8
+ readonly super_federal_register_agency_id?: number;
9
+ readonly description?: string;
10
+ readonly url?: string;
11
+ constructor(federal_register_agency: any);
12
+ static is(federal_register_agency: any): federal_register_agency is FederalRegisterAgency;
13
+ }
package/dist/src/types/federal_register/FederalRegisterAgency.js ADDED
@@ -0,0 +1,37 @@
1
+ export class FederalRegisterAgency {
2
+ federal_register_agency_id;
3
+ name;
4
+ short_name;
5
+ slug;
6
+ federal_docket_agency_id;
7
+ sub_federal_register_agency_ids;
8
+ super_federal_register_agency_id;
9
+ description;
10
+ url;
11
+ constructor(federal_register_agency) {
12
+ if (!FederalRegisterAgency.is(federal_register_agency)) {
13
+ throw Error("Invalid input.");
14
+ }
15
+ this.federal_register_agency_id = federal_register_agency.federal_register_agency_id;
16
+ this.name = federal_register_agency.name;
17
+ this.slug = federal_register_agency.slug;
18
+ this.short_name = federal_register_agency.short_name;
19
+ this.federal_docket_agency_id = federal_register_agency.federal_docket_agency_id;
20
+ this.sub_federal_register_agency_ids = federal_register_agency.sub_federal_register_agency_ids;
21
+ this.super_federal_register_agency_id = federal_register_agency.super_federal_register_agency_id;
22
+ this.description = federal_register_agency.description;
23
+ this.url = federal_register_agency.url;
24
+ }
25
+ static is(federal_register_agency) {
26
+ return (federal_register_agency !== undefined &&
27
+ typeof federal_register_agency.federal_register_agency_id === "number" &&
28
+ typeof federal_register_agency.name === "string" &&
29
+ typeof federal_register_agency.slug === "string" &&
30
+ (federal_register_agency.short_name === undefined || typeof federal_register_agency.short_name === "string") &&
31
+ (federal_register_agency.federal_docket_agency_id === undefined || typeof federal_register_agency.federal_docket_agency_id === "string") &&
32
+ 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") &&
33
+ (federal_register_agency.super_federal_register_agency_id === undefined || typeof federal_register_agency.super_federal_register_agency_id === "number") &&
34
+ (federal_register_agency.description === undefined || typeof federal_register_agency.description === "string") &&
35
+ (federal_register_agency.url === undefined || typeof federal_register_agency.url === "string"));
36
+ }
37
+ }
package/dist/src/types/federal_register/FederalRegisterDocument.d.ts ADDED
@@ -0,0 +1,21 @@
1
+ export declare const federal_register_document_type_ids: readonly ["NOTICE", "RULE", "PRORULE", "UNCATEGORIZED", "PRESDOCU", "SUNSHINE", "CORRECTION", "MISC", "NONE"];
2
+ export type FederalRegisterDocumentTypeID = typeof federal_register_document_type_ids[number];
3
+ export declare function is_federal_register_document_type_id(federal_register_document_type_id: any): federal_register_document_type_id is FederalRegisterDocumentTypeID;
4
+ export declare class FederalRegisterDocument {
5
+ readonly federal_register_document_id: string;
6
+ readonly federal_register_agency_ids: number[];
7
+ readonly title: string;
8
+ readonly action?: string;
9
+ readonly type_id: FederalRegisterDocumentTypeID;
10
+ readonly volume: number;
11
+ readonly page_start?: number;
12
+ readonly page_end?: number;
13
+ readonly publish_date: string;
14
+ readonly abstract?: string;
15
+ readonly url: string;
16
+ readonly topics: string[];
17
+ readonly s3_id?: string;
18
+ readonly vector_keys?: string[];
19
+ constructor(federal_register_document: any);
20
+ static is(federal_register_document: any): federal_register_document is FederalRegisterDocument;
21
+ }
package/dist/src/types/federal_register/FederalRegisterDocument.js ADDED
@@ -0,0 +1,56 @@
1
+ export const federal_register_document_type_ids = ["NOTICE", "RULE", "PRORULE", "UNCATEGORIZED", "PRESDOCU", "SUNSHINE", "CORRECTION", "MISC", "NONE"];
2
+ export function is_federal_register_document_type_id(federal_register_document_type_id) {
3
+ return federal_register_document_type_ids.includes(federal_register_document_type_id);
4
+ }
5
+ export class FederalRegisterDocument {
6
+ federal_register_document_id;
7
+ federal_register_agency_ids;
8
+ title;
9
+ action;
10
+ type_id;
11
+ volume;
12
+ page_start;
13
+ page_end;
14
+ publish_date;
15
+ abstract;
16
+ url;
17
+ topics;
18
+ s3_id;
19
+ vector_keys;
20
+ constructor(federal_register_document) {
21
+ if (!FederalRegisterDocument.is(federal_register_document)) {
22
+ throw Error("Invalid input.");
23
+ }
24
+ this.federal_register_document_id = federal_register_document.federal_register_document_id;
25
+ this.federal_register_agency_ids = federal_register_document.federal_register_agency_ids;
26
+ this.title = federal_register_document.title;
27
+ this.action = federal_register_document.action;
28
+ this.type_id = federal_register_document.type_id;
29
+ this.volume = federal_register_document.volume;
30
+ this.page_start = federal_register_document.page_start;
31
+ this.page_end = federal_register_document.page_end;
32
+ this.publish_date = federal_register_document.publish_date;
33
+ this.abstract = federal_register_document.abstract;
34
+ this.url = federal_register_document.url;
35
+ this.topics = federal_register_document.topics;
36
+ this.s3_id = federal_register_document.s3_id;
37
+ this.vector_keys = federal_register_document.vector_keys;
38
+ }
39
+ static is(federal_register_document) {
40
+ return (federal_register_document !== undefined &&
41
+ typeof federal_register_document.federal_register_document_id === "string" &&
42
+ 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") &&
43
+ typeof federal_register_document.title === "string" &&
44
+ (federal_register_document.action === undefined || typeof federal_register_document.action === "string") &&
45
+ is_federal_register_document_type_id(federal_register_document.type_id) &&
46
+ typeof federal_register_document.volume === "number" &&
47
+ (federal_register_document.page_start === undefined || typeof federal_register_document.page_start === "number") &&
48
+ (federal_register_document.page_end === undefined || typeof federal_register_document.page_end === "number") &&
49
+ typeof federal_register_document.publish_date === "string" &&
50
+ (federal_register_document.abstract === undefined || typeof federal_register_document.abstract === "string") &&
51
+ typeof federal_register_document.url === "string" &&
52
+ Array.isArray(federal_register_document.topics) && federal_register_document.topics.every((topic) => typeof topic === "string") &&
53
+ (federal_register_document.s3_id === undefined || typeof federal_register_document.s3_id === "string") &&
54
+ (federal_register_document.vector_keys === undefined || Array.isArray(federal_register_document.vector_keys) && federal_register_document.vector_keys.every((topic) => typeof topic === "string")));
55
+ }
56
+ }
package/dist/src/types/state_permits/StatePermitDocument.d.ts CHANGED
@@ -15,8 +15,8 @@ export declare class StatePermitDocument {
15
15
  readonly document_type: string;
16
16
  readonly document_type_id?: string;
17
17
  readonly name: string;
18
- readonly s3_filename?: string;
19
- readonly s3_text_filename?: string;
18
+ readonly s3_id?: string;
19
+ readonly s3_id_txt?: string;
20
20
  readonly source_ids?: string[];
21
21
  readonly comments?: StatePermitComment[];
22
22
  readonly [x: string]: any;
package/dist/src/types/state_permits/StatePermitDocument.js CHANGED
@@ -25,8 +25,8 @@ export class StatePermitDocument {
25
25
  document_type;
26
26
  document_type_id;
27
27
  name;
28
- s3_filename;
29
- s3_text_filename;
28
+ s3_id;
29
+ s3_id_txt;
30
30
  source_ids;
31
31
  comments;
32
32
  constructor(state_permit_document) {
@@ -41,8 +41,8 @@ export class StatePermitDocument {
41
41
  this.document_type = state_permit_document.document_type;
42
42
  this.document_type_id = state_permit_document.document_type_id;
43
43
  this.name = state_permit_document.name;
44
- this.s3_filename = state_permit_document.s3_filename;
45
- this.s3_text_filename = state_permit_document.s3_text_filename;
44
+ this.s3_id = state_permit_document.s3_id;
45
+ this.s3_id_txt = state_permit_document.s3_id_txt;
46
46
  this.source_ids = state_permit_document.source_ids;
47
47
  this.comments = state_permit_document.comments;
48
48
  }
@@ -56,8 +56,8 @@ export class StatePermitDocument {
56
56
  typeof state_permit_document.document_type === "string" &&
57
57
  (state_permit_document.document_type_id === undefined || typeof state_permit_document.document_type_id === "string") &&
58
58
  typeof state_permit_document.name === "string" &&
59
- (state_permit_document.s3_filename === undefined || typeof state_permit_document.s3_filename == "string") &&
60
- (state_permit_document.s3_text_filename === undefined || typeof state_permit_document.s3_text_filename == "string") &&
59
+ (state_permit_document.s3_id === undefined || typeof state_permit_document.s3_id == "string") &&
60
+ (state_permit_document.s3_id_txt === undefined || typeof state_permit_document.s3_id_txt == "string") &&
61
61
  (state_permit_document.source_ids === undefined || Array.isArray(state_permit_document.source_ids) && state_permit_document.source_ids.every((source_id) => typeof source_id === "string")) &&
62
62
  (state_permit_document.comments === undefined || Array.isArray(state_permit_document.comments) && state_permit_document.comments.every(StatePermitComment.is)));
63
63
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "triage-types",
3
- "version": "1.0.93",
3
+ "version": "1.0.95",
4
4
  "main": "dist/src/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "directories": {
package/src/index.ts CHANGED
@@ -1,6 +1,9 @@
1
1
  export * from "./types/APIError"
2
2
  export * from "./types/State"
3
3
 
4
+ export * from "./types/federal_register/FederalRegisterAgency"
5
+ export * from "./types/federal_register/FederalRegisterDocument"
6
+
4
7
  export * from "./types/federal_dockets/FederalDocketAgency"
5
8
  export * from "./types/federal_dockets/FederalDocket"
6
9
  export * from "./types/federal_dockets/FederalDocketDocument"
package/src/types/federal_dockets/FederalDocketCommentAttachment.ts CHANGED
@@ -3,7 +3,7 @@ export class FederalDocketCommentAttachment {
3
3
  readonly federal_docket_comment_id : string
4
4
  readonly attachment_number : number
5
5
  readonly urls : string[]
6
- readonly s3_filenames? : string[]
6
+ readonly s3_ids? : string[]
7
7
 
8
8
  constructor(federal_docket_comment_attachment : any) {
9
9
  if (!FederalDocketCommentAttachment.is(federal_docket_comment_attachment)) {
@@ -13,7 +13,7 @@ export class FederalDocketCommentAttachment {
13
13
  this.attachment_number = federal_docket_comment_attachment.attachment_number
14
14
  this.federal_docket_comment_id = federal_docket_comment_attachment.federal_docket_comment_id
15
15
  this.urls = federal_docket_comment_attachment.urls
16
- this.s3_filenames = federal_docket_comment_attachment.s3_filenames
16
+ this.s3_ids = federal_docket_comment_attachment.s3_ids
17
17
  }
18
18
 
19
19
  static is(federal_docket_comment_attachment : any) : federal_docket_comment_attachment is FederalDocketCommentAttachment {
@@ -23,7 +23,7 @@ export class FederalDocketCommentAttachment {
23
23
  typeof federal_docket_comment_attachment.federal_docket_comment_id === "string" &&
24
24
  typeof federal_docket_comment_attachment.attachment_number === "number" &&
25
25
  Array.isArray(federal_docket_comment_attachment.urls) && federal_docket_comment_attachment.urls.every((url : any) => typeof url === "string") &&
26
- (federal_docket_comment_attachment.s3_filenames === undefined || Array.isArray(federal_docket_comment_attachment.s3_filenames) && federal_docket_comment_attachment.s3_filenames.every((s3_filename : any) => typeof s3_filename === "string"))
26
+ (federal_docket_comment_attachment.s3_ids === undefined || Array.isArray(federal_docket_comment_attachment.s3_ids) && federal_docket_comment_attachment.s3_ids.every((s3_id : any) => typeof s3_id === "string"))
27
27
  )
28
28
  }
29
29
  }
package/src/types/federal_dockets/FederalDocketDocument.ts CHANGED
@@ -26,7 +26,7 @@ export class FederalDocketDocument {
26
26
  readonly media_type_id? : string
27
27
  readonly abstract? : string
28
28
  readonly urls : string[]
29
- readonly s3_filenames? : string[]
29
+ readonly s3_ids? : string[]
30
30
 
31
31
  constructor(federal_docket_document : any) {
32
32
  if (!FederalDocketDocument.is(federal_docket_document)) {
@@ -51,7 +51,7 @@ export class FederalDocketDocument {
51
51
  this.media_type_id = federal_docket_document.media_type_id
52
52
  this.abstract = federal_docket_document.abstract
53
53
  this.urls = federal_docket_document.urls
54
- this.s3_filenames = federal_docket_document.s3_filenames
54
+ this.s3_ids = federal_docket_document.s3_ids
55
55
  }
56
56
 
57
57
  static is(federal_docket_document : any) : federal_docket_document is FederalDocketDocument {
@@ -76,7 +76,7 @@ export class FederalDocketDocument {
76
76
  (federal_docket_document.media_type_id === undefined || typeof federal_docket_document.media_type_id === "string") &&
77
77
  (federal_docket_document.abstract === undefined || typeof federal_docket_document.abstract === "string") &&
78
78
  Array.isArray(federal_docket_document.urls) && federal_docket_document.urls.every((url : any) => typeof url === "string") &&
79
- (federal_docket_document.s3_filenames === undefined || Array.isArray(federal_docket_document.s3_filenames) && federal_docket_document.s3_filenames.every((s3_filename : any) => typeof s3_filename === "string"))
79
+ (federal_docket_document.s3_ids === undefined || Array.isArray(federal_docket_document.s3_ids) && federal_docket_document.s3_ids.every((s3_id : any) => typeof s3_id === "string"))
80
80
  )
81
81
  }
82
82
  }
package/src/types/federal_register/FederalRegisterAgency.ts ADDED
@@ -0,0 +1,41 @@
1
+ export class FederalRegisterAgency {
2
+ readonly federal_register_agency_id : number
3
+ readonly name : string
4
+ readonly short_name? : string
5
+ readonly slug : string
6
+ readonly federal_docket_agency_id? : string
7
+ readonly sub_federal_register_agency_ids : number[]
8
+ readonly super_federal_register_agency_id? : number
9
+ readonly description? : string
10
+ readonly url? : string
11
+
12
+ constructor(federal_register_agency : any) {
13
+ if (!FederalRegisterAgency.is(federal_register_agency)) {
14
+ throw Error("Invalid input.")
15
+ }
16
+ this.federal_register_agency_id = federal_register_agency.federal_register_agency_id
17
+ this.name = federal_register_agency.name
18
+ this.slug = federal_register_agency.slug
19
+ this.short_name = federal_register_agency.short_name
20
+ this.federal_docket_agency_id = federal_register_agency.federal_docket_agency_id
21
+ this.sub_federal_register_agency_ids = federal_register_agency.sub_federal_register_agency_ids
22
+ this.super_federal_register_agency_id = federal_register_agency.super_federal_register_agency_id
23
+ this.description = federal_register_agency.description
24
+ this.url = federal_register_agency.url
25
+ }
26
+
27
+ static is(federal_register_agency : any) : federal_register_agency is FederalRegisterAgency {
28
+ return (
29
+ federal_register_agency !== undefined &&
30
+ typeof federal_register_agency.federal_register_agency_id === "number" &&
31
+ typeof federal_register_agency.name === "string" &&
32
+ typeof federal_register_agency.slug === "string" &&
33
+ (federal_register_agency.short_name === undefined || typeof federal_register_agency.short_name === "string") &&
34
+ (federal_register_agency.federal_docket_agency_id === undefined || typeof federal_register_agency.federal_docket_agency_id === "string") &&
35
+ 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") &&
36
+ (federal_register_agency.super_federal_register_agency_id === undefined || typeof federal_register_agency.super_federal_register_agency_id === "number") &&
37
+ (federal_register_agency.description === undefined || typeof federal_register_agency.description === "string") &&
38
+ (federal_register_agency.url === undefined || typeof federal_register_agency.url === "string")
39
+ )
40
+ }
41
+ }
package/src/types/federal_register/FederalRegisterDocument.ts ADDED
@@ -0,0 +1,64 @@
1
+ export const federal_register_document_type_ids = ["NOTICE", "RULE", "PRORULE", "UNCATEGORIZED", "PRESDOCU", "SUNSHINE", "CORRECTION", "MISC", "NONE"] as const
2
+
3
+ export type FederalRegisterDocumentTypeID = typeof federal_register_document_type_ids[number]
4
+
5
+ export function is_federal_register_document_type_id(federal_register_document_type_id : any) : federal_register_document_type_id is FederalRegisterDocumentTypeID {
6
+ return federal_register_document_type_ids.includes(federal_register_document_type_id)
7
+ }
8
+
9
+ export class FederalRegisterDocument {
10
+ readonly federal_register_document_id : string
11
+ readonly federal_register_agency_ids : number[]
12
+ readonly title : string
13
+ readonly action? : string
14
+ readonly type_id : FederalRegisterDocumentTypeID
15
+ readonly volume : number
16
+ readonly page_start? : number
17
+ readonly page_end? : number
18
+ readonly publish_date : string
19
+ readonly abstract? : string
20
+ readonly url : string
21
+ readonly topics : string[]
22
+ readonly s3_id? : string
23
+ readonly vector_keys? : string[]
24
+
25
+ constructor(federal_register_document : any) {
26
+ if (!FederalRegisterDocument.is(federal_register_document)) {
27
+ throw Error("Invalid input.")
28
+ }
29
+ this.federal_register_document_id = federal_register_document.federal_register_document_id
30
+ this.federal_register_agency_ids = federal_register_document.federal_register_agency_ids
31
+ this.title = federal_register_document.title
32
+ this.action = federal_register_document.action
33
+ this.type_id = federal_register_document.type_id
34
+ this.volume = federal_register_document.volume
35
+ this.page_start = federal_register_document.page_start
36
+ this.page_end = federal_register_document.page_end
37
+ this.publish_date = federal_register_document.publish_date
38
+ this.abstract = federal_register_document.abstract
39
+ this.url = federal_register_document.url
40
+ this.topics = federal_register_document.topics
41
+ this.s3_id = federal_register_document.s3_id
42
+ this.vector_keys = federal_register_document.vector_keys
43
+ }
44
+
45
+ static is(federal_register_document : any) : federal_register_document is FederalRegisterDocument {
46
+ return (
47
+ federal_register_document !== undefined &&
48
+ typeof federal_register_document.federal_register_document_id === "string" &&
49
+ 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") &&
50
+ typeof federal_register_document.title === "string" &&
51
+ (federal_register_document.action === undefined || typeof federal_register_document.action === "string") &&
52
+ is_federal_register_document_type_id(federal_register_document.type_id) &&
53
+ typeof federal_register_document.volume === "number" &&
54
+ (federal_register_document.page_start === undefined || typeof federal_register_document.page_start === "number") &&
55
+ (federal_register_document.page_end === undefined || typeof federal_register_document.page_end === "number") &&
56
+ typeof federal_register_document.publish_date === "string" &&
57
+ (federal_register_document.abstract === undefined || typeof federal_register_document.abstract === "string") &&
58
+ typeof federal_register_document.url === "string" &&
59
+ Array.isArray(federal_register_document.topics) && federal_register_document.topics.every((topic : any) => typeof topic === "string") &&
60
+ (federal_register_document.s3_id === undefined || typeof federal_register_document.s3_id === "string") &&
61
+ (federal_register_document.vector_keys === undefined || Array.isArray(federal_register_document.vector_keys) && federal_register_document.vector_keys.every((topic : any) => typeof topic === "string"))
62
+ )
63
+ }
64
+ }
package/src/types/state_permits/StatePermitDocument.ts CHANGED
@@ -33,8 +33,8 @@ export class StatePermitDocument {
33
33
  readonly document_type : string
34
34
  readonly document_type_id? : string
35
35
  readonly name : string
36
- readonly s3_filename? : string
37
- readonly s3_text_filename? : string
36
+ readonly s3_id? : string
37
+ readonly s3_id_txt? : string
38
38
  readonly source_ids? : string[]
39
39
  readonly comments? : StatePermitComment[]
40
40
  readonly [x : string] : any
@@ -51,8 +51,8 @@ export class StatePermitDocument {
51
51
  this.document_type = state_permit_document.document_type
52
52
  this.document_type_id = state_permit_document.document_type_id
53
53
  this.name = state_permit_document.name
54
- this.s3_filename = state_permit_document.s3_filename
55
- this.s3_text_filename = state_permit_document.s3_text_filename
54
+ this.s3_id = state_permit_document.s3_id
55
+ this.s3_id_txt = state_permit_document.s3_id_txt
56
56
  this.source_ids = state_permit_document.source_ids
57
57
  this.comments = state_permit_document.comments
58
58
  }
@@ -68,8 +68,8 @@ export class StatePermitDocument {
68
68
  typeof state_permit_document.document_type === "string" &&
69
69
  (state_permit_document.document_type_id === undefined || typeof state_permit_document.document_type_id === "string") &&
70
70
  typeof state_permit_document.name === "string" &&
71
- (state_permit_document.s3_filename === undefined || typeof state_permit_document.s3_filename == "string") &&
72
- (state_permit_document.s3_text_filename === undefined || typeof state_permit_document.s3_text_filename == "string") &&
71
+ (state_permit_document.s3_id === undefined || typeof state_permit_document.s3_id == "string") &&
72
+ (state_permit_document.s3_id_txt === undefined || typeof state_permit_document.s3_id_txt == "string") &&
73
73
  (state_permit_document.source_ids === undefined || Array.isArray(state_permit_document.source_ids) && state_permit_document.source_ids.every((source_id : any) => typeof source_id === "string")) &&
74
74
  (state_permit_document.comments === undefined || Array.isArray(state_permit_document.comments) && state_permit_document.comments.every(StatePermitComment.is))
75
75
  )