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

@windingtree/glider-types

v5.0.0

Published

Typescript types of Glider projects

Downloads

88

Readme

glider-types

Typescript types, JSON schemas and swagger configuration files of Glider projects: Derbysoft Proxy, ...

Getting started

yarn add @windingtree/glider-types

Swagger configuration files

const fs = require('fs');
const path = require('path');

// Importing the swagger doc
const doc = fs.readFileSync(
  path.resolve('node_modules', '@windingtree/glider-types/dist/derbysoft_proxy.yaml'),
  'utf8'
);

JSON schemas

import { derbysoft_proxy } from '@windingtree/glider-types';

// derbysoft_proxy.definitions.Price
// ...
// ...

Typescript types

import type { Price } from '@windingtree/glider-types/dist/derbysoft_proxy';

Swagger schema definitions management

All schema definitions are collected in the commonly shared file located at ./src/shared-definitions.yaml.

Project-specific swagger configuration files are located in the named files like ./src/derbysoft-proxy.yaml.

Project-specific swagger configuration files should not contain any data type definitions. Instead of that, all links to the definitions must be organized using schema references like $ref: "#components/schemas/DefinitionKey".

During the module build, all definitions that have been referred to will be built in the final swagger file of every specific project.

Definitions rules

Every definition must follow these mandatory rules:

  • Must have unique CamelCase styled key
  • Must have description
  • Must have definition of properties types
  • Must have definition of required properties
  • Must have an example of usage

If it is required, a definition can have format validation rules in regular expressions format or native rules supported by swagger.

Supported projects

  • The accommodations API
  • Simard Pay API
  • Win-backend API

To add new project:

  • Add project configuration to the ./scripts/build.js to the supportedApis constant at line 11 in format:
{
  name: 'project-name', // Unique project name
  path: 'src/project-name.yaml' // Base project swagger file
}
  • Create a swagger file by the pointed path

Contribution

Please check the CONTRIBUTING.md