@harborclient/team-hub-api 0.1.1

package/dist/schemas.js

@@ -0,0 +1,353 @@
+import { z } from 'zod';
+/**
+ * Supported HTTP methods for saved and live requests.
+ */
+export const httpMethod = z.enum([
+    'GET',
+    'POST',
+    'PUT',
+    'PATCH',
+    'DELETE',
+    'HEAD',
+    'OPTIONS'
+]);
+/**
+ * Supported request body content types.
+ */
+export const bodyType = z.enum([
+    'none',
+    'json',
+    'text',
+    'multipart',
+    'urlencoded'
+]);
+/**
+ * Header or query parameter key-value row.
+ */
+export const keyValue = z.object({
+    key: z.string(),
+    value: z.string(),
+    enabled: z.boolean()
+});
+/**
+ * Collection or environment variable row.
+ */
+export const variable = z.object({
+    key: z.string(),
+    value: z.string(),
+    defaultValue: z.string(),
+    share: z.boolean()
+});
+/**
+ * Authorization settings returned by Team Hub entity routes.
+ */
+export const teamHubAuthConfigSchema = z.object({
+    type: z.enum(['none', 'basic', 'bearer']),
+    basic: z.object({
+        username: z.string(),
+        password: z.string()
+    }),
+    bearer: z.object({
+        token: z.string()
+    })
+});
+/**
+ * Standard error body returned by HarborClient Server API routes.
+ */
+export const errorResponseSchema = z.object({
+    error: z.string()
+});
+/**
+ * ISO 8601 timestamp strings returned in JSON responses.
+ */
+export const timestampSchema = z.iso.datetime();
+/**
+ * Parses deletion lock flags from Team Hub responses.
+ *
+ * Older hub versions omit this field; treat missing values as unlocked.
+ */
+export const deletionLockedSchema = z.boolean().optional().default(false);
+/**
+ * JSON shape for a persisted collection record.
+ */
+export const collectionRecordSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    variables: z.array(variable),
+    headers: z.array(keyValue),
+    auth: teamHubAuthConfigSchema,
+    preRequestScript: z.string(),
+    postRequestScript: z.string(),
+    createdAt: timestampSchema,
+    deletionLocked: deletionLockedSchema
+});
+/**
+ * JSON shape for a persisted environment record.
+ */
+export const environmentRecordSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    variables: z.array(variable),
+    createdAt: timestampSchema,
+    deletionLocked: deletionLockedSchema
+});
+/**
+ * JSON shape for a persisted folder record.
+ */
+export const folderRecordSchema = z.object({
+    id: z.string(),
+    collectionId: z.string(),
+    name: z.string(),
+    sortOrder: z.number().int(),
+    createdAt: timestampSchema
+});
+/**
+ * JSON shape for a persisted saved request record.
+ */
+export const savedRequestRecordSchema = z.object({
+    id: z.string(),
+    collectionId: z.string(),
+    name: z.string(),
+    method: httpMethod,
+    url: z.string(),
+    headers: z.array(keyValue),
+    params: z.array(keyValue),
+    auth: teamHubAuthConfigSchema,
+    body: z.string(),
+    bodyType: bodyType,
+    preRequestScript: z.string(),
+    postRequestScript: z.string(),
+    comment: z.string(),
+    folderId: z.string().nullable(),
+    sortOrder: z.number().int(),
+    createdAt: timestampSchema,
+    updatedAt: timestampSchema
+});
+/**
+ * Response body schema for `GET /health`.
+ */
+export const healthResponseSchema = z.object({
+    status: z.literal('ok'),
+    version: z.string()
+});
+/**
+ * Response body schema for `GET /auth/session`.
+ */
+export const sessionResponseSchema = z.object({
+    user: z.object({
+        id: z.string(),
+        name: z.string(),
+        role: z.enum(['admin', 'user'])
+    }),
+    token: z.object({
+        id: z.string(),
+        prefix: z.string()
+    }),
+    capabilities: z.object({
+        dataApi: z.boolean(),
+        managementApi: z.boolean(),
+        llm: z.boolean()
+    })
+});
+/**
+ * JSON shape for a Team Hub user account returned by management routes.
+ */
+export const hubUserRecordSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    role: z.enum(['admin', 'user']),
+    collectionAccess: z.array(z.string()),
+    environmentAccess: z.array(z.string()),
+    llmAccess: z.boolean(),
+    llmModels: z.array(z.string()),
+    llmMonthlyTokenLimit: z.number().int().nonnegative().nullable(),
+    createdAt: timestampSchema,
+    updatedAt: timestampSchema
+});
+/**
+ * List response wrapper for admin user listings.
+ */
+export const listAdminUsersResponseSchema = z.object({
+    users: z.array(hubUserRecordSchema)
+});
+/**
+ * Lightweight id/name record returned by admin list routes.
+ */
+export const adminResourceOptionSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    deletionLocked: deletionLockedSchema
+});
+/**
+ * Response body schema for admin entity configuration updates.
+ */
+export const adminEntityConfigSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    deletionLocked: deletionLockedSchema
+});
+/**
+ * Request body schema for `PUT /admin/collections/:id`.
+ */
+export const updateAdminCollectionBodySchema = z.object({
+    deletionLocked: z.boolean()
+});
+/**
+ * Request body schema for `PUT /admin/environments/:id`.
+ */
+export const updateAdminEnvironmentBodySchema = z.object({
+    deletionLocked: z.boolean()
+});
+/**
+ * List response wrapper for admin collection listings.
+ */
+export const listAdminCollectionsResponseSchema = z.object({
+    collections: z.array(adminResourceOptionSchema)
+});
+/**
+ * List response wrapper for admin environment listings.
+ */
+export const listAdminEnvironmentsResponseSchema = z.object({
+    environments: z.array(adminResourceOptionSchema)
+});
+/**
+ * Request body schema for `PUT /admin/users/:id`.
+ */
+export const updateAdminUserBodySchema = z.object({
+    name: z.string().trim().min(1).optional(),
+    role: z.enum(['admin', 'user']).optional(),
+    collectionAccess: z.array(z.string()).optional(),
+    environmentAccess: z.array(z.string()).optional(),
+    llmAccess: z.boolean().optional(),
+    llmModels: z.array(z.string()).optional(),
+    llmMonthlyTokenLimit: z.number().int().nonnegative().nullable().optional()
+});
+/**
+ * Request body schema for `POST /admin/users`.
+ */
+export const createAdminUserBodySchema = z.object({
+    name: z.string().trim().min(1),
+    role: z.enum(['admin', 'user']),
+    collectionAccess: z.array(z.string()).optional(),
+    environmentAccess: z.array(z.string()).optional(),
+    llmAccess: z.boolean().optional(),
+    llmModels: z.array(z.string()).optional(),
+    llmMonthlyTokenLimit: z.number().int().nonnegative().nullable().optional()
+});
+/**
+ * JSON shape for an API token record returned by admin token routes.
+ */
+export const hubApiTokenRecordSchema = z.object({
+    id: z.string(),
+    userId: z.string(),
+    name: z.string(),
+    tokenPrefix: z.string(),
+    createdAt: timestampSchema,
+    lastUsedAt: timestampSchema.nullable(),
+    revokedAt: timestampSchema.nullable()
+});
+/**
+ * Response body schema for `POST /admin/users`.
+ */
+export const createAdminUserResponseSchema = z.object({
+    user: hubUserRecordSchema,
+    token: hubApiTokenRecordSchema,
+    secret: z.string()
+});
+/**
+ * Request body schema for `POST /admin/users/:id/tokens`.
+ */
+export const createAdminTokenBodySchema = z.object({
+    name: z.string().trim().min(1)
+});
+/**
+ * Response body schema for `POST /admin/users/:id/tokens`.
+ */
+export const createdApiTokenResponseSchema = z.object({
+    token: hubApiTokenRecordSchema,
+    secret: z.string()
+});
+/**
+ * List response wrapper for admin token listings.
+ */
+export const listAdminTokensResponseSchema = z.object({
+    tokens: z.array(hubApiTokenRecordSchema)
+});
+/**
+ * Per-section outcome reported by config reload routes.
+ */
+export const reloadConfigSectionResultSchema = z.object({
+    section: z.enum(['db', 'redis', 'llm', 'plugins', 'server']),
+    status: z.enum(['reloaded', 'unchanged', 'failed', 'restart-required']),
+    error: z.string().optional()
+});
+/**
+ * Response body schema for `POST /admin/config/reload`.
+ */
+export const reloadConfigResponseSchema = z.object({
+    sections: z.array(reloadConfigSectionResultSchema),
+    fatalError: z.string().optional()
+});
+/**
+ * List response wrapper for collections.
+ */
+export const listCollectionsResponseSchema = z.object({
+    collections: z.array(collectionRecordSchema)
+});
+/**
+ * List response wrapper for environments.
+ */
+export const listEnvironmentsResponseSchema = z.object({
+    environments: z.array(environmentRecordSchema)
+});
+/**
+ * List response wrapper for folders.
+ */
+export const listFoldersResponseSchema = z.object({
+    folders: z.array(folderRecordSchema)
+});
+/**
+ * List response wrapper for saved requests.
+ */
+export const listRequestsResponseSchema = z.object({
+    requests: z.array(savedRequestRecordSchema)
+});
+/**
+ * JSON shape for one hub-offered LLM model.
+ */
+export const hubLlmModelSchema = z.object({
+    id: z.string(),
+    label: z.string(),
+    provider: z.enum(['openai', 'claude', 'gemini'])
+});
+/**
+ * JSON shape for GET /llm/models response body.
+ */
+export const listHubLlmModelsResponseSchema = z.object({
+    models: z.array(hubLlmModelSchema)
+});
+/**
+ * JSON shape for GET /plugins/sources response body.
+ */
+export const pluginSourcesResponseSchema = z.object({
+    catalogs: z.array(z.string()),
+    trusted: z.array(z.string())
+});
+/**
+ * JSON shape for POST /llm/chat/step response body.
+ */
+export const hubChatStepResponseSchema = z.object({
+    content: z.string().nullable(),
+    toolCalls: z
+        .array(z.object({
+        id: z.string(),
+        name: z.string(),
+        arguments: z.string()
+    }))
+        .optional(),
+    usage: z.object({
+        promptTokens: z.number().int().nonnegative(),
+        completionTokens: z.number().int().nonnegative(),
+        totalTokens: z.number().int().nonnegative()
+    })
+});