@latlng/sdk 0.1.0

package/dist/types/models.d.ts

@@ -0,0 +1,408 @@
+import type { JsonValue } from "./json.js";
+/** Geographic bounding box expressed as min/max latitude and longitude. */
+export interface BoundingBox {
+    /** Southern latitude bound. */
+    min_lat: number;
+    /** Western longitude bound. */
+    min_lon: number;
+    /** Northern latitude bound. */
+    max_lat: number;
+    /** Eastern longitude bound. */
+    max_lon: number;
+}
+/** Field value stored alongside an object. */
+export type FieldValue = {
+    type: "number";
+    value: number;
+} | {
+    type: "text";
+    value: string;
+} | {
+    type: "json";
+    value: string;
+};
+/** Named field assignment. */
+export interface FieldEntry {
+    /** Field name. */
+    name: string;
+    /** Field value. */
+    value: FieldValue;
+}
+/** Field map keyed by field name. */
+export type FieldMap = Record<string, FieldValue>;
+/** Stored geographic object representation. */
+export type GeoObject = {
+    type: "point";
+    lat: number;
+    lon: number;
+    z?: number | null;
+} | {
+    type: "bounds";
+    bounds: BoundingBox;
+} | {
+    type: "hash";
+    value: string;
+} | {
+    type: "geojson";
+    value: JsonValue;
+} | {
+    type: "string";
+    value: string;
+};
+/** Object returned by the `latlng` server. */
+export interface LatLngObject {
+    /** Object identifier. */
+    id: string;
+    /** Stored geometry or string payload. */
+    geo: GeoObject;
+    /** Attached fields. */
+    fields: FieldMap;
+    /** Expiration timestamp, when set. */
+    expires_at: number | null;
+}
+/** Area definition used by spatial query APIs. */
+export type Area = {
+    type: "circle";
+    lat: number;
+    lon: number;
+    meters: number;
+} | {
+    type: "bounds";
+    bounds: BoundingBox;
+} | {
+    type: "hash";
+    value: string;
+} | {
+    type: "geojson";
+    value: JsonValue;
+} | {
+    type: "tile";
+    x: number;
+    y: number;
+    z: number;
+} | {
+    type: "quadkey";
+    value: string;
+} | {
+    type: "sector";
+    lat: number;
+    lon: number;
+    meters: number;
+    bearing1: number;
+    bearing2: number;
+} | {
+    type: "reference";
+    collection: string;
+    id: string;
+};
+/** Sort direction for search results. */
+export type SortOrder = "asc" | "desc";
+/** Output format requested from spatial query endpoints. */
+export type OutputFormat = "objects" | "points" | "bounds" | "ids" | "count" | {
+    hashes: {
+        precision: number;
+    };
+};
+/** Numeric or textual comparison used in `where` clauses. */
+export type WhereComparison = {
+    type: "range";
+    min: number;
+    max: number;
+} | {
+    type: "equalsText";
+    value: string;
+} | {
+    type: "regex";
+    value: string;
+};
+/** Field-level filter used by search endpoints. */
+export interface WhereFilter {
+    /** Field name to compare. */
+    field: string;
+    /** Comparison to apply to the field. */
+    comparison: WhereComparison;
+}
+/** Inclusion filter used by search endpoints. */
+export interface WhereInFilter {
+    /** Field name to inspect. */
+    field: string;
+    /** Accepted string values. */
+    values: string[];
+}
+/** Expression filter used by search endpoints. */
+export interface WhereExprFilter {
+    /** Server-side expression string. */
+    expression: string;
+}
+/** Shared options accepted by search endpoints. */
+export interface SearchOptions {
+    /** Cursor to resume a paginated query. */
+    cursor?: number;
+    /** Maximum number of results to return. */
+    limit?: number;
+    /** Omit field maps from result items when `true`. */
+    nofields?: boolean;
+    /** Match pattern applied to object IDs. */
+    matchPattern?: string;
+    /** Result sort direction. */
+    sort?: SortOrder;
+    /** Numeric/text `where` filters. */
+    whereFilters?: WhereFilter[];
+    /** `where in` filters. */
+    whereInFilters?: WhereInFilter[];
+    /** Expression filters. */
+    whereExprFilters?: WhereExprFilter[];
+    /** Clip geometries to the query area when supported. */
+    clip?: boolean;
+    /** Output format for result items. */
+    output?: OutputFormat;
+}
+/** Request payload for `nearby` searches. */
+export interface NearbyQuery {
+    /** Center latitude. */
+    lat: number;
+    /** Center longitude. */
+    lon: number;
+    /** Radius in meters. */
+    meters: number;
+    /** Additional search options. */
+    options?: SearchOptions;
+}
+/** Single result item returned by a search. */
+export interface SearchItem {
+    /** Object identifier. */
+    id: string;
+    /** Returned object when requested by the output format. */
+    object?: GeoObject;
+    /** Returned fields when requested. */
+    fields?: FieldMap;
+    /** Distance from the query origin, when relevant. */
+    distance_meters?: number | null;
+}
+/** Search response payload. */
+export interface SearchResults {
+    /** Result items for the current page. */
+    results: SearchItem[];
+    /** Cursor for the next page. */
+    cursor: number;
+    /** Total result count or count for the requested page, depending on the server output mode. */
+    count: number;
+}
+/** Collection statistics returned by the server. */
+export interface CollectionStats {
+    /** Collection name. */
+    name: string;
+    /** Number of stored objects. */
+    object_count: number;
+    /** Number of point objects. */
+    point_count: number;
+    /** Number of string objects. */
+    string_count: number;
+    /** Number of objects with TTLs. */
+    expires_count: number;
+}
+/** Collection metadata returned by `getCollection`. */
+export interface CollectionInfo {
+    /** Collection name. */
+    name: string;
+    /** Collection bounds when available. */
+    bounds: BoundingBox | null;
+    /** Collection statistics. */
+    stats: CollectionStats;
+}
+/** AOF compaction before/after statistics. */
+export interface CompactionResult {
+    before_entries: number;
+    after_entries: number;
+    before_bytes: number;
+    after_bytes: number;
+}
+/** Server status returned by the `/server` endpoint. */
+export interface ServerInfo {
+    version: string;
+    api_version: string;
+    protocol_version: string;
+    storage_format_version: string;
+    num_collections: number;
+    num_objects: number;
+    num_points: number;
+    heap_bytes: number;
+    read_only: boolean;
+    leader: boolean;
+    server_id: string;
+    following: string | null;
+    caught_up: boolean;
+    caught_up_once: boolean;
+    last_sequence: number;
+}
+/**
+ * Creates a point object payload.
+ *
+ * @param lat Latitude.
+ * @param lon Longitude.
+ * @param z Optional elevation component.
+ * @returns Point object payload.
+ */
+export declare function point(lat: number, lon: number, z?: number | null): GeoObject;
+/**
+ * Creates a bounds object payload.
+ *
+ * @param boundsValue Bounding box value.
+ * @returns Bounds object payload.
+ */
+export declare function bounds(boundsValue: BoundingBox): GeoObject;
+/**
+ * Creates a geohash object payload.
+ *
+ * @param value Hash string.
+ * @returns Hash object payload.
+ */
+export declare function hash(value: string): GeoObject;
+/**
+ * Creates a GeoJSON object payload.
+ *
+ * @param value GeoJSON value.
+ * @returns GeoJSON object payload.
+ */
+export declare function geojson(value: JsonValue): GeoObject;
+/**
+ * Creates a string object payload.
+ *
+ * @param value String value.
+ * @returns String object payload.
+ */
+export declare function stringObject(value: string): GeoObject;
+/**
+ * Creates a numeric field value.
+ *
+ * @param value Numeric field value.
+ * @returns Field value payload.
+ */
+export declare function numberField(value: number): FieldValue;
+/**
+ * Creates a text field value.
+ *
+ * @param value Text field value.
+ * @returns Field value payload.
+ */
+export declare function textField(value: string): FieldValue;
+/**
+ * Creates a JSON field value.
+ *
+ * @param value JSON string value.
+ * @returns Field value payload.
+ */
+export declare function jsonField(value: string): FieldValue;
+/**
+ * Converts a field map into an ordered list of field entries.
+ *
+ * @param fields Field map.
+ * @returns Field entry array.
+ */
+export declare function fieldEntries(fields: FieldMap | undefined): FieldEntry[];
+/**
+ * Converts a field value into the server wire format.
+ *
+ * @param value Field value.
+ * @returns Wire-format field value.
+ */
+export declare function toWireFieldValue(value: FieldValue): unknown;
+/**
+ * Parses a field value from the server wire format.
+ *
+ * @param value Raw response value.
+ * @returns Parsed field value.
+ */
+export declare function fromWireFieldValue(value: unknown): FieldValue;
+/**
+ * Converts field entries into the server wire format.
+ *
+ * @param fields Field map or entry list.
+ * @returns Wire-format field entry array.
+ */
+export declare function toWireFieldEntries(fields: FieldEntry[] | FieldMap | undefined): unknown[];
+/**
+ * Parses a field map from the server wire format.
+ *
+ * @param value Raw response value.
+ * @returns Parsed field map.
+ */
+export declare function fromWireFieldMap(value: unknown): FieldMap;
+/**
+ * Converts a geographic object into the server wire format.
+ *
+ * @param value Geographic object.
+ * @returns Wire-format object payload.
+ */
+export declare function toWireGeoObject(value: GeoObject): unknown;
+/**
+ * Parses a geographic object from the server wire format.
+ *
+ * @param value Raw response value.
+ * @returns Parsed geographic object.
+ */
+export declare function fromWireGeoObject(value: unknown): GeoObject;
+/**
+ * Converts an area definition into the server wire format.
+ *
+ * @param area Area definition.
+ * @returns Wire-format area payload.
+ */
+export declare function toWireArea(area: Area): unknown;
+/**
+ * Parses an area definition from the server wire format.
+ *
+ * @param value Raw response value.
+ * @returns Parsed area definition.
+ */
+export declare function fromWireArea(value: unknown): Area;
+/**
+ * Converts a sort order into the server wire format.
+ *
+ * @param value Sort order.
+ * @returns Wire-format sort order.
+ */
+export declare function toWireSortOrder(value: SortOrder | undefined): unknown;
+/**
+ * Converts an output format into the server wire format.
+ *
+ * @param value Output format.
+ * @returns Wire-format output format.
+ */
+export declare function toWireOutputFormat(value: OutputFormat | undefined): unknown;
+/**
+ * Converts a `where` comparison into the server wire format.
+ *
+ * @param value Comparison value.
+ * @returns Wire-format comparison.
+ */
+export declare function toWireWhereComparison(value: WhereComparison): unknown;
+/**
+ * Converts search options into the server wire format.
+ *
+ * @param options Search options.
+ * @returns Wire-format search options.
+ */
+export declare function toWireSearchOptions(options: SearchOptions | undefined): unknown;
+/**
+ * Parses an object response from the server.
+ *
+ * @param value Raw response value.
+ * @returns Parsed object or `null`.
+ */
+export declare function fromWireObject(value: unknown): LatLngObject | null;
+/**
+ * Parses search results from the server wire format.
+ *
+ * @param value Raw response value.
+ * @returns Parsed search results.
+ */
+export declare function fromWireSearchResults(value: unknown): SearchResults;
+/**
+ * Parses the `/server` endpoint response.
+ *
+ * @param value Raw response value.
+ * @returns Parsed server info.
+ */
+export declare function parseServerInfo(value: unknown): ServerInfo;
+//# sourceMappingURL=models.d.ts.map

