@3ngram/sdk 0.8.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 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/dist/client.d.ts

@@ -0,0 +1,45 @@
+import type { CommitmentStatus, FactsQueryArgs, FactsToolOutput, RememberToolArgs, RememberToolOutput, ResolveToolOutput, ReviseToolArgs, ReviseToolOutput, SearchQueryArgs, SearchToolOutput } from '@3ngram/schema';
+/** Explicit client configuration. No env/flag fallback — the caller supplies both. */
+export interface ThreengramClientConfig {
+    /** REST origin, e.g. `https://api.example.com` (no trailing `/api/v1`). */
+    baseUrl: string;
+    /** API key sent as the `X-API-Key` header on every request (C3 key chain). */
+    apiKey: string;
+}
+/**
+ * Search options: everything except `query` from the wider, caller-side
+ * {@link SearchQueryArgs} (server-defaulted `limit` stays optional for callers).
+ */
+export type SearchOptions = Omit<SearchQueryArgs, 'query'>;
+/**
+ * Revise body: the successor write WITHOUT `predecessorId`. The predecessor is
+ * the URL arg of {@link ThreengramClient.revise}, and the REST router overwrites
+ * any body `predecessorId` with the path id anyway ("the URL wins"), so requiring
+ * it in the body would be redundant.
+ */
+export type ReviseBody = Omit<ReviseToolArgs, 'predecessorId'>;
+/** The `fetch` surface the client depends on — injectable for tests (no network). */
+export type FetchLike = (input: string, init: RequestInit) => Promise<Response>;
+/**
+ * Typed client over REST `/api/v1`. Five methods mirror the routes 1:1; every
+ * argument and return type is sourced from @3ngram/schema.
+ */
+export declare class ThreengramClient {
+    #private;
+    constructor(config: ThreengramClientConfig, fetchImpl?: FetchLike);
+    /** POST /api/v1/memories — write a memory (commitmentId present only for commitments). */
+    remember(input: RememberToolArgs): Promise<RememberToolOutput>;
+    /** POST /api/v1/search — semantic search over the wider query+filters body. */
+    search(query: string, opts?: SearchOptions): Promise<SearchToolOutput>;
+    /** GET /api/v1/facts — currently-valid facts; filters ride as the querystring. */
+    getFacts(filters?: FactsQueryArgs): Promise<FactsToolOutput>;
+    /**
+     * POST /api/v1/memories/:id/revise — supersede a predecessor with a successor write.
+     * `predecessorId` is the path arg ONLY; it is merged into the body internally
+     * (the REST router does the same — "the URL wins", router.ts), so callers never
+     * duplicate it in {@link ReviseBody}.
+     */
+    revise(predecessorId: string, input: ReviseBody): Promise<ReviseToolOutput>;
+    /** POST /api/v1/memories/:id/resolve — transition the commitment riding a memory. */
+    resolve(memoryId: string, status: CommitmentStatus): Promise<ResolveToolOutput>;
+}

package/dist/client.js

