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

@saleor/json-schema-compiler

v0.2.0

Published

Usage:

Downloads

653

Readme

@saleor/json-schema-compiler

Usage:

pnpm saleor-schema-compiler compile ./src/schemas

With external definitions.json file:

pnpm saleor-schema-compiler compile ./src/schemas --definitions ./src/schemas/definitions.json

Description

It's a CLI tool that takes a directory and recursively transforms all JSON schemas it found into two files: .d.mts and .mjs. The first one contains types and the second one is a JS standalone validator:

Example

Input

TransactionCancelationRequestedResponse.schema.json
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "type": "object",
  "properties": {
    "pspReference": { "type": "string" },
    "result": {
      "$ref": "definitions.json#/definitions/TransactionCancelationRequestedAllowedResult"
    },
    "amount": { "$ref": "definitions.json#/definitions/PositiveDecimal" },
    "time": { "$ref": "definitions.json#/definitions/DateTime" },
    "externalUrl": { "type": "string" },
    "message": { "type": "string" }
  },
  "additionalProperties": false,
  "required": ["pspReference"]
}
definitions.json
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "definitions.json",
  "definitions": {
    "PositiveDecimal": { "type": "number", "minimum": 0 },
    "DateTime": { "type": "string", "format": "date-time" },
    "TransactionCancelationRequestedAllowedResult": {
      "anyOf": [
        { "type": "string", "const": "CANCEL_SUCCESS" },
        { "type": "string", "const": "CANCEL_FAILURE" }
      ]
    }
  }
}
Command:
pnpm saleor-schema-compiler compile ./src/schemas --definitions ./src/schemas/definitions.json

Output

TransactionCancelationRequestedResponse.d.mts:
import type { ValidateFunction } from "ajv";
import type { JSONObject } from '../../types';
/* eslint-disable */
/**
 * This file was automatically generated by json-schema-to-typescript.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
 * and run json-schema-to-typescript to regenerate this file.
 */

export interface TransactionCancelationRequestedResponse {
  pspReference: string;
  result?: "CANCEL_SUCCESS" | "CANCEL_FAILURE";
  amount?: number;
  time?: string;
  externalUrl?: string;
  message?: string;
}

declare const ValidateTransactionCancelationRequestedResponse: ValidateFunction<TransactionCancelationRequestedResponse>;
export default ValidateTransactionCancelationRequestedResponse;
TransactionCancelationRequestedResponse.mjs

Contains a standalone validator function. Exports default function that a ValidateFunction from Ajv library.

Usage

Generated code can be used as follows:

// As a type:
import { type TransactionCancelationRequestedResponse } from "./src/schemas/TransactionCancelationRequested/TransactionCancelationRequestedResponse.mjs";

// As a validator:
import ValidateTransactionCancelationRequestedResponse from "./src/schemas/TransactionCancelationRequested/TransactionCancelationRequestedResponse.mjs";

const data: unknown = { /* … */ };
const isDataValid = ValidateTransactionCancelationRequestedResponse(data); // true | false

if (isDataValid) {
  data // data has proper type here! TransactionCancelationRequestedResponse
}