@civitai/app-sdk 0.68.0 → 0.69.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.
- package/README.md +11 -0
- package/dist/blocks/messages.d.ts +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
Shared OAuth + orchestrator glue for building third-party [Civitai](https://civitai.com) apps. Used internally by every starter in [`civitai/civitai-app-starters`](https://github.com/civitai/civitai-app-starters), and publishable for direct use in your own app.
|
|
4
4
|
|
|
5
|
+
> **Building a block app (an app that runs inside civitai.com)? Start from
|
|
6
|
+
> [`@civitai/sdk`](https://www.npmjs.com/package/@civitai/sdk).** The three
|
|
7
|
+
> packages are layers over one host contract, and all three are supported:
|
|
8
|
+
>
|
|
9
|
+
> - **`@civitai/sdk`** is the client new block apps start on: `initialize()`,
|
|
10
|
+
> then `app.workflows`, `app.storage`, `app.site` and `app.host`.
|
|
11
|
+
> - **`@civitai/app-sdk/blocks`** (this package) is the contract itself: the
|
|
12
|
+
> workflow body types, the manifest types and the host message shapes.
|
|
13
|
+
> - **[`@civitai/blocks-react`](https://www.npmjs.com/package/@civitai/blocks-react)**
|
|
14
|
+
> is the React hook binding over that same contract.
|
|
15
|
+
|
|
5
16
|
This package is **runtime-agnostic** — Node 20+ APIs only. There is no Next.js, SvelteKit, or Express coupling. Each starter writes a ~30-line framework adapter that calls into these primitives.
|
|
6
17
|
|
|
7
18
|
## Install
|
package/package.json
CHANGED