@polyguard/sdk 1.5.0 → 1.5.1

package/scripts/regenerate-client.sh

@@ -1,59 +0,0 @@
-#!/bin/bash
-
-# Navigate to the script's directory
-cd "$(dirname "$0")/.."
-
-# Step 1: Download the OpenAPI specification
-echo "Downloading OpenAPI specification..."
-curl -o openapi.json https://api.actual.video/openapi.json
-
-# Check if curl was successful
-if [ $? -ne 0 ]; then
-    echo "Failed to download OpenAPI specification. Aborting."
-    exit 1
-fi
-
-# Step 2: Run the OpenAPI generator using Docker
-echo "Generating client from OpenAPI specification..."
-docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli generate \
-    -i /local/openapi.json \
-    -g javascript \
-    -o /local/src/generated \
-    --skip-validate-spec \
-    --additional-properties=legacyDiscriminatorBehavior=false
-
-# Check if generation was successful
-if [ $? -ne 0 ]; then
-    echo "Client generation failed. Aborting."
-    rm openapi.json # Clean up downloaded spec
-    exit 1
-fi
-
-# Step 3: Remove problematic model files
-echo "Removing problematic model files..."
-rm -f src/generated/src/model/Certainty.js
-rm -f src/generated/src/model/ValidationErrorLocInner.js
-rm -f src/generated/src/model/AppId.js
-
-# Step 4: Comment out invalid import statements in generated code
-echo "Patching generated files..."
-find src/generated -type f -name "*.js" -print0 | xargs -0 sed -i.bak "s/import Certainty from '.\/model\/Certainty';/\/\/ import Certainty from '.\/model\/Certainty';/"
-find src/generated -type f -name "*.js" -print0 | xargs -0 sed -i.bak "s/import ValidationErrorLocInner from '.\/model\/ValidationErrorLocInner';/\/\/ import ValidationErrorLocInner from '.\/model\/ValidationErrorLocInner';/"
-find src/generated -type f -name "*.js" -print0 | xargs -0 sed -i.bak "s/import AppId from '.\/model\/AppId';/\/\/ import AppId from '.\/model\/AppId';/"
-find src/generated -type f -name "*.js" -print0 | xargs -0 sed -i.bak "s/import Certainty from '.\/Certainty';/\/\/ import Certainty from '.\/Certainty';/"
-find src/generated -type f -name "*.js" -print0 | xargs -0 sed -i.bak "s/import ValidationErrorLocInner from '.\/ValidationErrorLocInner';/\/\/ import ValidationErrorLocInner from '.\/ValidationErrorLocInner';/"
-find src/generated -type f -name "*.js" -print0 | xargs -0 sed -i.bak "s/import AppId from '.\/AppId';/\/\/ import AppId from '.\/AppId';/"
-
-# Also comment out the exports of the removed models
-find src/generated -type f -name "*.js" -print0 | xargs -0 sed -i.bak "s/    Certainty,/\/\/    Certainty,/"
-find src/generated -type f -name "*.js" -print0 | xargs -0 sed -i.bak "s/    ValidationErrorLocInner,/\/\/    ValidationErrorLocInner,/"
-find src/generated -type f -name "*.js" -print0 | xargs -0 sed -i.bak "s/    AppId,/\/\/    AppId,/"
-
-# Remove backup files created by sed
-find src/generated -type f -name "*.js.bak" -delete
-
-# Step 5: Clean up the downloaded specification file
-echo "Cleaning up..."
-rm openapi.json
-
-echo "Client regeneration complete." 

package/src/PolyguardClient.js

@@ -1,25 +0,0 @@
-import { PolyguardWebsocketClientImpl } from './PolyguardWebsocketClientImpl';
-
-export class PolyguardClient {
-  constructor(params = {}) {
-    // Choose implementation based on integrationType
-    let impl;
-    switch (params.integrationType) {
-      case 'websocket':
-      default:
-        impl = new PolyguardWebsocketClientImpl(params);
-        break;
-    }
-    this._impl = impl;
-    // Copy API services and properties from impl to this
-    for (const key in impl) {
-      if (Object.prototype.hasOwnProperty.call(impl, key)) {
-        this[key] = impl[key];
-      }
-    }
-  }
-
-  async verify(...args) {
-    return this._impl.verify(...args);
-  }
-}

package/src/PolyguardWebsocketClientImpl.js