package/dist/types/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/types/models.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAE3C,2EAA2E;AAC3E,MAAM,WAAW,WAAW;IAC1B,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,8CAA8C;AAC9C,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACjC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpC,8BAA8B;AAC9B,MAAM,WAAW,UAAU;IACzB,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,KAAK,EAAE,UAAU,CAAC;CACnB;AAED,qCAAqC;AACrC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAElD,+CAA+C;AAC/C,MAAM,MAAM,SAAS,GACjB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAC9D;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,WAAW,CAAA;CAAE,GACvC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,SAAS,CAAA;CAAE,GACrC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,8CAA8C;AAC9C,MAAM,WAAW,YAAY;IAC3B,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,yCAAyC;IACzC,GAAG,EAAE,SAAS,CAAC;IACf,uBAAuB;IACvB,MAAM,EAAE,QAAQ,CAAC;IACjB,sCAAsC;IACtC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,kDAAkD;AAClD,MAAM,MAAM,IAAI,GACZ;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC5D;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,WAAW,CAAA;CAAE,GACvC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,SAAS,CAAA;CAAE,GACrC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,GACjD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAClC;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1D,yCAAyC;AACzC,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;AAEvC,4DAA4D;AAC5D,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,OAAO,GACP;IAAE,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC;AAEtC,6DAA6D;AAC7D,MAAM,MAAM,eAAe,GACvB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAC3C;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACrC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAErC,mDAAmD;AACnD,MAAM,WAAW,WAAW;IAC1B,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,UAAU,EAAE,eAAe,CAAC;CAC7B;AAED,iDAAiD;AACjD,MAAM,WAAW,aAAa;IAC5B,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,kDAAkD;AAClD,MAAM,WAAW,eAAe;IAC9B,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,mDAAmD;AACnD,MAAM,WAAW,aAAa;IAC5B,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2CAA2C;IAC3C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6BAA6B;IAC7B,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,oCAAoC;IACpC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,0BAA0B;IAC1B,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC,0BAA0B;IAC1B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,wDAAwD;IACxD,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,sCAAsC;IACtC,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED,6CAA6C;AAC7C,MAAM,WAAW,WAAW;IAC1B,uBAAuB;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,wBAAwB;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,+CAA+C;AAC/C,MAAM,WAAW,UAAU;IACzB,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,2DAA2D;IAC3D,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,sCAAsC;IACtC,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,qDAAqD;IACrD,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,+BAA+B;AAC/B,MAAM,WAAW,aAAa;IAC5B,yCAAyC;IACzC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,+FAA+F;IAC/F,KAAK,EAAE,MAAM,CAAC;CACf;AAED,oDAAoD;AACpD,MAAM,WAAW,eAAe;IAC9B,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,uDAAuD;AACvD,MAAM,WAAW,cAAc;IAC7B,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;IAC3B,6BAA6B;IAC7B,KAAK,EAAE,eAAe,CAAC;CACxB;AAED,8CAA8C;AAC9C,MAAM,WAAW,gBAAgB;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,wDAAwD;AACxD,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAE5E;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,WAAW,EAAE,WAAW,GAAG,SAAS,CAE1D;AAED;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,CAEnD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAErD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAErD;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAEnD;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAEnD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,UAAU,EAAE,CAEvE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAS3D;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,CAc7D;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,EAAE,CASzF;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,QAAQ,CAWzD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAazD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,CA0C3D;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CA2B9C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAmGjD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAKrE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,SAAS,GAAG,OAAO,CAiB3E;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CASrE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,GAAG,OAAO,CAiB/E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,GAAG,IAAI,CAalE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,aAAa,CA0BnE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,CAwB1D"}

