@honua/react 0.0.20-alpha.0

package/core/query-builder.d.ts

@@ -0,0 +1,261 @@
+import type { HonuaClient } from "./client.js";
+import type { EsriGeometryType, EsriSpatialRel, HonuaOgcFeatureCollectionResponse, HonuaQueryResponse, MapLayerQueryRequest, OgcItemsRequest, OgcResponseFormat, QueryFeaturesRequest, QueryMethod } from "./types.js";
+/**
+ * Fluent builder for constructing `QueryFeaturesRequest` objects.
+ *
+ * Create via `QueryBuilder.from(serviceId, layerId)` (standalone) or
+ * `QueryBuilder.for(client, serviceId, layerId)` (bound to a client for `.run()`).
+ *
+ * @example
+ * ```ts
+ * // Standalone — build request object
+ * const req = QueryBuilder.from("myService", 0)
+ *   .where("POP > 1000")
+ *   .outFields("NAME", "POP")
+ *   .limit(100)
+ *   .build();
+ *
+ * const result = await client.queryFeatures(req);
+ *
+ * // Bound — build and execute in one chain
+ * const result = await QueryBuilder.for(client, "myService", 0)
+ *   .where("POP > 1000")
+ *   .outFields("NAME", "POP")
+ *   .limit(100)
+ *   .run();
+ * ```
+ */
+export declare class QueryBuilder {
+    private readonly serviceId;
+    private readonly layerId;
+    private readonly boundClient;
+    private whereClause;
+    private fields;
+    private geometryFilter;
+    private geometryTypeValue;
+    private spatialRelValue;
+    private returnGeometryValue;
+    private orderByFieldsValue;
+    private resultOffsetValue;
+    private resultRecordCountValue;
+    private objectIdsValue;
+    private returnDistinctValuesValue;
+    private returnCentroidValue;
+    private groupByFieldsValue;
+    private outStatisticsValue;
+    private methodValue;
+    private signalValue;
+    private extraParamsValue;
+    private constructor();
+    /** Create a standalone builder (call `.build()` to get the request object). */
+    static from(serviceId: string, layerId: number): QueryBuilder;
+    /** Create a builder bound to a client (enables `.run()` to execute the query). */
+    static for(client: HonuaClient, serviceId: string, layerId: number): QueryBuilder;
+    /** Set the WHERE clause for filtering features. */
+    where(clause: string): this;
+    /** Set the output fields to return. Accepts individual field names. */
+    outFields(...fieldNames: string[]): this;
+    /** Set a geometry filter. Accepts a geometry object or JSON string. */
+    geometry(geom: string | Record<string, unknown>): this;
+    /** Set the geometry type for the geometry filter. */
+    geometryType(type: EsriGeometryType): this;
+    /** Set the spatial relationship for the geometry filter. */
+    spatialRel(rel: EsriSpatialRel): this;
+    /** Whether to include geometry in the response. */
+    returnGeometry(value: boolean): this;
+    /** Set the fields to order results by (e.g. `"NAME ASC"`). */
+    orderBy(fields: string): this;
+    /** Set the maximum number of features to return. */
+    limit(count: number): this;
+    /** Set the number of features to skip (for pagination). */
+    offset(count: number): this;
+    /** Filter by specific object IDs. */
+    objectIds(ids: number[] | string): this;
+    /** Return only distinct values. */
+    distinct(value?: boolean): this;
+    /** Return centroids instead of full geometries. */
+    returnCentroid(value?: boolean): this;
+    /** Set group-by fields for statistics queries. */
+    groupBy(fields: string): this;
+    /** Set output statistics definitions. */
+    outStatistics(stats: string | readonly Record<string, unknown>[]): this;
+    /** Set the HTTP method (GET or POST). */
+    method(m: QueryMethod): this;
+    /** Attach an AbortSignal for cancellation. */
+    signal(s: AbortSignal): this;
+    /** Set extra query parameters. */
+    extraParams(params: Record<string, string | number | boolean>): this;
+    /** Build the `QueryFeaturesRequest` object without executing it. */
+    build(): QueryFeaturesRequest;
+    /**
+     * Build the request and execute it via the bound client.
+     * Throws if the builder was created with `QueryBuilder.from()` (no client).
+     */
+    run(): Promise<HonuaQueryResponse>;
+}
+/**
+ * Fluent builder for constructing `MapLayerQueryRequest` objects.
+ *
+ * Create via `MapLayerQueryBuilder.from(serviceId, layerId)` (standalone) or
+ * `MapLayerQueryBuilder.for(client, serviceId, layerId)` (bound to a client for `.run()`).
+ *
+ * @example
+ * ```ts
+ * // Standalone — build request object
+ * const req = MapLayerQueryBuilder.from("myService", 0)
+ *   .where("POP > 1000")
+ *   .outFields("NAME", "POP")
+ *   .limit(100)
+ *   .build();
+ *
+ * const result = await client.queryMapLayer(req);
+ *
+ * // Bound — build and execute in one chain
+ * const result = await MapLayerQueryBuilder.for(client, "myService", 0)
+ *   .where("POP > 1000")
+ *   .outFields("NAME", "POP")
+ *   .limit(100)
+ *   .run();
+ * ```
+ */
+export declare class MapLayerQueryBuilder {
+    private readonly serviceId;
+    private readonly layerId;
+    private readonly boundClient;
+    private whereClause;
+    private fields;
+    private geometryFilter;
+    private geometryTypeValue;
+    private spatialRelValue;
+    private returnGeometryValue;
+    private orderByFieldsValue;
+    private resultOffsetValue;
+    private resultRecordCountValue;
+    private objectIdsValue;
+    private returnDistinctValuesValue;
+    private returnCentroidValue;
+    private groupByFieldsValue;
+    private outStatisticsValue;
+    private methodValue;
+    private signalValue;
+    private extraParamsValue;
+    private constructor();
+    /** Create a standalone builder (call `.build()` to get the request object). */
+    static from(serviceId: string, layerId: number): MapLayerQueryBuilder;
+    /** Create a builder bound to a client (enables `.run()` to execute the query). */
+    static for(client: HonuaClient, serviceId: string, layerId: number): MapLayerQueryBuilder;
+    /** Set the WHERE clause for filtering features. */
+    where(clause: string): this;
+    /** Set the output fields to return. Accepts individual field names. */
+    outFields(...fieldNames: string[]): this;
+    /** Set a geometry filter. Accepts a geometry object or JSON string. */
+    geometry(geom: string | Record<string, unknown>): this;
+    /** Set the geometry type for the geometry filter. */
+    geometryType(type: EsriGeometryType): this;
+    /** Set the spatial relationship for the geometry filter. */
+    spatialRel(rel: EsriSpatialRel): this;
+    /** Whether to include geometry in the response. */
+    returnGeometry(value: boolean): this;
+    /** Set the fields to order results by (e.g. `"NAME ASC"`). */
+    orderBy(fields: string): this;
+    /** Set the maximum number of features to return. */
+    limit(count: number): this;
+    /** Set the number of features to skip (for pagination). */
+    offset(count: number): this;
+    /** Filter by specific object IDs. */
+    objectIds(ids: number[] | string): this;
+    /** Return only distinct values. */
+    distinct(value?: boolean): this;
+    /** Return centroids instead of full geometries. */
+    returnCentroid(value?: boolean): this;
+    /** Set group-by fields for statistics queries. */
+    groupBy(fields: string): this;
+    /** Set output statistics definitions. */
+    outStatistics(stats: string | readonly Record<string, unknown>[]): this;
+    /** Set the HTTP method (GET or POST). */
+    method(m: QueryMethod): this;
+    /** Attach an AbortSignal for cancellation. */
+    signal(s: AbortSignal): this;
+    /** Set extra query parameters. */
+    extraParams(params: Record<string, string | number | boolean>): this;
+    /** Build the `MapLayerQueryRequest` object without executing it. */
+    build(): MapLayerQueryRequest;
+    /**
+     * Build the request and execute it via the bound client.
+     * Throws if the builder was created with `MapLayerQueryBuilder.from()` (no client).
+     */
+    run(): Promise<HonuaQueryResponse>;
+}
+/**
+ * Fluent builder for constructing `OgcItemsRequest` objects.
+ *
+ * Create via `OgcQueryBuilder.from(collectionId)` (standalone) or
+ * `OgcQueryBuilder.for(client, collectionId)` (bound to a client for `.run()`).
+ *
+ * @example
+ * ```ts
+ * // Standalone — build request object
+ * const req = OgcQueryBuilder.from("rivers")
+ *   .limit(50)
+ *   .bbox("-180,-90,180,90")
+ *   .build();
+ *
+ * const result = await client.listOgcItems(req);
+ *
+ * // Bound — build and execute in one chain
+ * const result = await OgcQueryBuilder.for(client, "rivers")
+ *   .limit(50)
+ *   .bbox("-180,-90,180,90")
+ *   .run();
+ * ```
+ */
+export declare class OgcQueryBuilder {
+    private readonly collectionId;
+    private readonly boundClient;
+    private limitValue;
+    private offsetValue;
+    private bboxValue;
+    private datetimeValue;
+    private filterValue;
+    private idsValue;
+    private propertiesValue;
+    private sortbyValue;
+    private crsValue;
+    private signalValue;
+    private responseFormatValue;
+    private constructor();
+    /** Create a standalone builder (call `.build()` to get the request object). */
+    static from(collectionId: string | number): OgcQueryBuilder;
+    /** Create a builder bound to a client (enables `.run()` to execute the query). */
+    static for(client: HonuaClient, collectionId: string | number): OgcQueryBuilder;
+    /** Set the maximum number of items to return. */
+    limit(n: number): this;
+    /** Set the number of items to skip (for pagination). */
+    offset(n: number): this;
+    /** Set the bounding box filter (e.g. `"-180,-90,180,90"`). */
+    bbox(value: string): this;
+    /** Set the datetime filter (e.g. `"2020-01-01T00:00:00Z/.."`). */
+    datetime(value: string): this;
+    /** Set the CQL2 filter expression. */
+    filter(value: string): this;
+    /** Filter by specific feature IDs. */
+    ids(...idValues: (string | number)[]): this;
+    /** Set the properties to return. */
+    properties(...props: string[]): this;
+    /** Set the sort order (e.g. `"+name"` or `"-pop"`). */
+    sortby(value: string): this;
+    /** Set the coordinate reference system URI. */
+    crs(value: string): this;
+    /** Attach an AbortSignal for cancellation. */
+    signal(s: AbortSignal): this;
+    /** Set the response format (e.g. `"json"`, `"geojson"`). */
+    responseFormat(fmt: OgcResponseFormat | string): this;
+    /** Build the `OgcItemsRequest` object without executing it. */
+    build(): OgcItemsRequest;
+    /**
+     * Build the request and execute it via the bound client.
+     * Throws if the builder was created with `OgcQueryBuilder.from()` (no client).
+     */
+    run(): Promise<HonuaOgcFeatureCollectionResponse>;
+}
+//# sourceMappingURL=query-builder.d.ts.map

