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

storyblok-solr-indexer

v1.1.0

Published

Storyblok Solr Indexer

Downloads

25

Readme

Storyblok Solr Indexer

Indexer to index Storyblok stories in Solr.

Usage

Install package

npm install storyblok-solr-indexer

Example Usage

indexer.js

mport 'dotenv/config';
import StoryblokSolrIndexer from './StoryblokSolrIndexer.mjs';

// Destructure required environment variables for better readability and performance.
const {
	STORYBLOK_ACCESS_TOKEN,
	SOLR_HOST,
	SOLR_PORT,
	SOLR_PATH,
	SOLR_USER,
	SOLR_PASS,
	SOLR_CORE,
	TEST_DATA
} = process.env;

if (!STORYBLOK_ACCESS_TOKEN || !SOLR_HOST || !SOLR_PORT || !SOLR_PATH || !SOLR_USER || !SOLR_PASS || !SOLR_CORE || !TEST_DATA) {
	throw new Error('One or more environment variables are missing or invalid');
}

// Configure storyblock options with access token and query parameters.
const storyblockOptions = {
		accessToken: STORYBLOK_ACCESS_TOKEN,
		options: {
				starts_with: '',
				'filter_query[component][in]': 'Page',
				per_page: 100,
				page: 1,
				version: 'published'
		}
};

// Configure Solr connection options using environment variables.
const solrOptions = {
		host: SOLR_HOST,
		port: SOLR_PORT,
		path: SOLR_PATH,
		user: SOLR_USER,
		pass: SOLR_PASS,
		core: SOLR_CORE,
};

// Parse the test data provided via environment variable.
const data = JSON.parse(TEST_DATA);

// Create an instance of StoryblokSolrIndexer and pass the configured options.
const indexer = new StoryblokSolrIndexer(storyblockOptions, solrOptions);

indexer.indexStoriesBasedOnAction(data)

The data object passed through the indexer can contain a property action and story_id.

{
	"action": "published", // 'unpublished', 'moved', 'deleted'
	"story_id": 473816430
}

If no action is passed the Solr index is cleared and fully new indexed.

Run in Terminal

node indexer.js

NPM Package

https://www.npmjs.com/package/storyblok-solr-indexer

Cloudflare

You can find a cloudflare worker using the indexer here:

https://github.com/dkd/cloudflare-worker-storyblok-solr-indexer

Hosted Solr

You can host your Solr core here:

https://hosted-solr.com/de/