@pulseindex/sdk 2.0.0

package/dist/index.d.mts

@@ -0,0 +1,324 @@
+import * as grpc from '@grpc/grpc-js';
+import { ServiceError } from '@grpc/grpc-js';
+
+declare const FilterOperation: {
+    readonly MUST: 0;
+    readonly SHOULD: 1;
+    readonly MUST_NOT: 2;
+};
+type FilterOperationCode = (typeof FilterOperation)[keyof typeof FilterOperation];
+type EntityId = string | number | bigint;
+interface FilterPredicate {
+    op: FilterOperationCode;
+    attribute: string;
+}
+interface RangePredicate {
+    field: string;
+    minVal: number;
+    maxVal: number;
+}
+interface SearchQueryRequest {
+    locationPrefix: string;
+    filters: FilterPredicate[];
+    ranges: RangePredicate[];
+    limit: number;
+    offset: number;
+    tenantId: string;
+}
+interface SearchResponse {
+    matchedEntityIds: string[];
+    totalMatches: number;
+    executionTimeUs: number;
+}
+interface IndexEntityRequest {
+    entityId: string;
+    locationPrefix: string;
+    price: number;
+    categories: string[];
+    tenantId: string;
+}
+interface IndexEntityResponse {
+    success: boolean;
+}
+interface BatchIndexResponse {
+    indexedCount: number;
+}
+interface DeleteResponse {
+    success: boolean;
+}
+interface RadiusOptions {
+    lat: number;
+    lng?: number;
+    lon?: number;
+    radiusKm: number;
+    precision?: number;
+}
+interface SearchRequestOptions {
+    tenantId?: string;
+    locationPrefix?: EntityId;
+    must?: string | string[];
+    should?: string | string[];
+    mustNot?: string | string[];
+    ranges?: Array<{
+        field: string;
+        min: number;
+        max: number;
+    }>;
+    limit?: number;
+    offset?: number;
+    withinRadius?: RadiusOptions;
+    geoHash?: string;
+}
+interface EntityAttributes {
+    categories?: unknown;
+    tags?: unknown;
+    price?: unknown;
+    locationPrefix?: unknown;
+    location_prefix?: unknown;
+    tenantId?: unknown;
+    tenant_id?: unknown;
+    latitude?: unknown;
+    longitude?: unknown;
+    lat?: unknown;
+    lng?: unknown;
+    lon?: unknown;
+    [key: string]: unknown;
+}
+interface EntityInput {
+    id?: EntityId;
+    entityId?: EntityId;
+    entity_id?: EntityId;
+    attributes?: EntityAttributes;
+    categories?: unknown;
+    tags?: unknown;
+    price?: unknown;
+    locationPrefix?: unknown;
+    location_prefix?: unknown;
+    tenantId?: unknown;
+    tenant_id?: unknown;
+    latitude?: unknown;
+    longitude?: unknown;
+    lat?: unknown;
+    lng?: unknown;
+    lon?: unknown;
+    [key: string]: unknown;
+}
+interface BatchEntityInput {
+    id?: EntityId;
+    entityId?: EntityId;
+    entity_id?: EntityId;
+    attributes?: EntityAttributes;
+    [key: string]: unknown;
+}
+interface EncodedEntity {
+    entityId: string;
+    categories: string[];
+    price: number;
+    locationPrefix: string;
+    tenantId: string;
+}
+interface PulseIndexClientConfig {
+    endpoint?: string;
+    host?: string;
+    apiKey?: string;
+    authorization?: string;
+    tenantId?: string;
+    timeoutMs?: number;
+    ssl?: boolean | string | number;
+    rootCerts?: Buffer;
+    privateKey?: Buffer;
+    certChain?: Buffer;
+    protoPath?: string;
+    /** Override the bundled `health.proto`. Only needed if the package layout is rewritten. */
+    healthProtoPath?: string;
+    poolSize?: number;
+    channelOptions?: Record<string, unknown>;
+}
+
+interface QueryExecutor {
+    search(query: QueryBuilder): Promise<SearchResponse>;
+}
+declare class QueryBuilder {
+    private readonly executor;
+    private state;
+    constructor(executor?: QueryExecutor | null);
+    tenant(tenantId: string): QueryBuilder;
+    location(locationPrefix: string | number | bigint): QueryBuilder;
+    must(attribute: string | string[]): QueryBuilder;
+    should(attribute: string | string[]): QueryBuilder;
+    mustNot(attribute: string | string[]): QueryBuilder;
+    whereGeoHash(geohash: string): QueryBuilder;
+    inGeoHash(geohash: string): QueryBuilder;
+    withinRadius(lat: number, lon: number, radiusKm: number, precision?: number): QueryBuilder;
+    withinRadius(options: RadiusOptions): QueryBuilder;
+    range(field: string, min: number, max: number): QueryBuilder;
+    limit(limit: number): QueryBuilder;
+    offset(offset: number): QueryBuilder;
+    toRequest(defaultTenantId?: string): SearchQueryRequest;
+    toArray(defaultTenantId?: string): SearchQueryRequest;
+    execute(): Promise<SearchResponse>;
+    static fromOptions(options: SearchRequestOptions, executor?: QueryExecutor | null): QueryBuilder;
+    private addFilters;
+    private fork;
+}
+
+interface SearchEngineServiceClient extends grpc.Client {
+    indexEntity(request: unknown, metadata: grpc.Metadata, options: grpc.CallOptions, callback: grpc.requestCallback<unknown>): grpc.ClientUnaryCall;
+    batchIndexEntities(request: unknown, metadata: grpc.Metadata, options: grpc.CallOptions, callback: grpc.requestCallback<unknown>): grpc.ClientUnaryCall;
+    deleteEntity(request: unknown, metadata: grpc.Metadata, options: grpc.CallOptions, callback: grpc.requestCallback<unknown>): grpc.ClientUnaryCall;
+    search(request: unknown, metadata: grpc.Metadata, options: grpc.CallOptions, callback: grpc.requestCallback<unknown>): grpc.ClientUnaryCall;
+}
+/** `grpc.health.v1.Health` — the readiness check that needs no scope. */
+interface HealthClient extends grpc.Client {
+    check(request: {
+        service: string;
+    }, metadata: grpc.Metadata, options: grpc.CallOptions, callback: grpc.requestCallback<{
+        status?: number;
+    }>): grpc.ClientUnaryCall;
+}
+/** Values of `grpc.health.v1.HealthCheckResponse.ServingStatus`. */
+declare const SERVING_STATUS: {
+    readonly UNKNOWN: 0;
+    readonly SERVING: 1;
+    readonly NOT_SERVING: 2;
+    readonly SERVICE_UNKNOWN: 3;
+};
+
+declare function sslEnabled(config: PulseIndexClientConfig): boolean;
+declare class ConnectionManager {
+    readonly endpoint: string;
+    readonly tenantId: string;
+    readonly timeoutMs: number;
+    readonly ssl: boolean;
+    private readonly apiKey?;
+    private readonly authorization?;
+    private readonly clients;
+    private cursor;
+    private closed;
+    private readonly credentials;
+    private readonly channelOptions;
+    private readonly healthProtoPath?;
+    private healthStub?;
+    constructor(config?: PulseIndexClientConfig);
+    /**
+     * `grpc.health.v1.Health` stub, created on first use.
+     *
+     * A separate service from the query API, and unauthenticated: the health
+     * protocol needs no scope, so it works with any key or none.
+     */
+    getHealthStub(): HealthClient;
+    getStub(): SearchEngineServiceClient;
+    createMetadata(): grpc.Metadata;
+    createCallOptions(): grpc.CallOptions;
+    waitForReady(timeoutMs?: number): Promise<void>;
+    close(): void;
+    private assertOpen;
+    private createCredentials;
+}
+
+declare class PulseIndexClient implements QueryExecutor {
+    readonly connection: ConnectionManager;
+    constructor(config?: PulseIndexClientConfig);
+    static create(endpoint: string, apiKey?: string, ssl?: boolean, extra?: Omit<PulseIndexClientConfig, 'endpoint' | 'apiKey' | 'ssl'>): PulseIndexClient;
+    static query(): QueryBuilder;
+    query(): QueryBuilder;
+    search(query: QueryBuilder | SearchRequestOptions): Promise<SearchResponse>;
+    index(entityIdOrInput: EntityId | EntityInput, attributes?: EntityAttributes): Promise<IndexEntityResponse>;
+    indexEntity(entityId: EntityId, categories?: string[], price?: number, locationPrefix?: EntityId, tenantId?: string): Promise<boolean>;
+    batchIndex(entities: Array<EntityInput | BatchEntityInput>): Promise<BatchIndexResponse>;
+    delete(entityId: EntityId, tenantId?: string): Promise<DeleteResponse>;
+    deleteEntity(entityId: EntityId, tenantId?: string): Promise<boolean>;
+    /**
+     * True only when the engine can serve reads.
+     *
+     * Asks `grpc.health.v1.Health`, which needs no particular scope and tracks
+     * whether the service can currently answer queries. So this distinguishes a
+     * reachable-but-unavailable service from a healthy one.
+     *
+     * Returns `false` rather than throwing, so unreachable and unavailable look
+     * the same here. Use {@link servingStatus} to tell them apart.
+     */
+    health(): Promise<boolean>;
+    /**
+     * Raw `grpc.health.v1` serving status for a service name.
+     *
+     * Defaults to `''`, the overall-server key defined by the health spec. The
+     * service answers for both that and its named service.
+     */
+    servingStatus(service?: string): Promise<number>;
+    close(): void;
+    private unary;
+}
+declare class PulseIndex extends PulseIndexClient {
+}
+
+declare class GeoHash {
+    static readonly TAG_PREFIX = "geo:";
+    static readonly MIN_PRECISION = 1;
+    static readonly MAX_PRECISION = 12;
+    static readonly INDEX_PRECISIONS: readonly [5, 6];
+    private static readonly BASE32;
+    private static readonly EARTH_RADIUS_KM;
+    private static readonly MAX_COVERING_CELLS;
+    private static readonly NEIGHBORS;
+    private static readonly BORDERS;
+    static encode(lat: number, lon: number, precision?: number): string;
+    static decode(hash: string): {
+        lat: number;
+        lon: number;
+    };
+    static decodeBounds(hash: string): {
+        latMin: number;
+        latMax: number;
+        lonMin: number;
+        lonMax: number;
+    };
+    static neighbor(hash: string, direction: string): string;
+    static neighbors(hash: string): string[];
+    static neighborhood3x3(hash: string): string[];
+    static neighborhoodTags(lat: number, lon: number, precision?: number): string[];
+    static optimalPrecisionForRadius(radiusKm: number): number;
+    static precisionForRadius(radiusKm: number): number;
+    static getCoveringHashes(lat: number, lon: number, radiusKm: number, precision?: number): string[];
+    static tag(geohash: string): string;
+    static encodeTag(lat: number, lon: number, precision?: number): string;
+    static encodeMultiTags(lat: number, lon: number): string[];
+    static haversineKm(lat1: number, lon1: number, lat2: number, lon2: number): number;
+    private static cellIntersectsCircle;
+    private static adjacent;
+    private static normalizeHash;
+    private static assertLatitude;
+    private static assertLongitude;
+    private static assertPrecision;
+    private static isCardinal;
+    private static toRadians;
+}
+
+declare function toUint64String(value: EntityId, field?: string): string;
+declare function encodeEntity(entityIdOrInput: EntityId | EntityInput, attributes?: EntityAttributes, defaults?: {
+    tenantId?: string;
+}): EncodedEntity;
+
+declare class PulseIndexError extends Error {
+    readonly code: string;
+    readonly grpcStatusCode?: number;
+    readonly grpcDetails?: string;
+    constructor(message: string, options?: {
+        code?: string;
+        grpcStatusCode?: number;
+        grpcDetails?: string;
+        cause?: unknown;
+    });
+    static fromGrpc(error: ServiceError | Error): PulseIndexError;
+}
+declare class PulseIndexConnectionError extends PulseIndexError {
+    constructor(message: string, options?: ConstructorParameters<typeof PulseIndexError>[1]);
+}
+declare class PulseIndexAuthError extends PulseIndexError {
+    constructor(message: string, options?: ConstructorParameters<typeof PulseIndexError>[1]);
+}
+declare class PulseIndexQueryError extends PulseIndexError {
+    constructor(message: string, options?: ConstructorParameters<typeof PulseIndexError>[1]);
+}
+
+export { type BatchEntityInput, type BatchIndexResponse, ConnectionManager, type DeleteResponse, type EncodedEntity, type EntityAttributes, type EntityId, type EntityInput, FilterOperation, type FilterPredicate, GeoHash, type IndexEntityRequest, type IndexEntityResponse, PulseIndex, PulseIndexAuthError, PulseIndexClient, type PulseIndexClientConfig, PulseIndexConnectionError, PulseIndexError, PulseIndexQueryError, QueryBuilder, type RadiusOptions, type RangePredicate, SERVING_STATUS, type SearchQueryRequest, type SearchRequestOptions, type SearchResponse, PulseIndex as default, encodeEntity, sslEnabled, toUint64String };

