DDS Plugin SDK

Installieren Sie das öffentliche DDS Plugin SDK 1.2 und nutzen Sie Workflows, Cache, Werkzeugstreams, LSP und stabile APIs.

Die folgenden Beispiele für Benutzerarbeitsbereiche beschreiben einen ausdrücklich verbundenen, vom Kunden kontrollierten Entwicklungshost. Wählen Sie WSL, einen Container oder Server als eigenständigen SDK-Host für diese Beispiele. Die reguläre Digital Design Studio Windows-App läuft nativ unter Windows. Der gewählte SDK-Host verwaltet Erkennung, Berechtigungen und Plugin-Fähigkeiten; verwaltete Cloud-Engine-Jobs verwenden ihren eigenen Ausführungspfad.

1. SDK installieren

DDS Plugin SDK 1.2.1 bietet JavaScript-APIs, TypeScript-Deklarationen, Sprachprovider, Themes, Arbeitsbereichswerkzeuge und Befehlsjobs. Optionale dauerhafte Speicher ergänzen Jobverläufe, ausdrückliche Wiederholungsversuche und geprüfte Text-/Binär-Snapshots, die das Löschen der Quelle und Prozessneustarts überstehen. Verwenden Sie Node.js 22 oder 24. Installieren Sie die stabile SDK-Version aus dem offiziellen GitHub-Release. Für ein eigenständiges Befehlsplugin verwenden Sie nach der Installation Entwicklungswerkzeuge:

1.0.0 veröffentlicht die stabile SDK-API, 18 Host-Konformitätsprofile, die Support-/Migrationsrichtlinie und gemessene Prüfungen kombinierter Arbeitslasten. Neue Plugins verwenden >=1.0.0 <2.0.0. Diese veröffentlichten Ergebnisse dokumentieren API-Konformität und funktionales Verhalten des eigenständigen SDK.

0.13.0 ergänzt sechs Entwicklungsvorlagen, generierte Typen und Schemas, deterministische Testszenarien und optionale lokale Diagnosen. Das gepackte SDK und generierte Projekte laufen außerhalb des Quellbaums; synthetische Wiedergabe und Loopback-Debugging werden ausdrücklich ausgewählt.

0.12.0 ergänzt typisierte Einstellungen mit begrenztem Geltungsbereich und ausdrückliche Migrationen, ausführungsgebundene Geheimnisreferenzen, strukturierte Befehlsein- und -ausgaben, Sprachkataloge und Metadaten zur Barrierefreiheit. Das öffentliche SDK und unabhängige Beispiele prüfen Einstellungskonflikte, ungültige Eingaben, entzogene Befugnisse und Übersetzungs-Fallbacks. Verwenden Sie diese Funktionen über eigenständige SDK-Host-APIs und unabhängige Beispiele.

0.11.0 ergänzt Signaturhilfe, verzögerte Vervollständigung, begrenzte Snippets, überprüfte dateiübergreifende Bearbeitungen und Umbenennungen, Formatierung/Codeaktionen, semantische Tokens, Faltung, Hinweise und hierarchische Symbole. Vorschläge, Prüfung, aktuelle Befugnisse und bedingte Anwendung bleiben getrennt; veraltete Dokumentergebnisse können weder angezeigt noch angewendet werden. Verwenden Sie diese öffentlichen SDK-Funktionen in einem eigenständigen Host und den unabhängigen Beispielen.

0.10.0 ergänzt Streaming-Downloads im Browser, Uploads ausgewählter Dateien, eine gemischte Übertragungswarteschlange und Worker-OPFS-Checkpoint-Wiederherstellung. Übertragungen prüfen aktuelle Befugnisse, Dateiidentität sowie Chunk-/Gesamthashes und unterscheiden dabei den Bytefortschritt von geprüftem Speicher. Führen Sie diese öffentlichen SDK-Beispiele mit einem ausdrücklich gewählten Host und Browser-Speicherziel aus.

0.9.0 ergänzt Projektbäume mit begrenztem Geltungsbereich, Dateinamen-/Textsuche und Änderungsbeobachtung für vom Betreiber ausgewählte lokale Verzeichnisse. Verwenden Sie sie vom HTTP-Client oder Projekthelfer aus und behalten Sie dabei Bearbeitungs-Snapshots und ungespeicherte Entwürfe. Die folgenden Projektbeispiele behandeln Erstellung, Suche, externe Änderungen und Konfliktbehandlung.

Bash
mkdir hello-dds-plugin
cd hello-dds-plugin
npm init -y
npm install --ignore-scripts --save-exact "https://github.com/Altifigence/dds-plugin-sdk/releases/download/v1.2.1/altifigence-dds-plugin-sdk-1.2.1.tgz"

Das erste Diagnosebeispiel verwendet vertrauenswürdigen Code in einem lokalen Testhost. Themes verwenden den bestehenden DDS-XML-Import. Bestehende Werkzeugintegrationen finden Sie unter Plugins und Werkzeuge von Drittanbietern.

2. Ihr erstes Plugin schreiben

Erstellen Sie plugin.mjs im neuen Projekt. Dieses Plugin prüft Klartextdokumente und meldet in jeder Zeile, die NOTE enthält, eine Informationsdiagnose.

plugin.mjs

import { createDiagnosticsResult, definePlugin } from '@altifigence/dds-plugin-sdk';

export default definePlugin({
  manifestVersion: 1,
  id: 'hello-diagnostics',
  name: 'Hello Diagnostics',
  publisher: 'example',
  version: '0.1.0',
  protocolVersion: 1,
  entry: './plugin.mjs',
  capabilities: ['diagnostics'],
  permissions: ['document.read', 'diagnostics.publish'],
  supportedHosts: ['test-host'],
  license: 'Apache-2.0',
}, context => context.registerDiagnosticsProvider({languages: ['plaintext']}, {
  provideDiagnostics(request, {signal}) {
    signal.throwIfAborted();
    const diagnostics = [];
    const lines = request.snapshot.text.split(/\r\n|\n|\r/);
    for (let line = 0; line < lines.length; line++) {
      const character = lines[line].indexOf('NOTE');
      if (character !== -1) diagnostics.push({
        range: {start: {line, character}, end: {line, character: character + 4}},
        severity: 'info',
        code: 'todo',
        source: 'hello-diagnostics',
        message: 'Review this marked line before sharing the document.',
      });
    }
    return createDiagnosticsResult(request, diagnostics);
  },
}));

Das Manifest deklariert Protokollversion 1, die Fähigkeit diagnostics, den Host test-host sowie die Berechtigungen document.read und diagnostics.publish. Der Provider erhält einen Dokument-Snapshot und ein AbortSignal. Diagnosebereiche verwenden bei null beginnende Zeilennummern und UTF-16-Zeichenoffsets.

3. Lokal ausführen

Erstellen Sie run.mjs neben plugin.mjs. Aktivieren Sie das Plugin, übergeben Sie ein Dokument und fordern Sie Diagnosen an. Geben Sie den Host nach Abschluss immer frei.

run.mjs

import { createTestHost } from '@altifigence/dds-plugin-sdk/testing';
import plugin from './plugin.mjs';

const host = createTestHost();
try {
  await host.activate(plugin);
  host.setDocument({
    uri: 'memory:///hello.txt',
    languageId: 'plaintext',
    modelVersion: 1,
    workspaceRevision: 'example-1',
    text: 'Hello, DDS!\nNOTE: write a plugin.\n',
  });
  const result = await host.requestDiagnostics();
  console.log(`${plugin.manifest.name}: ${result.diagnostics.length} diagnostic`);
  for (const diagnostic of result.diagnostics) {
    console.log(`${diagnostic.severity} ${diagnostic.range.start.line + 1}:${diagnostic.range.start.character + 1} ${diagnostic.message}`);
  }
} finally {
  host.dispose();
}
Bash
node run.mjs

Erwartete Ausgabe (die ausgegebenen Zeilen- und Spaltennummern beginnen bei eins):

Text
Hello Diagnostics: 1 diagnostic
info 2:1 Review this marked line before sharing the document.

4. Ihr Plugin testen

Speichern Sie diesen Test als plugin.test.mjs. Er prüft den Diagnosebereich und bestätigt, dass eine Bearbeitung des Dokuments die Diagnose entfernt.

plugin.test.mjs

import assert from 'node:assert/strict';
import test from 'node:test';
import { createTestHost } from '@altifigence/dds-plugin-sdk/testing';
import plugin from './plugin.mjs';

test('reports a NOTE and clears it after editing', async () => {
  const host = createTestHost();
  try {
    await host.activate(plugin);
    const document = {
      uri: 'memory:///hello.txt',
      languageId: 'plaintext',
      modelVersion: 1,
      workspaceRevision: 'test-1',
      text: 'NOTE: write a plugin.\n',
    };
    host.setDocument(document);
    const result = await host.requestDiagnostics();
    assert.equal(result.diagnostics.length, 1);
    assert.equal(result.diagnostics[0].code, 'todo');
    assert.deepEqual(result.diagnostics[0].range, {
      start: {line: 0, character: 0},
      end: {line: 0, character: 4},
    });
    host.setDocument({...document, modelVersion: 2, text: 'Done.\n'});
    assert.equal((await host.requestDiagnostics()).diagnostics.length, 0);
  } finally {
    host.dispose();
  }
});
Bash
node --test plugin.test.mjs

Der Test sollte bestehen. Ergänzen Sie Testdaten für Ihre eigene Sprache, Abbruch, ungültige Ergebnisse und große Dokumente. Halten Sie die Dokumentversion aktuell, damit Ergebnisse eines früheren Snapshots abgelehnt werden.

5. Ein Theme erstellen und anwenden

Speichern Sie diese Hell-/Dunkelpalette als theme.json. Die sechs Farben jeder Palette sind erforderlich. Optionale semantische Tokens passen Suche, Auswahlen, HintsBox und die GDS-Zeichenfläche an; ausgelassene Tokens verwenden DDS-Standardwerte.

theme.json

{
  "name": "Hello Ocean",
  "colors": {
    "light": {
      "backdrop": "#dbe8ef",
      "navigation": "#edf5f8",
      "tool": "#f3f8fb",
      "main": "#ffffff",
      "text": "#183b4e",
      "muted": "#486477"
    },
    "dark": {
      "backdrop": "#0c1922",
      "navigation": "#102430",
      "tool": "#17303e",
      "main": "#1c3949",
      "text": "#e8f4fb",
      "muted": "#adcadb"
    },
    "metrics": {
      "panelRadius": 16,
      "controlRadius": 8
    }
  }
}

Erstellen Sie export-theme.mjs daneben. parseTheme validiert die Farbdaten und serializeThemeXml exportiert DDS XML Version 2.

export-theme.mjs

import { readFile, writeFile } from 'node:fs/promises';
import { parseTheme, serializeThemeXml } from '@altifigence/dds-plugin-sdk/themes';

const theme = parseTheme(await readFile('./theme.json', 'utf8'));
await writeFile('./hello-theme.xml', serializeThemeXml(theme), 'utf8');
console.log('Created hello-theme.xml');
Bash
node export-theme.mjs

Der Befehl schreibt hello-theme.xml und gibt Created hello-theme.xml aus. Öffnen Sie in DDS Plugins → Theme installieren…, wählen Sie die XML-Datei und anschließend Anwenden für Hello Ocean. Wechseln Sie zwischen heller und dunkler Darstellung, um beide Paletten zu sehen.

Sie können auch Einstellungen → Allgemein → Darstellung → XML importieren verwenden. Speichern Sie das aktuelle Theme vor dem Ersetzen mit XML exportieren. Dadurch werden XML-Darstellungsdaten in die Theme-Konfiguration importiert.

Der Theme-Leitfaden führt alle unterstützten Tokens und Maße auf. Das Hello-Ocean-Beispiel enthält das vollständige Theme, direkt importierbares XML und eine lokale HTML-Vorschau.

XML-Referenz für Themes

Laden Sie Hello Ocean XML und die dazugehörige bearbeitbare JSON-Datei herunter. Das XML enthält vollständige helle und dunkle Paletten, alle 28 optionalen Rollenfarben in jedem Modus und vier ausdrückliche Maße. Speichern Sie die XML-Datei vor dem Import lokal. Diese ursprünglichen SDK-Beispiele verwenden Apache-2.0; behalten Sie beim Weitergeben den Hinweis bei.

Beginnen Sie mit Einstellungen → Allgemein → Darstellung → XML exportieren, um Ihr aktuelles Theme zu sichern. Importieren Sie das heruntergeladene XML, prüfen Sie den Entwurf und wählen Sie dann Anwenden. Änderungen verwerfen behält das angewendete Theme bei. Wechseln Sie zwischen heller und dunkler Darstellung, um beide Paletten zu prüfen. Zur Wiederherstellung wählen Sie ein integriertes Theme oder importieren Ihre gespeicherte Kopie. Ein abgelehnter Import erhält das aktuelle Theme.

DDS, ALcad, gemeinsame Editoren, Projektnavigation, Einstellungen und Popups verwenden in diesem Profil die gemeinsame Workbench-Palette. Cloud und Desktop verwenden dasselbe Theme-Format; importieren Sie es in jedem Profil separat. gdsBackground steuert die GDS-Zeichenfläche unabhängig. Andere Design-Zeichenflächen-, Ebenen- und Simulationsfarben können eigene Einstellungen haben. XML enthält die Palette und Darstellungsmetriken dieses Theme-Profils.

Element

Regel

<dds-theme version="2" name="Hello Ocean">

Ein Wurzelelement; ein Name nach Entfernen äußerer Leerzeichen mit 1–80 UTF-16-Codeeinheiten; höchstens 65536 UTF-8-Bytes für das gesamte XML.

<palette mode="light">, <palette mode="dark">

Beide erforderlich, jeweils mit den sechs folgenden Farben.

<tokens mode="light">, <tokens mode="dark">

Optionale v2-Überschreibungen. Ausgelassene Rollen folgen den DDS-Standardwerten für diesen Modus.

<metrics>

Optionale numerische v2-Überschreibungen.

Version 1

Nur beide Paletten. Bestehende v1-Dateien bleiben unterstützt; der SDK-Exporter erzeugt v2.

Erforderlicher Palettenschlüssel

Verwendung

backdrop

Äußerer Arbeitsbereichshintergrund

navigation

Projektnavigation

tool

Werkzeugpanels und Steuerelemente

main

Hauptarbeitsbereich und Einstellungen

text

Haupttext

muted

Sekundärtext

Optionale Rollenschlüssel (28)

Verwendung

search, searchText, searchPlaceholder

Gemeinsamer Suchhintergrund, Text und Platzhalter

searchBorder

Kompatibilitätsfeld; aktuelle gemeinsame Suchfelder haben keinen Rahmen

selection, selectionText

Ausgewählte Zeilen und Text

tabActive, tabInactive, tabText

Editor-Tabs

rail, panelBorder, popover

Werkzeugleisten, Panelgrenzen und Popups

focus

Umrandung des Tastaturfokus

success, warning, danger, info, aiBall

Statusfarben und Hintergrund der KI-Kugel

hintsBoxBackground, hintsBoxDetailsBackground

Hintergründe für Vorschläge und Details

hintsBoxText, hintsBoxDetailsText, hintsBoxMutedText

Vorschlags-, Detail- und Sekundärtext

hintsBoxSelectedBackground, hintsBoxSelectedText

Per Tastatur ausgewählter Vorschlag

hintsBoxHoverBackground, hintsBoxHoverText

Mit dem Zeiger berührter Vorschlag

gdsBackground

Hintergrund der GDS-Viewer-Zeichenfläche

HintsBox ist die gemeinsame Funktion für Codevorschläge. Ihre Farben finden Sie unter Benutzerdefiniert → Detaillierte Farben und Formen → HintsBox und den GDS-Hintergrund unter Anzeige. Bearbeiten Sie alle drei Suchfarben gemeinsam, um lesbaren Kontrast zu erzielen. Dieses Fragment gehört in ein v2-Theme; behalten Sie die beiden vollständigen Paletten bei:

