@tmlmobilidade/interfaces 20251217.1540.37 → 20251222.1537.24

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 (27) hide show
  1. package/dist/common/mongo-collection.d.ts +58 -33
  2. package/dist/common/mongo-collection.js +157 -69
  3. package/dist/interfaces/agencies/agencies.d.ts +4 -6
  4. package/dist/interfaces/alerts/alerts.d.ts +33 -39
  5. package/dist/interfaces/auth/roles.d.ts +48 -27
  6. package/dist/interfaces/auth/users.d.ts +99 -212
  7. package/dist/interfaces/auth/users.js +11 -25
  8. package/dist/interfaces/auth/verification-tokens.d.ts +3 -4
  9. package/dist/interfaces/auth/verification-tokens.js +5 -6
  10. package/dist/interfaces/dates/annotations.d.ts +38 -0
  11. package/dist/interfaces/dates/annotations.js +41 -0
  12. package/dist/interfaces/dates/index.d.ts +1 -0
  13. package/dist/interfaces/dates/index.js +1 -0
  14. package/dist/interfaces/gtfs-validations/gtfs-validations.d.ts +1 -0
  15. package/dist/interfaces/index.d.ts +1 -0
  16. package/dist/interfaces/index.js +1 -0
  17. package/dist/interfaces/locations/locations.js +2 -2
  18. package/dist/interfaces/organizations/organizations.js +2 -2
  19. package/dist/interfaces/pcgidb/pcgidb-legacy.js +0 -1
  20. package/dist/interfaces/pcgidb/pcgidb-ticketing.js +0 -1
  21. package/dist/interfaces/pcgidb/pcgidb-validations.js +0 -1
  22. package/dist/interfaces/plans/plans.d.ts +1 -1
  23. package/dist/interfaces/rides/rides.d.ts +6 -6
  24. package/dist/interfaces/stops/stops.d.ts +81 -60
  25. package/dist/interfaces/stops/stops.js +41 -7
  26. package/dist/providers/auth/auth.js +2 -4
  27. package/package.json +4 -4
package/dist/interfaces/alerts/alerts.d.ts CHANGED
@@ -13,108 +13,102 @@ declare class AlertsClass extends MongoCollectionClass<Alert, CreateAlertDto, Up
13
13
  created_at: number & {
14
14
  __brand: "UnixTimestamp";
15
15
  };
16
- created_by: string;
16
+ created_by: string | null;
17
+ is_locked: boolean;
17
18
  updated_at: number & {
18
19
  __brand: "UnixTimestamp";
19
20
  };
20
- type: "PLANNED" | "REALTIME";
21
+ type: "PLANNED" | "REALTIME" | null;
22
+ active_period_end_date: import("@tmlmobilidade/types").UnixTimestamp | null;
21
23
  active_period_start_date: number & {
22
24
  __brand: "UnixTimestamp";
23
25
  };
24
26
  cause: "ACCIDENT" | "CONSTRUCTION" | "DEMONSTRATION" | "HOLIDAY" | "MAINTENANCE" | "MEDICAL_EMERGENCY" | "OTHER_CAUSE" | "POLICE_ACTIVITY" | "STRIKE" | "TECHNICAL_PROBLEM" | "UNKNOWN_CAUSE" | "WEATHER" | "DRIVER_ABSENCE" | "DRIVER_ISSUE" | "HIGH_PASSENGER_LOAD" | "ROAD_INCIDENT" | "SYSTEM_FAILURE" | "TRAFFIC_JAM" | "VEHICLE_ISSUE";
27
+ coordinates: [number, number] | null;
25
28
  description: string;
26
29
  effect: "ACCESSIBILITY_ISSUE" | "ADDITIONAL_SERVICE" | "DETOUR" | "MODIFIED_SERVICE" | "NO_EFFECT" | "NO_SERVICE" | "OTHER_EFFECT" | "REDUCED_SERVICE" | "SIGNIFICANT_DELAYS" | "STOP_MOVED" | "UNKNOWN_EFFECT";
27
- modified_by: string;
30
+ external_id: string | null;
31
+ file_id: string | null;
32
+ info_url: string | null;
28
33
  municipality_ids: string[];