@@ -1,198 +0,0 @@
-import ReconnectingWebSocket from 'reconnecting-websocket';
-import * as PolyguardApi from './generated/src';
-import { buildModal, showSpinner } from './ui.js';
-import { fetchTicket } from './ticketService.js';
-import { handleWebSocketMessage } from './messageHandler.js';
-
-// Implementation class for websocket integration
-export class PolyguardWebsocketClientImpl {
-  constructor(params = {}) {
-    this.apiClient = new PolyguardApi.ApiClient();
-    const { apiKey, baseUrl, appId, apiServer, proxyUrl, iKnowThisIsInsecure, requiredProofs = ['Full Name'], scanType = 'single', redirectUrl, callbackUrl, cookieName, link_uuid, sidebarUrl } = params;
-    this.sidebarUrl = sidebarUrl;
-
-    if (apiKey && typeof window !== 'undefined' && iKnowThisIsInsecure !== true) {
-      throw new Error(
-        'apiKey is forbidden in browser code; use proxyUrl with a server-side proxy (see @polyguard/sdk/server). ' +
-        'Set iKnowThisIsInsecure: true to bypass.'
-      );
-    }
-
-    if (proxyUrl) {
-      this.apiClient.basePath = proxyUrl.replace(/\/$/, '');
-    } else if (baseUrl) {
-      this.apiClient.basePath = baseUrl;
-    }
-
-    if (apiKey) {
-      if (this.apiClient.authentications['bearerAuth']) {
-        this.apiClient.authentications['bearerAuth'].apiKey = apiKey;
-      }
-      this.apiClient.defaultHeaders = this.apiClient.defaultHeaders || {};
-      this.apiClient.defaultHeaders['x-pg-api-key'] = apiKey;
-    }
-    // Instantiate all API services
-    for (const key in PolyguardApi) {
-      if (key.endsWith('Api')) {
-        const apiName = key.charAt(0).toLowerCase() + key.slice(1);
-        this[apiName] = new PolyguardApi[key](this.apiClient);
-      }
-    }
-    // Polyguard auth params
-    this.integrationType = 'websocket';
-    this.appId = appId;
-    this.apiServer = apiServer;
-    this.proxyUrl = proxyUrl;
-    this.requiredProofs = requiredProofs;
-    this.scanType = scanType;
-    this.redirectUrl = redirectUrl;
-    this.callbackUrl = callbackUrl;
-    this.cookieName = cookieName;
-    this.link_uuid = link_uuid;
-  }
-
-  buildModal() {
-    return buildModal();
-  }
-
-  async verify(target = null, rawJwt = false) {
-    let modal = null;
-    let qrDiv = null;
-    let isTargetMode = false;
-
-    if (target) {
-      isTargetMode = true;
-      qrDiv = document.getElementById(target);
-      if (!qrDiv) {
-        throw new Error(`Target element with ID '${target}' not found`);
-      }
-    } else {
-      modal = buildModal();
-    }
-
-    if (!isTargetMode) {
-      document.body.appendChild(modal);
-      qrDiv = modal.querySelector('#polyguard-qr');
-    }
-
-    if (qrDiv) {
-      showSpinner(qrDiv);
-    }
-
-    function cleanup() {
-      if (isTargetMode) {
-        if (qrDiv) {
-          qrDiv.innerHTML = '';
-        }
-      } else if (modal && modal.parentNode) {
-        modal.parentNode.removeChild(modal);
-      }
-    }
-
-    return new Promise(async (resolve, reject) => {
-      let ws = null;
-      let closed = false;
-
-      function returnError(msg, score = "OFFLINE") {
-        if (isTargetMode) {
-          console.error('Polyguard Error:', msg);
-          cleanup();
-          resolve({presence: { score: score, msg: msg }});
-        } else {
-          const errDiv = modal.querySelector('#polyguard-error');
-          if (errDiv) {
-            errDiv.textContent = msg;
-            errDiv.style.display = 'block';
-          }
-          setTimeout(() => {
-            cleanup();
-            resolve({presence: { score: score, msg: msg }});
-          }, 1250);
-        }
-      }
-      function clearError() {
-        if (!isTargetMode) {
-          const errDiv = modal.querySelector('#polyguard-error');
-          if (errDiv) errDiv.style.display = 'none';
-        }
-      }
-      function handleClose() {
-        closed = true;
-        if (ws) ws.close();
-        cleanup();
-        reject(new Error('User cancelled'));
-      }
-
-      if (!isTargetMode) {
-        modal.querySelector('#polyguard-modal-close').onclick = handleClose;
-        modal.querySelector('#polyguard-modal-cancel').onclick = handleClose;
-      }
-
-      try {
-        clearError();
-        const wsProtocol = window.location.protocol === 'https:' ? 'wss' : 'ws';
-
-        const newTicket = await fetchTicket({
-          apiServer: this.apiServer,
-          proxyUrl: this.proxyUrl,
-          appId: this.appId,
-          link_uuid: this.link_uuid,
-          requiredProofs: this.requiredProofs,
-          scanType: this.scanType,
-        });
-
-        const wsUrl = `${wsProtocol}://${this.apiServer}/v2/realtime/${newTicket}`;
-        const options = {
-          maxRetries: 10,
-          minTimeout: 1000,
-          maxTimeout: 10000,
-          reconnectionDelay: 1000,
-          reconnectionDelayGrowFactor: 1.5,
-        };
-        ws = new ReconnectingWebSocket(wsUrl, [], options);
-
-        const markClosed = () => { closed = true; };
-        const ctx = { ws, qrDiv, isTargetMode, modal, cleanup, markClosed, returnError, clearError, resolve, rawJwt, sidebarUrl: this.sidebarUrl, link_uuid: this.link_uuid };
-        ws.addEventListener('message', (event) => handleWebSocketMessage(event, ctx));
-
-        ws.addEventListener('error', () => {
-          console.error('WebSocket error');
-          returnError('WebSocket error');
-        });
-        ws.addEventListener('close', () => {
-          if (!closed) cleanup();
-        });
-      } catch (err) {
-        returnError(err.message === 'Failed to get ticket' || err.message === 'No ticket returned from server'
-          ? err.message
-          : 'Failed to connect to WebSocket');
-      }
-    });
-  }
-
-  /**
-   * Wrapper around verify that checks received proof values against expected values.
-   * @param {Object} expectedProofs - An object mapping proof names to expected values.
-   * @param {string} target - Optional ID of target element to render QR code in.
-   * @returns {Promise<boolean>} - Resolves to true if all expected proofs match, false otherwise or if cancelled.
-   */
-  async require(expectedProofs = {}, target = null) {
-    try {
-      const jwt = await this.verify(target);
-      if (!jwt) return false;
-      // Decode JWT (without verifying signature)
-      const payload = JSON.parse(atob(jwt.split('.')[1]));
-      console.dir(payload);
-      // Check each expected proof
-      for (const [proof, expectedValue] of Object.entries(expectedProofs)) {
-        if (payload[proof] !== expectedValue) {
-          return false;
-        }
-      }
-      return true;
-    } catch (err) {
-      // If modal is cancelled or error occurs, return false
-      return false;
-    }
-  }
-}

