feat(monocle-backend,monocle-react,monocle-nextjs) Allow overriding of Monocle domain

.changeset/hip-donkeys-jog.md

@@ -0,0 +1,7 @@
+---
+'@spur.us/monocle-backend': minor
+'@spur.us/monocle-nextjs': minor
+'@spur.us/monocle-react': minor
+---
+
+Allow overriding of Monocle domain

package.json

@@ -15,7 +15,7 @@
     "release:canary": "changeset publish --tag canary",
     "test": "turbo run test",
     "version-packages": "changeset version && pnpm install --lockfile-only --engine-strict=false",
-    "version-packages:canary": "./scripts/canary.mjs",
+    "version-packages:canary": "changeset version --snapshot canary",
     "yalc:all": "for d in packages/*/; do echo $d; cd $d; pnpm yalc push --replace --sig; cd '../../'; done"
   },
   "devDependencies": {
@@ -41,8 +41,7 @@
     "typescript-eslint": "^8.31.0",
     "vitest": "^3.1.2",
     "yalc": "1.0.0-pre.53",
-    "yaml": "^2.7.1",
-    "zx": "catalog:repo"
+    "yaml": "^2.7.1"
   },
   "packageManager": "pnpm@10.8.0",
   "engines": {

packages/monocle-backend/src/__tests__/monocle-client.test.ts

@@ -15,7 +15,7 @@ vi.mock('jose', () => ({
 
 describe('MonocleClient', () => {
   const mockSecretKey = 'test-secret-key';
-  const mockBaseUrl = 'https://api.test.com';
+  const mockBaseDomain = 'test.com';
   const mockEncryptedAssessment = 'encrypted-data';
   const mockDecryptedAssessment: MonocleAssessment = {
     vpn: false,
@@ -38,7 +38,7 @@ describe('MonocleClient', () => {
   beforeEach(() => {
     client = createMonocleClient({
       secretKey: mockSecretKey,
-      baseUrl: mockBaseUrl,
+      baseDomain: mockBaseDomain,
     });
     vi.clearAllMocks();
   });
@@ -47,7 +47,7 @@ describe('MonocleClient', () => {
     it('should throw error when secret key is missing', () => {
       expect(() =>
         createMonocleClient({
-          baseUrl: mockBaseUrl,
+          baseUrl: mockBaseDomain,
           // @ts-expect-error Testing missing secretKey
           secretKey: undefined,
         })
@@ -66,7 +66,7 @@ describe('MonocleClient', () => {
         const result = await client.decryptAssessment(mockEncryptedAssessment);
 
         expect(global.fetch).toHaveBeenCalledWith(
-          `${mockBaseUrl}/api/v1/assessment`,
+          `https://decrypt.${mockBaseDomain}/api/v1/assessment`,
           {
             method: 'POST',
             headers: {

packages/monocle-backend/src/constants.ts

@@ -1,2 +1,2 @@
-export const API_URL = 'https://decrypt.mcl.spur.us';
+export const BASE_DOMAIN = 'mcl.spur.us';
 export const USER_AGENT = `${PACKAGE_NAME}@${PACKAGE_VERSION}`;

packages/monocle-backend/src/monocleClient.ts

@@ -1,6 +1,6 @@
 import { MonocleAssessment } from '@spur.us/types';
 import * as jose from 'jose';
-import { API_URL, USER_AGENT } from './constants.js';
+import { BASE_DOMAIN, USER_AGENT } from './constants.js';
 import { MonocleOptions } from './types.js';
 import {
   MonocleAPIError,
@@ -24,7 +24,7 @@ export class MonocleClient {
   /** The secret key used for API authentication */
   private secretKey: string;
   /** The base URL for API requests */
-  private baseUrl: string;
+  private decryptApiUrl: string;
 
   /**
    * Creates a new MonocleClient instance
@@ -37,7 +37,7 @@ export class MonocleClient {
       });
     }
     this.secretKey = options.secretKey;
-    this.baseUrl = options.baseUrl || API_URL;
+    this.decryptApiUrl = `https://decrypt.${options.baseDomain || BASE_DOMAIN}`;
   }
 
   /**
@@ -67,7 +67,7 @@ export class MonocleClient {
     encryptedAssessment: string
   ): Promise<MonocleAssessment> {
     try {
-      const response = await fetch(`${this.baseUrl}/api/v1/assessment`, {
+      const response = await fetch(`${this.decryptApiUrl}/api/v1/assessment`, {
         method: 'POST',
         headers: {
           'Content-Type': 'text/plain; charset=utf-8',

packages/monocle-backend/src/types.ts

@@ -4,6 +4,6 @@
 export interface MonocleOptions {
   /** The secret key used for authentication with the Monocle API */
   secretKey: string;
-  /** Optional base URL for the Monocle API. Defaults to the standard API URL if not provided */
-  baseUrl?: string;
+  /** Optional base domain for the Monocle API. Defaults to `mcl.spur.us` if not provided */
+  baseDomain?: string;
 }

packages/monocle-nextjs/src/client-boundary/MonocleProvider.tsx

@@ -7,13 +7,20 @@ import { NextMonocleProviderProps } from '../types';
 export const MonocleProvider = ({
   children,
   publishableKey,
+  domain,
   ...rest
 }: NextMonocleProviderProps) => {
   const safePublishableKey =
     publishableKey || process.env.NEXT_PUBLIC_MONOCLE_PUBLISHABLE_KEY || '';
+  const safeDomain =
+    domain || process.env.NEXT_PUBLIC_MONOCLE_DOMAIN || undefined;
 
   return (
-    <ReactMonocleProvider publishableKey={safePublishableKey} {...rest}>
+    <ReactMonocleProvider
+      publishableKey={safePublishableKey}
+      domain={safeDomain}
+      {...rest}
+    >
       {children}
     </ReactMonocleProvider>
   );

packages/monocle-nextjs/src/server/constants.ts

@@ -1 +1,2 @@
+export const DOMAIN = process.env.NEXT_PUBLIC_MONOCLE_DOMAIN || undefined;
 export const SECRET_KEY = process.env.MONOCLE_SECRET_KEY || '';

packages/monocle-nextjs/src/server/monocleClient.ts

@@ -1,9 +1,10 @@
 import { createMonocleClient } from '@spur.us/monocle-backend';
-import { SECRET_KEY } from './constants';
+import { DOMAIN, SECRET_KEY } from './constants';
 
 const monocleClient = async () => {
   return createMonocleClient({
     secretKey: SECRET_KEY,
+    baseDomain: DOMAIN,
   });
 };
 

packages/monocle-react/src/constants.ts

@@ -0,0 +1 @@
+export const DOMAIN = 'mcl.spur.us';

packages/monocle-react/src/contexts/MonocleProvider.tsx

@@ -1,7 +1,7 @@
 import React, { createContext, useContext, useEffect, useState } from 'react';
 import { withMaxAllowedInstancesGuard } from '../utils';
 import { MonocleProviderProps } from '../types';
-
+import { DOMAIN } from '../constants';
 interface MonocleContextType {
   assessment: string | undefined;
   refresh: () => void;
@@ -14,6 +14,7 @@ const MonocleContext = createContext<MonocleContextType | null>(null);
 const MonocleProviderComponent: React.FC<MonocleProviderProps> = ({
   children,
   publishableKey,
+  domain = DOMAIN,
 }) => {
   const [assessment, setAssessment] = useState<string | undefined>(undefined);
   const [isLoading, setIsLoading] = useState(true);
@@ -37,7 +38,7 @@ const MonocleProviderComponent: React.FC<MonocleProviderProps> = ({
       const script = document.createElement('script');
       script.id = '_mcl';
       script.async = true;
-      script.src = `https://mcl.spur.us/d/mcl.js?tk=${publishableKey}`;
+      script.src = `https://${domain}/d/mcl.js?tk=${publishableKey}`;
       script.onload = () => {
         resolve();
       };

packages/monocle-react/src/types.ts

@@ -7,4 +7,6 @@ export interface MonocleProviderProps {
   children: React.ReactNode;
   /** The publishable key used for authentication with Monocle. */
   publishableKey: string;
+  /** Optional base domain for the Monocle API. Defaults to `mcl.spur.us` if not provided */
+  domain?: string;
 }

pnpm-workspace.yaml

@@ -16,4 +16,3 @@ catalogs:
     tslib: 2.8.1
     tsup: 8.4.0
     typescript: 5.8.3
-    zx: 8.4.1