@ebitex/data-sdk 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,22 @@
-# Temporary Holding Version
+# @ebitex/data-sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The client for the ebitex Data Delivery API. Filters, sorts, facets, keyset paging and reference expansion, typed, in a browser or on a server. No runtime dependencies.
+
+```ts
+import { createDataClient } from '@ebitex/data-sdk'
+
+const data = createDataClient({ apiKey: 'ebx_your_key' })
+
+const page = await data.records({ model: 'dog', filters: { colour: 'black' }, sort: '-born', limit: 25 })
+for await (const dog of data.eachRecord({ model: 'dog' })) console.log(dog.name)
+```
+
+- **Keys.** A key with no origin or address restriction is a server key and reads everything in its partition; never ship one to a browser. A key restricted to your site's origins is browser-safe and reads only the models and fields marked public.
+- **Read `models()` first.** It lists what your key may ask for: each field's type and whether it can be filtered, sorted or counted.
+- **A cursor belongs to its query.** `eachRecord` and `eachPage` capture the query once and send it unchanged with every cursor.
+- **Nothing is cached or retried.** Pass your own `fetch` to add either.
+- **Errors.** `DataApiError` carries the status, the server's `code`, and the `X-Request-Id` to quote. `DataNetworkError` is a failure to connect. A request the client refuses to send (a limit of 500, more than 5 facets) is a `DataApiError` with `local: true`.
+
+Documentation: https://developers.ebitex.io/reference/data-sdk/
+
+Licensed under Apache-2.0.

package/dist/client.d.ts

@@ -0,0 +1,33 @@
+import type { BatchResult, DataRecord, ExpansionOptions, ModelsResult, RecordOptions, RecordResponse, RecordsPage, RecordsQuery } from './types.js';
+export declare const DEFAULT_BASE_URL = "https://api.ebitex.io";
+export interface DataClientOptions {
+    /** A delivery key. A server key reads everything in its partition and must never reach a browser; a browser-safe key is restricted to origins or addresses. */
+    apiKey: string;
+    /** Defaults to `https://api.ebitex.io`. */
+    baseUrl?: string;
+    /** Defaults to the global `fetch`. Wrap it to add retries, a cache or tracing: the client adds none of its own. */
+    fetch?: typeof fetch;
+}
+export interface CallOptions {
+    signal?: AbortSignal;
+}
+export interface DataClient {
+    /** The models this key may read, each with the fields it may see and what it may query. Read this before querying. */
+    models(options?: CallOptions): Promise<ModelsResult>;
+    /** One page of records. */
+    records<V = Record<string, unknown>>(query?: RecordsQuery, options?: CallOptions): Promise<RecordsPage<V>>;
+    /** Every page of a query as an async iterator. The query is captured once and replayed unchanged for each page. */
+    eachPage<V = Record<string, unknown>>(query?: Omit<RecordsQuery, 'cursor'>, options?: CallOptions): AsyncGenerator<RecordsPage<V>, void, undefined>;
+    /** Every record a query matches, one at a time. */
+    eachRecord<V = Record<string, unknown>>(query?: Omit<RecordsQuery, 'cursor'>, options?: CallOptions): AsyncGenerator<DataRecord<V>, void, undefined>;
+    /** Up to 50 records by key in one round trip, in the order asked; the keys that could not be read are in `missing`. */
+    recordsByKeys<V = Record<string, unknown>>(keys: readonly string[], expansion?: ExpansionOptions, options?: CallOptions): Promise<BatchResult<V>>;
+    /** One record, or `null` when there is none (or the key may not read it). `throwIfMissing` makes that an error. */
+    record<V = Record<string, unknown>>(key: string, options?: RecordOptions & CallOptions): Promise<DataRecord<V> | null>;
+    /** The primitive under `record`: keeps the `ETag`, and sends `If-None-Match` when given, so an unchanged record is `notModified`. */
+    recordResponse<V = Record<string, unknown>>(key: string, options?: RecordOptions & CallOptions & {
+        ifNoneMatch?: string;
+    }): Promise<RecordResponse<V>>;
+}
+export declare function createDataClient(options: DataClientOptions): DataClient;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,WAAW,EACX,YAAY,EACb,MAAM,YAAY,CAAA;AAEnB,eAAO,MAAM,gBAAgB,0BAA0B,CAAA;AAIvD,MAAM,WAAW,iBAAiB;IAChC,+JAA+J;IAC/J,MAAM,EAAE,MAAM,CAAA;IACd,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,mHAAmH;IACnH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,sHAAsH;IACtH,MAAM,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IACpD,2BAA2B;IAC3B,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;IAC1G,mHAAmH;IACnH,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IACnJ,mDAAmD;IACnD,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IACpJ,uHAAuH;IACvH,aAAa,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,SAAS,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;IACjJ,mHAAmH;IACnH,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IACtH,qIAAqI;IACrI,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxC,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,aAAa,GAAG,WAAW,GAAG;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/D,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAA;CAC9B;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,GAAG,UAAU,CAsEvE"}

package/dist/client.js

