@sharadtech/infralytiqs-sdk 1.0.0 → 1.0.1

package/buildScripts/Jenkinsfile.deploy

@@ -1,25 +1,37 @@
 // =============================================================================
 //  Infralytiqs SDK — DEPLOY Jenkinsfile
 // -----------------------------------------------------------------------------
-//  Pipeline performs the deploy flow:
-//    1. Fetch Released Version  -> npm pack from npmjs.com
-//    2. Upload                  -> aws s3 cp into target bucket / prefix
-//    3. Verify                  -> HTTP GET via CDN URL & version match
-//    4. Finish
+//  Pipeline performs the deploy flow for two distinct artifacts:
+//
+//    A) The shared Infralytiqs SDK (sourced from npmjs.com).
+//       Uploaded to:  s3://infralytiqs/cdn/infralytiqs.min.js
+//       Served via :  https://assets.infralytiqs.com/cdn/infralytiqs.min.js
+//
+//    B) Per-client bootstraps (built directly from this git repository under
+//       clients/<vendor>/<app>). Currently the only client wired in is:
+//
+//         clients/publicis/ps  ->  s3://infralytiqs/cl/publicis/ps/infralytiqs-bootstrap.min.js
+//                                  https://assets.infralytiqs.com/cl/publicis/ps/infralytiqs-bootstrap.min.js
+//
+//       Additional clients can be wired in by adding another build/upload/
+//       verify stage trio with its own boolean job parameter.
+//
+//  Per-artifact stages can be toggled independently from the build form via
+//  the DEPLOY_SDK and DEPLOY_CLIENT_PUBLICIS_PS boolean job parameters.
 //
 //  Required Jenkins credentials:
-//    - aws-infralytiqs-deploy   : AWS credentials (Access Key + Secret) bound
-//                                 with "AWS Credentials" credential type, OR a
-//                                 username/password pair used as access/secret.
+//    - aws-infralytiqs-deploy   : "Username with password" credential where
+//                                 username = AWS Access Key ID and
+//                                 password = AWS Secret Access Key.
+//                                 (We don't need the AWS Credentials plugin —
+//                                 we just bind it as a username/password and
+//                                 export the standard AWS_* env vars ourselves.)
 //
 //  Required Jenkins plugins:
 //    - Pipeline Utility Steps
 //    - Credentials Binding
