@crossworks/client-types 0.234.4 → 0.234.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crossworks/client-types",
-  "version": "0.234.4",
+  "version": "0.234.8",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./src/index.ts",

package/src/dto/auth.ts

@@ -0,0 +1,26 @@
+/**
+ * First-run auth on the wire: the public bootstrap state a login screen reads
+ * before anyone has signed in, and the first-run signup body.
+ */
+
+/** GET /api/auth/bootstrap-state. Public and boolean-only. */
+export type BootstrapStateDTO = {
+  /** No account exists yet: the login screen shows "create your login". */
+  firstRun: boolean;
+  /** Signup asks for the installer's setup code (MANTLE_SETUP_CODE). Only
+   *  ever true while `firstRun` is. Absent on a brain from before the field. */
+  setupCodeRequired?: boolean;
+};
+
+/** POST /api/auth/signup. Open only while no account exists. */
+export type SignupBody = {
+  email: string;
+  password: string;
+  /** The setup code the installer printed. Required when the bootstrap
+   *  state says `setupCodeRequired`; dashes, spaces and case are ignored. */
+  setupCode?: string;
+};
+
+/** The `reason` of a refused signup: `setup-code` for a wrong or missing
+ *  code. (The other 403, "an account already exists", carries no reason.) */
+export type SignupRefusedReason = 'setup-code';

package/src/index.ts

@@ -25,6 +25,7 @@
  */
 
 export * from './dto/agent-graph';
+export * from './dto/auth';
 export * from './dto/agents';
 export * from './dto/comms';
 export * from './dto/heartbeats';