@urbankitstudio/atlas 0.8.0 → 0.9.0

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
@@ -201,6 +201,71 @@ interface SearchField {
201
201
  name: string;
202
202
  label: string;
203
203
  searchable: boolean;
204
+ /**
205
+ * The column's fully qualified name on a layer that answers with one (a
206
+ * server-side join publishes `table.column`, as in
207
+ * `SDE.mc_parcel_polygon.TAXPINNO`), while `name` stays the bare last
208
+ * segment. Declared since 0.9.0 and carried by NO record yet: the registry's
209
+ * validator refuses it until a later release, so `name` is the literal query
210
+ * column on every record today. Read the column to send through
211
+ * `queryFieldName(field)`, exported by this package, so your code is already
212
+ * right when a record does carry one.
213
+ */
214
+ wireName?: string;
215
+ }
216
+ /**
217
+ * Owner rows that live in a separate TABLE of the same service, joined to the
218
+ * endpoint's parcel polygons by a key: the polygons carry `parcelKey`, the
219
+ * table carries `key`, and a parcel's owners are the table rows whose `key`
220
+ * equals its `parcelKey` value. Declared since 0.9.0 and carried by NO record
221
+ * yet.
222
+ *
223
+ * The table has no geometry. Query it by key only
224
+ * (`<key> IN ('<value>', ...)`, each `'` doubled), never spatially: an ArcGIS
225
+ * table ignores a geometry parameter, so a spatial query would answer with
226
+ * arbitrary rows. Check that every returned row's `key` is one you asked for.
227
+ *
228
+ * The table's columns live ONLY in `fields`, never in the endpoint's
229
+ * `searchFields`. So a reader that ignores `ownerJoin` sees a layer with a
230
+ * parcel id and no owner, which is the safe reading: it cannot ask the polygon
231
+ * layer for a column that is not on it.
232
+ */
233
+ interface OwnerJoin {
234
+ /** The table's layer URL: another layer of the endpoint's own service (the
235
+ * same host and service path; `MapServer` and `FeatureServer` are one
236
+ * service). No endpoint `url` in the registry names this layer, under
237
+ * either service type. */
238
+ url: string;
239
+ layerName: string;
240
+ /** The key column on the table. */
241
+ key: string;
242
+ /** The matching column on the endpoint's layer; one of its `searchFields`. */
243
+ parcelKey: string;
244
+ /** The table's documented columns: `key`, `rowIdField` and the owner columns. */
245
+ fields: SearchField[];
246
+ /** A column that labels the rows of one key (an assessment unit, say). It is
247
+ * NOT unique: several rows can share one value and differ only in columns
248
+ * that are not served. De-duplicate the rows of one key by the owner and
249
+ * mailing content you read, never by this column. */
250
+ rowIdField?: string;
251
+ /** `"rows"`: a key with several rows stands for several ownership records,
252
+ * up to `maxRowsPerKey` of them. Absent: treat a key with several rows as
253
+ * having no single owner rather than picking one. */
254
+ multiple?: "rows";
255
+ /** The most table rows one key may hold and still be read as its ownership
256
+ * records: an integer from 1 to `maxRecordCount`, present exactly when
257
+ * `multiple` is `"rows"`. Treat a key with more rows as having no owner you
258
+ * can state (a single key can hold more rows than one query returns). */
259
+ maxRowsPerKey?: number;
260
+ /** A unique, stable column to order the table's pages by: send it as
261
+ * `orderByFields` whenever you send `resultOffset`, or a paged read can
262
+ * repeat a row or skip one. */
263
+ orderField: string;
264
+ /** The most rows the table returns to one query, as its metadata declares;
265
+ * `exceededTransferLimit` on the response is the authority. */
266
+ maxRecordCount: number;
267
+ /** ISO date the table and its key were last verified before publish. */
268
+ lastVerified: string;
204
269
  }