package/dist/index.d.ts

@@ -0,0 +1,324 @@
+import * as grpc from '@grpc/grpc-js';
+import { ServiceError } from '@grpc/grpc-js';
+
+declare const FilterOperation: {
+    readonly MUST: 0;
+    readonly SHOULD: 1;
+    readonly MUST_NOT: 2;
+};
+type FilterOperationCode = (typeof FilterOperation)[keyof typeof FilterOperation];
+type EntityId = string | number | bigint;
+interface FilterPredicate {
+    op: FilterOperationCode;
+    attribute: string;
+}
+interface RangePredicate {
+    field: string;
+    minVal: number;
+    maxVal: number;
+}
+interface SearchQueryRequest {
+    locationPrefix: string;
+    filters: FilterPredicate[];
+    ranges: RangePredicate[];
+    limit: number;
+    offset: number;
+    tenantId: string;
+}
+interface SearchResponse {
+    matchedEntityIds: string[];
+    totalMatches: number;
+    executionTimeUs: number;
+}
+interface IndexEntityRequest {
+    entityId: string;
+    locationPrefix: string;
+    price: number;
+    categories: string[];
+    tenantId: string;
+}
+interface IndexEntityResponse {
+    success: boolean;
+}
+interface BatchIndexResponse {
+    indexedCount: number;
+}
+interface DeleteResponse {
+    success: boolean;
+}
+interface RadiusOptions {
+    lat: number;
+    lng?: number;
+    lon?: number;
+    radiusKm: number;
+    precision?: number;
+}
+interface SearchRequestOptions {
+    tenantId?: string;
+    locationPrefix?: EntityId;
+    must?: string | string[];
+    should?: string | string[];
+    mustNot?: string | string[];
+    ranges?: Array<{
+        field: string;
+        min: number;
+        max: number;
+    }>;
+    limit?: number;
+    offset?: number;
+    withinRadius?: RadiusOptions;
+    geoHash?: string;
+}
+interface EntityAttributes {
+    categories?: unknown;
+    tags?: unknown;
+    price?: unknown;
+    locationPrefix?: unknown;
+    location_prefix?: unknown;
+    tenantId?: unknown;
+    tenant_id?: unknown;
+    latitude?: unknown;
+    longitude?: unknown;
+    lat?: unknown;
+    lng?: unknown;
+    lon?: unknown;
+    [key: string]: unknown;
+}
+interface EntityInput {
+    id?: EntityId;
+    entityId?: EntityId;
+    entity_id?: EntityId;
+    attributes?: EntityAttributes;
+    categories?: unknown;
+    tags?: unknown;
+    price?: unknown;
+    locationPrefix?: unknown;
+    location_prefix?: unknown;
+    tenantId?: unknown;
+    tenant_id?: unknown;
+    latitude?: unknown;
+    longitude?: unknown;
+    lat?: unknown;
+    lng?: unknown;
+    lon?: unknown;
+    [key: string]: unknown;
+}
+interface BatchEntityInput {
+    id?: EntityId;
+    entityId?: EntityId;
+    entity_id?: EntityId;
+    attributes?: EntityAttributes;
+    [key: string]: unknown;
+}
+interface EncodedEntity {
+    entityId: string;
+    categories: string[];
+    price: number;
+    locationPrefix: string;
+    tenantId: string;
+}
+interface PulseIndexClientConfig {
+    endpoint?: string;
+    host?: string;
+    apiKey?: string;
+    authorization?: string;
+    tenantId?: string;
+    timeoutMs?: number;
+    ssl?: boolean | string | number;
+    rootCerts?: Buffer;
+    privateKey?: Buffer;
+    certChain?: Buffer;
+    protoPath?: string;
+    /** Override the bundled `health.proto`. Only needed if the package layout is rewritten. */
+    healthProtoPath?: string;
+    poolSize?: number;
+    channelOptions?: Record<string, unknown>;
+}
+
+interface QueryExecutor {
+    search(query: QueryBuilder): Promise<SearchResponse>;
+}
+declare class QueryBuilder {
+    private readonly executor;
+    private state;
+    constructor(executor?: QueryExecutor | null);
+    tenant(tenantId: string): QueryBuilder;
+    location(locationPrefix: string | number | bigint): QueryBuilder;
+    must(attribute: string | string[]): QueryBuilder;
+    should(attribute: string | string[]): QueryBuilder;
+    mustNot(attribute: string | string[]): QueryBuilder;
+    whereGeoHash(geohash: string): QueryBuilder;
+    inGeoHash(geohash: string): QueryBuilder;
+    withinRadius(lat: number, lon: number, radiusKm: number, precision?: number): QueryBuilder;
+    withinRadius(options: RadiusOptions): QueryBuilder;
+    range(field: string, min: number, max: number): QueryBuilder;
+    limit(limit: number): QueryBuilder;
+    offset(offset: number): QueryBuilder;
+    toRequest(defaultTenantId?: string): SearchQueryRequest;
+    toArray(defaultTenantId?: string): SearchQueryRequest;
+    execute(): Promise<SearchResponse>;
+    static fromOptions(options: SearchRequestOptions, executor?: QueryExecutor | null): QueryBuilder;
+    private addFilters;
+    private fork;
+}
+
+interface SearchEngineServiceClient extends grpc.Client {
+    indexEntity(request: unknown, metadata: grpc.Metadata, options: grpc.CallOptions, callback: grpc.requestCallback<unknown>): grpc.ClientUnaryCall;
+    batchIndexEntities(request: unknown, metadata: grpc.Metadata, options: grpc.CallOptions, callback: grpc.requestCallback<unknown>): grpc.ClientUnaryCall;
+    deleteEntity(request: unknown, metadata: grpc.Metadata, options: grpc.CallOptions, callback: grpc.requestCallback<unknown>): grpc.ClientUnaryCall;
+    search(request: unknown, metadata: grpc.Metadata, options: grpc.CallOptions, callback: grpc.requestCallback<unknown>): grpc.ClientUnaryCall;
+}
+/** `grpc.health.v1.Health` — the readiness check that needs no scope. */
+interface HealthClient extends grpc.Client {
+    check(request: {
+        service: string;
+    }, metadata: grpc.Metadata, options: grpc.CallOptions, callback: grpc.requestCallback<{
+        status?: number;
+    }>): grpc.ClientUnaryCall;
+}
+/** Values of `grpc.health.v1.HealthCheckResponse.ServingStatus`. */
+declare const SERVING_STATUS: {
+    readonly UNKNOWN: 0;
+    readonly SERVING: 1;
+    readonly NOT_SERVING: 2;
+    readonly SERVICE_UNKNOWN: 3;
+};
+
+declare function sslEnabled(config: PulseIndexClientConfig): boolean;
+declare class ConnectionManager {
+    readonly endpoint: string;
+    readonly tenantId: string;
+    readonly timeoutMs: number;
+    readonly ssl: boolean;
+    private readonly apiKey?;
+    private readonly authorization?;
+    private readonly clients;
+    private cursor;
+    private closed;
+    private readonly credentials;
+    private readonly channelOptions;
+    private readonly healthProtoPath?;
+    private healthStub?;
+    constructor(config?: PulseIndexClientConfig);
+    /**
+     * `grpc.health.v1.Health` stub, created on first use.
+     *
+     * A separate service from the query API, and unauthenticated: the health
+     * protocol needs no scope, so it works with any key or none.
+     */
+    getHealthStub(): HealthClient;
+    getStub(): SearchEngineServiceClient;
+    createMetadata(): grpc.Metadata;
+    createCallOptions(): grpc.CallOptions;
+    waitForReady(timeoutMs?: number): Promise<void>;
+    close(): void;
+    private assertOpen;
+    private createCredentials;
+}
+
+declare class PulseIndexClient implements QueryExecutor {
+    readonly connection: ConnectionManager;
+    constructor(config?: PulseIndexClientConfig);
+    static create(endpoint: string, apiKey?: string, ssl?: boolean, extra?: Omit<PulseIndexClientConfig, 'endpoint' | 'apiKey' | 'ssl'>): PulseIndexClient;
+    static query(): QueryBuilder;
+    query(): QueryBuilder;
+    search(query: QueryBuilder | SearchRequestOptions): Promise<SearchResponse>;
+    index(entityIdOrInput: EntityId | EntityInput, attributes?: EntityAttributes): Promise<IndexEntityResponse>;
+    indexEntity(entityId: EntityId, categories?: string[], price?: number, locationPrefix?: EntityId, tenantId?: string): Promise<boolean>;
+    batchIndex(entities: Array<EntityInput | BatchEntityInput>): Promise<BatchIndexResponse>;
+    delete(entityId: EntityId, tenantId?: string): Promise<DeleteResponse>;
+    deleteEntity(entityId: EntityId, tenantId?: string): Promise<boolean>;
+    /**
+     * True only when the engine can serve reads.
+     *
+     * Asks `grpc.health.v1.Health`, which needs no particular scope and tracks
+     * whether the service can currently answer queries. So this distinguishes a
+     * reachable-but-unavailable service from a healthy one.
+     *
+     * Returns `false` rather than throwing, so unreachable and unavailable look
+     * the same here. Use {@link servingStatus} to tell them apart.
+     */
+    health(): Promise<boolean>;
+    /**
+     * Raw `grpc.health.v1` serving status for a service name.
+     *
+     * Defaults to `''`, the overall-server key defined by the health spec. The
+     * service answers for both that and its named service.
+     */
+    servingStatus(service?: string): Promise<number>;
+    close(): void;
+    private unary;
+}
+declare class PulseIndex extends PulseIndexClient {
+}
+
+declare class GeoHash {
+    static readonly TAG_PREFIX = "geo:";
+    static readonly MIN_PRECISION = 1;
+    static readonly MAX_PRECISION = 12;
+    static readonly INDEX_PRECISIONS: readonly [5, 6];
+    private static readonly BASE32;
+    private static readonly EARTH_RADIUS_KM;
+    private static readonly MAX_COVERING_CELLS;
+    private static readonly NEIGHBORS;
+    private static readonly BORDERS;
+    static encode(lat: number, lon: number, precision?: number): string;
+    static decode(hash: string): {
+        lat: number;
+        lon: number;
+    };
+    static decodeBounds(hash: string): {
+        latMin: number;
+        latMax: number;
+        lonMin: number;
+        lonMax: number;
+    };
+    static neighbor(hash: string, direction: string): string;
+    static neighbors(hash: string): string[];
+    static neighborhood3x3(hash: string): string[];
+    static neighborhoodTags(lat: number, lon: number, precision?: number): string[];
+    static optimalPrecisionForRadius(radiusKm: number): number;
+    static precisionForRadius(radiusKm: number): number;
+    static getCoveringHashes(lat: number, lon: number, radiusKm: number, precision?: number): string[];
+    static tag(geohash: string): string;
+    static encodeTag(lat: number, lon: number, precision?: number): string;
+    static encodeMultiTags(lat: number, lon: number): string[];
+    static haversineKm(lat1: number, lon1: number, lat2: number, lon2: number): number;
+    private static cellIntersectsCircle;
+    private static adjacent;
+    private static normalizeHash;
+    private static assertLatitude;
+    private static assertLongitude;
+    private static assertPrecision;
+    private static isCardinal;
+    private static toRadians;
+}
+
+declare function toUint64String(value: EntityId, field?: string): string;
+declare function encodeEntity(entityIdOrInput: EntityId | EntityInput, attributes?: EntityAttributes, defaults?: {
+    tenantId?: string;
+}): EncodedEntity;
+
+declare class PulseIndexError extends Error {
+    readonly code: string;
+    readonly grpcStatusCode?: number;
+    readonly grpcDetails?: string;
+    constructor(message: string, options?: {
+        code?: string;
+        grpcStatusCode?: number;
+        grpcDetails?: string;
+        cause?: unknown;
+    });
+    static fromGrpc(error: ServiceError | Error): PulseIndexError;
+}
+declare class PulseIndexConnectionError extends PulseIndexError {
+    constructor(message: string, options?: ConstructorParameters<typeof PulseIndexError>[1]);
+}
+declare class PulseIndexAuthError extends PulseIndexError {
+    constructor(message: string, options?: ConstructorParameters<typeof PulseIndexError>[1]);
+}
+declare class PulseIndexQueryError extends PulseIndexError {
+    constructor(message: string, options?: ConstructorParameters<typeof PulseIndexError>[1]);
+}
+
+export { type BatchEntityInput, type BatchIndexResponse, ConnectionManager, type DeleteResponse, type EncodedEntity, type EntityAttributes, type EntityId, type EntityInput, FilterOperation, type FilterPredicate, GeoHash, type IndexEntityRequest, type IndexEntityResponse, PulseIndex, PulseIndexAuthError, PulseIndexClient, type PulseIndexClientConfig, PulseIndexConnectionError, PulseIndexError, PulseIndexQueryError, QueryBuilder, type RadiusOptions, type RangePredicate, SERVING_STATUS, type SearchQueryRequest, type SearchRequestOptions, type SearchResponse, PulseIndex as default, encodeEntity, sslEnabled, toUint64String };