@tiangong-ai/cli 0.0.50 → 0.0.55

package/dist/data/connectors/usgs-water-instantaneous-values.schemas.d.ts

@@ -0,0 +1,496 @@
+export declare const USGS_WATER_IV_INPUT_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://schemas.tiangong.ai/data/usgs/water-instantaneous-values-input.v1.json";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly boundingBox: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["minLongitude", "minLatitude", "maxLongitude", "maxLatitude"];
+            readonly description: "USGS bBox major filter in WGS84-style decimal degrees. The coordinate-span product must not exceed 25 square degrees.";
+            readonly examples: readonly [{
+                readonly minLongitude: -77.3;
+                readonly minLatitude: 38.8;
+                readonly maxLongitude: -77;
+                readonly maxLatitude: 39.1;
+            }];
+            readonly properties: {
+                readonly minLongitude: {
+                    readonly type: "number";
+                    readonly minimum: -180;
+                    readonly maximum: 180;
+                    readonly description: "Western longitude boundary in decimal degrees.";
+                    readonly examples: readonly [-77.3];
+                };
+                readonly minLatitude: {
+                    readonly type: "number";
+                    readonly minimum: -90;
+                    readonly maximum: 90;
+                    readonly description: "Southern latitude boundary in decimal degrees.";
+                    readonly examples: readonly [38.8];
+                };
+                readonly maxLongitude: {
+                    readonly type: "number";
+                    readonly minimum: -180;
+                    readonly maximum: 180;
+                    readonly description: "Eastern longitude boundary in decimal degrees.";
+                    readonly examples: readonly [-77];
+                };
+                readonly maxLatitude: {
+                    readonly type: "number";
+                    readonly minimum: -90;
+                    readonly maximum: 90;
+                    readonly description: "Northern latitude boundary in decimal degrees.";
+                    readonly examples: readonly [39.1];
+                };
+            };
+        };
+        readonly siteNumbers: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly maxItems: 100;
+            readonly uniqueItems: true;
+            readonly description: "Explicit numeric USGS site identifiers. Use instead of boundingBox; at most 100 are accepted by WaterServices.";
+            readonly examples: readonly [readonly ["01646500", "01646000"]];
+            readonly items: {
+                readonly type: "string";
+                readonly pattern: "^\\d+$";
+                readonly description: "One numeric USGS site identifier, preserving any leading zeroes.";
+                readonly examples: readonly ["01646500"];
+            };
+        };
+        readonly period: {
+            readonly type: "string";
+            readonly minLength: 2;
+            readonly maxLength: 64;
+            readonly pattern: "^P(?=.*\\d)(?:\\d+(?:\\.\\d+)?Y)?(?:\\d+(?:\\.\\d+)?M)?(?:\\d+(?:\\.\\d+)?W)?(?:\\d+(?:\\.\\d+)?D)?(?:T(?=\\d)(?:\\d+(?:\\.\\d+)?H)?(?:\\d+(?:\\.\\d+)?M)?(?:\\d+(?:\\.\\d+)?S)?)?$";
+            readonly description: "Positive ISO-8601 duration ending at the provider's most recent value. Week notation cannot be mixed with other duration components. Use instead of an explicit start/end window.";
+            readonly examples: readonly ["P1D", "PT2H"];
+        };
+        readonly startDateTimeUtc: {
+            readonly type: "string";
+            readonly pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$";
+            readonly description: "Inclusive explicit start instant with timezone. It must be paired with endDateTimeUtc and must not follow it.";
+            readonly examples: readonly ["2026-03-21T00:00:00Z"];
+        };
+        readonly endDateTimeUtc: {
+            readonly type: "string";
+            readonly pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$";
+            readonly description: "Inclusive explicit end instant with timezone. It must be paired with startDateTimeUtc.";
+            readonly examples: readonly ["2026-03-22T23:59:59Z"];
+        };
+        readonly parameterCodes: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly maxItems: 8;
+            readonly uniqueItems: true;
+            readonly description: "Five-digit USGS parameter codes to retrieve. Defaults to discharge 00060 and gage height 00065.";
+            readonly examples: readonly [readonly ["00060", "00065"]];
+            readonly items: {
+                readonly type: "string";
+                readonly pattern: "^\\d{5}$";
+                readonly description: "One five-digit USGS time-series parameter code.";
+                readonly examples: readonly ["00060"];
+            };
+        };
+        readonly siteType: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 128;
+            readonly pattern: "^[A-Za-z0-9-]+(?:,[A-Za-z0-9-]+)*$";
+            readonly description: "Comma-separated USGS site-type filter. Defaults to ST, which selects streams and its subtypes.";
+            readonly examples: readonly ["ST", "ST,LA-OU"];
+        };
+        readonly siteStatus: {
+            readonly enum: readonly ["all", "active", "inactive"];
+            readonly description: "USGS activity-status filter. Defaults to active to preserve this Skill's bounded monitoring behavior.";
+            readonly examples: readonly ["active"];
+        };
+        readonly agencyCode: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 32;
+            readonly pattern: "^[A-Za-z0-9-]+$";
+            readonly description: "Optional organization code used by USGS to filter site maintainers.";
+            readonly examples: readonly ["USGS"];
+        };
+    };
+    readonly allOf: readonly [{
+        readonly oneOf: readonly [{
+            readonly required: readonly ["boundingBox"];
+            readonly properties: {
+                readonly boundingBox: {};
+                readonly siteNumbers: false;
+            };
+        }, {
+            readonly required: readonly ["siteNumbers"];
+            readonly properties: {
+                readonly boundingBox: false;
+                readonly siteNumbers: {};
+            };
+        }];
+    }, {
+        readonly oneOf: readonly [{
+            readonly required: readonly ["period"];
+            readonly properties: {
+                readonly period: {};
+                readonly startDateTimeUtc: false;
+                readonly endDateTimeUtc: false;
+            };
+        }, {
+            readonly required: readonly ["startDateTimeUtc", "endDateTimeUtc"];
+            readonly properties: {
+                readonly period: false;
+                readonly startDateTimeUtc: {};
+                readonly endDateTimeUtc: {};
+            };
+        }];
+    }];
+};
+export declare const USGS_WATER_IV_OUTPUT_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://schemas.tiangong.ai/data/usgs/water-instantaneous-values-output.v1.json";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["source", "request", "validation", "series", "records", "stopReason"];
+    readonly properties: {
+        readonly source: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["providerId", "service", "endpoint", "provisionalPossible", "legacyService", "decommissionExpected", "officialReplacement"];
+            readonly properties: {
+                readonly providerId: {
+                    readonly const: "usgs";
+                };
+                readonly service: {
+                    readonly const: "WaterServices Instantaneous Values";
+                };
+                readonly endpoint: {
+                    readonly const: "/nwis/iv/";
+                };
+                readonly provisionalPossible: {
+                    readonly const: true;
+                };
+                readonly legacyService: {
+                    readonly const: true;
+                };
+                readonly decommissionExpected: {
+                    readonly const: "2027-Q1";
+                };
+                readonly officialReplacement: {
+                    readonly const: "https://api.waterdata.usgs.gov/ogcapi/";
+                };
+            };
+        };
+        readonly request: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["selection", "time", "parameterCodes", "siteType", "siteStatus", "agencyCode"];
+            readonly properties: {
+                readonly selection: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["kind", "boundingBox", "siteNumbers"];
+                    readonly properties: {
+                        readonly kind: {
+                            readonly enum: readonly ["bounding-box", "sites"];
+                        };
+                        readonly boundingBox: {
+                            readonly anyOf: readonly [{
+                                readonly type: "object";
+                                readonly additionalProperties: false;
+                                readonly required: readonly ["minLongitude", "minLatitude", "maxLongitude", "maxLatitude"];
+                                readonly description: "USGS bBox major filter in WGS84-style decimal degrees. The coordinate-span product must not exceed 25 square degrees.";
+                                readonly examples: readonly [{
+                                    readonly minLongitude: -77.3;
+                                    readonly minLatitude: 38.8;
+                                    readonly maxLongitude: -77;
+                                    readonly maxLatitude: 39.1;
+                                }];
+                                readonly properties: {
+                                    readonly minLongitude: {
+                                        readonly type: "number";
+                                        readonly minimum: -180;
+                                        readonly maximum: 180;
+                                        readonly description: "Western longitude boundary in decimal degrees.";
+                                        readonly examples: readonly [-77.3];
+                                    };
+                                    readonly minLatitude: {
+                                        readonly type: "number";
+                                        readonly minimum: -90;
+                                        readonly maximum: 90;
+                                        readonly description: "Southern latitude boundary in decimal degrees.";
+                                        readonly examples: readonly [38.8];
+                                    };
+                                    readonly maxLongitude: {
+                                        readonly type: "number";
+                                        readonly minimum: -180;
+                                        readonly maximum: 180;
+                                        readonly description: "Eastern longitude boundary in decimal degrees.";
+                                        readonly examples: readonly [-77];
+                                    };
+                                    readonly maxLatitude: {
+                                        readonly type: "number";
+                                        readonly minimum: -90;
+                                        readonly maximum: 90;
+                                        readonly description: "Northern latitude boundary in decimal degrees.";
+                                        readonly examples: readonly [39.1];
+                                    };
+                                };
+                            }, {
+                                readonly type: "null";
+                            }];
+                        };
+                        readonly siteNumbers: {
+                            readonly anyOf: readonly [{
+                                readonly type: "array";
+                                readonly minItems: 1;
+                                readonly maxItems: 100;
+                                readonly uniqueItems: true;
+                                readonly description: "Explicit numeric USGS site identifiers. Use instead of boundingBox; at most 100 are accepted by WaterServices.";
+                                readonly examples: readonly [readonly ["01646500", "01646000"]];
+                                readonly items: {
+                                    readonly type: "string";
+                                    readonly pattern: "^\\d+$";
+                                    readonly description: "One numeric USGS site identifier, preserving any leading zeroes.";
+                                    readonly examples: readonly ["01646500"];
+                                };
+                            }, {
+                                readonly type: "null";
+                            }];
+                        };
+                    };
+                };
+                readonly time: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["kind", "period", "startDateTimeUtc", "endDateTimeUtc"];
+                    readonly properties: {
+                        readonly kind: {
+                            readonly enum: readonly ["period", "window"];
+                        };
+                        readonly period: {
+                            readonly type: readonly ["string", "null"];
+                        };
+                        readonly startDateTimeUtc: {
+                            readonly type: readonly ["string", "null"];
+                            readonly pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$";
+                        };
+                        readonly endDateTimeUtc: {
+                            readonly type: readonly ["string", "null"];
+                            readonly pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$";
+                        };
+                    };
+                };
+                readonly parameterCodes: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 8;
+                    readonly uniqueItems: true;
+                    readonly description: "Five-digit USGS parameter codes to retrieve. Defaults to discharge 00060 and gage height 00065.";
+                    readonly examples: readonly [readonly ["00060", "00065"]];
+                    readonly items: {
+                        readonly type: "string";
+                        readonly pattern: "^\\d{5}$";
+                        readonly description: "One five-digit USGS time-series parameter code.";
+                        readonly examples: readonly ["00060"];
+                    };
+                };
+                readonly siteType: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly siteStatus: {
+                    readonly enum: readonly ["all", "active", "inactive"];
+                };
+                readonly agencyCode: {
+                    readonly type: readonly ["string", "null"];
+                };
+            };
+        };
+        readonly validation: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["issueCount", "issues"];
+            readonly properties: {
+                readonly issueCount: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly issues: {
+                    readonly type: "array";
+                    readonly maxItems: 50;
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["path", "message"];
+                        readonly properties: {
+                            readonly path: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly message: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        readonly series: {
+            readonly type: "array";
+            readonly maxItems: 500;
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["siteNumber", "siteName", "agencyCode", "siteType", "stateCode", "countyCode", "hucCode", "latitude", "longitude", "parameterCode", "variableName", "variableDescription", "statisticCode", "unit", "recordCount", "provisionalRecordCount", "firstObservedAtUtc", "lastObservedAtUtc"];
+                readonly properties: {
+                    readonly siteNumber: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly siteName: {
+                        readonly type: "string";
+                    };
+                    readonly agencyCode: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly siteType: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly stateCode: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly countyCode: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly hucCode: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly latitude: {
+                        readonly type: readonly ["number", "null"];
+                        readonly minimum: -90;
+                        readonly maximum: 90;
+                    };
+                    readonly longitude: {
+                        readonly type: readonly ["number", "null"];
+                        readonly minimum: -180;
+                        readonly maximum: 180;
+                    };
+                    readonly parameterCode: {
+                        readonly type: "string";
+                        readonly pattern: "^\\d{5}$";
+                    };
+                    readonly variableName: {
+                        readonly type: "string";
+                    };
+                    readonly variableDescription: {
+                        readonly type: "string";
+                    };
+                    readonly statisticCode: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly unit: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly recordCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly provisionalRecordCount: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly firstObservedAtUtc: {
+                        readonly type: readonly ["string", "null"];
+                        readonly pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$";
+                    };
+                    readonly lastObservedAtUtc: {
+                        readonly type: readonly ["string", "null"];
+                        readonly pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$";
+                    };
+                };
+            };
+        };
+        readonly records: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["siteNumber", "siteName", "agencyCode", "siteType", "stateCode", "countyCode", "hucCode", "latitude", "longitude", "parameterCode", "variableName", "variableDescription", "statisticCode", "unit", "observedAtUtc", "value", "qualifiers", "provisional"];
+                readonly properties: {
+                    readonly siteNumber: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly siteName: {
+                        readonly type: "string";
+                    };
+                    readonly agencyCode: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly siteType: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly stateCode: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly countyCode: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly hucCode: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly latitude: {
+                        readonly type: readonly ["number", "null"];
+                        readonly minimum: -90;
+                        readonly maximum: 90;
+                    };
+                    readonly longitude: {
+                        readonly type: readonly ["number", "null"];
+                        readonly minimum: -180;
+                        readonly maximum: 180;
+                    };
+                    readonly parameterCode: {
+                        readonly type: "string";
+                        readonly pattern: "^\\d{5}$";
+                    };
+                    readonly variableName: {
+                        readonly type: "string";
+                    };
+                    readonly variableDescription: {
+                        readonly type: "string";
+                    };
+                    readonly statisticCode: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly unit: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly observedAtUtc: {
+                        readonly type: "string";
+                        readonly pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$";
+                    };
+                    readonly value: {
+                        readonly type: "number";
+                    };
+                    readonly qualifiers: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                    };
+                    readonly provisional: {
+                        readonly type: "boolean";
+                    };
+                };
+            };
+        };
+        readonly stopReason: {
+            readonly enum: readonly ["completed", "max-records", "partial"];
+        };
+    };
+};