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> {
    attachments: AttachmentApi;
    capabilities: Capabilities;
    capabilityProfile?: CapabilityProfile;
    descriptor: SourceDescriptor;
    adapter<K>(kind: K): undefined | AdapterFor<K>;
    applyEdits(envelope: EditEnvelope<T>): Promise<EditResult>;
    protocol<K>(kind: K): undefined | AdapterFor<K>;
    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: null | HonuaExtent;
    }>;
    queryObjectIds(request?: Query<T>): Promise<readonly FeatureId[]>;
    queryRelated<R>(request: RelatedQuery): Promise<RelatedResult<R>>;
    stream(request?: Query<T>): AsyncGenerator<Result<T>, void, undefined>;
    supports<const C>(capability: C): this is CapabilityAwareSource<T> & SupportedSourceCapability<C>;
}

Type Parameters

T = Record<string, unknown>

Hierarchy (view full)

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>(kind): undefined | AdapterFor<K>
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 undefined | AdapterFor<K>
Inherited from Source.adapter
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:902

applyEdits

applyEdits(envelope): 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:882

protocol

protocol<K>(kind): undefined | AdapterFor<K>
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 undefined | AdapterFor<K>
Inherited from Source.protocol
- Defined in work/honua-sdk-js/honua-sdk-js/src/contract/types.ts:895

query

query(request?): 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:869

queryAggregate

queryAggregate(request): 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:873

queryAll

queryAll(request?): 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:871

queryExtent

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

queryObjectIds

queryObjectIds(request?): 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:880

queryRelated

queryRelated<R>(request): 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:884

stream

stream(request?): 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:877

supports

supports<const C>(capability): 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:935

Interface CapabilityAwareSource<T>

Type Parameters

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonlyattachments

Readonlycapabilities

Optional ReadonlycapabilityProfile

Readonlydescriptor

Methods

adapter

Type Parameters

Parameters

Returns undefined | AdapterFor<K>

applyEdits

Parameters

Returns Promise<EditResult>

protocol

Type Parameters

Parameters

Returns undefined | AdapterFor<K>

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: null | HonuaExtent; }>

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

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