@urbankitstudio/atlas 0.9.6 → 0.9.8

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/dist/index.d.cts CHANGED
@@ -212,7 +212,73 @@ interface SearchField {
212
212
  * right when a record does carry one.
213
213
  */
214
214
  wireName?: string;
215
+ /**
216
+ * An opt-in role the column plays. Absent on almost every field; since 0.9.7
217
+ * Dooly County, Georgia (`ga-dooly`) is the first record that declares any.
218
+ * A tag adds a role: read every other column as you would without it.
219
+ *
220
+ * - `"mailing-fallback"`: a second owner-mailing line. Read it ONLY when the
221
+ * endpoint's primary mailing column holds nothing (a blank cell, or a
222
+ * placeholder such as "N/A"; never when the primary is masked, like
223
+ * `"*, *, * #####"`, `"#####-####"`, `"(***)"` or `"#, #, #"`: no letter
224
+ * or digit outside one trailing ZIP, and an asterisk, two or more "#", or a
225
+ * mask glyph such as a bullet or a block; nor when it was withheld from
226
+ * you; a lone "#", "-", "?", "." or "~" is no mask), and ONLY
227
+ * when the value, with invisible characters ignored, is a mailing line: a
228
+ * whole house number then a word (`"123 MAIN ST"`, `"123 1/2 MAIN ST"`;
229
+ * not `"1/2 INT ..."`, not numbers only), a P O Box or P O Drawer with its
230
+ * number (`"P O BOX 77"`, `"PO BOX 77"`, `"POST OFFICE BOX 77"`), or a
231
+ * rural route box (`"RR 2 BOX 15"`, `"HC 63 BOX 1"`), and carries no
232
+ * owner-entity, share, c/o or attention word (LLC, INC, INCORPORATED,
233
+ * CORP, CORPORATION, COMPANY, LTD, LP, LLP, TRUST, TRUSTEE(S), ESTATE,
234
+ * HEIRS, ET AL, ET UX, INT, INTEREST, OWNER(S), PERCENT, PER CENT, PCT,
235
+ * "%", "1 OF 2", C/O, C\O, C/0, CARE OF, ATTN, ATTENTION) and no word
236
+ * that says a value is withheld
237
+ * (CONFIDENTIAL, REDACTED, WITHHELD, PROTECTED, SUPPRESSED, RESTRICTED,
238
+ * NOT DISCLOSED). Read the words after Unicode NFKC, split on anything
239
+ * that is not a letter or digit (a control or zero-width character too),
240
+ * with a run of single letters as one word ("L.L.C." is LLC). One
241
+ * exception: a spelled-out entity word (INCORPORATED, CORPORATION,
242
+ * COMPANY, TRUST, TRUSTEE(S), ESTATE, HEIRS) directly before a street
243
+ * suffix is part of a street name (`"123 ESTATE DR"`, `"40 TRUST RD"`)
244
+ * only when nothing follows the suffix, or only one unit word (APT, UNIT,
245
+ * STE, SUITE, FL, FLOOR, RM, ROOM) and its value, a letter or up to four
246
+ * digits or the two together (`"123 ESTATE DR APT 5"`); after any other
247
+ * tail it is the owner's (`"100 TEST FAMILY TRUST ST LOUIS MO"`,
248
+ * `"5 TEST TRUST CT 06001"`, `"7 TEST ESTATE PT 2"`). Bare CO is no entity
249
+ * word (`"123 CO RD 45"`). Anything else on that
250
+ * line (a c/o line, a second owner name) is not the address.
251
+ * A county REDACTION MARKER on the fallback line ("CONFIDENTIAL",
252
+ * "REDACTED PER KRS 61.878") withholds the whole row, owner included,
253
+ * whatever the primary holds, exactly as one in the primary would.
254
+ * Dooly's primary is `address2`; `address1` is its fallback.
255
+ * - `"situs-directional"`: the street directional of a split site address
256
+ * (house number + street name columns, no single address column). Compose
257
+ * the site address as house number, directional, street name, and use the
258
+ * value only when it is a direction (N, S, E, W, NE, NW, SE, SW, or the
259
+ * word spelled out); Dooly's `stdirect` holds one "Q" that is not. Never
260
+ * compose it into a house number and street that together are a
261
+ * redaction marker ("0 CONFIDENTIAL" stays as it is, and the row is
262
+ * withheld). A redaction marker in the directional column itself
263
+ * ("CONFIDENTIAL") withholds the whole row. The tagged column is never
264
+ * itself the house number, the street name, the owner, the parcel id, a
265
+ * mailing column or a unit or suffix qualifier, and its name or label
266
+ * names a direction ("dir", "direction" or "directional" as a word of
267
+ * its own, a pre, post, st or suf prefix allowed: `PRE_DIR`, "Street
268
+ * Direction"; not `DIRECTOR` or "Direct Bill Flag"). A geocoded address without
269
+ * the directional still names the parcel when only one parcel at that
270
+ * number shares the street name; with it, the directional counts only
271
+ * beside a shared street-name word that is not itself a direction, and a
272
+ * parcel it alone singles out does not win over one at the same number
273
+ * and street whose directional is blank.
274
+ *
275
+ * At most one field per role on an endpoint, and never on
276
+ * `ownerJoin.fields`.
277
+ */
278
+ role?: SearchFieldRole;
215
279
  }
