Merge smart camera web

.github/workflows/deploy-preview.yml

@@ -1,16 +1,52 @@
 name: deploy-preview
 on:
+  workflow_call:
   pull_request:
+    branches: [ 'main' ]
     types:
       - opened
       - edited
       - synchronize
+  push:
+    branches: [ 'main' ]
 
 jobs:
   test:
     uses: ./.github/workflows/test.yml
-  deploy-preview:
+  deploy-preview-camera-web:
     needs: [test]
+    defaults:
+      run:
+        working-directory: ./smart-camera-web
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: set node version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build
+      - name: set destination directory
+        id: set_dest_dir_camera_web
+        run: echo "DEST_DIR_CAMERA_WEB=js/preview-$GITHUB_HEAD_REF" >> "$GITHUB_ENV"
+      - name: deploy preview to s3
+        uses: jakejarvis/[email protected]
+        with:
+          args: --follow-symlinks --delete --exclude '*' --include 'smart-camera-web.js'
+        env:
+          AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+          DEST_DIR: ${{ env.DEST_DIR_CAMERA_WEB }}
+
+  deploy-preview-hosted-web:
+    needs: [test]
+    defaults:
+      run:
+        working-directory: ./hosted-web-integration
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -22,8 +58,8 @@ jobs:
       - run: npm ci
       - run: npm run build && npm run build:dist
       - name: set destination directory
-        id: set_dest_dir
-        run: echo "DEST_DIR=inline/preview-$GITHUB_HEAD_REF" >> "$GITHUB_OUTPUT"
+        id: set_dest_dir_hosted_web
+        run: echo "DEST_DIR_HOSTED_WEB=inline/preview-$GITHUB_HEAD_REF" >> "$GITHUB_ENV"
       - name: deploy preview to s3
         uses: jakejarvis/[email protected]
         with:
@@ -33,6 +69,5 @@ jobs:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_REGION: ${{ secrets.AWS_REGION }}
-          SOURCE_DIR: "./dist"
-          DEST_DIR: ${{ steps.set_dest_dir.outputs.DEST_DIR }}
-
+          SOURCE_DIR: "./hosted-web-integration/dist"
+          DEST_DIR: ${{ env.DEST_DIR_HOSTED_WEB }}

.github/workflows/deploy.yml

@@ -0,0 +1,42 @@
+name: deploy
+on:
+  push:
+    tags: v[1-9]+.[0-9]+.[0-9]+*
+defaults:
+  run:
+    working-directory: ./smart-camera-web
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+  deploy:
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: set node version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build
+      - name: get version number
+        id: get_version
+        run: |
+          echo "VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_OUTPUT
+      - name: set destination directory
+        id: set_destination
+        env:
+          TAG: ${{ steps.get_version.outputs.VERSION }}
+        run: |
+          echo "DEST_DIR=js/$TAG" >> $GITHUB_OUTPUT
+      - name: deploy to s3
+        uses: jakejarvis/[email protected]
+        with:
+          args: --follow-symlinks --delete --exclude '*' --include 'smart-camera-web.js'
+        env:
+          AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+          DEST_DIR: ${{ steps.set_destination.outputs.DEST_DIR }}

.github/workflows/lint.yml

@@ -1,17 +1,36 @@
 name: lint
 on: 
   push:
+    branches:
+      - main
   pull_request:
   workflow_dispatch:
 jobs:
-    lint:
-      runs-on: ubuntu-latest
-      steps:
-        - uses: actions/checkout@v4
-        - name: set node version
-          uses: actions/setup-node@v3
-          with:
-            node-version-file: '.nvmrc'
-            cache: 'npm'
-        - run: npm ci
-        - run: npm run lint:html
+  lint-hosted-web-integration:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./hosted-web-integration
+    steps:
+      - uses: actions/checkout@v4
+      - name: set node version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run lint:html
+  lint-smart-camera-web:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./smart-camera-web
+    steps:
+      - uses: actions/checkout@v4
+      - name: set node version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run lint

.github/workflows/main.yml

@@ -4,7 +4,9 @@ on:
   push:
     tags: v1
     branches: main
-
+defaults:
+  run:
+    working-directory: ./hosted-web-integration
 jobs:
   test:
     uses: ./.github/workflows/test.yml

.github/workflows/share-preview-url.yml

@@ -11,13 +11,27 @@ jobs:
     permissions: write-all
     steps:
       - uses: actions/checkout@v4
-      - name: get dest dir
-        id: get_dest_dir
-        run: echo "DEST_DIR=inline/preview-$GITHUB_HEAD_REF" >> "$GITHUB_OUTPUT"
-      - name: share preview url as PR comment
+
+      - name: get dest dir for camera-web
+        id: get_dest_dir_camera_web
+        working-directory: ./smart-camera-web
+        run: echo "DEST_DIR_CAMERA_WEB=js/preview-$GITHUB_HEAD_REF" >> "$GITHUB_ENV"
+
+      - name: get dest dir for hosted-web
+        id: get_dest_dir_hosted_web
+        working-directory: ./hosted-web-integration
+        run: echo "DEST_DIR_HOSTED_WEB=inline/preview-$GITHUB_HEAD_REF" >> "$GITHUB_ENV"
+
+      - name: share preview urls as PR comment
         uses: unsplash/comment-on-pr@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          msg: "This branch has been deployed to s3 / cloudfront.\n\n✅ Preview URL: https://cdn.smileidentity.com/${{ steps.get_dest_dir.outputs.DEST_DIR }}/js/script.js"
