@tai42/api-client 16.0.1 → 17.0.0

package/src/schemas/index.ts

@@ -1,37 +1,39 @@
 /** Public barrel for the api-client response/DTO schemas. */
-export * from './served';
-export { jsonSchema, jsonValue } from './shared';
-export * from './tools';
-export * from './extensions';
-export * from './presets';
-export * from './tool-meta';
-export * from './templates';
-export * from './storage';
-export * from './fleet';
-export * from './manifest-mcp';
-export * from './system-kinds';
-export * from './sub-mcp';
+export { toolRunList, toolRunRecord, toolRunSubmitResult } from '../tool-runs';
+export * from './api-keys';
+export * from './auth-routes';
+export * from './backup';
+export * from './capabilities';
+export * from './channels';
 export * from './config';
-export * from './profiles';
 export * from './connectors';
-export * from './studio-plugins';
-export * from './interactions';
-export * from './channels';
 export * from './conversations';
-export * from './web-entry';
-export * from './notifications';
+export * from './extensions';
+export * from './fleet';
 export * from './hooks';
-export * from './trigger-links';
-export * from './settings-schema';
-export * from './auth-routes';
-export * from './roles';
-export * from './api-keys';
+export * from './interactions';
 export * from './login';
-export * from './capabilities';
+export * from './manifest-mcp';
+export * from './marketplace';
+export * from './notifications';
+export * from './observability';
 export * from './policy';
-export * from './backup';
+export * from './presets';
+export * from './principals';
+export * from './profiles';
+export * from './roles';
 export * from './schedules';
-export * from './observability';
-export * from './marketplace';
+export * from './served';
+export * from './settings-schema';
+export * from './setup';
+export { jsonSchema, jsonValue } from './shared';
 export * from './states';
-export { toolRunSubmitResult, toolRunRecord, toolRunList } from '../tool-runs';
+export * from './storage';
+export * from './studio-plugins';
+export * from './sub-mcp';
+export * from './system-kinds';
+export * from './templates';
+export * from './tool-meta';
+export * from './tools';
+export * from './trigger-links';
+export * from './web-entry';

package/src/schemas/interactions.ts

@@ -1,5 +1,6 @@
 /** Interaction question, answer and media response schemas. */
 import { z } from 'zod';
+
 import { pageWindow } from './shared';
 
 // Shapes match the skeleton's interactions SSE contract: the SSE

package/src/schemas/login.ts

@@ -24,7 +24,7 @@ export const loginMethod = z.discriminatedUnion('shape', [
     shape: z.literal('form'),
     id: z.string().min(1),
     title: z.string().min(1),
-    purpose: z.enum(['login', 'bootstrap', 'invite']).default('login'),
+    purpose: z.enum(['login', 'invite']).default('login'),
     fields: z.array(loginFormField).min(1),
     submit_path: z.string().min(1),
   }),
@@ -38,13 +38,20 @@ export const loginMethod = z.discriminatedUnion('shape', [
 ]);
 
 /**
- * `GET /api/login/methods` (PUBLIC). `bootstrap: true` ⇒ the deployment has zero
- * accounts and `methods` contains the owner-creation form. Non-strict — the
+ * `GET /api/login/methods` (PUBLIC). `needs_setup: true` ⇒ no principal exists
+ * yet, so the deployment must be initialized through the setup door before anyone
+ * can sign in. `setup_login` names the login-credential kinds the setup door can
+ * attach the owner's login with; it is `null`/absent when no login-attaching
+ * accounts provider is configured (a keys-only deployment). Non-strict — the
  * skeleton may grow additive fields.
  */
 export const loginMethods = z.object({
   methods: z.array(loginMethod),
-  bootstrap: z.boolean(),
+  needs_setup: z.boolean(),
+  setup_login: z
+    .object({ kinds: z.array(z.enum(['password', 'invite'])) })
+    .nullable()
+    .optional(),
 });
 
 /**

package/src/schemas/manifest-mcp.ts

@@ -1,5 +1,6 @@
 /** Live-manifest MCP section, env-ref and config-reload schemas. */
 import { z } from 'zod';
