@letpeoplework/lighthouse-client 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 LetPeopleWork
+
+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.

package/dist/index.d.mts

@@ -0,0 +1,132 @@
+type ClientCapability = "versioned-api-contracts" | "shared-domain-operations" | "connectivity-and-discovery-contracts" | "automation-auth-contracts";
+type ClientPackageContract = {
+    readonly name: "@letpeoplework/lighthouse-client";
+    readonly capabilities: readonly ClientCapability[];
+};
+declare const getClientPackageContract: () => ClientPackageContract;
+type ConnectivityCategory = "success" | "unreachable" | "misconfigured" | "unauthorized" | "dependency-failure" | "unexpected";
+type StandaloneDiscoveryContract = {
+    readonly contractVersion: 1;
+    readonly lighthouseUrl: string;
+    readonly detectedAtUtc: string;
+};
+type StandaloneDiscoveryContractParseResult = {
+    readonly isValid: true;
+    readonly contract: StandaloneDiscoveryContract;
+} | {
+    readonly isValid: false;
+    readonly reason: string;
+};
+type LighthouseConnectionConfiguration = {
+    readonly kind: "explicit";
+    readonly lighthouseUrl: string;
+} | {
+    readonly kind: "standalone";
+    readonly getDiscoveryContract: () => Promise<StandaloneDiscoveryContract | null>;
+};
+type ConnectivityFetchResponse = {
+    readonly ok: boolean;
+    readonly status: number;
+    readonly text: () => Promise<string>;
+    readonly json?: () => Promise<unknown>;
+};
+type ConnectivityDependencies = {
+    readonly fetch: (url: string, init?: RequestInit) => Promise<ConnectivityFetchResponse>;
+};
+type ResolvedLighthouseEndpoint = {
+    readonly mode: "explicit" | "standalone";
+    readonly lighthouseUrl: string;
+    readonly apiBaseUrl: string;
+    readonly healthCheckUrl: string;
+};
+type ConnectivityValidationResult = {
+    readonly category: "success";
+    readonly endpoint: ResolvedLighthouseEndpoint;
+    readonly serverVersion: string;
+} | {
+    readonly category: Exclude<ConnectivityCategory, "success">;
+    readonly reason: string;
+    readonly statusCode?: number;
+    readonly endpoint?: ResolvedLighthouseEndpoint;
+};
+declare const parseStandaloneDiscoveryContract: (serializedContract: string) => StandaloneDiscoveryContractParseResult;
+declare const validateLighthouseConnectivity: (configuration: LighthouseConnectionConfiguration, dependencies: ConnectivityDependencies, requestInit?: RequestInit) => Promise<ConnectivityValidationResult>;
+type LighthouseClientAuth = {
+    readonly kind: "none";
+} | {
+    readonly kind: "api-key";
+    readonly value: string;
+    readonly headerName?: string;
+} | {
+    readonly kind: "bearer-token";
+    readonly token: string;
+};
+type StoredLighthouseAuth = Exclude<LighthouseClientAuth, {
+    kind: "none";
+}>;
+type LighthouseAuthOverrides = {
+    readonly apiKey?: string;
+    readonly bearerToken?: string;
+    readonly apiKeyHeaderName?: string;
+};
+type LighthouseAuthStatus = {
+    readonly isAuthenticated: boolean;
+    readonly kind: LighthouseClientAuth["kind"];
+    readonly source: "none" | "stored" | "override";
+};
+type LighthouseAuthStore = {
+    readonly load: () => Promise<StoredLighthouseAuth | null>;
+    readonly save: (auth: StoredLighthouseAuth) => Promise<void>;
+    readonly clear: () => Promise<void>;
+};
+type LighthouseAuthContext = {
+    readonly resolveAuth: (overrides?: LighthouseAuthOverrides) => Promise<LighthouseClientAuth>;
+    readonly login: (overrides: LighthouseAuthOverrides) => Promise<void>;
+    readonly logout: () => Promise<void>;
+    readonly getStatus: (overrides?: LighthouseAuthOverrides) => Promise<LighthouseAuthStatus>;
+};
+declare const createLighthouseAuthContext: (store: LighthouseAuthStore) => LighthouseAuthContext;
+type LighthouseClientConfiguration = {
+    readonly connection: LighthouseConnectionConfiguration;
+    readonly auth?: LighthouseClientAuth;
+};
+type LighthouseApiError = {
+    readonly category: ConnectivityCategory;
+    readonly reason: string;
+    readonly statusCode?: number;
+};
+type LighthouseApiResult<TValue> = {
+    readonly ok: true;
+    readonly value: TValue;
+} | {
+    readonly ok: false;
+    readonly error: LighthouseApiError;
+};
+type LighthouseWritePayload = Readonly<Record<string, unknown>>;
+type LighthouseClient = {
+    readonly checkConnectivity: () => Promise<ConnectivityValidationResult>;
+    readonly getVersion: () => Promise<LighthouseApiResult<string>>;
+    readonly listWorkTrackingConnections: () => Promise<LighthouseApiResult<readonly unknown[]>>;
+    readonly getWorkTrackingConnection: (connectionId: number) => Promise<LighthouseApiResult<unknown>>;
+    readonly createWorkTrackingConnection: (payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly updateWorkTrackingConnection: (connectionId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly deleteWorkTrackingConnection: (connectionId: number) => Promise<LighthouseApiResult<void>>;
+    readonly listTeams: () => Promise<LighthouseApiResult<readonly unknown[]>>;
+    readonly getTeam: (teamId: number) => Promise<LighthouseApiResult<unknown>>;
+    readonly createTeam: (payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly updateTeam: (teamId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly deleteTeam: (teamId: number) => Promise<LighthouseApiResult<void>>;
+    readonly refreshTeam: (teamId: number) => Promise<LighthouseApiResult<void>>;
+    readonly listPortfolios: () => Promise<LighthouseApiResult<readonly unknown[]>>;
+    readonly getPortfolio: (portfolioId: number) => Promise<LighthouseApiResult<unknown>>;
+    readonly createPortfolio: (payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly updatePortfolio: (portfolioId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly deletePortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
+    readonly refreshPortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
+};
+type LighthouseClientDependencies = {
+    readonly fetch?: (url: string, init?: RequestInit) => Promise<ConnectivityFetchResponse>;
+};
+declare const createLighthouseClient: (configuration: LighthouseClientConfiguration, dependencies?: LighthouseClientDependencies) => LighthouseClient;
+
+export { 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 ResolvedLighthouseEndpoint, type StandaloneDiscoveryContract, type StandaloneDiscoveryContractParseResult, type StoredLighthouseAuth, createLighthouseAuthContext, createLighthouseClient, getClientPackageContract, parseStandaloneDiscoveryContract, validateLighthouseConnectivity };

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+type ClientCapability = "versioned-api-contracts" | "shared-domain-operations" | "connectivity-and-discovery-contracts" | "automation-auth-contracts";
+type ClientPackageContract = {
+    readonly name: "@letpeoplework/lighthouse-client";
+    readonly capabilities: readonly ClientCapability[];
+};
+declare const getClientPackageContract: () => ClientPackageContract;
+type ConnectivityCategory = "success" | "unreachable" | "misconfigured" | "unauthorized" | "dependency-failure" | "unexpected";
+type StandaloneDiscoveryContract = {
+    readonly contractVersion: 1;
+    readonly lighthouseUrl: string;
+    readonly detectedAtUtc: string;
+};
+type StandaloneDiscoveryContractParseResult = {
+    readonly isValid: true;
+    readonly contract: StandaloneDiscoveryContract;
+} | {
+    readonly isValid: false;
+    readonly reason: string;
+};
+type LighthouseConnectionConfiguration = {
+    readonly kind: "explicit";
+    readonly lighthouseUrl: string;
+} | {
+    readonly kind: "standalone";
+    readonly getDiscoveryContract: () => Promise<StandaloneDiscoveryContract | null>;
+};
+type ConnectivityFetchResponse = {
+    readonly ok: boolean;
+    readonly status: number;
+    readonly text: () => Promise<string>;
+    readonly json?: () => Promise<unknown>;
+};
+type ConnectivityDependencies = {
+    readonly fetch: (url: string, init?: RequestInit) => Promise<ConnectivityFetchResponse>;
+};
+type ResolvedLighthouseEndpoint = {
+    readonly mode: "explicit" | "standalone";
+    readonly lighthouseUrl: string;
+    readonly apiBaseUrl: string;
+    readonly healthCheckUrl: string;
+};
+type ConnectivityValidationResult = {
+    readonly category: "success";
+    readonly endpoint: ResolvedLighthouseEndpoint;
+    readonly serverVersion: string;
+} | {
+    readonly category: Exclude<ConnectivityCategory, "success">;
+    readonly reason: string;
+    readonly statusCode?: number;
+    readonly endpoint?: ResolvedLighthouseEndpoint;
+};
+declare const parseStandaloneDiscoveryContract: (serializedContract: string) => StandaloneDiscoveryContractParseResult;
+declare const validateLighthouseConnectivity: (configuration: LighthouseConnectionConfiguration, dependencies: ConnectivityDependencies, requestInit?: RequestInit) => Promise<ConnectivityValidationResult>;
+type LighthouseClientAuth = {
+    readonly kind: "none";
+} | {
+    readonly kind: "api-key";
+    readonly value: string;
+    readonly headerName?: string;
+} | {
+    readonly kind: "bearer-token";
+    readonly token: string;
+};
+type StoredLighthouseAuth = Exclude<LighthouseClientAuth, {
+    kind: "none";
+}>;
+type LighthouseAuthOverrides = {
+    readonly apiKey?: string;
+    readonly bearerToken?: string;
+    readonly apiKeyHeaderName?: string;
+};
+type LighthouseAuthStatus = {
+    readonly isAuthenticated: boolean;
+    readonly kind: LighthouseClientAuth["kind"];
+    readonly source: "none" | "stored" | "override";
+};
+type LighthouseAuthStore = {
+    readonly load: () => Promise<StoredLighthouseAuth | null>;
+    readonly save: (auth: StoredLighthouseAuth) => Promise<void>;
+    readonly clear: () => Promise<void>;
+};
+type LighthouseAuthContext = {
+    readonly resolveAuth: (overrides?: LighthouseAuthOverrides) => Promise<LighthouseClientAuth>;
+    readonly login: (overrides: LighthouseAuthOverrides) => Promise<void>;
+    readonly logout: () => Promise<void>;
+    readonly getStatus: (overrides?: LighthouseAuthOverrides) => Promise<LighthouseAuthStatus>;
+};
+declare const createLighthouseAuthContext: (store: LighthouseAuthStore) => LighthouseAuthContext;
+type LighthouseClientConfiguration = {
+    readonly connection: LighthouseConnectionConfiguration;
+    readonly auth?: LighthouseClientAuth;
+};
+type LighthouseApiError = {
+    readonly category: ConnectivityCategory;
+    readonly reason: string;
+    readonly statusCode?: number;
+};
+type LighthouseApiResult<TValue> = {
+    readonly ok: true;
+    readonly value: TValue;
+} | {
+    readonly ok: false;
+    readonly error: LighthouseApiError;
+};
+type LighthouseWritePayload = Readonly<Record<string, unknown>>;
+type LighthouseClient = {
+    readonly checkConnectivity: () => Promise<ConnectivityValidationResult>;
+    readonly getVersion: () => Promise<LighthouseApiResult<string>>;
+    readonly listWorkTrackingConnections: () => Promise<LighthouseApiResult<readonly unknown[]>>;
+    readonly getWorkTrackingConnection: (connectionId: number) => Promise<LighthouseApiResult<unknown>>;
+    readonly createWorkTrackingConnection: (payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly updateWorkTrackingConnection: (connectionId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly deleteWorkTrackingConnection: (connectionId: number) => Promise<LighthouseApiResult<void>>;
+    readonly listTeams: () => Promise<LighthouseApiResult<readonly unknown[]>>;
+    readonly getTeam: (teamId: number) => Promise<LighthouseApiResult<unknown>>;
+    readonly createTeam: (payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly updateTeam: (teamId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly deleteTeam: (teamId: number) => Promise<LighthouseApiResult<void>>;
+    readonly refreshTeam: (teamId: number) => Promise<LighthouseApiResult<void>>;
+    readonly listPortfolios: () => Promise<LighthouseApiResult<readonly unknown[]>>;
+    readonly getPortfolio: (portfolioId: number) => Promise<LighthouseApiResult<unknown>>;
+    readonly createPortfolio: (payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly updatePortfolio: (portfolioId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
+    readonly deletePortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
+    readonly refreshPortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
+};
+type LighthouseClientDependencies = {
+    readonly fetch?: (url: string, init?: RequestInit) => Promise<ConnectivityFetchResponse>;
+};
+declare const createLighthouseClient: (configuration: LighthouseClientConfiguration, dependencies?: LighthouseClientDependencies) => LighthouseClient;
+
+export { 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 ResolvedLighthouseEndpoint, type StandaloneDiscoveryContract, type StandaloneDiscoveryContractParseResult, type StoredLighthouseAuth, createLighthouseAuthContext, createLighthouseClient, getClientPackageContract, parseStandaloneDiscoveryContract, validateLighthouseConnectivity };