package/dist/types/requests.d.ts

@@ -0,0 +1,96 @@
+import type { FieldEntry, FieldMap, NearbyQuery, OutputFormat, SearchOptions } from "./models.js";
+import type { GeofenceDef } from "./events.js";
+export type ReadPreference = "leader" | "leaderPreferred" | "followerPreferred" | "roundRobinFollowers";
+/** Configuration for creating a `LatLngClient`. */
+export interface LatLngClientConfig {
+    /** Base URL of the primary `latlng` server, for example `http://127.0.0.1:7421`. */
+    leaderUrl: string;
+    /** Optional follower URLs that may be used for read routing. */
+    readReplicas?: string[];
+    /** Read routing strategy to use when follower URLs are configured. */
+    readPreference?: ReadPreference;
+    /** Bearer token or JWT to send with HTTP and WebSocket requests. */
+    token?: string;
+    /** Per-request HTTP timeout in milliseconds. */
+    timeoutMs?: number;
+    /** Additional headers to merge into every HTTP request. */
+    headers?: HeadersInit;
+    /** Custom `fetch` implementation for Node, testing, or custom runtimes. */
+    fetch?: typeof globalThis.fetch;
+    /** Custom WebSocket constructor/factory, useful for tests or non-browser runtimes. */
+    webSocketFactory?: (url: string) => WebSocket;
+    /** Cache TTL for follower health/status probes used in replica routing. */
+    replicaStatusTtlMs?: number;
+}
+/** Options for object upserts through `setObject` and `setPoint`. */
+export interface SetObjectOptions {
+    /** Field values to write alongside the object. */
+    fields?: FieldMap | FieldEntry[];
+    /** Optional object TTL in seconds. */
+    expireSeconds?: number;
+    /** Conditional write mode. */
+    condition?: "always" | "nx" | "xx";
+}
+/** Options for `rename`. */
+export interface RenameOptions {
+    /** When `true`, the rename only succeeds if the target collection does not yet exist. */
+    nx?: boolean;
+}
+/** Options for `get`. */
+export interface GetObjectOptions {
+    /** Include the stored field map in the response. */
+    withFields?: boolean;
+    /** Output format requested from the server. */
+    format?: Exclude<OutputFormat, "count" | "ids">;
+}
+/** Options for `deleteMatching`. */
+export interface DeleteMatchingOptions {
+    /** Match pattern used to select object IDs for deletion. */
+    matchPattern?: string;
+}
+/** Options for `setFields`. */
+export interface FsetOptions {
+    /** When `true`, only update existing objects. */
+    xx?: boolean;
+}
+/** Options for `setJson`. */
+export interface JsetOptions {
+    /** When `true`, treat the `value` as raw JSON instead of a string literal. */
+    raw?: boolean;
+}
+/** Area-based query request shared by `within` and `intersects`. */
+export interface SearchAreaRequest {
+    area: import("./models.js").Area;
+    options?: SearchOptions;
+}
+/** Request body for `timeout`. */
+export interface TimeoutRequest {
+    /** Command name to configure, for example `set`. */
+    command: string;
+    /** Timeout in seconds. */
+    seconds: number;
+}
+/** Request body for `setChannel`. */
+export interface SetChannelRequest {
+    /** Unique channel name. */
+    name: string;
+    /** Geofence definition bound to the channel. */
+    def: GeofenceDef;
+}
+/** Request body for `setHook`. */
+export interface SetHookRequest {
+    /** Unique hook name. */
+    name: string;
+    /** Destination endpoint that receives webhook deliveries. */
+    endpoint: string;
+    /** Geofence definition bound to the hook. */
+    def: GeofenceDef;
+}
+/** Options for `connectWebSocket`. */
+export interface WebSocketConnectOptions {
+    /** Override URL for the WebSocket endpoint. Defaults to the leader URL with `/ws`. */
+    url?: string;
+}
+/** Alias for `nearby` request payloads. */
+export type NearbyRequest = NearbyQuery;
+//# sourceMappingURL=requests.d.ts.map

