@letpeoplework/lighthouse-client 0.3.1 → 0.5.0

package/dist/index.cjs

@@ -25,6 +25,9 @@ __export(index_exports, {
   getClientPackageContract: () => getClientPackageContract,
   getDefaultMetricsDateRange: () => getDefaultMetricsDateRange,
   parseStandaloneDiscoveryContract: () => parseStandaloneDiscoveryContract,
+  pollCliAuthSession: () => pollCliAuthSession,
+  queryServerAuthMode: () => queryServerAuthMode,
+  startCliAuthSession: () => startCliAuthSession,
   validateLighthouseConnectivity: () => validateLighthouseConnectivity
 });
 module.exports = __toCommonJS(index_exports);
@@ -41,6 +44,25 @@ var SUPPORTED_DISCOVERY_CONTRACT_VERSION = 1;
 var isObjectRecord = (value) => {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 };
+var getErrorMessageWithCause = (error, fallback) => {
+  if (!(error instanceof Error)) {
+    return fallback;
+  }
+  const cause = error.cause;
+  if (cause instanceof Error && cause.message.trim().length > 0) {
+    if (cause.message === error.message) {
+      return error.message;
+    }
+    return `${error.message} (${cause.message})`;
+  }
+  if (typeof cause === "string" && cause.trim().length > 0) {
+    if (cause === error.message) {
+      return error.message;
+    }
+    return `${error.message} (${cause})`;
+  }
+  return error.message;
+};
 var getNormalizedLighthouseUrl = (value) => {
   const trimmed = value.trim();
   if (trimmed.length === 0) {
@@ -139,7 +161,7 @@ var getResolvedEndpoint = (mode, lighthouseUrl) => {
     mode,
     lighthouseUrl,
     apiBaseUrl,
-    healthCheckUrl: `${apiBaseUrl}/v1/version`
+    healthCheckUrl: `${apiBaseUrl}/v1/version/current`
   };
 };
 var getMisconfiguredResult = (reason) => ({
@@ -224,7 +246,10 @@ var validateLighthouseConnectivity = async (configuration, dependencies, request
       endpoint
     };
   } catch (error) {
-    const message = error instanceof Error ? error.message : "Connectivity request failed.";
+    const message = getErrorMessageWithCause(
+      error,
+      "Connectivity request failed."
+    );
     return {
       category: "unreachable",
       reason: message,
@@ -313,6 +338,152 @@ var createLighthouseAuthContext = (store) => ({
     return getStatusFromAuth({ kind: "none" }, "none");
   }
 });
+var mapAuthMode = (serverMode) => {
+  switch (serverMode.toLowerCase()) {
+    case "enabled":
+      return "required";
+    case "disabled":
+      return "disabled";
+    case "blocked":
+      return "blocked";
+    default:
+      return "misconfigured";
+  }
+};
+var getAuthStartFailureCategory = (statusCode) => {
+  if (statusCode === 401 || statusCode === 403) {
+    return "unauthorized";
+  }
+  if (statusCode === 404) {
+    return "misconfigured";
+  }
+  if (statusCode >= 500 && statusCode <= 599) {
+    return "dependency-failure";
+  }
+  return "unexpected";
+};
+var getErrorReasonFromResponse = async (response, fallback) => {
+  try {
+    const body = (await response.text()).trim();
+    if (body.length > 0) {
+      return body;
+    }
+  } catch {
+  }
+  return fallback;
+};
+var queryServerAuthMode = async (endpointUrl, dependencies) => {
+  const normalizedEndpointUrl = getNormalizedLighthouseUrl(endpointUrl);
+  if (normalizedEndpointUrl === null) {
+    return {
+      mode: "misconfigured",
+      misconfigurationMessage: "Server URL is invalid."
+    };
+  }
+  const apiBase = getApiBaseUrl(normalizedEndpointUrl);
+  try {
+    const response = await dependencies.fetch(`${apiBase}/v1/auth/mode`);
+    if (!response.ok) {
+      return {
+        mode: "misconfigured",
+        misconfigurationMessage: await getErrorReasonFromResponse(
+          response,
+          `HTTP ${response.status}`
+        )
+      };
+    }
+    const json = await response.json();
+    return {
+      mode: mapAuthMode(json.mode),
+      misconfigurationMessage: json.misconfigurationMessage
+    };
+  } catch (error) {
+    return {
+      mode: "misconfigured",
+      misconfigurationMessage: getErrorMessageWithCause(
+        error,
+        "Could not reach auth mode endpoint."
+      )
+    };
+  }
+};
+var startCliAuthSession = async (endpointUrl, dependencies) => {
+  const normalizedEndpointUrl = getNormalizedLighthouseUrl(endpointUrl);
+  if (normalizedEndpointUrl === null) {
+    return {
+      status: "error",
+      category: "misconfigured",
+      reason: "Server URL is invalid."
+    };
+  }
+  const apiBase = getApiBaseUrl(normalizedEndpointUrl);
+  try {
+    const response = await dependencies.fetch(
+      `${apiBase}/v1/auth/cli/session`,
+      {
+        method: "POST"
+      }
+    );
+    if (!response.ok) {
+      return {
+        status: "error",
+        category: getAuthStartFailureCategory(response.status),
+        reason: await getErrorReasonFromResponse(
+          response,
+          `HTTP ${response.status}`
+        ),
+        statusCode: response.status
+      };
+    }
+    const json = await response.json();
+    return {
+      status: "started",
+      sessionId: json.sessionId,
+      verificationUrl: json.verificationUrl,
+      expiresAt: json.expiresAt
+    };
+  } catch (error) {
+    return {
+      status: "error",
+      category: "unreachable",
+      reason: getErrorMessageWithCause(
+        error,
+        "Could not reach auth session endpoint."
+      )
+    };
+  }
+};
+var pollCliAuthSession = async (endpointUrl, sessionId, dependencies) => {
+  const normalizedEndpointUrl = getNormalizedLighthouseUrl(endpointUrl);
+  if (normalizedEndpointUrl === null) {
+    return { status: "expired" };
+  }
+  const apiBase = getApiBaseUrl(normalizedEndpointUrl);
+  try {
+    const response = await dependencies.fetch(
+      `${apiBase}/v1/auth/cli/poll/${encodeURIComponent(sessionId)}`
+    );
+    if (response.status === 404) {
+      return { status: "not-found" };
+    }
+    if (!response.ok) {
+      return { status: "expired" };
+    }
+    const json = await response.json();
+    if (json.status === "approved" && json.token && json.userName) {
+      return { status: "approved", token: json.token, userName: json.userName };
+    }
+    if (json.status === "expired") {
+      return { status: "expired" };
+    }
+    if (json.status === "denied") {
+      return { status: "denied" };
+    }
+    return { status: "pending" };
+  } catch {
+    return { status: "expired" };
+  }
+};
 var getDefaultMetricsDateRange = () => {
   const end = /* @__PURE__ */ new Date();
   const start = /* @__PURE__ */ new Date();
@@ -499,7 +670,7 @@ var createLighthouseClient = (configuration, dependencies = {}) => ({
       getRequestInit(configuration.auth)
     );
   },
-  getVersion: async () => requestText(configuration, dependencies, "/v1/version"),
+  getVersion: async () => requestText(configuration, dependencies, "/v1/version/current"),
   listWorkTrackingConnections: async () => requestJson(
     configuration,
     dependencies,
@@ -702,5 +873,8 @@ var createLighthouseClient = (configuration, dependencies = {}) => ({
   getClientPackageContract,
   getDefaultMetricsDateRange,
   parseStandaloneDiscoveryContract,
+  pollCliAuthSession,
+  queryServerAuthMode,
+  startCliAuthSession,
   validateLighthouseConnectivity
 });

package/dist/index.d.cts

@@ -86,6 +86,55 @@ type LighthouseAuthContext = {
     readonly getStatus: (overrides?: LighthouseAuthOverrides) => Promise<LighthouseAuthStatus>;
 };
 declare const createLighthouseAuthContext: (store: LighthouseAuthStore) => LighthouseAuthContext;
+type CliServerAuthMode = "disabled" | "required" | "blocked" | "misconfigured";
+type ServerAuthModeResult = {
+    readonly mode: CliServerAuthMode;
+    readonly misconfigurationMessage?: string;
+};
+type CliAuthSessionStartResult = {
+    readonly status: "started";
+    readonly sessionId: string;
+    readonly verificationUrl: string;
+    readonly expiresAt: string;
+};
+type CliAuthSessionStartError = {
+    readonly status: "error";
+    readonly category: Exclude<ConnectivityCategory, "success">;
+    readonly reason: string;
+    readonly statusCode?: number;
+};
+type CliAuthSessionStartOutcome = CliAuthSessionStartResult | CliAuthSessionStartError;
+type CliAuthSessionPollResult = {
+    readonly status: "pending";
+} | {
+    readonly status: "approved";
+    readonly token: string;
+    readonly userName: string;
+} | {
+    readonly status: "expired";
+} | {
+    readonly status: "denied";
+} | {
+    readonly status: "not-found";
+};
+type CliServerConnection = {
+    readonly mode: "server";
+    readonly endpointUrl: string;
+    readonly authMode: "disabled" | "required";
+    readonly insecure?: boolean;
+    readonly auth?: StoredLighthouseAuth;
+};
+type CliStandaloneConnection = {
+    readonly mode: "standalone";
+    readonly authMode: "disabled";
+};
+type CliConnection = CliServerConnection | CliStandaloneConnection;
+type CliAuthDependencies = {
+    readonly fetch: typeof globalThis.fetch;
+};
+declare const queryServerAuthMode: (endpointUrl: string, dependencies: CliAuthDependencies) => Promise<ServerAuthModeResult>;
+declare const startCliAuthSession: (endpointUrl: string, dependencies: CliAuthDependencies) => Promise<CliAuthSessionStartOutcome>;
+declare const pollCliAuthSession: (endpointUrl: string, sessionId: string, dependencies: CliAuthDependencies) => Promise<CliAuthSessionPollResult>;
 type LighthouseClientConfiguration = {
     readonly connection: LighthouseConnectionConfiguration;
     readonly auth?: LighthouseClientAuth;
@@ -156,4 +205,4 @@ type LighthouseClientDependencies = {
 };
 declare const createLighthouseClient: (configuration: LighthouseClientConfiguration, dependencies?: LighthouseClientDependencies) => LighthouseClient;
 
-export { type BacktestInput, type ClientCapability, type ClientPackageContract, type ConnectivityCategory, type ConnectivityDependencies, type ConnectivityFetchResponse, type ConnectivityValidationResult, type LighthouseApiError, type LighthouseApiResult, type LighthouseAuthContext, type LighthouseAuthOverrides, type LighthouseAuthStatus, type LighthouseAuthStore, type LighthouseClient, type LighthouseClientAuth, type LighthouseClientConfiguration, type LighthouseClientDependencies, type LighthouseConnectionConfiguration, type LighthouseWritePayload, type ManualForecastInput, type MetricsDateRange, type ResolvedLighthouseEndpoint, type StandaloneDiscoveryContract, type StandaloneDiscoveryContractParseResult, type StoredLighthouseAuth, createLighthouseAuthContext, createLighthouseClient, getClientPackageContract, getDefaultMetricsDateRange, parseStandaloneDiscoveryContract, validateLighthouseConnectivity };
+export { type BacktestInput, type CliAuthSessionPollResult, type CliAuthSessionStartError, type CliAuthSessionStartOutcome, type CliAuthSessionStartResult, type CliConnection, type CliServerAuthMode, type CliServerConnection, type CliStandaloneConnection, type ClientCapability, type ClientPackageContract, type ConnectivityCategory, type ConnectivityDependencies, type ConnectivityFetchResponse, type ConnectivityValidationResult, type LighthouseApiError, type LighthouseApiResult, type LighthouseAuthContext, type LighthouseAuthOverrides, type LighthouseAuthStatus, type LighthouseAuthStore, type LighthouseClient, type LighthouseClientAuth, type LighthouseClientConfiguration, type LighthouseClientDependencies, type LighthouseConnectionConfiguration, type LighthouseWritePayload, type ManualForecastInput, type MetricsDateRange, type ResolvedLighthouseEndpoint, type ServerAuthModeResult, type StandaloneDiscoveryContract, type StandaloneDiscoveryContractParseResult, type StoredLighthouseAuth, createLighthouseAuthContext, createLighthouseClient, getClientPackageContract, getDefaultMetricsDateRange, parseStandaloneDiscoveryContract, pollCliAuthSession, queryServerAuthMode, startCliAuthSession, validateLighthouseConnectivity };

package/dist/index.d.ts

@@ -86,6 +86,55 @@ type LighthouseAuthContext = {
     readonly getStatus: (overrides?: LighthouseAuthOverrides) => Promise<LighthouseAuthStatus>;
 };
 declare const createLighthouseAuthContext: (store: LighthouseAuthStore) => LighthouseAuthContext;
+type CliServerAuthMode = "disabled" | "required" | "blocked" | "misconfigured";
+type ServerAuthModeResult = {
+    readonly mode: CliServerAuthMode;
+    readonly misconfigurationMessage?: string;
+};
+type CliAuthSessionStartResult = {
+    readonly status: "started";
+    readonly sessionId: string;
+    readonly verificationUrl: string;
+    readonly expiresAt: string;
+};
+type CliAuthSessionStartError = {
+    readonly status: "error";
+    readonly category: Exclude<ConnectivityCategory, "success">;
+    readonly reason: string;
+    readonly statusCode?: number;
+};
+type CliAuthSessionStartOutcome = CliAuthSessionStartResult | CliAuthSessionStartError;
+type CliAuthSessionPollResult = {
+    readonly status: "pending";
+} | {
+    readonly status: "approved";
+    readonly token: string;
+    readonly userName: string;
+} | {
+    readonly status: "expired";
+} | {
+    readonly status: "denied";
+} | {
+    readonly status: "not-found";
+};
+type CliServerConnection = {
+    readonly mode: "server";
+    readonly endpointUrl: string;
+    readonly authMode: "disabled" | "required";
+    readonly insecure?: boolean;
+    readonly auth?: StoredLighthouseAuth;
+};
+type CliStandaloneConnection = {
+    readonly mode: "standalone";
+    readonly authMode: "disabled";
+};
+type CliConnection = CliServerConnection | CliStandaloneConnection;
+type CliAuthDependencies = {
+    readonly fetch: typeof globalThis.fetch;
+};
+declare const queryServerAuthMode: (endpointUrl: string, dependencies: CliAuthDependencies) => Promise<ServerAuthModeResult>;
+declare const startCliAuthSession: (endpointUrl: string, dependencies: CliAuthDependencies) => Promise<CliAuthSessionStartOutcome>;
+declare const pollCliAuthSession: (endpointUrl: string, sessionId: string, dependencies: CliAuthDependencies) => Promise<CliAuthSessionPollResult>;
 type LighthouseClientConfiguration = {
     readonly connection: LighthouseConnectionConfiguration;
     readonly auth?: LighthouseClientAuth;
@@ -156,4 +205,4 @@ type LighthouseClientDependencies = {
 };
 declare const createLighthouseClient: (configuration: LighthouseClientConfiguration, dependencies?: LighthouseClientDependencies) => LighthouseClient;
 
-export { type BacktestInput, type ClientCapability, type ClientPackageContract, type ConnectivityCategory, type ConnectivityDependencies, type ConnectivityFetchResponse, type ConnectivityValidationResult, type LighthouseApiError, type LighthouseApiResult, type LighthouseAuthContext, type LighthouseAuthOverrides, type LighthouseAuthStatus, type LighthouseAuthStore, type LighthouseClient, type LighthouseClientAuth, type LighthouseClientConfiguration, type LighthouseClientDependencies, type LighthouseConnectionConfiguration, type LighthouseWritePayload, type ManualForecastInput, type MetricsDateRange, type ResolvedLighthouseEndpoint, type StandaloneDiscoveryContract, type StandaloneDiscoveryContractParseResult, type StoredLighthouseAuth, createLighthouseAuthContext, createLighthouseClient, getClientPackageContract, getDefaultMetricsDateRange, parseStandaloneDiscoveryContract, validateLighthouseConnectivity };
+export { type BacktestInput, type CliAuthSessionPollResult, type CliAuthSessionStartError, type CliAuthSessionStartOutcome, type CliAuthSessionStartResult, type CliConnection, type CliServerAuthMode, type CliServerConnection, type CliStandaloneConnection, type ClientCapability, type ClientPackageContract, type ConnectivityCategory, type ConnectivityDependencies, type ConnectivityFetchResponse, type ConnectivityValidationResult, type LighthouseApiError, type LighthouseApiResult, type LighthouseAuthContext, type LighthouseAuthOverrides, type LighthouseAuthStatus, type LighthouseAuthStore, type LighthouseClient, type LighthouseClientAuth, type LighthouseClientConfiguration, type LighthouseClientDependencies, type LighthouseConnectionConfiguration, type LighthouseWritePayload, type ManualForecastInput, type MetricsDateRange, type ResolvedLighthouseEndpoint, type ServerAuthModeResult, type StandaloneDiscoveryContract, type StandaloneDiscoveryContractParseResult, type StoredLighthouseAuth, createLighthouseAuthContext, createLighthouseClient, getClientPackageContract, getDefaultMetricsDateRange, parseStandaloneDiscoveryContract, pollCliAuthSession, queryServerAuthMode, startCliAuthSession, validateLighthouseConnectivity };

package/dist/index.js

@@ -12,6 +12,25 @@ var SUPPORTED_DISCOVERY_CONTRACT_VERSION = 1;
 var isObjectRecord = (value) => {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 };
+var getErrorMessageWithCause = (error, fallback) => {
+  if (!(error instanceof Error)) {
+    return fallback;
+  }
+  const cause = error.cause;
+  if (cause instanceof Error && cause.message.trim().length > 0) {
+    if (cause.message === error.message) {
+      return error.message;
+    }
+    return `${error.message} (${cause.message})`;
+  }
+  if (typeof cause === "string" && cause.trim().length > 0) {
+    if (cause === error.message) {
+      return error.message;
+    }
+    return `${error.message} (${cause})`;
+  }
+  return error.message;
+};
 var getNormalizedLighthouseUrl = (value) => {
   const trimmed = value.trim();
   if (trimmed.length === 0) {
@@ -110,7 +129,7 @@ var getResolvedEndpoint = (mode, lighthouseUrl) => {
     mode,
     lighthouseUrl,
     apiBaseUrl,
-    healthCheckUrl: `${apiBaseUrl}/v1/version`
+    healthCheckUrl: `${apiBaseUrl}/v1/version/current`
   };
 };
 var getMisconfiguredResult = (reason) => ({
@@ -195,7 +214,10 @@ var validateLighthouseConnectivity = async (configuration, dependencies, request
       endpoint
     };
   } catch (error) {
-    const message = error instanceof Error ? error.message : "Connectivity request failed.";
+    const message = getErrorMessageWithCause(
+      error,
+      "Connectivity request failed."
+    );
     return {
       category: "unreachable",
       reason: message,
@@ -284,6 +306,152 @@ var createLighthouseAuthContext = (store) => ({
     return getStatusFromAuth({ kind: "none" }, "none");
   }
 });
+var mapAuthMode = (serverMode) => {
+  switch (serverMode.toLowerCase()) {
+    case "enabled":
+      return "required";
+    case "disabled":
+      return "disabled";
+    case "blocked":
+      return "blocked";
+    default:
+      return "misconfigured";
+  }
+};
+var getAuthStartFailureCategory = (statusCode) => {
+  if (statusCode === 401 || statusCode === 403) {
+    return "unauthorized";
+  }
+  if (statusCode === 404) {
+    return "misconfigured";
+  }
+  if (statusCode >= 500 && statusCode <= 599) {
+    return "dependency-failure";
+  }
+  return "unexpected";
+};
+var getErrorReasonFromResponse = async (response, fallback) => {
+  try {
+    const body = (await response.text()).trim();
+    if (body.length > 0) {
+      return body;
+    }
+  } catch {
+  }
+  return fallback;
+};
+var queryServerAuthMode = async (endpointUrl, dependencies) => {
+  const normalizedEndpointUrl = getNormalizedLighthouseUrl(endpointUrl);
+  if (normalizedEndpointUrl === null) {
+    return {
+      mode: "misconfigured",
+      misconfigurationMessage: "Server URL is invalid."
+    };
+  }
+  const apiBase = getApiBaseUrl(normalizedEndpointUrl);
+  try {
+    const response = await dependencies.fetch(`${apiBase}/v1/auth/mode`);
+    if (!response.ok) {
+      return {
+        mode: "misconfigured",
+        misconfigurationMessage: await getErrorReasonFromResponse(
+          response,
+          `HTTP ${response.status}`
+        )
+      };
+    }
+    const json = await response.json();
+    return {
+      mode: mapAuthMode(json.mode),
+      misconfigurationMessage: json.misconfigurationMessage
+    };
+  } catch (error) {
+    return {
+      mode: "misconfigured",
+      misconfigurationMessage: getErrorMessageWithCause(
+        error,
+        "Could not reach auth mode endpoint."
+      )
+    };
+  }
+};
+var startCliAuthSession = async (endpointUrl, dependencies) => {
+  const normalizedEndpointUrl = getNormalizedLighthouseUrl(endpointUrl);
+  if (normalizedEndpointUrl === null) {
+    return {
+      status: "error",
+      category: "misconfigured",
+      reason: "Server URL is invalid."
+    };
+  }
+  const apiBase = getApiBaseUrl(normalizedEndpointUrl);
+  try {
+    const response = await dependencies.fetch(
+      `${apiBase}/v1/auth/cli/session`,
+      {
+        method: "POST"
+      }
+    );
+    if (!response.ok) {
+      return {
+        status: "error",
+        category: getAuthStartFailureCategory(response.status),
+        reason: await getErrorReasonFromResponse(
+          response,
+          `HTTP ${response.status}`
+        ),
+        statusCode: response.status
+      };
+    }
+    const json = await response.json();
+    return {
+      status: "started",
+      sessionId: json.sessionId,
+      verificationUrl: json.verificationUrl,
+      expiresAt: json.expiresAt
+    };
+  } catch (error) {
+    return {
+      status: "error",
+      category: "unreachable",
+      reason: getErrorMessageWithCause(
+        error,
+        "Could not reach auth session endpoint."
+      )
+    };
+  }
+};
+var pollCliAuthSession = async (endpointUrl, sessionId, dependencies) => {
+  const normalizedEndpointUrl = getNormalizedLighthouseUrl(endpointUrl);
+  if (normalizedEndpointUrl === null) {
+    return { status: "expired" };
+  }
+  const apiBase = getApiBaseUrl(normalizedEndpointUrl);
+  try {
+    const response = await dependencies.fetch(
+      `${apiBase}/v1/auth/cli/poll/${encodeURIComponent(sessionId)}`
+    );
+    if (response.status === 404) {
+      return { status: "not-found" };
+    }
+    if (!response.ok) {
+      return { status: "expired" };
+    }
+    const json = await response.json();
+    if (json.status === "approved" && json.token && json.userName) {
+      return { status: "approved", token: json.token, userName: json.userName };
+    }
+    if (json.status === "expired") {
+      return { status: "expired" };
+    }
+    if (json.status === "denied") {
+      return { status: "denied" };
+    }
+    return { status: "pending" };
+  } catch {
+    return { status: "expired" };
+  }
+};
 var getDefaultMetricsDateRange = () => {
   const end = /* @__PURE__ */ new Date();
   const start = /* @__PURE__ */ new Date();
@@ -470,7 +638,7 @@ var createLighthouseClient = (configuration, dependencies = {}) => ({
       getRequestInit(configuration.auth)
     );
   },
-  getVersion: async () => requestText(configuration, dependencies, "/v1/version"),
+  getVersion: async () => requestText(configuration, dependencies, "/v1/version/current"),
   listWorkTrackingConnections: async () => requestJson(
     configuration,
     dependencies,
@@ -672,5 +840,8 @@ export {
   getClientPackageContract,
   getDefaultMetricsDateRange,
   parseStandaloneDiscoveryContract,
+  pollCliAuthSession,
+  queryServerAuthMode,
+  startCliAuthSession,
   validateLighthouseConnectivity
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@letpeoplework/lighthouse-client",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "description": "Shared Lighthouse API client contracts",
   "repository": "https://github.com/LetPeopleWork/lighthouse-clients",
   "type": "module",