@sendlix/group 0.0.1 → 1.0.0

package/LICENSE

@@ -1,201 +1,201 @@
-                                 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.
+                                 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/README.md

@@ -1,222 +1,222 @@
-# @sendlix/group
-
-> Subscribe users to Sendlix mailing groups – with optional Proof-of-Work bot protection and ready-made React components.
-
-[![npm](https://img.shields.io/npm/v/@sendlix/group)](https://www.npmjs.com/package/@sendlix/group)
-[![license](https://img.shields.io/npm/l/@sendlix/group)](LICENSE)
-
-## Installation
-
-```bash
-npm install @sendlix/group
-```
-
-React components are included in the same package and available via the `/react` sub-path:
-
-```bash
-# No extra install needed – React is a peer dependency
-npm install react
-```
-
----
-
-## Quick start
-
-### Subscribe an email address
-
-```ts
-import { subscribeToGroup } from "@sendlix/group";
-
-const result = await subscribeToGroup({
-  id: "your-group-id",
-  email: "user@example.com",
-});
-// { success: true, code: 0, message: "Email added to group" }
-```
-
-### With Proof-of-Work bot protection
-
-```ts
-import { subscribeToGroup, ProofOfWork } from "@sendlix/group";
-
-const pow = new ProofOfWork("your-group-id");
-
-// Pre-warm the WebGPU pipeline (optional, call on page load)
-pow.init();
-
-const { token, nonce } = await pow.solve("user@example.com");
-
-const result = await subscribeToGroup({
-  id: "your-group-id",
-  email: "user@example.com",
-  botProtection: { type: "proofOfWork", token, nonce },
-});
-
-// Release resources when done
-pow.close();
-```
-
-### With template placeholders
-
-```ts
-await subscribeToGroup({
-  id: "your-group-id",
-  email: "user@example.com",
-  substitute: {
-    "##First Name##": "Alice",
-    "##Last Name##": "Smith",
-  },
-});
-```
-
----
-
-## React components
-
-### `GroupIframe` – embed the hosted form
-
-```tsx
-import { GroupIframe } from "@sendlix/group/react";
-
-<GroupIframe
-  id="your-group-id"
-  appearance={{
-    primaryColor: "oklch(0.65 0.12 87)",
-    backgroundColor: "white",
-    textColor: "black",
-    name: "Newsletter",
-    info: "No spam, unsubscribe at any time.",
-  }}
-/>;
-```
-
-The iframe resizes automatically when the hosted form changes height. All standard `<iframe>` attributes are forwarded.
-
-| Prop          | Type         | Default | Description                 |
-| ------------- | ------------ | ------- | --------------------------- |
-| `id`          | `string`     | –       | Group ID                    |
-| `appearance`  | `Appearance` | –       | Visual customisation        |
-| `startHeight` | `number`     | `500`   | Initial iframe height in px |
-
-### `ProofOfWorkInput` – drop-in email input with PoW
-
-A replacement for `<input type="email">` that automatically runs the Proof-of-Work challenge on blur and injects hidden `pow-token` / `pow-nonce` fields into the surrounding `<form>`.
-
-```tsx
-import { ProofOfWorkInput } from "@sendlix/group/react";
-
-function SubscribeForm() {
-  const [status, setStatus] = useState<string>();
-
-  return (
-    <form method="POST" action="https://group.sendlix.com/your-group-id">
-      <ProofOfWorkInput
-        sendlix={{ id: "your-group-id", onStatusChange: setStatus }}
-        placeholder="your@email.com"
-        required
-      />
-      {status === "loading" && <span>Solving challenge…</span>}
-      {status === "processing" && <span>Renewing token…</span>}
-      {status === "success" && <span>Ready</span>}
-      {status === "error" && <span>PoW failed</span>}
-      <button type="submit">Subscribe</button>
-    </form>
-  );
-}
-```
-
-| Prop                     | Type                          | Description                       |
-| ------------------------ | ----------------------------- | --------------------------------- |
-| `sendlix.id`             | `string`                      | Group ID                          |
-| `sendlix.onStatusChange` | `(status: PowStatus) => void` | Called on every status transition |
-
-All standard `<input>` attributes are forwarded to the underlying email input.
-
----
-
-## API reference
-
-### `subscribeToGroup(options)`
-
-```ts
-subscribeToGroup(options: {
-  id:              string;
-  email:           string;
-  substitute?:     Record<string, string>;
-  botProtection?:  { type: "proofOfWork"; token: string; nonce: string };
-}): Promise<GroupResponse>
-```
-
-### `subscribeToGroupWithFormData(data, id, substitute?)`
-
-```ts
-subscribeToGroupWithFormData(
-  data:       FormData,
-  id:         string,
-  substitute?: Record<string, string>,
-): Promise<GroupResponse>
-```
-
-Use this when you already have a native `<form>` and control the `FormData` yourself.
-
-### `ProofOfWork`
-
-```ts
-const pow = new ProofOfWork(groupId: string, options?: PowOptions);
-```
-
-**Options**
-
-| Option           | Type                          | Description                                             |
-| ---------------- | ----------------------------- | ------------------------------------------------------- |
-| `onStatusChange` | `(status: PowStatus) => void` | Called on every status change                           |
-| `onRenew`        | `(result: PowResult) => void` | Called when the token is silently renewed before expiry |
-
-**Methods**
-
-| Method             | Returns              | Description                                                            |
-| ------------------ | -------------------- | ---------------------------------------------------------------------- |
-| `pow.solve(email)` | `Promise<PowResult>` | Requests a challenge and solves it. Schedules automatic renewal.       |
-| `pow.init()`       | `void`               | Pre-warms the WebGPU pipeline. Call on component mount.                |
-| `pow.close()`      | `void`               | Cancels the renewal timer and releases GPU resources. Call on unmount. |
-
-Uses **WebGPU** when available for GPU-accelerated solving, with an automatic fallback to the **Web Crypto API** (CPU).
-
-### Types
-
-```ts
-type PowResult = { token: string; nonce: string };
-type PowStatus = "loading" | "processing" | "success" | "error";
-
-type GroupResponse = {
-  success: boolean;
-  code: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
-  message: string;
-};
-```
-
----
-
-## Development
-
-```bash
-npm install        # install dependencies
-npm test           # run Jest test suite
-npm run build      # compile TypeScript → ./dist
-```
-
-## Releases
-
-Releases are automated via [semantic-release](https://semantic-release.gitbook.io) on every push to `main`. Use [Conventional Commits](https://www.conventionalcommits.org) for your commit messages:
-
-| Prefix                        | Release type  |
-| ----------------------------- | ------------- |
-| `fix:`                        | Patch (0.0.x) |
-| `feat:`                       | Minor (0.x.0) |
-| `feat!:` / `BREAKING CHANGE:` | Major (x.0.0) |
-
-Required repository secrets: `NPM_TOKEN`.
-
-## License
-
+# @sendlix/group
+
+> Subscribe users to Sendlix mailing groups – with optional Proof-of-Work bot protection and ready-made React components.
+
+[![npm](https://img.shields.io/npm/v/@sendlix/group)](https://www.npmjs.com/package/@sendlix/group)
+[![license](https://img.shields.io/npm/l/@sendlix/group)](LICENSE)
+
+## Installation
+
+```bash
+npm install @sendlix/group
+```
+
+React components are included in the same package and available via the `/react` sub-path:
+
+```bash
+# No extra install needed – React is a peer dependency
+npm install react
+```
+
+---
+
+## Quick start
+
+### Subscribe an email address
+
+```ts
+import { subscribeToGroup } from "@sendlix/group";
+
+const result = await subscribeToGroup({
+  id: "your-group-id",
+  email: "user@example.com",
+});
+// { success: true, code: 0, message: "Email added to group" }
+```
+
+### With Proof-of-Work bot protection
+
+```ts
+import { subscribeToGroup, ProofOfWork } from "@sendlix/group";
+
+const pow = new ProofOfWork("your-group-id");
+
+// Pre-warm the WebGPU pipeline (optional, call on page load)
+pow.init();
+
+const { token, nonce } = await pow.solve("user@example.com");
+
+const result = await subscribeToGroup({
+  id: "your-group-id",
+  email: "user@example.com",
+  botProtection: { type: "proofOfWork", token, nonce },
+});
+
+// Release resources when done
+pow.close();
+```
+
+### With template placeholders
+
+```ts
+await subscribeToGroup({
+  id: "your-group-id",
+  email: "user@example.com",
+  substitute: {
+    "##First Name##": "Alice",
+    "##Last Name##": "Smith",
+  },
+});
+```
+
+---
+
+## React components
+
+### `GroupIframe` – embed the hosted form
+
+```tsx
+import { GroupIframe } from "@sendlix/group/react";
+
+<GroupIframe
+  id="your-group-id"
+  appearance={{
+    primaryColor: "oklch(0.65 0.12 87)",
+    backgroundColor: "white",
+    textColor: "black",
+    name: "Newsletter",
+    info: "No spam, unsubscribe at any time.",
+  }}
+/>;
+```
+
+The iframe resizes automatically when the hosted form changes height. All standard `<iframe>` attributes are forwarded.
+
+| Prop          | Type         | Default | Description                 |
+| ------------- | ------------ | ------- | --------------------------- |
+| `id`          | `string`     | –       | Group ID                    |
+| `appearance`  | `Appearance` | –       | Visual customisation        |
+| `startHeight` | `number`     | `500`   | Initial iframe height in px |
+
+### `ProofOfWorkInput` – drop-in email input with PoW
+
+A replacement for `<input type="email">` that automatically runs the Proof-of-Work challenge on blur and injects hidden `pow-token` / `pow-nonce` fields into the surrounding `<form>`.
+
+```tsx
+import { ProofOfWorkInput } from "@sendlix/group/react";
+
+function SubscribeForm() {
+  const [status, setStatus] = useState<string>();
+
+  return (
+    <form method="POST" action="https://group.sendlix.com/your-group-id">
+      <ProofOfWorkInput
+        sendlix={{ id: "your-group-id", onStatusChange: setStatus }}
+        placeholder="your@email.com"
+        required
+      />
+      {status === "loading" && <span>Solving challenge…</span>}
+      {status === "processing" && <span>Renewing token…</span>}
+      {status === "success" && <span>Ready</span>}
+      {status === "error" && <span>PoW failed</span>}
+      <button type="submit">Subscribe</button>
+    </form>
+  );
+}
+```
+
+| Prop                     | Type                          | Description                       |
+| ------------------------ | ----------------------------- | --------------------------------- |
+| `sendlix.id`             | `string`                      | Group ID                          |
+| `sendlix.onStatusChange` | `(status: PowStatus) => void` | Called on every status transition |
+
+All standard `<input>` attributes are forwarded to the underlying email input.
+
+---
+
+## API reference
+
+### `subscribeToGroup(options)`
+
+```ts
+subscribeToGroup(options: {
+  id:              string;
+  email:           string;
+  substitute?:     Record<string, string>;
+  botProtection?:  { type: "proofOfWork"; token: string; nonce: string };
+}): Promise<GroupResponse>
+```
+
+### `subscribeToGroupWithFormData(data, id, substitute?)`
+
+```ts
+subscribeToGroupWithFormData(
+  data:       FormData,
+  id:         string,
+  substitute?: Record<string, string>,
+): Promise<GroupResponse>
+```
+
+Use this when you already have a native `<form>` and control the `FormData` yourself.
+
+### `ProofOfWork`
+
+```ts
+const pow = new ProofOfWork(groupId: string, options?: PowOptions);
+```
+
+**Options**
+
+| Option           | Type                          | Description                                             |
+| ---------------- | ----------------------------- | ------------------------------------------------------- |
+| `onStatusChange` | `(status: PowStatus) => void` | Called on every status change                           |
+| `onRenew`        | `(result: PowResult) => void` | Called when the token is silently renewed before expiry |
+
+**Methods**
+
+| Method             | Returns              | Description                                                            |
+| ------------------ | -------------------- | ---------------------------------------------------------------------- |
+| `pow.solve(email)` | `Promise<PowResult>` | Requests a challenge and solves it. Schedules automatic renewal.       |
+| `pow.init()`       | `void`               | Pre-warms the WebGPU pipeline. Call on component mount.                |
+| `pow.close()`      | `void`               | Cancels the renewal timer and releases GPU resources. Call on unmount. |
+
+Uses **WebGPU** when available for GPU-accelerated solving, with an automatic fallback to the **Web Crypto API** (CPU).
+
+### Types
+
+```ts
+type PowResult = { token: string; nonce: string };
+type PowStatus = "loading" | "processing" | "success" | "error";
+
+type GroupResponse = {
+  success: boolean;
+  code: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
+  message: string;
+};
+```
+
+---
+
+## Development
+
+```bash
+npm install        # install dependencies
+npm test           # run Jest test suite
+npm run build      # compile TypeScript → ./dist
+```
+
+## Releases
+
+Releases are automated via [semantic-release](https://semantic-release.gitbook.io) on every push to `main`. Use [Conventional Commits](https://www.conventionalcommits.org) for your commit messages:
+
+| Prefix                        | Release type  |
+| ----------------------------- | ------------- |
+| `fix:`                        | Patch (0.0.x) |
+| `feat:`                       | Minor (0.x.0) |
+| `feat!:` / `BREAKING CHANGE:` | Major (x.0.0) |
+
+Required repository secrets: `NPM_TOKEN`.
+
+## License
+
 Apache License 2.0. See [LICENSE](LICENSE) for details.

package/dist/proof-of-work.js

@@ -1,75 +1,75 @@
-const SHADER_CODE = /* wgsl */ `
-const K = array<u32, 64>(
-  0x428a2f98u, 0x71374491u, 0xb5c0fbcfu, 0xe9b5dba5u,
-  0x3956c25bu, 0x59f111f1u, 0x923f82a4u, 0xab1c5ed5u,
-  0xd807aa98u, 0x12835b01u, 0x243185beu, 0x550c7dc3u,
-  0x72be5d74u, 0x80deb1feu, 0x9bdc06a7u, 0xc19bf174u,
-  0xe49b69c1u, 0xefbe4786u, 0x0fc19dc6u, 0x240ca1ccu,
-  0x2de92c6fu, 0x4a7484aau, 0x5cb0a9dcu, 0x76f988dau,
-  0x983e5152u, 0xa831c66du, 0xb00327c8u, 0xbf597fc7u,
-  0xc6e00bf3u, 0xd5a79147u, 0x06ca6351u, 0x14292967u,
-  0x27b70a85u, 0x2e1b2138u, 0x4d2c6dfcu, 0x53380d13u,
-  0x650a7354u, 0x766a0abbu, 0x81c2c92eu, 0x92722c85u,
-  0xa2bfe8a1u, 0xa81a664bu, 0xc24b8b70u, 0xc76c51a3u,
-  0xd192e819u, 0xd6990624u, 0xf40e3585u, 0x106aa070u,
-  0x19a4c116u, 0x1e376c08u, 0x2748774cu, 0x34b0bcb5u,
-  0x391c0cb3u, 0x4ed8aa4au, 0x5b9cca4fu, 0x682e6ff3u,
-  0x748f82eeu, 0x78a5636fu, 0x84c87814u, 0x8cc70208u,
-  0x90befffau, 0xa4506cebu, 0xbef9a3f7u, 0xc67178f2u
-);
-
-struct Params    { nonce_base : u32, difficulty : u32, _p0 : u32, _p1 : u32 }
-struct TokenData { w : array<vec4<u32>, 2>                                   }
-struct Result    { found : atomic<u32>                                        }
-
-@group(0) @binding(0) var<uniform>             params : Params;
-@group(0) @binding(1) var<uniform>             tok    : TokenData;
-@group(0) @binding(2) var<storage, read_write> res    : Result;
-
-fn rotr(x : u32, n : u32) -> u32 { return (x >> n) | (x << (32u - n)); }
-
-fn sha256_h0(nonce : u32) -> u32 {
-  var w : array<u32, 64>;
-  w[0] = tok.w[0].x; w[1] = tok.w[0].y; w[2] = tok.w[0].z; w[3] = tok.w[0].w;
-  w[4] = tok.w[1].x; w[5] = tok.w[1].y; w[6] = tok.w[1].z; w[7] = tok.w[1].w;
-  w[8]  = nonce;
-  w[9]  = 0x80000000u;
-  w[14] = 0u;
-  w[15] = 288u;
-
-  for (var i = 16u; i < 64u; i++) {
-    let s0 = rotr(w[i-15u],  7u) ^ rotr(w[i-15u], 18u) ^ (w[i-15u] >>  3u);
-    let s1 = rotr(w[i - 2u],17u) ^ rotr(w[i - 2u], 19u) ^ (w[i - 2u] >> 10u);
-    w[i]   = w[i-16u] + s0 + w[i-7u] + s1;
-  }
-
-  var a = 0x6a09e667u; var b = 0xbb67ae85u;
-  var c = 0x3c6ef372u; var d = 0xa54ff53au;
-  var e = 0x510e527fu; var f = 0x9b05688cu;
-  var g = 0x1f83d9abu; var h = 0x5be0cd19u;
-
-  for (var i = 0u; i < 64u; i++) {
-    let S1  = rotr(e, 6u) ^ rotr(e, 11u) ^ rotr(e, 25u);
-    let ch  = (e & f) ^ (~e & g);
-    let t1  = h + S1 + ch + K[i] + w[i];
-    let S0  = rotr(a, 2u) ^ rotr(a, 13u) ^ rotr(a, 22u);
-    let maj = (a & b) ^ (a & c) ^ (b & c);
-    h = g; g = f; f = e; e = d + t1;
-    d = c; c = b; b = a; a = t1 + S0 + maj;
-  }
-
-  return 0x6a09e667u + a;
-}
-
-@compute @workgroup_size(256)
-fn main(@builtin(global_invocation_id) gid : vec3<u32>) {
-  let nonce = params.nonce_base + gid.x;
-  let h0    = sha256_h0(nonce);
-  let shift = 32u - params.difficulty * 4u;
-  if ((h0 >> shift) == 0u) {
-    atomicMin(&res.found, nonce);
-  }
-}
+const SHADER_CODE = /* wgsl */ `
+const K = array<u32, 64>(
+  0x428a2f98u, 0x71374491u, 0xb5c0fbcfu, 0xe9b5dba5u,
+  0x3956c25bu, 0x59f111f1u, 0x923f82a4u, 0xab1c5ed5u,
+  0xd807aa98u, 0x12835b01u, 0x243185beu, 0x550c7dc3u,
+  0x72be5d74u, 0x80deb1feu, 0x9bdc06a7u, 0xc19bf174u,
+  0xe49b69c1u, 0xefbe4786u, 0x0fc19dc6u, 0x240ca1ccu,
+  0x2de92c6fu, 0x4a7484aau, 0x5cb0a9dcu, 0x76f988dau,
+  0x983e5152u, 0xa831c66du, 0xb00327c8u, 0xbf597fc7u,
+  0xc6e00bf3u, 0xd5a79147u, 0x06ca6351u, 0x14292967u,
+  0x27b70a85u, 0x2e1b2138u, 0x4d2c6dfcu, 0x53380d13u,
+  0x650a7354u, 0x766a0abbu, 0x81c2c92eu, 0x92722c85u,
+  0xa2bfe8a1u, 0xa81a664bu, 0xc24b8b70u, 0xc76c51a3u,
+  0xd192e819u, 0xd6990624u, 0xf40e3585u, 0x106aa070u,
+  0x19a4c116u, 0x1e376c08u, 0x2748774cu, 0x34b0bcb5u,
+  0x391c0cb3u, 0x4ed8aa4au, 0x5b9cca4fu, 0x682e6ff3u,
+  0x748f82eeu, 0x78a5636fu, 0x84c87814u, 0x8cc70208u,
+  0x90befffau, 0xa4506cebu, 0xbef9a3f7u, 0xc67178f2u
+);
+
+struct Params    { nonce_base : u32, difficulty : u32, _p0 : u32, _p1 : u32 }
+struct TokenData { w : array<vec4<u32>, 2>                                   }
+struct Result    { found : atomic<u32>                                        }
+
+@group(0) @binding(0) var<uniform>             params : Params;
+@group(0) @binding(1) var<uniform>             tok    : TokenData;
+@group(0) @binding(2) var<storage, read_write> res    : Result;
+
+fn rotr(x : u32, n : u32) -> u32 { return (x >> n) | (x << (32u - n)); }
+
+fn sha256_h0(nonce : u32) -> u32 {
+  var w : array<u32, 64>;
+  w[0] = tok.w[0].x; w[1] = tok.w[0].y; w[2] = tok.w[0].z; w[3] = tok.w[0].w;
+  w[4] = tok.w[1].x; w[5] = tok.w[1].y; w[6] = tok.w[1].z; w[7] = tok.w[1].w;
+  w[8]  = nonce;
+  w[9]  = 0x80000000u;
+  w[14] = 0u;
+  w[15] = 288u;
+
+  for (var i = 16u; i < 64u; i++) {
+    let s0 = rotr(w[i-15u],  7u) ^ rotr(w[i-15u], 18u) ^ (w[i-15u] >>  3u);
+    let s1 = rotr(w[i - 2u],17u) ^ rotr(w[i - 2u], 19u) ^ (w[i - 2u] >> 10u);
+    w[i]   = w[i-16u] + s0 + w[i-7u] + s1;
+  }
+
+  var a = 0x6a09e667u; var b = 0xbb67ae85u;
+  var c = 0x3c6ef372u; var d = 0xa54ff53au;
+  var e = 0x510e527fu; var f = 0x9b05688cu;
+  var g = 0x1f83d9abu; var h = 0x5be0cd19u;
+
+  for (var i = 0u; i < 64u; i++) {
+    let S1  = rotr(e, 6u) ^ rotr(e, 11u) ^ rotr(e, 25u);
+    let ch  = (e & f) ^ (~e & g);
+    let t1  = h + S1 + ch + K[i] + w[i];
+    let S0  = rotr(a, 2u) ^ rotr(a, 13u) ^ rotr(a, 22u);
+    let maj = (a & b) ^ (a & c) ^ (b & c);
+    h = g; g = f; f = e; e = d + t1;
+    d = c; c = b; b = a; a = t1 + S0 + maj;
+  }
+
+  return 0x6a09e667u + a;
+}
+
+@compute @workgroup_size(256)
+fn main(@builtin(global_invocation_id) gid : vec3<u32>) {
+  let nonce = params.nonce_base + gid.x;
+  let h0    = sha256_h0(nonce);
+  let shift = 32u - params.difficulty * 4u;
+  if ((h0 >> shift) == 0u) {
+    atomicMin(&res.found, nonce);
+  }
+}
 `;
 function hexToTokenWords(hex) {
     const u32 = new Uint32Array(8);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sendlix/group",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Sendlix Group SDK – subscribe users to mailing groups with optional Proof-of-Work bot protection.",
   "license": "Apache-2.0",
   "type": "module",
@@ -10,14 +10,14 @@
   "sideEffects": false,
   "repository": {
     "type": "git",
-    "url": "https://github.com/sendlix/group-subscription-sdk.git"
+    "url": "git+https://github.com/sendlix/group-subscription-sdk.git"
   },
   "exports": {
     ".": {
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
-    "./ct": {
+    "./react": {
       "import": "./dist/react/index.js",
       "types": "./dist/react/index.d.ts"
     }