@@ -0,0 +1,97 @@
+import { ThreengramApiError, ThreengramNetworkError } from './errors.js';
+/**
+ * Typed client over REST `/api/v1`. Five methods mirror the routes 1:1; every
+ * argument and return type is sourced from @3ngram/schema.
+ */
+export class ThreengramClient {
+    #baseUrl;
+    #apiKey;
+    #fetch;
+    constructor(config, fetchImpl) {
+        this.#baseUrl = config.baseUrl.replace(/\/+$/, '');
+        this.#apiKey = config.apiKey;
+        this.#fetch = fetchImpl ?? ((input, init) => fetch(input, init));
+    }
+    /** POST /api/v1/memories — write a memory (commitmentId present only for commitments). */
+    remember(input) {
+        return this.#send('POST', '/api/v1/memories', input);
+    }
+    /** POST /api/v1/search — semantic search over the wider query+filters body. */
+    search(query, opts) {
+        const body = { query, ...opts };
+        return this.#send('POST', '/api/v1/search', body);
+    }
+    /** GET /api/v1/facts — currently-valid facts; filters ride as the querystring. */
+    getFacts(filters) {
+        const path = `/api/v1/facts${factsQuery(filters)}`;
+        return this.#send('GET', path);
+    }
+    /**
+     * POST /api/v1/memories/:id/revise — supersede a predecessor with a successor write.
+     * `predecessorId` is the path arg ONLY; it is merged into the body internally
+     * (the REST router does the same — "the URL wins", router.ts), so callers never
+     * duplicate it in {@link ReviseBody}.
+     */
+    revise(predecessorId, input) {
+        const path = `/api/v1/memories/${encodeURIComponent(predecessorId)}/revise`;
+        return this.#send('POST', path, { ...input, predecessorId });
+    }
+    /** POST /api/v1/memories/:id/resolve — transition the commitment riding a memory. */
+    resolve(memoryId, status) {
+        const path = `/api/v1/memories/${encodeURIComponent(memoryId)}/resolve`;
+        return this.#send('POST', path, { status });
+    }
+    /** Issue one request: attach the key header, body, and map both failure shapes. */
+    async #send(method, path, body) {
+        const init = {
+            method,
+            headers: {
+                'X-API-Key': this.#apiKey,
+                ...(body === undefined ? {} : { 'Content-Type': 'application/json' }),
+            },
+            ...(body === undefined ? {} : { body: JSON.stringify(body) }),
+        };
+        const response = await this.#dispatch(`${this.#baseUrl}${path}`, init);
+        if (!response.ok)
+            throw new ThreengramApiError(response.status, await reasonOf(response));
+        return (await response.json());
+    }
+    /** Run the injected fetch; a transport rejection becomes a ThreengramNetworkError. */
+    async #dispatch(url, init) {
+        try {
+            return await this.#fetch(url, init);
+        }
+        catch (cause) {
+            throw new ThreengramNetworkError('3ngram REST transport failed', cause);
+        }
+    }
+}
+/** Read the `{ error: <reason> }` code from a non-2xx body; 'unknown' if unparseable. */
+async function reasonOf(response) {
+    try {
+        const body = (await response.json());
+        return typeof body.error === 'string' ? body.error : 'unknown';
+    }
+    catch {
+        return 'unknown';
+    }
+}
+/** Build the `/api/v1/facts` querystring — subject/predicate/limit + FLAT asOf coords. */
+function factsQuery(filters) {
+    if (filters === undefined)
+        return '';
+    const params = new URLSearchParams();
+    if (filters.subject !== undefined)
+        params.set('subject', filters.subject);
+    if (filters.predicate !== undefined)
+        params.set('predicate', filters.predicate);
+    if (filters.limit !== undefined)
+        params.set('limit', String(filters.limit));
+    if (filters.asOf?.validAt !== undefined)
+        params.set('validAt', filters.asOf.validAt);
+    if (filters.asOf?.asKnownAt !== undefined)
+        params.set('asKnownAt', filters.asOf.asKnownAt);
+    const query = params.toString();
+    return query === '' ? '' : `?${query}`;
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AA2BA,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AA2BxE;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAClB,QAAQ,CAAQ;IAChB,OAAO,CAAQ;IACf,MAAM,CAAW;IAE1B,YAAY,MAA8B,EAAE,SAAqB;QAC/D,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;QAClD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,IAAI,CAAC,MAAM,GAAG,SAAS,IAAI,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IAClE,CAAC;IAED,0FAA0F;IAC1F,QAAQ,CAAC,KAAuB;QAC9B,OAAO,IAAI,CAAC,KAAK,CAAqB,MAAM,EAAE,kBAAkB,EAAE,KAAK,CAAC,CAAA;IAC1E,CAAC;IAED,+EAA+E;IAC/E,MAAM,CAAC,KAAa,EAAE,IAAoB;QACxC,MAAM,IAAI,GAAoB,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,CAAA;QAChD,OAAO,IAAI,CAAC,KAAK,CAAmB,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAA;IACrE,CAAC;IAED,kFAAkF;IAClF,QAAQ,CAAC,OAAwB;QAC/B,MAAM,IAAI,GAAG,gBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE,CAAA;QAClD,OAAO,IAAI,CAAC,KAAK,CAAkB,KAAK,EAAE,IAAI,CAAC,CAAA;IACjD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,aAAqB,EAAE,KAAiB;QAC7C,MAAM,IAAI,GAAG,oBAAoB,kBAAkB,CAAC,aAAa,CAAC,SAAS,CAAA;QAC3E,OAAO,IAAI,CAAC,KAAK,CAAmB,MAAM,EAAE,IAAI,EAAE,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,CAAC,CAAA;IAChF,CAAC;IAED,qFAAqF;IACrF,OAAO,CAAC,QAAgB,EAAE,MAAwB;QAChD,MAAM,IAAI,GAAG,oBAAoB,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAA;QACvE,OAAO,IAAI,CAAC,KAAK,CAAoB,MAAM,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;IAChE,CAAC;IAED,mFAAmF;IACnF,KAAK,CAAC,KAAK,CAAI,MAAc,EAAE,IAAY,EAAE,IAAc;QACzD,MAAM,IAAI,GAAgB;YACxB,MAAM;YACN,OAAO,EAAE;gBACP,WAAW,EAAE,IAAI,CAAC,OAAO;gBACzB,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;aACtE;YACD,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;SAC9D,CAAA;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,IAAI,kBAAkB,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;QACzF,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAA;IACrC,CAAC;IAED,sFAAsF;IACtF,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,IAAiB;QAC5C,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,sBAAsB,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAA;QACzE,CAAC;IACH,CAAC;CACF;AAED,yFAAyF;AACzF,KAAK,UAAU,QAAQ,CAAC,QAAkB;IACxC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAwB,CAAA;QAC3D,OAAO,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;IAChE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC;AAED,0FAA0F;AAC1F,SAAS,UAAU,CAAC,OAAmC;IACrD,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,EAAE,CAAA;IACpC,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;IACpC,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;QAAE,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IACzE,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS;QAAE,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;IAC/E,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;QAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;IAC3E,IAAI,OAAO,CAAC,IAAI,EAAE,OAAO,KAAK,SAAS;QAAE,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACpF,IAAI,OAAO,CAAC,IAAI,EAAE,SAAS,KAAK,SAAS;QAAE,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC1F,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;IAC/B,OAAO,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAA;AACxC,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,14 @@
+/** A non-2xx REST response: carries the HTTP status and the `{ error }` reason code. */
+export declare class ThreengramApiError extends Error {
+    /** The HTTP status code of the failing response (e.g. 404, 409, 503). */
+    readonly status: number;
+    /** The REST `{ error: <reason> }` body code (e.g. 'not_found'); 'unknown' when absent. */
+    readonly reason: string;
+    constructor(status: number, reason: string);
+}
+/** A transport-level failure: `fetch` rejected before any HTTP response arrived. */
+export declare class ThreengramNetworkError extends Error {
+    /** The underlying transport rejection (the original fetch error), if any. */
+    readonly cause: unknown;
+    constructor(message: string, cause: unknown);
+}

package/dist/errors.js

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: Apache-2.0
+// Typed SDK errors. The REST surface (apps/server/src/rest/router.ts) returns a
+// `{ error: <reason> }` body on every non-2xx response (status 400/401/403/404/
+// 409/503) and a generic `internal_error` on 500. The client maps those two
+// failure shapes to DISTINCT classes so callers can branch without parsing:
+//   - ThreengramApiError      — the server replied with a non-2xx status; carries
+//     the HTTP `.status` and the `{ error }` `.reason` code (e.g. 'not_found',
+//     'invalid_transition', 'embedding_unavailable', 'invalid_input').
+//   - ThreengramNetworkError  — fetch itself rejected (DNS, connection refused,
+//     timeout, aborted): no HTTP exchange completed, so there is no status/reason.
+/** A non-2xx REST response: carries the HTTP status and the `{ error }` reason code. */
+export class ThreengramApiError extends Error {
+    /** The HTTP status code of the failing response (e.g. 404, 409, 503). */
+    status;
+    /** The REST `{ error: <reason> }` body code (e.g. 'not_found'); 'unknown' when absent. */
+    reason;
+    constructor(status, reason) {
+        super(`3ngram REST request failed: ${status} ${reason}`);
+        this.name = 'ThreengramApiError';
+        this.status = status;
+        this.reason = reason;
+    }
+}
+/** A transport-level failure: `fetch` rejected before any HTTP response arrived. */
+export class ThreengramNetworkError extends Error {
+    /** The underlying transport rejection (the original fetch error), if any. */
+    cause;
+    constructor(message, cause) {
+        super(message);
+        this.name = 'ThreengramNetworkError';
+        this.cause = cause;
+    }
+}
+//# 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,sCAAsC;AACtC,gFAAgF;AAChF,gFAAgF;AAChF,4EAA4E;AAC5E,4EAA4E;AAC5E,kFAAkF;AAClF,+EAA+E;AAC/E,uEAAuE;AACvE,gFAAgF;AAChF,mFAAmF;AAEnF,wFAAwF;AACxF,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,yEAAyE;IAChE,MAAM,CAAQ;IACvB,0FAA0F;IACjF,MAAM,CAAQ;IAEvB,YAAY,MAAc,EAAE,MAAc;QACxC,KAAK,CAAC,+BAA+B,MAAM,IAAI,MAAM,EAAE,CAAC,CAAA;QACxD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAA;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CACF;AAED,oFAAoF;AACpF,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAC/C,6EAA6E;IAC3D,KAAK,CAAS;IAEhC,YAAY,OAAe,EAAE,KAAc;QACzC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAA;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { type FetchLike, type SearchOptions, ThreengramClient, type ThreengramClientConfig, } from './client.js';
+export { ThreengramApiError, ThreengramNetworkError } from './errors.js';

package/dist/index.js

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: Apache-2.0
+// @3ngram/sdk — workspace-only typed client over the REST /api/v1 surface
+// (docs/concepts/architecture.mdx one core, N transports; NOT published to npm).
+export { ThreengramClient, } from './client.js';
+export { ThreengramApiError, ThreengramNetworkError } from './errors.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,sCAAsC;AACtC,0EAA0E;AAC1E,iFAAiF;AACjF,OAAO,EAGL,gBAAgB,GAEjB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA"}

package/dist/reference.d.ts

@@ -0,0 +1,18 @@
+export interface SdkMethodReference {
+    name: string;
+    signature: string;
+    route: string;
+    summary: string;
+    requestSchema: 'remember' | 'search' | 'facts' | 'revise' | 'resolve';
+    responseSchema: 'remember' | 'search' | 'facts' | 'revise' | 'resolve';
+    example: string;
+}
+export declare const SDK_METHOD_NAMES: readonly ["remember", "search", "getFacts", "revise", "resolve"];
+export declare const SDK_METHODS: readonly SdkMethodReference[];
+export declare const SDK_ERRORS: readonly [{
+    readonly name: "ThreengramApiError";
+    readonly description: "Thrown for non-2xx REST responses. Carries status and reason from the response body.";
+}, {
+    readonly name: "ThreengramNetworkError";
+    readonly description: "Thrown when fetch rejects before a server response is available.";
+}];

package/dist/reference.js

@@ -0,0 +1,90 @@
+// SPDX-License-Identifier: Apache-2.0
+// Public SDK reference metadata consumed by the docs generator. The SDK runtime
+// surface stays in client.ts; this file keeps docs prose, method signatures, and
+// examples explicit without making the generator parse comments.
+export const SDK_METHOD_NAMES = ['remember', 'search', 'getFacts', 'revise', 'resolve'];
+export const SDK_METHODS = [
+    {
+        name: 'remember',
+        signature: 'remember(input: RememberToolArgs): Promise<RememberToolOutput>',
+        route: 'POST /api/v1/memories',
+        summary: 'Append a typed memory. Commitment outputs include a commitmentId.',
+        requestSchema: 'remember',
+        responseSchema: 'remember',
+        example: [
+            'await client.remember({',
+            "  memoryType: 'decision',",
+            "  topic: 'search backend',",
+            "  content: 'Use Postgres full-text search for v1.',",
+            "  scope: 'work',",
+            "  project: '3ngram',",
+            '})',
+        ].join('\n'),
+    },
+    {
+        name: 'search',
+        signature: 'search(query: string, opts?: SearchOptions): Promise<SearchToolOutput>',
+        route: 'POST /api/v1/search',
+        summary: 'Run semantic and keyword retrieval with optional pre-fusion filters.',
+        requestSchema: 'search',
+        responseSchema: 'search',
+        example: [
+            "await client.search('oauth refresh token', {",
+            '  limit: 5,',
+            "  scope: 'work',",
+            "  project: '3ngram',",
+            '})',
+        ].join('\n'),
+    },
+    {
+        name: 'getFacts',
+        signature: 'getFacts(filters?: FactsQueryArgs): Promise<FactsToolOutput>',
+        route: 'GET /api/v1/facts',
+        summary: 'Read currently-valid facts, with optional bi-temporal filters.',
+        requestSchema: 'facts',
+        responseSchema: 'facts',
+        example: [
+            'await client.getFacts({',
+            "  subject: '3ngram',",
+            "  predicate: 'status',",
+            '  limit: 20,',
+            '})',
+        ].join('\n'),
+    },
+    {
+        name: 'revise',
+        signature: 'revise(predecessorId: string, input: ReviseBody): Promise<ReviseToolOutput>',
+        route: 'POST /api/v1/memories/:id/revise',
+        summary: 'Create a corrected successor memory and link it to the predecessor.',
+        requestSchema: 'revise',
+        responseSchema: 'revise',
+        example: [
+            'await client.revise(memoryId, {',
+            "  memoryType: 'decision',",
+            "  topic: 'search backend',",
+            "  content: 'Use Postgres full-text search plus embeddings for v1.',",
+            "  edgeIntent: 'updates',",
+            '})',
+        ].join('\n'),
+    },
+    {
+        name: 'resolve',
+        signature: 'resolve(memoryId: string, status: CommitmentStatus): Promise<ResolveToolOutput>',
+        route: 'POST /api/v1/memories/:id/resolve',
+        summary: 'Transition the commitment riding a memory, or archive an active blocker.',
+        requestSchema: 'resolve',
+        responseSchema: 'resolve',
+        example: "await client.resolve(memoryId, 'resolved')",
+    },
+];
+export const SDK_ERRORS = [
+    {
+        name: 'ThreengramApiError',
+        description: 'Thrown for non-2xx REST responses. Carries status and reason from the response body.',
+    },
+    {
+        name: 'ThreengramNetworkError',
+        description: 'Thrown when fetch rejects before a server response is available.',
+    },
+];
+//# sourceMappingURL=reference.js.map

package/dist/reference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reference.js","sourceRoot":"","sources":["../src/reference.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,gFAAgF;AAChF,iFAAiF;AACjF,iEAAiE;AAYjE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAA;AAEhG,MAAM,CAAC,MAAM,WAAW,GAAkC;IACxD;QACE,IAAI,EAAE,UAAU;QAChB,SAAS,EAAE,gEAAgE;QAC3E,KAAK,EAAE,uBAAuB;QAC9B,OAAO,EAAE,mEAAmE;QAC5E,aAAa,EAAE,UAAU;QACzB,cAAc,EAAE,UAAU;QAC1B,OAAO,EAAE;YACP,yBAAyB;YACzB,2BAA2B;YAC3B,4BAA4B;YAC5B,qDAAqD;YACrD,kBAAkB;YAClB,sBAAsB;YACtB,IAAI;SACL,CAAC,IAAI,CAAC,IAAI,CAAC;KACb;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,wEAAwE;QACnF,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,sEAAsE;QAC/E,aAAa,EAAE,QAAQ;QACvB,cAAc,EAAE,QAAQ;QACxB,OAAO,EAAE;YACP,8CAA8C;YAC9C,aAAa;YACb,kBAAkB;YAClB,sBAAsB;YACtB,IAAI;SACL,CAAC,IAAI,CAAC,IAAI,CAAC;KACb;IACD;QACE,IAAI,EAAE,UAAU;QAChB,SAAS,EAAE,8DAA8D;QACzE,KAAK,EAAE,mBAAmB;QAC1B,OAAO,EAAE,gEAAgE;QACzE,aAAa,EAAE,OAAO;QACtB,cAAc,EAAE,OAAO;QACvB,OAAO,EAAE;YACP,yBAAyB;YACzB,sBAAsB;YACtB,wBAAwB;YACxB,cAAc;YACd,IAAI;SACL,CAAC,IAAI,CAAC,IAAI,CAAC;KACb;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,6EAA6E;QACxF,KAAK,EAAE,kCAAkC;QACzC,OAAO,EAAE,qEAAqE;QAC9E,aAAa,EAAE,QAAQ;QACvB,cAAc,EAAE,QAAQ;QACxB,OAAO,EAAE;YACP,iCAAiC;YACjC,2BAA2B;YAC3B,4BAA4B;YAC5B,qEAAqE;YACrE,0BAA0B;YAC1B,IAAI;SACL,CAAC,IAAI,CAAC,IAAI,CAAC;KACb;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,iFAAiF;QAC5F,KAAK,EAAE,mCAAmC;QAC1C,OAAO,EAAE,0EAA0E;QACnF,aAAa,EAAE,SAAS;QACxB,cAAc,EAAE,SAAS;QACzB,OAAO,EAAE,4CAA4C;KACtD;CACF,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB;QACE,IAAI,EAAE,oBAAoB;QAC1B,WAAW,EACT,sFAAsF;KACzF;IACD;QACE,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,kEAAkE;KAChF;CACO,CAAA"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@3ngram/sdk",
+  "version": "0.8.0",
+  "description": "Thin typed client over the existing REST /api/v1 surface (docs/concepts/architecture.mdx one core, N transports).",
+  "license": "Apache-2.0",
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/B3dmar/3ngram.git",
+    "directory": "packages/sdk"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./tsconfig.package.json": "./tsconfig.package.json"
+  },
+  "files": [
+    "dist",
+    "tsconfig.package.json"
+  ],
+  "dependencies": {
+    "zod": "4.4.3",
+    "@3ngram/schema": "0.4.0"
+  },
+  "devDependencies": {
+    "@types/node": "25.9.1",
+    "typescript": "6.0.3",
+    "vitest": "4.1.8"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run --exclude '**/integration/**'"
+  }
+}

package/tsconfig.package.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "composite": true,
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"]
+}