@vertigis/arcgis-extensions 53.8.0 → 53.10.0

package/tasks/query/ArcGISRelationship.d.ts

@@ -1,33 +1,90 @@
 import type { Feature, FetchRelatedFeaturesOptions } from "../../data/Feature.js";
 import type { FeatureSet } from "../../data/FeatureSet.js";
-import type { RelationshipType } from "../../data/_Relationship.js";
+import type { FeatureSource } from "../../data/FeatureSource.js";
+import { RelationshipBase } from "../../data/RelationshipBase.js";
+import type { Cardinality, RelationshipProperties, RelationshipType } from "../../data/_Relationship.js";
 import type { PropertyDefs } from "../../support/Serializable.js";
-import type { QueryBasedRelationshipProperties } from "./QueryBasedRelationship.js";
-import { QueryBasedRelationship } from "./QueryBasedRelationship.js";
+import { QueryService } from "./QueryService.js";
 /**
  * Properties that can be passed into the constructor for
- * {@link ArcGISRelationship}.
+ * {@link tasks/query/ArcGISRelationship!ArcGISRelationship}.
  */
-export interface ArcGISRelationshipProperties extends QueryBasedRelationshipProperties {
+export interface ArcGISRelationshipProperties extends RelationshipProperties {
     /**
-     * See {@link ArcGISRelationship.relationshipTableId}.
+     * See {@link tasks/query/ArcGISRelationship!ArcGISRelationship.keyField}.
+     */
+    keyField: string;
+    /**
+     * See
+     * {@link tasks/query/ArcGISRelationship!ArcGISRelationship.relatedSource}.
+     */
+    relatedSource: FeatureSource;
+    /**
+     * See
+     * {@link tasks/query/ArcGISRelationship!ArcGISRelationship.relatedKeyField}.
+     */
+    relatedKeyField?: string;
+    /**
+     * See {@link tasks/query/ArcGISRelationship!ArcGISRelationship.cardinality}.
+     */
+    cardinality?: Cardinality;
+    /**
+     * See
+     * {@link tasks/query/ArcGISRelationship!ArcGISRelationship.queryService}.
+     */
+    queryService?: QueryService;
+    /**
+     * See
+     * {@link tasks/query/ArcGISRelationship!ArcGISRelationship.relationshipTableId}.
      */
     relationshipTableId?: number;
     /**
-     * See {@link ArcGISRelationship.originForeignKey}.
+     * See
+     * {@link tasks/query/ArcGISRelationship!ArcGISRelationship.originForeignKey}.
      */
     originForeignKey?: string;
     /**
-     * See {@link ArcGISRelationship.destinationForeignKey}.
+     * See
+     * {@link tasks/query/ArcGISRelationship!ArcGISRelationship.destinationForeignKey}.
      */
     destinationForeignKey?: string;
+    /**
+     * See {@link data/_Relationship!RelationshipProperties.$relationshipType}.
+     */
+    $relationshipType?: RelationshipType;
 }
 /**
  * A {@link data/_Relationship!Relationship} that works by querying the
  * queryRelatedRecords endpoint of a FeatureLayer, Table, or ArcGIS Sublayer.
  */
-export declare class ArcGISRelationship extends QueryBasedRelationship<ArcGISRelationshipProperties> {
+export declare class ArcGISRelationship<TProperties extends ArcGISRelationshipProperties = ArcGISRelationshipProperties> extends RelationshipBase<TProperties> {
+    /**
+     * @inheritDoc
+     */
+    readonly relatedSource: FeatureSource;
+    /**
+     * @inheritDoc
+     */
+    readonly cardinality: Cardinality;
+    /**
+     * The key field in the source.
+     */
+    readonly keyField: string;
+    /**
+     * @inheritDoc
+     */
     readonly relationshipType: RelationshipType;
+    /**
+     * The {@link tasks/query/QueryService!QueryService} to use for fetching
+     * related features. The service must be configured with a provider that can
+     * handle the related source.
+     */
+    queryService: QueryService;
+    /**
+     * The key field in the related source. Needed for two-sided relationships
+     * but isn't needed for one-sided ones.
+     */
+    readonly relatedKeyField: string | undefined;
     /**
      * The ID of the intermediate table in the feature service for attributed
      * relationships. This property will only be exposed if the relationship is
@@ -48,12 +105,18 @@ export declare class ArcGISRelationship extends QueryBasedRelationship<ArcGISRel
      * attributed.
      */
     readonly destinationForeignKey: string | undefined;
-    constructor(properties: ArcGISRelationshipProperties);
+    constructor(properties: TProperties);
     /**
      * Whether the relationship is attributed.
      */
     get isAttributed(): boolean;
-    protected _getSerializableProperties(): PropertyDefs<ArcGISRelationshipProperties>;
+    protected _getSerializableProperties(): PropertyDefs<TProperties>;
+    /**
+     * @inheritDoc
+     */
     protected _getRelatedFeatures(feature: Feature, options?: FetchRelatedFeaturesOptions): Promise<FeatureSet>;
-    protected _getAllRelatedFeatures(features: Feature[], options?: FetchRelatedFeaturesOptions): Promise<Map<Feature, FeatureSet>>;
+    /**
+     * @inheritDoc
+     */
+    protected _getAllRelatedFeatures(features: Feature[]): Promise<Map<Feature, FeatureSet>>;
 }

package/tasks/query/ArcGISRelationship.js

@@ -1 +1 @@
-import{__decorate as e}from"tslib";import t from"@arcgis/core/rest/support/RelationshipQuery";import{isSublayerExtension as i}from"../../ItemType.js";import{cancelifyWithAbortSignal as r}from"../../support/Cancellable.js";import{serializable as a}from"../../support/Serializable.js";import{isFeatureLayer as s,isMapImageSublayer as o,isSubtypeGroupLayer as n}from"../../utilities/_layers.js";import{isArcGISServiceTableExtension as l,isFeatureLayerExtension as u,isSubtypeGroupLayerExtension as p,isSubtypeSublayerExtension as y}from"../../utilities/extensions.js";import{QueryBasedRelationship as c}from"./QueryBasedRelationship.js";const d=new WeakMap;let m=class extends c{relationshipType="ArcGISRelationship";relationshipTableId;originForeignKey;destinationForeignKey;constructor(e){super(e),this.relationshipTableId=e.relationshipTableId,this.originForeignKey=e.originForeignKey,this.destinationForeignKey=e.destinationForeignKey}get isAttributed(){return"number"==typeof this.relationshipTableId}_getSerializableProperties(){return{...super._getSerializableProperties(),$relationshipType:{serializeModes:["initial"],serialize:()=>"ArcGISRelationship"},destinationForeignKey:"initial",originForeignKey:"initial",relationshipTableId:"initial"}}async _getRelatedFeatures(e,t){return r((async t=>(await f([e],h(this.source),this.relatedSource,{relationshipId:+this.id,signal:t})).get(e)),t?.cancelToken)}async _getAllRelatedFeatures(e,t){return f(e,h(this.source),this.relatedSource,{relationshipId:+this.id})}};m=e([a],m);export{m as ArcGISRelationship};function h(e){let t;if(l(e))t=e.table;else if(u(e))t=e.layer;else if(i(e)&&o(e.sublayer))t=e.sublayer;else if(y(e)&&e.sublayer?.layer)t=e.sublayer.layer;else{if(!p(e))throw new Error(`Cannot query for related records. Unsupported FeatureSource: ${e.title} (${e.itemType}/${e.id})`);t=e.layer}return t}const g={returnGeometry:!0};async function f(e,i,r,a){const o=e.map((e=>+e?.primaryKey)),{signal:l,...u}=a,p=new t({...g,objectIds:o.filter((e=>!isNaN(e)&&"number"==typeof e)),outFields:r?.featureSettings.outFields??["*"],...u});let y;if(s(i)||n(i))y=i;else{const e=i;d.has(e)||d.set(e,await e.createFeatureLayer()),y=d.get(e)}const c=await y.queryRelatedFeatures(p,{signal:l}),m=new Map,[h,f]=await Promise.all([(await import("../../data/FeatureSet.js")).FeatureSet,(await import("../../data/Feature.js")).toFeature]);return o.forEach(((t,i)=>{m.set(e[i],new h({source:r,features:c[t]?.features.map((e=>f(e,{source:r})))??[]}))})),m}
+import{__decorate as e}from"tslib";import i from"@arcgis/core/rest/support/RelationshipQuery";import{isSublayerExtension as t}from"../../ItemType.js";import{RelationshipBase as r}from"../../data/RelationshipBase.js";import{cancelifyWithAbortSignal as a}from"../../support/Cancellable.js";import{serializable as s}from"../../support/Serializable.js";import{isFeatureLayer as o,isMapImageSublayer as l,isSubtypeGroupLayer as n}from"../../utilities/_layers.js";import{checkArg as u}from"../../utilities/checkArg.js";import{isArcGISServiceTableExtension as p,isFeatureLayerExtension as y,isSubtypeGroupLayerExtension as d,isSubtypeSublayerExtension as c}from"../../utilities/extensions.js";import{QueryService as m}from"./QueryService.js";const h=new WeakMap;let g=class extends r{relatedSource;cardinality;keyField;relationshipType="ArcGISRelationship";queryService;relatedKeyField;relationshipTableId;originForeignKey;destinationForeignKey;constructor(e){super(e),u("properties",e).isNotMissing(),u("properties.relatedSource",e.relatedSource).isNotMissing(),u("properties.keyField",e.keyField).isNotMissing().isNotEmpty(),this.relatedSource=e.relatedSource,this.keyField=e.keyField,this.relatedKeyField=e.relatedKeyField,this.cardinality=e.cardinality||"many-to-many",this.relationshipTableId=e.relationshipTableId,this.queryService=e.queryService||new m,this.originForeignKey=e.originForeignKey,this.destinationForeignKey=e.destinationForeignKey}get isAttributed(){return"number"==typeof this.relationshipTableId}_getSerializableProperties(){return{...super._getSerializableProperties(),keyField:"initial",relatedKeyField:"initial",$relationshipType:{serializeModes:["initial"],serialize:()=>"ArcGISRelationship"},cardinality:"initial",relatedSource:"initial",queryService:{serialize:!1},destinationForeignKey:"initial",originForeignKey:"initial",relationshipTableId:"initial"}}async _getRelatedFeatures(e,i){return a((async i=>(await S([e],F(this.source),this.relatedSource,{relationshipId:+this.id,signal:i})).get(e)),i?.cancelToken)}async _getAllRelatedFeatures(e){return S(e,F(this.source),this.relatedSource,{relationshipId:+this.id})}};g=e([s],g);export{g as ArcGISRelationship};function F(e){let i;if(p(e))i=e.table;else if(y(e))i=e.layer;else if(t(e)&&l(e.sublayer))i=e.sublayer;else if(c(e)&&e.sublayer?.layer)i=e.sublayer.layer;else{if(!d(e))throw new Error(`Cannot query for related records. Unsupported FeatureSource: ${e.title} (${e.itemType}/${e.id})`);i=e.layer}return i}const f={returnGeometry:!0};async function S(e,t,r,a){const s=e.map((e=>+e?.primaryKey)),{signal:l,...u}=a,p=new i({...f,objectIds:s.filter((e=>!isNaN(e)&&"number"==typeof e)),outFields:r?.featureSettings.outFields??["*"],...u});let y;if(o(t)||n(t))y=t;else{const e=t;h.has(e)||h.set(e,await e.createFeatureLayer()),y=h.get(e)}const d=await y.queryRelatedFeatures(p,{signal:l}),c=new Map,[m,g]=await Promise.all([(await import("../../data/FeatureSet.js")).FeatureSet,(await import("../../data/Feature.js")).toFeature]);return s.forEach(((i,t)=>{c.set(e[t],new m({source:r,features:d[i]?.features.map((e=>g(e,{source:r})))??[]}))})),c}

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex ArcGIS Extensions API.
  */
-export declare const version = "53.8.0";
+export declare const version = "53.10.0";

package/version.js

@@ -1 +1 @@
-export const version="53.8.0";
+export const version="53.10.0";