205
270
  /**
206
271
  * The county's own "this owner's record is confidential" column on a layer, the
@@ -357,6 +422,9 @@ interface EndpointRecord {
357
422
  * `safeValues`. Absent means the layer publishes no
358
423
  * such column, not that no owner there is protected. */
359
424
  confidentialFlag?: ConfidentialFlag;
425
+ /** The table that holds this layer's owner rows (see {@link OwnerJoin}).
426
+ * Declared since 0.9.0; absent on every record today. */
427
+ ownerJoin?: OwnerJoin;
360
428
  sampleQuery: string | null;
361
429
  license: LicenseType;
362
430
  licenseUrl: string | null;
@@ -513,6 +581,19 @@ interface AtlasIndex {
513
581
  };
514
582
  }
515
583
 
584
+ /**
585
+ * The column name to SEND for a field: in a `where` clause, in `outFields`,
586
+ * and as the key to read back off a returned row. That is `wireName` when the
587
+ * record carries one (a layer that answers with fully qualified
588
+ * `table.column` names) and `name` otherwise.
589
+ *
590
+ * No record carries a `wireName` yet, so this returns `name` for every field
591
+ * today. It exists now so that code written against it keeps working when a
592
+ * record does: go through it rather than reading `field.name` for a query.
593
+ * Keep using `name` and `label` to decide what a column IS (parcel id, owner,
594
+ * address); a qualified name carries table names that read like roles.
595
+ */
596
+ declare function queryFieldName(field: Pick<SearchField, "name" | "wireName">): string;
516
597
  /**
517
598
  * Can this layer take a `where`-clause search at all (owner name, address text,
518
599
  * a field filter)? False on a layer flagged `attributeSearch: "unsupported"`,
@@ -1264,4 +1345,4 @@ declare function citiesForCounty(stateSlug: string, countySlug: string): CitySum
1264
1345
  declare const cityPropertyIndex: CityPropertyIndex;
1265
1346
  declare const cityZoningIndex: CityZoningIndex;
1266
1347
 
1267
- 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, 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 };
1348
+ 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 };
package/dist/index.d.ts CHANGED
@@ -201,6 +201,71 @@ interface SearchField {
201
201
  name: string;
202
202
  label: string;
203
203
  searchable: boolean;
204
+ /**
205
+ * The column's fully qualified name on a layer that answers with one (a
206
+ * server-side join publishes `table.column`, as in
207
+ * `SDE.mc_parcel_polygon.TAXPINNO`), while `name` stays the bare last
208
+ * segment. Declared since 0.9.0 and carried by NO record yet: the registry's
209
+ * validator refuses it until a later release, so `name` is the literal query
210
+ * column on every record today. Read the column to send through
211
+ * `queryFieldName(field)`, exported by this package, so your code is already
212
+ * right when a record does carry one.
213
+ */
214
+ wireName?: string;
215
+ }
216
+ /**
217
+ * Owner rows that live in a separate TABLE of the same service, joined to the
218
+ * endpoint's parcel polygons by a key: the polygons carry `parcelKey`, the
219
+ * table carries `key`, and a parcel's owners are the table rows whose `key`
220
+ * equals its `parcelKey` value. Declared since 0.9.0 and carried by NO record
221
+ * yet.
222
+ *
223
+ * The table has no geometry. Query it by key only
224
+ * (`<key> IN ('<value>', ...)`, each `'` doubled), never spatially: an ArcGIS
225
+ * table ignores a geometry parameter, so a spatial query would answer with
226
+ * arbitrary rows. Check that every returned row's `key` is one you asked for.
227
+ *
228
+ * The table's columns live ONLY in `fields`, never in the endpoint's
229
+ * `searchFields`. So a reader that ignores `ownerJoin` sees a layer with a
230
+ * parcel id and no owner, which is the safe reading: it cannot ask the polygon
231
+ * layer for a column that is not on it.
232
+ */
233
+ interface OwnerJoin {
234
+ /** The table's layer URL: another layer of the endpoint's own service (the
235
+ * same host and service path; `MapServer` and `FeatureServer` are one
236
+ * service). No endpoint `url` in the registry names this layer, under
237
+ * either service type. */
238
+ url: string;
239
+ layerName: string;
240
+ /** The key column on the table. */
241
+ key: string;
242
+ /** The matching column on the endpoint's layer; one of its `searchFields`. */
243
+ parcelKey: string;
244
+ /** The table's documented columns: `key`, `rowIdField` and the owner columns. */
245
+ fields: SearchField[];
246
+ /** A column that labels the rows of one key (an assessment unit, say). It is
247
+ * NOT unique: several rows can share one value and differ only in columns
248
+ * that are not served. De-duplicate the rows of one key by the owner and
249
+ * mailing content you read, never by this column. */
250
+ rowIdField?: string;
251
+ /** `"rows"`: a key with several rows stands for several ownership records,
252
+ * up to `maxRowsPerKey` of them. Absent: treat a key with several rows as
253
+ * having no single owner rather than picking one. */
254
+ multiple?: "rows";
255
+ /** The most table rows one key may hold and still be read as its ownership
256
+ * records: an integer from 1 to `maxRecordCount`, present exactly when
257
+ * `multiple` is `"rows"`. Treat a key with more rows as having no owner you
258
+ * can state (a single key can hold more rows than one query returns). */
259
+ maxRowsPerKey?: number;
260
+ /** A unique, stable column to order the table's pages by: send it as
261
+ * `orderByFields` whenever you send `resultOffset`, or a paged read can
262
+ * repeat a row or skip one. */
263
+ orderField: string;
264
+ /** The most rows the table returns to one query, as its metadata declares;
265
+ * `exceededTransferLimit` on the response is the authority. */
266
+ maxRecordCount: number;
267
+ /** ISO date the table and its key were last verified before publish. */
268
+ lastVerified: string;
204
269
  }