@@ -0,0 +1,98 @@
+import { DataApiError, DataNetworkError } from './errors.js';
+import { buildBatchQuery, buildRecordQuery, buildRecordsQuery } from './query.js';
+export const DEFAULT_BASE_URL = 'https://api.ebitex.io';
+const ROOT = '/data/delivery/v1';
+export function createDataClient(options) {
+    if (!options.apiKey)
+        throw new TypeError('createDataClient needs an apiKey.');
+    const base = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, '');
+    const doFetch = options.fetch ?? ((input, init) => globalThis.fetch(input, init));
+    async function send(path, query, init = {}) {
+        const headers = { Authorization: `Bearer ${options.apiKey}`, Accept: 'application/json' };
+        if (init.ifNoneMatch)
+            headers['If-None-Match'] = init.ifNoneMatch;
+        const url = `${base}${ROOT}${path}${query ? `?${query}` : ''}`;
+        try {
+            return await doFetch(url, { method: 'GET', headers, signal: init.signal });
+        }
+        catch (cause) {
+            if (cause instanceof DOMException && cause.name === 'AbortError')
+                throw cause;
+            // The message carries no URL: it can hold a search term, and logs are not a place for a visitor's query.
+            throw new DataNetworkError('The Data Delivery API could not be reached.', { cause });
+        }
+    }
+    async function json(response) {
+        if (response.ok)
+            return (await response.json());
+        throw await toError(response);
+    }
+    async function* eachPage(query = {}, call = {}) {
+        if (query.cursor) {
+            throw new DataApiError(400, 'invalid_cursor', 'eachPage and eachRecord start from the beginning; to resume, call records() with a cursor.', null, null, true);
+        }
+        const frozen = { ...query };
+        let cursor;
+        for (;;) {
+            const page = await json(await send('/records', buildRecordsQuery({ ...frozen, cursor }), call));
+            yield page;
+            if (!page.nextCursor)
+                return;
+            cursor = page.nextCursor;
+        }
+    }
+    async function recordResponse(key, opts = {}) {
+        if (!key)
+            throw new DataApiError(400, 'invalid_keys', 'A record key is required.', null, null, true);
+        const response = await send(`/records/${encodeURIComponent(key)}`, buildRecordQuery(opts), opts);
+        const etag = response.headers.get('ETag');
+        if (response.status === 304)
+            return { status: 'notModified', etag };
+        if (response.status === 404) {
+            const error = await toError(response);
+            if (error.code === 'record_not_found') {
+                if (opts.throwIfMissing)
+                    throw error;
+                return { status: 'missing' };
+            }
+            throw error;
+        }
+        return { status: 'ok', record: await json(response), etag };
+    }
+    return {
+        models: async (call) => json(await send('/models', '', call)),
+        records: async (query, call) => json(await send('/records', buildRecordsQuery(query), call)),
+        eachPage,
+        async *eachRecord(query = {}, call = {}) {
+            for await (const page of eachPage(query, call))
+                yield* page.items;
+        },
+        recordsByKeys: async (keys, expansion, call) => json(await send('/records', buildBatchQuery(keys, expansion), call)),
+        async record(key, opts = {}) {
+            const result = await recordResponse(key, opts);
+            return result.status === 'ok' ? result.record : null;
+        },
+        recordResponse,
+    };
+}
+async function toError(response) {
+    const requestId = response.headers.get('X-Request-Id');
+    const retryAfter = Number(response.headers.get('Retry-After'));
+    let code = response.status === 401 ? 'unauthorized' : 'error';
+    let message = `The Data Delivery API answered ${response.status}.`;
+    let bodyRequestId = null;
+    try {
+        const body = (await response.json());
+        if (typeof body.error === 'string')
+            code = body.error;
+        if (typeof body.message === 'string' && body.message)
+            message = body.message;
+        if (typeof body.requestId === 'string')
+            bodyRequestId = body.requestId;
+    }
+    catch {
+        // An error with no JSON body (an edge page, an empty 401) still has a status and a request id.
+    }
+    return new DataApiError(response.status, code, message, requestId ?? bodyRequestId, Number.isFinite(retryAfter) && response.headers.has('Retry-After') ? retryAfter : null);
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAC5D,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAYjF,MAAM,CAAC,MAAM,gBAAgB,GAAG,uBAAuB,CAAA;AAEvD,MAAM,IAAI,GAAG,mBAAmB,CAAA;AAmChC,MAAM,UAAU,gBAAgB,CAAC,OAA0B;IACzD,IAAI,CAAC,OAAO,CAAC,MAAM;QAAE,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAA;IAC7E,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,gBAAgB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IACtE,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IAEjF,KAAK,UAAU,IAAI,CAAC,IAAY,EAAE,KAAa,EAAE,OAAuD,EAAE;QACxG,MAAM,OAAO,GAA2B,EAAE,aAAa,EAAE,UAAU,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAA;QACjH,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,WAAW,CAAA;QACjE,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QAC9D,IAAI,CAAC;YACH,OAAO,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;QAC5E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY;gBAAE,MAAM,KAAK,CAAA;YAC7E,yGAAyG;YACzG,MAAM,IAAI,gBAAgB,CAAC,6CAA6C,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;QACtF,CAAC;IACH,CAAC;IAED,KAAK,UAAU,IAAI,CAAI,QAAkB;QACvC,IAAI,QAAQ,CAAC,EAAE;YAAE,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAA;QACpD,MAAM,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC/B,CAAC;IAED,KAAK,SAAS,CAAC,CAAC,QAAQ,CAAI,QAAsC,EAAE,EAAE,OAAoB,EAAE;QAC1F,IAAK,KAAsB,CAAC,MAAM,EAAE,CAAC;YACnC,MAAM,IAAI,YAAY,CAAC,GAAG,EAAE,gBAAgB,EAAE,4FAA4F,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAC/J,CAAC;QACD,MAAM,MAAM,GAAG,EAAE,GAAG,KAAK,EAAE,CAAA;QAC3B,IAAI,MAA0B,CAAA;QAC9B,SAAS,CAAC;YACR,MAAM,IAAI,GAAG,MAAM,IAAI,CAAiB,MAAM,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;YAC/G,MAAM,IAAI,CAAA;YACV,IAAI,CAAC,IAAI,CAAC,UAAU;gBAAE,OAAM;YAC5B,MAAM,GAAG,IAAI,CAAC,UAAU,CAAA;QAC1B,CAAC;IACH,CAAC;IAED,KAAK,UAAU,cAAc,CAC3B,GAAW,EACX,OAA+D,EAAE;QAEjE,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,YAAY,CAAC,GAAG,EAAE,cAAc,EAAE,2BAA2B,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QACpG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,kBAAkB,CAAC,GAAG,CAAC,EAAE,EAAE,gBAAgB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAA;QAChG,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QACzC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,CAAA;QACnE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAA;YACrC,IAAI,KAAK,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;gBACtC,IAAI,IAAI,CAAC,cAAc;oBAAE,MAAM,KAAK,CAAA;gBACpC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAA;YAC9B,CAAC;YACD,MAAM,KAAK,CAAA;QACb,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,IAAI,CAAgB,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAA;IAC5E,CAAC;IAED,OAAO;QACL,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAe,MAAM,IAAI,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAC3E,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5F,QAAQ;QACR,KAAK,CAAC,CAAC,UAAU,CAAI,QAAsC,EAAE,EAAE,OAAoB,EAAE;YACnF,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,QAAQ,CAAI,KAAK,EAAE,IAAI,CAAC;gBAAE,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAA;QACtE,CAAC;QACD,aAAa,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;QACpH,KAAK,CAAC,MAAM,CAAI,GAAW,EAAE,OAAoC,EAAE;YACjE,MAAM,MAAM,GAAG,MAAM,cAAc,CAAI,GAAG,EAAE,IAAI,CAAC,CAAA;YACjD,OAAO,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;QACtD,CAAC;QACD,cAAc;KACf,CAAA;AACH,CAAC;AAED,KAAK,UAAU,OAAO,CAAC,QAAkB;IACvC,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;IACtD,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAA;IAC9D,IAAI,IAAI,GAAG,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAA;IAC7D,IAAI,OAAO,GAAG,kCAAkC,QAAQ,CAAC,MAAM,GAAG,CAAA;IAClE,IAAI,aAAa,GAAkB,IAAI,CAAA;IACvC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAgE,CAAA;QACnG,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;YAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAA;QACrD,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC5E,IAAI,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ;YAAE,aAAa,GAAG,IAAI,CAAC,SAAS,CAAA;IACxE,CAAC;IAAC,MAAM,CAAC;QACP,+FAA+F;IACjG,CAAC;IACD,OAAO,IAAI,YAAY,CACrB,QAAQ,CAAC,MAAM,EACf,IAAI,EACJ,OAAO,EACP,SAAS,IAAI,aAAa,EAC1B,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CACvF,CAAA;AACH,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,23 @@
+/** The server answered with a non-success status, or the request was refused before it was sent. */
+export declare class DataApiError extends Error {
+    readonly name = "DataApiError";
+    /** The HTTP status; 400 for a request this client refused to send. */
+    readonly status: number;
+    /** The server's error code (`field_not_queryable`, `invalid_cursor`, …), or `unauthorized` / `error` when the body carried none. */
+    readonly code: string;
+    /** The `X-Request-Id` to quote to support, or null when the request never reached the server. */
+    readonly requestId: string | null;
+    /** From `Retry-After` on a `429`. */
+    readonly retryAfterSeconds: number | null;
+    /** True when this client refused the request itself, before any network call. */
+    readonly local: boolean;
+    constructor(status: number, code: string, message: string, requestId?: string | null, retryAfterSeconds?: number | null, local?: boolean);
+}
+/** The request could not complete: no connection, a DNS failure, an aborted request. `cause` is the underlying error. */
+export declare class DataNetworkError extends Error {
+    readonly name = "DataNetworkError";
+    constructor(message: string, options?: {
+        cause?: unknown;
+    });
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,oGAAoG;AACpG,qBAAa,YAAa,SAAQ,KAAK;IACrC,QAAQ,CAAC,IAAI,kBAAiB;IAC9B,sEAAsE;IACtE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,oIAAoI;IACpI,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,iGAAiG;IACjG,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,qCAAqC;IACrC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC,iFAAiF;IACjF,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;gBAGrB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,MAAM,GAAG,IAAW,EAC/B,iBAAiB,GAAE,MAAM,GAAG,IAAW,EACvC,KAAK,UAAQ;CAShB;AAED,yHAAyH;AACzH,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,QAAQ,CAAC,IAAI,sBAAqB;gBAEtB,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE;CAG3D"}

package/dist/errors.js

@@ -0,0 +1,30 @@
+/** The server answered with a non-success status, or the request was refused before it was sent. */
+export class DataApiError extends Error {
+    name = 'DataApiError';
+    /** The HTTP status; 400 for a request this client refused to send. */
+    status;
+    /** The server's error code (`field_not_queryable`, `invalid_cursor`, …), or `unauthorized` / `error` when the body carried none. */
+    code;
+    /** The `X-Request-Id` to quote to support, or null when the request never reached the server. */
+    requestId;
+    /** From `Retry-After` on a `429`. */
+    retryAfterSeconds;
+    /** True when this client refused the request itself, before any network call. */
+    local;
+    constructor(status, code, message, requestId = null, retryAfterSeconds = null, local = false) {
+        super(message);
+        this.status = status;
+        this.code = code;
+        this.requestId = requestId;
+        this.retryAfterSeconds = retryAfterSeconds;
+        this.local = local;
+    }
+}
+/** The request could not complete: no connection, a DNS failure, an aborted request. `cause` is the underlying error. */
+export class DataNetworkError extends Error {
+    name = 'DataNetworkError';
+    constructor(message, options) {
+        super(message, options);
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,oGAAoG;AACpG,MAAM,OAAO,YAAa,SAAQ,KAAK;IAC5B,IAAI,GAAG,cAAc,CAAA;IAC9B,sEAAsE;IAC7D,MAAM,CAAQ;IACvB,oIAAoI;IAC3H,IAAI,CAAQ;IACrB,iGAAiG;IACxF,SAAS,CAAe;IACjC,qCAAqC;IAC5B,iBAAiB,CAAe;IACzC,iFAAiF;IACxE,KAAK,CAAS;IAEvB,YACE,MAAc,EACd,IAAY,EACZ,OAAe,EACf,YAA2B,IAAI,EAC/B,oBAAmC,IAAI,EACvC,KAAK,GAAG,KAAK;QAEb,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;QAC1C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;CACF;AAED,yHAAyH;AACzH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAChC,IAAI,GAAG,kBAAkB,CAAA;IAElC,YAAY,OAAe,EAAE,OAA6B;QACxD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IACzB,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { createDataClient, DEFAULT_BASE_URL } from './client.js';
+export type { CallOptions, DataClient, DataClientOptions } from './client.js';
+export { DataApiError, DataNetworkError } from './errors.js';
+export { expanded, isInline, isReference, readPointer } from './pointers.js';
+export type { Pointer, PointerKind } from './pointers.js';
+export { buildBatchQuery, buildRecordQuery, buildRecordsQuery, Limits } from './query.js';
+export type { BatchResult, DataRecord, ExpansionOptions, Facets, FacetBucket, FieldDescriptor, FieldFilter, FilterOperator, InlineValue, ModelDescriptor, ModelsResult, RecordOptions, RecordResponse, RecordsPage, RecordsQuery, ReferenceValue, Scalar, } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAChE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC7E,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC5E,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACzF,YAAY,EACV,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,MAAM,EACN,WAAW,EACX,eAAe,EACf,WAAW,EACX,cAAc,EACd,WAAW,EACX,eAAe,EACf,YAAY,EACZ,aAAa,EACb,cAAc,EACd,WAAW,EACX,YAAY,EACZ,cAAc,EACd,MAAM,GACP,MAAM,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,5 @@
+export { createDataClient, DEFAULT_BASE_URL } from './client.js';
+export { DataApiError, DataNetworkError } from './errors.js';
+export { expanded, isInline, isReference, readPointer } from './pointers.js';
+export { buildBatchQuery, buildRecordQuery, buildRecordsQuery, Limits } from './query.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAEhE,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE5E,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA"}

package/dist/pointers.d.ts

@@ -0,0 +1,26 @@
+import type { DataRecord, InlineValue, ReferenceValue } from './types.js';
+export type PointerKind = 'empty' | 'reference' | 'inline' | 'unrecognised';
+export interface Pointer {
+    kind: PointerKind;
+    /** Exactly what was written, or null when the value names none. */
+    provider: string | null;
+    key: string | null;
+    mode: string | null;
+}
+/**
+ * The one answer to "is this value a pointer, and to what?" in this package. It classifies by the value's own shape and nothing else, and
+ * reads both spellings the API can deliver: the `component` envelope (`mode` of `reference` or `inline`) and a plain `{ provider, key }`
+ * with no `mode`. It is pinned by the same `pointer-cases.json` the platform's C# and TypeScript readers are, so a value that merely looks
+ * like a pointer cannot be read as one here and not there.
+ */
+export declare function readPointer(value: unknown): Pointer;
+/** True for a pointer to another record. */
+export declare function isReference<V = Record<string, unknown>>(value: unknown): value is ReferenceValue<V>;
+/** True for a value described inline by a model. */
+export declare function isInline(value: unknown): value is InlineValue;
+/**
+ * The record a reference was expanded to (`generations` or `expand` on the request), or `undefined` when the value is not a reference or is
+ * a bare pointer: not followed, a cycle, missing, or not readable by the key. Never an error, because each of those is an ordinary answer.
+ */
+export declare function expanded<V = Record<string, unknown>>(value: unknown): DataRecord<V> | undefined;
+//# sourceMappingURL=pointers.d.ts.map

package/dist/pointers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pointers.d.ts","sourceRoot":"","sources":["../src/pointers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEzE,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,cAAc,CAAA;AAE3E,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,WAAW,CAAA;IACjB,mEAAmE;IACnE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AAID;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAiBnD;AAED,4CAA4C;AAC5C,wBAAgB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAAC,CAAC,CAAC,CAEnG;AAED,oDAAoD;AACpD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAE7D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAM/F"}

package/dist/pointers.js

@@ -0,0 +1,45 @@
+const text = (value) => (typeof value === 'string' ? value : null);
+/**
+ * The one answer to "is this value a pointer, and to what?" in this package. It classifies by the value's own shape and nothing else, and
+ * reads both spellings the API can deliver: the `component` envelope (`mode` of `reference` or `inline`) and a plain `{ provider, key }`
+ * with no `mode`. It is pinned by the same `pointer-cases.json` the platform's C# and TypeScript readers are, so a value that merely looks
+ * like a pointer cannot be read as one here and not there.
+ */
+export function readPointer(value) {
+    if (value === null || value === undefined)
+        return { kind: 'empty', provider: null, key: null, mode: null };
+    if (typeof value !== 'object' || Array.isArray(value))
+        return { kind: 'unrecognised', provider: null, key: null, mode: null };
+    const v = value;
+    const mode = text(v.mode);
+    if (mode === 'inline') {
+        const hasDocument = typeof v.document === 'object' && v.document !== null && !Array.isArray(v.document);
+        return { kind: hasDocument ? 'inline' : 'unrecognised', provider: null, key: null, mode };
+    }
+    const key = text(v.key);
+    if ((mode === null || mode === 'reference') && key !== null && key.length > 0) {
+        return { kind: 'reference', provider: text(v.provider), key, mode };
+    }
+    return { kind: 'unrecognised', provider: null, key: null, mode };
+}
+/** True for a pointer to another record. */
+export function isReference(value) {
+    return readPointer(value).kind === 'reference';
+}
+/** True for a value described inline by a model. */
+export function isInline(value) {
+    return readPointer(value).kind === 'inline';
+}
+/**
+ * The record a reference was expanded to (`generations` or `expand` on the request), or `undefined` when the value is not a reference or is
+ * a bare pointer: not followed, a cycle, missing, or not readable by the key. Never an error, because each of those is an ordinary answer.
+ */
+export function expanded(value) {
+    if (!isReference(value))
+        return undefined;
+    const record = value.record;
+    return typeof record === 'object' && record !== null && typeof record.key === 'string'
+        ? record
+        : undefined;
+}
+//# sourceMappingURL=pointers.js.map

package/dist/pointers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pointers.js","sourceRoot":"","sources":["../src/pointers.ts"],"names":[],"mappings":"AAYA,MAAM,IAAI,GAAG,CAAC,KAAc,EAAiB,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;AAE1F;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IAC1G,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IAE7H,MAAM,CAAC,GAAG,KAAgC,CAAA;IAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IACzB,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtB,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;QACvG,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IAC3F,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IACvB,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,WAAW,CAAC,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9E,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAA;IACrE,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;AAClE,CAAC;AAED,4CAA4C;AAC5C,MAAM,UAAU,WAAW,CAA8B,KAAc;IACrE,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,WAAW,CAAA;AAChD,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAA;AAC7C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAA8B,KAAc;IAClE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAA;IACzC,MAAM,MAAM,GAAI,KAA8B,CAAC,MAAM,CAAA;IACrD,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,OAAQ,MAA4B,CAAC,GAAG,KAAK,QAAQ;QAC3G,CAAC,CAAE,MAAwB;QAC3B,CAAC,CAAC,SAAS,CAAA;AACf,CAAC"}

package/dist/query.d.ts

@@ -0,0 +1,23 @@
+import type { ExpansionOptions, RecordsQuery } from './types.js';
+/** The limits the API documents. The server stays the authority: these only refuse, early, what it would refuse. */
+export declare const Limits: {
+    readonly maxPageSize: 100;
+    readonly maxBatchKeys: 50;
+    readonly maxGenerations: 5;
+    readonly maxFacetFields: 5;
+    readonly maxFilters: 10;
+    readonly maxInValues: 50;
+    readonly maxSearch: 100;
+};
+/**
+ * `encodeURIComponent` leaves `! ' ( ) *` alone; RFC 3986 percent-encoding, which the .NET client uses, does not. Escaping them here makes the two
+ * produce the same string for the same query, which `query-cases.json` asserts in both suites.
+ */
+export declare function encode(value: string): string;
+/** The query string (no leading `?`) for a list request. The parameter order is fixed: model, search, filters, sort, limit, cursor, facets, generations, expand. */
+export declare function buildRecordsQuery(query?: RecordsQuery): string;
+/** The query string for `keys=a,b,c`: only `generations` and `expand` may accompany it. */
+export declare function buildBatchQuery(keys: readonly string[], options?: ExpansionOptions): string;
+/** The query string for one record. */
+export declare function buildRecordQuery(options?: ExpansionOptions): string;
+//# sourceMappingURL=query.d.ts.map

package/dist/query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAA+B,YAAY,EAAU,MAAM,YAAY,CAAA;AAErG,oHAAoH;AACpH,eAAO,MAAM,MAAM;;;;;;;;CAQT,CAAA;AAOV;;;GAGG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE5C;AAsCD,oKAAoK;AACpK,wBAAgB,iBAAiB,CAAC,KAAK,GAAE,YAAiB,GAAG,MAAM,CAsDlE;AAED,2FAA2F;AAC3F,wBAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,OAAO,GAAE,gBAAqB,GAAG,MAAM,CAK/F;AAED,uCAAuC;AACvC,wBAAgB,gBAAgB,CAAC,OAAO,GAAE,gBAAqB,GAAG,MAAM,CAIvE"}

package/dist/query.js

@@ -0,0 +1,136 @@
+import { DataApiError } from './errors.js';
+/** The limits the API documents. The server stays the authority: these only refuse, early, what it would refuse. */
+export const Limits = {
+    maxPageSize: 100,
+    maxBatchKeys: 50,
+    maxGenerations: 5,
+    maxFacetFields: 5,
+    maxFilters: 10,
+    maxInValues: 50,
+    maxSearch: 100,
+};
+/** The operators in the order they are sent, so equal queries are equal strings whatever order an object listed them in. */
+const OPERATORS = ['eq', 'in', 'prefix', 'gt', 'gte', 'lt', 'lte', 'exists'];
+const local = (code, message) => new DataApiError(400, code, message, null, null, true);
+/**
+ * `encodeURIComponent` leaves `! ' ( ) *` alone; RFC 3986 percent-encoding, which the .NET client uses, does not. Escaping them here makes the two
+ * produce the same string for the same query, which `query-cases.json` asserts in both suites.
+ */
+export function encode(value) {
+    return encodeURIComponent(value).replace(/[!'()*]/g, (c) => '%' + c.charCodeAt(0).toString(16).toUpperCase());
+}
+function scalar(value, what) {
+    if (value instanceof Date) {
+        if (Number.isNaN(value.getTime()))
+            throw local('invalid_filter', `${what} is an invalid date.`);
+        return value.toISOString();
+    }
+    if (typeof value === 'number') {
+        if (!Number.isFinite(value))
+            throw local('invalid_filter', `${what} is not a finite number.`);
+        return String(value);
+    }
+    return String(value);
+}
+function list(values, what) {
+    for (const v of values) {
+        if (v.includes(','))
+            throw local('invalid_filter', `${what} cannot contain a comma.`);
+    }
+    return values.map(encode).join(',');
+}
+function requireInt(value, min, max, code, message) {
+    if (!Number.isInteger(value) || value < min || value > max)
+        throw local(code, message);
+}
+function expansion(parts, options) {
+    if (options.generations !== undefined) {
+        requireInt(options.generations, 0, Limits.maxGenerations, 'invalid_generations', `generations is a whole number from 0 to ${Limits.maxGenerations}.`);
+        parts.push(`generations=${options.generations}`);
+    }
+    if (options.expand && options.expand.length > 0)
+        parts.push(`expand=${list(options.expand, 'expand')}`);
+}
+function normalise(filter) {
+    if (typeof filter === 'object' && !(filter instanceof Date))
+        return filter;
+    return { eq: filter };
+}
+/** The query string (no leading `?`) for a list request. The parameter order is fixed: model, search, filters, sort, limit, cursor, facets, generations, expand. */
+export function buildRecordsQuery(query = {}) {
+    const parts = [];
+    const filters = query.filters ?? {};
+    const fieldIds = Object.keys(filters).sort((a, b) => (a < b ? -1 : a > b ? 1 : 0));
+    const search = query.search?.trim();
+    if (search && search.length > Limits.maxSearch)
+        throw local('invalid_search', `search is at most ${Limits.maxSearch} characters.`);
+    const fieldSort = query.sort !== undefined && query.sort.replace(/^-/, '') !== 'name' && query.sort.replace(/^-/, '') !== 'updated';
+    const facets = query.facets ?? [];
+    if (!query.model && (fieldIds.length > 0 || facets.length > 0 || fieldSort)) {
+        throw local('model_required', 'Filters, facets and a field sort need a model: pass model.');
+    }
+    if (query.model)
+        parts.push(`model=${encode(query.model)}`);
+    if (search)
+        parts.push(`search=${encode(search)}`);
+    let filterCount = 0;
+    for (const id of fieldIds) {
+        const ops = normalise(filters[id]);
+        for (const op of OPERATORS) {
+            const operand = ops[op];
+            if (operand === undefined)
+                continue;
+            if (++filterCount > Limits.maxFilters)
+                throw local('invalid_filter', `At most ${Limits.maxFilters} filters.`);
+            const what = `filter ${id} ${op}`;
+            let value;
+            if (op === 'in') {
+                if (!Array.isArray(operand) || operand.length === 0 || operand.length > Limits.maxInValues) {
+                    throw local('invalid_filter', `in takes 1 to ${Limits.maxInValues} values.`);
+                }
+                value = list(operand.map((v) => scalar(v, what)), what);
+            }
+            else if (op === 'exists') {
+                if (typeof operand !== 'boolean')
+                    throw local('invalid_filter', 'exists is true or false.');
+                value = String(operand);
+            }
+            else {
+                if (Array.isArray(operand) || typeof operand === 'boolean' && op !== 'eq')
+                    throw local('invalid_filter', `${what} takes one value.`);
+                value = encode(scalar(operand, what));
+            }
+            parts.push(op === 'eq' ? `filter[${encode(id)}]=${value}` : `filter[${encode(id)}][${op}]=${value}`);
+        }
+    }
+    if (query.sort)
+        parts.push(`sort=${encode(query.sort)}`);
+    if (query.limit !== undefined) {
+        requireInt(query.limit, 1, Limits.maxPageSize, 'invalid_limit', `limit is a whole number from 1 to ${Limits.maxPageSize}.`);
+        parts.push(`limit=${query.limit}`);
+    }
+    if (query.cursor)
+        parts.push(`cursor=${encode(query.cursor)}`);
+    if (facets.length > 0) {
+        if (facets.length > Limits.maxFacetFields)
+            throw local('invalid_facets', `At most ${Limits.maxFacetFields} facets.`);
+        parts.push(`facets=${list(facets, 'facets')}`);
+    }
+    expansion(parts, query);
+    return parts.join('&');
+}
+/** The query string for `keys=a,b,c`: only `generations` and `expand` may accompany it. */
+export function buildBatchQuery(keys, options = {}) {
+    if (keys.length === 0 || keys.length > Limits.maxBatchKeys)
+        throw local('invalid_keys', `keys takes 1 to ${Limits.maxBatchKeys} record keys.`);
+    const parts = [`keys=${list(keys, 'keys')}`];
+    expansion(parts, options);
+    return parts.join('&');
+}
+/** The query string for one record. */
+export function buildRecordQuery(options = {}) {
+    const parts = [];
+    expansion(parts, options);
+    return parts.join('&');
+}
+//# sourceMappingURL=query.js.map

package/dist/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAG1C,oHAAoH;AACpH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,WAAW,EAAE,GAAG;IAChB,YAAY,EAAE,EAAE;IAChB,cAAc,EAAE,CAAC;IACjB,cAAc,EAAE,CAAC;IACjB,UAAU,EAAE,EAAE;IACd,WAAW,EAAE,EAAE;IACf,SAAS,EAAE,GAAG;CACN,CAAA;AAEV,4HAA4H;AAC5H,MAAM,SAAS,GAA8B,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAA;AAEvG,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,OAAe,EAAgB,EAAE,CAAC,IAAI,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;AAErH;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAC,KAAa;IAClC,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;AAC/G,CAAC;AAED,SAAS,MAAM,CAAC,KAAa,EAAE,IAAY;IACzC,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAAE,MAAM,KAAK,CAAC,gBAAgB,EAAE,GAAG,IAAI,sBAAsB,CAAC,CAAA;QAC/F,OAAO,KAAK,CAAC,WAAW,EAAE,CAAA;IAC5B,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,MAAM,KAAK,CAAC,gBAAgB,EAAE,GAAG,IAAI,0BAA0B,CAAC,CAAA;QAC7F,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;AACtB,CAAC;AAED,SAAS,IAAI,CAAC,MAAyB,EAAE,IAAY;IACnD,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,MAAM,KAAK,CAAC,gBAAgB,EAAE,GAAG,IAAI,0BAA0B,CAAC,CAAA;IACvF,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACrC,CAAC;AAED,SAAS,UAAU,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW,EAAE,IAAY,EAAE,OAAe;IACxF,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,GAAG,IAAI,KAAK,GAAG,GAAG;QAAE,MAAM,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;AACxF,CAAC;AAED,SAAS,SAAS,CAAC,KAAe,EAAE,OAAyB;IAC3D,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACtC,UAAU,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,EAAE,MAAM,CAAC,cAAc,EAAE,qBAAqB,EAAE,2CAA2C,MAAM,CAAC,cAAc,GAAG,CAAC,CAAA;QACrJ,KAAK,CAAC,IAAI,CAAC,eAAe,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAClD,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAA;AACzG,CAAC;AAED,SAAS,SAAS,CAAC,MAAmB;IACpC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,YAAY,IAAI,CAAC;QAAE,OAAO,MAAM,CAAA;IAC1E,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,CAAA;AACvB,CAAC;AAED,oKAAoK;AACpK,MAAM,UAAU,iBAAiB,CAAC,QAAsB,EAAE;IACxD,MAAM,KAAK,GAAa,EAAE,CAAA;IAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,EAAE,CAAA;IACnC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAElF,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,CAAA;IACnC,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS;QAAE,MAAM,KAAK,CAAC,gBAAgB,EAAE,qBAAqB,MAAM,CAAC,SAAS,cAAc,CAAC,CAAA;IAElI,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,SAAS,CAAA;IACnI,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,EAAE,CAAA;IACjC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,CAAC,EAAE,CAAC;QAC5E,MAAM,KAAK,CAAC,gBAAgB,EAAE,4DAA4D,CAAC,CAAA;IAC7F,CAAC;IAED,IAAI,KAAK,CAAC,KAAK;QAAE,KAAK,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IAC3D,IAAI,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,UAAU,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAElD,IAAI,WAAW,GAAG,CAAC,CAAA;IACnB,KAAK,MAAM,EAAE,IAAI,QAAQ,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,EAAE,CAAE,CAAC,CAAA;QACnC,KAAK,MAAM,EAAE,IAAI,SAAS,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAG,GAAG,CAAC,EAAE,CAAC,CAAA;YACvB,IAAI,OAAO,KAAK,SAAS;gBAAE,SAAQ;YACnC,IAAI,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU;gBAAE,MAAM,KAAK,CAAC,gBAAgB,EAAE,WAAW,MAAM,CAAC,UAAU,WAAW,CAAC,CAAA;YAC7G,MAAM,IAAI,GAAG,UAAU,EAAE,IAAI,EAAE,EAAE,CAAA;YACjC,IAAI,KAAa,CAAA;YACjB,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;gBAChB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;oBAC3F,MAAM,KAAK,CAAC,gBAAgB,EAAE,iBAAiB,MAAM,CAAC,WAAW,UAAU,CAAC,CAAA;gBAC9E,CAAC;gBACD,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;YACzD,CAAC;iBAAM,IAAI,EAAE,KAAK,QAAQ,EAAE,CAAC;gBAC3B,IAAI,OAAO,OAAO,KAAK,SAAS;oBAAE,MAAM,KAAK,CAAC,gBAAgB,EAAE,0BAA0B,CAAC,CAAA;gBAC3F,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;YACzB,CAAC;iBAAM,CAAC;gBACN,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI;oBAAE,MAAM,KAAK,CAAC,gBAAgB,EAAE,GAAG,IAAI,mBAAmB,CAAC,CAAA;gBACpI,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,OAAiB,EAAE,IAAI,CAAC,CAAC,CAAA;YACjD,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,MAAM,CAAC,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,EAAE,CAAC,CAAA;QACtG,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,IAAI;QAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACxD,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,eAAe,EAAE,qCAAqC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAA;QAC3H,KAAK,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,KAAK,EAAE,CAAC,CAAA;IACpC,CAAC;IACD,IAAI,KAAK,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,UAAU,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAC9D,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,IAAI,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,cAAc;YAAE,MAAM,KAAK,CAAC,gBAAgB,EAAE,WAAW,MAAM,CAAC,cAAc,UAAU,CAAC,CAAA;QACpH,KAAK,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAA;IAChD,CAAC;IACD,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;IACvB,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACxB,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,eAAe,CAAC,IAAuB,EAAE,UAA4B,EAAE;IACrF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,YAAY;QAAE,MAAM,KAAK,CAAC,cAAc,EAAE,mBAAmB,MAAM,CAAC,YAAY,eAAe,CAAC,CAAA;IAC9I,MAAM,KAAK,GAAG,CAAC,QAAQ,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,CAAA;IAC5C,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACzB,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACxB,CAAC;AAED,uCAAuC;AACvC,MAAM,UAAU,gBAAgB,CAAC,UAA4B,EAAE;IAC7D,MAAM,KAAK,GAAa,EAAE,CAAA;IAC1B,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACzB,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACxB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,131 @@
+/** A reference to another record: `{ mode: 'reference', provider: 'data', key }`, with the target beside it as `record` when expanded. */
+export interface ReferenceValue<V = Record<string, unknown>> {
+    mode?: 'reference';
+    provider?: string;
+    key: string;
+    record?: DataRecord<V>;
+    [extra: string]: unknown;
+}
+/** A value described inline by a model, stored in the record that holds it. */
+export interface InlineValue {
+    mode: 'inline';
+    model?: string;
+    document: Record<string, unknown>;
+    [extra: string]: unknown;
+}
+export interface DataRecord<V = Record<string, unknown>> {
+    key: string;
+    model: string;
+    name: string | null;
+    version: number;
+    updatedAtUtc: string;
+    /** Keyed by field id. A field the record holds no value for is absent, not null. */
+    values: V;
+    /** On a record fetched with `generations`: `truncated` is true when the 200-record expansion budget cut it short. */
+    meta?: {
+        truncated?: boolean;
+    };
+}
+export interface FieldDescriptor {
+    id: string;
+    name: string;
+    type: string;
+    mandatory: boolean;
+    list: boolean;
+    localized: boolean;
+    settings?: Record<string, unknown>;
+    /** Present only for a field the model declared queryable: which of the three it supports. */
+    queryable?: {
+        filter: boolean;
+        sort: boolean;
+        facet: boolean;
+    };
+}
+export interface ModelDescriptor {
+    key: string;
+    name: string;
+    description: string | null;
+    abstract: boolean;
+    /** The id of the field that carries a record's name, or null. */
+    nameField: string | null;
+    /** The key of the model this inherits from, or null when there is none or this key may not read it. */
+    parent: string | null;
+    fields: FieldDescriptor[];
+}
+export interface ModelsResult {
+    partition: {
+        key: string;
+    };
+    models: ModelDescriptor[];
+}
+export interface FacetBucket {
+    value: string | number | boolean;
+    count: number;
+}
+/** Field id to its most common values; the built-in `model` facet counts matches per concrete model. */
+export type Facets = Record<string, FacetBucket[]>;
+export interface RecordsPage<V = Record<string, unknown>> {
+    items: DataRecord<V>[];
+    /** Null on the last page. Send it back as `cursor` with the same query. */
+    nextCursor: string | null;
+    facets?: Facets;
+    meta?: {
+        truncated?: boolean;
+    };
+}
+export interface BatchResult<V = Record<string, unknown>> {
+    items: DataRecord<V>[];
+    /** The keys that could not be read: absent, or not readable by this key. */
+    missing: string[];
+    meta?: {
+        truncated?: boolean;
+    };
+}
+export type FilterOperator = 'eq' | 'in' | 'prefix' | 'gt' | 'gte' | 'lt' | 'lte' | 'exists';
+/** A scalar operand. A `Date` is sent as an RFC 3339 instant. */
+export type Scalar = string | number | boolean | Date;
+/** A bare scalar means `eq`. An object names the operators; `in` takes an array, `exists` a boolean. */
+export type FieldFilter = Scalar | {
+    eq?: Scalar;
+    in?: Scalar[];
+    prefix?: string;
+    gt?: Scalar;
+    gte?: Scalar;
+    lt?: Scalar;
+    lte?: Scalar;
+    exists?: boolean;
+};
+export interface ExpansionOptions {
+    /** 0 to 5 hops of references to follow; default 0. */
+    generations?: number;
+    /** Reference field ids to follow; without it every reference is followed. */
+    expand?: string[];
+}
+export interface RecordsQuery extends ExpansionOptions {
+    /** Lists this model's records and those of every model that inherits from it. Required for filters, field sorts and facets. */
+    model?: string;
+    search?: string;
+    filters?: Record<string, FieldFilter>;
+    /** `name` (default), `updated` or a sortable field id; a leading `-` is descending. */
+    sort?: string;
+    /** 1 to 100; default 25. */
+    limit?: number;
+    cursor?: string;
+    /** At most 5 facetable field ids, and/or `model`. */
+    facets?: string[];
+}
+export interface RecordOptions extends ExpansionOptions {
+    /** Throw `DataApiError` (`record_not_found`) instead of resolving to `null`. */
+    throwIfMissing?: boolean;
+}
+export type RecordResponse<V = Record<string, unknown>> = {
+    status: 'ok';
+    record: DataRecord<V>;
+    etag: string | null;
+} | {
+    status: 'notModified';
+    etag: string | null;
+} | {
+    status: 'missing';
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,0IAA0I;AAC1I,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACzD,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;IACtB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;CACzB;AAED,+EAA+E;AAC/E,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACrD,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,oFAAoF;IACpF,MAAM,EAAE,CAAC,CAAA;IACT,qHAAqH;IACrH,IAAI,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,OAAO,CAAA;IAClB,IAAI,EAAE,OAAO,CAAA;IACb,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,6FAA6F;IAC7F,SAAS,CAAC,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAA;CAC/D;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,OAAO,CAAA;IACjB,iEAAiE;IACjE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,uGAAuG;IACvG,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1B,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;IAChC,KAAK,EAAE,MAAM,CAAA;CACd;AAED,wGAAwG;AACxG,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAA;AAElD,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACtD,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAA;IACtB,2EAA2E;IAC3E,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;CAC/B;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACtD,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAA;IACtB,4EAA4E;IAC5E,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;CAC/B;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,GAAG,IAAI,GAAG,QAAQ,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,QAAQ,CAAA;AAE5F,iEAAiE;AACjE,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;AAErD,wGAAwG;AACxG,MAAM,MAAM,WAAW,GACnB,MAAM,GACN;IACE,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAEL,MAAM,WAAW,gBAAgB;IAC/B,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,6EAA6E;IAC7E,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,+HAA+H;IAC/H,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACrC,uFAAuF;IACvF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,gFAAgF;IAChF,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAClD;IAAE,MAAM,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAC5D;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE,CAAA"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@ebitex/data-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "The client for the ebitex Data Delivery API: typed queries with filters, sorts, facets, keyset paging and reference expansion, for a server or a browser.",
+  "keywords": [
+    "ebitex",
+    "data",
+    "master-data",
+    "reference-data",
+    "delivery-api"
+  ],
+  "license": "Apache-2.0",
+  "homepage": "https://developers.ebitex.io/reference/data-sdk/",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "oxlint",
+    "test": "vitest run"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "oxlint": "^1.71.0",
+    "typescript": "~6.0.2",
+    "vitest": "^4.1.10"
+  }
+}