-//    - AWS Credentials Plugin   (for AmazonWebServicesCredentialsBinding)
-//    - Timestamper, AnsiColor   (optional, used in options)
-//    - NodeJS Plugin            (only if you want managed npm/node — see TOOLS
-//                                block below; otherwise the agent must already
-//                                have node + npm + curl + aws on PATH).
+//    (No AWS Credentials plugin or NodeJS tool installation is needed — we
+//    download portable Node and AWS CLI v2 into the workspace at runtime.)
 // =============================================================================
 
 pipeline {
@@ -29,21 +41,31 @@ pipeline {
         string(
             name: 'DEPLOY_VERSION',
             defaultValue: '1.0.0',
-            description: 'Release version available on npmjs.com (e.g. "1.0.1") to deploy to S3 / CDN.'
+            description: 'Release version available on npmjs.com (e.g. "1.0.1") to deploy to S3 / CDN. Only used when DEPLOY_SDK is checked.'
+        )
+        booleanParam(
+            name: 'DEPLOY_SDK',
+            defaultValue: true,
+            description: 'Fetch the released SDK from npmjs.com and upload it to s3://infralytiqs/cdn/infralytiqs.min.js'
+        )
+        booleanParam(
+            name: 'DEPLOY_CLIENT_PUBLICIS_PS',
+            defaultValue: true,
+            description: 'Build clients/publicis/ps from THIS repository and upload its minified bootstrap to s3://infralytiqs/cl/publicis/ps/infralytiqs-bootstrap.min.js'
         )
     }
 
     options {
         buildDiscarder(logRotator(numToKeepStr: '30'))
         disableConcurrentBuilds()
-        timeout(time: 20, unit: 'MINUTES')
+        timeout(time: 30, unit: 'MINUTES')
     }
 
     // -------------------------------------------------------------------------
     //  Pipeline-wide configuration — adjust per environment.
     // -------------------------------------------------------------------------
     environment {
-        // ---- npm registry (source of artifact) ----
+        // ---- npm registry (source of SDK artifact) ----
         NPM_REGISTRY              = 'https://registry.npmjs.org/'
         NPM_PACKAGE_NAME          = '@sharadtech/infralytiqs-sdk'
 
@@ -55,22 +77,32 @@ pipeline {
         SDK_FILENAME_MIN          = 'infralytiqs.min.js'
         SDK_FILENAME_UNMIN        = 'infralytiqs.js'
 
-        // ---- S3 destination ----
-        S3_BUCKET                 = 'assets-infralytiqs-com'   // <-- adjust
-        S3_KEY_PREFIX             = 'v1/scripts'               // <-- adjust
+        // ---- S3 destination (shared SDK) ----
+        S3_BUCKET                 = 'infralytiqs'   // <-- adjust
+        S3_KEY_PREFIX             = 'cdn'           // <-- adjust
         S3_OBJECT_NAME            = 'infralytiqs.min.js'       // final filename in S3
-        AWS_REGION                = 'us-east-1'
+        AWS_REGION                = 'eu-west-2'
         AWS_CREDENTIALS_ID        = 'aws-infralytiqs-deploy'
 
-        // ---- Object metadata ----
+        // ---- Object metadata (shared by every uploaded artifact) ----
         S3_CONTENT_TYPE           = 'application/javascript; charset=utf-8'
         S3_CACHE_CONTROL          = 'public, max-age=300'
 
         // ---- CDN verification ----
         CDN_BASE_URL              = 'https://assets.infralytiqs.com'
-        CDN_VERIFY_PATH           = 'v1/scripts/infralytiqs.min.js'
+        CDN_VERIFY_PATH           = 'cdn/infralytiqs.min.js'
         CDN_VERIFY_RETRIES        = '6'   // number of attempts
         CDN_VERIFY_SLEEP_SEC      = '10'  // delay between attempts
+
+        // ---- clients/publicis/ps (client-specific bootstrap) ----
+        // The git repository is checked out into this subdirectory by the
+        // "Checkout Source" stage so it doesn't collide with the npm artifact
+        // tarball or the AWS CLI binaries downloaded into the workspace root.
+        REPO_SRC_DIR              = 'repo-src'
+        CLIENT_PS_REL_DIR         = 'clients/publicis/ps'
+        CLIENT_PS_BOOTSTRAP_MIN   = 'infralytiqs-bootstrap.min.js'
+        CLIENT_PS_S3_KEY_PREFIX   = 'cl/publicis/ps'
+        CLIENT_PS_CDN_VERIFY_PATH = 'cl/publicis/ps/infralytiqs-bootstrap.min.js'
     }
 
     // If you use the Jenkins NodeJS plugin, uncomment and set the tool name:
@@ -79,18 +111,33 @@ pipeline {
     stages {
 
         // ---------------------------------------------------------------------
-        stage('Fetch Released Version') {
+        stage('Init Workspace') {
             steps {
                 // Workspace Cleanup plugin not installed on this Jenkins —
-                // use deleteDir() to wipe the workspace.
+                // use deleteDir() to wipe the workspace before every build.
                 deleteDir()
                 script {
-                    if (!params.DEPLOY_VERSION?.trim()) {
-                        error "DEPLOY_VERSION job parameter is required."
+                    if (!params.DEPLOY_SDK && !params.DEPLOY_CLIENT_PUBLICIS_PS) {
+                        error "Nothing to do: both DEPLOY_SDK and DEPLOY_CLIENT_PUBLICIS_PS are unchecked."
+                    }
+                    def labelParts = []
+                    if (params.DEPLOY_SDK) {
+                        if (!params.DEPLOY_VERSION?.trim()) {
+                            error "DEPLOY_VERSION is required when DEPLOY_SDK is checked."
+                        }
+                        labelParts << "sdk:${params.DEPLOY_VERSION}"
                     }
-                    currentBuild.displayName = "#${env.BUILD_NUMBER} • ${params.DEPLOY_VERSION}"
+                    if (params.DEPLOY_CLIENT_PUBLICIS_PS) {
+                        labelParts << 'publicis/ps'
+                    }
+                    currentBuild.displayName = "#${env.BUILD_NUMBER} • ${labelParts.join(' + ')}"
                 }
+            }
+        }
 
+        // ---------------------------------------------------------------------
+        stage('Setup Node') {
+            steps {
                 // Bring our own portable Node.js (the agent has no global Node).
                 sh '''
                     set -eu
@@ -115,7 +162,13 @@ pipeline {
                     env.NODE_HOME = "${env.WORKSPACE}/.tools/node-v${env.NODE_VERSION}-${env.NODE_PLATFORM}"
                     env.PATH      = "${env.NODE_HOME}/bin:${env.PATH}"
                 }
+            }
+        }
 
+        // ---------------------------------------------------------------------
+        stage('Fetch Released SDK (npm)') {
+            when { expression { return params.DEPLOY_SDK } }
+            steps {
                 sh '''
                     set -eu
                     echo "Node : $(node --version)"
@@ -150,37 +203,149 @@ pipeline {
                     // Sanity-check the embedded version banner before uploading.
                     def header = sh(script: "head -c 1024 ${minPath}", returnStdout: true)
                     if (!header.contains(params.DEPLOY_VERSION)) {
-                        error "Fetched artifact does NOT contain expected version '${params.DEPLOY_VERSION}' in its banner. Aborting deploy."
+                        error "Fetched SDK artifact does NOT contain expected version '${params.DEPLOY_VERSION}' in its banner. Aborting deploy."
                     }
-                    echo "Verified fetched artifact contains version banner v${params.DEPLOY_VERSION}."
+                    echo "Verified fetched SDK artifact contains version banner v${params.DEPLOY_VERSION}."
+                }
+            }
+        }
+
+        // ---------------------------------------------------------------------
+        stage('Checkout Source (client builds)') {
+            when { expression { return params.DEPLOY_CLIENT_PUBLICIS_PS } }
+            steps {
+                // The repository is checked out into a sub-folder so it
+                // doesn't collide with the npm pack output (artifact/) or
+                // the AWS CLI binaries (.tools/) we drop into the workspace
+                // root. The Jenkins SCM config of this job (URL + branch +
+                // credentials) is reused verbatim.
+                dir("${env.REPO_SRC_DIR}") {
+                    checkout scm
+                    sh 'git --no-pager log -1 --oneline'
                 }
             }
         }
 
         // ---------------------------------------------------------------------
-        stage('Upload') {
+        stage('Build Client — publicis/ps') {
+            when { expression { return params.DEPLOY_CLIENT_PUBLICIS_PS } }
             steps {
-                withCredentials([[
-                    $class: 'AmazonWebServicesCredentialsBinding',
+                sh '''
+                    set -eu
+                    cd "${REPO_SRC_DIR}/${CLIENT_PS_REL_DIR}"
+                    echo "Building client bootstrap in $(pwd) ..."
+                    # `npm ci` requires package-lock.json; fall back to install
+                    # for a fresh checkout that doesn't carry one yet.
+                    if [ -f package-lock.json ]; then
+                        npm ci --no-audit --no-fund
+                    else
+                        npm install --no-audit --no-fund
+                    fi
+                    npm run build
+                    ls -la dist
+                '''
+
+                script {
+                    def relMin = "${env.REPO_SRC_DIR}/${env.CLIENT_PS_REL_DIR}/dist/${env.CLIENT_PS_BOOTSTRAP_MIN}"
+                    if (!fileExists(relMin)) {
+                        error "Build did not produce expected client bootstrap: ${relMin}"
+                    }
+                    env.LOCAL_CLIENT_PS_MIN_PATH = relMin
+                    archiveArtifacts artifacts: "${env.REPO_SRC_DIR}/${env.CLIENT_PS_REL_DIR}/dist/*.js",
+                                     fingerprint: true,
+                                     onlyIfSuccessful: true
+                    echo "Built client bootstrap: ${relMin}"
+                }
+            }
+        }
+
+        // ---------------------------------------------------------------------
+        stage('Setup AWS CLI') {
+            steps {
+                // Download a portable AWS CLI v2 distribution into the
+                // workspace so the pipeline doesn't depend on aws being
+                // pre-installed on the agent. We invoke the bundled
+                // aws/dist/aws binary directly (no system-wide install
+                // step is needed, no root, no PATH writes outside $WORKSPACE).
+                sh '''
+                    set -eu
+                    AWS_CLI_DIR="${WORKSPACE}/.tools/aws-cli"
+                    AWS_CLI_BIN="${AWS_CLI_DIR}/aws/dist/aws"
+                    if [ ! -x "${AWS_CLI_BIN}" ]; then
+                        mkdir -p "${WORKSPACE}/.tools"
+                        echo "Downloading AWS CLI v2 ..."
+                        curl -fSL --retry 3 --retry-delay 2 \
+                            "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" \
+                            -o "${WORKSPACE}/.tools/awscliv2.zip"
+                        rm -rf "${AWS_CLI_DIR}"
+                        mkdir -p "${AWS_CLI_DIR}"
+                        # The agent doesn't necessarily have `unzip`. Fall back
+                        # in order to: unzip -> jar (JDK ships with the Jenkins
+                        # agent) -> python3 zipfile module. At least one of
+                        # these is available on essentially any Linux Jenkins
+                        # agent.
+                        cd "${AWS_CLI_DIR}"
+                        if command -v unzip >/dev/null 2>&1; then
+                            echo "Extracting with unzip ..."
+                            unzip -q "${WORKSPACE}/.tools/awscliv2.zip"
+                        elif command -v jar >/dev/null 2>&1; then
+                            echo "Extracting with jar ..."
+                            jar -xf "${WORKSPACE}/.tools/awscliv2.zip"
+                        elif command -v python3 >/dev/null 2>&1; then
+                            echo "Extracting with python3 zipfile ..."
+                            python3 -c "import zipfile,sys; zipfile.ZipFile(sys.argv[1]).extractall('.')" \
+                                "${WORKSPACE}/.tools/awscliv2.zip"
+                        else
+                            echo "ERROR: agent is missing all of: unzip, jar (JDK), python3" >&2
+                            exit 1
+                        fi
+                        cd "${WORKSPACE}"
+                        # The bundled aws/dist/aws (and aws/install) binaries
+                        # may lose their +x bit through some extractors.
+                        chmod +x "${AWS_CLI_BIN}" "${AWS_CLI_DIR}/aws/install" 2>/dev/null || true
+                        rm -f "${WORKSPACE}/.tools/awscliv2.zip"
+                    fi
+                    "${AWS_CLI_BIN}" --version
+                '''
+                script {
+                    env.AWS_CLI_BIN = "${env.WORKSPACE}/.tools/aws-cli/aws/dist/aws"
+                }
+            }
+        }
+
+        // ---------------------------------------------------------------------
+        stage('Upload SDK') {
+            when { expression { return params.DEPLOY_SDK } }
+            steps {
+                // The credential is stored as "Username with password":
+                //   username = AWS Access Key ID
+                //   password = AWS Secret Access Key
+                // (so we don't need the AWS Credentials plugin).
+                withCredentials([usernamePassword(
                     credentialsId: env.AWS_CREDENTIALS_ID,
-                    accessKeyVariable: 'AWS_ACCESS_KEY_ID',
-                    secretKeyVariable: 'AWS_SECRET_ACCESS_KEY'
-                ]]) {
+                    usernameVariable: 'AWS_ACCESS_KEY_ID',
+                    passwordVariable: 'AWS_SECRET_ACCESS_KEY'
+                )]) {
                     sh '''
                         set -eu
-                        aws --version
+                        export AWS_DEFAULT_REGION="${AWS_REGION}"
+                        # Make sure curl/git proxy or other AWS_* leftovers don't
+                        # interfere with the credentials we just bound.
+                        unset AWS_SESSION_TOKEN || true
+
+                        "${AWS_CLI_BIN}" --version
 
                         S3_TARGET="s3://${S3_BUCKET}/${S3_KEY_PREFIX}/${S3_OBJECT_NAME}"
                         echo "Uploading ${LOCAL_SDK_MIN_PATH} -> ${S3_TARGET}"
 
-                        aws s3 cp "${LOCAL_SDK_MIN_PATH}" "${S3_TARGET}" \
+                        "${AWS_CLI_BIN}" s3 cp "${LOCAL_SDK_MIN_PATH}" "${S3_TARGET}" \
                             --region "${AWS_REGION}" \
                             --content-type "${S3_CONTENT_TYPE}" \
                             --cache-control "${S3_CACHE_CONTROL}" \
                             --metadata "sdk-version=${DEPLOY_VERSION}"
 
                         echo "S3 head-object verification:"
-                        aws s3api head-object \
+                        "${AWS_CLI_BIN}" s3api head-object \
                             --region "${AWS_REGION}" \
                             --bucket "${S3_BUCKET}" \
                             --key    "${S3_KEY_PREFIX}/${S3_OBJECT_NAME}"
@@ -190,7 +355,8 @@ pipeline {
         }
 
         // ---------------------------------------------------------------------
-        stage('Verify') {
+        stage('Verify SDK on CDN') {
+            when { expression { return params.DEPLOY_SDK } }
             steps {
                 sh '''
                     set -eu
@@ -227,29 +393,131 @@ pipeline {
             }
         }
 
+        // ---------------------------------------------------------------------
+        stage('Upload Client — publicis/ps') {
+            when { expression { return params.DEPLOY_CLIENT_PUBLICIS_PS } }
+            steps {
+                withCredentials([usernamePassword(
+                    credentialsId: env.AWS_CREDENTIALS_ID,
+                    usernameVariable: 'AWS_ACCESS_KEY_ID',
+                    passwordVariable: 'AWS_SECRET_ACCESS_KEY'
+                )]) {
+                    sh '''
+                        set -eu
+                        export AWS_DEFAULT_REGION="${AWS_REGION}"
+                        unset AWS_SESSION_TOKEN || true
+
+                        "${AWS_CLI_BIN}" --version
+
+                        S3_TARGET="s3://${S3_BUCKET}/${CLIENT_PS_S3_KEY_PREFIX}/${CLIENT_PS_BOOTSTRAP_MIN}"
+                        echo "Uploading ${LOCAL_CLIENT_PS_MIN_PATH} -> ${S3_TARGET}"
+
+                        "${AWS_CLI_BIN}" s3 cp "${LOCAL_CLIENT_PS_MIN_PATH}" "${S3_TARGET}" \
+                            --region "${AWS_REGION}" \
+                            --content-type "${S3_CONTENT_TYPE}" \
+                            --cache-control "${S3_CACHE_CONTROL}" \
+                            --metadata "client=publicis-ps build-number=${BUILD_NUMBER}"
+
+                        echo "S3 head-object verification:"
+                        "${AWS_CLI_BIN}" s3api head-object \
+                            --region "${AWS_REGION}" \
+                            --bucket "${S3_BUCKET}" \
+                            --key    "${CLIENT_PS_S3_KEY_PREFIX}/${CLIENT_PS_BOOTSTRAP_MIN}"
+                    '''
+                }
+            }
+        }
+
+        // ---------------------------------------------------------------------
+        stage('Verify Client — publicis/ps on CDN') {
+            when { expression { return params.DEPLOY_CLIENT_PUBLICIS_PS } }
+            steps {
+                sh '''
+                    set -eu
+                    CDN_URL="${CDN_BASE_URL}/${CLIENT_PS_CDN_VERIFY_PATH}"
+                    LOCAL_BANNER=$(head -n 1 "${LOCAL_CLIENT_PS_MIN_PATH}" | tr -d "\n")
+                    echo "Verifying CDN URL: ${CDN_URL}"
+                    echo "Expected banner   : ${LOCAL_BANNER}"
+
+                    i=1
+                    while [ "${i}" -le "${CDN_VERIFY_RETRIES}" ]; do
+                        STATUS=$(curl -sS -o /tmp/client-ps-cdn.js -w "%{http_code}" \
+                            "${CDN_URL}?cb=$(date +%s)-${BUILD_NUMBER}-${i}" || echo "000")
+
+                        if [ "${STATUS}" = "200" ]; then
+                            CDN_BANNER=$(head -n 1 /tmp/client-ps-cdn.js | tr -d "\n")
+                            if [ "${CDN_BANNER}" = "${LOCAL_BANNER}" ]; then
+                                echo "CDN OK — client bootstrap served from ${CDN_URL}"
+                                echo "  banner: ${CDN_BANNER}"
+                                exit 0
+                            else
+                                echo "Attempt ${i}: HTTP 200 but banner mismatch (likely CDN cache lag)."
+                                echo "   cdn  : ${CDN_BANNER}"
+                                echo "   local: ${LOCAL_BANNER}"
+                            fi
+                        else
+                            echo "Attempt ${i}: HTTP ${STATUS} from ${CDN_URL}"
+                        fi
+
+                        i=$((i + 1))
+                        if [ "${i}" -le "${CDN_VERIFY_RETRIES}" ]; then
+                            sleep "${CDN_VERIFY_SLEEP_SEC}"
+                        fi
+                    done
+
+                    echo "CDN verification FAILED after ${CDN_VERIFY_RETRIES} attempts."
+                    exit 1
+                '''
+            }
+        }
+
         // ---------------------------------------------------------------------
         stage('Finish') {
             steps {
-                echo "==============================================================="
-                echo " Deploy job completed successfully."
-                echo "   npm package      : ${env.NPM_PACKAGE_NAME}@${params.DEPLOY_VERSION}"
-                echo "   S3 destination   : s3://${env.S3_BUCKET}/${env.S3_KEY_PREFIX}/${env.S3_OBJECT_NAME}"
-                echo "   CDN URL          : ${env.CDN_BASE_URL}/${env.CDN_VERIFY_PATH}"
-                echo "==============================================================="
+                script {
+                    echo "==============================================================="
+                    echo " Deploy job completed successfully."
+                    if (params.DEPLOY_SDK) {
+                        echo "   SDK"
+                        echo "     npm package      : ${env.NPM_PACKAGE_NAME}@${params.DEPLOY_VERSION}"
+                        echo "     S3 destination   : s3://${env.S3_BUCKET}/${env.S3_KEY_PREFIX}/${env.S3_OBJECT_NAME}"
+                        echo "     CDN URL          : ${env.CDN_BASE_URL}/${env.CDN_VERIFY_PATH}"
+                    } else {
+                        echo "   SDK upload skipped (DEPLOY_SDK = false)."
+                    }
+                    if (params.DEPLOY_CLIENT_PUBLICIS_PS) {
+                        echo "   Client: publicis/ps"
+                        echo "     Source           : ${env.REPO_SRC_DIR}/${env.CLIENT_PS_REL_DIR}"
+                        echo "     S3 destination   : s3://${env.S3_BUCKET}/${env.CLIENT_PS_S3_KEY_PREFIX}/${env.CLIENT_PS_BOOTSTRAP_MIN}"
+                        echo "     CDN URL          : ${env.CDN_BASE_URL}/${env.CLIENT_PS_CDN_VERIFY_PATH}"
+                    } else {
+                        echo "   Client publicis/ps upload skipped (DEPLOY_CLIENT_PUBLICIS_PS = false)."
+                    }
+                    echo "==============================================================="
+                }
             }
         }
     }
 
     post {
         success {
-            echo "SUCCESS: Deployed ${env.NPM_PACKAGE_NAME}@${params.DEPLOY_VERSION} to ${env.CDN_BASE_URL}/${env.CDN_VERIFY_PATH}"
+            script {
+                def messages = []
+                if (params.DEPLOY_SDK) {
+                    messages << "${env.NPM_PACKAGE_NAME}@${params.DEPLOY_VERSION} -> ${env.CDN_BASE_URL}/${env.CDN_VERIFY_PATH}"
+                }
+                if (params.DEPLOY_CLIENT_PUBLICIS_PS) {
+                    messages << "publicis/ps -> ${env.CDN_BASE_URL}/${env.CLIENT_PS_CDN_VERIFY_PATH}"
+                }
+                echo "SUCCESS: Deployed ${messages.join(' ; ')}"
+            }
         }
         failure {
             echo "FAILURE: Deploy job failed at stage '${env.STAGE_NAME}'."
         }
         // Workspace cleanup is intentionally NOT performed in post —
-        // the "Fetch Released Version" stage wipes the workspace at the
-        // start of every build, and the Workspace Cleanup plugin
-        // (cleanWs) is not installed on this Jenkins.
+        // the "Init Workspace" stage wipes the workspace at the start of
+        // every build, and the Workspace Cleanup plugin (cleanWs) is not
+        // installed on this Jenkins.
     }
 }

package/clients/publicis/ps/README.md

@@ -0,0 +1,84 @@
+# Infralytiqs Client Bootstrap — Publicis Sapient (`ps`)
+
+Client-specific Infralytiqs bootstrap for the website
+**https://psassets.publicissapient.com**.
+
+This project ships a single minified JavaScript file (`dist/infralytiqs-bootstrap.min.js`)
+that is deployed to CloudFront and embedded in the host page **after** the
+shared Infralytiqs SDK has loaded.
+
+```
+Host page <head>
+  ├─ <script>window.IL_SERVER_URL = "…"; window.IL_TENANT_ID = "…"; …</script>      ← from Sightly
+  ├─ <script src="https://assets.infralytiqs.com/cdn/infralytiqs.min.js"></script>  ← shared SDK (CDN)
+  └─ <script src="https://assets.infralytiqs.com/cdn/clients/publicis/ps/infralytiqs-bootstrap.min.js"></script>
+```
+
+## Tracked events
+
+| Event              | Trigger                                          | Notes |
+| ------------------ | ------------------------------------------------ | --- |
+| `login_page_view`  | Anonymous user lands on the login page           | Fired in addition to the SDK's auto `page_view` so the Reports login funnel can segment login-page traffic before identify(). |
+| `login_attempt`    | Click on **Sign in** or form submit              | Captures the typed username only — **never** the password. Calls `identify(username)` so subsequent events carry it. |
+| `sso_click`        | Click on **Login with Lion Login** SSO button    | Sends `method: lion_login`, `sso_provider: lion`. |
+| `terms_click`      | Click on **Terms and Conditions** link           | Sends the link `href` and visible text. |
+
+Every event also picks up the global enrichment dimensions (browser, viewport,
+screen, timezone, language, color scheme, tenant, site, origin) so the
+Reports UI can slice by them without per-event instrumentation.
+
+## Configuration contract
+
+The bootstrap reads its configuration from `window.IL_*` globals that **must
+be set by the host page before this script runs** (the AEM Sightly fragment
+`Infralytiqs.html` injects them server-side):
+
+| Global              | Required | Description                              |
+| ------------------- | -------- | ---------------------------------------- |
+| `IL_SERVER_URL`     | Yes      | Base URL of the st-ck-server (Infralytiqs API). |
+| `IL_TENANT_ID`      | Yes      | Tenant id assigned in the Infralytiqs settings. |
+| `IL_SITE_ID`        | Yes      | Site id assigned in the Infralytiqs settings.   |
+| `IL_DB_NAME`        | No       | ClickHouse DB name for the tenant/site.  |
+| `IL_DEBUG`          | No       | `true` enables SDK console logging.      |
+| `IL_CAPTURE_LOCATION` | No     | `true` opts the SDK into the browser geolocation prompt. |
+| `IL_PS_SELECTORS`   | No       | Object overriding the default selectors (see below). |
+
+### Selector overrides
+
+The bootstrap matches DOM controls with a robust default set (id, name,
+data-attribute, href, and visible-text). To opt out of the heuristic, set
+`window.IL_PS_SELECTORS` before this script loads:
+
+```html
+<script>
+  window.IL_PS_SELECTORS = {
+    loginForm:    '#loginForm',
+    signInButton: '#signInButton',
+    userField:    'input[name="username"]',
+    ssoButton:    '#lionLoginBtn',
+    termsLink:    'a#termsAndConditions'
+  };
+</script>
+```
+
+## Building
+
+```bash
+npm install
+npm run build       # produces dist/infralytiqs-bootstrap.{js,min.js}
+npm run dev         # watch mode
+```
+
+The `dist/` directory contains both an unminified (`infralytiqs-bootstrap.js`)
+and a minified (`infralytiqs-bootstrap.min.js`) IIFE. Only the minified file
+is deployed to CloudFront.
+
+## Deployment
+
+Deployment of `dist/infralytiqs-bootstrap.min.js` to the CloudFront-fronted
+S3 bucket is handled by a Jenkins pipeline (TBD). The destination URL is
+expected to be something along the lines of:
+
+```
+https://assets.infralytiqs.com/cdn/clients/publicis/ps/infralytiqs-bootstrap.min.js
+```