itemsjs/src/index.js at 2a15f5a63bbcd7f776162cfe7a80df4cdad194e8 · itemsapi/itemsjs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
import { search, similar, aggregation } from './lib.js';
import {
  mergeAggregations,
  buildFiltersQueryFromFacets,
  normalizeRuntimeFacetConfig,
} from './helpers.js';
import { Fulltext } from './fulltext.js';
import { Facets } from './facets.js';

function itemsjs(items, configuration) {
  configuration = configuration || Object.create(null);

  // upsert id to items
  // throw error in tests if id does not exists

  let fulltext;
  if (configuration.native_search_enabled !== false) {
    fulltext = new Fulltext(items, configuration);
  }

  // index facets
  let facets = new Facets(items, configuration);

  return {
    /**
     * per_page
     * page
     * query
     * sort
     * filters
     */
    search: function (input) {
      input = input || Object.create(null);

      // allow runtime facet options via input.facets (alias for aggregations/filters)
      let effectiveConfiguration = configuration;
      if (input.facets) {
        const { aggregations, filters } = normalizeRuntimeFacetConfig(
          input.facets,
          configuration,
        );

        effectiveConfiguration = {
          ...configuration,
          aggregations,
        };

        // merge filters so buckets can mark selected values
        if (filters) {
          input.filters = {
            ...(input.filters || {}),
            ...filters,
          };
        }

        if (!input.filters_query) {
          const filters_query = buildFiltersQueryFromFacets(
            input.facets,
            effectiveConfiguration,
          );
          if (filters_query) {
            input.filters_query = filters_query;
          }
        }

        // Facets instance keeps reference to config; update for this run
        facets.config = effectiveConfiguration.aggregations;
      } else {
        facets.config = configuration.aggregations;
      }

      /**
       * merge configuration aggregation with user input
       */
      input.aggregations = mergeAggregations(
        effectiveConfiguration.aggregations,
        input,
      );

      const result = search(
        items,
        input,
        effectiveConfiguration,
        fulltext,
        facets,
      );

      if (result?.data?.aggregations && !result.data.facets) {
        result.data.facets = result.data.aggregations;
      }

      return result;
    },

    /**
     * returns list of similar elements to specified item id
     * id
     */
    similar: function (id, options) {
      return similar(items, id, options);
    },

    /**
     * returns list of elements for specific aggregation i.e. list of tags
     * name (aggregation name)
     * query
     * per_page
     * page
     */
    aggregation: function (input) {
      let aggregationConfiguration = configuration;

      if (input?.facets) {
        const { aggregations } = normalizeRuntimeFacetConfig(
          input.facets,
          configuration,
        );

        aggregationConfiguration = {
          ...configuration,
          aggregations,
        };

        facets.config = aggregationConfiguration.aggregations;
      } else {
        facets.config = configuration.aggregations;
      }

      return aggregation(
        items,
        input,
        aggregationConfiguration,
        fulltext,
        facets,
      );
    },

    /**
     * reindex items
     * reinitialize fulltext search
     */
    reindex: function (newItems) {
      items = newItems;
      fulltext = new Fulltext(items, configuration);
      facets = new Facets(items, configuration);
    },

    /**
     * export snapshots for faster cold starts
     */
    serializeFulltext: function () {
      if (!fulltext) {
        return null;
      }
      return fulltext.serialize();
    },

    serializeFacets: function () {
      return facets.serialize();
    },

    serializeAll: function () {
      return {
        version: 'itemsjs-snapshot-v1',
        fulltext: this.serializeFulltext(),
        facets: this.serializeFacets(),
      };
    },
  };
}

export default itemsjs;