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

@api3/ois

v2.3.2

Published

> OIS (or Oracle Integration Specifications) is a JSON object that describes an API specification

Downloads

3,489

Readme

@api3/ois

OIS (or Oracle Integration Specifications) is a JSON object that describes an API specification

You can find the documentation for OIS in the docs.

Installation

To install this package run either:

yarn add @api3/ois

or if you use npm:

npm install @api3/ois --save

Gotchas

Use pinned version

We recommend using a pinned version of the OIS package because the validation included in the package enforces the OIS version up to the patch. Pinning the version also ensures your project uses the correct OIS version even if there are other packages depending on a different OIS version.

Make sure only one "zod" version is installed

Internally, we use zod to implement validation and TS typing for the OIS schema. It's possible to have TS issues when multiple different zod versions are used in a project.

Usage

The OIS package defines validation and TypeScript typings that can be used to verify correctness of a full OIS schema or just a part of it. For example:

const { oisSchema } = require('@api3/ois');

const possibleOis = {
  // Placeholder values. Refer to the Example section below and the documentation.
  oisFormat: '1.0.0',
  version: '1.2.3',
  title: 'coinlayer',
  apiSpecifications: { ... } // omitted for brevity
  endpoints: [ ... ], // omitted for brevity
};
const result = oisSchema.safeParse(possibleOis);
if (!result.success) {
  throw result.error
} else {
  const validOis = result.data
}

Example

An example of a valid OIS can be found here.

Developer documentation

Release

To release a new version follow these steps:

  1. git checkout main && git pull - ensure you are on a "main" branch with latest changes
  2. yarn version - choose "x.y.z" as the version to be released
  3. git show - verify the changes of the version commit
  4. yarn build - only build the package after the "yarn version" command so the bundled "package.json" uses the updated version
  5. yarn publish --access public
  6. git push --follow-tags - to push the commits to a "main" branch