CremaUIStudio/lib-arcadia-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: rename @crema/arcadia-client → @crema/arcadia-core-client

Browse Source 
Disambiguates the Phoenix/auth client lib from lib-arcadia-agents-client.
Dir lib-arcadia-client → lib-arcadia-core-client; alias updated in
tsconfig paths, vite config, app.css @source, imports, CI and docs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
jules
2026-06-11 13:31:54 +10:00
parent 57dc0455d1
commit ae8332ab3f
2 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,4 +1,4 @@
# @crema/arcadia-client
# @crema/arcadia-core-client
Typed HTTP client + React bindings for the [arcadia](https://git.sky-ai.com/CremaUIStudio/arcadia-app) Phoenix API. Wraps the OpenAPI-spec'd surface at `/api/v1` with auth (Bearer JWT and/or service-account API key), tenant context (`X-Tenant-ID`), idempotency keys, error normalization, and rate-limit-aware retry.
@@ -13,7 +13,7 @@ import {
useArcadia,
useArcadiaClient,
ArcadiaError,
} from "@crema/arcadia-client";
} from "@crema/arcadia-core-client";
```
## Usage in a Crema app
@@ -21,7 +21,7 @@ import {
In `app/root.tsx`, wrap providers:
```tsx
import { ArcadiaProvider } from "@crema/arcadia-client";
import { ArcadiaProvider } from "@crema/arcadia-core-client";
<ArcadiaProvider
baseUrl={import.meta.env.VITE_ARCADIA_URL}
@@ -36,7 +36,7 @@ import { ArcadiaProvider } from "@crema/arcadia-client";
In any component:
```tsx
import { useArcadiaClient, ArcadiaError } from "@crema/arcadia-client";
import { useArcadiaClient, ArcadiaError } from "@crema/arcadia-core-client";
function ResourceList() {
const arcadia = useArcadiaClient();
@@ -59,7 +59,7 @@ Endpoint request/response types come from arcadia's live OpenAPI spec. Regenerat
```bash
ARCADIA_OPENAPI_URL=http://localhost:4000/api/openapi \
node ../lib-arcadia-client/scripts/sync-spec.mjs
node ../lib-arcadia-core-client/scripts/sync-spec.mjs
```
Requires `openapi-typescript` in the consuming app's devDeps:
@@ -108,7 +108,7 @@ Phoenix Channels at `/socket/tenant`, opt-in via the provider. The socket auto-c
```
```tsx
import { useArcadiaSubscription } from "@crema/arcadia-client";
import { useArcadiaSubscription } from "@crema/arcadia-core-client";
function NotificationToasts() {
useArcadiaSubscription("notification", (n) => {
@@ -129,7 +129,7 @@ favourites, DNA-change subscriptions, notifications, search,
@-mention search), there's a typed wrapper over the generic client:
```ts
import { createArcadiaClient, createSocialBindings } from "@crema/arcadia-client";
import { createArcadiaClient, createSocialBindings } from "@crema/arcadia-core-client";
const client = createArcadiaClient({ baseUrl, getToken });
const social = createSocialBindings(client);
@@ -156,5 +156,5 @@ Realtime: the social write paths broadcast via Phoenix.PubSub →
## Conventions
- Inline imports only — no own `package.json` (lib lives by the consuming app's deps).
- Path-aliased into apps via `tsconfig.json` `paths`: `@crema/arcadia-client` → `../lib-arcadia-client/src/index.tsx`.
- Path-aliased into apps via `tsconfig.json` `paths`: `@crema/arcadia-core-client` → `../lib-arcadia-core-client/src/index.tsx`.
- Tailwind doesn't scan this lib — no UI; nothing to scan.