@sbc-connect/nuxt-auth 0.1.3 → 0.1.5

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @sbc-connect/nuxt-auth
 
+## 0.1.5
+
+### Patch Changes
+
+- Updated dependencies [[`4231254`](https://github.com/bcgov/connect-nuxt/commit/42312540f5eec65f5d3979d5492bdfaa9bb0b079)]:
+  - @sbc-connect/nuxt-base@0.1.5
+
+## 0.1.4
+
+### Patch Changes
+
+- [#16](https://github.com/bcgov/connect-nuxt/pull/16) [`9b8c225`](https://github.com/bcgov/connect-nuxt/commit/9b8c225a011e3c89c9b490e93a554f55a4e29b78) Thanks [@kialj876](https://github.com/kialj876)! - - add base header components (logo, localeSelect, wrapper)
+
+  - add footer component
+  - appendUrlParam util
+
+  issue: bcgov/entity#29334
+
+- Updated dependencies [[`90f240f`](https://github.com/bcgov/connect-nuxt/commit/90f240fd789a5286ded5df710bddd6dc953bcba5), [`0fb8c54`](https://github.com/bcgov/connect-nuxt/commit/0fb8c54e059d78b246b80a03f049d075b7bbcf72), [`9b8c225`](https://github.com/bcgov/connect-nuxt/commit/9b8c225a011e3c89c9b490e93a554f55a4e29b78)]:
+  - @sbc-connect/nuxt-base@0.1.4
+
 ## 0.1.3
 
 ### Patch Changes

package/README.md

@@ -1,73 +1,65 @@
-# Nuxt Layer Starter
+[![License](https://img.shields.io/badge/License-BSD%203%20Clause-blue.svg)](LICENSE) [![pkg.pr.new](https://pkg.pr.new/badge/OWNER/REPO)](https://pkg.pr.new/~/bcgov/connect-nuxt)
 
-Create Nuxt extendable layer with this GitHub template.
+# @sbc-connect/nuxt-auth
+A Nuxt layer for handling user authentication and session management within the Connect ecosystem.
 
-## Setup
+This package provides the necessary composables, plugins, and logic to integrate authentication into a Nuxt application, offering a secure and standardized login experience.
 
-Make sure to install the dependencies:
+## Features
+### Authentication & Session Management
+- Integration with the BC Government authentication provider.
+- User session management.
+- User account management.
 
-```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.
+### Core Development Assets
+- useConnectAuth() composable to access user information and token state.
+- login() and logout() helper functions.
+- Automatic token refreshing and session validation.
 
-Running `pnpm dev` will prepare and boot `.playground` directory, which imports your layer itself.
+For detailed usage and documentation, please see the [Auth Layer Docs](../../../docs/packages/layers/auth/intro.md).
 
-## Distributing your layer
+## Usage
 
-Your Nuxt layer is shaped exactly the same as any other Nuxt project, except you can publish it on NPM.
-
-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-auth
 ```
 
-Once done, your users will only have to run:
-
-```bash
-npm install --save your-layer
-```
+### Configure
+Then add the dependency to `extends` in `nuxt.config`:
 
-Then add the dependency to their `extends` in `nuxt.config`:
+> [!NOTE]
+> `@sbc-connect/nuxt-auth` already includes `@sbc-connect/nuxt-base`, it is not necessary to install `@sbc-connect/nuxt-base`.
 
 ```ts
 defineNuxtConfig({
-  extends: 'your-layer'
+  extends: '@sbc-connect/nuxt-auth'
 })
 ```
 
-## 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 development instance of the authentication provider.
 
-```bash
-pnpm build
 ```
-
-Or statically generate it with:
-
-```bash
-pnpm generate
+# .env
+NUXT_PUBLIC_AUTH_PROVIDER_URL="https://dev.oidc.gov.bc.ca/auth"
+NUXT_PUBLIC_AUTH_PROVIDER_REALM="your-realm-name"
+NUXT_PUBLIC_AUTH_PROVIDER_CLIENT_ID="your-client-id"
 ```
 
-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 [Contribution Guidelines](../../../CONTRIBUTING.md) for information on our branching strategy, commit conventions, and pull request process.

package/app/components/HelloWorld/Auth.vue

@@ -5,8 +5,8 @@
     <h3 class="text-red-700">
       Auth - should be red-700
     </h3>
-    <p class="text-connect-yellow">
-      Auth - should be connect-yellow
+    <p class="text-brandLight">
+      Auth - should be brandLight
     </p>
   </div>
 </template>

package/nuxt.config.ts

@@ -18,5 +18,13 @@ export default defineNuxtConfig({
 
   css: [
     resolve('./app/assets/css/tw-auth.css')
-  ]
+  ],
+
+  runtimeConfig: {
+    public: {
+      // Should in alphabetical order
+      appName: process.env.npm_package_name || '',
+      version: `Connect Auth Layer v${process.env.npm_package_version || ''}`
+    }
+  }
 })

package/package.json

@@ -1,22 +1,23 @@
 {
   "name": "@sbc-connect/nuxt-auth",
   "type": "module",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "repository": "github:bcgov/connect-nuxt",
+  "license": "BSD-3-Clause",
   "main": "./nuxt.config.ts",
   "devDependencies": {
     "@axe-core/playwright": "^4.10.2",
-    "@vitest/coverage-v8": "^3.2.3",
+    "@vitest/coverage-v8": "^3.2.4",
     "dotenv": "^17.2.0",
-    "nuxt": "4.0.0",
+    "nuxt": "^4.0.0",
     "typescript": "^5.8.3",
-    "vue-tsc": "^3.0.2",
-    "@sbc-connect/eslint-config": "0.0.4",
+    "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.4"
+    "@sbc-connect/vitest-config": "0.0.5"
   },
   "dependencies": {
-    "@sbc-connect/nuxt-base": "0.1.3"
+    "@sbc-connect/nuxt-base": "0.1.5"
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",