https://github.com/luismeyer/node-mtmr

Node wrapper for MTMR
https://github.com/luismeyer/node-mtmr

mtmr node typescript

Last synced: 22 days ago
JSON representation

Node wrapper for MTMR

• Host: GitHub
• URL: https://github.com/luismeyer/node-mtmr
• Owner: luismeyer
• Created: 2021-04-09T12:17:25.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-03T12:13:08.000Z (almost 2 years ago)
• Last Synced: 2024-10-04T18:41:24.890Z (about 1 month ago)
• Topics: mtmr, node, typescript
• Language: TypeScript
• Homepage:
• Size: 429 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Node MTMR

This is a Node library which wraps around [MTMR](https://github.com/Toxblh/MTMR). It is highly recommended to use this library with typescript. The main features are:

1. TS/JS support for button handlers

2. Typescript typings for the items

For further documentation have a look at the original [repo](https://github.com/Toxblh/MTMR).

## Installation

Here you find the [NPM Page](https://www.npmjs.com/package/node-mtmr).

```bash

npm i node-mtmr

```

Or

```bash

yarn add node-mtmr

```

## Setup

A working example can be found [here](./example).

### Initialize parse

Create an index file inside your "src" directory. In this file call the "createParse" function:

```js

import { createParse } from "node-mtmr";

const parse = createParse({

  outDir: "./my-mtmr-config",

  loggingEnabled: true,

});

```

1. "outDir" is the output path for the script and assets. It's either relative to the cwd or absolute

2. "loggingEnabled" configures the logging output

### Execute parse

Pass the items to the parse function. The result is a correct MTMR item array.

```js

const result = await parse(items);

```

### Save result

There is a utility function for saving the output into the MTMR directory. Pass an options object with the force set to true to overwrite an existing file.

```js

import { saveItems } from "node-mtmr";

saveItems(result, { force: true });

```

### Utilities

If you want to create a ScriptTitledButton with a jsSource you can use either the `createSourceScriptSync` or the `createSourceScript` function. These will handle your script result and hand them to MTMR.

```ts

createSourceScriptSync(() => {

  const buttonLabel = "Label";

  const imageIdentifier = "inactive";

  return {

    label: buttonLabel,

    imgKey: imageIdentifier,

  };

});

```

or async

```ts

createSourceScript(async () => {

  const label = await func();

  return label;

});

```

or pass the result to the `sourceOutput` util function

```ts

sourceOutput({

  label: "Label",

  imgKey: "key",

});

```

If you your button needs a state make use of the state functions. Internally the data is stored in your computers ''/tmp/'' folder (so it might be deleted at some point):

```ts

const stateId = "counter";

const count = stateValue(stateId, 0);

const setCount = stateFunction(stateId);

const [count, setCount] = state(stateId);

```

## JavaScriptTitledButton

This is the new item type which supports JavaScript.

```ts

{

  type: "scriptTitledButton",

  sourceType: "javaScript",

  jsSource: {

    inline: () => {

      // Your function logic

    },

  },

  actions: [

    {

      action: "javaScript",

      trigger: "singleTap",

      actionJavaScript: {

        filePath: "./path/to/js/file.js",

      },

    },

  ],

}

```