@cauthyhq/react 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,3 @@
+Copyright 2026 Vennet Developers
+
+Licensed under the Apache License, Version 2.0. See LICENSE.

package/README.md

@@ -1,3 +1,71 @@
-# Temporary Holding Version
+# @cauthyhq/react
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Cauthy for React: who is signed in, ready-made sign-in, account and organization screens in a default theme you can restyle, and headless hooks for screens of your own. Built on [`@cauthyhq/js`](https://github.com/vennet-developers/cauthy-sdk-js); talks only to your own server under `/api/auth` (served by [`@cauthyhq/node`](https://github.com/vennet-developers/cauthy-sdk-node) or `cauthy-sdk-go`). The browser never holds a token.
+
+```bash
+npm install @cauthyhq/react
+```
+
+React 18 or 19. ESM and CommonJS. Every part is marked `'use client'`.
+
+## Five lines
+
+```tsx
+import { CauthyProvider, SignIn, UserButton } from '@cauthyhq/react'
+import '@cauthyhq/react/styles.css'
+
+<CauthyProvider>
+  <UserButton accountHref="/account" signInHref="/sign-in" />
+  <SignIn returnTo="/" />
+</CauthyProvider>
+```
+
+What the form offers (password, passkeys, a sign-in link, Google, your company's SSO, a second step, "keep me signed in") is what the workspace has switched on in Cauthy's dashboard: no code changes when it changes.
+
+## Parts
+
+| Part | What it is |
+| --- | --- |
+| `SignIn`, `SignUp`, `ForgotPassword`, `ResetPassword`, `VerifyEmail`, `AcceptInvite`, `PendingTerms`, `GoogleOneTap` | The sign-in screens |
+| `Account` and `AccountProfile`, `AccountEmail`, `AccountPassword`, `AccountSecondStep`, `AccountPhone`, `AccountPasskeys`, `AccountLinked`, `AccountAgents`, `AccountSessions` | The person's account, whole or one part |
+| `Organizations`, `OrganizationMembers` | The person's organizations, and their people |
+| `UserButton` | Initials and a menu: the account, sign out |
+
+Hooks: `useSession()`, `useAuth()` (every call of the protocol, the session following), `useOrganizations()`, `useSignInFlow()` (the steps of a sign-in, driven by the server's `next`, for a form of your own), and `can(organization, 'deals', 'write')`.
+
+## Look
+
+`styles.css` draws everything inside `:where()`, so any rule of yours wins. Colours, corners and typeface are `--cauthy-*` variables, set by default to what the workspace chose in Cauthy's dashboard. Your own look, for every part: `<CauthyProvider theme={…}>`. From a stackmyth or shadcn stylesheet: `theme={themeFromStackmyth(css).theme}` or `themeFromCss(css).theme`. Or draw them with your own components (`components`), classes (`classNames`), or none of ours (`unstyled`).
+
+## Server rendering
+
+Next.js app router: put `<CauthyProvider initialSession={session}>` in a layout (the session your server read with `@cauthyhq/node`), and use the parts in any page. TanStack Start and any React server renderer: the same; no part touches the browser while rendering. Import functions such as `can` from `@cauthyhq/js` in server code: everything in this package is a client module.
+
+## Accessibility
+
+Every input is labelled; an error is announced in a live region; the first wrong field takes the focus and names its error; the user menu follows the WAI-ARIA menu button pattern. Checked with axe-core on every `npm test`.
+
+## Moving from `cauthy-auth/react`
+
+Change the import: every component, prop and hook of `cauthy-auth/react` 0.42 is here with the same names. `import 'cauthy-auth/styles.css'` becomes `import '@cauthyhq/react/styles.css'`.
+
+## The browser suite
+
+The Playwright suite (`e2e/`) runs on a developer's machine, not in CI. **Before a release: `npm run e2e:node`**, which drives the demo application against `@cauthyhq/node` in Chromium, Firefox and WebKit (`npx playwright install chromium firefox webkit` once). `npm run e2e:fixture` replays the protocol recorded from it (`e2e/fixture/auth-bff.v1.json`) with no backend, and `npm run e2e:record` records it again. CI checks the recording itself against the spec's route table, with no browser (`e2e/fixture/fixture.test.ts`, part of `npm test`).
+
+### The suite against another backend
+
+`E2E_BACKEND=go GO_BFF_URL=http://localhost:4301 GO_BFF_CMD="<command>" npm run e2e:go`. The backend the command starts must:
+
+1. serve auth-bff version 1 at level `strict` under `/api/auth` on the port of `GO_BFF_URL`, answering `GET /api/auth/session` with `200` once ready;
+2. take `E2E_ORIGIN` (`http://localhost:4100`, the proxy the browser sees) as its origin, with cookies without `Secure`;
+3. know the accounts of `e2e/accounts.ts`: `member@example.com` (no second step, owner of the organization `3b2f6c1e-8d4a-4c7e-9f10-2a6b5c8d9e01` "Acme Sales" of system `acme-crm`, permissions `deals:read`, `deals:write`, `cauthy:members:*`, `cauthy:organization:*`) and `mfa@example.com` (TOTP, code `123456`), password `acme-e2e-password-1`; sign-ups open, a repeated sign-up with the same password succeeding;
+4. need no network.
+
+## Package size
+
+`npm run check:package` holds every JavaScript entry to 45 kB gzipped (React and `@cauthyhq/js` are not in it: they are the application's own copies).
+
+## License
+
+Apache-2.0. See `LICENSE` and `NOTICE`.