BotCity Maestro SDK - JavaScript

Overview

BotCity Maestro SDK - Javascript

« Explore Framework docs


Summary

🤖 Computer-vision based UI Automation

Recognize and interact with UI elements using state-of-art computer vision module.

Operate any UI interface independent of the technology or platform (desktop, web, terminal).

🚀 Getting Started

📦 Prerequisites

  • Node 16+

💫 Installing

Install by Npm:

npm i @botcity/botcity-maestro-sdk

Install a local:

npm install

📚 Documentation

Documentation is available at https://documentation.botcity.dev/maestro/maestro-sdk/

💻 Developers Portal

Developers Portal

💬 Forum

Forum

🌎 BotCity Automation Platform

BotCity is a platform to develop, deploy, manage and maintain automations. Automations can be developed in Python or Java using open-source libraries that are market standard.

1️⃣ All in One Platform

Develop, deploy, manage and scale your Automation Ops using All in One platform that provides task queue, runtime environment management, reports, alerts, logs and much more.

BotCity Maestro

2️⃣ Deploy with a Single Line

Use BotCity command-line interface (CLI) to deploy your bot into a runtime environment with a single line:

BotCity CLI

3️⃣ Manage your Task Queue

BotCity Maestro Task Queue

4️⃣ Manage your Runtime Environments

BotCity Maestro Machines

5️⃣ Create Alerts and Reports from the Automation Execution

BotCity Maestro Alerts

6️⃣ Create Google Data Studio Dashboards

BotCity Maestro Dashboards

7️⃣ Create your Community Account

We have a community account for hobbyists and students. Just signup and start automating.

Sign Up

🤝 Contributing to BotCity Framework

Support

🐛 Bug reports and 💎 Feature requests

If you spot a problem, please let us know by following the template in here: Report a bug.

Ideas or suggestions for enhancements are more than welcome. Please use the following template in here: Request feature.

📢 Contact us

If you have questions or comments in general about the framework, we want to know.

You can choose between the channels the one that best fit you:

or you can file a bug and let us know where our documentation could be improved.