280
+ /** The opt-in column roles a record may declare ({@link SearchField.role}). Since 0.9.7. */
281
+ type SearchFieldRole = "mailing-fallback" | "situs-directional";
216
282
  /**
217
283
  * Owner rows that live in a separate TABLE of the same service, joined to the
218
284
  * endpoint's parcel polygons by a key: the polygons carry `parcelKey`, the
@@ -1353,4 +1419,4 @@ declare function citiesForCounty(stateSlug: string, countySlug: string): CitySum
1353
1419
  declare const cityPropertyIndex: CityPropertyIndex;
1354
1420
  declare const cityZoningIndex: CityZoningIndex;
1355
1421
 
1356
- 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 ConfidentialFlag, 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, type OwnerJoin, 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, queryFieldName, requestHint, reviewedCapability, slugify, splitAddressStreetName, splitStreet, statePath, streetForDataset };
1422
+ 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 ConfidentialFlag, 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, type OwnerJoin, POINT_PLACEHOLDER, PRESET_FLAGS, type PropertyDataset, type PropertyDatasets, type PropertyFieldMap, type PropertySource, type PropertySourceType, type PropertyStatusBuckets, type SearchField, type SearchFieldRole, 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, queryFieldName, requestHint, reviewedCapability, slugify, splitAddressStreetName, splitStreet, statePath, streetForDataset };
package/dist/index.d.ts CHANGED
@@ -212,7 +212,73 @@ interface SearchField {
212
212
  * right when a record does carry one.
213
213
  */
214
214
  wireName?: string;
