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

imgmanifest

v3.2.1

Published

Library for working with Triton/SDC/SmartOS image manifests

Downloads

7

Readme

node-imgmanifest

This repository is part of the Joyent Triton project. See the contribution guidelines and general documentation at the main Triton project page.

node-imgmanifest is a node.js lib for working with SmartOS image manifests.

The SmartOS/SDC Image world involves a number of pieces:

  1. The imgadm tool in SmartOS for installing and managing images for VM creation.
  2. The IMGAPI server in SmartDataCenter instances.
  3. The Joyent Images API, https://images.joyent.com.
  4. Possibly 3rd-party IMGAPI instances.
  5. *-imgadm tools for managing the above API servers.

Most or all of these require being able to upgrade and validate image manifests. This is the library for it.

Usage

var imgmanifest = require('imgmanifest');

// The latest Image manifest format version, i.e. the 'v' field
// in a manifest.
console.log(imgmanifest.V);

// Upgrade a manifest to the latest manifest format version.
var manifest = imgmanifest.upgradeManifest(manifest);

// Validate a manifest, according to the "minimal" requirements.
// "Minimal" requirements are those that, e.g., 'imgadm install'
// requires and that 'imgadm create' creates. It does require
// the manifest to include fields that are added by an IMGAPI
// repository. Returns null if the manifest is valid.
var errs = imgmanifest.validateMinimalManifest(manifest);

Note: Current implementation of manifest validation here is incomplete.

Validation Errors

The errs returned by a validate*Manifest function is an array of objects, e.g.:

[
    {
        "field": "name",
        "code": "MissingParameter",
    },
    {
        "field": "os",
        "code": "Invalid",
        "message": "invalid os, \"my-os\", must be one of: smartos, linux, windows, other"
    }
]

Each error object will always include "field" and "code" keys and may include a "message" string field. Current error "code" values are:

||MissingParameter||A required parameter was not provided.|| ||Invalid||The formatting of the field is invalid.||

Note: This error format is based on https://mo.joyent.com/docs/eng/master/#error-handling.