DO NOT MERGE - this is a diff of what's changed since Release 3.0.8

.github/workflows/nodejs.yml

@@ -5,6 +5,7 @@ on:
     branches: master
     paths:
     - '**package.json'
+  workflow_dispatch:
 
 jobs:
   build:
@@ -13,10 +14,10 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.14.2]
+        node-version: [20.5.1]
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:

.github/workflows/vue-ci.yml

@@ -4,6 +4,7 @@
   pull_request:
     branches:
       - master
+      - 4.0.0-vue3
     paths:
       - "vue/sbc-common-components/**"
 
@@ -14,24 +15,24 @@
 
 jobs:
   setup-job:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     if: github.repository == 'bcgov/sbc-common-components'
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: "true"
 
   linting:
     needs: setup-job
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     strategy:
       matrix:
-        node-version: [16.14.2]
+        node-version: [20.5.1]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:
@@ -45,14 +46,14 @@
 
   testing-coverage:
     needs: setup-job
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     strategy:
       matrix:
-        node-version: [16.14.2]
+        node-version: [20.5.1]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:
@@ -64,23 +65,17 @@
         id: test
         run: |
           make test
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
-        with:
-          flags: sbccommoncomponentsweb
-          name: codecov-vue
-          fail_ci_if_error: true
 
   build-check:
     needs: setup-job
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     strategy:
       matrix:
-        node-version: [16.14.2]
+        node-version: [20.5.1]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:

python/requirements.txt

@@ -1,4 +1,4 @@
-Flask-OpenTracing
+Flask-OpenTracing==1.1.0
 Flask-SQLAlchemy
 Flask
 Jinja2

python/requirements/prod.txt

@@ -1,5 +1,5 @@
 flask
 Flask-SQLAlchemy
 flask-jwt-oidc>=0.1.5
-Flask-OpenTracing
-jaeger-client
+Flask-OpenTracing==1.1.0
+jaeger-client

python/src/sbc_common_components/__init__.py

@@ -0,0 +1,14 @@
+# Copyright © 2019 Province of British Columbia
+#
+# 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.
+"""This module holds general utility functions and helpers for the main package."""

python/src/sbc_common_components/exception_handling/exception_handler.py

@@ -17,6 +17,7 @@
 from werkzeug.exceptions import HTTPException, default_exceptions
 import logging
 logger = logging.getLogger('api-exceptions')
+http_logger = logging.getLogger('api-exceptions-http')
 
 RESPONSE_HEADERS = {'Content-Type': 'application/json', 'Access-Control-Allow-Origin': '*'}
 
@@ -31,7 +32,7 @@ def __init__(self, app=None):
 
     def auth_handler(self, error):  # pylint: disable=no-self-use
         """Handle AuthError."""
-        logger.error(error.error)
+        http_logger.error(error.error)
         return error.error, error.status_code, RESPONSE_HEADERS
 
     def db_handler(self, error):  # pylint: disable=no-self-use
@@ -46,7 +47,7 @@ def db_handler(self, error):  # pylint: disable=no-self-use
     def std_handler(self, error):  # pylint: disable=no-self-use
         """Handle standard exception."""
         if isinstance(error, HTTPException):
-            logger.error(error)
+            http_logger.error(error)
             message = dict(message=error.message if hasattr(error, 'message') else error.description)
         else:
             logger.exception(error)

python/src/sbc_common_components/utils/camel_case_response.py

@@ -39,9 +39,18 @@ def camelcase(string):
     ])
 
 
-def camelcase_dict(data: Dict[str, any], camel_dict: Dict[str, any]):
+def camelcase_dict(data, camel_dict: Dict[str, any]):
     """Iterate through the dict and convert to camel case."""
-    if data:
+
+    if isinstance(data, list):
+        if not data:  # empty array is falsy
+            return []
+        return [camelcase_dict(item, {}) for item in data]
+
+    if isinstance(data, dict):
+        if not data:  # empty dict is falsy
+            return {}
+
         for key, value in data.items():
             key = camelcase(key)
             if isinstance(value, dict):

python/src/sbc_common_components/utils/dataclasses.py

@@ -0,0 +1,12 @@
+from dataclasses import asdict, dataclass
+from typing import Optional
+
+
+@dataclass
+class PaymentToken:
+    """Payment Token payload common interface for LEAR and Names."""
+
+    id: Optional[str] = None
+    status_code: Optional[str] = None
+    filing_identifier: Optional[str] = None
+    corp_type_code: Optional[str] = None

python/src/sbc_common_components/utils/enums.py

