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

Это руководство поможет вам за несколько минут настроить Kodzero SDK в вашем проекте.

Установка

Установите пакет с помощью npm:

npm install kodzero-front-sdk-alfa

Или с помощью yarn:

yarn add kodzero-front-sdk-alfa

Инициализация

Создайте экземпляр SDK, указав URL вашего бэкенда:

TypeScript

import Kodzero from 'kodzero-front-sdk-alfa'

const kodzero = new Kodzero({
  host: 'https://api.your-backend.com',
  authCollection: 'auth'
})

JavaScript (ES Modules)

import Kodzero from 'kodzero-front-sdk-alfa'

const kodzero = new Kodzero({
  host: 'https://api.your-backend.com',
  authCollection: 'auth'
})

JavaScript (CommonJS)

const Kodzero = require('kodzero-front-sdk-alfa').default

const kodzero = new Kodzero({
  host: 'https://api.your-backend.com',
  authCollection: 'auth'
})

Параметры инициализации

Параметр	Тип	Описание
host	string	URL вашего Kodzero бэкенда
authCollection	string	Название коллекции для аутентификации

Регистрация и авторизация

Регистрация нового пользователя

const result = await kodzero.auth.register({
  email: 'user@example.com',
  password: 'secure_password123',
  name: 'Иван Иванов' // дополнительные поля
})

console.log('Пользователь создан:', result.user)

Авторизация

const result = await kodzero.auth.login({
  email: 'user@example.com',
  password: 'secure_password123'
})

console.log('Добро пожаловать,', result.user.name)

Автоматическое управление токенами

После успешной авторизации SDK автоматически сохраняет токены и добавляет их к последующим запросам.

Работа с данными

Создание модели

// Определяем интерфейс (TypeScript)
interface Task {
  _id: string | null
  title: string
  completed: boolean
  createdAt?: Date
}

// Создаём модель
const Task = kodzero.createModel<Task>({
  collection: 'tasks'
})

CRUD-операции

// Создание записи
const task = new Task({
  title: 'Изучить Kodzero SDK',
  completed: false
})
await task.save()
console.log('Создана задача:', task.data()._id)

// Чтение записей
const tasks = await Task.findMany({
  page: 1,
  perPage: 10
})

// Обновление записи
task.set('completed', true)
await task.update()

// Удаление записи
await task.delete()

Полный пример

Вот полный пример простого приложения со списком задач:

import Kodzero from 'kodzero-front-sdk-alfa'

// 1. Инициализация
const kodzero = new Kodzero({
  host: 'https://api.your-backend.com',
  authCollection: 'auth'
})

// 2. Авторизация
await kodzero.auth.login({
  email: 'user@example.com',
  password: 'password123'
})

// 3. Создание модели
interface Task {
  _id: string | null
  title: string
  completed: boolean
}

const Task = kodzero.createModel<Task>({
  collection: 'tasks'
})

// 4. Добавление новой задачи
const newTask = new Task({
  _id: null,
  title: 'Моя первая задача',
  completed: false
})
await newTask.save()

// 5. Получение всех задач
const allTasks = await Task.findMany()
console.log('Все задачи:', allTasks)

// 6. Обновление задачи
newTask.set('completed', true)
await newTask.update()

// 7. Удаление задачи
await newTask.delete()

// 8. Выход из системы
await kodzero.auth.logout()

Следующие шаги

• Подробнее об аутентификации
• Работа с моделями
• Валидация данных
• Обработка ошибок