getOrCreate, Error Handler and CreateIndex Usage changes

[bidoubiwa]

In this PR

CreateIndex Usage changes

Previously

client.createIndex(data: IndexRequest): Promise<Index>

New usage:

client.createIndex(uid: string, options?: IndexOptions): Promise<Index>

Example

await client.createIndex('movies', {
  primaryKey: "movieId"
})

Error Handler

• Http error handler to dispatch to the right error

function httpErrorHandler(e: AxiosError, cachedStack?: string): void {
  if (e.response !== undefined) {
    throw new MeiliSearchApiError(e, cachedStack)
  } else if (e.isAxiosError) {
    throw new MeilISearchCommunicationError(e.message)
  } else {
    throw e
  }
}

• Create additional error meiliSearchCommunicationError when a problem occurred when trying to communicate with MeiliSearch.

Refactor

• Changed the name of the folder custom-errors to errors
• Changed meilisearchError to meilisearchApiError

NEW: AddOrCreateIndex

• Updated example with getOrCreateIndex
• Added getOrCreateIndex in the README references
• Tests for getOrCreateIndex

If movies does not exist it will be created in MeiliSearch and will return an index instance.
If it already exists, it returns an index instance.

const index = await client.addOrCreateIndex('movies', {
  primaryKey: "movieId"
})

[curquiza]

Http error handler to dispatch to the right error

What is the default error?
According to this issue, the default one should be MeiliSearchError.

Add Or Create Index

I wait for the Samuel answer in this issue before reviewing.

[bidoubiwa]

MeiliSearchError: for any other errors in the SDK (wrong parameter if the SDK checks the parameters...etc)

Since we do not check anything in the SDK for the moment I did not add this error. For any native error as:
EvalError, InternalError, RangeError, ReferenceError, SyntaxError, TypeError, URIError
they are being passed down with throw e.

[curquiza]

Ok, but what is e exactly? What does it contain? 🙂

[bidoubiwa]

e is the Error object.
By default it is the global error object:
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
But in the case it was returned by Axios, it is an axiosError that inherits the default Error object.

[curquiza]

@bidoubiwa, according to this comment:

• You can now update the getOrCreateIndex method in this PR
• You can create a new PR that modifies createIndex
  🙂