@urbankitstudio/atlas 0.6.39 → 0.6.40
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.
- package/README.md +2 -2
- package/data/georgia.json +10 -10
- package/data/illinois.json +43 -1
- package/data/index.json +12 -12
- package/data/kentucky.json +11 -83
- package/data/north-carolina.json +203 -1
- package/data/ohio.json +233 -1
- package/data/south-carolina.json +13 -35
- package/dist/index.cjs +537 -143
- package/dist/index.d.cts +28 -1
- package/dist/index.d.ts +28 -1
- package/dist/index.js +536 -144
- package/package.json +2 -2
package/dist/index.d.cts
CHANGED
|
@@ -98,6 +98,22 @@ interface CoverageRecordLike extends EndpointPresenceLike {
|
|
|
98
98
|
} | null;
|
|
99
99
|
coverage?: CountyCoverage | null;
|
|
100
100
|
}
|
|
101
|
+
/**
|
|
102
|
+
* Does the record's own retirement explain the county better than a pause
|
|
103
|
+
* would? True for a record with no endpoint whose coverage reason is anything
|
|
104
|
+
* but "licence-restricted": the county published nothing we can serve (it sold
|
|
105
|
+
* its data, made the layer private, ...), so the honest answer is the coverage
|
|
106
|
+
* block with the record's summary, whatever the access switch says about the
|
|
107
|
+
* county. A "licence-restricted" record keeps the paused answer: its endpoint
|
|
108
|
+
* was withheld under the county's terms, which is the pause's own story. A
|
|
109
|
+
* record WITH an endpoint never qualifies, so a paused county whose endpoint
|
|
110
|
+
* comes back is paused again with no edit; nor does a contradictory record
|
|
111
|
+
* (hasPublicRest false beside a non-empty endpoints array: validate-atlas
|
|
112
|
+
* rejects the shape, so this is defensive), because an override would drop even
|
|
113
|
+
* an all-off pause and discovery would serve the endpoints the record lists.
|
|
114
|
+
* (Leo, 2026-10-18.)
|
|
115
|
+
*/
|
|
116
|
+
declare function coverageOverridesPause(record: CoverageRecordLike | null | undefined): boolean;
|
|
101
117
|
/** `why` for a county the atlas has no record for. */
|
|
102
118
|
declare const NOT_IN_ATLAS_WHY = "This county is not in the UrbanKit atlas.";
|
|
103
119
|
/** `why` for a recorded county whose record carries no coverage summary (data older than the field). */
|
|
@@ -563,6 +579,17 @@ interface CountyPausedAnswer {
|
|
|
563
579
|
}
|
|
564
580
|
/** The paused answer for one county. `record` is its atlas record when known. */
|
|
565
581
|
declare function pausedAnswer(entry: CountyAccessEntry, record: AccessRecordLike | null | undefined, page?: AccessPageRef): CountyPausedAnswer;
|
|
582
|
+
/**
|
|
583
|
+
* The one sentence every surface gives for a county whose own GIS server is
|
|
584
|
+
* down: the liveness probe observed `down`, the operator paused it with reason
|
|
585
|
+
* `upstream-broken`, or a county query failed on the county's side
|
|
586
|
+
* (`county-unavailable`). It names the county's end, not ours, and says nothing
|
|
587
|
+
* about money: whether a call was charged is that call's fact, so each surface
|
|
588
|
+
* appends its own conditional charge clause (the enrichment-billing.ts rule).
|
|
589
|
+
* `countyName` is the name as that surface shows it ("Fulton", "Kane County");
|
|
590
|
+
* unknown, the sentence says "The county's".
|
|
591
|
+
*/
|
|
592
|
+
declare function countyDownMessage(countyName: string | null | undefined): string;
|
|
566
593
|
|
|
567
594
|
/**
|
|
568
595
|
* Look up a county by state slug and county slug. A two-letter state
|
|
@@ -1139,4 +1166,4 @@ declare function citiesForCounty(stateSlug: string, countySlug: string): CitySum
|
|
|
1139
1166
|
declare const cityPropertyIndex: CityPropertyIndex;
|
|
1140
1167
|
declare const cityZoningIndex: CityZoningIndex;
|
|
1141
1168
|
|
|
1142
|
-
export { ACCESS_FLAGS, ACCESS_PRESETS, ACCESS_REASONS, ATLAS_COUNTY_PAGE_BASE, type AccessFlag, type AccessFlags, type AccessPageRef, type AccessPreset, type AccessReason, type AccessRecordLike, type Atlas, type AtlasIndex, CITY_RECORD_LIMIT, CITY_STREET_MAX_LEN, COUNTY_RECHECK_REQUEST_MESSAGE, COUNTY_REQUEST_MESSAGE, COUNTY_REQUEST_URL, COVERAGE_REASONS, type CapabilityBasis, type CapabilityBasisType, type CapabilityField, type CapabilityOverrides, type CapabilityStatus, type CaseFieldMap, type CasesSource, type CityDatasetDescriptor, type CityFilter, type CityKind, type CityLookup, type CityPropertyIndex, type CityPropertyIndexEntry, type CityPropertyRecord, type CityProvider, type CityQueryTemplate, type CitySource, type CitySummary, type CityZoningIndex, type CityZoningIndexEntry, type CityZoningRecord, type ContactInfo, type CountyAccessEntry, type CountyAdvisory, type CountyCoverage, type CountyPausedAnswer, type CountyProduct, type CountyRecord, type CountyRequestHint, type CountyRequestRef, type CoverageAnswer, type CoverageReason, type CoverageRecordLike, type CoverageStatus, type CoverageTextInput, type CurrentZoningFieldMap, type CurrentZoningSource, type DatasetKind, type DeepLinkCounty, type EndpointPresenceLike, type EndpointRecord, type EndpointStatus, type GeocoderConfig, type GeocoderProvider, LIVE_STATUS_URL, type LicenseType, NOT_IN_ATLAS_WHY, NO_PUBLIC_DATA_WHY, POINT_PLACEHOLDER, PRESET_FLAGS, type PropertyDataset, type PropertyDatasets, type PropertyFieldMap, type PropertySource, type PropertySourceType, type PropertyStatusBuckets, type SearchField, type ServiceType, type SplitStreet, type StateFile, type StateIndexEntry, type VerifiedBy, type ZoningByAddressSource, type ZoningSourceType, type ZoningStatusBuckets, type ZoningToolKind, accessBlocks, atlas, atlasIndex, buildCityQuery, buildParcelLookupDeepLink, canonicalLayerUrl, casesLocationTemplate, casesQueryUrl, citiesForCounty, citiesForCountyIn, cityDatasetDescriptors, cityDatasets, cityPath, cityPropertyIndex, cityZoningIndex, countyHasEndpoint, countyOffersAttributeSearch, countyPath, countySlugFromName, coverageAnswer, coverageAnswerText, currentZoningTemplate, findCity, findCityIn, findCounty, findCountyByFips, findState, flagsFor, getCityProperty, getCityZoning, isReviewedUnservable, listCities, listCountiesByState, listStates, mergeCityIndexes, offersAttributeSearch, offersPagination, pausedAnswer, pausedFlags, presetOf, propertyQueryUrl, requestHint, reviewedCapability, slugify, splitAddressStreetName, splitStreet, statePath, streetForDataset };
|
|
1169
|
+
export { ACCESS_FLAGS, ACCESS_PRESETS, ACCESS_REASONS, ATLAS_COUNTY_PAGE_BASE, type AccessFlag, type AccessFlags, type AccessPageRef, type AccessPreset, type AccessReason, type AccessRecordLike, type Atlas, type AtlasIndex, CITY_RECORD_LIMIT, CITY_STREET_MAX_LEN, COUNTY_RECHECK_REQUEST_MESSAGE, COUNTY_REQUEST_MESSAGE, COUNTY_REQUEST_URL, COVERAGE_REASONS, type CapabilityBasis, type CapabilityBasisType, type CapabilityField, type CapabilityOverrides, type CapabilityStatus, type CaseFieldMap, type CasesSource, type CityDatasetDescriptor, type CityFilter, type CityKind, type CityLookup, type CityPropertyIndex, type CityPropertyIndexEntry, type CityPropertyRecord, type CityProvider, type CityQueryTemplate, type CitySource, type CitySummary, type CityZoningIndex, type CityZoningIndexEntry, type CityZoningRecord, type ContactInfo, type CountyAccessEntry, type CountyAdvisory, type CountyCoverage, type CountyPausedAnswer, type CountyProduct, type CountyRecord, type CountyRequestHint, type CountyRequestRef, type CoverageAnswer, type CoverageReason, type CoverageRecordLike, type CoverageStatus, type CoverageTextInput, type CurrentZoningFieldMap, type CurrentZoningSource, type DatasetKind, type DeepLinkCounty, type EndpointPresenceLike, type EndpointRecord, type EndpointStatus, type GeocoderConfig, type GeocoderProvider, LIVE_STATUS_URL, type LicenseType, NOT_IN_ATLAS_WHY, NO_PUBLIC_DATA_WHY, POINT_PLACEHOLDER, PRESET_FLAGS, type PropertyDataset, type PropertyDatasets, type PropertyFieldMap, type PropertySource, type PropertySourceType, type PropertyStatusBuckets, type SearchField, type ServiceType, type SplitStreet, type StateFile, type StateIndexEntry, type VerifiedBy, type ZoningByAddressSource, type ZoningSourceType, type ZoningStatusBuckets, type ZoningToolKind, accessBlocks, atlas, atlasIndex, buildCityQuery, buildParcelLookupDeepLink, canonicalLayerUrl, casesLocationTemplate, casesQueryUrl, citiesForCounty, citiesForCountyIn, cityDatasetDescriptors, cityDatasets, cityPath, cityPropertyIndex, cityZoningIndex, countyDownMessage, countyHasEndpoint, countyOffersAttributeSearch, countyPath, countySlugFromName, coverageAnswer, coverageAnswerText, coverageOverridesPause, currentZoningTemplate, findCity, findCityIn, findCounty, findCountyByFips, findState, flagsFor, getCityProperty, getCityZoning, isReviewedUnservable, listCities, listCountiesByState, listStates, mergeCityIndexes, offersAttributeSearch, offersPagination, pausedAnswer, pausedFlags, presetOf, propertyQueryUrl, requestHint, reviewedCapability, slugify, splitAddressStreetName, splitStreet, statePath, streetForDataset };
|
package/dist/index.d.ts
CHANGED
|
@@ -98,6 +98,22 @@ interface CoverageRecordLike extends EndpointPresenceLike {
|
|
|
98
98
|
} | null;
|
|
99
99
|
coverage?: CountyCoverage | null;
|
|
100
100
|
}
|
|
101
|
+
/**
|
|
102
|
+
* Does the record's own retirement explain the county better than a pause
|
|
103
|
+
* would? True for a record with no endpoint whose coverage reason is anything
|
|
104
|
+
* but "licence-restricted": the county published nothing we can serve (it sold
|
|
105
|
+
* its data, made the layer private, ...), so the honest answer is the coverage
|
|
106
|
+
* block with the record's summary, whatever the access switch says about the
|
|
107
|
+
* county. A "licence-restricted" record keeps the paused answer: its endpoint
|
|
108
|
+
* was withheld under the county's terms, which is the pause's own story. A
|
|
109
|
+
* record WITH an endpoint never qualifies, so a paused county whose endpoint
|
|
110
|
+
* comes back is paused again with no edit; nor does a contradictory record
|
|
111
|
+
* (hasPublicRest false beside a non-empty endpoints array: validate-atlas
|
|
112
|
+
* rejects the shape, so this is defensive), because an override would drop even
|
|
113
|
+
* an all-off pause and discovery would serve the endpoints the record lists.
|
|
114
|
+
* (Leo, 2026-10-18.)
|
|
115
|
+
*/
|
|
116
|
+
declare function coverageOverridesPause(record: CoverageRecordLike | null | undefined): boolean;
|
|
101
117
|
/** `why` for a county the atlas has no record for. */
|
|
102
118
|
declare const NOT_IN_ATLAS_WHY = "This county is not in the UrbanKit atlas.";
|
|
103
119
|
/** `why` for a recorded county whose record carries no coverage summary (data older than the field). */
|
|
@@ -563,6 +579,17 @@ interface CountyPausedAnswer {
|
|
|
563
579
|
}
|
|
564
580
|
/** The paused answer for one county. `record` is its atlas record when known. */
|
|
565
581
|
declare function pausedAnswer(entry: CountyAccessEntry, record: AccessRecordLike | null | undefined, page?: AccessPageRef): CountyPausedAnswer;
|
|
582
|
+
/**
|
|
583
|
+
* The one sentence every surface gives for a county whose own GIS server is
|
|
584
|
+
* down: the liveness probe observed `down`, the operator paused it with reason
|
|
585
|
+
* `upstream-broken`, or a county query failed on the county's side
|
|
586
|
+
* (`county-unavailable`). It names the county's end, not ours, and says nothing
|
|
587
|
+
* about money: whether a call was charged is that call's fact, so each surface
|
|
588
|
+
* appends its own conditional charge clause (the enrichment-billing.ts rule).
|
|
589
|
+
* `countyName` is the name as that surface shows it ("Fulton", "Kane County");
|
|
590
|
+
* unknown, the sentence says "The county's".
|
|
591
|
+
*/
|
|
592
|
+
declare function countyDownMessage(countyName: string | null | undefined): string;
|
|
566
593
|
|
|
567
594
|
/**
|
|
568
595
|
* Look up a county by state slug and county slug. A two-letter state
|
|
@@ -1139,4 +1166,4 @@ declare function citiesForCounty(stateSlug: string, countySlug: string): CitySum
|
|
|
1139
1166
|
declare const cityPropertyIndex: CityPropertyIndex;
|
|
1140
1167
|
declare const cityZoningIndex: CityZoningIndex;
|
|
1141
1168
|
|
|
1142
|
-
export { ACCESS_FLAGS, ACCESS_PRESETS, ACCESS_REASONS, ATLAS_COUNTY_PAGE_BASE, type AccessFlag, type AccessFlags, type AccessPageRef, type AccessPreset, type AccessReason, type AccessRecordLike, type Atlas, type AtlasIndex, CITY_RECORD_LIMIT, CITY_STREET_MAX_LEN, COUNTY_RECHECK_REQUEST_MESSAGE, COUNTY_REQUEST_MESSAGE, COUNTY_REQUEST_URL, COVERAGE_REASONS, type CapabilityBasis, type CapabilityBasisType, type CapabilityField, type CapabilityOverrides, type CapabilityStatus, type CaseFieldMap, type CasesSource, type CityDatasetDescriptor, type CityFilter, type CityKind, type CityLookup, type CityPropertyIndex, type CityPropertyIndexEntry, type CityPropertyRecord, type CityProvider, type CityQueryTemplate, type CitySource, type CitySummary, type CityZoningIndex, type CityZoningIndexEntry, type CityZoningRecord, type ContactInfo, type CountyAccessEntry, type CountyAdvisory, type CountyCoverage, type CountyPausedAnswer, type CountyProduct, type CountyRecord, type CountyRequestHint, type CountyRequestRef, type CoverageAnswer, type CoverageReason, type CoverageRecordLike, type CoverageStatus, type CoverageTextInput, type CurrentZoningFieldMap, type CurrentZoningSource, type DatasetKind, type DeepLinkCounty, type EndpointPresenceLike, type EndpointRecord, type EndpointStatus, type GeocoderConfig, type GeocoderProvider, LIVE_STATUS_URL, type LicenseType, NOT_IN_ATLAS_WHY, NO_PUBLIC_DATA_WHY, POINT_PLACEHOLDER, PRESET_FLAGS, type PropertyDataset, type PropertyDatasets, type PropertyFieldMap, type PropertySource, type PropertySourceType, type PropertyStatusBuckets, type SearchField, type ServiceType, type SplitStreet, type StateFile, type StateIndexEntry, type VerifiedBy, type ZoningByAddressSource, type ZoningSourceType, type ZoningStatusBuckets, type ZoningToolKind, accessBlocks, atlas, atlasIndex, buildCityQuery, buildParcelLookupDeepLink, canonicalLayerUrl, casesLocationTemplate, casesQueryUrl, citiesForCounty, citiesForCountyIn, cityDatasetDescriptors, cityDatasets, cityPath, cityPropertyIndex, cityZoningIndex, countyHasEndpoint, countyOffersAttributeSearch, countyPath, countySlugFromName, coverageAnswer, coverageAnswerText, currentZoningTemplate, findCity, findCityIn, findCounty, findCountyByFips, findState, flagsFor, getCityProperty, getCityZoning, isReviewedUnservable, listCities, listCountiesByState, listStates, mergeCityIndexes, offersAttributeSearch, offersPagination, pausedAnswer, pausedFlags, presetOf, propertyQueryUrl, requestHint, reviewedCapability, slugify, splitAddressStreetName, splitStreet, statePath, streetForDataset };
|
|
1169
|
+
export { ACCESS_FLAGS, ACCESS_PRESETS, ACCESS_REASONS, ATLAS_COUNTY_PAGE_BASE, type AccessFlag, type AccessFlags, type AccessPageRef, type AccessPreset, type AccessReason, type AccessRecordLike, type Atlas, type AtlasIndex, CITY_RECORD_LIMIT, CITY_STREET_MAX_LEN, COUNTY_RECHECK_REQUEST_MESSAGE, COUNTY_REQUEST_MESSAGE, COUNTY_REQUEST_URL, COVERAGE_REASONS, type CapabilityBasis, type CapabilityBasisType, type CapabilityField, type CapabilityOverrides, type CapabilityStatus, type CaseFieldMap, type CasesSource, type CityDatasetDescriptor, type CityFilter, type CityKind, type CityLookup, type CityPropertyIndex, type CityPropertyIndexEntry, type CityPropertyRecord, type CityProvider, type CityQueryTemplate, type CitySource, type CitySummary, type CityZoningIndex, type CityZoningIndexEntry, type CityZoningRecord, type ContactInfo, type CountyAccessEntry, type CountyAdvisory, type CountyCoverage, type CountyPausedAnswer, type CountyProduct, type CountyRecord, type CountyRequestHint, type CountyRequestRef, type CoverageAnswer, type CoverageReason, type CoverageRecordLike, type CoverageStatus, type CoverageTextInput, type CurrentZoningFieldMap, type CurrentZoningSource, type DatasetKind, type DeepLinkCounty, type EndpointPresenceLike, type EndpointRecord, type EndpointStatus, type GeocoderConfig, type GeocoderProvider, LIVE_STATUS_URL, type LicenseType, NOT_IN_ATLAS_WHY, NO_PUBLIC_DATA_WHY, POINT_PLACEHOLDER, PRESET_FLAGS, type PropertyDataset, type PropertyDatasets, type PropertyFieldMap, type PropertySource, type PropertySourceType, type PropertyStatusBuckets, type SearchField, type ServiceType, type SplitStreet, type StateFile, type StateIndexEntry, type VerifiedBy, type ZoningByAddressSource, type ZoningSourceType, type ZoningStatusBuckets, type ZoningToolKind, accessBlocks, atlas, atlasIndex, buildCityQuery, buildParcelLookupDeepLink, canonicalLayerUrl, casesLocationTemplate, casesQueryUrl, citiesForCounty, citiesForCountyIn, cityDatasetDescriptors, cityDatasets, cityPath, cityPropertyIndex, cityZoningIndex, countyDownMessage, countyHasEndpoint, countyOffersAttributeSearch, countyPath, countySlugFromName, coverageAnswer, coverageAnswerText, coverageOverridesPause, currentZoningTemplate, findCity, findCityIn, findCounty, findCountyByFips, findState, flagsFor, getCityProperty, getCityZoning, isReviewedUnservable, listCities, listCountiesByState, listStates, mergeCityIndexes, offersAttributeSearch, offersPagination, pausedAnswer, pausedFlags, presetOf, propertyQueryUrl, requestHint, reviewedCapability, slugify, splitAddressStreetName, splitStreet, statePath, streetForDataset };
|