205
270
  /**
206
271
  * The county's own "this owner's record is confidential" column on a layer, the
@@ -357,6 +422,9 @@ interface EndpointRecord {
357
422
  * `safeValues`. Absent means the layer publishes no
358
423
  * such column, not that no owner there is protected. */
359
424
  confidentialFlag?: ConfidentialFlag;
425
+ /** The table that holds this layer's owner rows (see {@link OwnerJoin}).
426
+ * Declared since 0.9.0; absent on every record today. */
427
+ ownerJoin?: OwnerJoin;
360
428
  sampleQuery: string | null;
361
429
  license: LicenseType;
362
430
  licenseUrl: string | null;
@@ -513,6 +581,19 @@ interface AtlasIndex {
513
581
  };
514
582
  }
515
583
 
584
+ /**
585
+ * The column name to SEND for a field: in a `where` clause, in `outFields`,
586
+ * and as the key to read back off a returned row. That is `wireName` when the
587
+ * record carries one (a layer that answers with fully qualified
588
+ * `table.column` names) and `name` otherwise.
589
+ *
590
+ * No record carries a `wireName` yet, so this returns `name` for every field
591
+ * today. It exists now so that code written against it keeps working when a
592
+ * record does: go through it rather than reading `field.name` for a query.
593
+ * Keep using `name` and `label` to decide what a column IS (parcel id, owner,
594
+ * address); a qualified name carries table names that read like roles.
595
+ */
596
+ declare function queryFieldName(field: Pick<SearchField, "name" | "wireName">): string;
516
597
  /**
517
598
  * Can this layer take a `where`-clause search at all (owner name, address text,
518
599
  * a field filter)? False on a layer flagged `attributeSearch: "unsupported"`,
@@ -1264,4 +1345,4 @@ declare function citiesForCounty(stateSlug: string, countySlug: string): CitySum
1264
1345
  declare const cityPropertyIndex: CityPropertyIndex;
1265
1346
  declare const cityZoningIndex: CityZoningIndex;
1266
1347
 
1267
- 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, 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 };
1348
+ 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 };