+
 import { fleetReportFanout } from './fleet';
 
 /**

package/src/schemas/notifications.ts

@@ -1,5 +1,6 @@
 /** Notification-sink record response schemas. */
 import { z } from 'zod';
+
 import { channelTemplate } from './served';
 
 // The internal notifications sink: the messages the `notify_user` operation records

package/src/schemas/observability.ts

@@ -1,5 +1,6 @@
 /** Run metrics, listing, span and trace response schemas. */
 import { z } from 'zod';
+
 import { jsonValue } from './shared';
 
 export const dashboardMetrics = z.object({

package/src/schemas/policy.ts

@@ -1,5 +1,6 @@
 /** Access-policy validation, version and rollback response schemas. */
 import { z } from 'zod';
+
 import { policyBody } from './served';
 
 /**

package/src/schemas/presets.ts

@@ -1,5 +1,6 @@
 /** Preset record, version and validation response schemas. */
 import { z } from 'zod';
+
 import { presetExtensionElement } from './extensions';
 import { presetBody } from './served';
 

package/src/schemas/principals.ts

@@ -0,0 +1,41 @@
+/** Principal (identity) reference, row, listing and delete-result schemas. */
+import { z } from 'zod';
+
+/**
+ * A compact reference to a principal — the owner of a key, or the human behind a
+ * session — carried inline on payloads that name one.
+ */
+export const principalRef = z.object({
+  user_id: z.string(),
+  kind: z.enum(['human', 'service']),
+  display_name: z.string(),
+});
+export type PrincipalRef = z.infer<typeof principalRef>;
+
+/**
+ * A principal row (`/api/auth/principals`). `kind` is `human` (logs in
+ * interactively) or `service` (holds keys only, never logs in). `created_by` is
+ * the principal that created this one, or `null` for the owner the setup door
+ * mints. `disabled` turns off every credential the principal owns. `created_at`
+ * is an ISO-8601 instant.
+ */
+export const principal = z.object({
+  user_id: z.string(),
+  kind: z.enum(['human', 'service']),
+  display_name: z.string(),
+  created_by: z.string().nullable(),
+  disabled: z.boolean(),
+  created_at: z.string(),
+});
+export type Principal = z.infer<typeof principal>;
+
+/** The principals listing (`GET /api/auth/principals`). */
+export const principalList = z.array(principal);
+export type PrincipalList = z.infer<typeof principalList>;
+
+/** The delete result (`DELETE /api/auth/principals/{user_id}`). */
+export const principalDeleted = z.object({
+  user_id: z.string(),
+  deleted: z.boolean(),
+});
+export type PrincipalDeleted = z.infer<typeof principalDeleted>;

package/src/schemas/profiles.ts

@@ -1,5 +1,6 @@
 /** Settings-profile record, version, diff and apply response schemas. */
 import { z } from 'zod';
+
 import { fleetReportFanout } from './fleet';
 
 // The admin-only `/api/config/profiles/*` surface. Secrets ride the wire in the

package/src/schemas/roles.ts

@@ -1,5 +1,6 @@
 /** Role grant, version and audit response schemas. */
 import { z } from 'zod';
+
 import { roleBody } from './served';
 import { jsonValue } from './shared';
 

package/src/schemas/schedules.ts

@@ -1,5 +1,6 @@
 /** Schedule listing and server-clock response schemas. */
 import { z } from 'zod';
+
 import { jsonValue } from './shared';
 
 // The skeleton returns opaque backend-tool results; the table reads a few known

package/src/schemas/served.ts

@@ -1,9 +1,10 @@
 /** Generated served-document schema aliases and templated-text re-exports. */
 import { z } from 'zod';
+
 import * as generated from '../generated/served-schemas';
 
-export { templatedText, requiredTemplatedText } from '../templated-text';
 export type { TemplatedText } from '../templated-text';
+export { requiredTemplatedText, templatedText } from '../templated-text';
 
 // Served-document schemas are GENERATED from the platform contract JSON-schema
 // bundle (src/generated/served-schemas.ts) and re-exported here under the names the

package/src/schemas/settings-schema.ts

@@ -1,5 +1,6 @@
 /** Declarative settings-form schema response. */
 import { z } from 'zod';
+
 import { jsonValue } from './shared';
 
 // The settings form is auto-rendered from a declarative group/field description

package/src/schemas/setup.ts

@@ -0,0 +1,39 @@
+/** Setup-door (`POST /api/setup`) request-body and result schemas. */
+import { z } from 'zod';
+
+/**
+ * The result of a successful `POST /api/setup`, returned exactly ONCE. `api_key`
+ * is the owner key's plaintext (shown once, never retrievable again).
+ * `login_attached` is whether an interactive login was attached now;
+ * `invite_token` and `login_path` are set only when the attachment was an invite
+ * the operator completes later.
+ */
+export const setupResult = z.object({
+  owner_user_id: z.string(),
+  key_user_id: z.string(),
+  api_key: z.string().min(1),
+  key_fingerprint: z.string(),
+  login_attached: z.boolean(),
+  invite_token: z.string().nullable().optional(),
+  login_path: z.string().nullable().optional(),
+});
+export type SetupResult = z.infer<typeof setupResult>;
+
+/**
+ * The body of `POST /api/setup`. `setup_token` is checked against the
+ * deployment's setup token. `owner_user_id`/`key_user_id` are optional — the door
+ * mints ids when they are absent. `owner_display_name` is required. `login`
+ * attaches the owner's interactive login when a login-attaching accounts provider
+ * is configured (a password set now, or a one-time invite completed later); a
+ * keys-only setup omits it.
+ */
+export interface SetupBody {
+  readonly setup_token: string;
+  readonly owner_display_name: string;
+  readonly owner_user_id?: string;
+  readonly key_user_id?: string;
+  readonly key_description?: string;
+  readonly login?:
+    | { readonly kind: 'password'; readonly email: string; readonly password: string }
+    | { readonly kind: 'invite'; readonly email: string };
+}

package/src/schemas/states.ts

@@ -1,5 +1,6 @@
 /** State declaration, record, template and consumer response schemas. */
 import { z } from 'zod';
+
 import { conversationTargetKind } from './conversations';
 import { stateDeclaration, stateTemplateDocument } from './served';
 

package/src/schemas/system-kinds.ts

@@ -1,5 +1,6 @@
 /** Pluggable-kind status and MCP status/reload response schemas. */
 import { z } from 'zod';
+
 import { fleetResult } from './fleet';
 import { reloadConfigResult } from './manifest-mcp';
 

package/src/schemas/templates.ts

@@ -1,5 +1,6 @@
 /** Prompt-template listing, render and mutation ack schemas. */
 import { z } from 'zod';
+
 import { jsonSchema } from './shared';
 
 export const templateNames = z.array(z.string());

package/src/schemas/tools.ts

@@ -1,5 +1,6 @@
 /** Tool catalog, run-result and per-tool tag response schemas. */
 import { z } from 'zod';
+
 import { jsonSchema, jsonValue } from './shared';
 
 export const toolNames = z.array(z.string());

package/src/schemas/trigger-links.ts

@@ -1,5 +1,6 @@
 /** Trigger-link record and lifecycle response schemas. */
 import { z } from 'zod';
+
 import { triggerAuth } from './hooks';
 
 // A trigger link is a minted, token-bearing PUBLIC URL (`GET|POST /trigger/{token}`)

package/src/tool-runs.ts

@@ -14,8 +14,8 @@
  */
 import { z } from 'zod';
 
-import { apiRequest, encodeSegment } from './http';
 import type { ApiConfig } from './http';
+import { apiRequest, encodeSegment } from './http';
 
 /** A run's lifecycle state. `lost` = the server restarted mid-run; the result is
  * unrecoverable. `running` is the only non-terminal state. */