@harborclient/team-hub-api 0.1.1

package/dist/TeamHubClientError.js

@@ -0,0 +1,30 @@
+/**
+ * Thrown when a HarborClient Server request fails or the response body is invalid.
+ */
+export class TeamHubClientError extends Error {
+    /**
+     * HTTP status code from the server, or `0` for network and parse failures.
+     */
+    status;
+    /**
+     * HTTP method used for the failed request.
+     */
+    method;
+    /**
+     * Request path relative to the configured base URL.
+     */
+    path;
+    /**
+     * Creates a team hub client error with request context for logging and UI display.
+     *
+     * @param message - Human-readable error description.
+     * @param options - HTTP status and request metadata.
+     */
+    constructor(message, options) {
+        super(message);
+        this.name = 'TeamHubClientError';
+        this.status = options.status;
+        this.method = options.method;
+        this.path = options.path;
+    }
+}

package/dist/appTypes.d.ts

@@ -0,0 +1,209 @@
+/**
+ * Supported HTTP methods for saved and live requests.
+ */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+/**
+ * Request body content type.
+ */
+export type BodyType = 'none' | 'json' | 'text' | 'multipart' | 'urlencoded';
+/**
+ * A key-value pair with an enable toggle for headers and query params.
+ */
+export interface KeyValue {
+    /**
+     * Header or query parameter name.
+     */
+    key: string;
+    /**
+     * Header or query parameter value.
+     */
+    value: string;
+    /**
+     * When false, the pair is ignored when building the request.
+     */
+    enabled: boolean;
+}
+/**
+ * A collection-scoped variable for use in request URLs via {{key}} syntax.
+ */
+export interface Variable {
+    /**
+     * Variable name referenced in {{key}} placeholders.
+     */
+    key: string;
+    /**
+     * Value substituted when the variable is resolved.
+     */
+    value: string;
+    /**
+     * Fallback value used when value is empty.
+     */
+    defaultValue: string;
+    /**
+     * When true, value is included in collection exports.
+     */
+    share: boolean;
+}
+/**
+ * Supported LLM providers for the OpenAI SDK compatibility layer.
+ */
+export type LlmProvider = 'openai' | 'claude' | 'gemini';
+/**
+ * Role of a message in an LLM completion step (includes tool roles).
+ */
+export type ChatStepMessageRole = 'system' | 'user' | 'assistant' | 'tool';
+/**
+ * Serializable tool call returned from a completion step.
+ */
+export interface ChatToolCall {
+    /**
+     * Tool call id from the model.
+     */
+    id: string;
+    /**
+     * Tool function name.
+     */
+    name: string;
+    /**
+     * JSON-encoded tool arguments.
+     */
+    arguments: string;
+}
+/**
+ * Serializable message passed to a single LLM completion step.
+ */
+export interface ChatStepMessage {
+    /**
+     * OpenAI-compatible message role.
+     */
+    role: ChatStepMessageRole;
+    /**
+     * Text content for user, assistant, tool, or system messages.
+     */
+    content?: string | null;
+    /**
+     * Tool calls requested by the assistant.
+     */
+    tool_calls?: ChatToolCall[];
+    /**
+     * Tool call id this tool message responds to.
+     */
+    tool_call_id?: string;
+    /**
+     * Tool name for tool role messages (optional).
+     */
+    name?: string;
+}
+/**
+ * One LLM model offered by a Team Hub.
+ */
+export interface HubLlmModel {
+    /**
+     * Provider-specific model id.
+     */
+    id: string;
+    /**
+     * Human-readable label from the hub.
+     */
+    label: string;
+    /**
+     * LLM provider that owns this model.
+     */
+    provider: LlmProvider;
+}
+/**
+ * Result of one LLM completion step.
+ */
+export interface ChatStepResult {
+    /**
+     * Assistant text when the model finishes without tool calls.
+     */
+    content: string | null;
+    /**
+     * Tool calls to execute in the renderer when present.
+     */
+    toolCalls?: ChatToolCall[];
+}
+/**
+ * Authorization type for the Auth tab; none inherits collection auth at send time.
+ */
+export type AuthType = 'none' | 'basic' | 'bearer' | 'oauth2';
+/**
+ * How OAuth client credentials are sent to the token endpoint.
+ */
+export type OAuth2ClientAuth = 'body' | 'header';
+/**
+ * OAuth 2.0 Client Credentials configuration stored on requests and collections.
+ */
+export interface OAuth2Config {
+    /**
+     * Token endpoint URL.
+     */
+    tokenUrl: string;
+    /**
+     * OAuth client id.
+     */
+    clientId: string;
+    /**
+     * OAuth client secret.
+     */
+    clientSecret: string;
+    /**
+     * Space-delimited OAuth scopes.
+     */
+    scope: string;
+    /**
+     * Optional audience claim for token requests.
+     */
+    audience: string;
+    /**
+     * Whether client credentials are sent in the POST body or as HTTP Basic auth.
+     */
+    clientAuth: OAuth2ClientAuth;
+}
+/**
+ * Basic and bearer credential fields stored together so switching type preserves values.
+ */
+export interface AuthConfig {
+    /**
+     * Selected auth mode; none means no request-level override.
+     */
+    type: AuthType;
+    /**
+     * Username and password for Basic Auth.
+     */
+    basic: {
+        username: string;
+        password: string;
+    };
+    /**
+     * Token value for Bearer Token auth.
+     */
+    bearer: {
+        token: string;
+    };
+    /**
+     * OAuth 2.0 Client Credentials settings.
+     */
+    oauth2: OAuth2Config;
+}
+/**
+ * Returns empty OAuth 2.0 Client Credentials fields.
+ *
+ * @returns Default OAuth2Config for new auth configs.
+ */
+export declare function defaultOAuth2Config(): OAuth2Config;
+/**
+ * Returns a default auth config with type none and empty credentials.
+ *
+ * @returns Empty AuthConfig safe for new requests and collections.
+ */
+export declare function defaultAuth(): AuthConfig;
+/**
+ * Normalizes a partial or legacy auth value from storage into a full AuthConfig.
+ *
+ * @param value - Parsed JSON or unknown field from the database.
+ * @returns Valid AuthConfig with defaults for missing fields.
+ */
+export declare function normalizeAuth(value: unknown): AuthConfig;
+//# sourceMappingURL=appTypes.d.ts.map

