Interface CapabilityAwareSource<T>

Runtime Source returned by Dataset.source() and connect().source().

A v2 profile, when attached, is the authoritative truth. Legacy sources without a profile continue to answer built-in checks from their existing ReadonlySet and return false for extension identifiers.

interface CapabilityAwareSource<T = Record<string, unknown>> {
    attachments: AttachmentApi;
    capabilities: Capabilities;
    capabilityProfile?: CapabilityProfile;
    descriptor: SourceDescriptor;
    adapter<K extends AdapterKind>(kind: K): AdapterFor<K> | undefined;
    applyEdits(envelope: EditEnvelope<T>): Promise<EditResult>;
    protocol<K extends AdapterKind>(kind: K): AdapterFor<K> | undefined;
    query(request?: Query<T>): Promise<Result<T>>;
    queryAggregate(
        request: Query<T> & { aggregation: AggregationSpec },
    ): Promise<Result<T>>;
    queryAll(request?: Query<T>): Promise<Result<T>>;
    queryExtent(
        request?: Query<T>,
    ): Promise<{ count?: number; extent: HonuaExtent | null }>;
    queryObjectIds(request?: Query<T>): Promise<readonly FeatureId[]>;
    queryRelated<R = Record<string, unknown>>(
        request: RelatedQuery,
    ): Promise<RelatedResult<R>>;
    stream(request?: Query<T>): AsyncGenerator<Result<T>, void, undefined>;
    supports<const C extends CapabilityId>(
        capability: C,
    ): this is CapabilityAwareSource<T> & SupportedSourceCapability<C>;
}

Type Parameters

T = Record<string, unknown>

Hierarchy (View Summary)

Source<T>
- CapabilityAwareSource

Index

Properties

attachments capabilities capabilityProfile? descriptor

Methods

adapter applyEdits protocol query queryAggregate queryAll queryExtent queryObjectIds queryRelated stream supports

Properties

`Readonly`attachments

attachments: AttachmentApi

Attachment operations namespace; methods throw if attachments is missing.

`Readonly`capabilities

capabilities: Capabilities

`Optional` `Readonly`capabilityProfile

capabilityProfile?: CapabilityProfile

`Readonly`descriptor

descriptor: SourceDescriptor

Methods

adapter

adapter<K extends AdapterKind>(kind: K): AdapterFor<K> | undefined
Legacy alias of Source.protocol. Retained for callers written against the original ticket-23 surface; new code should prefer protocol() because the name reflects the design intent of protocol-namespaced escape hatches.
Type Parameters
- K extends AdapterKind
Parameters
- kind: K
Returns AdapterFor<K> | undefined
Inherited from Source.adapter
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1034

applyEdits

applyEdits(envelope: EditEnvelope<T>): Promise<EditResult>
Apply add / update / delete edits to the source.
Parameters
- envelope: EditEnvelope<T>
Returns Promise<EditResult>
Inherited from Source.applyEdits
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1014

protocol

protocol<K extends AdapterKind>(kind: K): AdapterFor<K> | undefined
Typed escape hatch to the underlying protocol-specific class. Use this when a caller needs raw protocol semantics (e.g. raw where, raw outFields, GeoServices calculate / validateSQL / replica / queryBins / getEstimates) that the canonical surface intentionally does not expose.
Type Parameters
- K extends AdapterKind
Parameters
- kind: K
Returns AdapterFor<K> | undefined
Inherited from Source.protocol
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1027

query

query(request?: Query<T>): Promise<Result<T>>
Single-page query.
Parameters
- Optionalrequest: Query<T>
Returns Promise<Result<T>>
Inherited from Source.query
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1001

queryAggregate

queryAggregate(
request: Query<T> & { aggregation: AggregationSpec },
): Promise<Result<T>>
Server-side aggregation; falls back to client-side under degraded policy.
Parameters
- request: Query<T> & { aggregation: AggregationSpec }
Returns Promise<Result<T>>
Inherited from Source.queryAggregate
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1005

queryAll

queryAll(request?: Query<T>): Promise<Result<T>>
Drain all pages into a single result. Honors Query.pagination.limit.
Parameters
- Optionalrequest: Query<T>
Returns Promise<Result<T>>
Inherited from Source.queryAll
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1003

queryExtent

queryExtent(
request?: Query<T>,
): Promise<{ count?: number; extent: HonuaExtent | null }>
Extent of the records that match request.
Parameters
- Optionalrequest: Query<T>
Returns Promise<{ count?: number; extent: HonuaExtent | null }>
Inherited from Source.queryExtent
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1007

queryObjectIds

queryObjectIds(request?: Query<T>): Promise<readonly FeatureId[]>
Object ids of the records matching request.
Parameters
- Optionalrequest: Query<T>
Returns Promise<readonly FeatureId[]>
Inherited from Source.queryObjectIds
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1012

queryRelated

queryRelated<R = Record<string, unknown>>(
request: RelatedQuery,
): Promise<RelatedResult<R>>
Pull related records for the addressed source ids.
Type Parameters
- R = Record<string, unknown>
Parameters
- request: RelatedQuery
Returns Promise<RelatedResult<R>>
Inherited from Source.queryRelated
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1016

stream

stream(request?: Query<T>): AsyncGenerator<Result<T>, void, undefined>
Async-generator paging stream.
Parameters
- Optionalrequest: Query<T>
Returns AsyncGenerator<Result<T>, void, undefined>
Inherited from Source.stream
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1009

supports

supports<const C extends CapabilityId>(
capability: C,
): this is CapabilityAwareSource<T> & SupportedSourceCapability<C>
Test effective support and narrow this source for a literal capability. Only the exact "supported" effective state passes; unknown, disabled, unavailable, and authorization states all fail closed.
Type Parameters
- const C extends CapabilityId
Parameters
- capability: C
Returns this is CapabilityAwareSource<T> & SupportedSourceCapability<C>
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:1067

Interface CapabilityAwareSource<T>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonlyattachments

Readonlycapabilities

Optional ReadonlycapabilityProfile

Readonlydescriptor

Methods

adapter

Type Parameters

Parameters

Returns AdapterFor<K> | undefined

applyEdits

Parameters

Returns Promise<EditResult>

protocol

Type Parameters

Parameters

Returns AdapterFor<K> | undefined

query

Parameters

Returns Promise<Result<T>>

queryAggregate

Parameters

Returns Promise<Result<T>>

queryAll

Parameters

Returns Promise<Result<T>>

queryExtent

Parameters

Returns Promise<{ count?: number; extent: HonuaExtent | null }>

queryObjectIds

Parameters

Returns Promise<readonly FeatureId[]>

queryRelated

Type Parameters

Parameters

Returns Promise<RelatedResult<R>>

stream

Parameters

Returns AsyncGenerator<Result<T>, void, undefined>

supports

Type Parameters

Parameters

Returns this is CapabilityAwareSource<T> & SupportedSourceCapability<C>

Settings

On This Page

`Readonly`attachments

`Readonly`capabilities

`Optional` `Readonly`capabilityProfile

`Readonly`descriptor