XML-v2-Fragment

<tokens mode="dark">
  <color key="search" value="#214556"/>
  <color key="searchText" value="#e8f4fb"/>
  <color key="searchPlaceholder" value="#adcadb"/>
</tokens>

Maß

Zulässige Werte

Aktueller DDS-Standardwert

panelRadius

Ganzzahl 0–24

14

controlRadius

Ganzzahl 0–16

6

popoverRadius

Ganzzahl 0–24

16

popoverOpacity

Zahl 0,6–1

0,72

Schreiben Sie Maße als <number key="popoverOpacity" value="0.9"/> innerhalb von <metrics> ohne Einheiten. Radiuswerte sind Pixel. Das SDK lässt ausgelassene Maße weg; die installierte DDS-Version liefert ihre Standardwerte. Setzen Sie ausdrückliche Werte für eine einheitliche Darstellung. Hello Ocean setzt bewusst 16, 8, 12 und 0,9. Einstellungen für reduzierte Transparenz und erzwungene Farben können die endgültige Darstellung verändern.

Jede Farbe muss im sechsstelligen Format #RRGGBB vorliegen; Alpha, CSS-Namen, Variablen, URLs und Stile werden abgelehnt. Doppelte Schlüssel oder Modi, unbekannte Elemente/Attribute, Namensräume, DTDs, Entitäten und Verarbeitungsanweisungen werden abgelehnt. XML-Deklarationen und Kommentare sind erlaubt. Wenn der Import fehlschlägt, prüfen Sie Dateigröße, Version, beide vollständigen Paletten und unterstützte Werte; versuchen Sie es anschließend mit Ihrer unveränderten Sicherung erneut. Themes anderer Editoren müssen in dieses DDS-Format konvertiert werden.

6. Einen Arbeitsbereich in Ihrer Umgebung ausführen

Führen Sie Host, SDK, Plugins und Werkzeuge in Ihrer eigenen WSL-, Container- oder Serverumgebung aus. Projektdateien bleiben unter dem von Ihnen gewählten Stammverzeichnis. Der eigenständige SDK-Client liest und bearbeitet sie über die Verbindung; er erhält Plugin-Metadaten und Befehlsergebnisse, während der Plugin-Code in Ihrer Umgebung läuft.

Speichern Sie diesen Helfer im oben erstellten SDK-Projekt als copy-workspace-example.mjs. Er kopiert den bearbeitbaren Server, das Plugin, das Werkzeug und das Beispielprojekt und erhält dabei die Lizenzdateianordnung des Beispiels.

copy-workspace-example.mjs

import { cp, copyFile, mkdir } from 'node:fs/promises';
import { createRequire } from 'node:module';
import path from 'node:path';

const require = createRequire(import.meta.url);
const sdkRoot = path.dirname(require.resolve('@altifigence/dds-plugin-sdk/package.json'));
await mkdir('./user-host/examples', {recursive: true});
await cp(path.join(sdkRoot, 'examples/user-workspace'), './user-host/examples/user-workspace', {
  recursive: true, force: false, errorOnExist: true,
});
await copyFile(path.join(sdkRoot, 'LICENSE'), './user-host/LICENSE');
console.log('Created user-host');
Bash
node copy-workspace-example.mjs

Das Beispielprojekt ist user-host/examples/user-workspace/project. Starten Sie den Server in dieser Umgebung mit einem ausdrücklich generierten Token:

WSL / Linux / Container

export DDS_WORKSPACE_TOKEN="$(node -e 'process.stdout.write(require("node:crypto").randomBytes(32).toString("hex"))')"
node user-host/examples/user-workspace/server.mjs

PowerShell

$env:DDS_WORKSPACE_TOKEN = node -e "process.stdout.write(require('node:crypto').randomBytes(32).toString('hex'))"
node user-host/examples/user-workspace/server.mjs

Der Server gibt Workspace server: http://127.0.0.1:4777/dds/workspace/v1 sowie eine Arbeitsbereichs-ID und Generation aus. Setzen Sie DDS_WORKSPACE_TOKEN im Client-Terminal auf das generierte Token. Es ist eine Betreiber-Zugangsinformation, getrennt von einem DDS-Account-Token. Beenden Sie den Beispielserver mit Ctrl+C.

Setzen Sie in einem anderen Terminal desselben Projekts DDS_WORKSPACE_TOKEN auf dasselbe Geheimnis und führen Sie den Entwicklerclient aus:

Bash
node user-host/examples/user-workspace/client.mjs http://127.0.0.1:4777

Der Client listet die Beispieldateien auf und führt Projektdatei untersuchen für design.sv aus. Das JSON-Ergebnis enthält tool: "module-counter" und modules: 1, erzeugt durch einen echten Kindprozess. Ergänzen Sie --edit im Client-Befehl nur, wenn das Beispiel eine Notiz an die Beispieldatei anhängen soll.

Um Ihr eigenes Projekt zu verwenden, übergeben Sie dessen absolutes Verzeichnis als letztes Argument an server.mjs. Bewahren Sie Server, Plugin-Module und installierte Werkzeuge in derselben Benutzerumgebung auf. server.mjs importiert das Plugin ausdrücklich und ordnet dessen benanntem Backend eine feste ausführbare Datei und Argumente zu:

Backend-Zuordnung in server.mjs

'module-counter': createProcessBackend({
  executable: process.execPath,
  args: [fileURLToPath(new URL('./tool.mjs', import.meta.url))],
  cwd: root,
  env: {},
})

Ersetzen Sie diese Zuordnung durch Ihr genehmigtes installiertes Werkzeug oder eigenes Backend. ctx.workspace.readFile und writeFile verwenden Pfade relativ zum ausgewählten Stammverzeichnis; ctx.backends.invoke("module-counter", input, {signal}) ruft ausschließlich einen konfigurierten Backend-Namen auf. Der Prozessadapter sendet begrenztes JSON über stdin und erwartet JSON auf stdout. Er verwendet keinen vom Aufruf gelieferten Shell-Befehl und übernimmt keine Umgebungsvariablen vom Host.

Verwenden Sie für einen entfernten Server Ihren eigenen authentifizierten HTTPS-Endpunkt oder einen privaten Tunnel, der auf lokalem Loopback endet. Konfigurieren Sie Container-Portzuordnung oder TLS in Ihrer Umgebung. Das Beispiel bindet standardmäßig an Loopback; eine Änderung der Bindeadresse ergänzt kein TLS. Vertrauenswürdige Plugins und Werkzeuge laufen mit den Betriebssystembefugnissen Ihres Hostprozesses.

Das Beispiel für Benutzerarbeitsbereiche und das Arbeitsbereichsprotokoll erläutern Serverkonfiguration, Ursprünge, Dateirevisionen, Abbruch und begrenzte Ergebnisse.

Sprachfunktionen

SDK 0.7.0 bietet Vervollständigung, Hover, Definition, Referenzen und flache Dokumentsymbole. Deklarieren Sie jede Funktion in den Manifest-v2-Fähigkeiten sowie die Berechtigungen document.read und language.provide. Der Host muss beide Berechtigungen ausdrücklich erteilen. Speichern Sie dieses vollständige Hover-Beispiel als language-demo.mjs im oben erstellten Projekt:

language-demo.mjs

import { definePlugin, createLanguageResult, createPluginHost } from '@altifigence/dds-plugin-sdk';

const plugin = definePlugin({
  manifestVersion: 2,
  id: 'hello-hover', name: 'Hello Hover', publisher: 'example', version: '1.0.0',
  protocolVersion: 1, entry: './language-demo.mjs', runtime: 'ui',
  capabilities: ['hover'],
  permissions: ['document.read', 'language.provide'],
  supportedHosts: ['test-host'], license: 'Apache-2.0',
  source: {visibility: 'open', licenseFile: 'LICENSE'},
}, context => context.registerLanguageProvider('hover', {languages: ['dds-demo']}, {
  provide(request, {signal}) {
    signal.throwIfAborted();
    return createLanguageResult(request, {text: 'A local LED signal.'});
  },
}));

const host = createPluginHost({grants: ['document.read', 'language.provide']});
try {
  await host.activate(plugin);
  host.setDocument({
    uri: 'memory:///demo.dds', languageId: 'dds-demo',
    modelVersion: 1, workspaceRevision: 'demo-1', text: 'led',
  });
  const result = await host.requestLanguage('hover', {position: {line: 0, character: 1}});
  console.log(result.data.text);
} finally {
  host.dispose();
}
Bash
node language-demo.mjs
node node_modules/@altifigence/dds-plugin-sdk/examples/hello-language/run.mjs

Der erste Befehl gibt A local LED signal. aus. Das mitgelieferte zweite Beispiel prüft alle fünf Funktionen mit einer kleinen Lehrsprache mit let name = value; der eigene Provider des Beispiels implementiert diese Lehrsprache.

Funktion

Anfrageeingabe

Ergebnisdaten

completion

position

Bis zu 500 {label, insertText, detail?, range?}-Einträge

hover

position

{text, range?} oder null

definition

position

Bis zu 500 zum Arbeitsbereich relative {path, range}-Positionen

references

position, optional includeDeclaration

Bis zu 500 zum Arbeitsbereich relative {path, range}-Positionen

document-symbols

{}

Bis zu 500 flache {name, kind, range, selectionRange, detail?}-Symbole

Positionen verwenden bei null beginnende Zeilen und UTF-16-Offsets. Vervollständigungseinfügungen sind wörtlicher Text; Hover- und Detailzeichenfolgen sind Klartext. Ein Host muss Zieldateien und Bereiche prüfen, bevor er einer Position folgt. Das Ergebnis erhält Anfrage-, Projekt-/Sitzungs- und Dokumentversionsidentität. Bearbeiten des Snapshots, Abbruch, Timeout, Abmelden oder Freigeben beendet ausstehende Anfragen und verwirft verspätete Ergebnisse.

Diese APIs arbeiten im vertrauenswürdigen SDK-Host. Der eigenständige Host ruft registrierte Sprachprovider auf; eine LSP-Brücke verwendet eine ausdrücklich konfigurierte Prozessverbindung. Hosts vor 0.3.0 lehnen die neuen Fähigkeiten ab. Lesen Sie Sprachfunktionen für Selektoren, Grenzen und Lebenszyklusverhalten.

Projektbearbeitungssitzungen

Importieren Sie createWorkspaceProject und applyTextEdits aus @altifigence/dds-plugin-sdk/workspace-client. Nachdem Ihr Host einen createWorkspaceClient verbunden und Arbeitsbereichsidentität, Hinweis und Zugriff geprüft hat, rufen Sie createWorkspaceProject(client) auf. Das Projekt erhält die genaue Verbindungsbindung. Eine erneute Verbindung erfordert ein neu geprüftes Projekt, selbst wenn dieselbe Arbeitsbereichs-ID und Generation zurückkehren.

API

Verhalten

project.listFiles(path?, options?)

Ein Verzeichnis unter dem ausgewählten Arbeitsbereichsstamm auflisten.

project.openFile(path, options?)

Eine Datei lesen und ihren unveränderlichen Inhalt samt Revision in einer Bearbeitungssitzung behalten.

project.createFile(path, content, options?)

Nur erstellen, wenn die Datei nicht vorhanden ist, und anschließend eine Sitzung zurückgeben.

session.snapshot / session.state

Den zuletzt bestätigten {path, content, revision} und den aktuellen Operationszustand lesen.

session.save(content, options?)

Nur speichern, wenn die Serverrevision noch mit der behaltenen Revision übereinstimmt.

session.saveEdits(edits, options?)

Änderungen vom Typ {range, text} auf einen Snapshot anwenden und anschließend einmal revisionsgeprüft speichern.

session.reload(options?)

Nach einem Konflikt oder ungewissem Schreibvorgang ausdrücklich den neuesten Inhalt und die Revision lesen.

project.dispose() / session.dispose()

Eigene Arbeit abbrechen; beim Freigeben des Projekts bleibt der dem Aufrufer gehörende Client verbunden.

Führen Sie das vollständige HTTP-Beispiel im installierten Paket aus. Es erstellt einen eigenen temporären Beispielarbeitsbereich, testet Bearbeitung, eine zweite Sitzung mit Konflikt, ausdrückliches Neuladen, Unicode und erneute Verbindung und schließt danach seinen Server und entfernt dieses temporäre Verzeichnis:

Bash
node node_modules/@altifigence/dds-plugin-sdk/examples/project-session/run.mjs

Erwartete Ausgabe: Project session: HTTP edit, conflict, reload, Unicode and reconnect verified. Der Beispielquellcode zeigt die vollständige Server-/Client-Einrichtung und Bereinigung.

Optionen akzeptieren signal und timeoutMs. Ein nach dem Versuch fehlgeschlagener Schreibvorgang hinterlässt needs-reload; bewahren Sie jeden ungespeicherten UI-Entwurf separat auf und laden Sie vor einem weiteren Speichern ausdrücklich neu. Das SDK führt weder Zusammenführung noch Wiederholung automatisch durch. Timeout, Abbruch oder Antwortverlust können auftreten, nachdem ein Server den Schreibvorgang festgeschrieben hat; das Abbrechen einer Anfrage belässt bereits festgeschriebene Änderungen. Jede Sitzung erlaubt einen ausstehenden Speicher- oder Neuladevorgang.

Textänderungen verwenden den ursprünglichen Snapshot, bei null beginnende Zeilen und UTF-16-Offsets. Überlappungen, getrennte Surrogatpaare und ungültige Bereiche werden vor dem Speichern abgelehnt. Projekte erlauben höchstens 64 offene oder sich öffnende Sitzungen und 500 Änderungen je Speichervorgang. Diese Helfer verwenden das unveränderte Arbeitsbereichsprotokoll v1, einschließlich SDK-0.2.x-Servern, und erhalten Einschränkungen für Stammverzeichnis, geschützte Pfade und Nur-Lesen. Lesen Sie Arbeitsbereichsprojekte für Lebenszyklus- und Größenbegrenzungen.

API-Referenz

Importieren Sie Plugin-APIs aus @altifigence/dds-plugin-sdk. Das Paket enthält TypeScript-Deklarationen für dieselben Exporte.

API

Verwendung

definePlugin(manifest, activate)

Manifest validieren und Aktivierungsfunktion deklarieren.

context.registerDiagnosticsProvider(selector, provider)

Registrieren Sie provideDiagnostics(request, {signal}) für ausgewählte Sprach-IDs; geben Sie eine freigebbare Registrierung zurück.

createDiagnosticsResult(request, diagnostics)

Ein geprüftes Ergebnis anhand der Anfrageidentität erstellen.

context.registerLanguageProvider(kind, selector, provider) / createLanguageResult(request, data)

Einen Sprachprovider registrieren und ein Ergebnis mit validierter Anfrageidentität erstellen.

parseManifest(value)

Manifestversion, Identität, Berechtigungen, unterstützte Hosts und Einstiegsmodul validieren.

parseDocumentSnapshot(value)

URI, Sprache, Modellversion, Arbeitsbereichsrevision und Text validieren.

parseDiagnosticsRequest(value) / parseDiagnosticsResult(value)

Protokoll, Anfrage, Geltungsbereich, Dokumentidentität und Diagnosefelder validieren.

PluginSdkError / ErrorCode / LIMITS / PROTOCOL_VERSION

Typisierte Fehler, Ressourcengrenzen und Protokollversion lesen.

Importieren Sie den Entwicklerhost aus @altifigence/dds-plugin-sdk/testing:

Testhost-API

Verwendung

createTestHost({scope, grants})

Einen lokalen Host erstellen. Beide Optionen sind optional; Standardfreigaben erlauben Dokumentlesen und Diagnosen.

