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

@sophos-factory/api-client

v3.2.0

Published

Official Sophos Factory API client library for JavaScript.

Downloads

20

Readme

Sophos Factory API Client Library for JavaScript

This is the official Sophos Factory API client library for JavaScript.

This library is available as an npm package, @sophos-factory/api-client.

The library contains two (2) APi clients -- one for the Factory API and one for the Factory Auth API.

Installation

The Sophos Factory API Client Library can be installed in a node.js project using npm or the package manager of your choosing. For example:

npm install @sophos-factory/api-client --save

Usage

Prerequisites

A Factory API token is required to use the Factory API Client Library. An API Token is generated by logging into Sophos Factory and visiting the API Tokens page.

Factory API

The documentation for all methods can be viewed by browsing the Factory API.

For an example of list projects, see (examples/getProjectList.ts).

Factory Auth API

The documentation for all methods can be viewed by browsing the Factory Auth API.

For an example of listing organizations, see (examples/getOrganizationList.ts):

Generating the Library

The Factory API Client Library is generated from the following Sophos Factory APIs.

| API Name | Documentation | Specification | Schema File | | :--------------- | :---------------------------------- | :--------------------------------------- | :------------------------------- | | Factory API | https://api.factory.sophos.com/v1 | https://api.factory.sophos.com/v1/spec | spec/api.json | | Factory Auth API | https://auth.factory.sophos.com/v1 | https://auth.factory.sophos.com/v1/spec | spec/authApi.json |

This repository generates two OpenAPI clients for the above schemas using a GitHub Action workflow .github/workflows/gen.yml.

The GitHub Action workflow runs on a schedule and can also be dispatched manually. It compares the last updated schemas with the current schemas downloaded from the online specs. If there is any difference in the schemas, the workflow regenerates the client library, then opens a pull request with the changes.

Terms of Use

Please see Sophos Services Agreement and Sophos Privacy Notice.