215
+ /**
216
+ * An opt-in role the column plays. Absent on almost every field; since 0.9.7
217
+ * Dooly County, Georgia (`ga-dooly`) is the first record that declares any.
218
+ * A tag adds a role: read every other column as you would without it.
219
+ *
220
+ * - `"mailing-fallback"`: a second owner-mailing line. Read it ONLY when the
221
+ * endpoint's primary mailing column holds nothing (a blank cell, or a
222
+ * placeholder such as "N/A"; never when the primary is masked, like
223
+ * `"*, *, * #####"`, `"#####-####"`, `"(***)"` or `"#, #, #"`: no letter
224
+ * or digit outside one trailing ZIP, and an asterisk, two or more "#", or a
225
+ * mask glyph such as a bullet or a block; nor when it was withheld from
226
+ * you; a lone "#", "-", "?", "." or "~" is no mask), and ONLY
227
+ * when the value, with invisible characters ignored, is a mailing line: a
228
+ * whole house number then a word (`"123 MAIN ST"`, `"123 1/2 MAIN ST"`;
229
+ * not `"1/2 INT ..."`, not numbers only), a P O Box or P O Drawer with its
230
+ * number (`"P O BOX 77"`, `"PO BOX 77"`, `"POST OFFICE BOX 77"`), or a
231
+ * rural route box (`"RR 2 BOX 15"`, `"HC 63 BOX 1"`), and carries no
232
+ * owner-entity, share, c/o or attention word (LLC, INC, INCORPORATED,
233
+ * CORP, CORPORATION, COMPANY, LTD, LP, LLP, TRUST, TRUSTEE(S), ESTATE,
234
+ * HEIRS, ET AL, ET UX, INT, INTEREST, OWNER(S), PERCENT, PER CENT, PCT,
235
+ * "%", "1 OF 2", C/O, C\O, C/0, CARE OF, ATTN, ATTENTION) and no word
236
+ * that says a value is withheld
237
+ * (CONFIDENTIAL, REDACTED, WITHHELD, PROTECTED, SUPPRESSED, RESTRICTED,
238
+ * NOT DISCLOSED). Read the words after Unicode NFKC, split on anything
239
+ * that is not a letter or digit (a control or zero-width character too),
240
+ * with a run of single letters as one word ("L.L.C." is LLC). One
241
+ * exception: a spelled-out entity word (INCORPORATED, CORPORATION,
242
+ * COMPANY, TRUST, TRUSTEE(S), ESTATE, HEIRS) directly before a street
243
+ * suffix is part of a street name (`"123 ESTATE DR"`, `"40 TRUST RD"`)
244
+ * only when nothing follows the suffix, or only one unit word (APT, UNIT,
245
+ * STE, SUITE, FL, FLOOR, RM, ROOM) and its value, a letter or up to four
246
+ * digits or the two together (`"123 ESTATE DR APT 5"`); after any other
247
+ * tail it is the owner's (`"100 TEST FAMILY TRUST ST LOUIS MO"`,
248
+ * `"5 TEST TRUST CT 06001"`, `"7 TEST ESTATE PT 2"`). Bare CO is no entity
249
+ * word (`"123 CO RD 45"`). Anything else on that
250
+ * line (a c/o line, a second owner name) is not the address.
251
+ * A county REDACTION MARKER on the fallback line ("CONFIDENTIAL",
252
+ * "REDACTED PER KRS 61.878") withholds the whole row, owner included,
253
+ * whatever the primary holds, exactly as one in the primary would.
254
+ * Dooly's primary is `address2`; `address1` is its fallback.
255
+ * - `"situs-directional"`: the street directional of a split site address
256
+ * (house number + street name columns, no single address column). Compose
257
+ * the site address as house number, directional, street name, and use the
258
+ * value only when it is a direction (N, S, E, W, NE, NW, SE, SW, or the
259
+ * word spelled out); Dooly's `stdirect` holds one "Q" that is not. Never
260
+ * compose it into a house number and street that together are a
261
+ * redaction marker ("0 CONFIDENTIAL" stays as it is, and the row is
262
+ * withheld). A redaction marker in the directional column itself
263
+ * ("CONFIDENTIAL") withholds the whole row. The tagged column is never
264
+ * itself the house number, the street name, the owner, the parcel id, a
265
+ * mailing column or a unit or suffix qualifier, and its name or label
266
+ * names a direction ("dir", "direction" or "directional" as a word of
267
+ * its own, a pre, post, st or suf prefix allowed: `PRE_DIR`, "Street
268
+ * Direction"; not `DIRECTOR` or "Direct Bill Flag"). A geocoded address without
269
+ * the directional still names the parcel when only one parcel at that
270
+ * number shares the street name; with it, the directional counts only
271
+ * beside a shared street-name word that is not itself a direction, and a
272
+ * parcel it alone singles out does not win over one at the same number
273
+ * and street whose directional is blank.
274
+ *
275
+ * At most one field per role on an endpoint, and never on
276
+ * `ownerJoin.fields`.
277
+ */
278
+ role?: SearchFieldRole;
215
279
  }
280
+ /** The opt-in column roles a record may declare ({@link SearchField.role}). Since 0.9.7. */
281
+ type SearchFieldRole = "mailing-fallback" | "situs-directional";
216
282
  /**
217
283
  * Owner rows that live in a separate TABLE of the same service, joined to the
218
284
  * endpoint's parcel polygons by a key: the polygons carry `parcelKey`, the
@@ -1353,4 +1419,4 @@ declare function citiesForCounty(stateSlug: string, countySlug: string): CitySum
1353
1419
  declare const cityPropertyIndex: CityPropertyIndex;
1354
1420
  declare const cityZoningIndex: CityZoningIndex;
1355
1421
 
1356
- 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 ConfidentialFlag, 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, type OwnerJoin, 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, queryFieldName, requestHint, reviewedCapability, slugify, splitAddressStreetName, splitStreet, statePath, streetForDataset };
1422
+ 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 ConfidentialFlag, 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, type OwnerJoin, POINT_PLACEHOLDER, PRESET_FLAGS, type PropertyDataset, type PropertyDatasets, type PropertyFieldMap, type PropertySource, type PropertySourceType, type PropertyStatusBuckets, type SearchField, type SearchFieldRole, 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, queryFieldName, requestHint, reviewedCapability, slugify, splitAddressStreetName, splitStreet, statePath, streetForDataset };