await host.activate(plugin)

Das Plugin aktivieren und eine freigebbare Aktivierung zurückgeben.

host.setDocument(snapshot)

Das aktuelle Dokument setzen. Erhöhen Sie modelVersion oder ändern Sie workspaceRevision beim Ändern seines Texts.

await host.requestDiagnostics({signal, timeoutMs})

Diagnosen von einem passenden Provider anfordern; beide Optionen sind optional.

await host.requestLanguage(kind, input, {signal, timeoutMs})

Eine deklarierte Sprachfunktion mit ausdrücklichen Freigaben document.read und language.provide anfordern.

host.deactivate(pluginId) / host.dispose()

Registrierungen entfernen und ausstehende Arbeit abbrechen; den Host nach Testende freigeben.

Anfragen enthalten requestId, Projekt-/Sitzungs-scope und einen Snapshot mit uri, languageId, modelVersion, workspaceRevision und text. Verwenden Sie createDiagnosticsResult, um diese Identität zu erhalten. Ergebnisse enthalten ein diagnostics-Array und lassen den Quelltext weg.

Fehler stellen einen code bereit, unter anderem invalid_contract, permission_denied, cancelled, stale_snapshot, provider_unavailable und budget_exceeded. Der Standard-Timeout für Anfragen beträgt 5 Sekunden; akzeptierte Timeouts liegen bei 1–30000 ms. Ein Dokument ist auf 262144 UTF-8-Bytes und ein Ergebnis auf 500 Diagnosen begrenzt. Lesen Sie LIMITS für die vollständigen Grenzen.

SDK 1.0.0 bietet außerdem separate Module. Nur unter Node nutzbare Arbeitsbereichs- und Paketierungsimporte gehören in die Benutzerumgebung:

Import

API

@altifigence/dds-plugin-sdk

createPluginHost — v2-Befehle, ausdrückliche Arbeitsbereichs-/Backend-Ports

@altifigence/dds-plugin-sdk/themes

parseTheme, serializeThemeXml

@altifigence/dds-plugin-sdk/workspace-node

createNodeWorkspace, createProcessBackend, createWorkspaceServer, downloadJobBinaryArtifact, downloadStoredJobArtifact

@altifigence/dds-plugin-sdk/workspace-client

createWorkspaceClient, createWorkspaceProject, applyTextEdits, WORKSPACE_OBSERVATION_LIMITS; getFileCapabilities, getFileRevision, readFileIfChanged, watchFiles, watchJob, waitForJob; getBinaryArtifactCapabilities, listJobBinaryArtifacts, getJobBinaryArtifact, readJobBinaryArtifactChunk; getJobStorageCapabilities, listJobHistory, recoverJob, retryCommandJob; getArtifactStorageCapabilities, listStoredJobArtifacts, getStoredJobArtifact, readStoredJobArtifactChunk, readStoredJobArtifactText

@altifigence/dds-plugin-sdk/publishing

validatePluginPackage, packPlugin

@altifigence/dds-plugin-sdk/consent

createNotice, createPermissionGrant, isPermissionGranted, revokeConsentReceipt

@altifigence/dds-plugin-sdk/devtools

initPlugin, doctorPlugin, runPluginDev

@altifigence/dds-plugin-sdk/jobs

JOB_LIMITS, parseJobSnapshot, parseJobEvents, Jobtypen

@altifigence/dds-plugin-sdk/artifacts

BINARY_ARTIFACT_LIMITS, parseBinaryArtifactReference, parseBinaryArtifactChunk, decodeBinaryArtifactData

/job-storage / /job-storage-node

createNodeJobStore, dauerhafte Jobtypen

/job-history

parseJobHistoryQuery, parseJobHistoryPage, Wiederholungsbeziehungen

/artifact-storage / /artifact-storage-node

createNodeArtifactStore, Typen gespeicherter Ergebnisse

Ihr Plugin paketieren und veröffentlichen

Beginnen Sie mit dem enthaltenen veröffentlichbaren Plugin. Speichern Sie diesen Helfer in Ihrem SDK-Projekt, um seine Dateien in ein neues my-plugin-Verzeichnis zu kopieren.

copy-publishable-example.mjs

import { cp } from 'node:fs/promises';
import { createRequire } from 'node:module';
import path from 'node:path';

const require = createRequire(import.meta.url);
const sdkRoot = path.dirname(require.resolve('@altifigence/dds-plugin-sdk/package.json'));
await cp(path.join(sdkRoot, 'examples/publishable-plugin'), './my-plugin', {
  recursive: true,
  force: false,
  errorOnExist: true,
});
console.log('Created my-plugin');
Bash
node copy-publishable-example.mjs

Bearbeiten Sie plugin.json, plugin.mjs, disclosure.json und die Lizenz, um Ihr eigenes Plugin zu beschreiben. Die Offenlegung muss mit Manifest-Herausgeber, Plugin-ID, Version, Lizenz und Quellcodesichtbarkeit übereinstimmen. Listen Sie in dds-package.json ausschließlich Dateien auf, die Sie verbreiten möchten:

dds-package.json

{
  "schemaVersion": 1,
  "files": [
    "plugin.json",
    "plugin.mjs",
    "disclosure.json",
    "LICENSE",
    "NOTICE"
  ]
}

Validieren und paketieren Sie das Beispiel:

Bash
npx --no-install dds-plugin validate ./my-plugin
npx --no-install dds-plugin pack ./my-plugin --out ./dist

Mit den unveränderten Beispielmetadaten erstellt pack die Dateien dist/example-hello-publisher-1.0.0.tgz und dist/example-hello-publisher-1.0.0.tgz.release.json. Das Release-JSON enthält das endgültige Archiv-SHA-256, Manifest-/Offenlegungshashes und das Dateiinventar. Prüfen Sie diese Dateien vor der Verbreitung.

Nur ausdrücklich erlaubte Dateien, dds-package.json und generierte npm-Metadaten gelangen in das Archiv. Validierung prüft Paketdaten, und Paketierung erstellt das lokale Archiv für den gewählten Verteilungskanal. Die CLI lehnt private Konfiguration, Schlüsseldateien und verknüpfte Pfade ab; prüfen Sie den Inhalt Ihrer gewählten Dateien vor dem Teilen.

Kanal

Bereitzustellende Inhalte

Öffentliches GitHub-Release

Ein versioniertes Archiv, sein externes Release-JSON, die Lizenz und erforderlicher Quellcodezugang.

Private Registry oder Downloadkanal

Dieselben versionierten Dateien, Zielgruppenautorisierung und tatsächlichen Plugin-Bedingungen.

Manifest v2 deklariert runtime, angeforderte Berechtigungen und source: {visibility, licenseFile, repository?}. Setzen Sie die Sichtbarkeit auf open oder closed und fügen Sie die tatsächliche Lizenzdatei bei. Eigener Code kann Open-Source- oder proprietäre Bedingungen verwenden; geltende SDK- und Abhängigkeitshinweise gelten weiterhin. Empfänger erhalten das ausführbare JavaScript zusammen mit den deklarierten Metadaten zu Quellsichtbarkeit und Lizenz.

Folgen Sie Veröffentlichung und Lizenzierung für Offenlegungsfelder und Verbreitungsanforderungen. Verteilen Sie das erzeugte Archiv und Release-JSON über Ihr gewähltes GitHub-Release, eine private Registry oder einen Downloadkanal.

Die CLI 1.2.1 trägt >=1.0.0 <2.0.0 in neue Plugin-Pakete ein. Historische Archive von 0.3–0.13 und exakt 1.0.0-rc.1 behalten ihre ursprünglichen Peer-Abhängigkeiten. Validieren und paketieren Sie eine neue Plugin-Version für die stabile Installation; der Herausgeber aktualisiert beim erneuten Paketieren den deklarierten Peer-Bereich und die Release-Metadaten ausdrücklich.

Ein heruntergeladenes Plugin überprüfen

SDK 1.2.1 bietet dds-plugin verify für exakt veröffentlichte Plugin-Metadaten von 0.3.x–0.13.x, RC1 und der aktuellen stabilen Version. Bewahren Sie .tgz und .tgz.release.json zusammen auf. Die Überprüfung erhält die ursprüngliche Peer-Abhängigkeit. Prüfen Sie das oben erstellte Paket:

Das paketierte Beispiel überprüfen

npx --no-install dds-plugin verify ./dist/example-hello-publisher-1.0.0.tgz

Der Befehl prüft begrenzte gzip-/tar-Struktur, genaue Datei-Erlaubnislisten, jeden Dateihash, Manifest, Offenlegung, Lizenz und generierte npm-Metadaten. Er lehnt Links, unsichere oder doppelte Pfade, Zusatzdateien und npm-Hooks/-Abhängigkeiten ab. Er liest und validiert das lokale Archiv an Ort und Stelle als Datenoperation. Erfolg gibt einen JSON-Beleg aus; Ablehnung beendet mit Code 1.

Für umbenannte Downloads verwenden Sie --metadata mit dem passenden Release-JSON. Beschaffen Sie das erwartete SHA-256 unabhängig über einen vertrauenswürdigen Release-Kanal und übergeben Sie es mit --sha256, um die ausgewählten Bytes festzulegen. Die Node-API stellt dieselben Optionen bereit:

verify-release.mjs

import { verifyPluginArchive } from '@altifigence/dds-plugin-sdk/publishing';

const receipt = await verifyPluginArchive(process.argv[2], {
  metadataPath: process.argv[3],
  expectedSha256: process.argv[4],
});
console.log(receipt.pluginId, receipt.pluginVersion, receipt.artifact.sha256);

Führen Sie verify-release.mjs mit Archivpfad, Metadatenpfad und unabhängig beschafftem 64-stelligem kleingeschriebenem Hash als drei Argumenten aus. checksumPinned ist nur dann true, wenn dieser angegebene Hash übereinstimmt. Grenzen sind 12 MiB komprimierte Eingabe, 10 MiB Dateiinhalte, 4 MiB je Datei, 256 Dateien und 256 KiB externe Metadaten.

Die zugehörigen Metadaten dokumentieren die Archivintegrität durch übereinstimmende Hashes. Beziehen Sie den erwarteten Digest aus einem unabhängig vertrauenswürdigen Releasekanal, da der Austausch beider Dateien ein neues passendes Paar erzeugen kann. Prüfen Sie Herausgeber und ausführbare Inhalte, erteilen Sie Hostberechtigungen ausdrücklich und validieren Sie die Zielinstallation in eigenen Schritten. Ein Beleg beschreibt die während dieses Aufrufs gelesenen Bytes; prüfen Sie die tatsächlichen Bytes erneut, falls sich die Datei vor der Nutzung ändern kann. Bestehende Plugin-Archive von 0.3.x/0.4.x/0.5.x/0.6.x/0.7.x/0.8.x/0.9.x/0.10.x/0.11.x bleiben überprüfbar, wenn sie die verschärfte Dateirichtlinie erfüllen; ihre Installation auf 1.0 erfordert weiterhin Herausgebervalidierung und erneute Paketierung. Entfernen Sie neu ausgeschlossene Dateien und veröffentlichen Sie gegebenenfalls eine neue Plugin-Version. Dieser Prüfer ist für DDS-Plugin-Pakete; SDK-npm-Tarballs verwenden ihr Release-SHA-256.

Siehe Archivüberprüfung und das vollständige Beispiel für Paketierung, Überprüfung und Manipulation.

Berechtigungen, Lizenzen und Datennutzung

Angeforderte Manifestberechtigungen sind von Hostfreigaben, die Operationen ermöglichen, getrennt. Informieren Sie Benutzer vor der Aktivierung über Plugin-Identität, Version, tatsächliche Lizenz, Arbeitsbereichsumfang und angeforderte Berechtigungen. Erläutern Sie vor dem Verbinden eines Backends dessen Betreiber, übermittelte Daten, Zweck, Aufbewahrung und Datenschutzhinweis.

Datensatz

Bedeutung

pluginPermissionGrant

Eine Host-Zugriffsentscheidung für das genaue Paket, den Arbeitsbereich und die Berechtigungen.

noticeAcknowledgement

Ein Benutzer hat einen Informationshinweis bestätigt.

pluginLicenseAcceptance

Ein Benutzer hat entschieden, ob er die tatsächlichen Bedingungen des Plugin-Herausgebers akzeptiert.

optionalPersonalDataConsent

Eine separate Entscheidung, wenn optionale Verarbeitung auf Einwilligung beruht.

Eine SDK-Arbeitsbereichsgenehmigung ist eine technische Zugriffsentscheidung. Dokumentieren Sie die Annahme von Plugin-Bedingungen und optionale Einwilligung zur Verarbeitung personenbezogener Daten als jeweils eigene Entscheidungen und Datensatzarten. Verwenden Sie das SDK gemäß seiner Apache-2.0-Lizenz und den Hinweisen.

Hostentwickler können einen versionierten Hinweis mit den portablen asynchronen Helfern erhalten. Speichern Sie dies beispielsweise als notice.mjs und führen Sie node notice.mjs aus:

notice.mjs

import { createNotice, parseNotice } from '@altifigence/dds-plugin-sdk/consent';

const notice = await createNotice({
  id: 'greet-data-use',
  version: '1.0.0',
  locale: 'en',
  purpose: 'Explain the greet command',
  text: 'The greet command uses the name you enter to return a greeting. It does not read project files or contact another backend.',
});
await parseNotice(notice);
console.log(notice.text);
console.log(`Notice text SHA-256: ${notice.contentSha256}`);

createPermissionGrant bindet eine angeforderte Berechtigungsteilmenge an Manifest v2, Artefakt- und Manifest-Hashes, Arbeitsbereichsgeneration, Hostidentität, Hinweis und Ablaufzeit. isPermissionGranted bewertet die vom Host bereitgestellten aktuellen Identitäten und Widerrufsereignisse. revokeConsentReceipt erstellt ein separates Ereignis; der Host muss danach zukünftige autorisierte Aufrufe stoppen.

Diese Helfer validieren lokale Datensätze. Der Host liefert die tatsächliche Benutzerentscheidung, Identität, Speicherung und Durchsetzung. Lesen Sie Berechtigungen und Einwilligung für genaue Felder und das interaktive Berechtigungsbeispiel für eine ausdrückliche Demonstration von Erlauben/Ablehnen/Widerrufen. Der Host verwaltet Herausgeberbedingungen und deren Annahmeaufzeichnungen.

Quellcode, Releases und Beiträge

Das offizielle SDK-Repository enthält Quellcode, Schemas, Beispiele und Vertragstests. Um das veröffentlichte Beispiel und SDK-Tests aus dem Quellcode auszuführen:

Bash
git clone --branch v1.2.1 --depth 1 https://github.com/Altifigence/dds-plugin-sdk.git
cd dds-plugin-sdk
npm ci
npm test
npm run example
npm run example:language
npm run example:project
npm run example:verify
npm run example:jobs
npm run example:observe
npm run benchmark:files
npm run example:artifacts
npm run benchmark:artifacts
npm run example:durable-jobs
npm run example:stored-artifacts

Melden Sie SDK-Fehler über GitHub Issues mit SDK-Version und minimalem Reproduktionsbeispiel. Das SDK ist unter Apache-2.0 lizenziert; siehe Repository-Lizenz und Hinweise. Verwenden Sie die Release-Seite für versionierte Archive und Versionshinweise.

Dieses Repository ist das bewusst öffentliche Entwickler-SDK. Sein Release enthält die deklarierten SDK-Dateien, Schemas, Beispiele und Hinweise gemäß seinem öffentlichen Umfang. Paketprüfungen erzwingen das genaue veröffentlichte Dateiinventar und lehnen bekannte Geheimnis- und Privatpfadmuster ab. Prüfen Sie die tatsächlichen Release-Inhalte zusammen mit diesen Musterprüfungen.

