@sbc-connect/nuxt-pay 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @sbc-connect/nuxt-pay
 
+## 0.1.4
+
+### Patch Changes
+
+- Updated dependencies [[`9b8c225`](https://github.com/bcgov/connect-nuxt/commit/9b8c225a011e3c89c9b490e93a554f55a4e29b78)]:
+  - @sbc-connect/nuxt-auth@0.1.4
+
+## 0.1.3
+
+### Patch Changes
+
+- [#9](https://github.com/bcgov/connect-nuxt/pull/9) [`e841fde`](https://github.com/bcgov/connect-nuxt/commit/e841fde27630d63efb2c152cd78d92b1193d1d5e) Thanks [@kialj876](https://github.com/kialj876)! - Add Nuxt back as a dev dependency
+
+- [#8](https://github.com/bcgov/connect-nuxt/pull/8) [`c85ebfc`](https://github.com/bcgov/connect-nuxt/commit/c85ebfc879e19cce307b109c9d38044f71f482d2) Thanks [@kialj876](https://github.com/kialj876)! - Added in i18n, added base header components, added in styles for nuxt ui
+
+- Updated dependencies [[`e841fde`](https://github.com/bcgov/connect-nuxt/commit/e841fde27630d63efb2c152cd78d92b1193d1d5e), [`c85ebfc`](https://github.com/bcgov/connect-nuxt/commit/c85ebfc879e19cce307b109c9d38044f71f482d2)]:
+  - @sbc-connect/nuxt-auth@0.1.3
+
 ## 0.1.2
 
 ### Patch Changes

package/README.md

@@ -1,73 +1,63 @@
-# Nuxt Layer Starter
+# @sbc-connect/nuxt-pay
+A Nuxt layer for handling fee calculation and payment processing within the Connect ecosystem.
 
-Create Nuxt extendable layer with this GitHub template.
+This package provides the necessary components, composables, and service integrations to use the Connect payment flow, offering a standardized payment experience for all applications.
 
-## Setup
+## Features
 
-Make sure to install the dependencies:
+### Payment Integration
+- Utilities for fetching fees by payment code.
+- Components for displaying fee summaries and handling payment actions.
 
-```bash
-pnpm install
-```
-
-## Working on your layer
-
-Your layer is at the root of this repository, it is exactly like a regular Nuxt project, except you can publish it on NPM.
-
-The `.playground` directory should help you on trying your layer during development.
 
-Running `pnpm dev` will prepare and boot `.playground` directory, which imports your layer itself.
+### Core Development Assets
+- useConnectFeeStore() Pinia store for managing filing fees and payment status.
+- Composables for interacting with the payment API.
+- Pre-configured for handling different payment methods (Credit Card, PAD, etc.).
 
-## Distributing your layer
+For detailed usage and documentation, please see the [Pay Layer Docs](../../../docs/packages/layers/pay/intro.md).
 
-Your Nuxt layer is shaped exactly the same as any other Nuxt project, except you can publish it on NPM.
+## Usage
 
-To do so, you only have to check if `files` in `package.json` are valid, then run:
+### Install
 
 ```bash
-npm publish --access public
+pnpm install @sbc-connect/nuxt-pay
 ```
 
-Once done, your users will only have to run:
+### Configure
+Then add the dependency to `extends` in `nuxt.config`:
 
-```bash
-npm install --save your-layer
-```
-
-Then add the dependency to their `extends` in `nuxt.config`:
+> [!NOTE]
+> `@sbc-connect/nuxt-pay` already includes `@sbc-connect/nuxt-auth`, it is not necessary to install `@sbc-connect/nuxt-auth`.
 
 ```ts
 defineNuxtConfig({
-  extends: 'your-layer'
+  extends: '@sbc-connect/nuxt-pay'
 })
 ```
 
-## Development Server
+## Environment Variables
+This project requires certain environment variables to be set to run correctly.
 
-Start the development server on http://localhost:3000
+Create a file named .env in the root of the project.
 
-```bash
-pnpm dev
-```
-
-## Production
+Copy the contents of the .env.example file into your new .env file.
 
-Build the application for production:
+### Local Development
+For local development, you will need credentials for the interacting with the Pay services.
 
-```bash
-pnpm build
 ```
-
-Or statically generate it with:
-
-```bash
-pnpm generate
+# .env
+NUXT_PUBLIC_PAY_API_URL="https://pay-api-dev.pathfinder.gov.bc.ca/api/v1"
+NUXT_PUBLIC_PAY_API_KEY="your-dev-api-key"
 ```
 
-Locally preview production build:
+### Production Environments
+> [!IMPORTANT]
+> The values for staging and production environments are managed securely and should not be stored in this file.
 
-```bash
-pnpm preview
-```
+To obtain the correct values for a production build or deployment, please contact the Connect Platform Team.
 
-Checkout the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+## Contributing
+We welcome contributions to this package! Please see the main [suspicious link removed] for information on our branching strategy, commit conventions, and pull request process.

package/app/components/HelloWorld/Pay.vue

@@ -2,8 +2,8 @@
   <div class="bg-midnightBlue-300 p-5 mt-5">
     Pay - should have bg-midnightBlue-300
     <HelloWorldAuth />
-    <p class="text-bcGovColor-activeBlue">
-      Pay - Should be bcGovColor-activeBlue
+    <p class="text-connect-primary">
+      Pay - Should be connect-primary
     </p>
   </div>
 </template>

package/package.json

@@ -1,24 +1,23 @@
 {
   "name": "@sbc-connect/nuxt-pay",
   "type": "module",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "repository": "github:bcgov/connect-nuxt",
+  "license": "BSD-3-Clause",
   "main": "./nuxt.config.ts",
   "devDependencies": {
     "@axe-core/playwright": "^4.10.2",
-    "@nuxtjs/i18n": "^9.5.5",
-    "@vitest/coverage-v8": "^3.2.3",
+    "@vitest/coverage-v8": "^3.2.4",
     "dotenv": "^17.2.0",
     "nuxt": "4.0.0",
     "typescript": "^5.8.3",
-    "vue": "latest",
-    "vue-tsc": "^3.0.2",
-    "@sbc-connect/eslint-config": "0.0.3",
-    "@sbc-connect/playwright-config": "0.0.3",
-    "@sbc-connect/vitest-config": "0.0.3"
+    "vue-tsc": "^3.0.3",
+    "@sbc-connect/eslint-config": "0.0.5",
+    "@sbc-connect/playwright-config": "0.0.4",
+    "@sbc-connect/vitest-config": "0.0.5"
   },
   "dependencies": {
-    "@sbc-connect/nuxt-auth": "0.1.2"
+    "@sbc-connect/nuxt-auth": "0.1.4"
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",

package/eslint.config.ts

@@ -1,3 +0,0 @@
-import eslintConfig from '@sbc-connect/eslint-config'
-
-export default eslintConfig