@mindful-web/marko-web-search 1.0.0

package/components/links/set-filter-value.marko.js

@@ -0,0 +1,86 @@
+// Compiled using marko@4.20.2 - DO NOT EDIT
+"use strict";
+
+var marko_template = module.exports = require("marko/dist/html").t(__filename),
+    marko_componentType = "/@mindful-web/marko-web-search$1.0.0/components/links/set-filter-value.marko",
+    marko_renderer = require("marko/dist/runtime/components/renderer"),
+    module_defaultValue = require("@mindful-web/marko-core/utils/default-value"),
+    defaultValue = module_defaultValue.default || module_defaultValue,
+    marko_dynamicTag = require("marko/dist/runtime/helpers/dynamic-tag"),
+    marko_web_search_link_template = require("./link.marko"),
+    marko_loadTag = require("marko/dist/runtime/helpers/load-tag"),
+    marko_web_search_link_tag = marko_loadTag(marko_web_search_link_template);
+
+function render(input, out, __component, component, state) {
+  var data = input;
+
+  const { isArray } = Array;
+
+  const { $markoWebSearch: search } = out.global;
+
+  const { name } = input;
+
+  const { value } = input;
+
+  const v = search.isArrayParam(name) && !isArray(value) ? [value] : value;
+
+  const resetPage = defaultValue(input.resetPage, true);
+
+  const queryValues = {
+  [name]: v,
+  ...(resetPage && { page: 1 }),
+};
+
+  const resetValues = {
+  ...queryValues,
+  [name]: null,
+};
+
+  const isSelected = search.isInputValueSelectedFor(name, v);
+
+  if (isSelected) {
+    marko_web_search_link_tag({
+        path: input.path,
+        queryValues: resetValues,
+        class: input.resetClass,
+        target: input.target,
+        rel: input.rel,
+        attrs: input.attrs,
+        renderBody: function(out) {
+          marko_dynamicTag(out, input.renderBody, function() {
+            return {
+                "is-selected": false
+              };
+          }, null, null, null, __component, "1");
+        }
+      }, out, __component, "0");
+  } else {
+    marko_web_search_link_tag({
+        path: input.path,
+        queryValues: queryValues,
+        class: input.class,
+        target: input.target,
+        rel: input.rel,
+        attrs: input.attrs,
+        renderBody: function(out) {
+          marko_dynamicTag(out, input.renderBody, function() {
+            return {
+                "is-selected": false
+              };
+          }, null, null, null, __component, "3");
+        }
+      }, out, __component, "2");
+  }
+}
+
+marko_template._ = marko_renderer(render, {
+    d_: true,
+    e_: marko_componentType
+  });
+
+marko_template.meta = {
+    id: "/@mindful-web/marko-web-search$1.0.0/components/links/set-filter-value.marko",
+    tags: [
+      "./link.marko"
+    ]
+  };

package/components/marko.json

@@ -0,0 +1,25 @@
+{
+  "taglib-imports": [
+    "./filters/marko.json",
+    "./form/marko.json",
+    "./links/marko.json",
+    "./sort-by/marko.json"
+  ],
+  "<marko-web-search-build-href>": {
+    "template": "./build-href.marko",
+    "@path": "string",
+    "@query-values": "object"
+  },
+  "<marko-web-search-query>": {
+    "template": "./query.marko"
+  },
+  "<marko-web-search-pagination-controls>": {
+    "template": "./pagination-controls.marko",
+    "<block>": {},
+    "<link>": {},
+    "@total-count": "number"
+  },
+  "<marko-web-search-query-child-sections>": {
+    "template": "./query-child-sections.marko"
+  }
+}

package/components/pagination-controls.marko

