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

typesafe-json-scrubber

v1.1.0

Published

Define scrubbers of data of unreliable formats to ensure at run-time that the scrubbed data matches the specified schema/contract and type definitions. Your scrubbers are also typechecked against your typescript types at design-time so that your scrubber

Downloads

28

Readme

Type-safety scrubber for json data

Define scrubbers of data of unreliable formats to ensure at run-time that the scrubbed data matches the specified schema/contract and type definitions. Your scrubbers are also typechecked against your typescript types at design-time so that your scrubbers don't fall out of sync with the types they are meant to guarantee. As always, tsc --strict is recommended.

As with most typesafety benefits, it really requires interaction to understand, but here's an example anyway.

Let's say you need to read in this type at runtime from storage. You want to rely on the members being there in your application code and not have to do runtime assertions throughout, but the data might be of an older format or from an unreliable source such that missing runtime assertions would cause havok on your algorithms. Here's your expectation encoded into typescript interfaces:

interface SimpleDocument1 {
    stringMember: string
    stringOrNullMember: string | null
    stringOrNullOrUndefinedMember1: string | null | undefined
    stringOrNullOrUndefinedMember2?: string | null
    stringOrNullOrUndefinedMember3?: string | null | undefined

    stringArrayMember: string[] | null
    stringArrayArrayMember: string[][]

    booleanMember: boolean
    objectMember: SubType1
}

interface SubType1 {
    stringMember: string
    numberMember: number
}

Here's the data you'll read in (using JSON.parse, etc.):

const conformingSimpleDocument1a = {
    stringMember: 'one',
    stringOrNullMember: 'two',
    stringOrNullOrUndefinedMember1: 'three',
    stringOrNullOrUndefinedMember2: 'four',
    stringOrNullOrUndefinedMember3: 'five',

    stringArrayMember: ['x', 'y', 'z'],
    stringArrayArrayMember: [['xx', 'yy', 'zz'], ['aa', 'bb', 'cc']],

    booleanMember : true,

    objectMember : {
        stringMember: 'objectString',
        numberMember: 100
    }
};

Here is the runtime scrubber:

import { schema, ObjectScrubber, UndefinedType, StringType,
    BooleanType, NumberType, NullType, ArrayOfType, Union,
    StringOrNullOrUndefinedType, ObjectType } from 'typesafe-json-scrubber'

const simpleDocument1Scrubber = schema<SimpleDocument1>('simpleDocument1Scrubber')
    .must('stringMember', StringType)
    .must('stringOrNullMember', Union(StringType, NullType))
    .must('stringOrNullOrUndefinedMember1', Union(StringType, NullType, UndefinedType))
    .must('stringOrNullOrUndefinedMember2', StringOrNullOrUndefinedType)
    .must('stringOrNullOrUndefinedMember3', StringOrNullOrUndefinedType)
    .must('stringArrayMember', Union(ArrayOfType(StringType), NullType))
    .must('stringArrayArrayMember', ArrayOfType(ArrayOfType(StringType)))
    .must('booleanMember', BooleanType)
    .must('objectMember', ObjectType((schema : ObjectScrubber<SubType1>) => schema
        .must('stringMember', StringType)
        .must('numberMember', NumberType)));

... and a use of the scubber, printing out the results of the attempt:

const { scrubbed, scrubLog } = simpleDocument1Scrubber.scrub(conformingSimpleDocument1a);

if (scrubLog.filter(l => l.level === 'Fatal').length) {
    console.log('Unsuccessful because: ');
    console.log(scrubLog.map(l => `[${l.level}] at ${l.path}: ${l.detail}`));
} else {
    if (scrubLog.length) {
        console.log('Succeeded with warnings: ');
        console.log(scrubLog.map(l => `[${l.level}] at ${l.path}: ${l.detail}`));
        console.log(JSON.stringify(scrubbed));
    } else {
        console.log('Succeeded: ');
        console.log(JSON.stringify(scrubbed));
    }

    // Where the scrubber's output is to the application type finally (design-time)
    // the typescript checker will complain about misalignment between what the scrubber is built to scrub
    // and the type you're outputting to!  This is very very cool but you can only really experience it's
    // awesomeness for youself interactively.
    const clean : SimpleDocument1 = scrubbed;

    // That said, I haven't put enough miles on this code yet to be very confident that the typechecker can have
    // enough information in all scenarios.
}

There's also .may() and .should() for ObjectType construction but I haven't tested it or given examples.

Here's a ~realworld example of a scrubber that it built up from other scrubber definitions. The way the types work here enforce that the field names do in fact exist in the type they are scrubbing for (protection from expecting too much) AND that the built-up scrubber outputs only those fields which have been scrubbed for - so when you try to assign your scrubbed data to an identifier of the type you expect (protecting you from expecting too little).

export const secKey = ObjectType((schema: ObjectScrubber<SecKey>) => schema
    .must('curve', StringType)
    .must('pub', StringType)
    .must('sec', StringType)
    .must('issuedDateUtc', NumberType));

export const pubKey = ObjectType((schema: ObjectScrubber<PubKey>) => schema
    .must('curve', StringType)
    .must('pub', StringType)
    .must('issuedDateUtc', NumberType));

export const privateChannelToken = ObjectType((schema: ObjectScrubber<PrivateChannelToken>) => schema
    .must('channel', StringType)
    .must('issuedDateUtc', NumberType)
    .must('ttl', NumberType)
    .must('signingKey', pubKey)
    .must('exchangingKey', pubKey)
    .must('signature', StringType));

export const PrivateChannelTokenScrubber = new privateChannelToken('');

This whole library is alpha stage use-at-your-own-risk for now ... so try it out.