29
- publish_start_date: number & {
30
- __brand: "UnixTimestamp";
31
- };
34
+ publish_end_date: import("@tmlmobilidade/types").UnixTimestamp | null;
35
+ publish_start_date: import("@tmlmobilidade/types").UnixTimestamp | null;
32
36
  publish_status: "PUBLISHED" | "ARCHIVED" | "DRAFT";
33
- reference_type: "LINE" | "STOP" | "AGENCY" | "TRIP";
37
+ reference_type: "LINE" | "STOP" | "AGENCY" | "TRIP" | null;
34
38
  references: {
35
39
  child_ids: string[];
36
40
  parent_id: string;
37
41
  }[];
38
42
  title: string;
39
43
  updated_by?: string | undefined;
40
- active_period_end_date?: import("@tmlmobilidade/types").UnixTimestamp | null | undefined;
41
- coordinates?: [number, number] | null | undefined;
42
- external_id?: string | null | undefined;
43
- file_id?: string | null | undefined;
44
- info_url?: string | undefined;
45
- publish_end_date?: import("@tmlmobilidade/types").UnixTimestamp | null | undefined;
46
44
  }>>;
47
45
  findByMunicipalityId(municipality_id: string): Promise<import("mongodb").WithId<{
48
46
  _id: string;
49
47
  created_at: number & {
50
48
  __brand: "UnixTimestamp";
51
49
  };
52
- created_by: string;
50
+ created_by: string | null;
51
+ is_locked: boolean;
53
52
  updated_at: number & {
54
53
  __brand: "UnixTimestamp";
55
54
  };
56
- type: "PLANNED" | "REALTIME";
55
+ type: "PLANNED" | "REALTIME" | null;
56
+ active_period_end_date: import("@tmlmobilidade/types").UnixTimestamp | null;
57
57
  active_period_start_date: number & {
58
58
  __brand: "UnixTimestamp";
59
59
  };
60
60
  cause: "ACCIDENT" | "CONSTRUCTION" | "DEMONSTRATION" | "HOLIDAY" | "MAINTENANCE" | "MEDICAL_EMERGENCY" | "OTHER_CAUSE" | "POLICE_ACTIVITY" | "STRIKE" | "TECHNICAL_PROBLEM" | "UNKNOWN_CAUSE" | "WEATHER" | "DRIVER_ABSENCE" | "DRIVER_ISSUE" | "HIGH_PASSENGER_LOAD" | "ROAD_INCIDENT" | "SYSTEM_FAILURE" | "TRAFFIC_JAM" | "VEHICLE_ISSUE";
61
+ coordinates: [number, number] | null;
61
62
  description: string;
62
63
  effect: "ACCESSIBILITY_ISSUE" | "ADDITIONAL_SERVICE" | "DETOUR" | "MODIFIED_SERVICE" | "NO_EFFECT" | "NO_SERVICE" | "OTHER_EFFECT" | "REDUCED_SERVICE" | "SIGNIFICANT_DELAYS" | "STOP_MOVED" | "UNKNOWN_EFFECT";
63
- modified_by: string;
64
+ external_id: string | null;
65
+ file_id: string | null;
66
+ info_url: string | null;
64
67
  municipality_ids: string[];
65
- publish_start_date: number & {
66
- __brand: "UnixTimestamp";
67
- };
68
+ publish_end_date: import("@tmlmobilidade/types").UnixTimestamp | null;
69
+ publish_start_date: import("@tmlmobilidade/types").UnixTimestamp | null;
68
70
  publish_status: "PUBLISHED" | "ARCHIVED" | "DRAFT";
69
- reference_type: "LINE" | "STOP" | "AGENCY" | "TRIP";
71
+ reference_type: "LINE" | "STOP" | "AGENCY" | "TRIP" | null;
70
72
  references: {
71
73
  child_ids: string[];
72
74
  parent_id: string;
73
75
  }[];
74
76
  title: string;
75
77
  updated_by?: string | undefined;
76
- active_period_end_date?: import("@tmlmobilidade/types").UnixTimestamp | null | undefined;
77
- coordinates?: [number, number] | null | undefined;
78
- external_id?: string | null | undefined;
79
- file_id?: string | null | undefined;
80
- info_url?: string | undefined;
81
- publish_end_date?: import("@tmlmobilidade/types").UnixTimestamp | null | undefined;
82
78
  }>[]>;