@@ -0,0 +1,42 @@
+import defaultValue from "@mindful-web/marko-core/utils/default-value";
+import { get } from "@mindful-web/object-path";
+import { isFunction } from '@mindful-web/utils';
+
+$ const { $markoWebSearch: search, i18n } = out.global;
+$ const totalCount = defaultValue(input.totalCount, 0);
+$ const linkClasses = get(input.link, "class");
+
+$ const blockName = "marko-web-search-pagination-controls";
+
+<if(totalCount)>
+  <marko-web-block ...input.block name=blockName>
+    <marko-web-search-previous-page-link
+      ...input.link
+      class=`${linkClasses} ${blockName}__prev`
+    />
+
+    <marko-web-element block-name=blockName name="pages">
+      $ const currentPage = search.getCurrentPage();
+      $ const totalPages = search.getTotalPages(totalCount);
+      <if(input.renderBody)>
+        <!-- custom rendering -->
+        <${input.renderBody} current-page=currentPage total-pages=totalPages />
+      </if>
+      <else>
+        <!-- default rendering -->
+        <if(isFunction(i18n))>
+          ${i18n("Page")} ${currentPage} ${i18n("of")} ${totalPages}
+        </if>
+        <else>
+          Page ${currentPage} of ${totalPages}
+        </else>
+      </else>
+    </marko-web-element>
+
+    <marko-web-search-next-page-link
+      ...input.link
+      class=`${linkClasses} ${blockName}__next`
+      total-count=totalCount
+    />
+  </marko-web-block>
+</if>

package/components/pagination-controls.marko.js

@@ -0,0 +1,108 @@
+// Compiled using marko@4.20.2 - DO NOT EDIT
+"use strict";
+
+var marko_template = module.exports = require("marko/dist/html").t(__filename),
+    marko_componentType = "/@mindful-web/marko-web-search$1.0.0/components/pagination-controls.marko",
+    marko_renderer = require("marko/dist/runtime/components/renderer"),
+    module_defaultValue = require("@mindful-web/marko-core/utils/default-value"),
+    defaultValue = module_defaultValue.default || module_defaultValue,
+    module_objectPath_module = require("@mindful-web/object-path"),
+    objectPath_module = module_objectPath_module.default || module_objectPath_module,
+    get = module_objectPath_module.get,
+    module_utils_module = require("@mindful-web/utils"),
+    utils_module = module_utils_module.default || module_utils_module,
+    isFunction = module_utils_module.isFunction,
+    marko_assign = require("marko/dist/runtime/helpers/assign"),
+    marko_web_search_previous_page_link_template = require("./links/previous-page.marko"),
+    marko_loadTag = require("marko/dist/runtime/helpers/load-tag"),
+    marko_web_search_previous_page_link_tag = marko_loadTag(marko_web_search_previous_page_link_template),
+    marko_dynamicTag = require("marko/dist/runtime/helpers/dynamic-tag"),
+    helpers_escape_xml = require("marko/dist/runtime/html/helpers/escape-xml"),
+    marko_escapeXml = helpers_escape_xml.x,
+    marko_web_element_template = require("@mindful-web/marko-web/components/element/index.marko"),
+    marko_web_element_tag = marko_loadTag(marko_web_element_template),
+    marko_web_search_next_page_link_template = require("./links/next-page.marko"),
+    marko_web_search_next_page_link_tag = marko_loadTag(marko_web_search_next_page_link_template),
+    marko_web_block_template = require("@mindful-web/marko-web/components/element/block.marko"),
+    marko_web_block_tag = marko_loadTag(marko_web_block_template);
+
+function render(input, out, __component, component, state) {
+  var data = input;
+
+  const { $markoWebSearch: search, i18n } = out.global;
+
+  const totalCount = defaultValue(input.totalCount, 0);
+
+  const linkClasses = get(input.link, "class");
+
+  const blockName = "marko-web-search-pagination-controls";
+
+  if (totalCount) {
+    marko_web_block_tag(marko_assign({
+        name: "block",
+        tag: "div"
+      }, input.block, {
+        name: blockName,
+        renderBody: function(out) {
+          marko_web_search_previous_page_link_tag(marko_assign({}, input.link, {
+              class: ((linkClasses + " ") + blockName) + "__prev"
+            }), out, __component, "1");
+
+          marko_web_element_tag({
+              name: "pages",
+              tag: "div",
+              blockName: blockName,
+              renderBody: function(out) {
+                const currentPage = search.getCurrentPage();
+
+                const totalPages = search.getTotalPages(totalCount);
+
+                if (input.renderBody) {
+                  marko_dynamicTag(out, input.renderBody, function() {
+                    return {
+                        "current-page": currentPage,
+                        "total-pages": totalPages
+                      };
+                  }, null, null, null, __component, "3");
+                } else {
+                  if (isFunction(i18n)) {
+                    out.w(marko_escapeXml(i18n("Page")) +
+                      " " +
+                      marko_escapeXml(currentPage) +
+                      " " +
+                      marko_escapeXml(i18n("of")) +
+                      " " +
+                      marko_escapeXml(totalPages));
+                  } else {
+                    out.w("Page " +
+                      marko_escapeXml(currentPage) +
+                      " of " +
+                      marko_escapeXml(totalPages));
+                  }
+                }
+              }
+            }, out, __component, "2");
+
+          marko_web_search_next_page_link_tag(marko_assign({}, input.link, {
+              class: ((linkClasses + " ") + blockName) + "__next",
+              totalCount: totalCount
+            }), out, __component, "4");
+        }
+      }), out, __component, "0");
+  }
+}
+
+marko_template._ = marko_renderer(render, {
+    d_: true,
+    e_: marko_componentType
+  });
+
+marko_template.meta = {
+    id: "/@mindful-web/marko-web-search$1.0.0/components/pagination-controls.marko",
+    tags: [
+      "./links/previous-page.marko",
+      "@mindful-web/marko-web/components/element/index.marko",
+      "./links/next-page.marko",
+      "@mindful-web/marko-web/components/element/block.marko"
+    ]
+  };