Sicherheitsupdates und Hostgrenzen

Aktualisieren Sie sowohl Ihren Arbeitsbereichsserver als auch den SDK-Client auf 0.3.2 oder neuer. Installieren Sie das Serverupdate, um seine verbesserten Dateiprüfungen und Anfragegrenzen zu aktivieren. Starten Sie den aktualisierten Host neu, prüfen Sie seine neue Generation und holen Sie vor der Arbeitsbereichsnutzung erneut eine Genehmigung ein.

Der Node-Arbeitsbereichshost lehnt Hardlinks ab, die geschützte Dateien oder Dateien außerhalb des ausgewählten Stammverzeichnisses aliasieren könnten. Kopieren Sie eine bewusst gemeinsam genutzte Projektdatei in eine reguläre Datei mit nur einem Link. Auch Zugangsdatenablagen wie .netrc, _netrc, .git-credentials, .gnupg, .kube und .docker, zusätzliche SSH-Schlüsselnamen und Windows-Gerätealiasnamen werden blockiert. Paketierung und Downloadprüfung wenden die entsprechende Richtlinie für Zugangsdaten-Dateinamen an.

Serverressource

Grenze

Gleichzeitig eingehende Anfrageinhalte

16; weitere Uploads erhalten vor der Ausführung HTTP 429

Laufende Anfragen

64; Abbruch verwendet einen separaten Dispatch-Pfad

Verbindungen / Anfragen je Socket

128 / 128

Anfrage und Antwort / Dateiinhalt

1600000 / 262144 UTF-8-Bytes

Der Client bricht ungelesene abgelehnte Antworten und stockende Streams bei Fristablauf oder Abbruch ab. Ein Timeout nach Beginn eines Schreibvorgangs kann dessen Ergebnis ungewiss lassen: Lesen Sie die Datei vor einem erneuten Versuch nochmals. Prüfen Sie Dateiinhalte zusätzlich zu ausdrücklichen Pfadausschlüssen und berücksichtigen Sie den Betriebssystemzugriff des Hostprozesses beim Ausführen vertrauenswürdigen Plugin-Codes. Verwenden Sie den Sicherheitsupgrade-Leitfaden und die Arbeitsbereichsgrenzen beim Bereitstellen eines Hosts.

Entwicklungswerkzeuge

Erstellen Sie nach der obigen Installation von SDK 1.2.1 ein separates Befehlsplugin-Projekt. Wählen Sie ein neues Ziel für die erzeugten Dateien; führen Sie Abhängigkeitsinstallation und Plugin-Ausführung nach dem Erstellen des Grundgerüsts ausdrücklich aus. Das Grundgerüst enthält einen Befehl, Test, Manifest, Offenlegung, festgelegte SDK-Abhängigkeit und Apache-2.0 LICENSE/NOTICE.

Bash
npx --no-install dds-plugin init ../my-command-plugin --id my-command-plugin --publisher example
cd ../my-command-plugin
npm install --ignore-scripts
npm run doctor
npm test
npx --no-install dds-plugin dev . --trust-local-code --command greet --input '{"name":"Ada"}'

Doctor liest Metadaten und prüft Node, SDK-Auflösung, Manifest, Lizenz, Offenlegung und erlaubte Paketdateien, ohne das Plugin zu importieren. Fehler erzeugen Exitstatus 1; Beispielwerte für Herausgeber/Support sind Warnungen. Ersetzen Sie diese Werte und prüfen Sie vor der Verbreitung die Lizenzen.

Bash
npx --no-install dds-plugin doctor . --json
npx --no-install dds-plugin dev . --trust-local-code --watch
npx --no-install dds-plugin dev . --trust-local-code --job --command greet --input '{"name":"Ada"}'
npm run pack:plugin

Dev erfordert --trust-local-code. Es führt vertrauenswürdige lokale Importe/Aktivierungen in einem Kindprozess aus und beobachtet nur erlaubte Dateien sowie dds-package.json. Jeder Lauf hat eine Frist und eine stdout-/stderr-Grenze von 256 KiB. Ctrl+C beendet die Beobachtung und bereinigt den Prozessbaum. Der Kindprozess läuft mit Ihren Betriebssystembefugnissen und der geerbten Umgebung. Der Standardtesthost bietet Dokumentlesen und Diagnostik; konfigurieren Sie für Arbeitsbereichs-/Backend-Integrationen einen separaten Host und ausdrückliche Freigaben.

Verwenden Sie --job, um Jobfortschritt/-protokolle auszugeben; mit --timeout-ms setzen Sie bis zu 30 Sekunden für normale Befehle oder 30 Minuten für Jobs. Die Node-APIs sind initPlugin, doctorPlugin und runPluginDev in /devtools. Der Leitfaden für Entwicklungswerkzeuge erläutert Beobachtungsverhalten und Ressourcenbereinigung.

Lang laufende Befehlsjobs

Aktivieren Sie jobs: true auf einem SDK-Host/-Server 0.4.0, um Befehle über die normale Anfragefrist hinaus auszuführen. Jobs sind standardmäßig deaktiviert. Probieren Sie das vollständige lokale HTTP-Beispiel aus, das Fortschritt, ein Protokoll eines benannten Backends und eine per Hash festgelegte Ergebnisdatei meldet:

Bash
node node_modules/@altifigence/dds-plugin-sdk/examples/command-jobs/run.mjs

Erwartete Ausgabe: Command job: progress, backend log and pinned result file verified. Ein Befehlshandler erhält optional job in {signal, job}. Es bietet reportProgress, log, addArtifact und invokeBackend. Bestehende Freigaben workspace.read/write und backend.invoke gelten weiterhin; kein beliebiger Pfad zu einer ausführbaren Datei wird akzeptiert.

JavaScript
await client.connect();
if (!(await client.getJobCapabilities()).enabled) throw new Error("Jobs are unavailable");
const jobId = crypto.randomUUID(); // Save before sending.
let job = await client.startCommandJob(pluginId, "analyze", {}, artifactSha256, {jobId, timeoutMs: 300_000});
let after = 0;
for (;;) {
  const page = await client.getJobEvents(jobId, after);
  after = page.nextCursor;
  if (page.dropped) console.log("Expired events:", page.dropped);
  for (const event of page.events) console.log(event.kind, event.data);
  job = await client.getJob(jobId);
  if (job.state !== "running" && !page.hasMore && after >= job.lastSequence) break;
  await new Promise(resolve => setTimeout(resolve, 250));
}
if (job.state === "succeeded") {
  const file = await client.readJobArtifact(jobId, "report");
  console.log(file.content);
}

Das Polling-Snippet setzt einen verbundenen Client und einen konfigurierten analyze-Befehl voraus, der report registriert. Bewahren Sie die Job-ID vor dem Start auf. Trennen oder Abbrechen einer Polling-Anfrage beendet die Ausführung nicht; verbinden Sie sich erneut mit derselben Generation und fragen Sie ausdrücklich ab bzw. brechen Sie ab. Wiederholte Starts mit derselben ID und Eingabe verwenden den behaltenen Job erneut; geänderte Argumente führen zu einem Konflikt. Ein Hostneustart verliert die In-Memory-Datensätze. Aktivieren Sie den separaten dauerhaften Speicher 0.8 unten, um nach einem Neustart festgeschriebene Metadaten wiederherzustellen.

Zustände sind running, succeeded, failed, cancelled und timed_out. Verspätete Ausgabe wird nach Abbruch verworfen; Nebenwirkungen werden nicht rückgängig gemacht. Nicht abgeschlossene Provider behalten ihre Plätze. Es gibt höchstens 4 gleichzeitige Jobs, 32 behaltene Datensätze, 32 verschachtelte Operationen je Job, 256 Ereignisse/64 KiB je Job, 64 Ereignisse je Seite und 16 Artefakte. Die Laufzeit beträgt standardmäßig 5 Minuten und ist auf 30 Minuten begrenzt. Abgeschlossene terminale Datensätze laufen 15 Minuten nach ihrem letzten Ereignis ab.

Textergebnisdateien sind zum Arbeitsbereich relative UTF-8-Dateien mit bis zu 256 KiB. Der Host liest sie mit der bestehenden Freigabe, zeichnet SHA-256 auf und lehnt spätere Lesevorgänge ab, falls die Bytes verändert wurden. Für binäre oder größere Simulationsausgaben verwenden Sie die optionale API für Binärergebnisse. Teilweise Artefakte können nach Abbruch bestehen bleiben; prüfen Sie den terminalen Jobstatus auf Erfolg. Ältere 0.3-Clients verwenden weiterhin bestehende v1-Methoden; eigenständige SDK-Jobs verwenden 0.4 oder neuer auf Client und Host. Siehe Jobs für genaue Verträge und Grenzen.

Arbeitsbereichsdateien beobachten

project.watchFiles() erfasst Stichproben von 1–16 ausdrücklichen relativen Dateipfaden. SDK 1.0.0 verwendet auf unterstützenden Hosts reine Revisionsanfragen und auf älteren Hosts bestehende begrenzte Lesevorgänge. Das Beispiel setzt einen verbundenen, vom Host genehmigten Client voraus. Ändern Sie design.sv mit einem externen Editor, um die Schleife zu beenden; der behaltene Bearbeitungs-Snapshot bleibt unverändert.

JavaScript
import {createWorkspaceProject} from '@altifigence/dds-plugin-sdk/workspace-client';
const project = createWorkspaceProject(client);
const edit = await project.openFile('design.sv');
const original = edit.snapshot;
try {
  for await (const change of project.watchFiles(['design.sv'], {intervalMs: 1000})) {
    console.log(change.kind, change.path, change.previousRevision, change.revision);
    if (change.kind !== 'initial') break;
  }
  console.log(edit.snapshot === original);
} finally { project.dispose(); }

Ereignisse sind unveränderliche {kind, path, previousRevision, revision}. Die erste Stichprobe erzeugt initial; spätere Änderungen erzeugen created, changed oder deleted. Fehlende Dateien haben revision null. includeInitial: false zeichnet die Ausgangsbasis ohne Meldung auf, und gleiche Revisionen erzeugen kein Ereignis. Nur not_found bedeutet Löschung; Berechtigungs-, geschützte-Pfad-, Größen- und Transportfehler beenden die Beobachtung.

Bewahren Sie ungespeicherten UI-Text separat auf. Beobachtung erhält den Entwurf und Bearbeitungssnapshot. Der Aufrufer wählt Neuladen, Zusammenführen oder Speichern ausdrücklich; Speichern prüft die behaltene Revision auf Konflikte. Pfade werden einzeln in Reihenfolge gelesen; diese Beobachtung beruht auf Stichproben, sodass Zwischenänderungen zusammenfallen können. Wählen Sie die genauen Dateipfade zur Abtastung; jedes Ereignis beschreibt einen beobachteten Pfad und seine Revision. Bestehende Einschränkungen für Stammverzeichnis, Dateigröße und geschützte Pfade gelten auf Nur-Lese- und beschreibbaren Servern.

Datei- und Jobbeobachter starten beim ersten next(), holen keine Hintergrundseiten, während der Verbraucher pausiert, und teilen ein Maximum von acht aktiven Beobachtern je Client. Ein next() darf ausstehen; gleichzeitiges Lesen scheitert mit conflict. Break oder return() stoppt ausstehende Lesevorgänge; Projektfreigabe beendet seine Dateibeobachter, und Trennen/erneutes Verbinden/Freigeben invalidiert alle alten Beobachter. AbortSignal beendet die Beobachtung mit cancelled; verspätete Antworten können keine Ergebnisse liefern.

intervalMs liegt bei 250–60000 ms (Standard 1000), angewendet zwischen Dateidurchläufen oder inaktiven Joblesevorgängen. requestTimeoutMs liegt bei 1–30000 ms je Anfrage und verwendet standardmäßig die Clientfrist. Der gesamte timeoutMs liegt bei 1–1800000 ms ab dem ersten next(), einschließlich Verbraucherpausen. Dateien haben standardmäßig keinen Gesamt-Timeout; Jobs standardmäßig 30 Minuten. Fristabläufe melden budget_exceeded und geben den Platz frei. Diese Grenzen werden als WORKSPACE_OBSERVATION_LIMITS exportiert.

Bash
node node_modules/@altifigence/dds-plugin-sdk/examples/workspace-observation/run.mjs

Erwartete Ausgabe: Workspace observation: file changes, retained draft and resumed job verified. Das vollständige Beispiel erstellt einen eigenen temporären Arbeitsbereich und prüft Dateiänderungen, Entwurfskonflikte und ausdrückliche Jobfortsetzung. Siehe Beobachtung für alle Optionen und Lebensdauerregeln.

Jobs beobachten und fortsetzen

client.watchJob() verfolgt einen bestehenden Job mit jobs.events/get; waitForJob() gibt dessen terminalen Snapshot zurück. Das Snippet setzt einen verbundenen Client, eine ausdrücklich gestartete jobId und einen savedCursor (oder undefined) voraus. Prüfen Sie getJobCapabilities() vor dem Jobstart. Beobachtung startet, wiederholt oder beendet den Befehl niemals.

JavaScript
let after = savedCursor ?? 0;
for await (const update of client.watchJob(jobId, {after, intervalMs: 1000})) {
  if (update.dropped) console.log('Expired events:', update.dropped);
  for (const event of update.events) console.log(event.kind, event.data);
  console.log(update.snapshot.state, update.snapshot.progress);
  after = update.nextCursor;
}
const result = await client.waitForJob(jobId, {after, timeoutMs: 120000});
if (result.state === 'succeeded') console.log(result.result);
else console.log(result.state, result.error.code);

Jede eingefrorene Aktualisierung enthält snapshot, events, after, nextCursor, dropped und hasMore. Verarbeiten Sie höchstens 64 Ereignisse je Seite und zeichnen Sie nextCursor nach der Verarbeitung zusammen mit Job-ID und Arbeitsbereichsidentität auf. dropped meldet abgelaufenen Verlauf. Ein Snapshot kann neuer als seine Ereignisseite sein; lesen Sie terminale Snapshots weiter, solange hasMore true ist. Der Iterator endet nach der letzten Seite. waitForJob() verarbeitet dieselben Seiten und gibt succeeded, failed, cancelled oder timed_out zurück; prüfen Sie state, statt jedes erfüllte Promise als Erfolg zu behandeln.

Das Stoppen eines Iterators oder ein Timeout beendet nur die Beobachtung. Der Serverbefehl läuft weiter, bis er endet oder cancelJob() ausdrücklich aufgerufen wird. Prüfen Sie nach einer vom Host genehmigten erneuten Verbindung dieselbe Arbeitsbereichs-ID und Generation und erstellen Sie anschließend einen neuen Beobachter mit gespeicherter Job-ID und Cursor. Alte Beobachter sind ungültig, selbst bei unveränderter Identität. Fehlende/abgelaufene Jobs und Transportfehler werden ohne erneute Übermittlung gemeldet; In-Memory-Jobs überstehen keinen Hostneustart. Dauerhafte Wiederherstellung verwendet recoverJob() mit einer neuen Verbindung; Live-Beobachter werden nicht generationsübergreifend fortgesetzt.

Bestehende v1-hello- und Jobverträge bleiben unverändert. Dateibeobachtung verwendet auf Hosts 0.3.2/0.4/0.5 einen Fallback; Jobbeobachtung erfordert einen aktivierten Host ab 0.4. Prüfen Sie vor der Beobachtung die Jobfähigkeiten des Hosts. Eine Nichtunterstützungsantwort beendet die Anfrage und erhält die ausdrückliche Kontrolle über die Befehlsausführung. Diese Beobachter laufen über eigenständige SDK-Clients und Hosts. Siehe Beobachtung und Kompatibilität.

Dateirevisionen und bedingtes Lesen