package/src/__tests__/PolyguardClient.test.js

@@ -1,65 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { DEFAULT_PARAMS } from './helpers/fixtures.js';
-
-// Mock the WebSocket impl so the facade tests never touch real internals
-vi.mock('../PolyguardWebsocketClientImpl', () => {
-  class FakeImpl {
-    constructor(params = {}) {
-      this.appId = params.appId;
-      this.apiServer = params.apiServer;
-      this.integrationType = 'websocket';
-      this.blockingApi = { fake: true };
-      this.callsApi = { fake: true };
-    }
-    async verify(...args) {
-      return { args, result: 'fake-jwt' };
-    }
-  }
-  return { PolyguardWebsocketClientImpl: FakeImpl };
-});
-
-// Import after mock is set up
-const { PolyguardClient } = await import('../PolyguardClient.js');
-
-describe('PolyguardClient', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it('defaults to websocket implementation', () => {
-    const client = new PolyguardClient(DEFAULT_PARAMS);
-    expect(client._impl).toBeDefined();
-    expect(client._impl.integrationType).toBe('websocket');
-  });
-
-  it('explicit integrationType websocket works the same', () => {
-    const client = new PolyguardClient({ ...DEFAULT_PARAMS, integrationType: 'websocket' });
-    expect(client._impl.integrationType).toBe('websocket');
-  });
-
-  it('copies properties from impl to facade', () => {
-    const client = new PolyguardClient(DEFAULT_PARAMS);
-    expect(client.appId).toBe(DEFAULT_PARAMS.appId);
-    expect(client.apiServer).toBe(DEFAULT_PARAMS.apiServer);
-    expect(client.integrationType).toBe('websocket');
-    expect(client.blockingApi).toEqual({ fake: true });
-    expect(client.callsApi).toEqual({ fake: true });
-  });
-
-  it('verify() delegates to _impl.verify() with all args forwarded', async () => {
-    const client = new PolyguardClient(DEFAULT_PARAMS);
-    const spy = vi.spyOn(client._impl, 'verify');
-    await client.verify('my-target', true);
-    expect(spy).toHaveBeenCalledWith('my-target', true);
-  });
-
-  it('verify() returns the impl result', async () => {
-    const client = new PolyguardClient(DEFAULT_PARAMS);
-    const result = await client.verify('t', false);
-    expect(result).toEqual({ args: ['t', false], result: 'fake-jwt' });
-  });
-
-  it('constructor with no params does not throw', () => {
-    expect(() => new PolyguardClient()).not.toThrow();
-  });
-});