@structured-id/ui-core 3.0.0 → 3.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@structured-id/ui-core",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "type": "module",
   "publishConfig": {
     "access": "public",
@@ -42,7 +42,7 @@
     "@protobuf-ts/grpcweb-transport": "^2.11.1",
     "@protobuf-ts/runtime": "^2.11.1",
     "@protobuf-ts/runtime-rpc": "^2.11.1",
-    "@structured-id/proto": "^0.2.0",
+    "@structured-id/proto": "^0.3.0",
     "libphonenumber-js": "^1.13.15"
   },
   "devDependencies": {

package/src/profile/components/SidLoginForm.test.ts

@@ -2,6 +2,7 @@ import { describe, it, expect, vi } from "vitest";
 import { mount } from "@vue/test-utils";
 import { defineComponent } from "vue";
 import SidLoginForm from "./SidLoginForm.vue";
+import { REQUIRED_FIELD_TEXT } from "../../utils/validators";
 
 // Stub all Quasar components as divs
 const quasarStubs = {
@@ -16,7 +17,8 @@ const quasarStubs = {
     emits: ["submit"],
   },
   "q-input": defineComponent({
-    props: ["modelValue", "type", "label", "disable", "rules"],
+    name: "QInputStub",
+    props: ["modelValue", "type", "label", "disable", "rules", "lazyRules"],
     emits: ["update:modelValue"],
     template:
       '<input :value="modelValue" @input="$emit(\'update:modelValue\', $event.target.value)" />',
@@ -77,4 +79,16 @@ describe("SidLoginForm", () => {
     const w = mountLogin();
     expect(w.text()).toContain("Your password never leaves this device");
   });
+
+  // Regression: the password turned red on the first keystroke and its empty
+  // error read "Required" beside the identifier's "This field is required".
+  it("validates the password once left, with the shared required text", () => {
+    const w = mountLogin();
+    const password = w.findComponent({ name: "QInputStub" });
+    const lazy = password.props("lazyRules");
+    expect(lazy === "" || lazy === true).toBe(true);
+    const [required] = password.props("rules") as ((v: string) => unknown)[];
+    expect(required("")).toBe(REQUIRED_FIELD_TEXT);
+    expect(required("secret")).toBe(true);
+  });
 });

package/src/profile/components/SidLoginForm.vue

@@ -48,6 +48,7 @@
           :label="passwordLabel"
           outlined
           :disable="loading"
+          lazy-rules
           :rules="[(v: string) => !!v || passwordRequiredText]"
           data-test="password"
         >
@@ -119,6 +120,7 @@ import { ref } from "vue";
 import { SidPrincipalInput } from "../../quasar";
 import type { PrincipalType } from "../../quasar";
 import { normalizePrincipal, refusalMessage } from "../../index";
+import { REQUIRED_FIELD_TEXT } from "../../utils/validators";
 
 void SidPrincipalInput;
 
@@ -169,7 +171,7 @@ const props = withDefaults(
     submitLabel: "Sign in",
     identifierLabel: "Email, phone, or username",
     passwordLabel: "Password",
-    passwordRequiredText: "Required",
+    passwordRequiredText: REQUIRED_FIELD_TEXT,
     showForgotPassword: true,
     forgotPasswordText: "Forgot password?",
     forgotPasswordUrl: undefined,

package/src/profile/components/SidRegistrationForm.vue

@@ -225,6 +225,7 @@ interface ValidatableInput {
 }
 import type { PrincipalType } from "../../quasar";
 import { normalizePrincipal, refusalMessage } from "../../index";
+import { REQUIRED_FIELD_TEXT } from "../../utils/validators";
 
 /** What the form collected besides the identifier and password. */
 export interface RegistrationExtras {
@@ -280,9 +281,9 @@ const props = withDefaults(
     /** Pre-filled invite code (e.g. from URL) */
     initialInviteCode?: string;
     /**
-     * The installation has no administrator yet (GetInstanceStatus). The form
-     * then asks for the claim token and the new account becomes administrator;
-     * the invite code is not asked for.
+     * The installation's local claim is open (GetInstanceStatus `OPEN`). The
+     * form then asks for the claim token and the new account becomes
+     * administrator; the invite code is not asked for.
      */
     claimRequired?: boolean;
     /** Claim token input label */
@@ -317,7 +318,7 @@ const props = withDefaults(
     identifierLabel: "Email, phone, or username",
     passwordLabel: "Password",
     confirmPasswordLabel: "Confirm password",
-    passwordRequiredText: "Required",
+    passwordRequiredText: REQUIRED_FIELD_TEXT,
     passwordMinLengthText: "At least 12 characters with mixed case + digit",
     passwordMinLength: 12,
     passwordsMismatchText: "Passwords do not match",

package/src/profile/composables/useEnrollmentApi.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect, vi, beforeEach } from "vitest";
-import { getInstanceStatus } from "./useEnrollmentApi";
+import { AdministratorClaim, getInstanceStatus } from "./useEnrollmentApi";
 
 const mockGetInstanceStatus = vi.fn();
 
@@ -22,12 +22,14 @@ describe("getInstanceStatus", () => {
   // The registration page asks before anyone signs in, so the call must
   // carry no credentials and return the server's answer as is.
   it("asks without credentials and returns the status", async () => {
-    mockGetInstanceStatus.mockResolvedValue({ response: { claimed: false } });
+    mockGetInstanceStatus.mockResolvedValue({
+      response: { claim: AdministratorClaim.OPEN },
+    });
 
     const status = await getInstanceStatus();
 
     expect(mockGetInstanceStatus).toHaveBeenCalledWith({});
-    expect(status).toEqual({ claimed: false });
+    expect(status).toEqual({ claim: AdministratorClaim.OPEN });
   });
 
   it("propagates gRPC errors", async () => {

package/src/profile/composables/useEnrollmentApi.ts

@@ -6,17 +6,22 @@
  */
 import { getTransport } from "../../index";
 import { EnrollmentServiceClient } from "@structured-id/proto/sid/v1/admin/enrollment.client";
-import type { InstanceStatus } from "@structured-id/proto/sid/v1/admin/enrollment";
+import {
+  AdministratorClaim,
+  type InstanceStatus,
+} from "@structured-id/proto/sid/v1/admin/enrollment";
 
 function client(): EnrollmentServiceClient {
   return new EnrollmentServiceClient(getTransport());
 }
 
+export { AdministratorClaim };
 export type { InstanceStatus };
 
 /**
- * Whether the installation has its first administrator. While it has none,
- * registration accepts only the claim token from the service log.
+ * The installation's local administrator claim (`claim`). While it is
+ * `OPEN`, registration accepts only the claim token from the service log; a
+ * centrally managed installation reports `UNAVAILABLE` and takes no token.
  */
 export async function getInstanceStatus(): Promise<InstanceStatus> {
   const { response } = await client().getInstanceStatus({});

package/src/quasar/SidPrincipalInput.test.ts

@@ -0,0 +1,49 @@
+import { describe, it, expect } from "vitest";
+import { mount } from "@vue/test-utils";
+import { defineComponent } from "vue";
+import SidPrincipalInput from "./SidPrincipalInput.vue";
+import { REQUIRED_FIELD_TEXT } from "../utils/validators";
+
+const stubs = {
+  "q-input": defineComponent({
+    name: "QInputStub",
+    props: ["modelValue", "rules", "lazyRules"],
+    template: "<div><slot name='prepend' /><slot name='append' /></div>",
+  }),
+  "q-icon": { template: "<span />" },
+  "q-chip": { template: "<span><slot /></span>" },
+};
+
+function input(props: Record<string, unknown> = {}) {
+  return mount(SidPrincipalInput, {
+    props: { modelValue: "", ...props },
+    global: { stubs },
+  }).findComponent({ name: "QInputStub" });
+}
+
+type Rule = (v: string) => unknown;
+
+describe("SidPrincipalInput", () => {
+  // Regression: the identifier turned red while still being typed; it is
+  // checked once left, unless a form asks for checking from the start.
+  it("validates once left by default", () => {
+    expect(input().props("lazyRules")).toBe(true);
+    expect(input({ lazyRules: false }).props("lazyRules")).toBe(false);
+  });
+
+  // One text for an empty required field, the same the password field uses.
+  it("says the shared text of an empty required field", () => {
+    const [required] = input().props("rules") as Rule[];
+    expect(required("")).toBe(REQUIRED_FIELD_TEXT);
+    expect(required("alice")).toBe(true);
+    const [custom] = input({ requiredText: "Enter it" }).props(
+      "rules",
+    ) as Rule[];
+    expect(custom("")).toBe("Enter it");
+  });
+
+  it("does not require an optional field", () => {
+    const [required] = input({ required: false }).props("rules") as Rule[];
+    expect(required("")).toBe(true);
+  });
+});

package/src/quasar/SidPrincipalInput.vue

@@ -33,7 +33,7 @@
 <script setup lang="ts">
 import { ref, computed, watch } from "vue";
 import { isValidPhoneNumber } from "libphonenumber-js";
-import { isValidEmail } from "../utils/validators";
+import { REQUIRED_FIELD_TEXT, isValidEmail } from "../utils/validators";
 
 export type PrincipalType = "email" | "phone" | "username" | "unknown";
 
@@ -42,7 +42,13 @@ interface Props {
   minUsernameLength?: number;
   required?: boolean;
   label?: string;
-  /** Validate on each input change (false) vs only on blur (true). Default false — eager. */
+  /** What an empty required field says. */
+  requiredText?: string;
+  /**
+   * Validate once the field is left, then on every change (true), or on
+   * every change from the first keystroke (false). Default true: a field
+   * being typed into is not yet wrong.
+   */
   lazyRules?: boolean;
 }
 
@@ -52,7 +58,8 @@ const props = withDefaults(defineProps<Props>(), {
   minUsernameLength: 3,
   required: true,
   label: "Email, phone, or username",
-  lazyRules: false,
+  requiredText: REQUIRED_FIELD_TEXT,
+  lazyRules: true,
 });
 
 const emit = defineEmits<{
@@ -107,7 +114,7 @@ function onInput(value: string | number | null) {
 // --- Validation rules ---
 
 const requiredRule = (val: string) =>
-  !props.required || !!val || "This field is required";
+  !props.required || !!val || props.requiredText;
 
 const typeRule = (val: string): string | true => {
   if (!val) return true; // required rule handles empty

package/src/utils/validators.ts

@@ -42,6 +42,9 @@ export function maxLength(value: string, max: number): boolean {
   return value.length <= max;
 }
 
+/** What every form says of an empty required field, so one error reads alike. */
+export const REQUIRED_FIELD_TEXT = "This field is required";
+
 /** Check value is not empty/whitespace-only. */
 export function isRequired(value: string): boolean {
   return value.trim().length > 0;