# magic-point-sdk

> Software Developer Kit of Magic Point project build on Javascript/NodeJS

Latest version **0.0.12** (published 2024-01-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install magic-point-sdk
pnpm add magic-point-sdk
yarn add magic-point-sdk
bun add magic-point-sdk
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.12 |
| Published | 2024-01-23 |
| First published | 2023-11-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 12 |
| Unpacked size | 10.8 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Genki System Corp |
| Maintainers | huan-lt |
| Keywords | Magic-Dot, Magic-Point, UI-Testing, Testing, Front-end-Testing |

## Links

- npm: https://www.npmjs.com/package/magic-point-sdk
- Repository: https://github.com/genkisystem/magic-point-sdk
- Homepage: https://github.com/genkisystem/magic-point-sdk#readme
- Issues: https://github.com/genkisystem/magic-point-sdk/issues
- npm.io page: https://npm.io/package/magic-point-sdk

## Dependencies (12)

- [quill](https://npm.io/package/quill.md) ^1.3.7
- [i18next](https://npm.io/package/i18next.md) ^23.7.13
- [figma-api](https://npm.io/package/figma-api.md) ^1.11.0
- [resemblejs](https://npm.io/package/resemblejs.md) ^5.0.0
- [typescript](https://npm.io/package/typescript.md) ^5.2.2
- [html2canvas](https://npm.io/package/html2canvas.md) ^1.4.1
- [toastify-js](https://npm.io/package/toastify-js.md) ^1.12.0
- [browserify-fs](https://npm.io/package/browserify-fs.md) ^1.0.0
- [html-to-image](https://npm.io/package/html-to-image.md) ^1.11.11
- [tui-image-editor](https://npm.io/package/tui-image-editor.md) ^3.15.3
- [rollup-plugin-alias](https://npm.io/package/rollup-plugin-alias.md) ^2.2.0
- [img-comparison-slider](https://npm.io/package/img-comparison-slider.md) ^8.0.6

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 0.0.12 (latest) — 2024-01-23
- 0.0.11 — 2024-01-19
- 0.0.10 — 2024-01-18
- 0.0.9 — 2024-01-18
- 0.0.8 — 2024-01-17
- 0.0.7 — 2024-01-17
- 0.0.6 — 2024-01-17
- 0.0.5 — 2024-01-17
- 0.0.4 — 2024-01-17
- 0.0.3 — 2024-01-15
- 0.0.2 — 2024-01-15
- 0.0.1 — 2023-11-06
- 0.0.0 — 2023-11-06

## README

# Magic Point Software Developer Kit

Integrate the `magic-point-sdk` into your project to utilize its features across your entire application. This guide covers installation and setup for various JavaScript frameworks using TypeScript.

##### * Just need to initialize, everything is setted up by Magic Point.

## Installation

Install the `magic-point-sdk` using npm, run the following command:

```bash
npm install magic-point-sdk
```

## Usage
To use `magic-point-sdk` add following lines of code into your entry file (index.js/ts, main.js/ts, ...)
```javascript
/// your imports
import MagicPoint from 'magic-point-sdk'

/// your code
new MagicPoint({apiKey: 'your-api-key-here'}) //Replaced `'your-api-key-here'` with your actual API key from Magic Point Management.
```

# Code Example
```javascript
import MagicPoint from './magic-point-sdk'
new MagicPoint({apiKey: 'generate-on-management-page',
                lng: "en",
                breakpoints: {
                    aKeyName: 120,
                    anotherKeyName: 576,
                    ...,
                    andSoOn: 1200
                }})
```

## Options
| <b>key</b>  | <b>type</b> | <b>default</b>                                   | <b>values</b> | <b>note</b>                                             |
| ----------- | ----------- | ------------------------------------------------ | ------------- | ------------------------------------------------------- |
| apiKey      | string      | ''                                               |               | Generate on Management Page                             |
| lng         | string      | "en"                                             | "en", "ja"    |                                                         |
| breakpoints | object:     | {sm: 576, md: 768, lg: 992, xl: 1200, xxl: 1400} | {key: number} | Key name and value (number) is up to you, no restricted |

---
_Source: https://npm.io/package/magic-point-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._