smartshell_sdk@0.3.1

Smartshell SDK - Source Development Kit for ERP management platform
for cyber sports arenas and computer clubs

SmartShell SDK Logo

🔗 Useful Links

💾 Installation

# Node
npx jsr add @xlsoftware/smartshell-sdk

// main.ts
import { Shell } from "@xlsoftware/smartshell-sdk";

# Deno
deno add @xlsoftware/smartshell-sdk

// main.ts
import { Shell } from "@xlsoftware/smartshell-sdk";
# OR
import { Shell } from "https://deno.land/x/smartshell_sdk/mod.ts"

📄 Quickstart

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

🟢 API coverage

Caution

The project started quite a long time ago is moving to a new code base and JSR registry. Due to the addition of new methods and the possibility of optimization the SDK project has received a second life and will continue to develop. Now in priority robust base and modularity

🎯 Todo

create single update script for types/types.ts, graphql/index.ts, api.ts (Test doc link before put in documentation) and methods in graphql folder
clientLogin switch in constructor instead of login
add entity on ShellSdkFormattedQuery and updater
add actual JSDoc in api.ts
add auto test generation
update module creation documentation
add github pages based documentation for modules [autogenerated]

📜 License

MIT