package/dist/types/requests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../src/types/requests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EAER,WAAW,EACX,YAAY,EACZ,aAAa,EACd,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,CAAC;AAE1B,mDAAmD;AACnD,MAAM,WAAW,kBAAkB;IACjC,oFAAoF;IACpF,SAAS,EAAE,MAAM,CAAC;IAClB,gEAAgE;IAChE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,sEAAsE;IACtE,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,oEAAoE;IACpE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2DAA2D;IAC3D,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAChC,sFAAsF;IACtF,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,SAAS,CAAC;IAC9C,2EAA2E;IAC3E,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,qEAAqE;AACrE,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,EAAE,CAAC;IACjC,sCAAsC;IACtC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC;CACpC;AAED,4BAA4B;AAC5B,MAAM,WAAW,aAAa;IAC5B,yFAAyF;IACzF,EAAE,CAAC,EAAE,OAAO,CAAC;CACd;AAED,yBAAyB;AACzB,MAAM,WAAW,gBAAgB;IAC/B,oDAAoD;IACpD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,EAAE,OAAO,GAAG,KAAK,CAAC,CAAC;CACjD;AAED,oCAAoC;AACpC,MAAM,WAAW,qBAAqB;IACpC,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,+BAA+B;AAC/B,MAAM,WAAW,WAAW;IAC1B,iDAAiD;IACjD,EAAE,CAAC,EAAE,OAAO,CAAC;CACd;AAED,6BAA6B;AAC7B,MAAM,WAAW,WAAW;IAC1B,8EAA8E;IAC9E,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,oEAAoE;AACpE,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,aAAa,EAAE,IAAI,CAAC;IACjC,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,kCAAkC;AAClC,MAAM,WAAW,cAAc;IAC7B,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qCAAqC;AACrC,MAAM,WAAW,iBAAiB;IAChC,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,GAAG,EAAE,WAAW,CAAC;CAClB;AAED,kCAAkC;AAClC,MAAM,WAAW,cAAc;IAC7B,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,GAAG,EAAE,WAAW,CAAC;CAClB;AAED,sCAAsC;AACtC,MAAM,WAAW,uBAAuB;IACtC,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,2CAA2C;AAC3C,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC"}

