ldap-rest 0.22.1 → 0.23.0

package/dist/src/config/schema.d.ts

@@ -32,6 +32,9 @@ export type SchemaAttributeType = 'string' | 'number' | 'integer' | 'boolean' |
  * | `accountExpiry`    | Date after which the account is to be removed        |
  * | `domainLink`       | DNs of the mail domains an organization may use      |
  * | `domainName`       | Domain name carried by a domain entry                |
+ *
+ * Clients look for more: `givenName` and `surname` name the parts of a
+ * person's name, which a form composes the `displayName` from.
  */
 export type SchemaRole = string;
 /**
@@ -150,6 +153,12 @@ export interface SchemaAttribute {
      * client never has to hardcode either.
      */
     hint?: LocalizedText;
+    /**
+     * What the attribute is, for a client to show on demand — a tooltip next to
+     * the label — where its label alone does not say: "Employee ID" names a
+     * number, not whose records hold it.
+     */
+    help?: LocalizedText;
     branch?: string[];
     fixed?: boolean;
     /** Semantic role(s) — see {@link SchemaRole} */

package/docs/usage/plugins/ldap/flat-generic.md

@@ -222,6 +222,27 @@ cannot drift apart, and neither is hardcoded in the interface. A translated
 hint is picked like a label; the server's messages are in English, so it
 quotes the English text.
 
+### Explaining an attribute: `help`
+
+A label names an attribute; it does not always say what it is. `help` does,
+for a client to show on demand — a tooltip next to the label — rather than
+under every field:
+
+```json
+{
+  "employeeNumber": {
+    "type": "string",
+    "label": { "en": "Employee ID", "fr": "Matricule" },
+    "help": {
+      "en": "The person's registration number, as the personnel records hold it.",
+      "fr": "Le matricule de la personne, tel que le tient la gestion du personnel."
+    }
+  }
+}
+```
+
+It is picked like a label. The server never shows it.
+
 ### Attributes a client may not send
 
 | Marker      | Meaning                                                                         |
@@ -303,6 +324,10 @@ chose in its own. The roles the core looks for:
 An attribute may carry several roles (`"role": ["identifier", "displayName"]`),
 and a deployment is free to add its own for its plugins.
 
+Clients look for more: `givenName` and `surname` name the parts of a person's
+name, which a form composes the `displayName` from. The shipped user schemas
+mark `givenName` and `sn` with them.
+
 ### Which attributes a search covers: `searchable`
 
 `GET /{pluralName}?match=…&attribute=…` takes one attribute name or several

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ldap-rest",
-  "version": "0.22.1",
+  "version": "0.23.0",
   "description": "Light directory manager",
   "keywords": [
     "Identity-Manager"

package/static/schemas/ad/users.json

@@ -37,11 +37,13 @@
     },
     "sn": {
       "type": "string",
-      "required": true
+      "required": true,
+      "role": "surname"
     },
     "givenName": {
       "type": "string",
-      "required": false
+      "required": false,
+      "role": "givenName"
     },
     "displayName": {
       "type": "string",

package/static/schemas/example/users.json

@@ -57,6 +57,7 @@
       "test": "^[A-ZÀ-ÖØ-Þ](?!.*([\\s’'-]{2}|[.’'-]{2}|\\s\\.|[\\s’'-]$))[A-Za-zÀ-ÖØ-öø-ÿ\\s’'.-]{1,50}$",
       "hint": "Starts with a capital, up to 51 letters, no repeated space, apostrophe, hyphen or dot",
       "required": true,
+      "role": "surname",
       "label": "Last name"
     },
     "givenName": {
@@ -65,6 +66,7 @@
       "test": "^[A-ZÀ-ÖØ-Þ](?!.*([\\s’'-]{2}|[.’'-]{2}|\\s\\.|[\\s’'-]$))[A-Za-zÀ-ÖØ-öø-ÿ\\s’'.-]{1,50}$",
       "hint": "Starts with a capital, up to 51 letters, no repeated space, apostrophe, hyphen or dot",
       "required": true,
+      "role": "givenName",
       "label": "First name"
     },
     "displayName": {

package/static/schemas/obm/users.json

@@ -53,7 +53,8 @@
     },
     "sn": {
       "type": "string",
-      "required": true
+      "required": true,
+      "role": "surname"
     },
     "homeDirectory": {
       "type": "string",
@@ -76,7 +77,8 @@
     },
     "givenName": {
       "type": "string",
-      "required": true
+      "required": true,
+      "role": "givenName"
     },
     "displayName": {
       "type": "string",

package/static/schemas/standard/users.json

@@ -31,7 +31,8 @@
     },
     "sn": {
       "type": "string",
-      "required": true
+      "required": true,
+      "role": "surname"
     },
     "mail": {
       "type": "string",
@@ -55,7 +56,8 @@
     },
     "givenName": {
       "type": "string",
-      "required": false
+      "required": false,
+      "role": "givenName"
     },
     "displayName": {
       "type": "string",

package/static/schemas/twake/users.json

@@ -53,12 +53,30 @@
       "type": "string",
       "searchable": true,
       "required": true,
-      "unique": { "sentinel": "UNIT" },
+      "unique": {
+        "sentinel": "UNIT"
+      },
       "role": "employeeId",
       "label": {
         "en": "Employee ID",
         "fr": "Matricule",
         "mn": "Ажилтны дугаар"
+      },
+      "help": {
+        "en": "The person's registration number, as the personnel records hold it. Unique in the directory, except UNIT, which the accounts of no one in particular (shared, technical) take.",
+        "fr": "Le matricule de la personne, tel que le tient la gestion du personnel. Unique dans l'annuaire, sauf UNIT, que prennent les comptes qui ne sont à personne en particulier (partagés, techniques).",
+        "mn": "Хүний нөөцийн бүртгэлд байгаа ажилтны дугаар. Лавлахад давхцахгүй байх ёстой; хэн нэгэн хүнд хамааралгүй (дундын, техникийн) бүртгэлүүд UNIT утгыг авна."
+      }
+    },
+    "twakeDepartmentLink": {
+      "type": "pointer",
+      "branch": ["__LDAP_BASE__"],
+      "required": true,
+      "role": "organizationLink",
+      "label": {
+        "en": "Department",
+        "fr": "Organisation",
+        "mn": "Байгууллага"
       }
     },
     "cn": {
@@ -75,6 +93,7 @@
       "type": "string",
       "searchable": true,
       "required": true,
+      "role": "surname",
       "label": {
         "en": "Last name",
         "fr": "Nom de famille",
@@ -85,6 +104,7 @@
       "type": "string",
       "searchable": true,
       "required": true,
+      "role": "givenName",
       "label": {
         "en": "First name",
         "fr": "Prénom",
@@ -289,17 +309,6 @@
         "mn": "Нууц үгээ солих шаардлагатай"
       }
     },
-    "twakeDepartmentLink": {
-      "type": "pointer",
-      "branch": ["__LDAP_BASE__"],
-      "required": true,
-      "role": "organizationLink",
-      "label": {
-        "en": "Department",
-        "fr": "Organisation",
-        "mn": "Байгууллага"
-      }
-    },
     "twakeDepartmentPath": {
       "type": "string",
       "test": "^[^\\r\\n]{1,4096}$",