Smartshell SDK - Современное, полностью типизированное, динамически генерирующееся,
постоянно актуальное SDK для взаимодействия с публичным API ERP системы управления компьютерными клубами SmartShell

🔗 Содержание

• Быстрый старт
• Статус проекта
• Разработчикам
• Лицензия
• GraphQL: Syntax Highlighting for VS Code

💾 Быстрый старт

Установите пакет smartshell-sdk с помощью вашего пакетного менеджера. Для хранения пакета используется JSR - реестр пакетов доступный во всех пакетных менеджерах экосистемы JS и TS

# PNPM
pnpm dlx jsr add @xlsoftware/smartshell-sdk

# Deno
deno add jsr:@xlsoftware/smartshell-sdk

# NPM
npx jsr add @xlsoftware/smartshell-sdk

# Bun
bunx jsr add @xlsoftware/smartshell-sdk

# Yarn
yarn dlx jsr add @xlsoftware/smartshell-sdk

Импортируйте пакет в свой проект

import { Shell } from "@xlsoftware/smartshell-sdk";
// ..or with jsr deno import
import { Shell } from "jsr:@xlsoftware/smartshell-sdk";

Создайте инстанс класса Shell. Можно указать данные для авторизации, изменить хост (scope) api, или сделать инстанс анонимным для запроса публичной информации без нужды в авторизации

// Shell instance
const shell = await new Shell({
    credentials: { login: '79998887766', password: 'password123' }
})

// Anonymous instance
const shell = await new Shell({
    anonymous: true
})

// Client-sided login
const client = await new Shell({
    host: 'mobile-auth'
    credentials: { login: '79998887766', password: 'password123' }
})

🎉 Отлично! При инициализации нового инстанса автоматически происходит авторизация и все доступные вам операции можно вызывать через SDK без дополнительной настройки!

🟢 Статус проекта

Проект находится в beta стадии, хоть и можно считать последние релизы стабильными, нужно будет проверять на ошибки в некоторых edge кейсах. Подробная документация с примерами в процессе разработки. Генерация запросов к API полностью функционирует и создает валидные модули. Особенности работы бека SmartShell нужно проверять. Надеемся команда SmartShell заинтересуется проектом и не останется в стороне). Связь с разработчиком: https://t.me/xlsoftware

💻 Разработчикам

Для обновления API SDK используйте следующую команду

deno task update

Она автоматически сгенерирует новые модули, обновит старые, обновит типизацию под новую схему, создаст референсы и документацию для каждого модуля или типа и обновит индексацию модулей. После исполнения скрипта апи полностью готово к использованию.

📜 Лицензия

MIT

SmartShell SDK - свободный проект с открытым исходным кодом и не имеет отношения к SmartShell. Торговая марка "SmartShell" принадлежит ООО "Смарт Шелл", ОГРН: 1217800044330, ИНН: 7801696720