SDK 0.6.0 ergänzt getFileCapabilities(), getFileRevision(path) und readFileIfChanged(path, knownRevision) für verbundene Clients. Revisionslesevorgänge geben {path, revision} ohne Inhalt zurück. Ein übereinstimmender bedingter Lesevorgang liefert {path, revision, notModified: true}; geänderter Inhalt liefert notModified: false und content. Übergeben Sie knownRevision: null für den aktuellen Inhalt. Fehlende Dateien werden mit not_found abgelehnt.

JavaScript
let cached = await client.readFile('design.sv');
const current = await client.readFileIfChanged(cached.path, cached.revision);
if (!current.notModified) cached = current;
console.log(cached.content);
const metadata = await client.getFileRevision('design.sv');
console.log(metadata.revision);

Verwenden Sie einen bereits verbundenen, autorisierten Client. Halten Sie ungespeicherte Entwürfe von diesem Cache getrennt. Bedingte Lesevorgänge hashen einen Datei-Snapshot und geben ihn zurück; ein späterer Lesevorgang kann bereits eine weitere Änderung sehen. Speichern Sie mit der Revision, die zum zurückgegebenen Inhalt gehört. Diese Aufrufe aktualisieren keine Bearbeitungssitzungs-Snapshots und führen keine Entwürfe zusammen. Eine unveränderte Antwort hat kein content-Feld; eine leere geänderte Datei hat content: “”.

Dateibeobachtung verwendet bei Unterstützung automatisch reine Revisionslesevorgänge. Die optionalen Methoden fs.capabilities, fs.revision und fs.readIfChanged erhalten das strikte v1-hello und die ursprünglichen Dateimethoden. Bekannte SDK-Arbeitsbereichshosts vor 0.6 verwenden fs.read ohne Probe. Andere Hosts müssen die Erkennung beantworten oder einen korrekt zugeordneten unsupported-Fehler zurückgeben. Jede false-Fähigkeit wählt ihren eigenen begrenzten vollständigen Lese-Fallback; die Antwort alter Server überträgt weiterhin den vollständigen Inhalt.

Fähigkeiten werden nur für die aktuelle Verbindung zwischengespeichert und bei erneuter Verbindung oder Widerruf zurückgesetzt. Ungültige Antworten, Pfad-/Revisionsabweichungen, Berechtigungen, Authentifizierung, Transportfehler und Timeouts lösen keinen Fallback aus. Angekündigte Operationen, die später scheitern, werden nicht stillschweigend herabgestuft. AbortSignal umfasst Erkennung und Lesen; timeoutMs gilt für jede HTTP-Anfrage. Ein Verbindungswechsel invalidiert die alte Operation.

Der Server führt weiterhin für jede Stichprobe einen geschützten vollständigen Dateilesevorgang und eine SHA-256-Berechnung aus. UTF-8-Validierung, die Grenze von 262144 Bytes und Prüfungen geschützter Pfade/Links gelten weiterhin. Dies reduziert Netzwerkantwortbytes und erhält den geschützten Festplattenlesevorgang und die SHA-256-Berechnung je Stichprobe. Eine lokale Windows-Messung mit Node 22.23.1 und 20 unveränderten Stichproben à 200000 Bytes lieferte 4003974 Bytes für vollständiges Lesen, 3867 für Revisionen (99,903 % weniger) und 4247 für bedingtes Lesen (99,894 % weniger). Erkennung ist enthalten; HTTP-Header, TLS und die ursprüngliche hello-/Inhaltsbasis sind ausgeschlossen. Führen Sie npm run benchmark:files in einem Checkout aus, um die Testdaten zu reproduzieren.

Das SDK bietet eine stabile 1.x-API. Bestehende Clients 0.3.2, 0.4, 0.5 und 0.6 behalten auf 0.7-Hosts ihre ursprünglichen APIs. Verwenden Sie diese Revisions-APIs über einen verbundenen eigenständigen SDK-Client. Siehe Dateirevisionen für den vollständigen Vertrag und Migrationsregeln.

Große und binäre Jobergebnisse

SDK 0.7.0 ergänzt eine optionale Erweiterung für binäre Ergebnisdateien. Ein vertrauenswürdiger Befehl registriert eine bestehende Arbeitsbereichsdatei; der Host zeichnet ihr SHA-256 und ihre Länge auf. Clients lesen höchstens 64 KiB je Chunk, und der Node-Downloader setzt eine Teildatei fort und überprüft die vollständige Ausgabe. Die maximal aufgezeichnete Datei ist 1 GiB groß; bestehende APIs für 256-KiB-UTF-8-Dateien und Textartefakte behalten ihre Grenzen.

Aktivieren Sie jobs: true und binaryArtifacts: true auf dem servereigenen Plugin-Host. Beide sind standardmäßig false. Behalten Sie das ausdrückliche Token, den Betreiberhinweis, die geprüfte Plugin-Artefaktbindung und die wirksame Freigabe workspace.read. Folgendes baut auf der obigen Arbeitsbereichseinrichtung auf; Nur-Lese-Arbeitsbereiche dürfen Dateien registrieren, die bereits durch das konfigurierte Werkzeug des Betreibers erzeugt wurden.

JavaScript
const server = await createWorkspaceServer({
  root, workspaceId, token, notice,
  plugins: [{plugin, artifactSha256}],
  grants: ['workspace.read'],
  jobs: true, binaryArtifacts: true, writable: false,
});

Registrieren Sie das Ergebnis in einem mit startCommandJob gestarteten Befehl. Die Registrierung streamt die bestehende Datei mit einem 64-KiB-Puffer durch SHA-256. Die Referenz verweist auf diese Quelldatei, nicht auf eine unveränderliche Kopie. Geschützte Pfade, Traversierung, Links und nicht reguläre Dateien werden abgelehnt; spätere Quelländerungen scheitern mit conflict.

JavaScript
context.registerCommand({id: 'collect', title: 'Collect trace'}, async (_, {job}) => {
  if (!job) throw new Error('Start this command as a job');
  const artifact = await job.addBinaryArtifact({
    id: 'trace', path: 'outputs/trace.fst', label: 'Simulation trace',
  });
  return {artifactId: artifact.id};
});

Verwenden Sie einen bereits verbundenen, autorisierten Client und eine bestehende Job-ID. Das Ziel ist ein absoluter Pfad in einem bestehenden echten, vom Aufrufer kontrollierten Verzeichnis. Der Helfer schreibt destination + “.dds-part” und verweigert das Überschreiben einer bestehenden endgültigen Datei.

JavaScript
import {downloadJobBinaryArtifact} from '@altifigence/dds-plugin-sdk/workspace-node';

const capabilities = await client.getBinaryArtifactCapabilities();
if (!capabilities.enabled) throw new Error('Binary results are not enabled');
const reference = await client.getJobBinaryArtifact(jobId, 'trace');
const receipt = await downloadJobBinaryArtifact(client, reference, {
  destination: absoluteDownloadPath, resume: true,
  signal: abortController.signal,
  onProgress({receivedBytes, totalBytes}) {
    console.log(receivedBytes, totalBytes);
  },
});
console.log(receipt.verified, receipt.revision);

Bewahren Sie die gesamte Referenz {jobId, scope, artifact} auf. Verbinden Sie sich nach einer Unterbrechung ausdrücklich wieder mit derselben Hostgeneration und rufen Sie den Helfer mit dieser Referenz und resume: true erneut auf. Er hasht das gespeicherte Präfix erneut und fordert nur das fehlende Suffix an. Er prüft SHA-256 für jeden Chunk, den gesamten empfangenen Stream und die tatsächliche Staging-Datei vor der Veröffentlichung. Der endgültige Beleg verified: true bestätigt den Abschluss; synchrone Fortschritts-Callbacks bleiben ungeprüft. Beschädigte Teildateien erfordern ausdrückliches Entfernen oder ein neues Ziel.

listJobBinaryArtifacts(jobId) liefert aufgezeichnete binäre Metadaten getrennt von bestehenden Textergebnissen. readJobBinaryArtifactChunk(reference, offset, {length?, signal?, timeoutMs?}) liefert kanonisches Base64 mit Chunk-SHA-256, genauem Bereich und EOF-Markierung. decodeBinaryArtifactData aus /artifacts gibt Uint8Array-Bytes zurück. Browser-Verbraucher müssen den Gesamtdatenhash selbst prüfen; einzelne Chunkprüfungen beweisen nicht, dass die zusammengesetzte Ausgabe mit der Referenz übereinstimmt.

Binär- und Textergebnisse teilen 16 Plätze und einen ID-Namensraum je Job. Binäre Erfassungs-/Leseoperationen sind auf vier je Host/Arbeitsbereich und Node-Downloads auf vier je Prozess begrenzt. timeoutMs für Node-Downloads ist eine Gesamtfrist mit standardmäßig maximal 30 Minuten; requestTimeoutMs beträgt standardmäßig 5 Sekunden mit maximal 30 Sekunden. Veröffentlichung erfordert Hardlink-Unterstützung wie NTFS oder ext4. Verwenden Sie ein vom Aufrufer kontrolliertes Verzeichnis und vertrauenswürdige Schreiber; Dateisystemprüfungen laufen mit den Betriebssystembefugnissen des Hostprozesses.

Optionale artifacts.capabilities, artifacts.list und artifacts.read erhalten bestehende v1-hello-, Job-Snapshot- und Ereignisverträge. Hosts vor 0.7 melden die Erweiterung als deaktiviert; der Client erhält dieses Fähigkeitsergebnis und die ausdrückliche Kontrolle über Lesen und Ausführung. Authentifizierung, fehlerhafte Antworten und Transportfehler bleiben Fehler. Erneute Verbindung, Widerruf, Jobablauf oder eine geänderte Hostgeneration invalidieren alte Operationen. Jobs bleiben 15 Minuten nach dem letzten Ereignis des terminalen Jobs im Speicher erhalten. Abgebrochene Jobs können aufgezeichnete teilweise Werkzeugausgabe hinterlassen; prüfen Sie den terminalen Jobstatus auf Erfolg. Dies beschreibt die standardmäßigen Live-/Quell-APIs. Die separate API für gespeicherte Ergebnisse unten erhält Bytes über Neustarts hinweg.

Führen Sie npm run example:artifacts für eine echte 2-MiB-Übertragung mit Unterbrechung, erneuter Verbindung und reiner Suffixfortsetzung aus; npm run benchmark:artifacts verwendet 8 MiB. Ein lokaler Windows-Lauf übertrug 8388625 Bytes in 129 Chunk-Anfragen, setzte ein 65536-Byte-Präfix fort und prüfte das endgültige SHA-256. Base64 verursacht Mehrbedarf; die JSON-Antwortinhalte umfassten insgesamt 11257419 Bytes. Die Übertragung begrenzt den Speicherbedarf und überprüft die gesamte empfangene Datei. Siehe Binäre Artefakte für den vollständigen Vertrag. Führen Sie die Übertragung über einen eigenständigen SDK-Client und Host aus.

Dauerhafte Jobs, Verlauf und ausdrückliche Wiederholung

SDK 0.8.0 ergänzt optionale dauerhafte Speicher in einem betreibereigenen Verzeichnis außerhalb des Arbeitsbereichs. Geben Sie absolute Pfade, eine stabile Arbeitsbereichs-ID, geprüften Plugin-Code, Paket-SHA-256, Token und Hinweis an. Das Beispiel aktiviert auch erhaltene Dateibytes; lassen Sie artifacts aus jobStorage weg, um nur Jobmetadaten zu speichern. Bestehende v1-Antworten und reine In-Memory-Standardwerte bleiben kompatibel.

JavaScript
import {createNodeJobStore} from '@altifigence/dds-plugin-sdk/job-storage-node';
import {createNodeArtifactStore} from '@altifigence/dds-plugin-sdk/artifact-storage-node';
import {createWorkspaceServer} from '@altifigence/dds-plugin-sdk/workspace-node';
const store = await createNodeJobStore({directory, workspaceRoot: root, workspaceId});
const artifacts = await createNodeArtifactStore({jobStore: store});
const server = await createWorkspaceServer({
  root, workspaceId, token, notice, plugins: [{plugin, artifactSha256}],
  grants: ['workspace.read'], jobs: true, binaryArtifacts: true,
  jobStorage: {store, artifacts},
});

Ein Provider startet erst, nachdem seine anfängliche Absicht gespeichert wurde. Spätere Checkpoints werden zusammengefasst; flushJobStore() wartet auf angeforderte Checkpoints, nicht auf den Befehlsabschluss. Wiederherstellung trennt die aktuelle Verbindung vom ursprünglichen Ausführungsgeltungsbereich und meldet live, completed, interrupted, expired, missing, corrupt oder unsupported. Ein unterbrochener Job startet nie automatisch neu; sein unrecordedTail ist unbekannt.

JavaScript
const capabilities = await client.getJobStorageCapabilities();
const query = {limit: 16, commandId: 'analyze'};
const page = await client.listJobHistory(pluginId, artifactSha256, query);
const prior = await client.recoverJob(pluginId, previousJobId, artifactSha256);
const attempt = await client.retryCommandJob(pluginId, previousJobId,
  reviewedFreshInput, artifactSha256, {jobId: crypto.randomUUID()});

Der Verlauf filtert nach Zustand, Wiederherstellungsstatus, Befehl, Startzeit und übergeordnetem Versuch. Seiten enthalten bis zu 32 Einträge, sortiert nach absteigender Startzeit und dann Job-ID. Ein Cursor friert die Zugehörigkeit für 60 Sekunden ein und muss dieselbe Abfrage verwenden; neue Jobs sind ausgeschlossen, gelöschte oder nicht autorisierte Datensätze werden übersprungen und Ablauf wird gemeldet. Neustarts verlieren Cursor. artifactCount, snapshotCount und resultAvailability beschreiben aufgezeichnete Referenzen, keinen Nachweis aktueller Dateien.

Eine ausdrückliche Wiederholung benötigt eine neue Job-ID, neue validierte Eingaben, dasselbe aktuell genehmigte Paket und einen verfügbaren Befehl. attemptOf verknüpft den neuen Lauf mit seinem unveränderten Vorgänger. Das Wiederholen derselben ID, Eingabe, Vorgängerbindung und desselben Timeouts ruft den behaltenen Versuch ohne erneute Ausführung ab, auch nach Neustart. Fehlende/abgelaufene Datensätze können diese Garantie nicht bieten. Eine akzeptierte Ausführung kann nach Abbruch der wartenden Anfrage weiterlaufen; fragen Sie die neue Job-ID ab, bevor Sie über einen Wiederholungsversuch entscheiden.

Standardmäßige Aufbewahrung lässt rohe Eingaben, Ergebnisinhalte, Fortschrittstext und Artefaktlabels weg; sensible Protokollinhalte werden maskiert. Nur eine ausdrückliche deterministische Hostfunktion zur Maskierung sensibler Inhalte erhält geprüften Text. Tokens, Geheimnisse und alte Einwilligungen werden nie wiederhergestellt. Aktuelle Arbeitsbereichs-/Plugin-Identität, Leseberechtigung und jede aufgezeichnete Freigabe werden erneut geprüft. Jobmetadaten sind standardmäßig auf 256 Datensätze, 64 MiB und 24 Stunden begrenzt, mit maximal sieben Tagen. Entfernen und Bereinigen sind ausdrückliche Hostoperationen.

Der lokale Speicher hat einen Schreiber, validiert Arbeitsbereichs-/Stammidentität und prüft Metadatenintegrität. Ausdrückliche Wiederherstellung veralteter Sperren übernimmt nur eine nachweislich tote PID desselben Rechners. Unbekannte/beschädigte Dateien erfordern Prüfung. Unter Windows unterstützen Dateisynchronisierung und Umbenennung die geprüfte Wiederherstellung nach Prozessende; Persistenz folgt dem Verhalten von Dateisystem und Speichergerät. Siehe Jobspeicherung, Verlauf und das Beispiel für dauerhafte Jobs.