+          msg: |
+            This branch has been deployed to s3 / cloudfront.
+
+            ✅ Preview URL for Smart Camera Web: 
+            https://cdn.smileidentity.com/${{ env.DEST_DIR_CAMERA_WEB }}/smart-camera-web.js
 
+            ✅ Preview URL for Hosted Web Integration: 
+            https://cdn.smileidentity.com/${{ env.DEST_DIR_HOSTED_WEB }}/js/script.js

.github/workflows/test.yml

@@ -1,28 +1,49 @@
 name: test
 on:
   workflow_call:
-
 jobs:
-  test:
+  test-smart-camera-web:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./smart-camera-web
     steps:
-      - name: checkout code, and install dependencies
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
       - name: set node version
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'
           cache: 'npm'
       - run: npm ci
+      - run: npm run build
       - name: run tests
         uses: cypress-io/github-action@v6
         with:
           start: npm start
+          working-directory: ./smart-camera-web
+          wait-on: 'http://localhost:8000'
+  test-hosted-web-integration:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./hosted-web-integration
+    steps:
+      - uses: actions/checkout@v4
+      - name: set node version
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+      - run: npm ci
+      - name: run tests
+        uses: cypress-io/github-action@v6
+        with:
+          start: npm start
+          working-directory: ./hosted-web-integration
           wait-on: 'http://localhost:8000'
       - name: upload test failure artifacts
         uses: actions/upload-artifact@v3
         if: failure()
         with:
           name: cypress-screenshots
-          path: cypress/screenshots
-
+          path: cypress/screenshots

.nvmrc

@@ -1 +1 @@
-v18.17.1
+v18.18.0

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Smile Identity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,72 +1,43 @@
-# hosted-web-integration
-
-[![Cypress Tests](https://github.com/smileidentity/hosted-web-integration/actions/workflows/main.yml/badge.svg)](https://github.com/smileidentity/hosted-web-integration/actions/workflows/main.yml)
+# Smile Identity Hosted-Web Mono-Repo
 
 ## Overview
 
-This repository provides a self-hosted integration for Smile ID on the Web. It encompasses a comprehensive set of utilities for KYC processes, biometric verification, and more. Public documentation [here](https://docs.usesmileid.com/integration-options/web-mobile-web/web-integration).
-
-## Prerequisites
-
-- Ensure you have [Node.js](https://nodejs.org/) installed.
-- Install [nvm (Node Version Manager)](https://github.com/nvm-sh/nvm) for managing Node.js versions.
-
-## Setup
-
-1. Clone the repository:
-
-    ```bash
-    git clone https://github.com/smileidentity/hosted-web-integration.git
-    cd hosted-web-integration
-    ```
-
-2. Switch to the appropriate Node version using `nvm`:
-
-    ```bash
-    nvm install
-    nvm use
-    ```
-
-3. Install project dependencies:
-
-    ```bash
-    npm install
-    ```
+- **Smart Camera Web** acts as a user interface client that works together with the [Server to Server](https://docs.smileidentity.com/server-to-server) libraries. For more detailed information, you can refer to the [Smart Camera Web documentation](./smart-camera-web/README.md).
 
-## Running the Project
+- **Hosted Web Integration** provides the necessary structure for self-hosted integration on the web. Detailed information about this can be found in the [Hosted Web Integration documentation](./hosted-web-integration/README.md).
 
-1. Build the project:
+## Quick Start
 
-    ```bash
-    npm run build
-    ```
+### Setting Up Your Environment
 
-2. Start the local server:
+1. **Node.js with NVM**: Ensure you're using the correct Node.js version. If you don't have [NVM (Node Version Manager)](https://github.com/nvm-sh/nvm) installed:
 
-    ```bash
-    npm start
-    ```
+   Activate the right Node version for this project:
 
-3. Access the application on `http://localhost:8000`.
+   ```sh
+   nvm use
+   ```
 
-### Configuration
+2. **Installing Dependencies**:
 
-- `.git-blame-ignore-revs`: File used to ignore certain commits in `git blame`.
-- `.gitignore`: Specifies files to ignore in git. These include [./dist](./dist) and [./build](./build).
-- `.nvmrc`: Node Version Manager configuration file.
-- `.nycrc`: [NYC](https://github.com/istanbuljs/nyc) configuration file.
+   ```sh
+   npm install
+   ```
 
-## Testing
+### Running Tests
 
-Run Cypress tests using:
+Both projects in this mono-repo come equipped with test suites to ensure code quality and functionality. Here's how to run them:
 
-```bash
-npm test
-```
+1. **Smart Camera Web**:
 
-NOTE: the `npm start` command must be running in a separate terminal window.
+   ```sh
+   cd smart-camera-web
+   npm test
+   ```
 
-### Cypress Configuration & Pages
+2. **Hosted Web Integration**:
 
-- `cypress.config.js`: Main Cypress configuration file.
-- `cypress/pages/`: Contains all the utility pages.
+   ```sh
+   cd hosted-web-integration
+   npm test
+   ```