npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

strapi-deepsearch-service

v0.5.0

Published

Strapi service for deep search using bookshelf (search by components)

Downloads

795

Readme

Strapi - Deep search service (bookshelf only)

Utilities for Strapi Headless CMS that allow searching across nested structures including components.

⏳ Installation

(Use yarn to install this plugin within your Strapi project (recommended). Install yarn with these docs.)

yarn add strapi-deepsearch-service

Enjoy 🎉

🖐 Requirements

Complete installation requirements are exact same as for Strapi itself and can be found in the documentation under Installation Requirements.

Supported Strapi versions:

  • Strapi v3.3.3 (recently tested)
  • Strapi v3.x

(This plugin may work with the older Strapi versions, but these are not tested nor officially supported at this time.)

We recommend always using the latest version of Strapi to start your new projects.

Features

  • Nested structure support Now you can search by a component or even their children (components, related content types)
  • Query by the components: When component is searchable _q parameter will apply also to all component attributes
  • Using builtin filters wit components now such suffixes like _contains, _eq etc could be used together with components attributes

Component model configuration

Component by default is not searchable. To enable Component to be included in search or be able to filter by, you've to add option searchable to true in a configuration json file (*.settings.json):

For example for component called paragraph_component You need to change components/text/paragraph_component.json by modifying option object:

{
  "collectionName": "components_text_paragraph_components",
  "info": {
    "name": "paragraph_component",
    "icon": "align-justify"
  },
  "options": {
    +"searchable": true
  },
  "attributes": {
    "body": {
      "type": "text"
    }
  }
}

Public API

find

    const entities = await find(model, ctx.query);

request examples: /restaurant?paragraph_component.body_contains=foo /restaurant?paragraph_component.body_contains=foo&paragraph_component.body_contains=bar

count

    const count = await count(model, ctx.query);

request examples: /restaurant/count?paragraph_component.body_contains=bar

search

    const entities = await search(model, ctx.query);

request examples (will search by all searchable components): /restaurant?_q=foo /restaurant?_q=foo&paragraph_component.title_contains=foo

searchCount

    const count = await countSearch(model, ctx.query);

request examples (will search by all searchable components): /restaurant?_q=foo /restaurant?_q=foo&paragraph_component.title_contains=foo

Examples

deep search for single model example resturant controller

generic deep search deep search controller

Contributing

Feel free to fork and make a Pull Request to this plugin project. All the input is warmly welcome!

Community support

For general help using Strapi, please refer to the official Strapi documentation. For additional help, you can use one of these channels to ask a question:

  • Email us We are always glad to help.
  • Slack We're present on official Strapi slack workspace.
  • GitHub (Bug reports, Contributions, Questions and Discussions)

License

MIT License Copyright (c) 2020 VirtusLab Sp. z o.o. & Strapi Solutions.