@@ -0,0 +1,67 @@
+from enum import Enum
+
+class QueueMessageTypes(Enum):
+    """Queue MessageTypes."""
+
+    # Note some of these need to match inside of SubjectType in account_mailer.enums.
+
+    ACTIVITY_LOG = 'bc.registry.auth.activity'
+    ADMIN_NOTIFICATION = 'bc.registry.auth.adminNotification'
+    ADMIN_REMOVED = 'bc.registry.auth.adminRemoved'
+    AFFILIATION_INVITATION = 'bc.registry.auth.affiliationInvitation'
+    AFFILIATION_INVITATION_REQUEST = 'bc.registry.auth.affiliationInvitationRequest'
+    AFFILIATION_INVITATION_REQUEST_AUTHORIZATION = 'bc.registry.auth.affiliationInvitationRequestAuthorization'
+    BUSINESS_AFFILIATED = 'bc.registry.auth.businessAffiliated'
+    BUSINESS_UNAFFILIATED = 'bc.registry.auth.businessUnaffiliated'
+    BUSINESS_INVITATION = 'bc.registry.auth.businessInvitation'
+    BUSINESS_INVITATION_FOR_BCEID = 'bc.registry.auth.businessInvitationForBceid'
+    CAS_MESSAGE_TYPE = 'bc.registry.payment.casSettlementUploaded'
+    CGI_ACK_MESSAGE_TYPE = 'bc.registry.payment.cgi.ACKReceived'
+    CGI_FEEDBACK_MESSAGE_TYPE = 'bc.registry.payment.cgi.FEEDBACKReceived'
+    CONFIRMATION_PERIOD_OVER = 'bc.registry.payment.confirmationPeriodOver'
+    DIRSEARCH_BUSINESS_INVITATION = 'bc.registry.auth.dirsearchBusinessInvitation'
+    EFT_AVAILABLE_NOTIFICATION = 'bc.registry.payment.eftAvailableNotification'
+    EFT_FILE_UPLOADED = 'bc.registry.payment.eft.fileUploaded'
+    EFT_INVOICE_CREATED = 'bc.registry.payment.eft.invoiceCreated'
+    EJV_FAILED = 'bc.registry.payment.ejvFailed'
+    GOVM_APPROVED_NOTIFICATION = 'bc.registry.auth.govmApprovedNotification'
+    GOVM_BUSINESS_INVITATION = 'bc.registry.auth.govmBusinessInvitation'
+    GOVM_MEMBER_INVITATION = 'bc.registry.auth.govmMemberInvitation'
+    GOVM_REJECTED_NOTIFICATION = 'bc.registry.auth.govmRejectedNotification'
+    INCORPORATION = 'bc.registry.business.incorporationApplication'
+    MEMBERSHIP_APPROVED_NOTIFICATION = 'bc.registry.auth.membershipApprovedNotification'
+    MEMBERSHIP_APPROVED_NOTIFICATION_FOR_BCEID = 'bc.registry.auth.membershipApprovedNotificationForBceid'
+    NAMES_EVENT = 'bc.registry.names.events'
+    NAMES_MESSAGE_TYPE = 'bc.registry.names.request'
+    NON_BCSC_ORG_APPROVED_NOTIFICATION = 'bc.registry.auth.nonbcscOrgApprovedNotification'
+    NON_BCSC_ORG_REJECTED_NOTIFICATION = 'bc.registry.auth.nonbcscOrgRejectedNotification'
+    NSF_LOCK_ACCOUNT = 'bc.registry.payment.lockAccount'
+    NSF_UNLOCK_ACCOUNT = 'bc.registry.payment.unlockAccount'
+    ONLINE_BANKING_OVER_PAYMENT = 'bc.registry.payment.OverPaid'
+    ONLINE_BANKING_PAYMENT = 'bc.registry.payment.Payment'
+    ONLINE_BANKING_UNDER_PAYMENT = 'bc.registry.payment.UnderPaid'
+    OTP_AUTHENTICATOR_RESET_NOTIFICATION = 'bc.registry.auth.otpAuthenticatorResetNotification'
+    PAD_ACCOUNT_CREATE = 'bc.registry.payment.padAccountCreate'
+    PAD_INVOICE_CREATED = 'bc.registry.payment.pad.invoiceCreated'
+    PAD_PAYMENT_SUCCESS = 'bc.registry.payment.PAD.PaymentSuccess'
+    PAD_SETUP_FAILED = 'bc.registry.payment.PadSetupFailed'
+    PAYMENT = 'bc.registry.payment'
+    PAYMENT_DUE_NOTIFICATION = 'bc.registry.payment.statementDueNotification'
+    PAYMENT_PENDING = 'bc.registry.payment.ob.outstandingInvoice'
+    PAYMENT_REMINDER_NOTIFICATION = 'bc.registry.payment.statementReminderNotification'
+    PROD_PACKAGE_APPROVED_NOTIFICATION = 'bc.registry.auth.prodPackageApprovedNotification'
+    PROD_PACKAGE_REJECTED_NOTIFICATION = 'bc.registry.auth.prodPackageRejectedNotification'
+    PRODUCT_APPROVED_NOTIFICATION_DETAILED = 'bc.registry.auth.productApprovedNotificationDetailed'
+    PRODUCT_CONFIRMATION_NOTIFICATION = 'bc.registry.auth.productConfirmationNotification'
+    PRODUCT_REJECTED_NOTIFICATION_DETAILED = 'bc.registry.auth.productRejectedNotificationDetailed'
+    REFUND_DRAWDOWN_REQUEST = 'bc.registry.payment.drawdown.refundRequest'
+    REGISTRATION = 'bc.registry.business.registration'
+    RESET_PASSCODE = 'bc.registry.auth.resetPasscode'
+    RESUBMIT_BCEID_ADMIN_NOTIFICATION = 'bc.registry.auth.resubmitBceidAdmin'
+    RESUBMIT_BCEID_ORG_NOTIFICATION = 'bc.registry.auth.resubmitBceidOrg'
+    ROLE_CHANGED_NOTIFICATION = 'bc.registry.auth.roleChangedNotification'
+    STAFF_REVIEW_ACCOUNT = 'bc.registry.auth.staffReviewAccount'
+    STATEMENT_NOTIFICATION = 'bc.registry.payment.statementNotification'
+    TEAM_MEMBER_INVITED = 'bc.registry.auth.teamMemberInvited'
+    TEAM_MEMBER_REMOVED = 'bc.registry.auth.teamMemberRemoved'
+    TEAM_MODIFIED = 'bc.registry.auth.teamModified'

