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

@frenchpastries/customer

v0.6.2

Published

Middleware to auto-register a service to a Bakery

Downloads

22

Readme

Bakery-client

To register on a @FrenchPastries/bakery.

Getting Started

Getting started with Bakery Client is simple and easy. It assumes you’re already using a French Pastries MilleFeuille.

# For Yarn users
yarn add  @frenchpastries/customer
# For NPM users
npm install --save @frenchpastries/customer

Interface to register

Service should send a json interface when registering:

{
  "name": "my-service",
  "version": "1.2.3",
  "state": "string",
  "address": "127.0.0.1:1234",
  "interface": {
    "type": "REST || GraphQL",
    "value": "REST routes or GraphQL Schema"
  }
}
const MilleFeuille = require('@frenchpastries/millefeuille')
const { get, ...Assemble } = require('@frenchpastries/assemble')
const client = require('@frenchpastries/customer')

const allRoutes = Assemble.routes([
  get('/', () => ({ statusCode: 200 })),
])

const bakeryMiddleware = client.register({
  hostname: process.env.REGISTRY_HOST,
  port: process.env.REGISTRY_PORT,
  serviceInfos: allRoutes.exportRoutes(),
})

MilleFeuille.create(
  bakeryMiddleware(allRoutes)
)

Calling an external service

Let’s imagine you have two services connected to your Bakery, like a payment service, and data management service. You’re building the data management service, but, dammit, you need to ask the payment service to verify the credit card number given by the user.
That’s fine, you planned all of this, and created the payment service using MilleFeuille and Assemble. Cool, moreover you registered the service using customer in both case. Perfect!

The API for the payment service is like this:

const allRoutes = Assemble.routes([
  get('/credit-card/:number/check', handler),
])

You can just do this:

const myHandler = async request => {
  const response = await request.services.Payment.creditCard().number('0000000000000000').check().get()
  // Do your stuff.
}

Under the hood, node-fetch is used, so you can expect to use the exact same API as fetch!