@almateam/app-sdk 0.3.0 → 0.3.1

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 +14 -11
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -8,13 +8,14 @@ An app imports the SDK as `@alma/app-sdk`. Install the published package under
8
8
  that name, for its types:
9
9
 
10
10
  ```sh
11
- npm install --save-dev @alma/app-sdk@npm:@almateam/app-sdk@^0.3.0
11
+ npm install --save-dev @alma/app-sdk@npm:@almateam/app-sdk@^0.3.1
12
12
  ```
13
13
 
14
14
  Alma builds an app's source with its own current copy of the SDK, whatever
15
15
  version the source installs or pins, so the copy you install never ships. The
16
- SDK has no dependency and holds no credential; an app runs in Alma's isolated
17
- frame and talks to its host through it:
16
+ SDK's runtime has no dependency and holds no credential (the `alma-app` command
17
+ uses the MCP client); an app runs in Alma's isolated frame and talks to its host
18
+ through it:
18
19
 
19
20
  ```ts
20
21
  import { createAppSdk, hostTransport } from "@alma/app-sdk";
@@ -45,10 +46,10 @@ for a field, a field key), and any operation outside the manifest's `scopes`
45
46
  forwards only the query keys an operation declares.
46
47
 
47
48
  A call resolves once it is done, within 30 seconds, or rejects. A change
48
- (`setTopicField`, `createLesson`, `updateLesson`) is the viewer's own act: it
49
- saves as them where they may edit that record and is refused where they cannot.
50
- Nobody is asked and no dialog appears: the promise resolves with the result, or
51
- rejects with the refusal's words.
49
+ (`setTopicField`, `createWorkflowLesson`, `updateLesson`) is the viewer's own
50
+ act: it saves as them where they may edit that record and is refused where they
51
+ cannot. Nobody is asked and no dialog appears: the promise resolves with the
52
+ result, or rejects with the refusal's words.
52
53
 
53
54
  The app talks to its host on one channel that belongs to the document the Space
54
55
  loaded; the SDK finds it there. A document the frame navigates to has no
@@ -114,10 +115,12 @@ token reaches the app.
114
115
 
115
116
  The package carries the `alma-app` command, which runs under Node.
116
117
  `npx alma-app dev [folder] --app <app id>` (or `bunx`) pushes the folder's
117
- source (`manifest.json` beside `index.html`, `node_modules` left out) as a new
118
- draft version now and on every save, signed in as you in the browser; Alma
119
- builds it and your draft moves to it. Without `--app` the first push starts a
120
- new app.
118
+ source (`manifest.json` beside `index.html`, and the `.tsx`, `.ts`, `.jsx`,
119
+ `.js`, `.mjs`, `.css`, `.html`, `.svg` and `.json` files around it, leaving out
120
+ `node_modules`, `dist`, `build`, dotfiles and lockfiles) as a new draft version
121
+ now and on every save, signed in as you in the browser; Alma builds it and your
122
+ draft moves to it. Without `--app` the first push starts a new app; a member of
123
+ several workspaces names one with `--org <organization id>`.
121
124
 
122
125
  While you have your own app open, what it logs (`console`) and every error it
123
126
  does not catch show in its Manage sheet, under Logs, beside how the workflows it
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@almateam/app-sdk",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
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",