package/components/query-child-sections.marko

@@ -0,0 +1,24 @@
+import gql from "graphql-tag";
+import { getAsArray } from "@mindful-web/object-path";
+
+$ const queryFragment = gql`
+  fragment MarkoWebSearchChildSectionsFragment on WebsiteSection {
+    id
+    children(input: { pagination: { limit: 100 }, sort: { field: name, order: asc } }) {
+      edges {
+        node {
+          id
+          name
+        }
+      }
+    }
+  }
+`;
+
+<marko-web-query-website-sections|{ nodes }|
+  include-ids=input.parentId
+  query-fragment=queryFragment
+>
+  $ const edges = getAsArray(nodes[0], "children.edges");
+  <${input.renderBody} nodes=edges.map(edge => edge.node) />
+</marko-web-query-website-sections>

package/components/query-child-sections.marko.js

@@ -0,0 +1,60 @@
+// Compiled using marko@4.20.2 - DO NOT EDIT
+"use strict";
+
+var marko_template = module.exports = require("marko/dist/html").t(__filename),
+    marko_componentType = "/@mindful-web/marko-web-search$1.0.0/components/query-child-sections.marko",
+    marko_component = require("./query-child-sections.marko"),
+    marko_renderer = require("marko/dist/runtime/components/renderer"),
+    module_gql = require("graphql-tag"),
+    gql = module_gql.default || module_gql,
+    module_objectPath_module = require("@mindful-web/object-path"),
+    objectPath_module = module_objectPath_module.default || module_objectPath_module,
+    getAsArray = module_objectPath_module.getAsArray,
+    marko_dynamicTag = require("marko/dist/runtime/helpers/dynamic-tag"),
+    marko_web_query_website_sections_template = require("@mindful-web/marko-core/components/queries/website-sections.marko"),
+    marko_loadTag = require("marko/dist/runtime/helpers/load-tag"),
+    marko_web_query_website_sections_tag = marko_loadTag(marko_web_query_website_sections_template);
+
+function render(input, out, __component, component, state) {
+  var data = input;
+
+  const queryFragment = gql`
+  fragment MarkoWebSearchChildSectionsFragment on WebsiteSection {
+    id
+    children(input: { pagination: { limit: 100 }, sort: { field: name, order: asc } }) {
+      edges {
+        node {
+          id
+          name
+        }
+      }
+    }
+  }
+`;
+
+  marko_web_query_website_sections_tag({
+      includeIds: input.parentId,
+      queryFragment: queryFragment,
+      renderBody: function(out, { nodes }) {
+        const edges = getAsArray(nodes[0], "children.edges");
+
+        marko_dynamicTag(out, input.renderBody, function() {
+          return {
+              nodes: edges.map(edge => edge.node)
+            };
+        }, null, null, null, __component, "1");
+      }
+    }, out, __component, "0");
+}
+
+marko_template._ = marko_renderer(render, {
+    e_: marko_componentType
+  }, marko_component);
+
+marko_template.meta = {
+    id: "/@mindful-web/marko-web-search$1.0.0/components/query-child-sections.marko",
+    component: "./query-child-sections.marko",
+    tags: [
+      "@mindful-web/marko-core/components/queries/website-sections.marko"
+    ]
+  };

