@almateam/app-sdk 0.6.0 → 0.8.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.
- package/README.md +230 -30
- package/generated/apiTypes.d.ts +403 -72
- package/index.d.ts +500 -38
- package/index.js +866 -39
- package/navigation.d.ts +21 -0
- package/package.json +2 -2
package/navigation.d.ts
CHANGED
|
@@ -18,4 +18,25 @@ export interface AppNavigation {
|
|
|
18
18
|
/** A topic, in the organization's Knowledge tab. */
|
|
19
19
|
openTopic(topicId: string): void;
|
|
20
20
|
}
|
|
21
|
+
/** A filtered host notification that something an app may reread changed.
|
|
22
|
+
* It carries only the kind and the id to reread; the app rereads canonical
|
|
23
|
+
* data through its ordinary scoped reads, so a notification discloses
|
|
24
|
+
* nothing a reread would refuse. A `type` event says some record of the
|
|
25
|
+
* type changed or joined, never which, and with `left` that one was
|
|
26
|
+
* deleted, restored, archived, merged away or moved to another type.
|
|
27
|
+
* Anything malformed is dropped. */
|
|
28
|
+
export interface AppHostEvent {
|
|
29
|
+
kind: "topic" | "type" | "execution";
|
|
30
|
+
topic_id?: string;
|
|
31
|
+
type_id?: string;
|
|
32
|
+
execution_id?: string;
|
|
33
|
+
left?: true;
|
|
34
|
+
}
|
|
35
|
+
export declare function parseAppHostEvent(told: unknown): AppHostEvent | null;
|
|
36
|
+
/** Host notifications as the host sends them, filtered before they arrive:
|
|
37
|
+
* only an event for a topic, type or execution the viewer can reach is
|
|
38
|
+
* ever posted to the frame. Subscribing returns its unsubscribe. */
|
|
39
|
+
export declare function hostEvents(): {
|
|
40
|
+
subscribe(listener: (event: AppHostEvent) => void): () => void;
|
|
41
|
+
};
|
|
21
42
|
export declare function hostNavigation(): AppNavigation;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@almateam/app-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "Types, host bridge and the alma-app dev command for apps that run in Alma. Alma builds every app with its own current copy of the SDK; install this for the types and the command.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://docs.alma.team/developers/apps",
|
|
@@ -17,6 +17,6 @@
|
|
|
17
17
|
"alma-app": "./cli.js"
|
|
18
18
|
},
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@modelcontextprotocol/sdk": "^1.32.
|
|
20
|
+
"@modelcontextprotocol/sdk": "^1.32.2"
|
|
21
21
|
}
|
|
22
22
|
}
|