Comments
  • Add methods send to module Credentials

    Add methods send to module Credentials

    With the release of the new version of <aestro, calls to enter and capture platform credentials are available. You will need to implement the following methods:

    • getCredential
    • create credential
    • getCredentials
    • createCredentials
    • updateCredential
    • getValueCredential
    • deleteCredential
    enhancement 
    opened by kayqueGovetri 1
  • Create package Types in NPM

    Create package Types in NPM

    To develop in Typescript it is necessary for the project to create a package in NPM called Types, for developers who use the language to be able to visualize the types of parameters, returns and so on.

    Acceptance criteria

    • Package Types in Npm.
    • Being able to recognize what the function returns directly in the IDE.
    enhancement 
    opened by kayqueGovetri 1
  • Add methods send to module Error

    Add methods send to module Error

    With the release of the Maestro version supporting the Error feature, it will be necessary to create functions that communicate with this module:

    • createError
    • createAttachment
    • createScreenshot

    It is necessary to send the following parameters:

    • taskId
    • type (error type)
    • message(error)
    • stackTrace
    • language (javascript/typescript)
    • tags
    enhancement 
    opened by kayqueGovetri 0
  • feat: Implement interfaces in class Sdk and methods.

    feat: Implement interfaces in class Sdk and methods.

    issue #1

    This PR was opened to make the developer's life easier and to integrate the sdk with the most modern IDEs with the return types of the Sdk class methods.

    Added some TODOs in the code that will be performed after the inclusion of fixes in the Maestro API.

    enhancement 
    opened by kayqueGovetri 0
  • CI: add action in pull request to run lint

    CI: add action in pull request to run lint

    issue #2

    This PR was opened to meet the need to have a pipeline that executes lint in the project in open pull requests, thus ensuring the quality and standardization of the code.

    In addition to helping in the future implementation of test execution by making the standardized pipeline.

    enhancement 
    opened by kayqueGovetri 0
  • Add action in pull request

    Add action in pull request

    In each pull request opening it is necessary to run "lint" to guarantee the code quality. If there is something wrong/out of standard, the pull request is blocked until the adjustment is made.

    enhancement 
    opened by hhslepicka 0
  • Implement interfaces

    Implement interfaces

    It is necessary to implement interface in the project to use typescript in the best possible way.

    For this it will be necessary to do a study on the return of the Maestro API and based on that create the necessary interfaces. Interesting content explaining in a simple way [how to create customizable types with typescript.

    (https://www.typescriptlang.org/docs/handbook/interfaces.htmlt)

    Acceptance criteria

    • Being able to recognize what the function returns directly in the IDE.
    enhancement 
    opened by hhslepicka 0
  • Add unit tests

    Add unit tests

    For the project to maintain its quality standard, it is necessary that all classes/methods/functions have some referring unit test.

    This serves to predict behavior and ensure pre- and post-delivery functionality of the feature in question.

    We will use the Jest library to create the tests.

    Acceptance criteria

    • Have a test coverage of more than 86%.
    • All tested functions must have their success and error test.
    • Each test has an execution timeout of 50ms.
    • Tests with duplication of logic will not be accepted.
    • The test name must be understandable
    opened by hhslepicka 0
  • Add specialized classes in each controller

    Add specialized classes in each controller

    To be able to create effective unit tests to improve code quality, it is necessary to separate the responsibilities contained in the BotMaestroSdk class into classes.

    Following the controllers available on swagger

    Acceptance criteria

    • Have a class specialized in user.
    • Have a class specialized in tasks/automations.
    • Have a class specialized in logs.
    • Have a class specialized in alerts.
    • Have a class specializing in artifacts.
    • In the BotMaestroSdk class it is necessary that the methods remain the same.
    opened by hhslepicka 0
  • Add jsdoc in project

    Add jsdoc in project

    To make it easier for the user to use it is interesting to implement jsdoc so that there is a concise reading of what the function/class/method executes, receives and returns interactively with the IDE.

    To learn more about jsdoc on Typescript

    Acceptance criteria

    • Be able to read the description of the methods through the IDE.
    opened by hhslepicka 0
Releases(v1.1.0)
  • v1.1.0(Jan 6, 2023)

    Feature

    • feat: Add credentials methods by @kayqueGovetri in https://github.com/botcity-dev/botcity-maestro-sdk-js/pull/18
    • feat: Add method to create error in Maestro by @kayqueGovetri in https://github.com/botcity-dev/botcity-maestro-sdk-js/pull/17

    Full Changelog: https://github.com/botcity-dev/botcity-maestro-sdk-js/compare/v1.0.0...v1.1.0

    Source code(tar.gz)
    Source code(zip)
  • v1.0.0(Oct 20, 2022)

  • v0.2.2(Oct 10, 2022)

    What's Changed

    • CI: add action in pull request to run lint by @kayqueGovetri in https://github.com/botcity-dev/botcity-maestro-sdk-js/pull/3
    • feat: Implement interfaces in class Sdk and methods. by @kayqueGovetri in https://github.com/botcity-dev/botcity-maestro-sdk-js/pull/4
    • feat: Set automatic finished in finish task by @kayqueGovetri in https://github.com/botcity-dev/botcity-maestro-sdk-js/pull/8
    • feat: Create class to Column by @kayqueGovetri in https://github.com/botcity-dev/botcity-maestro-sdk-js/pull/7

    New Contributors

    • @kayqueGovetri made their first contribution in https://github.com/botcity-dev/botcity-maestro-sdk-js/pull/3

    Full Changelog: https://github.com/botcity-dev/botcity-maestro-sdk-js/compare/v0.2.1...v0.2.2

    Source code(tar.gz)
    Source code(zip)
  • v0.2.1(Sep 6, 2022)

  • v0.1.4(Sep 5, 2022)

Owner
BotCity - Automation for Developers
Eliminate boundaries for automation and RPA projects.
BotCity - Automation for Developers
Movehat is a TypeScript SDK for Move on Sui built on top of Sui's TypeScript SDK and our fork of Ian Macalinao's `move-ts`.

Movehat Movehat is a TypeScript SDK for Move on Sui built on top of Sui's TypeScript SDK and our fork of Ian Macalinao's move-ts. Movehat aspires to b

Pentagon 10 Sep 30, 2022
microCMS JavaScript SDK.

microCMS JavaScript SDK It helps you to use microCMS from JavaScript and Node.js applications. Getting Started Install Install npm package. $ npm inst

Wanta Inc 107 Dec 31, 2022
Anagolay Network Javascript SDK written in Typescript

Anagolay Network Javascript SDK written in Typescript. This repo will contain the bindings to Anagolay Network with the sane defaults for pallet usage

Anagolay Network 4 Nov 26, 2022
Codemod scripts to update AWS SDK for JavaScript APIs.

aws-sdk-js-codemod This repository contains a collection of codemod scripts for use with JSCodeshift that help update AWS SDK for JavaScript APIs. The

Amazon Web Services - Labs 17 Jan 2, 2023
It's a javascript Class which contains utility methods that simplify working with google maps web SDK

About GoogleMapsJSHelper It's a javascript Class which contains utility methods that simplify working with google maps web SDK Note: i used ES7 Class

Sami Alateya 6 Jul 23, 2022
A JavaScript (and TypeScript) SDK for the ScreenshotOne.com API to take screenshots of any URL

jssdk An official Screenshot API client for JavaScript and TypeScript. It takes minutes to start taking screenshots. Just sign up to get access and se

ScreenshotOne.com 7 Oct 15, 2022
The official Directus SDK for use in JavaScript!

Directus JS SDK Installation npm install @directus/sdk Basic Usage import { Directus } from '@directus/sdk'; const directus = new Directus('http://d

Directus 36 Dec 29, 2022
Unofficial port of the Sentry SDK for JavaScript to Deno.

Sentry_deno This is an unofficial port of the Sentry SDK (@sentry/browser) to Deno. import * as Sentry from "https://deno.land/x/sentry_deno/main.ts";

Geert-Jan Zwiers 11 Aug 11, 2022
Temporal-time-utils - This is a library with some reusable functions for Temporal.io TypeScript SDK

temporal-time-utils This is a library with some reusable functions for Temporal.io TypeScript SDK: sleepUntil: sleep to a specific date, instead of by

swyx 15 Oct 18, 2022
Lazerpay SDK allows you accept payments easily in your react application

Lazerpay Official react sdk Lazerpay SDK allows you accept payments easily in your react application Installation npm install lazerpay-react Usage imp

LazerPay 18 Nov 20, 2022
Firebase SDK 9 + Google Sign In + Chrome Extension Manifest Version 3 + Webpack

Firebase SDK 9 + Google Sign In + Chrome Extension Manifest Version 3 + Webpack Demo Find this Chrome Extension Setup and working demo here or on Yout

Rasika Warade 40 Dec 28, 2022
js-sdk for multichain storage service

js-mcs-sdk Table of Contents Introduction Prerequisites MCS API Usage Installation Getting Started Documentation Contributing Introduction A client li

FilSwan 3 Aug 5, 2022
The NodeJS server SDK for Charon.

Charon - NodeJS Server SDK This is the NodeJS server SDK for Charon: A new form of secure, passwordless authentication. The SDK currently serves as a

null 2 Apr 8, 2022
NodeJS(TypeScript) SDK For V2EX

NodeJS(TypeScript) SDK For V2EX

chyroc 4 Mar 2, 2022
This SDK helps developers get started with the on-chain tools provided by Metaplex.

Metaplex JavaScript SDK ⛔️ DO NOT USE IN PRODUCTION, THIS SDK IS IN VERY EARLY ALPHA STAGES! This SDK helps developers get started with the on-chain t

Metaplex Foundation 263 Dec 27, 2022
TypeSafe MongoDB Atlas Data API SDK for Deno & Deno Deploy

Atlas SDK atlas_sdk is a TypeSafe MongoDB Atlas Data API SDK for Deno & Deno Deploy Links Docs Import Replace LATEST_VERSION with current latest versi

Erfan Safari 20 Dec 26, 2022
Autoinspector SDK for nodejs.

Autoinspector Node.js SDK The Autoinspector Node library provides convenient access to the Autoinspector API from applications written in server-side

Autoinspector 2 Jan 27, 2022
Textme.lk SMS SDK and Sample Apps

TextME Javascript SDK Table of Content Introduction Prerequisite Install Getting Started APIs constructor sendSMS viewSMS viewAllSMS Models ClientConf

Iconicto 3 Jan 29, 2022
A production-ready ECPay AIO SDK for Node.js

node-ecpay-aio A production-ready 綠界全方位金流(ECPay All-In-One, AIO) SDK for Node.js with TypeScript Support Documentation 本模組詳細使用說明請見 User Guide Overview

simen 21 Nov 1, 2022