Lifecycle

Creation

When you create a minion:

1. A UUID v4 id is generated
2. createdAt and updatedAt are set to the current time
3. Fields are validated against the MinionType schema
4. Default values from the schema are applied
5. status defaults to "active" if not specified

TypeScript

import { createMinion } from 'minions-sdk';

const { minion, validation } = createMinion({
  title: 'My Note',
  fields: { content: 'Hello world' },
}, noteType);

if (!validation.valid) {
  console.error(validation.errors);
}

Python

from minions import create_minion
from minions.schemas import note_type

minion, validation = create_minion(
    {"title": "My Note", "fields": {"content": "Hello world"}},
    note_type,
)

if not validation.valid:
    print(validation.errors)

Update

Updates merge new field values with existing ones. updatedAt is refreshed.

TypeScript

import { updateMinion } from 'minions-sdk';

const { minion: updated } = updateMinion(existing, {
  fields: { content: 'Updated content' },
}, noteType);

Python

from minions import update_minion

updated, validation = update_minion(
    existing,
    {"fields": {"content": "Updated content"}},
    note_type,
)

Soft Delete

Soft delete marks a minion as deleted without removing it. Relations are preserved.

TypeScript

import { softDelete } from 'minions-sdk';

const deleted = softDelete(minion, 'user-123');
// deleted.deletedAt is set
// deleted.deletedBy is 'user-123'

Python

from minions import soft_delete

deleted = soft_delete(minion, "user-123")
# deleted.deleted_at is set
# deleted.deleted_by is "user-123"

Restore

Restoring clears the deletion markers.

TypeScript

import { restoreMinion } from 'minions-sdk';

const restored = restoreMinion(deleted);
// restored.deletedAt is null

Python

from minions import restore_minion

restored = restore_minion(deleted)
# restored.deleted_at is None

Hard Delete

Hard delete permanently removes the minion. All relations involving it must also be removed.

TypeScript

import { hardDelete } from 'minions-sdk';

hardDelete(minion, graph);        // clean up relations
myMinionStore.delete(minion.id);  // then remove from your storage

Python

from minions import hard_delete

hard_delete(minion, graph)           # clean up relations
my_minion_store.delete(minion.id)    # then remove from your storage