@alviere/ui 0.8.1

package/LICENSE

@@ -0,0 +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 2025 Alviere
+
+   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

@@ -0,0 +1,93 @@
+# Development Server Setup
+
+This guide explains how to set up and run the Alviere UI Svelte development server.
+
+## Prerequisites
+
+- Node.js 22+ and pnpm installed
+- Alviere API credentials (client ID, client secret, and an account UUID that shoudl represent a Payee)
+
+## Quick Start
+
+### 1. Create Environment File
+
+Copy the example environment file and fill in your credentials:
+
+```bash
+cd packages/ui
+cp .env.example .env
+```
+
+### 2. Add Your Credentials
+
+Edit `.env` and add your Alviere API credentials:
+
+```env
+ALVIERE_CLIENT_ID=your-client-id-here
+ALVIERE_CLIENT_SECRET=your-client-secret-here
+ALVIERE_ACCOUNT_UUID=your-account-uuid-here
+```
+
+**⚠️ IMPORTANT:** Never commit the `.env` file to version control! It contains sensitive credentials.
+
+### 3. Start the Development Server
+
+```bash
+# From the ui package directory
+pnpm run dev:server
+
+# Or from the monorepo root
+pnpm --filter @alviere/ui dev:server
+```
+
+The development server will start on `http://localhost:8000`
+
+## Available Scripts
+
+- `pnpm run dev:server` - Start the Express development server
+- `pnpm run dev` - Start Vite development server (for component development)
+
+**For more information on how the dev server is setup [see here](./dev/README.md)**
+
+## Environment Variables
+
+| Variable                | Required | Default                               | Description                     |
+| ----------------------- | -------- | ------------------------------------- | ------------------------------- |
+| `ALVIERE_CLIENT_ID`     | ✅ Yes   | -                                     | Your Alviere API client ID      |
+| `ALVIERE_CLIENT_SECRET` | ✅ Yes   | -                                     | Your Alviere API client secret  |
+| `ALVIERE_ACCOUNT_UUID`  | ✅ Yes   | -                                     | Your Alviere account UUID       |
+| `ALVIERE_AUTH_URL`      | No       | `https://api.dev.alviere.com/v3/auth` | Alviere authentication endpoint |
+| `PORT`                  | No       | `8000`                                | Development server port         |
+
+**⚠️ IMPORTANT:** Bear in mind that all subsquent requests will be made to the same environment the auth was made, since, behind the curtains the CORE package will use the key `api_domain` retrieved from the auth JWT.
+
+## Getting Credentials
+
+To get your Alviere API credentials:
+
+1. Get in touch with your contact point from Alviere to get the Client_ID, Client_Secret and Starting Account UUID (If you don't have one already)
+
+## Troubleshooting
+
+### "Missing required environment variables" error
+
+If you see this error, make sure:
+
+1. You've created a `.env` file in `packages/ui/`
+2. All three required variables are set in the `.env` file
+3. The `.env` file has no typos in variable names
+
+### Server won't start
+
+- Check that port 8000 is not already in use
+- Try setting a different port: `PORT=3000 pnpm run dev:server`
+- Ensure you've run `pnpm install` in the workspace root
+
+**⚠️ IMPORTANT:** Bear in mind that port 8000 is CORS cleared, other ports might not be and if you really need a different port you'll need to contact Alviere as this needs a case-by-case decision and it's based on necessity.
+
+## Security Notes
+
+- The `.env` file is already in `.gitignore` and will not be committed
+- Never share your credentials publicly or in code repositories
+- Use different credentials for development, staging, and production environments
+- Rotate credentials regularly and if they're ever exposed

package/dist/index.d.ts

@@ -0,0 +1,133 @@
+import { AlviereCoreConfig } from '@alviere/core';
+import { PaymentInstrument } from '@alviere/core';
+import { PaymentInstrumentRequest } from '@alviere/core';
+import { PaymentInstrumentResponse } from '@alviere/core';
+import { SvelteComponentTyped } from 'svelte';
+
+export { AlviereCoreConfig }
+
+export declare interface BaseInputEvent {
+    value: string;
+    rawValue: string;
+    isValid: boolean;
+}
+
+export declare interface CardInputEvent extends BaseInputEvent {
+    cardType: CardType | null;
+}
+
+export declare interface CardType {
+    name: string;
+    icon: string;
+    pattern: RegExp;
+    gaps: number[];
+    lengths: number[];
+    code: string;
+}
+
+/**
+ * Configure token injection behavior and apply custom tokens.
+ * Call this BEFORE the web components load, or it will re-inject tokens.
+ *
+ * @example
+ * ```typescript
+ * configureTokens({
+ *   theme: 'dark',
+ *   customTokens: {
+ *     '--color-primary': '#8b5cf6',
+ *     '--color-background': '#1f2937'
+ *   }
+ * });
+ * ```
+ */
+export declare function configureTokens(config: TokensConfig): void;
+
+export declare interface CvvInputEvent extends BaseInputEvent {
+    cardType?: CardType | null;
+}
+
+export declare interface ExpiryInputEvent extends BaseInputEvent {
+    month?: string;
+    year?: string;
+}
+
+export declare type FieldSize = 'sm' | 'md' | 'lg';
+
+export declare interface FlowConfig {
+    steps: FlowStep[];
+    amount?: number;
+    title?: string;
+    description?: string;
+    allowSkip?: boolean;
+    allowBack?: boolean;
+    showProgress?: boolean;
+    showNavigation?: boolean;
+}
+
+export declare interface FlowEvent {
+    stepIndex: number;
+    stepType: StepType;
+    result: any;
+    error?: Error;
+}
+
+export declare interface FlowState {
+    currentStepIndex: number;
+    completedSteps: number[];
+    stepResults: Record<number, any>;
+    isComplete: boolean;
+}
+
+export declare interface FlowStep {
+    label: string;
+    type: StepType;
+    config?: Record<string, any>;
+}
+
+export { PaymentInstrument }
+
+export { PaymentInstrumentRequest }
+
+export { PaymentInstrumentResponse }
+
+export declare type StepStatus = 'INCOMPLETE' | 'COMPLETE' | 'IN_PROGRESS' | 'ERROR';
+
+export declare type StepType = 'CREATE_ACCOUNT' | 'CREATE_CONSUMER_ACCOUNT' | 'CREATE_BUSINESS_ACCOUNT' | 'ADD_BANK_ACCOUNT' | 'ADD_PAYMENT_INSTRUMENT' | 'BANK_ACCOUNTS' | 'CHECKOUT_CONFIRM';
+
+export { SvelteComponentTyped as AddBankAccount }
+export { SvelteComponentTyped as AddPaymentInstrument }
+export { SvelteComponentTyped as Badge }
+export { SvelteComponentTyped as Button }
+export { SvelteComponentTyped as CardCVVInput }
+export { SvelteComponentTyped as CardExpInput }
+export { SvelteComponentTyped as CardPanInput }
+export { SvelteComponentTyped as Checkbox }
+export { SvelteComponentTyped as CheckoutConfirm }
+export { SvelteComponentTyped as CreateConsumerAccount }
+export { SvelteComponentTyped as CurrencyInput }
+export { SvelteComponentTyped as DateOfBirthInput }
+export { SvelteComponentTyped as ErrorBoundary }
+export { SvelteComponentTyped as FormErrorBoundary }
+export { SvelteComponentTyped as MultiStepFlow }
+export { SvelteComponentTyped as PhoneInput }
+export { SvelteComponentTyped as Spinner }
+export { SvelteComponentTyped as TextInput }
+export { SvelteComponentTyped as Timeline }
+
+/**
+ * Configuration options for token injection
+ */
+export declare interface TokensConfig {
+    /** Predefined theme name (if you have theme presets) */
+    theme?: string;
+    /** Custom token overrides as CSS custom property key-value pairs */
+    customTokens?: Record<string, string>;
+    /** Disable automatic token injection */
+    disableAutoInject?: boolean;
+}
+
+export declare type ValidationState = 'valid' | 'invalid' | 'neutral';
+
+export declare const version = "1.0.0";
+
+export { }