package/core/query-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-builder.d.ts","sourceRoot":"","sources":["../../../src/core/query-builder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EACV,gBAAgB,EAChB,cAAc,EACd,iCAAiC,EACjC,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,WAAW,EACZ,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0B;IACtD,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,cAAc,CAA+C;IACrE,OAAO,CAAC,iBAAiB,CAA+B;IACxD,OAAO,CAAC,eAAe,CAA6B;IACpD,OAAO,CAAC,mBAAmB,CAAsB;IACjD,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,sBAAsB,CAAqB;IACnD,OAAO,CAAC,cAAc,CAAgC;IACtD,OAAO,CAAC,yBAAyB,CAAsB;IACvD,OAAO,CAAC,mBAAmB,CAAsB;IACjD,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,kBAAkB,CAA0D;IACpF,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,gBAAgB,CAAwD;IAEhF,OAAO;IAMP,+EAA+E;WACjE,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,YAAY;IAIpE,kFAAkF;WACpE,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,YAAY;IAIxF,mDAAmD;IAC5C,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKlC,uEAAuE;IAChE,SAAS,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI;IAK/C,uEAAuE;IAChE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAK7D,qDAAqD;IAC9C,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAKjD,4DAA4D;IACrD,UAAU,CAAC,GAAG,EAAE,cAAc,GAAG,IAAI;IAK5C,mDAAmD;IAC5C,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAK3C,8DAA8D;IACvD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKpC,oDAAoD;IAC7C,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKjC,2DAA2D;IACpD,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC,qCAAqC;IAC9B,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI;IAK9C,mCAAmC;IAC5B,QAAQ,CAAC,KAAK,UAAO,GAAG,IAAI;IAKnC,mDAAmD;IAC5C,cAAc,CAAC,KAAK,UAAO,GAAG,IAAI;IAKzC,kDAAkD;IAC3C,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKpC,yCAAyC;IAClC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,IAAI;IAK9E,yCAAyC;IAClC,MAAM,CAAC,CAAC,EAAE,WAAW,GAAG,IAAI;IAKnC,8CAA8C;IACvC,MAAM,CAAC,CAAC,EAAE,WAAW,GAAG,IAAI;IAKnC,kCAAkC;IAC3B,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI;IAK3E,oEAAoE;IAC7D,KAAK,IAAI,oBAAoB;IA2BpC;;;OAGG;IACU,GAAG,IAAI,OAAO,CAAC,kBAAkB,CAAC;CAQhD;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0B;IACtD,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,cAAc,CAA+C;IACrE,OAAO,CAAC,iBAAiB,CAA+B;IACxD,OAAO,CAAC,eAAe,CAA6B;IACpD,OAAO,CAAC,mBAAmB,CAAsB;IACjD,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,sBAAsB,CAAqB;IACnD,OAAO,CAAC,cAAc,CAAgC;IACtD,OAAO,CAAC,yBAAyB,CAAsB;IACvD,OAAO,CAAC,mBAAmB,CAAsB;IACjD,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,kBAAkB,CAA0D;IACpF,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,gBAAgB,CAAwD;IAEhF,OAAO;IAMP,+EAA+E;WACjE,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,oBAAoB;IAI5E,kFAAkF;WACpE,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,oBAAoB;IAIhG,mDAAmD;IAC5C,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKlC,uEAAuE;IAChE,SAAS,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI;IAK/C,uEAAuE;IAChE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAK7D,qDAAqD;IAC9C,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAKjD,4DAA4D;IACrD,UAAU,CAAC,GAAG,EAAE,cAAc,GAAG,IAAI;IAK5C,mDAAmD;IAC5C,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAK3C,8DAA8D;IACvD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKpC,oDAAoD;IAC7C,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKjC,2DAA2D;IACpD,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC,qCAAqC;IAC9B,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI;IAK9C,mCAAmC;IAC5B,QAAQ,CAAC,KAAK,UAAO,GAAG,IAAI;IAKnC,mDAAmD;IAC5C,cAAc,CAAC,KAAK,UAAO,GAAG,IAAI;IAKzC,kDAAkD;IAC3C,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKpC,yCAAyC;IAClC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,IAAI;IAK9E,yCAAyC;IAClC,MAAM,CAAC,CAAC,EAAE,WAAW,GAAG,IAAI;IAKnC,8CAA8C;IACvC,MAAM,CAAC,CAAC,EAAE,WAAW,GAAG,IAAI;IAKnC,kCAAkC;IAC3B,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI;IAK3E,oEAAoE;IAC7D,KAAK,IAAI,oBAAoB;IA2BpC;;;OAGG;IACU,GAAG,IAAI,OAAO,CAAC,kBAAkB,CAAC;CAQhD;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkB;IAC/C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0B;IACtD,OAAO,CAAC,UAAU,CAAqB;IACvC,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,QAAQ,CAAoD;IACpE,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,mBAAmB,CAAyC;IAEpE,OAAO;IAKP,+EAA+E;WACjE,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,eAAe;IAIlE,kFAAkF;WACpE,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,eAAe;IAItF,iDAAiD;IAC1C,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAK7B,wDAAwD;IACjD,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAK9B,8DAA8D;IACvD,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKhC,kEAAkE;IAC3D,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKpC,sCAAsC;IAC/B,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC,sCAAsC;IAC/B,GAAG,CAAC,GAAG,QAAQ,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI;IAKlD,oCAAoC;IAC7B,UAAU,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI;IAK3C,uDAAuD;IAChD,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC,+CAA+C;IACxC,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK/B,8CAA8C;IACvC,MAAM,CAAC,CAAC,EAAE,WAAW,GAAG,IAAI;IAKnC,4DAA4D;IACrD,cAAc,CAAC,GAAG,EAAE,iBAAiB,GAAG,MAAM,GAAG,IAAI;IAK5D,+DAA+D;IACxD,KAAK,IAAI,eAAe;IAoB/B;;;OAGG;IACU,GAAG,IAAI,OAAO,CAAC,iCAAiC,CAAC;CAQ/D"}