83
79
  findByTitle(title: string): Promise<import("mongodb").WithId<{
84
80
  _id: string;
85
81
  created_at: number & {
86
82
  __brand: "UnixTimestamp";
87
83
  };
88
- created_by: string;
84
+ created_by: string | null;
85
+ is_locked: boolean;
89
86
  updated_at: number & {
90
87
  __brand: "UnixTimestamp";
91
88
  };
92
- type: "PLANNED" | "REALTIME";
89
+ type: "PLANNED" | "REALTIME" | null;
90
+ active_period_end_date: import("@tmlmobilidade/types").UnixTimestamp | null;
93
91
  active_period_start_date: number & {
94
92
  __brand: "UnixTimestamp";
95
93
  };
96
94
  cause: "ACCIDENT" | "CONSTRUCTION" | "DEMONSTRATION" | "HOLIDAY" | "MAINTENANCE" | "MEDICAL_EMERGENCY" | "OTHER_CAUSE" | "POLICE_ACTIVITY" | "STRIKE" | "TECHNICAL_PROBLEM" | "UNKNOWN_CAUSE" | "WEATHER" | "DRIVER_ABSENCE" | "DRIVER_ISSUE" | "HIGH_PASSENGER_LOAD" | "ROAD_INCIDENT" | "SYSTEM_FAILURE" | "TRAFFIC_JAM" | "VEHICLE_ISSUE";
95
+ coordinates: [number, number] | null;
97
96
  description: string;
98
97
  effect: "ACCESSIBILITY_ISSUE" | "ADDITIONAL_SERVICE" | "DETOUR" | "MODIFIED_SERVICE" | "NO_EFFECT" | "NO_SERVICE" | "OTHER_EFFECT" | "REDUCED_SERVICE" | "SIGNIFICANT_DELAYS" | "STOP_MOVED" | "UNKNOWN_EFFECT";
99
- modified_by: string;
98
+ external_id: string | null;
99
+ file_id: string | null;
100
+ info_url: string | null;
100
101
  municipality_ids: string[];
101
- publish_start_date: number & {
102
- __brand: "UnixTimestamp";
103
- };
102
+ publish_end_date: import("@tmlmobilidade/types").UnixTimestamp | null;
103
+ publish_start_date: import("@tmlmobilidade/types").UnixTimestamp | null;
104
104
  publish_status: "PUBLISHED" | "ARCHIVED" | "DRAFT";
105
- reference_type: "LINE" | "STOP" | "AGENCY" | "TRIP";
105
+ reference_type: "LINE" | "STOP" | "AGENCY" | "TRIP" | null;
106
106
  references: {
107
107
  child_ids: string[];
108
108
  parent_id: string;
109
109
  }[];
110
110
  title: string;
111
111
  updated_by?: string | undefined;
112
- active_period_end_date?: import("@tmlmobilidade/types").UnixTimestamp | null | undefined;
113
- coordinates?: [number, number] | null | undefined;
114
- external_id?: string | null | undefined;
115
- file_id?: string | null | undefined;
116
- info_url?: string | undefined;
117
- publish_end_date?: import("@tmlmobilidade/types").UnixTimestamp | null | undefined;
118
112
  }>>;
119
113
  protected getCollectionIndexes(): IndexDescription[];
120
114
  protected getCollectionName(): string;
