Fixed unit tests and completed docs

CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Solr field types creation from model
+
+### Changed
+- Solr fields schema creation from model usage
+- `ping()` method now throws when the request fails instead returning false
 
 ## [1.5.0] - 2020-06-11
 ### Added

README.md

@@ -87,14 +87,15 @@ Get the current fields schema frol Solr
 - Rejects `SolrError`: When something bad occurs
 
 ### ***async*** `updateSchema(model)`
-Update the fields schema by syncing the current fields schema in Solr with the defined schema in the model static getter `schema`.
+Update the fields types and schema by syncing the current fields schema in Solr with the defined schema in the model static getter `schema`* and `fieldTypes`**.
 
 - model `Model`: A model instance
 
 - Resolves `Boolean`: `true` if the operation was successful
 - Rejects `SolrError`: When something bad occurs
 
-If you need details about how to define the fields schema in the model, see the schema apart [below](#schema)
+*If you need details about how to define the fields schema in the model, see the schema apart [below](#Fields-schema)  
+**If you need details about how to define the field types in the model, see the field types apart [below](#Field-types)
 
 #### Fields schema
 
@@ -201,6 +202,36 @@ These fields stores an object with multiple properties that **can be of differen
 
 It will show as a **full object** on `get` operations.
 
+#### Field types
+Custom field types can be defined in the model static getter `fieldTypes` like this:
+
+```js
+class MyModel extends Model {
+
+	static get fieldTypes(){
+
+		return {
+			myFieldType: {
+				class: 'solr.TextField',
+				indexed: false,
+				stored: true
+				// ...
+			}
+		}
+	}
+
+	static get schema(){
+
+		return {
+			myCustomField: { type: 'myFieldType' }
+			// ...
+		}
+	}
+}
+```
+
+The field type content accepts native Solr field type properties, please check the [Solr field types documentation for more information](https://lucene.apache.org/solr/guide/8_5/field-type-definitions-and-properties.html#field-type-definitions-and-properties).
+
 ### ***async*** `insert(model, item)`
 Inserts one document in a solr core
 
@@ -426,6 +457,7 @@ Removes one or more documents in a solr core
 Checks if the Solr host and core is online
 
 - Resolves `Boolean`: `true` if the Solr ping status is `'OK'`, `false` otherwise
+- Rejects: `SolrError`: When something bad occurs
 
 ## Errors
 

lib/helpers/schema.js

@@ -145,6 +145,10 @@ class Schema {
 	}
 
 	static _getType(type) {
+
+		if(!type)
+			return FIELD_TYPES.string;
+
 		return FIELD_TYPES[type] || { type };
 	}
 

lib/solr.js

@@ -447,7 +447,15 @@ class Solr {
 
 		const endpoint = Endpoint.create(Endpoint.presets.ping, this.url, this.core);
 
-		const res = await this.request.get(endpoint);
+		let res;
+
+		try {
+
+			res = await this.request.get(endpoint);
+
+		} catch(err) {
+			throw err;
+		}
 
 		try {
 

tests/solr-test.js

@@ -57,7 +57,7 @@ describe('Solr', () => {
 			return {
 				custom: { type: 'someFieldType' },
 				otherCustom: { type: 'otherFieldType' },
-				string: { type: 'string' },
+				string: true,
 				number: { type: 'number' },
 				float: { type: 'float' },
 				double: { type: 'double' },
@@ -1056,6 +1056,27 @@ describe('Solr', () => {
 		});
 	});
 
+	describe('getFieldTypes()', () => {
+
+		it('Should call Solr GET api to get the field types', async () => {
+
+			const request = nock(host)
+				.get(endpoints.schemaFieldTypes)
+				.reply(200, {
+					responseHeader: {
+						status: 0
+					},
+					fieldTypes: builtFieldTypes
+				});
+
+			const currentSchemas = await solr.getFieldTypes();
+
+			assert.deepStrictEqual(currentSchemas, builtFieldTypes);
+
+			request.done();
+		});
+	});
+
 	describe('updateSchema()', () => {
 
 		it('Should call Solr POST api to update the schema and reload the core', async () => {
@@ -1380,6 +1401,21 @@ describe('Solr', () => {
 			request.done();
 		});
 
+		it('Should return false when the Solr ping status response is invalid', async () => {
+
+			const request = nock(host)
+				.get(endpoints.ping)
+				.reply(200, {
+					responseHeader: {
+						status: 0
+					}
+				});
+
+			assert.deepEqual(await solr.ping(), false);
+
+			request.done();
+		});
+
 		it('Should reject when the Solr ping request fails', async () => {
 
 			nock.disableNetConnect();