Gespeicherte Ergebnisse und Downloads nach Neustart

Bei aktiviertem Artefaktspeicher kopiert und überprüft await job.addArtifact() oder job.addBinaryArtifact() die gesamte Datei vor der Registrierung. Text bleibt auf 256 KiB begrenzt; Binärdateien sind höchstens 1 GiB groß. Quellstream und tatsächliche Staging-Datei werden per SHA-256 geprüft. Abbruch, volle Datenträger, Änderungen und teilweise Schreibvorgänge veröffentlichen keine nutzbaren Ergebnisse. Vor einem Absturz veröffentlichte, aber nicht vom Job aufgezeichnete Dateien können zur Prüfung durch den Betreiber verbleiben.

JavaScript
import {downloadStoredJobArtifact} from '@altifigence/dds-plugin-sdk/workspace-node';
const list = await client.listStoredJobArtifacts(pluginId, jobId, artifactSha256);
const reference = await client.getStoredJobArtifact(pluginId, jobId, artifactId, artifactSha256);
const receipt = await downloadStoredJobArtifact(client, reference, {
  destination: absoluteOutputPath, resume: true,
});
console.log(receipt.storage, receipt.snapshotId, receipt.verified);

Die Liste trennt Quellreferenzen von Snapshot-Metadaten und meldet retained, expired, missing, corrupt oder unsupported für Snapshots. retained ist ein Metadatenstatus; getStoredJobArtifact() überprüft Metadaten und die gesamte gespeicherte Datei, bevor es eine neue Referenz der aktuellen Generation zurückgibt. Jeder Lesevorgang prüft aktuelle Befugnisse und Dateiidentität erneut. Gelöschte Quellen beeinflussen gespeicherte Bytes nicht; fehlende Snapshots fallen nie auf eine veränderliche Quelle zurück. Rufen Sie für Text-Snapshots client.readStoredJobArtifactText(textReference) auf.

Verbinden Sie sich nach einem Neustart mit aktuellen Freigaben erneut und holen Sie eine neue Referenz. Snapshot-ID, Speicher-ID und Digest bleiben stabil; die alte Generation wird abgelehnt. resume: true prüft ein gespeichertes .dds-part-Präfix erneut gegen diesen Snapshot, verifiziert Chunks und die vollständige Staging-Datei und veröffentlicht ohne Überschreiben des Ziels. Lesen benötigt sowohl behaltene Jobmetadaten als auch Dateibytes. Browser-Chunk-Verbraucher müssen den vollständigen Digest überprüfen; der Worker-Adapter unten bietet ausdrückliche Browser-Festplattenfortsetzung.

Artefaktspeicherung ist standardmäßig auf 256 Dateien, 256 MiB und 24 Stunden begrenzt, mit maximal 4 GiB Gesamtspeicher und sieben Tagen Aufbewahrung. Chunks umfassen höchstens 64 KiB bei vier gleichzeitigen Lesevorgängen. inspect() meldet Nutzung, Ablaufzeiten, ungültige Einträge und verwaiste Dateien. remove(snapshot) und prune() sind ausdrückliche Betreiberoperationen. Aktive Jobs und einzelne Lesevorgänge werden festgehalten; Ablauf oder Entfernen zwischen Chunks kann den nächsten Lesevorgang stoppen. Optionale Bereinigung verwaister Dateien entfernt nur erkannte Dateien mit einem Link. Beschädigte oder mehrdeutige Einträge müssen geprüft werden.

Dateiaufbewahrung speichert tatsächliche Projektbytes unabhängig von Maskierung sensibler Protokollinhalte. Wählen Sie sie bewusst. Aktuelles Plugin/aktueller Befehl, Pakethash, Arbeitsbereich und aufgezeichnete Freigaben bleiben nach Neustart erforderlich. Schließen Sie die Wartung ab und warten Sie dann auf server.close(), artifacts.close() und store.close() in dieser Reihenfolge. Konfigurieren und verwenden Sie Dateiaufbewahrung auf dem eigenständigen SDK-Host.

Führen Sie npm run example:stored-artifacts für einen echten Kindprozessneustart, Quelllöschung, überprüfte Teildownloadfortsetzung, Verlauf und ausdrückliche Wiederholung aus. npm run example:durable-jobs deckt auch erzwungenes Prozessende ab. Siehe Gespeicherte Ergebnisse. Bekannte Hosts 0.7 und früher melden Speicher als deaktiviert ohne unbekannte Probeaufrufe. Bestehende Live-/Quell-APIs behalten ihr ursprüngliches Verhalten.

Ein Projekt beobachten

Der Betreiber aktiviert Projekte ausdrücklich und wählt auf dem Server erlaubte Stammverzeichnisse. Standardmäßig ist dies deaktiviert. Bekannte SDK-Hosts 0.3–0.8 melden Nichtverfügbarkeit ohne neue Erkennungsprobe. Das unterstützte Profil verwendet lokale Windows-/Linux-Dateisysteme. Führen Sie dieses Beispiel über die eigenständigen SDK-Projekt-APIs aus.

import {createWorkspaceServer} from '@altifigence/dds-plugin-sdk/workspace-node';
import {createWorkspaceClient, createWorkspaceProject} from '@altifigence/dds-plugin-sdk/workspace-client';
// The operator chooses the workspace and its allowed local directories.
const server = await createWorkspaceServer({
  root: operatorWorkspace, workspaceId, token, notice,
  projects: {roots: ['rtl'], fileSystem: 'local'},
});
const client = createWorkspaceClient({url: server.url, token});
await client.connect();
const project = createWorkspaceProject(client);
if (!(await project.getProjectCapabilities()).enabled) {
  throw new Error('Project tools are unavailable');
}
const observer = project.watchProject({
  root: 'rtl', include: ['**/*.sv'], exclude: ['build/**'],
  intervalMs: 1000, debounceMs: 50,
}, {signal});
for await (const event of observer) {
  renderExternalView(event.snapshot, event.kind, event.reason);
}
project.dispose(); client.dispose(); await server.close();

Das erste Ereignis ist ein vollständiger Snapshot. Spätere Änderungen enthalten Deltas gegen eine vorherige Revision; verlorene Hinweise, Änderungen während des anfänglichen Scans, unvollständige Scans und Überlauf bei langsamen Verbrauchern erzeugen eine vollständige Neusynchronisierungsansicht mit Grund. Umbenennungen können als Löschen/Erstellen erscheinen. Jede Datei wird zu ihrem Beobachtungszeitpunkt separat überprüft; die Ansicht kombiniert diese Stichproben, und zwischenzeitliche Schreibvorgänge können zusammenfallen.

Server und Client erlauben jeweils vier Abonnements mit vier Ereignissen in der Warteschlange je nativem Abonnement. Die standardmäßige Leerlauf-Lease beträgt 30 Sekunden; ein späterer Lesevorgang kann not_found liefern. Erstellen Sie nach längerer Pause einen neuen Iterator für einen anfänglichen Snapshot. break/return, Abbruch und Freigeben lösen Abonnements; verhindert eine gestörte Verbindung die Bereinigung, laufen übrige entfernte Ressourcen mit ihrer Lease ab.

Standardmäßige Scangrenzen sind Tiefe 8, 512 Einträge, 1 MiB je Datei, 16 MiB insgesamt und 10 Sekunden. Konfigurierbare Maxima sind Tiefe 32, 1000 Einträge, 16 MiB je Datei, 64 MiB insgesamt und 30 Sekunden. Begrenzte Dateien können Metadaten ohne Inhaltshash enthalten; prüfen Sie complete und reasons. Fristen werden zwischen Dateisystemaufrufen geprüft; wählen Sie die Betriebssystemzugriffsrechte des Hostprozesses für diese Aufrufe bewusst.

Projektbaum und Suche

listTree liefert einen Baum, searchFiles sucht relative Dateinamen nach wörtlicher Teilzeichenfolge oder begrenztem Glob, und searchText findet wörtlichen Text in UTF-8-Dateien. root ist erforderlich; include/exclude beziehen sich darauf. Verwenden Sie literalen Text und die dokumentierte begrenzte Dateinamen-Globsyntax als Suchmuster. Suche ohne Beachtung der Groß-/Kleinschreibung vereinheitlicht nur ASCII A–Z, damit ursprüngliche UTF-16-Positionen stabil bleiben.

const tree = await project.listTree({root: 'rtl', pageSize: 16});
const names = await project.searchFiles({root: 'rtl', query: '**/*.sv', mode: 'glob'});
const query = {root: 'rtl', include: ['**/*.sv'], query: 'module ', pageSize: 16};
let page = await project.searchText(query);
for (const item of page.items) {
  console.log(item.entry.path, item.entry.revision, item.match.range, item.match.snippet);
}
if (page.nextCursor) {
  const next = await project.searchText({...query, cursor: page.nextCursor});
  console.log(next.stale, next.items.map(item => item.state));
  if (next.nextCursor) await project.releaseProjectQuery(next.nextCursor);
}
if (tree.nextCursor) await project.releaseProjectQuery(tree.nextCursor);
if (names.nextCursor) await project.releaseProjectQuery(names.nextCursor);

Texttreffer enthalten ein Inhalts-SHA-256, einen bei null beginnenden UTF-16-Bereich und ein begrenztes Snippet. Ein Cursor friert die ursprüngliche Zugehörigkeit für höchstens 60 Sekunden ein und erfordert dieselbe Abfrage. Spätere Seiten prüfen aktuellen Inhalt erneut und markieren Einträge als current, changed, missing oder unverified; neue Dateien erscheinen nur in einer neuen Abfrage. Der erfasste Treffer und die Revision bleiben unverändert.

Textdateien sind auf 256 KiB, Abfragen auf 256 UTF-16-Einheiten und Snippets auf 512 Einheiten begrenzt. Standardwerte sind 256 Ergebnisse (Maximum 512), 32 Einträge je Seite (Maximum 64) und eine 64-KiB-Antwort (Maximum 128 KiB). Binärdateien, ungültiges UTF-8 sowie Byte-/Tiefen-/Zeit-/Antwortgrenzen werden als unvollständige Ergebnisse mit Gründen gemeldet. Es gibt zwei gleichzeitige Abfragen und acht behaltene Cursoransichten; geben Sie ungenutzte Cursor ausdrücklich frei.

Projektentwürfe und erneute Verbindung

const edit = await project.openFile('rtl/counter.sv');
const original = edit.snapshot;
const draft = original.content + '\n// unsaved draft';
const query = {root: 'rtl', include: ['**/*.sv'], query: 'module '};
let page = await project.searchText(query);
for await (const event of project.watchProject({root: 'rtl', include: query.include}, {signal})) {
  if (event.snapshot.revision !== page.snapshotRevision) {
    if (page.nextCursor) await project.releaseProjectQuery(page.nextCursor);
    page = await project.searchText(query); // keep the same explicit scope
  }
  renderTreeAndMatches(event.snapshot, page); // draft remains caller-owned
}
// A changed file causes conflict; a move/deletion can cause not_found.
try { await edit.save(draft); }
catch (error) {
  if (!['conflict', 'not_found'].includes(error.code)) throw error;
  showResolutionChoice(error, draft, original);
}
// Only an explicit edit.reload() replaces the edit snapshot.
project.dispose(); client.disconnect(); await client.connect();
const freshProject = createWorkspaceProject(client);
const freshObserver = freshProject.watchProject({root: 'rtl'});
console.log((await freshObserver.next()).value.cursor); // 1: full initial view
await freshObserver.return(); freshProject.dispose();

Wenn snapshotRevision einer Abfrage vom beobachteten snapshot.revision abweicht, geben Sie den alten Cursor frei und wiederholen Sie dieselbe root-/Filterabfrage. Beobachtung verändert nie edit.snapshot oder den dem Aufrufer gehörenden Entwurfsinhalt. Nach externer Änderung, Verschieben oder Löschung meldet die ursprüngliche CAS-Bedingung einen Konflikt; der Aufrufer entscheidet sich ausdrücklich für Neuladen, Zusammenführen oder separates Speichern.

Der Client prüft Verbindungsgeneration, root/Filter, Abfragehash, Seitenpositionen, Snapshot-SHA-256 und Ereigniskontinuität. Verspätete Antworten werden nach Widerruf, Trennen oder erneuter Verbindung verworfen. Beobachtungs- und Abfragecursor sind getrennt und werden nicht automatisch wiederhergestellt. server.revokeProjects() beendet Projektzugriff; erneute Aktivierung erfordert eine neue Servergeneration.

npm run example:project-watch
npm run example:project-query
npm run example:project-tools
npm run example:project-browser

Installierte Node-Beispiele überprüfen Erstellung, Suche, externe Änderungen, behaltene Entwürfe, CAS-Konflikte und erneute Verbindung. Öffnen Sie für das Browserbeispiel die ausgegebene Loopback-URL und wählen Sie Szenario ausführen. Es verwendet nur seinen temporären Arbeitsbereich, der beim Stoppen des Beispielservers entfernt wird. HTTP-Anfragen haben standardmäßig fünf Sekunden Zeit; konfigurieren Sie Client- und Server-Timeouts für größere Scans bewusst.

Projektbeobachtung · Verträge für Baum/Suche · HTTP-Projektwerkzeuge

Browser-Artefakte streamen und überprüfen

import {streamStoredJobArtifact} from '@altifigence/dds-plugin-sdk/artifact-transfer';
import {createOpfsFileSink} from '@altifigence/dds-plugin-sdk/artifact-transfer-browser';
// selectedDirectory belongs to the application; no picker or grant is opened by the SDK.
const reference = await client.getStoredJobArtifact(pluginId, jobId, artifactId, pluginPin);
const sink = await createOpfsFileSink(selectedDirectory, 'trace.bin', {overwrite: false});
const receipt = await streamStoredJobArtifact(client, reference, {sink, signal});
if (receipt.verification === 'stored') showSavedHash(receipt.storedSha256);

Der browsersichere Helfer empfängt jeweils höchstens einen 64-KiB-Chunk, wartet auf die ausgewählte Senke und hasht die gesamte Datei schrittweise. Er validiert vor dem Schreiben genaue Bereiche, Identität, Base64 und jeden Chunkhash. Eine Rücklesesenke liest gespeicherte Bytes anschließend unabhängig erneut; verification ist erst stored, wenn beide Gesamthashes übereinstimmen. Ohne Rücklesen ist verification received und storedSha256 null. Ein Fortschritt über alle Bytes bedeutet keinen Abschluss.

Die Anwendung wählt Dateihandles oder OPFS-Verzeichnisse und erteilt erforderliche Berechtigungen. Übergeben Sie das ausdrücklich gewählte Ziel und den genehmigten Zugriff an den SDK-Adapter; Auswahl und Berechtigungen verwaltet die Anwendung. Die asynchronen beschreibbaren Datei-/OPFS-Senken behalten Staging bis close und verwerfen es bei Fehlern vor dem Commit. Für über Neuladen hinweg sichere Teildateien verwenden Sie den speziellen Worker-Adapter unten. Dateigrenzen sind 1 GiB, vier direkte gleichzeitige Streams und eine Gesamtfrist von 30 Minuten.

Ausgewählte Dateien hochladen

import {uploadFile} from '@altifigence/dds-plugin-sdk/uploads';
import {createBrowserUploadSource} from '@altifigence/dds-plugin-sdk/uploads-browser';
// The operator separately configures uploads.directory/principalId/roots/fileSystem
// on the Node workspace server, and grants workspace.write to this pinned plugin.
const source = createBrowserUploadSource(selectedFile);
const status = await uploadFile(client, source, {
  uploadId: crypto.randomUUID(), pluginId, artifactSha256: pluginPin,
  path: 'input/trace.bin', expectedRevision: null, signal,
});
if (status.state === 'committed' && status.commitReceipt.verified) {
  showCommittedUpload(status.commitReceipt);
}
// To recover a previously selected upload ID, pass the same specification and
// source with recover: true. The helper queries current authority and rehashes it.