package/dist/interfaces/auth/roles.d.ts CHANGED
@@ -17,13 +17,13 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
17
17
  findById(id: string, options?: FindOptions): Promise<{
18
18
  permissions: ({
19
19
  scope: "agencies";
20
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
20
+ action: "create" | "update" | "delete" | "read" | "lock";
21
21
  } | {
22
22
  scope: "alerts_scheduled";
23
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
23
+ action: "create" | "update" | "delete" | "read" | "lock";
24
24
  } | {
25
25
  scope: "alerts_realtime";
26
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
26
+ action: "create" | "update" | "delete" | "read" | "lock";
27
27
  resources: {
28
28
  agency_ids: string[];
29
29
  };
@@ -38,7 +38,7 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
38
38
  action: "read";
39
39
  } | {
40
40
  scope: "gtfs_validations";
41
- action: "create" | "read" | "request_approval";
41
+ action: "create" | "read" | "lock" | "request_approval";
42
42
  resources: {
43
43
  agency_ids: string[];
44
44
  };
@@ -47,29 +47,35 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
47
47
  action: "read_links" | "read_wiki";
48
48
  } | {
49
49
  scope: "organizations";
50
- action: "create" | "update" | "delete" | "read";
50
+ action: "create" | "update" | "delete" | "read" | "lock";
51
51
  } | {
52
52
  scope: "performance";
53
53
  action: "read";
54
54
  } | {
55
55
  scope: "plans";
56
- action: "create" | "update" | "delete" | "read" | "toggle_lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
56
+ action: "create" | "update" | "delete" | "read" | "lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
57
57
  resources: {
58
58
  agency_ids: string[];
59
59
  };
60
60
  } | {
61
61
  scope: "roles";
62
- action: "create" | "update" | "delete" | "read";
62
+ action: "create" | "update" | "delete" | "read" | "lock";
63
63
  } | {
64
64
  scope: "stops";
65
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
65
+ action: "create" | "update" | "delete" | "read" | "lock";
66
66
  resources: {
67
67
  municipality_ids: string[];
68
68
  agency_ids: string[];
69
69
  };
70
70
  } | {
71
71
  scope: "users";
72
- action: "create" | "update" | "delete" | "read";
72
+ action: "create" | "update" | "delete" | "read" | "lock";
73
+ } | {
74
+ scope: "dates";
75
+ action: "create_annotations" | "delete_annotations" | "read_annotations" | "update_annotations" | "lock_annotations";
76
+ resources: {
77
+ agency_ids: string[];
78
+ };
73
79
  })[];
74
80
  created_at: number & {
75
81
  __brand: "UnixTimestamp";
@@ -79,6 +85,7 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
79
85
  __brand: "UnixTimestamp";
80
86
  };
81
87
  updated_by?: string | undefined;
88
+ is_locked: boolean;
82
89
  name: string;
83
90
  _id: string;
84
91
  }>;
@@ -94,13 +101,13 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
94
101
  findMany(filter?: Filter<Role>, options?: FindOptions): Promise<{
95
102
  permissions: ({
96
103
  scope: "agencies";
97
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
104
+ action: "create" | "update" | "delete" | "read" | "lock";
98
105
  } | {
99
106
  scope: "alerts_scheduled";
100
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
107
+ action: "create" | "update" | "delete" | "read" | "lock";
101
108
  } | {
102
109
  scope: "alerts_realtime";
103
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
110
+ action: "create" | "update" | "delete" | "read" | "lock";
104
111
  resources: {
105
112
  agency_ids: string[];
106
113
  };
@@ -115,7 +122,7 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
115
122
  action: "read";
116
123
  } | {
117
124
  scope: "gtfs_validations";
118
- action: "create" | "read" | "request_approval";
125
+ action: "create" | "read" | "lock" | "request_approval";
119
126
  resources: {
120
127
  agency_ids: string[];
121
128
  };
@@ -124,29 +131,35 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
124
131
  action: "read_links" | "read_wiki";
125
132
  } | {
126
133
  scope: "organizations";
127
- action: "create" | "update" | "delete" | "read";
134
+ action: "create" | "update" | "delete" | "read" | "lock";
128
135
  } | {
129
136
  scope: "performance";
130
137
  action: "read";
131
138
  } | {
132
139
  scope: "plans";
133
- action: "create" | "update" | "delete" | "read" | "toggle_lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
140
+ action: "create" | "update" | "delete" | "read" | "lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
134
141
  resources: {
135
142
  agency_ids: string[];
136
143
  };
137
144
  } | {
138
145
  scope: "roles";
139
- action: "create" | "update" | "delete" | "read";
146
+ action: "create" | "update" | "delete" | "read" | "lock";
140
147
  } | {
141
148
  scope: "stops";
142
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
149
+ action: "create" | "update" | "delete" | "read" | "lock";
143
150
  resources: {
144
151
  municipality_ids: string[];
145
152
  agency_ids: string[];
146
153
  };
147
154
  } | {
148
155
  scope: "users";
149
- action: "create" | "update" | "delete" | "read";
156
+ action: "create" | "update" | "delete" | "read" | "lock";
157
+ } | {
158
+ scope: "dates";
159
+ action: "create_annotations" | "delete_annotations" | "read_annotations" | "update_annotations" | "lock_annotations";
160
+ resources: {
161
+ agency_ids: string[];
162
+ };
150
163
  })[];
151
164
  created_at: number & {
152
165
  __brand: "UnixTimestamp";
@@ -156,6 +169,7 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
156
169
  __brand: "UnixTimestamp";
157
170
  };
158
171
  updated_by?: string | undefined;
172
+ is_locked: boolean;
159
173
  name: string;
160
174
  _id: string;
161
175
  }[]>;
