@manychat/flow-preview-service

Service for creating flow preview screenshots

Stats

StarsIssuesVersionUpdatedCreatedSize
@manychat/flow-preview-service
0.2.185 months ago4 years agoMinified + gzip package size for @manychat/flow-preview-service in KB

Readme

flow-preview-service

Service for creating flow preview screenshots

Installation

Node 8 required

npm install @manychat/flow-preview-service -g

Install npm packages globally without sudo on Linux

Update to latest

npm update @manychat/flow-preview-service -g

Run

flow-preview-service --player-url https://manychat.com/flowPlayerPage?screenshot_mode=1 --debug

Options

-V, --version       output the version number
--max <n>           maximum number of workers
--min <n>           minimum number of workers
--port <n>          listening port
--max-uses <n>      maximum number of times a worker can be reused
--player-url [url]  flow player page URL, default value [https://dev.manychat.com/flowPlayerPage?screenshot_mode=1]
--debug             enable debug logging
-h, --help          output usage information
--acquire-timeout-millis <n>    max milliseconds an acquire call will wait for a resource before timing out

API

stats

GET /

make preview

POST /process
Content-Type: application/json
Payload: { 
    data: <SharedFlowData>,
    thumbnail: <bool>,
}

success response

Status: 200
{
    "success": true,
    "worker": {
        "name": "worker_4",
        "useCount": 1
    },
    "result": {
        "type": "image/png",
        "base64": "data:image/png;base64,iVBORw0KGgoAAAA.."
    }
}

error response

Status: 500
{
    "success": false,
    "worker": {
        "name": "worker_4",
        "useCount": 1
    },
    "messages": [
        {type: "console", msg: [,…]},
        {type: "requestfailed", msg: [,…]},
        {type: "pageerror", msg: [,…]},
    ],
    "error": "Something went wrong"
}


Status: 400
{
    "success": false,
    "error": "body.data is required"
}

client

html interface http://localhost:8844/client/

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.