package/components/query.marko

@@ -0,0 +1,30 @@
+import loader from "../loaders/search";
+
+$ const {
+  apollo: apolloMindfulWebCMS,
+  $baseBrowse: apolloBaseBrowse,
+  config,
+  site
+} = out.global;
+$ const { assignedToWebsiteSectionIds } = input;
+
+$ const params = {
+  limit: input.limit,
+  skip: input.skip,
+  searchQuery: input.searchQuery,
+  sortField: input.sortField,
+  sortOrder: input.sortOrder,
+  contentTypes: input.contentTypes,
+  countryCodes: input.countryCodes,
+  ...(assignedToWebsiteSectionIds && assignedToWebsiteSectionIds.length
+    ? { assignedToWebsiteSectionIds }
+    : { assignedToWebsiteSiteIds: [config.website("id")] }
+  ),
+  queryFragment: input.queryFragment,
+  opSuffix: input.opSuffix,
+  searchType: site.get('search.type'),
+};
+
+<marko-web-resolve|{ resolved }| promise=loader({ apolloMindfulWebCMS, apolloBaseBrowse }, params)>
+  <${input.renderBody} ...resolved />
+</marko-web-resolve>

package/components/query.marko.js

@@ -0,0 +1,67 @@
+// Compiled using marko@4.20.2 - DO NOT EDIT
+"use strict";
+
+var marko_template = module.exports = require("marko/dist/html").t(__filename),
+    marko_componentType = "/@mindful-web/marko-web-search$1.0.0/components/query.marko",
+    marko_component = require("./query.marko"),
+    marko_renderer = require("marko/dist/runtime/components/renderer"),
+    module_loader = require("../loaders/search"),
+    loader = module_loader.default || module_loader,
+    marko_dynamicTag = require("marko/dist/runtime/helpers/dynamic-tag"),
+    marko_web_resolve_template = require("@mindful-web/marko-core/components/resolve.marko"),
+    marko_loadTag = require("marko/dist/runtime/helpers/load-tag"),
+    marko_web_resolve_tag = marko_loadTag(marko_web_resolve_template);
+
+function render(input, out, __component, component, state) {
+  var data = input;
+
+  const {
+  apollo: apolloMindfulWebCMS,
+  $baseBrowse: apolloBaseBrowse,
+  config,
+  site
+} = out.global;
+
+  const { assignedToWebsiteSectionIds } = input;
+
+  const params = {
+  limit: input.limit,
+  skip: input.skip,
+  searchQuery: input.searchQuery,
+  sortField: input.sortField,
+  sortOrder: input.sortOrder,
+  contentTypes: input.contentTypes,
+  countryCodes: input.countryCodes,
+  ...(assignedToWebsiteSectionIds && assignedToWebsiteSectionIds.length
+    ? { assignedToWebsiteSectionIds }
+    : { assignedToWebsiteSiteIds: [config.website("id")] }
+  ),
+  queryFragment: input.queryFragment,
+  opSuffix: input.opSuffix,
+  searchType: site.get('search.type'),
+};
+
+  marko_web_resolve_tag({
+      promise: loader({
+          apolloMindfulWebCMS: apolloMindfulWebCMS,
+          apolloBaseBrowse: apolloBaseBrowse
+        }, params),
+      renderBody: function(out, { resolved }) {
+        marko_dynamicTag(out, input.renderBody, function() {
+          return resolved;
+        }, null, null, null, __component, "1");
+      }
+    }, out, __component, "0");
+}
+
+marko_template._ = marko_renderer(render, {
+    e_: marko_componentType
+  }, marko_component);
+
+marko_template.meta = {
+    id: "/@mindful-web/marko-web-search$1.0.0/components/query.marko",
+    component: "./query.marko",
+    tags: [
+      "@mindful-web/marko-core/components/resolve.marko"
+    ]
+  };