package/dist/appTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appTypes.d.ts","sourceRoot":"","sources":["../src/appTypes.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;AAE1F;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,YAAY,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,WAAW,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE;QACL,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF;;OAEG;IACH,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IAEF;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CASlD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,IAAI,UAAU,CAOxC;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,CA8CxD"}

package/dist/appTypes.js

@@ -0,0 +1,74 @@
+/**
+ * Returns empty OAuth 2.0 Client Credentials fields.
+ *
+ * @returns Default OAuth2Config for new auth configs.
+ */
+export function defaultOAuth2Config() {
+    return {
+        tokenUrl: '',
+        clientId: '',
+        clientSecret: '',
+        scope: '',
+        audience: '',
+        clientAuth: 'body'
+    };
+}
+/**
+ * Returns a default auth config with type none and empty credentials.
+ *
+ * @returns Empty AuthConfig safe for new requests and collections.
+ */
+export function defaultAuth() {
+    return {
+        type: 'none',
+        basic: { username: '', password: '' },
+        bearer: { token: '' },
+        oauth2: defaultOAuth2Config()
+    };
+}
+/**
+ * Normalizes a partial or legacy auth value from storage into a full AuthConfig.
+ *
+ * @param value - Parsed JSON or unknown field from the database.
+ * @returns Valid AuthConfig with defaults for missing fields.
+ */
+export function normalizeAuth(value) {
+    const fallback = defaultAuth();
+    if (value == null || typeof value !== 'object') {
+        return fallback;
+    }
+    const record = value;
+    const type = record.type === 'basic' ||
+        record.type === 'bearer' ||
+        record.type === 'oauth2' ||
+        record.type === 'none'
+        ? record.type
+        : fallback.type;
+    const basicRecord = record.basic != null && typeof record.basic === 'object'
+        ? record.basic
+        : {};
+    const bearerRecord = record.bearer != null && typeof record.bearer === 'object'
+        ? record.bearer
+        : {};
+    const oauth2Record = record.oauth2 != null && typeof record.oauth2 === 'object'
+        ? record.oauth2
+        : {};
+    return {
+        type,
+        basic: {
+            username: typeof basicRecord.username === 'string' ? basicRecord.username : '',
+            password: typeof basicRecord.password === 'string' ? basicRecord.password : ''
+        },
+        bearer: {
+            token: typeof bearerRecord.token === 'string' ? bearerRecord.token : ''
+        },
+        oauth2: {
+            tokenUrl: typeof oauth2Record.tokenUrl === 'string' ? oauth2Record.tokenUrl : '',
+            clientId: typeof oauth2Record.clientId === 'string' ? oauth2Record.clientId : '',
+            clientSecret: typeof oauth2Record.clientSecret === 'string' ? oauth2Record.clientSecret : '',
+            scope: typeof oauth2Record.scope === 'string' ? oauth2Record.scope : '',
+            audience: typeof oauth2Record.audience === 'string' ? oauth2Record.audience : '',
+            clientAuth: oauth2Record.clientAuth === 'header' ? 'header' : 'body'
+        }
+    };
+}

package/dist/auth.d.ts

