Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 5.17 KB

README.md

File metadata and controls

77 lines (54 loc) · 5.17 KB
Raw

fastify-cloudprnt

A fastify plugin to run a server that follows the Star Micronics CloudPRNT protocol.

Commit linting with Husky

The npm postinstall script has been removed as it fails on the GH action runner. If you would like lint-staged to run on each commit, run husky install manually.

Usage

import fastifyCloudPrnt from '@autotelic/fastify-cloudprnt'
import view from '@fastify/point-of-view'

export default async function basic (fastify, options) {
  // point-of-view must be registered and available before fastify-cloudprnt
  await fastify.register(view, viewConfig)

  await fastify.register(fastifyCloudPrnt, config)
}

Once the plugin is registered it exposes the CloudPRNT Protocol endpoints:

In addition it exposes:

  • POST /job to queue print jobs. Body:
{
  "token": <string>,
  "jobData": <object>
}

Returns 201 Created and echos the token back { "token": <string> }. The token should be a unique identifier for the print job - e.g. the order id if printing a receipt.

See API for config options.

See examples for working examples.

Template Rendering

Templates should be in Star Document Markup, and template rendering requires cputil to be in the path. The provided Dockerfile builds a container with the app and cputil in. Additionally, @fastify/view must be registered to fastify before fastify-cloudprnt.

Star Micronics provides a Star Document Markup Designer web app.

API

@autotelic/fastify-cloudprnt exports a fastify plugin. When registered the plugin expects a configuration object:

  • queueJob: (token, jobData) => any: method that takes a url-safe string token and an object of data jobData, to be passed to point-of-view for template rendering, and adds the job to the print queue.
  • getJob: (request) => token: method that returns the url-safe string token for the next available print job on the queue. request is the fastify request object.
  • getJobData: (token, request) => object: method that returns the data object for the job enqueued with the url-safe string token. request is the fastify request object.
  • deleteJob: (token, request) => any: method that deletes the job enqueued with the url-safe string token from the print queue. request is the fastify request object.
  • routePrefix: string: string which will configure a prefix for all cloudprnt routes.
  • defaultTemplate: string which will configure the default template to be joined with templatesDir and used by @fastify/point-of-view to render the template (default to receipt.stm). If jobData contains a template value, it will be used instead of the defaultTemplate.
  • templatesDir: string which will configure the directory to be joined with either the defaultTemplate or jobData.template and used by @fastify/point-of-view to render the template (default to an empty string).
  • routeOptions: object: object which will apply the configured fastify router options to all cloudprnt routes. Note: method, url, schema and handler cannot be configured through routeOptions.
  • formatPrntCommandData: (renderedReceipt) => : method that accepts the receipt rendered by @fastify/point-of-view and returns star PRNT Core command data. if configured, the formatPrntCommandData method will bypass the use of the cputil to encode receipt data in the star PRNT Core format.

Examples

Basic

An example fastify app using node-cache. To run the basic example, use the following command:

  npm run example:basic

Redis

An example fastify app using redis. To run the redis example, use the following command:

  npm run example:redis