package/dist/types/responses.d.ts

@@ -0,0 +1,108 @@
+import type { HookInfo } from "./events.js";
+import type { BoundingBox, CollectionInfo, CollectionStats, CompactionResult, LatLngObject, SearchResults, ServerInfo } from "./models.js";
+/** Response returned by `ping`. */
+export interface PingResponse {
+    ok: true;
+    pong: true;
+}
+/** Generic `{ ok: true }` response shape. */
+export interface OkResponse {
+    ok: true;
+}
+/** Response returned by `collections`. */
+export interface CollectionsResponse {
+    collections: string[];
+}
+/** Response returned by `rename`. */
+export interface RenameResponse {
+    ok: true;
+    renamed: boolean;
+}
+/** Response returned by `createCollection`. */
+export interface CreateCollectionResponse {
+    ok: true;
+    created: boolean;
+}
+/** Response returned by `bounds`. */
+export interface BoundsResponse {
+    bounds: BoundingBox;
+}
+/** Response returned by `stats`. */
+export type StatsResponse = CollectionStats[];
+/** Response returned by object upsert operations. */
+export interface SetObjectResponse {
+    ok: true;
+    stored: boolean;
+}
+/** Response returned by `get`. */
+export type GetObjectResponse = LatLngObject | null;
+/** Generic delete response shape used by multiple endpoints. */
+export interface DeleteResponse {
+    ok?: true;
+    deleted: boolean | number;
+}
+/** Response returned by field mutation endpoints. */
+export interface UpdatedResponse {
+    ok: true;
+    updated: boolean;
+}
+/** Response returned by field reads. */
+export interface FieldResponse {
+    value: import("./models.js").FieldValue | null;
+}
+/** Response returned by `ttl`. */
+export interface TtlResponse {
+    ttl: number | null;
+}
+/** Response returned by JSON path reads. */
+export interface JsonValueResponse {
+    value: unknown;
+}
+/** Response returned by search endpoints. */
+export type SearchResponse = SearchResults;
+/** Response returned by `channels`. */
+export type ChannelsResponse = string[];
+/** Response returned by `hooks`. */
+export interface HooksResponse extends Array<HookInfo> {
+}
+/** Response returned by `configGet`. */
+export interface ConfigValueResponse {
+    value: string;
+}
+/** Response returned by `webhookQueue`. */
+export interface WebhookQueueStatsResponse {
+    pending: number;
+    leased: number;
+    dead_letter: number;
+    oldest_pending_age_ms: number | null;
+}
+/** Response returned by `readonly`. */
+export interface ReadOnlyResponse {
+    ok: true;
+    read_only: boolean;
+}
+/** Response returned by `timeout`. */
+export interface TimeoutResponse {
+    ok: true;
+    command: string;
+    seconds: number | null;
+}
+/** Response returned by `dropCollection`. */
+export interface DropCollectionResponse {
+    dropped: boolean;
+}
+/** Response returned by `getCollection`. */
+export type CollectionInfoResponse = CollectionInfo;
+/** Response returned by `server`. */
+export type ServerResponse = ServerInfo;
+/** Response returned by `info`. */
+export interface InfoResponse {
+    server: ServerInfo;
+    metrics?: Record<string, unknown>;
+    section?: string;
+}
+/** Response returned by `metrics`. */
+export type MetricsResponse = string;
+/** Response returned by `aofshrink`. */
+export type AofshrinkResponse = CompactionResult;
+//# sourceMappingURL=responses.d.ts.map

