Scrydon

Packs & SDK d'authoring

Un SDK, un cycle de vie — créez des Intégrations, Ontologies, Workflows, Flux de processus et Sources de données, et livrez-les sous forme de bundles prêts à téléverser

@scrydon/sdk-authoring est le SDK unique pour la création d'extensions de plateforme. Il dispose de cinq surfaces de sous-chemin — une par artefact que vous pouvez livrer :

Pack vs Intégration

Il existe deux types de bundles de niveau supérieur que vous téléversez dans Scrydon. Choisissez en fonction de ce que vous modélisez :

  • Intégration — un bundle de capacités fournisseur. ESM compilé + manifeste + SBOM, s'exécute en sandbox dans la plateforme. Utilisez-le pour connecter Scrydon à un service externe (Slack, OpenAI, Twilio) et exposer des capacités — LLM, STT, TTS, embeddings, OCR, vidéo, webhooks, blocs et outils. Créé avec defineVendor, buildé avec bunx @scrydon/sdk-authoring integrations build.
  • Pack — un bundle de contenu de domaine. Regroupe une Ontologie (types d'objets typés, types de liens, types d'actions), zéro ou plusieurs Workflows (portes HITL, routes d'approbation, automatisations), un Flux de processus (stages, tâches, personas, modèles d'actions), zéro ou plusieurs Sources de données (sources de poll déclaratives — requête REST, DSL de correspondance de champs, liste de colonnes typées), et zéro ou plusieurs intégrations personnalisées dans une archive prête à téléverser. Un tableau contents[] de pack peut mélanger les types ontology, workflow, process-flow, data-source et integration. Utilisez-le pour livrer un modèle de domaine avec son playbook standard, ses flux de données et toute intégration fournisseur personnalisée dont il dépend. Créé avec defineScrydonPack, buildé avec bunx @scrydon/sdk-authoring pack build.

En résumé : Les Intégrations apportent des capacités dans la plateforme ; les Packs apportent du contenu de domaine — et peuvent inclure des intégrations personnalisées. Les deux se téléversent via Paramètres → Plateforme → Bundles.

Installation

bun add -d @scrydon/sdk-authoring zod
npm install --save-dev @scrydon/sdk-authoring zod

Confirmez que l'installation s'est correctement résolue :

bunx @scrydon/sdk-authoring --version

Fonctionnement de l'authoring

Chaque artefact utilise la même structure :

Composez votre artefact avec les helpers define*(). Ce sont des fonctions d'identité à l'exécution — leur rôle est de restreindre les types afin que votre IDE détecte les erreurs avant le build.

Un schéma Zod de manifeste (ManifestSchema, OntologyManifestSchema, ProcessFlowManifestSchema) valide l'artefact lors du build et à nouveau sur le serveur lors du téléversement.

Exécutez la CLI correspondante pour produire un .tar.gz prêt à téléverser. Les bundles d'intégration contiennent de l'ESM compilé + un SBOM CycloneDX ; les bundles d'ontologie et de flux de processus sont du JSON pur.

Téléversez via Paramètres → Plateforme → Bundles (ou l'API d'administration correspondante). La plateforme valide le manifeste, persiste le bundle et l'enregistre dans le catalogue. Aucun redéploiement requis.

CLI

@scrydon/sdk-authoring livre un seul binaire avec deux sous-commandes. Invoquez-le via la forme qualifiée par le package — cela fonctionne que le package soit installé localement ou non :

Sous-commandeAuteursCommandes
@scrydon/sdk-authoring integrationsBundles d'intégration fournisseurinit, build, test
@scrydon/sdk-authoring packBundles Scrydon Pack (flux de processus + ontologie)build, inspect, validate

Les packs d'ontologie sont livrés comme sous-répertoire du bundle Scrydon Pack. Les bundles d'ontologie autonomes utilisent le même SDK defineOntology sans CLI nécessaire (ils sont intégrés dans des bundles de pack ou livrés via npm).

bunx @scrydon/sdk-authoring --version
bunx @scrydon/sdk-authoring --help
bunx @scrydon/sdk-authoring integrations --help
bunx @scrydon/sdk-authoring pack --help

bunx @scrydon/sdk-authoring integrations build --entry src/index.ts

# pack build accepte un répertoire — il découvre automatiquement pack.ts | pack.mjs | pack.js | pack.json,
# et prend par défaut `--ontology` / `--process-flow` dans ./ontology et ./process-flow à l'intérieur.
bunx @scrydon/sdk-authoring pack build .
bunx @scrydon/sdk-authoring pack build ./my-pack

# Ou passez un manifeste explicite + remplacez les sous-répertoires :
bunx @scrydon/sdk-authoring pack build pack.json --ontology ./ontology --process-flow ./process-flow

Formats de bundle

ArtefactArchiveCode ?Validé par
Intégration<vendorId>-<version>.bundle.tar.gzESM compilé + manifeste + SBOMManifestSchema (Zod), inspecteur CycloneDX, garde de dépendances natives
Scrydon Pack<package.id>-<package.version>.scrydon-pack.tar.gz (ontologie + zéro ou plusieurs sous-répertoires workflow + flux de processus + zéro ou plusieurs sous-répertoires data-source)Aucun — JSON purPackBundleManifestSchema, ProcessFlowManifestSchema, OntologyManifestSchema, WorkflowManifestSchema, DataSourceManifestSchema, validateur de cycle de DAG

Les bundles d'intégration s'exécutent en sandbox dans un Worker Thread avec une liste de blocage de modules Node ; les flux de processus et les packs d'ontologie sont des données pures et n'exécutent jamais le code fourni par l'appelant.

Créer votre premier Pack

La façon la plus rapide d'apprendre la surface est de livrer un Pack de bout en bout. Chaque étape renvoie au guide complet par artefact :

Définissez les types d'objets, types de liens, types d'actions et règles d'identité. → Authoring : Ontologies

Portes HITL, routes d'approbation, automatisations que les actions du flux invoqueront par slug. → Authoring : Workflows

Stages, modèles de tâches, personas, modèles d'actions, déclencheurs vocaux. → Authoring : Flux de processus

Sources de poll déclaratives : spécification de requête REST, DSL de correspondance de champs, colonnes typées. → Authoring : Sources de données

Déclarez des domaines, marquages et politiques de promotion de KB org via l'extension du manifeste de pack. → Authoring : KB org

bunx @scrydon/sdk-authoring pack build ./my-pack

Produit <package.id>-<package.version>.scrydon-pack.tar.gz — JSON pur, validé par les schémas de manifeste et le validateur de cycle de DAG.

Paramètres → Plateforme → Bundles (ou l'API d'administration). Une installation atomique : ontologie, workflows, flux de processus, sources de données.

Pour aller plus loin

Sur cette page

Sur cette page