@@ -0,0 +1,41 @@
+import { type AuthConfig } from './appTypes.js';
+/**
+ * Authorization modes persisted by HarborClient Team Hub today.
+ */
+export type TeamHubAuthType = 'none' | 'basic' | 'bearer';
+/**
+ * Authorization settings shape returned by Team Hub entity routes.
+ *
+ * Team Hub does not store OAuth 2 yet; HarborClient normalizes this into a
+ * full {@link AuthConfig} when mapping records into local storage.
+ */
+export interface TeamHubAuthConfig {
+    /**
+     * Selected auth mode supported by the hub API.
+     */
+    type: TeamHubAuthType;
+    /**
+     * Username and password for Basic Auth.
+     */
+    basic: {
+        username: string;
+        password: string;
+    };
+    /**
+     * Token value for Bearer Token auth.
+     */
+    bearer: {
+        token: string;
+    };
+}
+/**
+ * Converts local auth settings to the shape accepted by Team Hub API routes.
+ *
+ * OAuth 2 configs are downgraded to `none` because the hub does not persist
+ * OAuth fields yet; basic and bearer credential strings are preserved.
+ *
+ * @param auth - Auth configuration from a collection or saved request.
+ * @returns Auth payload safe to send to Team Hub create/update routes.
+ */
+export declare function toTeamHubAuth(auth: AuthConfig): TeamHubAuthConfig;
+//# sourceMappingURL=auth.d.ts.map

package/dist/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE1D;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE;QACL,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF;;OAEG;IACH,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,iBAAiB,CAejE"}

package/dist/auth.js

@@ -0,0 +1,25 @@
+import { normalizeAuth } from './appTypes.js';
+/**
+ * Converts local auth settings to the shape accepted by Team Hub API routes.
+ *
+ * OAuth 2 configs are downgraded to `none` because the hub does not persist
+ * OAuth fields yet; basic and bearer credential strings are preserved.
+ *
+ * @param auth - Auth configuration from a collection or saved request.
+ * @returns Auth payload safe to send to Team Hub create/update routes.
+ */
+export function toTeamHubAuth(auth) {
+    const normalized = normalizeAuth(auth);
+    if (normalized.type === 'oauth2') {
+        return {
+            type: 'none',
+            basic: normalized.basic,
+            bearer: normalized.bearer
+        };
+    }
+    return {
+        type: normalized.type,
+        basic: normalized.basic,
+        bearer: normalized.bearer
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export type { ITeamHubClient } from './ITeamHubClient.js';
+export { DEFAULT_TEAM_HUB_REQUEST_TIMEOUT_MS, TeamHubClient, type HubChatStepRequest } from './TeamHubClient.js';
+export { TeamHubClientError } from './TeamHubClientError.js';
+export { toTeamHubAuth, type TeamHubAuthConfig, type TeamHubAuthType } from './auth.js';
+export { isTeamHubCollectionDeleteForbiddenError } from './isTeamHubCollectionDeleteForbiddenError.js';
+export type { AdminEntityConfig, AdminResourceOption, CollectionRecord, CreateCollectionInput, CreateEnvironmentInput, CreateFolderInput, CreateHubTokenInput, CreateHubUserInput, CreateRequestInput, CreatedHubToken, CreatedHubUser, EnvironmentRecord, FolderRecord, HealthResponse, HubApiTokenRecord, HubUserRecord, HubUserRole, MoveRequestInput, PluginSourcesResponse, RenameFolderInput, ReorderFoldersInput, ReorderRequestsInput, ReloadConfigResponse, ReloadConfigSectionResult, ReloadConfigSectionName, ReloadConfigSectionStatus, SavedRequestRecord, SessionCapabilities, SessionResponse, TeamHubAdminResourceOptions, TeamHubClientConfig, UpdateCollectionInput, UpdateEnvironmentInput, UpdateHubUserInput, UpdateRequestInput } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EACL,mCAAmC,EACnC,aAAa,EACb,KAAK,kBAAkB,EACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AACxF,OAAO,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AACvG,YAAY,EACV,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EACzB,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,2BAA2B,EAC3B,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { DEFAULT_TEAM_HUB_REQUEST_TIMEOUT_MS, TeamHubClient } from './TeamHubClient.js';
+export { TeamHubClientError } from './TeamHubClientError.js';
+export { toTeamHubAuth } from './auth.js';
+export { isTeamHubCollectionDeleteForbiddenError } from './isTeamHubCollectionDeleteForbiddenError.js';

package/dist/isTeamHubCollectionDeleteForbiddenError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns whether a Team Hub error indicates the caller may not delete a collection.
+ *
+ * @param err - Error thrown while deleting a hub-backed collection on the server.
+ */
+export declare function isTeamHubCollectionDeleteForbiddenError(err: unknown): boolean;
+//# sourceMappingURL=isTeamHubCollectionDeleteForbiddenError.d.ts.map

package/dist/isTeamHubCollectionDeleteForbiddenError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isTeamHubCollectionDeleteForbiddenError.d.ts","sourceRoot":"","sources":["../src/isTeamHubCollectionDeleteForbiddenError.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,uCAAuC,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAO7E"}

package/dist/isTeamHubCollectionDeleteForbiddenError.js

@@ -0,0 +1,12 @@
+import { TeamHubClientError } from './TeamHubClientError.js';
+/**
+ * Returns whether a Team Hub error indicates the caller may not delete a collection.
+ *
+ * @param err - Error thrown while deleting a hub-backed collection on the server.
+ */
+export function isTeamHubCollectionDeleteForbiddenError(err) {
+    return (err instanceof TeamHubClientError &&
+        err.status === 403 &&
+        err.method === 'DELETE' &&
+        err.path.startsWith('/collections/'));
+}