@@ -167,13 +181,13 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
167
181
  findOne(filter: Filter<Role>): Promise<{
168
182
  permissions: ({
169
183
  scope: "agencies";
170
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
184
+ action: "create" | "update" | "delete" | "read" | "lock";
171
185
  } | {
172
186
  scope: "alerts_scheduled";
173
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
187
+ action: "create" | "update" | "delete" | "read" | "lock";
174
188
  } | {
175
189
  scope: "alerts_realtime";
176
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
190
+ action: "create" | "update" | "delete" | "read" | "lock";
177
191
  resources: {
178
192
  agency_ids: string[];
179
193
  };
@@ -188,7 +202,7 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
188
202
  action: "read";
189
203
  } | {
190
204
  scope: "gtfs_validations";
191
- action: "create" | "read" | "request_approval";
205
+ action: "create" | "read" | "lock" | "request_approval";
192
206
  resources: {
193
207
  agency_ids: string[];
194
208
  };
@@ -197,29 +211,35 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
197
211
  action: "read_links" | "read_wiki";
198
212
  } | {
199
213
  scope: "organizations";
200
- action: "create" | "update" | "delete" | "read";
214
+ action: "create" | "update" | "delete" | "read" | "lock";
201
215
  } | {
202
216
  scope: "performance";
203
217
  action: "read";
204
218
  } | {
205
219
  scope: "plans";
206
- action: "create" | "update" | "delete" | "read" | "toggle_lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
220
+ action: "create" | "update" | "delete" | "read" | "lock" | "read_controller" | "read_pcgi_legacy" | "update_controller" | "update_feed_info_dates" | "update_gtfs_plan" | "update_pcgi_legacy";
207
221
  resources: {
208
222
  agency_ids: string[];
209
223
  };
210
224
  } | {
211
225
  scope: "roles";
212
- action: "create" | "update" | "delete" | "read";
226
+ action: "create" | "update" | "delete" | "read" | "lock";
213
227
  } | {
214
228
  scope: "stops";
215
- action: "create" | "update" | "delete" | "read" | "toggle_lock";
229
+ action: "create" | "update" | "delete" | "read" | "lock";
216
230
  resources: {
217
231
  municipality_ids: string[];
218
232
  agency_ids: string[];
219
233
  };
220
234
  } | {
221
235
  scope: "users";
222
- action: "create" | "update" | "delete" | "read";
236
+ action: "create" | "update" | "delete" | "read" | "lock";
237
+ } | {
238
+ scope: "dates";
239
+ action: "create_annotations" | "delete_annotations" | "read_annotations" | "update_annotations" | "lock_annotations";
240
+ resources: {
241
+ agency_ids: string[];
242
+ };
223
243
  })[];
224
244
  created_at: number & {
225
245
  __brand: "UnixTimestamp";
@@ -229,6 +249,7 @@ declare class RolesClass extends MongoCollectionClass<Role, CreateRoleDto, Updat
229
249
  __brand: "UnixTimestamp";
230
250
  };
231
251
  updated_by?: string | undefined;
252
+ is_locked: boolean;
232
253
  name: string;
233
254
  _id: string;
234
255
  }>;