Fix the MappingsProperties type (#705)

Fix the MappingsProperties type to reflect the real mappings object structure

Author: Adrien Maret

src/types/Mappings.ts

@@ -1,24 +1,42 @@
 import { JSONObject } from './JSONObject';
 
-export type MappingsProperties = {
-  /**
-   * Properties types definition
-   *
-   * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#mappings-properties
-   */
-  properties?: MappingsProperties | JSONObject,
+type PropertyObject = {
+  properties?: MappingsProperties;
+}
+
+type PropertyDynamic = {
   /**
    * Dynamic mapping policy
    *
    * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#mappings-dynamic-policy
    */
-  dynamic?: 'true' | 'false' | 'strict'
+  dynamic?: 'true' | 'false' | 'strict';
 }
 
+type PropertyType = {
+  [name: string]: { type?: string; } | PropertyObject | JSONObject
+}
+
+export type MappingsProperties = PropertyObject | PropertyDynamic | PropertyType;
+
 /**
  * Collection mappings definition
  *
  * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#collection-mappings
+ *
+ * @example
+ * ```
+ * {
+ *   properties: {
+ *     name: { type: 'keyword' },
+ *     address: {
+ *       properties: {
+ *         zipcode: { type: 'integer' }
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
  */
 export type CollectionMappings = {
   /**
@@ -27,16 +45,18 @@ export type CollectionMappings = {
    * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#mappings-metadata
    */
   _meta?: JSONObject;
+
   /**
    * Properties types definition
    *
    * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#mappings-properties
    */
-  properties?: MappingsProperties,
+  properties?: MappingsProperties;
+
   /**
    * Dynamic mapping policy
    *
    * @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#mappings-dynamic-polic
    */
-  dynamic?: 'true' | 'false' | 'strict',
+  dynamic?: 'true' | 'false' | 'strict';
 }