@k9o/core 0.0.0-stage → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog — @k9o/core
+
+## 1.1.0 — 2026-10-25
+
+- Documentation rewritten with runnable examples and expected output; internal cross-references removed from the published sources. No change to the public API.
+- Error text for `update()` / `delete()` without an `id` filter no longer mentions a version or a roadmap.
+
+## 1.0.0 — 2026-10-23
+
+First public release. See the README for the full API overview.

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/NOTICE

@@ -0,0 +1,4 @@
+Kilimanjaro SDK
+Copyright 2026 Formelo Inc.
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).

package/README.md

@@ -1,3 +1,254 @@
-# Temporary Holding Version
+# @k9o/core
 
-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 Kilimanjaro platform SDK for TypeScript and JavaScript. One client for your data, projects, functions, audit log and more.
+
+## Contents
+
+- [Install](#install)
+- [Quick start](#quick-start)
+- [Authentication and project context](#authentication-and-project-context)
+- [Running queries](#running-queries)
+- [Handling errors](#handling-errors)
+- [Regional hosts](#regional-hosts)
+- [Appendix](#appendix)
+
+## Install
+
+```bash
+npm install @k9o/core
+```
+
+```bash
+bun add @k9o/core
+```
+
+```bash
+pnpm add @k9o/core
+```
+
+Requires Node.js 18+, Bun 1.1+ or a browser with a global `fetch`. TypeScript 5.6+ is optional. See [Requirements](#requirements).
+
+## Quick start
+
+The examples on this page use a `tasks` collection with a `title` and a `done` field.
+
+```ts
+import { createClient } from "@k9o/core";
+
+const client = createClient({
+  apiKey: process.env.K9O_API_KEY,
+  orgSlug: "acme",
+  projectSlug: "member-portal",
+});
+
+type Task = { id: string; title: string; done: boolean };
+
+const created = await client.from("tasks").insert<Task>({ title: "Write the README", done: false });
+const task = created.data;
+
+console.log(task.title);
+```
+
+```text
+Write the README
+```
+
+Every method resolves to `{ data, meta }`. `data` is the typed result and `meta` holds response metadata.
+
+## Authentication and project context
+
+Three options select who you are and where you work. See [Client options](#client-options) for the full list.
+
+| Option | What it does |
+| --- | --- |
+| `apiKey` | Bearer token sent on every request. |
+| `orgSlug` | Selects your organization. |
+| `projectSlug` | Selects the project. Required by project-scoped calls. |
+
+- On the default host, pass `orgSlug` and leave `baseUrl` out.
+- On a self-hosted or custom host, pass `baseUrl` and leave `orgSlug` out.
+
+```ts
+const client = createClient({
+  baseUrl: "https://acme.example.com",
+  apiKey: process.env.K9O_API_KEY,
+  projectSlug: "member-portal",
+});
+```
+
+To retry transient failures, add `retryConfig`. See [Retry settings](#retry-settings).
+
+## Running queries
+
+`client.from(collection)` reads and writes records. Chain filters and paging, then await the result.
+
+```ts
+const response = await client.from("tasks").select<Task>().eq("done", false).limit(10);
+
+for (const openTask of response.data) {
+  console.log(openTask.title);
+}
+```
+
+Update or delete one record by id:
+
+```ts
+const updated = await client.from("tasks").update<Task>({ done: true }).eq("id", task.id);
+
+console.log(updated.data.done);
+```
+
+```text
+true
+```
+
+- `update` and `delete` need an `eq("id", ...)` filter. They never change many rows at once.
+- See [Data methods](#data-methods) for filters and paging.
+- Other namespaces such as projects, migrations and audit are listed in [Methods by namespace](#methods-by-namespace).
+
+## Handling errors
+
+Every method throws `KError` when a request fails or the SDK rejects your input. Switch on `code`.
+
+```ts
+import { KError } from "@k9o/core";
+
+try {
+  await client.from("tasks").insert<Task>({ title: "One more task", done: false });
+} catch (error) {
+  if (error instanceof KError && error.code === "K9O_TIER_CAP_HIT") {
+    console.warn(error.message, error.recommendation);
+  } else {
+    throw error;
+  }
+}
+```
+
+- `KError` also carries `context`, `status` and `requestId`. See [Error fields](#error-fields).
+- The gateway can send many codes. See [Error codes](#error-codes) for the ones the SDK raises itself.
+
+## Regional hosts
+
+- On an organization host such as `https://acme.api.k9o.io`, the client sends one `HEAD` request first.
+- The request carries no credentials. It finds the regional host for your organization.
+- All later requests go to that host. The answer is cached for the life of the client.
+- Any other `baseUrl` is used as given. If the lookup fails, the configured host is used.
+
+## Appendix
+
+### Requirements
+
+| Requirement | Version |
+| --- | --- |
+| Node.js | 18 or newer |
+| Bun | 1.1 or newer |
+| TypeScript (optional) | 5.6 or newer |
+| Browser | Any with a global `fetch` |
+
+### Client options
+
+| Option | What it does |
+| --- | --- |
+| `apiKey` | Bearer token sent on every request. |
+| `orgSlug` | Selects your organization. On the default host it builds `https://<orgSlug>.api.k9o.io`. |
+| `projectSlug` | Selects the project. Required by project-scoped calls. |
+| `baseUrl` | Gateway host, no path. Defaults to `https://api.k9o.io`. |
+| `fetch` | Custom `fetch` implementation. |
+| `defaultHeaders` | Headers added to every request. |
+| `retryConfig` | Retry policy. See [Retry settings](#retry-settings). |
+
+- A `baseUrl` with a path, query or fragment throws `K9O_INVALID_BASE_URL`.
+- Slugs use 2 to 63 lowercase letters, digits and hyphens. They start with a letter and do not end with a hyphen.
+
+### Retry settings
+
+| Field | Meaning |
+| --- | --- |
+| `maxRetries` | How many times to retry. |
+| `backoff` | `"exponential"`, `"linear"` or `"none"`. |
+| `initialDelayMs` | First delay. Optional. |
+| `maxDelayMs` | Delay cap. Optional. |
+
+- Only GET, HEAD, OPTIONS and DELETE are retried.
+- Retries happen on network failure and on HTTP 429, 502, 503 and 504.
+
+### Methods by namespace
+
+| Namespace | Methods |
+| --- | --- |
+| `client.from(collection)` | See [Data methods](#data-methods). |
+| `client.projects` | `list`, `create`, `get`, `update` |
+| `client.migrations` | `apply`, `list`, `get`, `queue`, `listPending`, `applyPending`, `rejectPending`, `deletePending` |
+| `client.functions` | `deploy`, `list`, `get`, `delete` |
+| `client.audit` | `query`, `tail` (needs `projectSlug`) |
+| `client.policies` | Policy bundle lifecycle |
+| `client.storage` | Storage locations and buckets |
+| `client.metadata` | Metadata queries across surfaces |
+| `client.orgs` | `list`, `get`, `restore`, `current` |
+| `client.org` | Members, groups, SMTP settings, audit log, identity providers |
+| `client.me` | Your profile, sessions, API tokens, notifications |
+| `client.studio` | `workflows` and `dashboards` |
+| `client.compute.llms` | `list`, `read`, `invoke` |
+| `client.ai` | `embed` |
+| `client.realtime` | `subscribe`, `replay` |
+| `client.gate` | End-user sign-in from `@k9o/gate` (needs `projectSlug`) |
+| `client.kibo` | Vault and key operations from `@k9o/kibo` |
+| `client.extensions` | `extension(slug)` from `@k9o/extensions` |
+
+### Data methods
+
+| Method | What it does |
+| --- | --- |
+| `select<T>()` | Starts a query. Await it to get the rows. |
+| `insert<T>(record)` | Creates one record. |
+| `update<T>(patch)` | Updates one record by id. |
+| `delete<T>()` | Deletes one record by id. |
+| `eq`, `neq` | Equal, not equal. |
+| `gt`, `gte`, `lt`, `lte` | Comparisons. |
+| `in`, `notIn` | Value is in, or not in, a list. |
+| `like`, `ilike` | Pattern match, case-sensitive or not. |
+| `is` | Compare with `"null"`, `"true"` or `"false"`. |
+| `filter(column, op, value)` | Generic form of the filters above. |
+| `limit(n)` | Maximum rows to return. |
+| `cursor(token)` | Continue from a cursor. |
+| `count(mode)` | `"none"`, `"exact"` or `"estimated"`. |
+
+Filters combine with AND.
+
+### Error fields
+
+| Field | Meaning |
+| --- | --- |
+| `code` | Stable string such as `K9O_PROJECT_NOT_FOUND`. Switch on this. |
+| `message` | Human-readable explanation. |
+| `context` | Read-only per-code details. |
+| `recommendation` | Suggested next step, or `null`. |
+| `status` | HTTP status, or `null` if no request was sent. |
+| `requestId` | Gateway trace id for support, or `null`. |
+
+### Error codes
+
+The gateway can send other codes. The SDK passes them through unchanged.
+
+| Code | When |
+| --- | --- |
+| `K9O_INVALID_BASE_URL` | `baseUrl` is not a plain http or https host. |
+| `K9O_INVALID_FIELD_VALUE` | An argument or slug failed validation. |
+| `K9O_INVALID_FILTER` | A realtime subscription filter was malformed. |
+| `K9O_MISSING_PROJECT_CONTEXT` | A project-scoped call was made without `projectSlug`. |
+| `K9O_UPSTREAM_UNAVAILABLE` | The gateway could not be reached. |
+| `K9O_INTERNAL_ERROR` | No `fetch` is available, or the response was unexpected. |
+
+### Related packages
+
+| Package | What it does |
+| --- | --- |
+| `@k9o/gate` | End-user sign-up, sign-in, sessions and JWT verification. |
+| `@k9o/extensions` | Typed bindings for platform extensions. |
+| `@k9o/kibo` | Vault and key operations. |
+
+Platform apex: https://api.k9o.io. Documentation: https://kilimanjaro.dev.
+
+## License
+
+Apache-2.0 © Formelo Inc. See `LICENSE` and `NOTICE`.

package/dist/chunk-2NDFTHUB.js

@@ -0,0 +1,93 @@
+import {
+  KError
+} from "./chunk-LJZ45UA2.js";
+
+// src/url-grammar.ts
+function validateBaseUrl(baseUrl) {
+  let parsed;
+  try {
+    parsed = new URL(baseUrl);
+  } catch {
+    throw new KError({
+      code: "K9O_INVALID_BASE_URL",
+      message: `baseUrl "${baseUrl}" is not a valid URL`,
+      context: { baseUrl },
+      recommendation: "Pass a scheme + host like `https://api.k9o.io` or `https://<orgSlug>.api.k9o.io`",
+      status: null
+    });
+  }
+  if (parsed.protocol !== "http:" && parsed.protocol !== "https:") {
+    throw new KError({
+      code: "K9O_INVALID_BASE_URL",
+      message: `baseUrl "${baseUrl}" uses unsupported scheme "${parsed.protocol}"; expected http: or https:`,
+      context: { baseUrl, scheme: parsed.protocol },
+      recommendation: "Use http:// or https://. WebSocket subscriptions are wired internally over SSE on the same host.",
+      status: null
+    });
+  }
+  if (parsed.pathname !== "/" && parsed.pathname !== "") {
+    throw new KError({
+      code: "K9O_INVALID_BASE_URL",
+      message: `baseUrl "${baseUrl}" must not contain a path segment; got "${parsed.pathname}"`,
+      context: { baseUrl, path: parsed.pathname },
+      recommendation: "Strip the path segment \u2014 pass host only. URL paths are composed by the SDK.",
+      status: null
+    });
+  }
+  if (parsed.search.length > 0 || parsed.hash.length > 0) {
+    throw new KError({
+      code: "K9O_INVALID_BASE_URL",
+      message: `baseUrl "${baseUrl}" must not contain query or fragment`,
+      context: { baseUrl, query: parsed.search, fragment: parsed.hash },
+      recommendation: "Pass host only.",
+      status: null
+    });
+  }
+  const normalised = `${parsed.protocol}//${parsed.host}`;
+  return normalised;
+}
+var K9O_ORG_DERIVABLE_APEXES = /* @__PURE__ */ new Set(["api.k9o.io", "api-staging.k9o.io"]);
+function resolveBaseUrl(baseUrl, orgSlug) {
+  const validated = validateBaseUrl(baseUrl ?? "https://api.k9o.io");
+  const parsed = new URL(validated);
+  if (K9O_ORG_DERIVABLE_APEXES.has(parsed.hostname) && orgSlug) {
+    validateSlug(orgSlug, "org");
+    return `${parsed.protocol}//${orgSlug}.${parsed.hostname}`;
+  }
+  return validated;
+}
+var SLUG_RE = /^[a-z][a-z0-9-]{1,62}$/;
+function validateSlug(slug, kind) {
+  if (!SLUG_RE.test(slug) || slug.endsWith("-")) {
+    throw new KError({
+      code: "K9O_INVALID_FIELD_VALUE",
+      message: `${kind}Slug "${slug}" does not match required format ^[a-z][a-z0-9-]{1,62}$ (must not end with '-')`,
+      context: { slug, kind },
+      recommendation: `Pass a slug matching the format \u2014 lowercase letters / digits / hyphens; 2-63 chars; starts with a letter; does not end with hyphen.`,
+      status: null
+    });
+  }
+}
+function projectPath(projectSlug, subResource) {
+  validateSlug(projectSlug, "project");
+  const cleaned = subResource.startsWith("/") ? subResource.slice(1) : subResource;
+  return `/@${projectSlug}/${cleaned}`;
+}
+function orgPath(resource) {
+  const cleaned = resource.startsWith("/") ? resource.slice(1) : resource;
+  return `/${cleaned}`;
+}
+function platformPath(resource) {
+  const cleaned = resource.startsWith("/") ? resource.slice(1) : resource;
+  return `/${cleaned}`;
+}
+
+export {
+  validateBaseUrl,
+  resolveBaseUrl,
+  validateSlug,
+  projectPath,
+  orgPath,
+  platformPath
+};
+//# sourceMappingURL=chunk-2NDFTHUB.js.map

package/dist/chunk-2NDFTHUB.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/url-grammar.ts"],"sourcesContent":["/**\n * URL grammar.\n *\n * Canonical URL shapes:\n *   - Member-plane (project-scoped): `<orgSlug>.api.k9o.io/@<projectSlug>/<sub-resource>/...`\n *   - Org-plane (org-scoped):        `<orgSlug>.api.k9o.io/<resource>/...`\n *   - Platform-plane (cross-org):    `api.k9o.io/discovery/...` + `api.k9o.io/auth/...` etc.\n *\n * The `baseUrl` passed to `createClient` is the gateway host root —\n * scheme + host (+ optional port). Path-bearing baseUrls\n * are rejected with `K9O_INVALID_BASE_URL`.\n *\n * The SDK constructs URLs by composing `baseUrl + path-from-builder`.\n * Per-resource SDK methods use the builders below to assemble their\n * `path` argument before handing to the HTTP client.\n */\n\nimport { KError } from \"./kerror.ts\";\n\n/**\n * Validate a `baseUrl`. Returns the normalised form\n * (trailing-slash stripped) on success; throws `K9O_INVALID_BASE_URL`\n * on any violation.\n *\n * Accepted shapes:\n *   - `https://api.k9o.io`\n *   - `https://acme.api.k9o.io`\n *   - `http://localhost:8080`\n *   - `https://api.k9o.io:443`\n *\n * Rejected shapes:\n *   - path segments (`https://api.k9o.io/v2`)\n *   - missing scheme (`api.k9o.io`)\n *   - non-http(s) scheme (`wss://api.k9o.io`)\n *   - query / fragment (`https://api.k9o.io?x=1`)\n */\nexport function validateBaseUrl(baseUrl: string): string {\n  let parsed: URL;\n  try {\n    parsed = new URL(baseUrl);\n  } catch {\n    throw new KError({\n      code: \"K9O_INVALID_BASE_URL\",\n      message: `baseUrl \"${baseUrl}\" is not a valid URL`,\n      context: { baseUrl },\n      recommendation: \"Pass a scheme + host like `https://api.k9o.io` or `https://<orgSlug>.api.k9o.io`\",\n      status: null,\n    });\n  }\n  if (parsed.protocol !== \"http:\" && parsed.protocol !== \"https:\") {\n    throw new KError({\n      code: \"K9O_INVALID_BASE_URL\",\n      message: `baseUrl \"${baseUrl}\" uses unsupported scheme \"${parsed.protocol}\"; expected http: or https:`,\n      context: { baseUrl, scheme: parsed.protocol },\n      recommendation: \"Use http:// or https://. WebSocket subscriptions are wired internally over SSE on the same host.\",\n      status: null,\n    });\n  }\n  if (parsed.pathname !== \"/\" && parsed.pathname !== \"\") {\n    throw new KError({\n      code: \"K9O_INVALID_BASE_URL\",\n      message: `baseUrl \"${baseUrl}\" must not contain a path segment; got \"${parsed.pathname}\"`,\n      context: { baseUrl, path: parsed.pathname },\n      recommendation: \"Strip the path segment — pass host only. URL paths are composed by the SDK.\",\n      status: null,\n    });\n  }\n  if (parsed.search.length > 0 || parsed.hash.length > 0) {\n    throw new KError({\n      code: \"K9O_INVALID_BASE_URL\",\n      message: `baseUrl \"${baseUrl}\" must not contain query or fragment`,\n      context: { baseUrl, query: parsed.search, fragment: parsed.hash },\n      recommendation: \"Pass host only.\",\n      status: null,\n    });\n  }\n  // Normalise — strip trailing slash so concatenation is predictable.\n  const normalised = `${parsed.protocol}//${parsed.host}`;\n  return normalised;\n}\n\n/**\n * The bare platform apex hosts org-subdomain derivation applies to. `api.k9o.io`\n * (production) and `api-staging.k9o.io` (staging) share the same\n * `<orgSlug>.<apex>` wire-routing scheme — confirmed live (conformance,\n * `k9o login` examples, staging demo configs all address orgs this way on\n * both). A THIRD apex here needs the same confirmation before joining this\n * set — never inferred from a hostname merely looking apex-shaped.\n */\nconst K9O_ORG_DERIVABLE_APEXES = new Set([\"api.k9o.io\", \"api-staging.k9o.io\"]);\n\n/**\n * Resolve the effective baseUrl. `baseUrl` is\n * OPTIONAL — it defaults to the platform apex `https://api.k9o.io`. When the\n * (validated) host is a bare apex in `K9O_ORG_DERIVABLE_APEXES` and `orgSlug`\n * is supplied, the SDK composes the canonical org-subdomain wire root\n * `https://<orgSlug>.<apex>`. An explicit `<orgSlug>` subdomain, a\n * self-hosted / Sovereign host, or a dev host (anything not in that set)\n * passes through unchanged — `orgSlug` is intentionally NOT validated or\n * composed onto a non-apex host (fixed 2026-08-30: this used to silently\n * ignore `orgSlug` for `api-staging.k9o.io` too, not just genuine\n * self-hosted/custom hosts, since only the literal production apex string\n * was checked).\n */\nexport function resolveBaseUrl(baseUrl: string | undefined, orgSlug?: string): string {\n  const validated = validateBaseUrl(baseUrl ?? \"https://api.k9o.io\");\n  const parsed = new URL(validated);\n  if (K9O_ORG_DERIVABLE_APEXES.has(parsed.hostname) && orgSlug) {\n    validateSlug(orgSlug, \"org\");\n    return `${parsed.protocol}//${orgSlug}.${parsed.hostname}`;\n  }\n  return validated;\n}\n\n/**\n * Slug format validator:\n *   `[a-z][a-z0-9-]{1,62}` and must not end with `-`.\n */\nconst SLUG_RE = /^[a-z][a-z0-9-]{1,62}$/;\n\nexport function validateSlug(slug: string, kind: \"org\" | \"project\"): void {\n  if (!SLUG_RE.test(slug) || slug.endsWith(\"-\")) {\n    throw new KError({\n      code: \"K9O_INVALID_FIELD_VALUE\",\n      message: `${kind}Slug \"${slug}\" does not match required format ^[a-z][a-z0-9-]{1,62}$ (must not end with '-')`,\n      context: { slug, kind },\n      recommendation: `Pass a slug matching the format — lowercase letters / digits / hyphens; 2-63 chars; starts with a letter; does not end with hyphen.`,\n      status: null,\n    });\n  }\n}\n\n/**\n * Build a project-scoped (member-plane) URL path per the URL grammar\n * E.g. `projectPath('member-portal', 'collections/posts/documents')`\n *      → `/@member-portal/collections/posts/documents`.\n *\n * The caller is responsible for normalising sub-resource components\n * (URL-encoding goes through the caller's path construction; this\n * helper handles only the prefix + slug shape).\n */\nexport function projectPath(projectSlug: string, subResource: string): string {\n  validateSlug(projectSlug, \"project\");\n  const cleaned = subResource.startsWith(\"/\") ? subResource.slice(1) : subResource;\n  return `/@${projectSlug}/${cleaned}`;\n}\n\n/**\n * Build an org-plane path. E.g. `orgPath('org')` → `/org`,\n * `orgPath('projects')` → `/projects`.\n */\nexport function orgPath(resource: string): string {\n  const cleaned = resource.startsWith(\"/\") ? resource.slice(1) : resource;\n  return `/${cleaned}`;\n}\n\n/**\n * Build a platform-plane path (cross-org). E.g.\n * `platformPath('discovery/projects')` → `/discovery/projects`,\n * `platformPath('auth/sign-in')` → `/auth/sign-in`.\n *\n * Composes with the platform baseUrl (`https://api.k9o.io`) — not the\n * org-subdomain baseUrl.\n */\nexport function platformPath(resource: string): string {\n  const cleaned = resource.startsWith(\"/\") ? resource.slice(1) : resource;\n  return `/${cleaned}`;\n}\n"],"mappings":";;;;;AAoCO,SAAS,gBAAgB,SAAyB;AACvD,MAAI;AACJ,MAAI;AACF,aAAS,IAAI,IAAI,OAAO;AAAA,EAC1B,QAAQ;AACN,UAAM,IAAI,OAAO;AAAA,MACf,MAAM;AAAA,MACN,SAAS,YAAY,OAAO;AAAA,MAC5B,SAAS,EAAE,QAAQ;AAAA,MACnB,gBAAgB;AAAA,MAChB,QAAQ;AAAA,IACV,CAAC;AAAA,EACH;AACA,MAAI,OAAO,aAAa,WAAW,OAAO,aAAa,UAAU;AAC/D,UAAM,IAAI,OAAO;AAAA,MACf,MAAM;AAAA,MACN,SAAS,YAAY,OAAO,8BAA8B,OAAO,QAAQ;AAAA,MACzE,SAAS,EAAE,SAAS,QAAQ,OAAO,SAAS;AAAA,MAC5C,gBAAgB;AAAA,MAChB,QAAQ;AAAA,IACV,CAAC;AAAA,EACH;AACA,MAAI,OAAO,aAAa,OAAO,OAAO,aAAa,IAAI;AACrD,UAAM,IAAI,OAAO;AAAA,MACf,MAAM;AAAA,MACN,SAAS,YAAY,OAAO,2CAA2C,OAAO,QAAQ;AAAA,MACtF,SAAS,EAAE,SAAS,MAAM,OAAO,SAAS;AAAA,MAC1C,gBAAgB;AAAA,MAChB,QAAQ;AAAA,IACV,CAAC;AAAA,EACH;AACA,MAAI,OAAO,OAAO,SAAS,KAAK,OAAO,KAAK,SAAS,GAAG;AACtD,UAAM,IAAI,OAAO;AAAA,MACf,MAAM;AAAA,MACN,SAAS,YAAY,OAAO;AAAA,MAC5B,SAAS,EAAE,SAAS,OAAO,OAAO,QAAQ,UAAU,OAAO,KAAK;AAAA,MAChE,gBAAgB;AAAA,MAChB,QAAQ;AAAA,IACV,CAAC;AAAA,EACH;AAEA,QAAM,aAAa,GAAG,OAAO,QAAQ,KAAK,OAAO,IAAI;AACrD,SAAO;AACT;AAUA,IAAM,2BAA2B,oBAAI,IAAI,CAAC,cAAc,oBAAoB,CAAC;AAetE,SAAS,eAAe,SAA6B,SAA0B;AACpF,QAAM,YAAY,gBAAgB,WAAW,oBAAoB;AACjE,QAAM,SAAS,IAAI,IAAI,SAAS;AAChC,MAAI,yBAAyB,IAAI,OAAO,QAAQ,KAAK,SAAS;AAC5D,iBAAa,SAAS,KAAK;AAC3B,WAAO,GAAG,OAAO,QAAQ,KAAK,OAAO,IAAI,OAAO,QAAQ;AAAA,EAC1D;AACA,SAAO;AACT;AAMA,IAAM,UAAU;AAET,SAAS,aAAa,MAAc,MAA+B;AACxE,MAAI,CAAC,QAAQ,KAAK,IAAI,KAAK,KAAK,SAAS,GAAG,GAAG;AAC7C,UAAM,IAAI,OAAO;AAAA,MACf,MAAM;AAAA,MACN,SAAS,GAAG,IAAI,SAAS,IAAI;AAAA,MAC7B,SAAS,EAAE,MAAM,KAAK;AAAA,MACtB,gBAAgB;AAAA,MAChB,QAAQ;AAAA,IACV,CAAC;AAAA,EACH;AACF;AAWO,SAAS,YAAY,aAAqB,aAA6B;AAC5E,eAAa,aAAa,SAAS;AACnC,QAAM,UAAU,YAAY,WAAW,GAAG,IAAI,YAAY,MAAM,CAAC,IAAI;AACrE,SAAO,KAAK,WAAW,IAAI,OAAO;AACpC;AAMO,SAAS,QAAQ,UAA0B;AAChD,QAAM,UAAU,SAAS,WAAW,GAAG,IAAI,SAAS,MAAM,CAAC,IAAI;AAC/D,SAAO,IAAI,OAAO;AACpB;AAUO,SAAS,aAAa,UAA0B;AACrD,QAAM,UAAU,SAAS,WAAW,GAAG,IAAI,SAAS,MAAM,CAAC,IAAI;AAC/D,SAAO,IAAI,OAAO;AACpB;","names":[]}

package/dist/chunk-LJZ45UA2.js

@@ -0,0 +1,33 @@
+// src/kerror.ts
+var KError = class extends Error {
+  code;
+  context;
+  recommendation;
+  status;
+  requestId;
+  constructor(init) {
+    super(init.message);
+    this.name = "KError";
+    this.code = init.code;
+    this.context = Object.freeze({ ...init.context ?? {} });
+    this.recommendation = init.recommendation ?? null;
+    this.status = init.status ?? null;
+    this.requestId = init.requestId ?? null;
+  }
+};
+function kerrorFromWire(wire, status) {
+  return new KError({
+    code: wire.code,
+    message: wire.message,
+    context: wire.context ?? {},
+    recommendation: wire.recommendation ?? null,
+    status,
+    requestId: wire.requestId ?? null
+  });
+}
+
+export {
+  KError,
+  kerrorFromWire
+};
+//# sourceMappingURL=chunk-LJZ45UA2.js.map

package/dist/chunk-LJZ45UA2.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/kerror.ts"],"sourcesContent":["/**\n * `KError` — the closed-taxonomy error class returned by every `@k9o/core`\n * surface on non-2xx gateway responses or SDK-side validation failures.\n *\n * TypeScript / JavaScript throw on error; the per-language SDKs deliver this same payload\n * via their idiomatic mechanism (Go tuple-return; Rust Result; Python\n * raise; etc.) without changing the field shape.\n *\n * Fields:\n *   - `code`     — closed-taxonomy string (e.g. `K9O_TIER_CAP_HIT`,\n *                  `K9O_PROJECT_NOT_FOUND`); unknown codes pass through\n *                  with `code` preserved + `INTERNAL_ERROR` family\n *                  classification recorded in `context.originalCode`.\n *   - `message`  — human-readable explanation.\n *   - `context`  — structured per-code payload (immutable; frozen).\n *   - `recommendation` — actionable next step (may be null when the\n *                  gateway didn't return one).\n *   - `status`   — HTTP status the gateway returned (or null for\n *                  SDK-side construct-time errors like\n *                  `K9O_INVALID_BASE_URL`).\n *   - `requestId` — gateway-emitted trace ID for downstream correlation.\n *\n * Standalone `@k9o/gate` ships its own `GateError` for the Auth0-parity\n * deployment shape; when `@k9o/gate` is composed inside `@k9o/core`,\n * `GateError` semantics align with `KError extends KError` (alignment still open).\n * Until then `KError` is the canonical error type returned by `@k9o/core` surfaces; `GateError` thrown by\n * `@k9o/gate`-delegated surfaces remain `KError`-shape-compatible\n * (both expose the same `code` / `message` / `context` / `recommendation`\n * fields) so caller code that narrows on `code` works against either.\n */\n\n/**\n * Wire-shape sentinel matching the gateway's `KError` JSON payload. The HTTP client recognises this on non-2xx responses\n * and rehydrates it into a `KError` instance.\n */\nexport type KErrorWire = {\n  code: string;\n  message: string;\n  context?: Record<string, unknown>;\n  recommendation?: string | null;\n  requestId?: string;\n};\n\n/**\n * The customer-facing error type. Every `@k9o/core` surface throws this\n * on non-2xx upstream responses, transport failures, or SDK-side\n * validation failures.\n */\nexport class KError extends Error {\n  readonly code: string;\n  readonly context: Readonly<Record<string, unknown>>;\n  readonly recommendation: string | null;\n  readonly status: number | null;\n  readonly requestId: string | null;\n\n  constructor(init: {\n    code: string;\n    message: string;\n    context?: Record<string, unknown>;\n    recommendation?: string | null;\n    status?: number | null;\n    requestId?: string | null;\n  }) {\n    super(init.message);\n    this.name = \"KError\";\n    this.code = init.code;\n    this.context = Object.freeze({ ...(init.context ?? {}) });\n    this.recommendation = init.recommendation ?? null;\n    this.status = init.status ?? null;\n    this.requestId = init.requestId ?? null;\n  }\n}\n\n/**\n * Rehydrate a wire `KError` payload into a typed `KError` instance.\n * Unlike `@k9o/gate.gateErrorFromWire`, `@k9o/core` does not maintain\n * a hand-curated allow-list of known codes — the gateway's KError\n * code-space is open-ended and curated centrally; the SDK\n * preserves whatever code the gateway sends. Code-narrowing in caller\n * code uses string-literal comparison against the well-known codes\n * (e.g. `if (e.code === 'K9O_TIER_CAP_HIT')`).\n */\nexport function kerrorFromWire(wire: KErrorWire, status: number): KError {\n  return new KError({\n    code: wire.code,\n    message: wire.message,\n    context: wire.context ?? {},\n    recommendation: wire.recommendation ?? null,\n    status,\n    requestId: wire.requestId ?? null,\n  });\n}\n"],"mappings":";AAgDO,IAAM,SAAN,cAAqB,MAAM;AAAA,EACvB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAET,YAAY,MAOT;AACD,UAAM,KAAK,OAAO;AAClB,SAAK,OAAO;AACZ,SAAK,OAAO,KAAK;AACjB,SAAK,UAAU,OAAO,OAAO,EAAE,GAAI,KAAK,WAAW,CAAC,EAAG,CAAC;AACxD,SAAK,iBAAiB,KAAK,kBAAkB;AAC7C,SAAK,SAAS,KAAK,UAAU;AAC7B,SAAK,YAAY,KAAK,aAAa;AAAA,EACrC;AACF;AAWO,SAAS,eAAe,MAAkB,QAAwB;AACvE,SAAO,IAAI,OAAO;AAAA,IAChB,MAAM,KAAK;AAAA,IACX,SAAS,KAAK;AAAA,IACd,SAAS,KAAK,WAAW,CAAC;AAAA,IAC1B,gBAAgB,KAAK,kBAAkB;AAAA,IACvC;AAAA,IACA,WAAW,KAAK,aAAa;AAAA,EAC/B,CAAC;AACH;","names":[]}