package/dist/types/responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../src/types/responses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EACV,WAAW,EACX,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,UAAU,EACX,MAAM,aAAa,CAAC;AAErB,mCAAmC;AACnC,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,6CAA6C;AAC7C,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,IAAI,CAAC;CACV;AAED,0CAA0C;AAC1C,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,qCAAqC;AACrC,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,IAAI,CAAC;IACT,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,+CAA+C;AAC/C,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,IAAI,CAAC;IACT,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,qCAAqC;AACrC,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,oCAAoC;AACpC,MAAM,MAAM,aAAa,GAAG,eAAe,EAAE,CAAC;AAE9C,qDAAqD;AACrD,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,IAAI,CAAC;IACT,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,kCAAkC;AAClC,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,IAAI,CAAC;AAEpD,gEAAgE;AAChE,MAAM,WAAW,cAAc;IAC7B,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC;CAC3B;AAED,qDAAqD;AACrD,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,IAAI,CAAC;IACT,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,wCAAwC;AACxC,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,OAAO,aAAa,EAAE,UAAU,GAAG,IAAI,CAAC;CAChD;AAED,kCAAkC;AAClC,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED,4CAA4C;AAC5C,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,6CAA6C;AAC7C,MAAM,MAAM,cAAc,GAAG,aAAa,CAAC;AAE3C,uCAAuC;AACvC,MAAM,MAAM,gBAAgB,GAAG,MAAM,EAAE,CAAC;AAExC,oCAAoC;AACpC,MAAM,WAAW,aAAc,SAAQ,KAAK,CAAC,QAAQ,CAAC;CAAG;AAEzD,wCAAwC;AACxC,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,2CAA2C;AAC3C,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,uCAAuC;AACvC,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,IAAI,CAAC;IACT,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,sCAAsC;AACtC,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,IAAI,CAAC;IACT,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,6CAA6C;AAC7C,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,4CAA4C;AAC5C,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC;AAEpD,qCAAqC;AACrC,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC;AAExC,mCAAmC;AACnC,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,sCAAsC;AACtC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AACrC,wCAAwC;AACxC,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,CAAC"}