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

@kelmscott/caster

v0.1.6

Published

Utility library for transforming JSON data.

Downloads

4

Readme

@kelmscott/caster

Kelmscott Caster is a utility library for transforming and reshaping JSON data.

It comprises a cast function (the default export) and a number of pre-built utility transformation functions that are commonly required when re-shaping JSON data.

For complete documentation, see Kelmscott.digital.

About

APIs are generally multi-purpose data feeds; they will typically be agnostic with respect to the final use of the data being served. This is the case regardless of whether data is accessed via REST, GraphQL, etc. As a result, the data requested from an API usually requires reshaping to conform to the requirements of the end-user or front-end application.

This is the problem Caster is designed to solve.

For the purposes of content-driven, statically-generated sites, most, if not all of this overhead can be implemented at build time. For dynamic (React) apps this may need to be implemented client-side, within components or as a request side-effect.

Either way, Caster is agnostic and can be used client or server side.

Principles

Caster is built on the principle of code over configuration.
There is zero-configuration required, and no DSL to learn.

Installation

Caster requires some additional libraries to be installed with it.

$ npm i ramda ramda-adunct traverse @kelmscott/caster

Usage

import caster from '@kelmscott/caster'

Transformations

At its core Caster offers a single cast function that accepts an array of transformations and a source object to which they are applied. It returns a mutated (copy) of the original source object.

import cast from '@kelmscott/caster'

const transformers = [
  {
    someField: when(isNonEmptyArray, head),
  },
  ...
]

const dataObject = {
  someField: [
    { id: 0 }
  ]
}

const result = cast(transformers, dataObject)

// result ...
// {
//   someField: { id: 0}
// }

The cast function is curried, so it can be preconfigured with transformations and the source object applied later. For instance:

const result = compose(
  ...
  cast(transformers)
)(source)

A transformation can be a function or a plain javascript object. The array of transformations may contain any combination of functions and objects. Caster processes each in order, from first to last.

Transformer Functions

A function must accept a source object (JSON) and return an object (JSON). It is recommended that transformer functions do not mutate the source object, although this is up to you.

export const transformerFn = (source) => {
  const transformedObject = {}

  // transform object here ...

  return transformedObject
}

Transformer Specs

If a transformation is described using an object, this is passed to Ramda's evolve function.

export const transformerSpec = {
  someField: when(isNonEmptyArray, head),
  anotherField: upper,
  anArrayField: map(filter(someFilterFn)),
  anObjectField: {
    someOtherField: compose(last, split('_')),
  }
}

Example

The following basic example demonstrates how Caster can be used within the context of a statically generated page, using Next.js.

Set up a Transformer for an API request

// my-api-transformer.js

import cast from '@kelmscott/caster'

const transformers = [
  myTransformFunction,
  {
    someField: when(isNonEmptyArray, head),
  },
  ...
]

export default cast(transformers)

And consume it:

import myApiTransformer from './my-api-transformer'

...

export const getStaticProps = async ({ params }) => {
  const { data } = await fetch(MY_API_QUERY, {
    id: params.id,
  })

  return {
    props: {
      data: myApiTransformer(data),
    },
  }
}

Prior Art

  • https://github.com/APIs-guru/graphql-lodash
  • https://www.fourkitchens.com/blog/development/graphql-leveler-controlling-shape-query/
  • https://labs.getninjas.com.br/pain-points-of-graphql-7e83ba5ddef7#db9d
  • https://github.com/bazaarvoice/jolt#Demo