vue/sbc-common-components/docs/.vuepress/config.js

@@ -20,7 +20,6 @@ module.exports = {
           '/Layout/',
           '/FeeCalculator/',
           '/AuthenticationOptions/',
-          '/BaseAddress/',
           '/KeycloakService/',
           '/TokenService(Deprecated)/',
           '/Signin/',

vue/sbc-common-components/docs/BaseAddress/README.md

@@ -1,24 +1,3 @@
-# Base Address
-
-This is a stand alone address display / entry component.
-
-The `BaseAddress` component has these properties:
-
-- `address`: a JavaScript `object` that contains the existing address information. Can be undefined.
-- `editing`: a `boolean` that is true if the component is to display the address in editing mode, or false if the
-address is displayed as static text.
-- `schema`: a JavaScript `object` that contains Vuelidate rules (ie, schema).
-
-The `BaseAddress` component emits these events:
-
-- `valid`: a `boolean` that is true if the address passes the validation tests, or false otherwise. This event will be
-emitted when the component is first created, and every time the address is changed.
-- `modified`: a `boolean` that is true if the address has been modified from its original value, or false otherwise.
-In the case where the address is changed from its original value and then changed back to its original value, the final
-event will be false.
-- `update:address`: a JavaScript `object` containing the address. This will be emitted every time the address is
-changed. The parent can use the `.sync` modifier to update its version of the `address` property.
-
 
 ### Prerequisites
 

vue/sbc-common-components/docs/KeycloakService/README.md

@@ -11,7 +11,7 @@ It has two optional arguments:
 
 | Argument | Type | Description |
 | --- | --- | --- | 
-| **store** | vuex store | optional argument to pass the store of the app (default: null)
+| **store** | pinia store | optional argument to pass the store of the app (default: null)
 | **isScheduleRefresh** | boolean | optional argument to disable/enable scheduled refresh (default: true)
 
 
@@ -37,8 +37,9 @@ It supports two modes for **refreshing the token**
    4. Start the timer
 
         ```js
-        if (this.$store.getters['auth/isAuthenticated']) {
-           await KeyCloakService.initializeToken(this.$store)
+        const authStore = useAuthStore()
+        if (authStore.isAuthenticated) {
+           await KeyCloakService.initializeToken()
         }
 
          ```
@@ -53,7 +54,7 @@ It supports two modes for **refreshing the token**
   `import KeyCloakService from 'sbc-common-components/src/services/keycloak.services'`
 
   ```js
-      KeyCloakService.initializeToken(this.$store, false).then(function (token) {
+      KeyCloakService.initializeToken(false).then(function (token) {
         originalRequest.headers['Authorization'] = `Bearer ${token}`
         return axios(originalRequest)
       }).catch(error => {
@@ -89,4 +90,4 @@ This function will verify whether the current logged in keycloak token has the a
 KeyCloakService.verifyRoles(['admin', 'coordinator'], ['basic_user'])
 ```
 
-here, the function will return true if the logged in KC token has roles `admin` or `cooordinator` and return false if it has `basic_user`
+here, the function will return true if the logged in KC token has roles `admin` or `cooordinator` and return false if it has `basic_user`

vue/sbc-common-components/index.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width,initial-scale=1.0">
+    <title>sbc-common-components</title>
+  </head>
+  <body>
+    <noscript>
+      <strong>
+        We're sorry but sbc-common-components doesn't work properly
+        without JavaScript enabled. Please enable it to continue.
+      </strong>
+    </noscript>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>