Uploads sind standardmäßig deaktiviert. Der Betreiber konfiguriert einen lokalen Node-Arbeitsbereich, ein isoliertes Staging-Verzeichnis, erlaubte Stammverzeichnisse und einen Principal und erteilt dann dem ausgewählten Plugin workspace.write mit genau festgelegtem Archiv. Der Helfer hasht die ausgewählte Quelle vor dem Beginn. Der Server akzeptiert sequenzielle 64-KiB-Chunks, prüft Duplikate und vollständigen Inhalt und schreibt erst nach bedingten Zielprüfungen fest. Keine Staging-Bytes erscheinen in normalen Arbeitsbereichsauflistungen.

expectedRevision: null erfordert ein fehlendes Ziel; ein SHA-256 erfordert das passende aktuelle Ziel. Abbruch erhält das bestätigte Serverpräfix. Eine neue ausdrückliche recover-Operation fragt aktuelle Befugnisse ab, validiert dieselbe Quelle/Spezifikation und setzt nur das passende Präfix fort. Eine verlorene Commit-Antwort ist bis zur Abfrage ungewiss; sie erlaubt weder erneutes Commit noch Zurückrollen einer Datei. Maximalgrenzen sind 1 GiB je Datei, 4 GiB je Speicher und vier aktive Sitzungen; Standardwerte sind niedriger. Bekannte Hosts 0.3–0.9 melden Uploads als deaktiviert ohne Probe neuer Methoden.

Dateiübertragungen planen

import {createTransferQueue} from '@altifigence/dds-plugin-sdk/transfer-queue';
const queue = createTransferQueue({
  concurrency: 2, perConnection: 1, bufferBytes: 131072,
  bytesPerSecond: 1048576, attempts: 3,
});
const unsubscribe = queue.subscribe(view => renderTransfer(view));
const download = queue.enqueueStoredDownload(client, reference, {sink});
download.pause(); // finishes the current stage, then waits at the next boundary
download.resume();
const receipt = await download.result;
queue.release(download.id);
unsubscribe(); await queue.dispose();

Eine aufrufereigene Warteschlange mischt Upload-, Live-Download- und gespeicherte Downloadjobs. Sie begrenzt behaltene Jobs (32), gleichzeitige Phasen (4), Client-Verbindungsparallelität, Reservierungen für dekodierte Chunks (64–256 KiB), Rate und Wiederholungen. Ausführbare Arbeit schreitet an einer ausgelasteten Verbindung vorbei fort, und begrenzte Prioritätsvorsprünge verhindern das Verhungern kleiner ausführbarer Jobs. Ein pausierter Job beendet seine aktuelle Phase und wartet dann; die Pause kann eine Speichersperre behalten. Gesamtfristen enthalten Warteschlangenzeit und Pause.

Automatische Wiederholung ist auf vom SDK erkannte 429/503, Netzwerkausfall oder Anfrage-Timeout während einer idempotenten exakten Chunkoperation beschränkt, mit begrenztem Backoff und Jitter. Begin/commit sowie Autorisierungs-, Prüfsummen-, Bereichs-, Quell- oder Senkenfehler geben die Kontrolle zur ausdrücklichen Prüfung an den Aufrufer zurück. acknowledgedBytes, transferredBytes, attemptedBytes, retriedBytes, resumedBytes und remainingBytes sind getrennt; nur ein überprüfter Beleg liefert completed. Eine bereits festgeschriebene Datei bleibt nach cancel/dispose festgeschrieben.

Browser-Downloads fortsetzen

// Run inside an application-owned dedicated Worker with OPFS + Web Locks.
import {createOpfsArtifactSink} from '@altifigence/dds-plugin-sdk/artifact-resume-browser';
import {streamStoredJobArtifact} from '@altifigence/dds-plugin-sdk/artifact-transfer';
await client.connect();
const fresh = await client.getStoredJobArtifact(pluginId, jobId, artifactId, pluginPin);
const sink = createOpfsArtifactSink({
  directory: selectedDirectory, partialId: selectedPartialId, reference: fresh,
});
const receipt = await streamStoredJobArtifact(client, fresh, {sink, resume: true, signal});
console.log(receipt.resumedBytes, receipt.receivedBytes, receipt.storedSha256);
// The first transfer omits resume, and refuses any existing files for that ID.
// A queue can use the same sink and explicit resume: true on a new stored download.

Dauerhafte Wiederherstellung erfordert einen dedizierten Worker, synchronen OPFS-Zugriff und Web Locks. Der Aufrufer wählt sein Verzeichnis und die Teil-UUID nach Neuladen erneut und erhält eine frisch genehmigte gespeicherte Referenz. Die Senke speichert zwei genaue Daten-/Metadaten-Dateinamen, die vollständige unveränderliche Snapshot-Identität, Ablaufzeit und aktuelle/vorherige Präfixhashes. Sie speichert weder Token noch Freigaben oder alten Verbindungsgeltungsbereich. Jeder Datenchunk wird geflusht, bevor der kleine Metadatenstream geschlossen wird.

Senke und Helfer hashen das Präfix jeweils unabhängig erneut. Ein nicht per Checkpoint erfasster Rest wird erst abgeschnitten, nachdem das aufgezeichnete Präfix übereinstimmt. Metadaten jenseits der tatsächlichen Dateigröße dürfen nur dann auf den vorherigen Checkpoint zurückfallen, wenn diese Bytes und der Hash passen; Beschädigung, fehlende Einträge, Ablauf oder ein anderer Snapshot scheitern ohne stillschweigenden Neustart. Eine ursprungsweite exklusive Sperre lehnt einen weiteren Tab ab, bleibt während des Rücklesens gehalten und wird bei close oder Worker-Ende freigegeben. Erneutes Öffnen erfordert dann ausdrückliche Wiederherstellung.

Lokale Metadaten sind auf 16 KiB und vier offene Senkensitzungen begrenzt. Aufbewahrung beträgt standardmäßig eine Stunde mit maximal 24 Stunden, begrenzt durch den Ablauf des Host-Snapshots. Der Browser verwaltet Speicherquota und Verdrängung; Skripte desselben Ursprungs teilen die Speicherzugriffsrechte. Wiederherstellung verwendet die aufgezeichneten Checkpoints unter diesen Speicherregeln. Chromium 154 auf Windows wurde für Abbruch, Neuladen, Hostneustart, Zwei-Tab-Konflikt und Beenden des Besitzer-Tabs mit vollständigen Hashes gespeicherter Dateien geprüft. Die berichteten Prüfungen gelten für diese Browser- und Betriebssystemkombination.

npm run example:browser-artifacts
npm run example:uploads-browser
npm run example:transfer-queue-browser
npm run example:browser-resume

Streaming · Uploads · Übertragungswarteschlange · Worker-Wiederherstellung

Signaturhilfe und Vervollständigungsunterstützung

Deklarieren Sie signature-help, completion-resolve und completion-snippets nach Bedarf in Manifest v2; Vervollständigungsmodifikatoren erfordern auch completion. Der Host muss document.read und language.provide erteilen. Bestehende wörtliche Vervollständigungen bleiben gültig. languageCapabilities() meldet die SDK-Implementierung und ihre Grenzen, ohne Berechtigungen zu erteilen.

const signatures = await host.requestLanguage('signature-help', {
  position, context: {triggerKind: 'invoked', isRetrigger: false},
});
const list = await host.requestLanguage('completion', {position});
if (list.data.length) {
  const detailed = list.data[0].resolveToken
    ? await host.resolveCompletion(list.data[0].resolveToken) : list;
  const preview = host.prepareCompletion(detailed, 0);
  showInsertionPreview(preview.content, preview.tabstops);
  host.releaseCompletion(detailed);
}
host.releaseCompletion(list);

Die Anwendung liefert aktuelle Position und Host; Vorbereitung gibt Daten zurück, ohne ein Dokument oder eine Datei zu schreiben. Signaturhilfe unterstützt bis zu 16 Signaturen mit je 64 Parametern und UTF-16-Offsets für Parameterlabels. Vervollständigungsauflösung hält Providerdaten privat, liefert ein einmal nutzbares Hosttoken und fixiert gewähltes Label/Einfügung/Bereich. Tokens binden Provider, Geltungsbereich und Dokument, laufen nach 60 Sekunden ab und sind auf 128 Einträge, 4 MiB und vier tatsächliche Resolveroperationen begrenzt. Dokument-/Provideränderungen verwerfen sie.

Snippets unterstützen $n, ${n}, ${n:literal}, $0 und dokumentierte Escape-Sequenzen mit Spiegelungen und geordneten Tabstopps. Variablen, Verschachtelung, Auswahlmöglichkeiten, Transformationen und ausführbare Befehle werden abgelehnt. UTF-16-/CRLF-Grenzen und überlappende zusätzliche Änderungen werden geprüft. Provider laufen als vertrauenswürdiger Code mit den Betriebssystembefugnissen des Hostprozesses; ein Provider, der einen Abbruch ignoriert, belegt seinen tatsächlichen Platz bis zum Abschluss.

Geprüfte Arbeitsbereichsbearbeitungen und Umbenennung

prepare-rename liefert einen validierten Bereich/Platzhalter oder null; rename liefert einen WorkspaceEdit-Vorschlag oder null. Vorschläge unterstützen edit, create, move und delete über disjunkte relative Dateipfade. Aktuelles Quell-SHA-256, Abwesenheit des Ziels, Richtlinie für geschützte Pfade, UTF-16-Bearbeitungsgeometrie und Grenzen werden geprüft. Sprachfähigkeiten autorisieren Vorschläge; der Arbeitsbereichsclient stellt separat genehmigten Dateizugriff und Änderungen bereit.

import {previewWorkspaceEdit, applyWorkspaceEdit, recoverWorkspaceEdit}
  from '@altifigence/dds-plugin-sdk/workspace-edits';
const preview = await previewWorkspaceEdit(client, proposal);
// Show every change, conflict and required capability; obtain this exact review.
const receipt = await applyWorkspaceEdit(client, preview, {
  reviewed: approvedReview, // {planId, digest} from that review
  journal,
  authorize: (request, {signal}) => currentHostPolicy(request, signal),
});
// After interruption, current-authority readback does not replay changes.
const observed = await recoverWorkspaceEdit(client, journal, preview.planId);

Der Aufrufer verwendet einen verbundenen autorisierten Arbeitsbereichsclient und ein vertrauenswürdiges Journal. Preview enthält vollständige Vorher-/Nachher-Snapshots und einen Digest; apply erfordert die geprüfte planId/den Digest und eine aktuelle Hostrichtlinie, die true liefert. Jede Datei wird vorgeprüft; danach verwendet jede Operation bestehendes dateiweises CAS und aktuelle Schreib-/Verwaltungsfähigkeiten. Das Journal speichert und liest vor jeder Änderung die Absicht und danach einen Beleg zurück. Ein Konflikt oder Ungewissheit stoppt weitere Schreibvorgänge; jede Datei wird durch ihre eigene CAS-Operation festgeschrieben, sodass ein unterbrochener Plan bereits festgeschriebene Dateien enthalten kann.

Der optionale workspace-edits-node-Adapter speichert ein begrenztes Journal außerhalb des ausgewählten Arbeitsbereichs, bindet dessen Identität und verwendet eine Ein-Schreiber-Sperre, reguläre Dateien und Prüfsummen-Checkpoints. Nach Prozessende ist recoverStaleLock eine ausdrückliche Wahl und übernimmt nur einen nachweislich toten Besitzer. Wiederherstellung meldet applied/not-applied/conflicted/unknown anhand aktueller Bytes und überlässt die nächste Aktion dem Aufrufer. Kompensation erstellt einen neuen inversen Vorschlag für erneute Prüfung. Unter Windows synchronisiert der Adapter Dateien und führt Umbenennungen durch; die berichteten Beständigkeitsprüfungen betreffen Prozessende und Wiederherstellung. Persistenz folgt dem Verhalten von Dateisystem und Speichergerät. Grenzen sind 32 Änderungen, 1000 Bearbeitungen, 256 KiB je Datei, eine 8-MiB-Vorschau und 64 behaltene Journalpläne.

Formatierung und diagnostische Codeaktionen

const formatted = await host.requestLanguage('format-range', {
  path: 'main.dds', range: selectedRange,
  formatOptions: {tabSize: 2, insertSpaces: true, endOfLine: 'preserve'},
});
const formatProposal = host.prepareFormatting(formatted);
await host.requestDiagnostics();
const actions = await host.requestLanguage('code-actions', {
  path: 'main.dds', range: selectedRange,
  context: {triggerKind: 'invoked', only: ['quickfix']},
});
if (actions.data.length && !actions.data[0].disabled) {
  const selected = actions.data[0].resolveToken
    ? await host.resolveCodeAction(actions.data[0].resolveToken) : actions;
  if (!selected.data[0].disabled) {
    const fixProposal = host.prepareCodeAction(selected, 0);
    showWorkspaceEditProposal(fixProposal); // separate preview, review and apply
  }
  host.releaseCodeActions(selected);
}
host.releaseCodeActions(actions);

format-document und format-range erfordern einen Pfad und Optionen tabSize/insertSpaces; nur Bereichsformatierung nimmt eine Auswahl an. Ein Ergebnis ist null oder genau eine Änderung der aktuellen Datei mit dem aktuellen Snapshot-Hash. Bereichsänderungen bleiben innerhalb der Auswahl. endOfLine wählt preserve, lf oder crlf für eingefügten Text; unbearbeitete Bytes bleiben unverändert. Inhaltsgleiche Vorschläge werden zu null normalisiert. prepareFormatting schreibt nichts.

Der Host bindet Aktionsanfragen und Resolve-Tokens an die akzeptierte Diagnoserevision und den aktuellen Snapshot. Spätere Diagnoseveröffentlichung, Dokumentänderung oder Providerfreigabe invalidiert alte Auswahlen. Diagnoseaufrufe in abweichender Reihenfolge überschreiben nicht das neuere akzeptierte Bündel. Bis zu 100 Aktionen tragen Klartextlabels, begrenzte Diagnoseindizes, vorgeschlagene Änderungen, private Resolve-Daten oder einen Deaktivierungsgrund. Unbekannte command-/URL-/shell-Felder werden abgelehnt. Aktionsänderungen können über die Auswahl hinausgehen; prüfen Sie deshalb den vollständigen Vorschlag. Formatierung und Aktionen genehmigen nie ihre eigenen Schreibvorgänge.

Semantische Anzeige, Faltung, Hinweise und Symbole

import {decodeSemanticTokens} from '@altifigence/dds-plugin-sdk';
const tokens = await host.requestLanguage('semantic-tokens',
  previousResultId ? {previousResultId} : {});
host.validateLanguageResult(tokens); // actual current host-owned result only
renderWhitelistedTokens(decodeSemanticTokens(tokens.data, currentDocumentText));
const folds = await host.requestLanguage('folding-ranges', {});
const hints = await host.requestLanguage('inlay-hints', {range: visibleRange});
const symbols = await host.requestLanguage('document-symbol-tree', {});
for (const result of [folds, hints, symbols]) host.validateLanguageResult(result);
// Render labels as text nodes. Release results when no longer retained.
host.releaseLanguageResult(tokens);

Semantische Tokens verwenden eine Legende mit eindeutigen Namen und neun hosteigenen Stilschlüsseln sowie fünf Ganzzahlen je Token: Delta für Zeile/Start, UTF-16-Länge, Typindex und Modifikatorbits. Tokens dürfen sich nicht überlappen, ein Surrogat trennen, eine Zeile überschreiten oder das aktuelle Dokument verlassen. Der Host liefert immer ein vollständiges normalisiertes Array und eine Host-UUID mit updateKind full/delta/fallback. Eine separate semantic-tokens-delta-Fähigkeit ermöglicht provideDelta gegen providereigene frühere Daten; der Cache speichert Identität und Tokendaten, keinen alten Dokumenttext.

