feat: add mergeConfig exported function used also in prepareSolrClient

BREAKING CHANGE: the prepareSolrClient function now accepts
user config which is merged with the default config (overrides its
fields). The userConfig can also be empty.

Author: vsimko

package.json

@@ -2,7 +2,7 @@
   "name": "node-solr-lambda",
   "version": "1.1.0",
   "description": "Minimalistic Solr client written in functional programming style",
-  "main": "src/index.js",
+  "main": "src/index",
   "repository": "https://github.com/vsimko/node-solr-lambda.git",
   "author": "Viliam Simko <viliam.simko@gmail.com>",
   "license": "MIT",

src/index.js

@@ -66,8 +66,24 @@ const solrPost = config => path => async data => {
 const solrSchema = config => op => data =>
   solrPost(config)("schema")({ [op]: data })
 
-/** @param {SolrConfig} config */
-const prepareSolrClient = config => {
+const mergeConfig = (a, b) => mergeConfigImpure({ ...a }, b)
+
+function mergeConfigImpure (target, source) {
+  for (let k in source) {
+    const objOrScalar = target[k]
+    if (objOrScalar != null && objOrScalar.constructor === Object) {
+      mergeConfigImpure(objOrScalar, source[k]) // recurse on objects
+    } else {
+      target[k] = source[k] // assign scalar value
+    }
+  }
+  return target
+}
+
+/** @param {SolrConfig} userConfig */
+const prepareSolrClient = (userConfig = {}) => {
+  const config = mergeConfig(defaultConfig, userConfig)
+
   // sanity checks
   if (!config.core) {
     throw Error("missing 'core' parameter in your config")
@@ -109,5 +125,6 @@ const prepareSolrClient = config => {
 
 module.exports = {
   prepareSolrClient,
-  defaultConfig
+  defaultConfig,
+  mergeConfig
 }

src/index.d.ts src/solr.d.tssrc/index.d.ts renamed to src/solr.d.ts

@@ -261,126 +261,125 @@ interface FacetFunctionResult {
   [facetName: string]: number
 }
 
-declare global {
-  interface SolrData {
-    [key: string]: SolrDataValue
-  }
+export 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
+/**
+ * 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.
-   */
-  type FieldTypeProperties = FieldTypeGeneralProperties &
-    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
 
-  interface SolrDocument {
-    id: string
-    _childDocuments_?: SolrFragmentWithId | SolrFragmentWithId[]
-    [key: string]: SolrDataValue | SolrData
-  }
+export 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.
+ */
+export 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 {
+/**
+ * This type definition contains just the most important parts.
+ */
+export interface SolrException {
+  config
+  message: string
+  request: ClientRequest
+  response: {
     config
-    message: string
-    request: ClientRequest
-    response: {
-      config
-      data: {
-        error: {
-          code: number
-          details: {
-            errorMessages: string[]
-            [key: string]: object
-          }[]
-          metadata: string[]
-        }
-        responseHeader: SolrResponseHeader
+    data: {
+      error: {
+        code: number
+        details: {
+          errorMessages: string[]
+          [key: string]: object
+        }[]
+        metadata: string[]
       }
-      headers
-      request: ClientRequest
-      status: number
-      statusText: string
+      responseHeader: SolrResponseHeader
     }
-    stack: string
+    headers
+    request: ClientRequest
+    status: number
+    statusText: string
   }
+  stack: string
+}
 
-  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"
-    }
+export 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
-      }
+export 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
   }
+  debug?: boolean
+  core?: string
+  apiPrefix?: string
+}
 
-  interface DeleteQuery {
-    id?: string
-    query?: any
-  }
+export interface DeleteQuery {
+  id?: string
+  query?: any
 }

test/solr.test.js

@@ -3,9 +3,9 @@ const { expect } = require("chai")
 
 describe("#prepareSolrClient", () => {
   it("should be able to prepare the client", () => {
-    const client = prepareSolrClient()
-    expect(client).to.haveOwnProperty("ping")
-    expect(client).to.haveOwnProperty("select")
-    expect(client).to.haveOwnProperty("add")
+    const solr = prepareSolrClient({ core: "dummy" })
+    expect(solr).to.haveOwnProperty("ping")
+    expect(solr).to.haveOwnProperty("query")
+    expect(solr).to.haveOwnProperty("add")
   })
 })