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

@arc-core-components/content-source_content-api-v4

v4.0.1

Published

Provides a common content source for the Content API portion of the Arc suite.

Downloads

1,242

Readme

Content Source: Content API v4 endpoint

This the Arc Core Component representing a content source that hooks into the Content API portion of the Arc Suite.

The most important part is the pattern, which defines the endpoint that PageBuilder Fusion uses to look up content.

This Core Component takes advantage of PageBuilder Fusion's ability to use CONTENT_BASE to define the credentials for a Content API, ensuring that no private secrets are exposed.

Pattern:

/content/v4/?website={arc-site}&website_url=${website_url}

Parameters:

This content source takes one parameter: a website URL, typically the path to the story following the domain name.

Getting started

This Core Component must be used within a Fusion project.

  1. Add this schema as a dependency of the repo. npm install @arc-core-components/content-source_content-api-v4
  2. Create a file of your desired content source name within the /content/sources folder. For this content source, the suggested name is content-api-v4.js
  3. This is the name you should use when referencing this content source in any content config within a custom field.
  4. Paste the following into content-api-v4.js:
import source from "@arc-core-components/content-source_content-api-v4";

export default source;

What does this content source return?

This will return an ANS document representing a single story from a Content API.

Overwriting the default website

The default export of the content source is set up for multisite deployments where a _website url parameter is necessary when visiting a specific page. Example: http://localhost/pf/sample-page/?_website=the-gazette. To override this behavior for a single site build we provide a factory function for creating an otherwise unchanged content source with a user provided website.

import { createContentSource } from "@arc-core-components/content-source_content-api-v4";
export default createContentSource("washingtonpost");

Adding resizer URLs to images

This module also exports a helper function addResizedUrls that can be called within the transform function to automatically add resizer URLs to all images in the content source:

import source, { addResizedUrls } from '@arc-core-components/content-source_content-api-v4';
import { resizerSecret, resizerUrl } from 'fusion:environment';

const transform = (data) => {
  return addResizedUrls(data, { resizerUrl, resizerSecret, presets: {
    small: { width: 50, height: 50 },
    large: {width: 480 }
  }});
};

export default {
  ...source,
  transform,
};

Then you can use the sizePreset prop in the image core component and it will be automatically resized:

<Image sizePreset="large" {...additionalProps} />

Here's an example for multisite, where each site could have its own resizer endpoint. This is helpful for clients that have publications in different continents - you can set up a resizer endpoint in each site's properties.

// properties/sites/my-site.json
{
    resizerUrl: "my-resizer-endpoint.com",
    resizerSecretKeyEnvVar: "RESIZER_SECRET_EU"
}

// content/sources/content-api-v4.js
import source, { addResizedUrls } from '@arc-core-components/content-source_content-api-v4';
import envVars from 'fusion:environment';
import getProperties from 'fusion:properties';

const transform = (data) => {
  const { website } = data;
  const { resizerSecretKeyEnvVar, resizerUrl } = getProperties(website);
  const resizerSecret = envVars[resizerSecretKeyEnvVar];
  return addResizedUrls(data, { resizerUrl, resizerSecret, presets: {
    small: { width: 50, height: 50 },
    large: {width: 480 }
  }});
  /*
  * Alternately you can give addResizedUrls a callback
  * return addResizedUrls(data, function ({ url, width, height, focalPoint }) {
  *  return { customSize: thumbor.setImagePath(url, resize(480, 0).buildUrl() }
  * });
  *
  */
};

export default {
  ...source,
  transform,
};

See also:

Testing & Linting

We are using Jest and XO for testing and linting.

We are using Husky to run a pre-push hook, preventing un-linted or code that fails tests from making it into the repo.

To test: npm test

To lint: npm run lint - This will also fix any simple linter errors automatically.

To push without testing or linting: git push --no-verify - This can often be helpful if you just need to push a branch for demonstration purposes or for help.