package/components/sort-by/index.marko

@@ -0,0 +1,25 @@
+import { get, getAsArray, getAsObject } from "@mindful-web/object-path";
+import { dasherize } from "@mindful-web/inflector";
+import { isFunction } from '@mindful-web/utils';
+
+$ const { $markoWebSearch: search, i18n } = out.global;
+
+$ const blockName = "marko-web-search-sort-by";
+$ const options = isFunction(i18n) ? [
+  { id: 'PUBLISHED', label: `${i18n("Sort")}: ${i18n("Published")}` },
+  { id: 'SCORE', label: `${i18n("Sort")}: ${i18n("Relevancy")}` },
+] : [
+  { id: 'PUBLISHED', label: "Sort: Published" },
+  { id: 'SCORE', label: "Sort: Relevancy" },
+];
+
+<marko-web-block name=blockName modifiers=input.modifiers>
+  $ const { searchQuery, sortField } = search.input;
+  $ const selectedId = sortField;
+  <if(searchQuery)>
+    <marko-web-browser-component
+      name="MarkoWebSearchSortSelect"
+      props={ options, selectedId }
+    />
+  </if>
+</marko-web-block>

package/components/sort-by/index.marko.js

@@ -0,0 +1,72 @@
+// Compiled using marko@4.20.2 - DO NOT EDIT
+"use strict";
+
+var marko_template = module.exports = require("marko/dist/html").t(__filename),
+    marko_componentType = "/@mindful-web/marko-web-search$1.0.0/components/sort-by/index.marko",
+    marko_renderer = require("marko/dist/runtime/components/renderer"),
+    module_objectPath_module = require("@mindful-web/object-path"),
+    objectPath_module = module_objectPath_module.default || module_objectPath_module,
+    get = module_objectPath_module.get,
+    getAsArray = module_objectPath_module.getAsArray,
+    getAsObject = module_objectPath_module.getAsObject,
+    module_inflector_module = require("@mindful-web/inflector"),
+    inflector_module = module_inflector_module.default || module_inflector_module,
+    dasherize = module_inflector_module.dasherize,
+    module_utils_module = require("@mindful-web/utils"),
+    utils_module = module_utils_module.default || module_utils_module,
+    isFunction = module_utils_module.isFunction,
+    marko_web_browser_component_template = require("@mindful-web/marko-web/components/browser-component.marko"),
+    marko_loadTag = require("marko/dist/runtime/helpers/load-tag"),
+    marko_web_browser_component_tag = marko_loadTag(marko_web_browser_component_template),
+    marko_web_block_template = require("@mindful-web/marko-web/components/element/block.marko"),
+    marko_web_block_tag = marko_loadTag(marko_web_block_template);
+
+function render(input, out, __component, component, state) {
+  var data = input;
+
+  const { $markoWebSearch: search, i18n } = out.global;
+
+  const blockName = "marko-web-search-sort-by";
+
+  const options = isFunction(i18n) ? [
+  { id: 'PUBLISHED', label: `${i18n("Sort")}: ${i18n("Published")}` },
+  { id: 'SCORE', label: `${i18n("Sort")}: ${i18n("Relevancy")}` },
+] : [
+  { id: 'PUBLISHED', label: "Sort: Published" },
+  { id: 'SCORE', label: "Sort: Relevancy" },
+];
+
+  marko_web_block_tag({
+      name: blockName,
+      tag: "div",
+      modifiers: input.modifiers,
+      renderBody: function(out) {
+        const { searchQuery, sortField } = search.input;
+
+        const selectedId = sortField;
+
+        if (searchQuery) {
+          marko_web_browser_component_tag({
+              name: "MarkoWebSearchSortSelect",
+              props: {
+                  options: options,
+                  selectedId: selectedId
+                }
+            }, out, __component, "1");
+        }
+      }
+    }, out, __component, "0");
+}
+
+marko_template._ = marko_renderer(render, {
+    d_: true,
+    e_: marko_componentType
+  });
+
+marko_template.meta = {
+    id: "/@mindful-web/marko-web-search$1.0.0/components/sort-by/index.marko",
+    tags: [
+      "@mindful-web/marko-web/components/browser-component.marko",
+      "@mindful-web/marko-web/components/element/block.marko"
+    ]
+  };

