fix: remove solrGet and use solrPost everywhere, update typedefs

BREAKING CHANGE:
- `select` function replaced by `query`
- `facet` function removed because we now have query+typedefs
- we now use the Solr JSON API in `SolrQuery` type with additional parameters inside `SolrQuery.params`.
- the config has now nested section `urlConfig` which is passed directly to `url.format` before calling `axios.post`.

Author: vsimko

src/index.d.ts

@@ -1,21 +1,18 @@
 import { AxiosError } from "axios"
 import { ClientRequest } from "http"
+import { UrlObject } from "url"
 
 // TODO: similarity https://lucene.apache.org/solr/guide/7_5/other-schema-elements.html#similarity
 // TODO: unique key https://lucene.apache.org/solr/guide/7_5/other-schema-elements.html#unique-key
 // TODO: dynamic fields https://lucene.apache.org/solr/guide/7_5/dynamic-fields.html
 // TODO: copying fields https://lucene.apache.org/solr/guide/7_5/copying-fields.html
-
-/**
- * @file
- * @see https://lucene.apache.org/solr/guide/7_5/v2-api.html
- */
+// https://lucene.apache.org/solr/guide/7_5/v2-api.html
 
 /**
  * Field types that are available in Solr (except deprecated fields).
  * @see https://lucene.apache.org/solr/guide/7_5/field-types-included-with-solr.html#field-types-included-with-solr
  */
-export type FieldTypesIncludedInSolr =
+type FieldTypesIncludedInSolr =
   | "solr.BinaryField"
   | "solr.BoolField"
   | "solr.CollationField"
@@ -234,58 +231,18 @@ interface FieldTypeDefaultProperties {
   large?: boolean
 }
 
-/**
- * Fields are defined in the fields element of `schema.xml`.
- * Once you have the **field types** set up, defining the fields themselves is simple.
- *
- * @see https://lucene.apache.org/solr/guide/7_5/defining-fields.html
- * @see https://lucene.apache.org/solr/guide/7_5/defining-fields.html#optional-field-type-override-properties
- */
-export type FieldProperties = FieldGeneralProperties &
-  FieldTypeDefaultProperties
-
-/**
- * A field type defines the analysis that will occur on a field when documents are indexed
- * or queries are sent to the index.
- * A field type definition can include four types of information:
- * - The `name` of the field type (**mandatory**).
- * - An implementation `class` name (**mandatory**).
- * - If the field type is `TextField`, a description of the field analysis for the field type.
- * - Field type properties - depending on the implementation class,
- *   some properties **may be mandatory**.
- *
- * The field type `class` determines most of the behavior of a field type, but optional properties
- * can also be defined.
- *
- * The properties that can be specified for a given field type fall into three major categories:
- * - Properties specific to the field type’s class.
- * - General Properties {@link FieldTypeGeneralProperties} that Solr supports for any field type.
- * - Field Default Properties {@link FieldTypeDefaultProperties} that can be specified on the field
- *   type that will be inherited by fields that use this type instead of the default behavior.
- */
-export type FieldTypeProperties = FieldTypeGeneralProperties &
-  FieldTypeDefaultProperties
-
 type SolrFragmentWithId = {
   id: string
   [key: string]: string | string[]
 }
 
