diff --git a/README.md b/README.md index 39da08f..a9f5399 100644 --- a/README.md +++ b/README.md @@ -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"; { @@ -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. diff --git a/scripts/sync-spec.mjs b/scripts/sync-spec.mjs index abe3e94..27f0eb2 100644 --- a/scripts/sync-spec.mjs +++ b/scripts/sync-spec.mjs @@ -2,7 +2,7 @@ // Fetches the arcadia OpenAPI spec and regenerates ../src/generated/openapi.d.ts. // // Usage (from a consuming app, with arcadia reachable): -// node ../lib-arcadia-client/scripts/sync-spec.mjs +// node ../lib-arcadia-core-client/scripts/sync-spec.mjs // // Configurable via env: // ARCADIA_OPENAPI_URL default: http://localhost:4000/api/openapi