package/components/sort-by/marko.json

@@ -0,0 +1,5 @@
+{
+  "<marko-web-search-sort-by>": {
+    "template": "./index.marko"
+  }
+}

package/config/index.js

@@ -0,0 +1,84 @@
+const Joi = require('@parameter1/joi');
+const { validate } = require('@parameter1/joi/utils');
+const { getDefaultContentTypes } = require('@mindful-web/utils');
+const { titleize, underscore } = require('@mindful-web/inflector');
+const MarkoWebSearchQueryParamConfig = require('./query-params');
+
+const defaultContentTypes = getDefaultContentTypes();
+
+class MarkoWebSearchConfig {
+  /**
+   *
+   * @param {object} params
+   *
+   * @param {object} [params.resultsPerPage=10] The results per page setting.
+   * @param {number} [params.resultsPerPage.min=1]
+   * @param {number} [params.resultsPerPage.max=100]
+   * @param {number} [params.resultsPerPage.default=20]
+   *
+   * @param {string[]} [params.contentTypes] The allowed content type filters. Defaults to all.
+   *                                         Should be provided as an array of classified content
+   *                                         type strings, e.g. ['Article', 'MediaGallery'] etc.
+   *
+   * @param {object[]} [params.assignedToWebsiteSectionIds] The allowed website section filters.
+   *                                                      Defaults to none. Should be an array of
+   *                                                      section IDs, e.g. [123, 321]
+   *
+   * @param {string} [params.rootAlias] The root alias for the search page defaults to 'search'
+   */
+  constructor(params = {}) {
+    const {
+      resultsPerPage,
+      contentTypes,
+      assignedToWebsiteSectionIds,
+      defaultSortField,
+      rootAlias,
+    } = validate(Joi.object({
+      resultsPerPage: Joi.object({
+        min: Joi.number().integer().default(1),
+        max: Joi.number().integer().default(100),
+        default: Joi.number().integer().default(20),
+      }).default(),
+
+      contentTypes: Joi.array().items(Joi.alternatives().try(
+        Joi.string().trim().allow(...defaultContentTypes),
+        Joi.object({
+          type: Joi.string().trim().allow(...defaultContentTypes),
+          label: Joi.string().trim(),
+        }),
+      )).default(defaultContentTypes),
+
+      assignedToWebsiteSectionIds: Joi.array().items(
+        Joi.number().integer().min(1).required(),
+      ).default([]),
+
+      defaultSortField: Joi.string().allow('NAME', 'PUBLISHED', 'SCORE').default('PUBLISHED'),
+
+      rootAlias: Joi.string().default('search'),
+    }).default(), params);
+
+    this.contentTypeObjects = contentTypes.sort().map((type) => (type.label ? ({
+      id: underscore(type.type).toUpperCase(),
+      label: type.label,
+    }) : ({
+      id: underscore(type).toUpperCase(),
+      label: titleize(type),
+    })));
+
+    this.contentTypeObjectMap = this.contentTypeObjects.reduce((map, type) => {
+      map.set(type.id, type);
+      return map;
+    }, new Map());
+
+    this.assignedToWebsiteSectionIds = assignedToWebsiteSectionIds;
+
+    this.queryParams = new MarkoWebSearchQueryParamConfig({
+      resultsPerPage,
+      contentTypeIds: this.contentTypeObjects.map(({ id }) => id),
+      defaultSortField,
+    });
+    this.rootAlias = rootAlias;
+  }
+}
+
+module.exports = MarkoWebSearchConfig;