-type SolrDataValue =
-  | string
-  | string[]
-  | SolrFragmentWithId
-  | SolrFragmentWithId[]
-
-export interface SolrData {
-  [key: string]: SolrDataValue
-}
-
-export interface SolrDocument {
-  id: string
-  _childDocuments_?: SolrFragmentWithId | SolrFragmentWithId[]
-  [key: string]: SolrDataValue | SolrData
-}
+// TODO: SolrDataValue
+type SolrDataValue = any
+// type SolrDataValue =
+//   | string
+//   | string[]
+//   | SolrFragmentWithId
+//   | SolrFragmentWithId[]
 
 /**
  * This type definition contains just the most important parts.
@@ -296,61 +253,129 @@ interface SolrResponseHeader {
   QTime: number
 }
 
-/**
- * This type definition contains just the most important parts.
- */
-export interface SolrResponse {
-  status?: string
-  response?: {
-    docs: SolrDocument[]
-    numFound: number
-    start: number
-  }
-  responseHeader: SolrResponseHeader
+interface TermsFacet {
+  buckets: { val: string; count: number }[]
 }
 
-/**
- * This type definition contains just the most important parts.
- */
-export interface SolrException {
-  config
-  message: string
-  request: ClientRequest
-  response: {
+interface FacetFunctionResult {
+  [facetName: string]: number
+}
+
+declare global {
+  interface SolrData {
+    [key: string]: SolrDataValue
+  }
+
+  /**
+   * Fields are defined in the fields element of `schema.xml`.
+   * Once you have the **field types** set up, defining the fields themselves is simple.
+   *
+   * @see https://lucene.apache.org/solr/guide/7_5/defining-fields.html
+   * @see https://lucene.apache.org/solr/guide/7_5/defining-fields.html#optional-field-type-override-properties
+   */
+  type FieldProperties = FieldGeneralProperties & FieldTypeDefaultProperties
+
+  /**
+   * A field type defines the analysis that will occur on a field when documents are indexed
+   * or queries are sent to the index.
+   * A field type definition can include four types of information:
+   * - The `name` of the field type (**mandatory**).
+   * - An implementation `class` name (**mandatory**).
+   * - If the field type is `TextField`, a description of the field analysis for the field type.
+   * - Field type properties - depending on the implementation class,
+   *   some properties **may be mandatory**.
+   *
+   * The field type `class` determines most of the behavior of a field type, but optional properties
+   * can also be defined.
+   *
+   * The properties that can be specified for a given field type fall into three major categories:
+   * - Properties specific to the field type’s class.
+   * - General Properties {@link FieldTypeGeneralProperties} that Solr supports for any field type.
+   * - Field Default Properties {@link FieldTypeDefaultProperties} that can be specified on the field
+   *   type that will be inherited by fields that use this type instead of the default behavior.
+   */
+  type FieldTypeProperties = FieldTypeGeneralProperties &
+    FieldTypeDefaultProperties
+
+  interface SolrDocument {
+    id: string
+    _childDocuments_?: SolrFragmentWithId | SolrFragmentWithId[]
+    [key: string]: SolrDataValue | SolrData
+  }
+
+  /**
+   * This type definition contains just the most important parts.
+   */
+  interface SolrResponse {
+    status?: string
+    facets?: {
+      count?: number
+    } & {
+      [facetName: string]: (TermsFacet | FacetFunctionResult)[] // TODO: to be completed
+    }
+    response?: {
+      docs: SolrDocument[]
+      numFound: number
+      start: number
+    }
+    responseHeader: SolrResponseHeader
+  }
+
+  /**
+   * This type definition contains just the most important parts.
+   */
+  interface SolrException {
     config
-    data: {
-      error: {
-        code: number
-        details: {
-          errorMessages: string[]
-          [key: string]: object
-        }[]
-        metadata: string[]
+    message: string
+    request: ClientRequest
+    response: {
+      config
+      data: {
+        error: {
+          code: number
+          details: {
+            errorMessages: string[]
+            [key: string]: object
+          }[]
+          metadata: string[]
+        }
+        responseHeader: SolrResponseHeader
       }
-      responseHeader: SolrResponseHeader
+      headers
+      request: ClientRequest
+      status: number
+      statusText: string
     }
-    headers
-    request: ClientRequest
-    status: number
-    statusText: string
+    stack: string
   }
-  stack: string
-}
 
-export interface SolrSelect {
-  q: string
-  fl?: string
-  fq?: string[]
-  start?: number
-  sort?: string
-  rows?: number
-  hl?: "on" | "off"
-  "hl.simple.pre"?: string
-  "hl.simple.post"?: string
-  "hl.fl"?: string
-  debugQuery?: "on" | "off"
-  indent?: "off" | "on"
-  wt?: "json" | "xml" | "python" | "ruby" | "php" | "csv"
-  "json.facet"?: object
-  facet?:"on" | "off"
+  interface SolrQuery {
+    query?
+    filter?
+    start?
+    limit?
+    sort?
+    facet?
+    params?: {
+      hl?: "on" | "off"
+      "hl.simple.pre"?: string
+      "hl.simple.post"?: string
+      "hl.fl"?: string
+      indent?: "off" | "on"
+    }
+  }
+
+  interface SolrConfig {
+    urlConfig: UrlObject & {
+      query: {
+        overwrite: boolean
+        commitWithin: number
+        wt: "json" | "xml" | "python" | "ruby" | "php" | "csv"
+        [key: string]: any
+      }
+    }
+    debug: boolean
+    core?: string
+    apiPrefix: string
+  }
 }