user-v0.0.1.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "title": "User Personal Informations",
  "description": "JSON schema for a user.",
  "additionalProperties": false,
  "propertiesOrder": [
    "first_name",
    "last_name",
    "username",
    "email",
    "password",
    "street",
    "postal_code",
    "city",
    "country",
    "birth_date",
    "gender",
    "home_phone",
    "business_phone",
    "mobile_phone",
    "other_phone",
    "keep_history"
  ],
  "required": [
    "$schema",
    "first_name",
    "last_name",
    "birth_date"
  ],
  "properties": {
    "$schema": {
      "title": "Schema",
      "description": "Schema to validate user records against.",
      "type": "string",
      "minLength": 9,
      "default": "https://bib.rero.ch/schemas/users/user-v0.0.1.json"
    },
    "pid": {
      "title": "User ID",
      "type": "number"
    },
    "first_name": {
      "title": "First name",
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "widget": {
        "formlyConfig": {
          "focus": true
        }
      }
    },
    "last_name": {
      "title": "Last name",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "birth_date": {
      "title": "Date of birth",
      "type": "string",
      "format": "date",
      "pattern": "^(19|2[0-9])[0-9]{2}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$",
      "widget": {
        "formlyConfig": {
          "validation": {
            "messages": {
              "patternMessage": "Should be in the following format: 2022-12-31 (YYYY-MM-DD)."
            }
          },
          "props": {
            "placeholder": "Example: 1985-12-29"
          }
        }
      }
    },
    "gender": {
      "title": "Gender",
      "enum": [
        "male",
        "female",
        "other",
        "no_information"
      ],
      "widget": {
        "formlyConfig": {
          "props": {
            "options": [
              {
                "label": "male",
                "value": "male"
              },
              {
                "label": "female",
                "value": "female"
              },
              {
                "label": "other",
                "value": "other"
              },
              {
                "label": "no_information",
                "value": "no_information"
              }
            ]
          }
        }
      }
    },
    "username": {
      "title": "Username",
      "description": "Login username for the web interface.",
      "type": "string",
      "pattern": "^[a-zA-Z0-9-_]{2,255}$",
      "minLength": 3,
      "maxLength": 255,
      "widget": {
        "formlyConfig": {
          "expressionProperties": {
            "templateOptions.required": "true"
          },
          "validation": {
            "messages": {
              "patternMessage": "Username must start with a letter or a number, be at least three characters long and only contain alphanumeric characters, dashes and underscores.",
              "uniqueUsernameMessage": "This username is already taken."
            }
          }
        }
      }
    },
    "street": {
      "title": "Street",
      "description": "Street and number of the address.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "widget": {
        "formlyConfig": {
          "type": "textarea",
          "props": {
            "rows": 2
          }
        }
      }
    },
    "postal_code": {
      "title": "Postal code",
      "type": "string",
      "minLength": 1,
      "maxLength": 16
    },
    "city": {
      "title": "City",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "country": {
      "allOf": [
        {
          "widget": {
            "formlyConfig": {
              "props": {
                "itemCssClass": "col-lg-12"
              }
            }
          }
        },
        {
          "$ref": "https://bib.rero.ch/schemas/common/countries-v0.0.1.json#/country"
        }
      ]
    },
    "home_phone": {
      "title": "Home phone number",
      "description": "Home phone number with the international prefix, without spaces.",
      "type": "string",
      "pattern": "^\\+[0-9]*$",
      "minLength": 1,
      "maxLength": 255,
      "widget": {
        "formlyConfig": {
          "validation": {
            "messages": {
              "patternMessage": "Phone number with the international prefix, without spaces, ie +41221234567."
            }
          },
          "props": {
            "placeholder": "Example: +41791231212"
          }
        }
      }
    },
    "business_phone": {
      "title": "Business phone number",
      "description": "Business phone number with the international prefix, without spaces.",
      "type": "string",
      "pattern": "^\\+[0-9]*$",
      "minLength": 1,
      "maxLength": 255,
      "widget": {
        "formlyConfig": {
          "validation": {
            "messages": {
              "patternMessage": "Phone number with the international prefix, without spaces, ie +41221234567."
            }
          },
          "props": {
            "placeholder": "Example: +41791231212"
          }
        }
      }
    },
    "mobile_phone": {
      "title": "Mobile phone number",
      "description": "Mobile phone number with the international prefix, without spaces.",
      "type": "string",
      "pattern": "^\\+[0-9]*$",
      "minLength": 1,
      "maxLength": 255,
      "widget": {
        "formlyConfig": {
          "validation": {
            "messages": {
              "patternMessage": "Phone number with the international prefix, without spaces, ie +41221234567."
            }
          },
          "props": {
            "placeholder": "Example: +41791231212"
          }
        }
      }
    },
    "other_phone": {
      "title": "Other phone number",
      "description": "Other phone number with the international prefix, without spaces.",
      "type": "string",
      "pattern": "^\\+[0-9]*$",
      "minLength": 1,
      "maxLength": 255,
      "widget": {
        "formlyConfig": {
          "validation": {
            "messages": {
              "patternMessage": "Phone number with the international prefix, without spaces, ie +41221234567."
            }
          },
          "props": {
            "placeholder": "Example: +41791231212"
          }
        }
      }
    },
    "keep_history": {
      "title": "Keep history",
      "description": "If enabled, the loan history is saved for a maximum of six months. It is visible to the user and the library staff.",
      "type": "boolean",
      "default": false
    },
    "email": {
      "title": "Email",
      "type": "string",
      "format": "email",
      "maxLength": 255,
      "widget": {
        "formlyConfig": {
          "validation": {
            "messages": {
              "uniqueEmailMessage": "This email is already taken."
            }
          }
        }
      }
    },
    "password": {
      "title": "Password",
      "type": "string",
      "maxLength": 255,
      "widget": {
        "formlyConfig": {
          "type": "passwordGenerator",
          "props": {
            "api": "/api/user/password/generate"
          }
        }
      }
    }
  },
  "widget": {
    "formlyConfig": {
      "props": {
        "hideLabel": true
      }
    }
  }
}