@k9o/extensions 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,7 +2,11 @@
2
2
 
3
3
  Typed bindings for Kilimanjaro platform extensions, resolved by slug with `k9o.extension(slug)`.
4
4
 
5
- Kilimanjaro is an AI-native platform on a Governed Database. Its products are Keep (AI Security and Governance), Pulse (Data Intelligence), Gate (Customer Identity and Access Management) and Kibo (Keys and Secrets Management).
5
+ > **This package is a placeholder.** Every method rejects until the platform serves extension calls.
6
+ > If you are writing an extension, use `@k9o/extensions-sdk` instead. It is not on npm yet.
7
+
8
+ Kilimanjaro is the AI-native foundation for building critical applications. Its products are Keep (AI Security and Governance),
9
+ Pulse (Data Intelligence), Gate (Customer Identity and Access Management) and Kibo (Keys and Secrets Management).
6
10
 
7
11
  ## Contents
8
12
 
@@ -38,26 +42,34 @@ Requires TypeScript 5.6+ for the bundled types. See [Requirements](#requirements
38
42
 
39
43
  ## Quick start
40
44
 
45
+ Resolve a binding by slug. Calling any method rejects, because no request is sent.
46
+
41
47
  ```ts
42
48
  import { k9o } from "@k9o/extensions";
43
49
 
44
50
  const cairn = k9o.extension("cairn");
45
51
 
46
- async function createTasksCollection() {
47
- return cairn.collections.create({ name: "tasks", dimension: 3, metric: "cosine" });
52
+ try {
53
+ await cairn.collections.list();
54
+ } catch (error) {
55
+ console.log(error instanceof Error ? error.message : error);
48
56
  }
49
57
  ```
50
58
 
59
+ ```text
60
+ cairn.collections.list is not available yet: the extension runtime is not implemented in this version of @k9o/extensions.
61
+ ```
62
+
51
63
  - The returned object is typed for the slug you pass.
52
64
  - An unknown slug is a compile-time error, and it also throws an `Error` at runtime.
53
- - See [Methods by extension](#methods-by-extension) for what each extension offers.
65
+ - See [Methods by extension](#methods-by-extension) for the typed contract of each extension.
54
66
 
55
67
  ## Current limitations
56
68
 
57
- - In this release the bindings define the typed contract only.
69
+ - The bindings define the typed contract only. They do not work yet.
58
70
  - Calling a method rejects with an `Error` saying the runtime is not implemented.
59
71
  - No request is sent to the platform.
60
- - Until method dispatch is available, call extensions over HTTP.
72
+ - Extension authors should use `@k9o/extensions-sdk`, which is not yet on npm.
61
73
 
62
74
  ## Using through @k9o/core
63
75
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@k9o/extensions",
3
- "version": "1.2.0",
3
+ "version": "1.3.0",
4
4
  "description": "Kilimanjaro extensions consumption SDK — k9o.extension(slug) typed Stack-SDK factory. Sibling of @k9o/gate (Identity-Aware Kernel) and future @k9o/kibo (data/compute pillar) per 3-pillar brand architecture.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",