Eine Cachebasis ist an Provider, Geltungsbereich, URI und Sprache gebunden, mit höchstens acht Einträgen, 4 MiB und 60 Sekunden. Normal ansteigende Dokumentversionen erhalten eine mögliche Deltabasis, während sie das alte Anzeigeergebnis veralten lassen. Eine verlorene/abgelaufene Basis, null-Delta oder nicht passende Providerbasis-ID erlaubt höchstens einen vollständigen Fallback innerhalb des ursprünglichen Timeouts. Ungültige Daten oder Providerfehler scheitern ohne Wiederholung. Deaktivieren, Abmelden und Dokumentersatz löschen betroffene Basen. Rufen Sie validateLanguageResult unmittelbar vor dem Rendern auf; ein kopiertes, freigegebenes oder veraltetes Objekt scheitert.

Grenzen sind 20000 semantische Tokens, 64 Tokentypen, 16 Modifikatoren und 64 Deltaänderungen; Faltung erlaubt 1000 Bereiche mit Tiefe 32 und lehnt sich kreuzende Bereiche ab. Inlay-Hinweise erlauben 1000 einzeilige Klartextlabels innerhalb des angeforderten Bereichs. Hierarchische Symbole erlauben insgesamt 1000 Einträge und 16 Ebenen mit enthaltenen Kindern/Auswahlen und geordneten nicht überlappenden Geschwistern. Der ursprüngliche flache document-symbols-Vertrag bleibt unverändert. Das Browserbeispiel prüft full/delta/fallback, Faltung, Navigation und Lebenszyklus; ein HTML-artiger Hinweis bleibt wörtlicher Text.

npm run example:assistance
npm run example:workspace-edits
npm run example:language-editing
npm run example:language-display
npm run example:language-display-browser

Unterstützung · Geprüfte Änderungen · Formatierung/Aktionen · Anzeige

Typisierte Einstellungen und Geheimnisreferenzen

Das Modul /settings bietet einen betreibereigenen In-Memory-Speicher für ein Plugin. Eine versionierte Definition deklariert jeden Schlüssel, Datenschema, Standardwert, erlaubte Benutzer-/Arbeitsbereichsgeltungsbereiche und Anzeigemetadaten. Wirksame Werte ersetzen jeden ganzen Schlüssel in der Reihenfolge default < user < workspace. read(workspaceId) liefert unveränderliche Werte, Quellen und eine speicherweite Revision. Verschachtelte Objekte werden nicht rekursiv zusammengeführt; ein fehlender Wert ohne Standardwert bleibt abwesend.

import {createSettingsStore} from '@altifigence/dds-plugin-sdk/settings';
const settings = createSettingsStore({schemaVersion: 1, pluginId: 'example',
  version: 1, settings: {count: {
    schema: {schemaVersion: 1, schema: {
      type: 'integer', minimum: 1, maximum: 10, default: 2,
    }}, scopes: ['user', 'workspace'], display: {label: 'Count'},
  }},
});
settings.update({workspaceId: 'selected-project', scope: 'workspace',
  expectedRevision: settings.read('selected-project').revision, values: {count: 4}});
const effective = settings.read('selected-project');
// Mount as createPluginHost({settings: {example: settings}, ...}).

Schreibvorgänge validieren die vollständige Transaktion und verwenden expectedRevision-CAS. reset entfernt einen Schlüssel aus einer Ebene; readOnly erfordert einen Standardwert und keine beschreibbaren Geltungsbereiche. Abonnements fassen synchrone Änderungen zusammen und liefern freigebbare Handles. Ausdrückliches migrate(nextDefinition, callback, options) validiert den nächsten Zustand und schreibt nur fest, wenn dessen Revision noch passt. Fehler, Abbruch oder Timeout erhalten alte Definition und Zustand. Export/Import sind reine Daten; der Betreiber verantwortet Persistenz und Verschlüsselung. Grenzen umfassen 64 Schlüssel, 32 Arbeitsbereichsebenen, 1 MiB exportierten Zustand und eine tatsächliche Migration.

Arbeitsbereichsplugins deklarieren settings und settings.read, und der Betreiber bindet den passenden Speicher mit dieser Freigabe ein. context.settings ist schreibgeschützt und an Plugin und ausgewählten Arbeitsbereich gebunden. Der /secrets-Resolver stellt separat opake Referenzen für ein Plugin, einen Arbeitsbereich, eine Befehls-Erlaubnisliste und eine Lebensdauer aus. Das Manifest muss secrets.resolve deklarieren, und der Host muss es erteilen. Eingabefelder verwenden type: object mit format: dds-secret-reference; normale Zeichenfolgen und ähnlich aussehende Objekte vermitteln keine Geheimnisbefugnis.

Nur Referenzen in validierter Eingabe sind über options.secrets.withSecret eines Befehls verfügbar. Jede Ausführung hat eine neue ID; der Resolver prüft Geltungsbereich, Ablauf, Widerruf und aktuelle Autorisierung rund um Auflösung und Callback. Der Callback liefert undefined und erhält eine Kopie, die bei Abbruch und jedem Verlassen gelöscht wird. Providerfehler werden bereinigt. Platzieren Sie die Lease vor Wirkungen, die diese Befugnis benötigen. Die Standardlebensdauer einer Referenz beträgt 60 Sekunden, höchstens eine Stunde; Grenzen sind 128 Referenzen, 8 tatsächliche Leases und 16 KiB Material. Vertrauenswürdiger prozessinterner Code läuft mit den Betriebssystembefugnissen des Hostprozesses und kann Kopien behalten. Legen Sie Material nie in Einstellungen, Bündeln, Protokollen oder Ergebnissen ab; klassifizieren Sie beliebige Anwendungszeichenfolgen beim Umgang mit sensiblen Daten ausdrücklich.

Strukturierte Befehlsschemas und Formulare

Befehle dürfen inputSchema und outputSchema in einem schemaVersion: 1-Umschlag deklarieren. Bestehende primitive Parameter bleiben unterstützt; die gemeinsame Deklaration von parameters und inputSchema wird abgelehnt. Der Host validiert Eingaben und wendet Standardwerte an, bevor er einen Handler oder Job startet, und validiert anschließend die Ausgabe vor der Erfolgsveröffentlichung. Ausgabestandardwerte werden nie angewendet. Neue Schema-/Anzeigemetadaten erfordern einen 0.12-kompatiblen Peer; ältere strikte Validatoren lehnen sie ab, während alte Definitionen ihr Verhalten behalten.

import {parseCommandInput, parseCommandOutput} from '@altifigence/dds-plugin-sdk';
const command = {id: 'summarize', title: 'Summarize',
  inputSchema: {schemaVersion: 1, schema: {
    type: 'object', additionalProperties: false,
    properties: {names: {type: 'array', minItems: 1, maxItems: 8,
      items: {type: 'string', minLength: 1, maxLength: 64}}}, required: ['names'],
  }}, outputSchema: {schemaVersion: 1, schema: {type: 'integer', minimum: 0}},
};
const input = parseCommandInput({names: ['Ada']}, command);
parseCommandOutput(input.names.length, command);

Die begrenzte Teilmenge unterstützt geschlossene Objekte, Arrays, Zeichenfolgen, endliche Zahlen, sichere Ganzzahlen, boolesche Werte, null, primitive Enums, Grenzen und validierte Standardwerte. Unbekannte Schlüsselwörter, entfernte Referenzen, Regex, Unions, Typumwandlung, Accessors und eigene Prototypen werden abgelehnt. Schemas erlauben 32 KiB, Tiefe 8 und 128 Knoten; Werte erlauben 64 KiB. Ein vollständiger Befehl behält das Metadatenbudget von 16 KiB. Lokaler DataValidationError stellt code, reason und bekannte Feldpfade wie /input/options/names/0 bereit; HTTP- und Jobfehler liefern sichere Codes ohne abgelehnte Werte.

describeDataForm liefert Pfade, Typen, Auswahlmöglichkeiten, Standardwerte, Pflichtkennzeichen und Hinweise auf Geheimnisreferenzen. Gemeinsame Anzeigemetadaten tragen wörtliche label/help/order sowie Namen, Beschreibungen und Tastaturhinweise zur Barrierefreiheit. Der Host verantwortet Rendering und Interaktion. Die Schemas liefern literale Formulardaten; Rendering, Ressourcenzugriff und Befehlsausführung implementiert der Host ausdrücklich.

Lokalisierung und Metadaten zur Barrierefreiheit

import {parseLocaleCatalog, resolveMessage, localizeDisplay}
  from '@altifigence/dds-plugin-sdk/localization';
const catalog = parseLocaleCatalog({schemaVersion: 1, defaultLocale: 'en',
  messages: {en: {title: 'Run', done: '{count} results'},
    ko: {title: '실행', done: '결과 {count}개'}, ar: {}}, fallbacks: {ar: ['en']},
});
const message = resolveMessage(catalog, 'ko-KR', 'done', {count: 2});
const display = localizeDisplay(catalog, 'ko', {
  labelKey: 'title', accessibility: {nameKey: 'title', shortcut: 'Control+Enter'},
});
// Render message.text as textContent; use message.locale and message.direction.
// Preserve raw values and command IDs when the display language changes.

Kataloge verwenden kanonische BCP-47-Basistags und ausdrückliche azyklische Fallback-Kanten. Bis zu acht Präferenzen handeln genaue Tags aus, dann übergeordnete Tags und den Standard. Die Standardsprache definiert alle Schlüssel; Übersetzungen dürfen Schlüssel auslassen, aber keine erfinden. Die Suche je Schlüssel folgt geordneten Fallback-Kanten und dann dem Standard. Jede Übersetzung und ihre Argumente müssen mit der genauen {name}-Platzhaltermenge übereinstimmen. Dies ist wörtliche Interpolation ohne ICU-Ausdrücke. resolveMessage meldet die tatsächliche Quellsprache und Richtung, sodass ein englischer Fallback auf einer RTL-Seite lang=en und dir=ltr behalten kann.

Zahlenformatierung unterstützt Dezimal/Prozent; Datumsformatierung verwendet eine ausdrückliche Epoche und standardmäßig UTC; Pluralauswahl liefert eine Intl-Kardinal-/Ordinalkategorie für die Nachrichtenauswahl des Aufrufers. Hosts verantworten Intl-Daten und Unterstützung. validateLocalizedSurfaces prüft Manifest-/Befehls-/Einstellungs-/Schemaschlüssel und Theme-Anzeigebegleitdateien, einschließlich aufgelöster Anzeigelängen und fehlender Übersetzungen. Theme-JSON/-XML bleibt kompatibel. Kataloggrenzen sind 32 Sprachen, 256 Schlüssel und 256 KiB; statische Labels dürfen keine Platzhalter enthalten.

Die /accessibility-Helfer melden fehlende Namen, doppelte normalisierte Tastenkürzel und ausdrücklichen Kontrast opaker Farbpaare in hellen/dunklen Themes. Verwenden Sie die Berichte als Prüfhilfe; Betriebssystem-Tastenbindungen und die Barrierefreiheitsbewertung der Anwendung verwaltet der Host. Das unabhängige Beispiel enthält EN/KO, teilweise Arabisch und Testdaten mit langen Labels. Es prüft Einstellungen mit begrenztem Geltungsbereich, verweigerte/widerrufene Referenzen, ungültige Felder, Ctrl+Enter und Sprachwechsel während eines ausstehenden Befehls. Browserlayout wurde in Desktop-/Mobilgrößen mit hellen/dunklen Themes geprüft.

npm run example:configuration
npm run example:configuration-browser

Einstellungen · Geheimnisreferenzen · Befehlsschemas · Lokalisierung

Entwicklungsvorlagen und Generierung

Sechs Vorlagen, genaue Archivabhängigkeiten, Generierungsprüfung, Erhalt bei Konflikten und Doctor-Prüfungen.

Vollständige Verträge, Beispiele und Grenzen

Deterministisches Testen und Wiedergabe

Ausdrückliche synthetische Testdaten, virtuelle Zeit, Fehler, begrenzte reine Hash-Traces und Ressourcenbereinigung.

Vollständige Verträge, Beispiele und Grenzen

Lokale Diagnosen und Debugging

Optionale lokale Profile und ein vertrauenswürdiger Kindprozess-Debugger mit kurzlebigem Loopback-Endpunkt und Gesamtfrist.

Vollständige Verträge, Beispiele und Grenzen

Hostkonformität

18 versionierte Profile unterscheiden unterstützte, nicht unterstützte und fehlgeschlagene Verträge; eigene Adapter behalten ausdrückliche Befugnisse.

Vollständige Verträge, Beispiele und Grenzen

SDK-Support und Migration

Siehe Exportinventar, Richtlinie für stabile/optionale/experimentelle Funktionen, genaue Peer-Abhängigkeiten, Laufzeitdaten und Migrationsbeispiele.

Vollständige Verträge, Beispiele und Grenzen

Release-Abnahme

Die kombinierten Fehlerarbeitslasten und gemessenen Leistungsgrenzen des Releases dokumentieren das funktionale Verhalten des eigenständigen SDK.

Vollständige Verträge, Beispiele und Grenzen

1.1 Werkzeuge für Abhängigkeiten, Herkunft und Updates

1.1.0 ergänzt deterministische Offline-Bündel geprüfter Abhängigkeiten, CycloneDX-SBOMs, abgetrennte Signaturen mit betreibereigenen Ed25519-Schlüsseln, digestgebundene Genehmigung/Aktivierung/Rollback und ausdrücklichen Upstream-Vergleich. Fünf nur unter Node nutzbare Einstiegspunkte enthalten Deklarationen, Schemas und unabhängige Beispiele. Der Host erteilt Ausführungsbefugnis ausdrücklich nach Signaturprüfung, und alte Jobs behalten ihren ursprünglichen Hash. Betreiber wählen Verteilungskanäle und rufen Aktivierung, Rollback und Upstream-Vergleich mit diesen eigenständigen SDK-Werkzeugen auf.

node node_modules/@altifigence/dds-plugin-sdk/examples/release-tools/run.mjs

Vollständiger Leitfaden für Bündel, Signaturen, Updates und Upstream

1.2 Workflows, Cache, Tool-Streams und LSP

1.2.0 ergänzt geprüfte Befehls-DAGs mit Jobs/Freigaben je Schritt, dauerhaften Checkpoints und ausdrücklicher Wiederherstellung als neuer Versuch; deterministischen inhaltsbasierten Cache und inkrementelle Ausführung; begrenzte UTF-8-/JSONL-/Text-Tool-Streams; und eine optionale stdio-LSP-3.17-Brücke. Sieben neue Einstiegspunkte bringen das Paket auf 50 Exporte und 107 Schemas mit Deklarationen und unabhängigen installierten Beispielen, ohne npm-Laufzeitabhängigkeiten. Der Tool-Stream-Parser funktioniert auch in Browsern; Workflows, Speicher, externe Prozesse und LSP erfordern Node. Tatsächliche Adapter wurden mit TypeScript 5.9.3 und language-server 5.3.0 geprüft; die LSP-Brücke akzeptiert an eine Dokumentversion gebundene Diagnosen. Betreiber prüfen und starten Workflowversuche ausdrücklich und konfigurieren den eigenständigen SDK-Host, Speicher und externe Prozesse.

node node_modules/@altifigence/dds-plugin-sdk/examples/workflows/run.mjs
node node_modules/@altifigence/dds-plugin-sdk/examples/workflow-tools/run.mjs
node node_modules/@altifigence/dds-plugin-sdk/examples/lsp/run.mjs

Vollständiger Leitfaden für Workflows, Cache, Werkzeuge und LSP