@coinlist-co/react 0.12.2-rc.e1f6c82 → 0.12.2

package/README.md

@@ -1,49 +1,85 @@
-# CoinList React SDK
+# This package has moved to `@passage-cl/react`
 
-This package is documented at:
-
-https://docs.coinlist.co/
-
-Please refer to the docs site for installation, configuration, and integration guides.
-
-## Local development
-
-The toolchain (Node 24, TypeScript) is pinned by `flake.nix` and frozen by `flake.lock`.
-
-Prerequisites:
-
-1. Nix — install with the [Determinate Systems installer](https://github.com/DeterminateSystems/nix-installer),
-   which enables flakes out of the box and supports clean uninstalls:
-
-   ```bash
-   curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
-   ```
-
-2. [direnv](https://direnv.net/) and [nix-direnv](https://github.com/nix-community/nix-direnv)
-   (direnv on its own does not provide `use flake`).
-
-```bash
-direnv allow   # activates the dev shell on every cd into the repo
-```
-
-Without direnv, enter the same shell manually:
-
-```bash
-nix develop
-```
-
-The flake provides the toolchain, not `node_modules` — install JS dependencies as usual:
+> **`@coinlist-co/react` is deprecated and will receive no further releases.**
+> The SDK continues as [`@passage-cl/react`](https://www.npmjs.com/package/@passage-cl/react).
 
 ```bash
-npm ci
+npm uninstall @coinlist-co/react
+npm install @passage-cl/react
 ```
 
-## Git hooks
-
-The dev shell includes [pre-commit](https://pre-commit.com/). Register the push hook once:
-
-```bash
-pre-commit install --hook-type pre-push
+`0.12.2` is functionally identical to `0.12.1`: it only updates this README.
+There will be no further releases under the `@coinlist-co/react` name.
+
+## Migrating
+
+`@passage-cl/react` starts at `0.13.0` and is a clean break: there are no
+aliases for the old names, so every import and every renamed symbol below has
+to be updated. Everything not listed keeps its name.
+
+### Import paths
+
+| `@coinlist-co/react` | `@passage-cl/react` |
+|---|---|
+| `@coinlist-co/react` | `@passage-cl/react` |
+| `@coinlist-co/react/universal` | `@passage-cl/react/universal` |
+| `@coinlist-co/react/server` | `@passage-cl/react/server` |
+
+### Renamed exports
+
+| Old | New |
+|---|---|
+| `CoinListProvider` | `PassageProvider` |
+| `CoinListProviderProps` | `PassageProviderProps` |
+| `useCoinList` | `usePassage` |
+| `UseCoinListResult` | `UsePassageResult` |
+| `UseCoinListResult.coinlist` | `UsePassageResult.passage` |
+| `CoinListClient` | `PassageClient` |
+| `createCoinListClient` | `createPassageClient` |
+| `CoinListClientInitializationError` | `PassageClientInitializationError` |
+| `CoinListServer` | `PassageServer` |
+| `createCoinListServer` | `createPassageServer` |
+| `CoinListStyleScope` | `PassageStyleScope` |
+| `CoinListStyleScopeProps` | `PassageStyleScopeProps` |
+
+### CSS and other host-visible names
+
+Hosts that override the SDK's styles, or filter its logs, must update them:
+
+| What | Old | New |
+|---|---|---|
+| Scope class | `.clco-sdk-root` | `.pcl-sdk-root` |
+| Utility class prefix | `clcosdk:` (e.g. `clcosdk:flex`) | `pclsdk:` (e.g. `pclsdk:flex`) |
+| Theme variables | `--clcosdk-*` | `--pclsdk-*` |
+| Injected `<style>` key | `clco-sdk-styles` | `pcl-sdk-styles` |
+| Pino logger `name` | `@coinlist-co/react` | `@passage-cl/react` |
+
+### Unchanged
+
+Names that refer to CoinList the company, rather than to the SDK, keep their
+names:
+
+- everything about the CoinList token sale, such as `CoinListTokenSale*`,
+  `ClientCoinListTokenSaleNamespace` and
+  `LoadCoinListTokenSaleParticipationsState` (for example `CoinListTokenSaleNamespace`,
+  `CoinListTokenSaleOffer`, `useCoinListTokenSaleCheckoutViewModel`)
+- `CoinListSignInButton`
+- `CoinListSignInCard*` (for example `CoinListSignInCardContainer`,
+  `useCoinListSignInCardViewModel`)
+- the `coinlistFee` field and the "CoinList fee" copy
+- the `coinlistBaseUrl` config field
+- the `coinlist::*` offer types
+
+### Example
+
+```diff
+-import { CoinListProvider, useCoinList } from '@coinlist-co/react';
+-import { createCoinListServer } from '@coinlist-co/react/server';
++import { PassageProvider, usePassage } from '@passage-cl/react';
++import { createPassageServer } from '@passage-cl/react/server';
+
+-const { coinlist } = useCoinList();
+-await coinlist.offers.list();
++const { passage } = usePassage();
++await passage.offers.list();
 ```
-
-The hook runs typecheck, Biome, and deslop.