@openmbee/opensysml 0.9.1 → 0.10.0

package/dist/core/capabilities.d.ts

@@ -35,34 +35,99 @@ export declare const CAPABILITY_FINAL_TIME = "final_time";
 export declare const CAPABILITY_INLINE_LANGUAGE = "inline_language";
 /** `ParseFileRequest.strict_conformance`. */
 export declare const CAPABILITY_STRICT_CONFORMANCE = "strict_conformance";
-/** The `Convert` RPC. Not used by this version; see the README. */
+/** The `Convert` RPC. */
 export declare const CAPABILITY_CONVERT = "convert";
-/** The verification RPCs. Not used by this version; see the README. */
+/** The `Migrate` RPC, which migrates a SysML v1 model. */
+export declare const CAPABILITY_MIGRATE = "migrate";
+/** The verification RPCs. */
 export declare const CAPABILITY_VERIFICATION = "verification";
+/** The `question` field of the verification RPCs. */
+export declare const CAPABILITY_VERIFICATION_QUESTIONS = "verification_questions";
+/** `arguments` and `named_arguments` on VerifyConstraint and VerifyRequirement. */
+export declare const CAPABILITY_VERIFICATION_ARGUMENTS = "verification_arguments";
+/** The `Query` RPC. */
+export declare const CAPABILITY_QUERY = "query";
+/** The `RunDocumentQuery` RPC. */
+export declare const CAPABILITY_DOCUMENT_QUERY = "document_query";
+/** The `RenderDocument` RPC. */
+export declare const CAPABILITY_RENDER_DOCUMENT = "render_document";
+/** `form` on `RenderDocumentRequest` asking for HTML rather than Markdown. */
+export declare const CAPABILITY_RENDER_DOCUMENT_HTML = "render_document_html";
+/** The `RenderView` RPC, returning typed diagram data. */
+export declare const CAPABILITY_RENDER_VIEW = "render_view";
+/** The `ExportGraphs` RPC, exporting a behavior's lowered graph as `graphs:1` JSON. */
+export declare const CAPABILITY_EXPORT_GRAPHS = "export_graphs";
 /** What the body of a verification case answered, as `verification_verdicts`. */
 export declare const CAPABILITY_VERIFICATION_VERDICTS = "verification_verdicts";
 /** `RunAnalysisResponse.evaluations`: each call the run made to a calc held as a value, such as a trade study's evaluation of every alternative. */
 export declare const CAPABILITY_CASE_EVALUATIONS = "case_evaluations";
-/** The `Query` RPC. Not used by this version; see the README. */
-export declare const CAPABILITY_QUERY = "query";
-/** The `ApplyEdits` RPC. Not used by this version; see the README. */
+/** The `ApplyEdits` RPC. */
 export declare const CAPABILITY_APPLY_EDITS = "apply_edits";
+/** Source-preserving add-member and delete authoring operations. */
+export declare const CAPABILITY_AUTHORING = "authoring";
+/** The `ApplyEdits` `add_connection` operation. */
+export declare const CAPABILITY_CONNECTION_AUTHORING = "connection_authoring";
+/** The `ApplyEdits` `add_satisfy` operation. */
+export declare const CAPABILITY_SATISFY_AUTHORING = "satisfy_authoring";
+/** The `ApplyEdits` `add_requirement_constraint` operation. */
+export declare const CAPABILITY_REQUIREMENT_CONSTRAINT_AUTHORING = "requirement_constraint_authoring";
+/** The `ApplyEdits` `add_transition` operation. */
+export declare const CAPABILITY_TRANSITION_AUTHORING = "transition_authoring";
+/** The `ApplyEdits` `add_verify` operation and anonymous objectives. */
+export declare const CAPABILITY_VERIFICATION_OBJECTIVE_AUTHORING = "verification_objective_authoring";
+/** The `ApplyEdits` `add_metadata` operation. */
+export declare const CAPABILITY_METADATA_AUTHORING = "metadata_authoring";
+/** `ApplyEdits` metadata prefixes. */
+export declare const CAPABILITY_METADATA_PREFIX_AUTHORING = "metadata_prefix_authoring";
 /** `ApplyEdits` can add `first`/`then` action sequencing members. */
 export declare const CAPABILITY_SEQUENCE_AUTHORING = "sequence_authoring";
 /** `ApplyEdits` can add action-body statements and succession source multiplicities. */
 export declare const CAPABILITY_ACTION_BODY_STATEMENT_AUTHORING = "action_body_statement_authoring";
+/** The `ApplyEdits` `add_import` operation. */
+export declare const CAPABILITY_IMPORT_AUTHORING = "import_authoring";
+/** The `ApplyEdits` `add_documentation` operation and `AddMemberEdit.doc`. */
+export declare const CAPABILITY_DOCUMENTATION_AUTHORING = "documentation_authoring";
+/** The `ApplyEdits` `add_comment` and `add_note` operations. */
+export declare const CAPABILITY_COMMENT_AUTHORING = "comment_authoring";
+/** The additional `AddMemberEdit` modifiers and `ref`/`return` kinds. */
+export declare const CAPABILITY_MEMBER_MODIFIERS = "member_modifiers";
+/** `ApplyEdits` adds a directed usage with no kind keyword (`in x : T;`). */
+export declare const CAPABILITY_IMPLICIT_PARAMETERS = "implicit_parameters";
+/** Constraint body expressions and asserted constraints in `ApplyEdits`. */
+export declare const CAPABILITY_CONSTRAINT_BODY_AUTHORING = "constraint_body_authoring";
+/** State behavior member kinds in `ApplyEdits`. */
+export declare const CAPABILITY_STATE_ACTION_AUTHORING = "state_action_authoring";
 /** `ApplyEdits` edits a model of several documents as one batch and answers each edited document by name in `documents`. Not used by this version; see the README. */
 export declare const CAPABILITY_EDIT_DOCUMENTS = "edit_documents";
-/** The `schedule` field of the execution requests, naming the scheduling policy. Not used by this version; see the README. */
+/** `ParseSources`, parsing several named documents as one model. */
+export declare const CAPABILITY_PARSE_SOURCES = "parse_sources";
+/** The `schedule` field of the execution requests, naming the scheduling policy. */
 export declare const CAPABILITY_SCHEDULE = "schedule";
-/** The `explore` scheduling policy, answering with every `outcomes` entry and an `exploration` status. Not used by this version; see the README. */
+/** The `explore` scheduling policy, answering with every `outcomes` entry and an `exploration` status. */
 export declare const CAPABILITY_SCHEDULE_EXPLORE = "schedule_explore";
-/** `performerSymbolId` on the action and state requests: the object the behavior runs on, a declaration or a path from one into its parts. Not used by this version; see the README. */
+/** `performerSymbolId` on the action and state requests: the object the behavior runs on, a declaration or a path from one into its parts. */
 export declare const CAPABILITY_PERFORMER = "performer";
-/** The `ListEngines` RPC, the `engine` field selecting an analysis engine, and `engine`, `strength` and `bounds` on the answers. Not used by this version; see the README. */
+/** `trace` on `ExecuteStateRequest`, returning documented events from one run. */
+export declare const CAPABILITY_STATE_TRACE = "state_trace";
+/** The `ListEngines` RPC, the `engine` field selecting an analysis engine, and `engine`, `strength` and `bounds` on the answers. */
 export declare const CAPABILITY_ENGINES = "engines";
 /** A model-level result the model leaves open as `Value.undetermined`, read as an `undetermined` value. */
 export declare const CAPABILITY_UNDETERMINED_VALUE = "undetermined_value";
+/** An Integer beyond int64 as `Value.bigIntValue`, `Quantity.bigIntMagnitude` and `DocumentValue.bigIntValue`; a service without it reads one sent to it as null. */
+export declare const CAPABILITY_BIG_INT_VALUES = "big_int_values";
+/** An exact Rational no double holds as `Value.rationalValue`, `Quantity.rationalMagnitude` and `DocumentValue.rationalValue`; a service without it reads one sent to it as null. */
+export declare const CAPABILITY_RATIONAL_VALUES = "rational_values";
+/** `ConvertRequest.documents`: a model converted with only the named documents written, the references into the others linked by id. */
+export declare const CAPABILITY_CONVERT_DOCUMENTS = "convert_documents";
+/** `ConvertRequest.compact`, `omitDerived` and `keepDerived`: api-json written as the compact document (an id table and handles), optionally without derived properties. */
+export declare const CAPABILITY_CONVERT_COMPACT = "convert_compact";
+/** `ParseSourcesRequest.baseModelHash` and `ParseSourcesResponse.affected`: the documents whose results may differ from the base model's, so a client re-reads only those after an edit. */
+export declare const CAPABILITY_PARSE_SOURCES_AFFECTED = "parse_sources_affected";
+/**
+ * Orders capability names by code unit, the order the service reports them in.
+ * Locale-aware collation ignores the underscores that separate their words.
+ */
+export declare function byCodeUnit(a: string, b: string): number;
 /** Self-description of the service a connection talks to. */
 export declare class ServerInfo {
     /** Version the service reports. Informational only; empty when unanswered. */
@@ -92,3 +157,19 @@ export declare class MissingCapabilityError extends OpenSysMLError {
 export declare function requireCapability(info: ServerInfo, capability: string, remedy: string): void;
 /** Remedy text for a service that lacks `capability`, naming both routes to one that has it. */
 export declare function upgradeRemedy(capability: string): string;
+/**
+ * Why `info` is not the service that was asked for, or undefined when it is. A
+ * release is compared as an exact tag: a build that cannot be shown to be the
+ * one asked for is a mismatch.
+ */
+export declare function mismatchReason(info: ServerInfo, options?: {
+    version?: string;
+    capabilities?: Iterable<string>;
+}): string | undefined;
+/**
+ * The UNIMPLEMENTED translator for a call whose capabilities were checked
+ * before it was sent: a refusal the service still answers with is mapped back
+ * to the capability it names — the first one present in its message — rather
+ * than arriving as a generic unsupported-operation error.
+ */
+export declare function capabilityRefusal(info: ServerInfo, capabilities: readonly string[]): ((details: string) => MissingCapabilityError) | undefined;

package/dist/core/capabilities.js

@@ -39,39 +39,99 @@ export const CAPABILITY_FINAL_TIME = "final_time";
 export const CAPABILITY_INLINE_LANGUAGE = "inline_language";
 /** `ParseFileRequest.strict_conformance`. */
 export const CAPABILITY_STRICT_CONFORMANCE = "strict_conformance";
-/** The `Convert` RPC. Not used by this version; see the README. */
+/** The `Convert` RPC. */
 export const CAPABILITY_CONVERT = "convert";
-/** The verification RPCs. Not used by this version; see the README. */
+/** The `Migrate` RPC, which migrates a SysML v1 model. */
+export const CAPABILITY_MIGRATE = "migrate";
+/** The verification RPCs. */
 export const CAPABILITY_VERIFICATION = "verification";
+/** The `question` field of the verification RPCs. */
+export const CAPABILITY_VERIFICATION_QUESTIONS = "verification_questions";
+/** `arguments` and `named_arguments` on VerifyConstraint and VerifyRequirement. */
+export const CAPABILITY_VERIFICATION_ARGUMENTS = "verification_arguments";
+/** The `Query` RPC. */
+export const CAPABILITY_QUERY = "query";
+/** The `RunDocumentQuery` RPC. */
+export const CAPABILITY_DOCUMENT_QUERY = "document_query";
+/** The `RenderDocument` RPC. */
+export const CAPABILITY_RENDER_DOCUMENT = "render_document";
+/** `form` on `RenderDocumentRequest` asking for HTML rather than Markdown. */
+export const CAPABILITY_RENDER_DOCUMENT_HTML = "render_document_html";
+/** The `RenderView` RPC, returning typed diagram data. */
+export const CAPABILITY_RENDER_VIEW = "render_view";
+/** The `ExportGraphs` RPC, exporting a behavior's lowered graph as `graphs:1` JSON. */
+export const CAPABILITY_EXPORT_GRAPHS = "export_graphs";
 /** What the body of a verification case answered, as `verification_verdicts`. */
 export const CAPABILITY_VERIFICATION_VERDICTS = "verification_verdicts";
 /** `RunAnalysisResponse.evaluations`: each call the run made to a calc held as a value, such as a trade study's evaluation of every alternative. */
 export const CAPABILITY_CASE_EVALUATIONS = "case_evaluations";
-/** The `Query` RPC. Not used by this version; see the README. */
-export const CAPABILITY_QUERY = "query";
-/** The `ApplyEdits` RPC. Not used by this version; see the README. */
+/** The `ApplyEdits` RPC. */
 export const CAPABILITY_APPLY_EDITS = "apply_edits";
+/** Source-preserving add-member and delete authoring operations. */
+export const CAPABILITY_AUTHORING = "authoring";
+/** The `ApplyEdits` `add_connection` operation. */
+export const CAPABILITY_CONNECTION_AUTHORING = "connection_authoring";
+/** The `ApplyEdits` `add_satisfy` operation. */
+export const CAPABILITY_SATISFY_AUTHORING = "satisfy_authoring";
+/** The `ApplyEdits` `add_requirement_constraint` operation. */
+export const CAPABILITY_REQUIREMENT_CONSTRAINT_AUTHORING = "requirement_constraint_authoring";
+/** The `ApplyEdits` `add_transition` operation. */
+export const CAPABILITY_TRANSITION_AUTHORING = "transition_authoring";
+/** The `ApplyEdits` `add_verify` operation and anonymous objectives. */
+export const CAPABILITY_VERIFICATION_OBJECTIVE_AUTHORING = "verification_objective_authoring";
+/** The `ApplyEdits` `add_metadata` operation. */
+export const CAPABILITY_METADATA_AUTHORING = "metadata_authoring";
+/** `ApplyEdits` metadata prefixes. */
+export const CAPABILITY_METADATA_PREFIX_AUTHORING = "metadata_prefix_authoring";
 /** `ApplyEdits` can add `first`/`then` action sequencing members. */
 export const CAPABILITY_SEQUENCE_AUTHORING = "sequence_authoring";
 /** `ApplyEdits` can add action-body statements and succession source multiplicities. */
 export const CAPABILITY_ACTION_BODY_STATEMENT_AUTHORING = "action_body_statement_authoring";
+/** The `ApplyEdits` `add_import` operation. */
+export const CAPABILITY_IMPORT_AUTHORING = "import_authoring";
+/** The `ApplyEdits` `add_documentation` operation and `AddMemberEdit.doc`. */
+export const CAPABILITY_DOCUMENTATION_AUTHORING = "documentation_authoring";
+/** The `ApplyEdits` `add_comment` and `add_note` operations. */
+export const CAPABILITY_COMMENT_AUTHORING = "comment_authoring";
+/** The additional `AddMemberEdit` modifiers and `ref`/`return` kinds. */
+export const CAPABILITY_MEMBER_MODIFIERS = "member_modifiers";
+/** `ApplyEdits` adds a directed usage with no kind keyword (`in x : T;`). */
+export const CAPABILITY_IMPLICIT_PARAMETERS = "implicit_parameters";
+/** Constraint body expressions and asserted constraints in `ApplyEdits`. */
+export const CAPABILITY_CONSTRAINT_BODY_AUTHORING = "constraint_body_authoring";
+/** State behavior member kinds in `ApplyEdits`. */
+export const CAPABILITY_STATE_ACTION_AUTHORING = "state_action_authoring";
 /** `ApplyEdits` edits a model of several documents as one batch and answers each edited document by name in `documents`. Not used by this version; see the README. */
 export const CAPABILITY_EDIT_DOCUMENTS = "edit_documents";
-/** The `schedule` field of the execution requests, naming the scheduling policy. Not used by this version; see the README. */
+/** `ParseSources`, parsing several named documents as one model. */
+export const CAPABILITY_PARSE_SOURCES = "parse_sources";
+/** The `schedule` field of the execution requests, naming the scheduling policy. */
 export const CAPABILITY_SCHEDULE = "schedule";
-/** The `explore` scheduling policy, answering with every `outcomes` entry and an `exploration` status. Not used by this version; see the README. */
+/** The `explore` scheduling policy, answering with every `outcomes` entry and an `exploration` status. */
 export const CAPABILITY_SCHEDULE_EXPLORE = "schedule_explore";
-/** `performerSymbolId` on the action and state requests: the object the behavior runs on, a declaration or a path from one into its parts. Not used by this version; see the README. */
+/** `performerSymbolId` on the action and state requests: the object the behavior runs on, a declaration or a path from one into its parts. */
 export const CAPABILITY_PERFORMER = "performer";
-/** The `ListEngines` RPC, the `engine` field selecting an analysis engine, and `engine`, `strength` and `bounds` on the answers. Not used by this version; see the README. */
+/** `trace` on `ExecuteStateRequest`, returning documented events from one run. */
+export const CAPABILITY_STATE_TRACE = "state_trace";
+/** The `ListEngines` RPC, the `engine` field selecting an analysis engine, and `engine`, `strength` and `bounds` on the answers. */
 export const CAPABILITY_ENGINES = "engines";
 /** A model-level result the model leaves open as `Value.undetermined`, read as an `undetermined` value. */
 export const CAPABILITY_UNDETERMINED_VALUE = "undetermined_value";
+/** An Integer beyond int64 as `Value.bigIntValue`, `Quantity.bigIntMagnitude` and `DocumentValue.bigIntValue`; a service without it reads one sent to it as null. */
+export const CAPABILITY_BIG_INT_VALUES = "big_int_values";
+/** An exact Rational no double holds as `Value.rationalValue`, `Quantity.rationalMagnitude` and `DocumentValue.rationalValue`; a service without it reads one sent to it as null. */
+export const CAPABILITY_RATIONAL_VALUES = "rational_values";
+/** `ConvertRequest.documents`: a model converted with only the named documents written, the references into the others linked by id. */
+export const CAPABILITY_CONVERT_DOCUMENTS = "convert_documents";
+/** `ConvertRequest.compact`, `omitDerived` and `keepDerived`: api-json written as the compact document (an id table and handles), optionally without derived properties. */
+export const CAPABILITY_CONVERT_COMPACT = "convert_compact";
+/** `ParseSourcesRequest.baseModelHash` and `ParseSourcesResponse.affected`: the documents whose results may differ from the base model's, so a client re-reads only those after an edit. */
+export const CAPABILITY_PARSE_SOURCES_AFFECTED = "parse_sources_affected";
 /**
  * Orders capability names by code unit, the order the service reports them in.
  * Locale-aware collation ignores the underscores that separate their words.
  */
-function byCodeUnit(a, b) {
+export function byCodeUnit(a, b) {
     if (a < b) {
         return -1;
     }
@@ -128,3 +188,44 @@ export function upgradeRemedy(capability) {
         `newer ${PLATFORM_PACKAGE_PREFIX}<platform> package, point $OPENSYSML_BINARY at a build that ` +
         `has it, or start one yourself and connect to its address`);
 }
+/**
+ * Why `info` is not the service that was asked for, or undefined when it is. A
+ * release is compared as an exact tag: a build that cannot be shown to be the
+ * one asked for is a mismatch.
+ */
+export function mismatchReason(info, options = {}) {
+    const reasons = [];
+    if (options.version !== undefined) {
+        if (!info.answered) {
+            reasons.push(`it did not answer GetServerInfo, so it cannot be shown to be the ${options.version} ` +
+                `that was asked for`);
+        }
+        else if (info.version !== options.version) {
+            reasons.push(`it reports version ${info.version === "" ? "unknown" : info.version}, but ` +
+                `${options.version} was asked for`);
+        }
+    }
+    const missing = [...(options.capabilities ?? [])].filter((capability) => !info.has(capability));
+    missing.sort(byCodeUnit);
+    if (missing.length > 0) {
+        const named = missing.map((capability) => JSON.stringify(capability)).join(", ");
+        const noun = missing.length > 1 ? "capabilities" : "capability";
+        reasons.push(`it does not report the ${named} ${noun} this client requires`);
+    }
+    return reasons.length === 0 ? undefined : reasons.join("; ");
+}
+/**
+ * The UNIMPLEMENTED translator for a call whose capabilities were checked
+ * before it was sent: a refusal the service still answers with is mapped back
+ * to the capability it names — the first one present in its message — rather
+ * than arriving as a generic unsupported-operation error.
+ */
+export function capabilityRefusal(info, capabilities) {
+    if (capabilities.length === 0) {
+        return undefined;
+    }
+    return (details) => {
+        const capability = capabilities.find((name) => details.includes(name)) ?? capabilities[0];
+        return new MissingCapabilityError(capability, info, upgradeRemedy(capability));
+    };
+}

package/dist/core/connection.d.ts

@@ -1,8 +1,21 @@
 import { type Client, type Transport } from "@connectrpc/connect";
 import { ServerInfo } from "./capabilities.js";
-import { SysMLService } from "../generated/sysml_pb.js";
+import { UnsupportedValueError } from "./errors.js";
+import { SysMLService, type EditOperation } from "../generated/sysml_pb.js";
 import { Model } from "./model.js";
 import type { ParseOptions } from "./model.js";
+import { type Source } from "./sources.js";
+import { Conversion, Migration } from "./conversion.js";
+import type { MigrateOptions } from "./conversion.js";
+import { type QueryElement, type QueryForm, type QueryPayload } from "./query.js";
+import { DocumentEvent, type BindingValues, type DocumentQueryResult } from "./document.js";
+import { type RenderedView } from "./render-view.js";
+import { type Graphs } from "./graphs.js";
+import { type EngineInfo } from "./engines.js";
+import { Exploration } from "./exploration.js";
+import { CalcResult, type AnalysisResult, type SweepTable, type Validation, type Verdict } from "./verdict.js";
+import { type SysMLValue, type ValueInput } from "./values.js";
+import { Editor, type EditOperationData, type EditResult } from "./edit.js";
 /** Wire encoding of the request and response bodies. Protobuf is the default. */
 export type Encoding = "protobuf" | "json";
 /** Observability hook: called with every response the service returns. */
@@ -32,8 +45,29 @@ export interface ConnectionBackend {
     readonly origin: string;
     /** Releases this connection's hold. Never stops a service the client did not start. */
     release(): Promise<void>;
+    /** Reports a warning the runtime raises: Node emits it, the browser logs it. */
+    warn?(message: string, type: string): void;
+    /**
+     * Makes a path the caller handed this client absolute, so that what a
+     * `Migration` remembers as its source outlives a later change of working
+     * directory. Absent where paths have no working directory, as in a browser.
+     */
+    resolvePath?(path: string): string;
 }
 /** A connection to a sysml-grpc service. Close it, or use `await using`. */
+/** Argument bindings for a constraint's or requirement's `in` parameters. */
+export interface VerifyArguments {
+    /** Positional arguments, bound in declaration order. */
+    arguments?: readonly ValueInput[];
+    /** Arguments by parameter name. */
+    namedArguments?: Readonly<Record<string, ValueInput>>;
+}
+/** Options of verifyConstraint and verifyRequirement. */
+export interface VerifyOptions extends VerifyArguments {
+    subject?: string;
+    engine?: string;
+    question?: string;
+}
 export declare class Connection {
     /**
      * The generated Connect client. The ergonomic API covers what this version
@@ -46,12 +80,25 @@ export declare class Connection {
     private readonly timeoutMs;
     private closed;
     private constructor();
-    /** Opens a connection over `transport` and performs the capability handshake. */
+    /**
+     * Opens a connection over `transport` and performs the capability handshake.
+     * A refused handshake — the service is not the release asked for, or lacks a
+     * required capability — releases the backend and is never returned.
+     */
     static open(init: {
         transport: Transport;
         backend: ConnectionBackend;
         encoding: Encoding;
         timeoutMs?: number | undefined;
+        /** Release tag the service must report. */
+        requiredVersion?: string;
+        /** Capabilities the service must report. */
+        requiredCapabilities?: readonly string[];
+        /** How a stale-service error addresses the service, and its remedy. */
+        stale?: {
+            address: string;
+            remedy: string;
+        };
     }): Promise<Connection>;
     /** Whether this connection has been closed. */
     get isClosed(): boolean;
@@ -68,6 +115,160 @@ export declare class Connection {
      * processes, and answers NOT_FOUND once the service has evicted the model.
      */
     model(hash: string): Model;
+    /** Parses several documents together as one model, one root per document. */
+    parseSources(documents: readonly Source[], options?: ParseOptions): Promise<Model>;
+    /**
+     * Writes a model out in another of the formats OpenSysML writes. Exactly one
+     * of `source.path`, `source.content` and `source.modelHash` names the source.
+     */
+    convert(toFormat: string, source: {
+        path: string;
+    } | {
+        content: string;
+    } | {
+        modelHash: string;
+    }, options?: {
+        fromFormat?: string;
+        tolerateSyntaxErrors?: boolean;
+    }): Promise<Conversion>;
+    /**
+     * Migrates a SysML v1 model — a Cameo/MagicDraw `.mdzip`, a UML XMI `.xmi` or
+     * an Eclipse UML2 `.uml` export — to one of the formats OpenSysML writes. A
+     * migration is ledgered, not lossless: every v1 element lands in the
+     * `Migration.report` as mapped, approximated, unmapped or skipped. Exactly one
+     * of `source.path` and `source.content` names the source; inline content is
+     * the file's bytes and needs `fromFormat` to say which form they are.
+     */
+    migrate(toFormat: string, source: {
+        path: string;
+    } | {
+        content: Uint8Array;
+    }, options?: MigrateOptions): Promise<Migration>;
+    /** Runs a SysML v2 API & Services Query over a loaded model. */
+    query(modelHash: string, options?: {
+        payload?: QueryPayload;
+    } & QueryForm): Promise<QueryElement[]>;
+    /** Runs a named document query and answers its typed rows. */
+    runDocumentQuery(modelHash: string, queryId: string, bindings?: Readonly<Record<string, BindingValues>>): Promise<DocumentQueryResult>;
+    /** Applies source-preserving edits to a loaded model. Operations are the
+     * tuple form the {@link Editor} builds, or wire `EditOperation` messages,
+     * which pass through as written. */
+    applyEdits(modelHash: string, operations: readonly (EditOperationData | EditOperation)[], options?: {
+        acceptDocuments?: boolean;
+        document?: string;
+    }): Promise<EditResult>;
+    /** Starts an edit of a loaded model, applied with {@link Editor.apply}. */
+    edit(modelHash: string): Editor;
+    /** Renders a named document to Markdown or HTML. */
+    renderDocument(modelHash: string, documentId: string, options?: {
+        form?: string;
+    }): Promise<string>;
+    /** Renders a named view or targeted pseudo-view as diagram data. */
+    renderView(modelHash: string, viewName: string, options?: {
+        ports?: "minimal" | "full";
+    }): Promise<RenderedView>;
+    /**
+     * Exports the lowered graph of an action or state machine, and of every
+     * behavior it performs, as the canonical `graphs:1` JSON an external
+     * analysis engine is sent.
+     */
+    exportGraphs(modelHash: string, subject: string): Promise<Graphs>;
+    /** Executes an action definition. */
+    executeAction(modelHash: string, actionSymbolId: string, options?: {
+        inputs?: Readonly<Record<string, ValueInput>>;
+        schedule?: string;
+        performer?: string;
+    }): Promise<{
+        outputs: ReadonlyMap<string, SysMLValue | UnsupportedValueError>;
+        performer: ReadonlyMap<string, SysMLValue | UnsupportedValueError>;
+        finalTime: number;
+    }>;
+    /** Runs an action once per valid order of its choice points, within a budget. */
+    exploreAction(modelHash: string, actionSymbolId: string, options?: {
+        inputs?: Readonly<Record<string, ValueInput>>;
+        schedule?: string;
+        performer?: string;
+    }): Promise<Exploration>;
+    private sendExecuteAction;
+    /** Executes a state machine; a failed traced run carries its partial trace on ExecutionError. */
+    executeState(modelHash: string, stateMachineSymbolId: string, options?: {
+        events?: readonly string[];
+        schedule?: string;
+        performer?: string;
+        trace?: boolean;
+    }): Promise<{
+        statesVisited: string[];
+        finalContext: ReadonlyMap<string, SysMLValue | UnsupportedValueError>;
+        finalTime: number;
+        trace: DocumentEvent[];
+        traceDropped: number;
+    }>;
+    /** Runs a state machine over the events once per valid order of its choice points. */
+    exploreState(modelHash: string, stateMachineSymbolId: string, options?: {
+        events?: readonly string[];
+        schedule?: string;
+        performer?: string;
+    }): Promise<Exploration>;
+    private sendExecuteState;
+    private explorationOf;
+    /** Lists the analysis engines the service answers with, as `sysml -engines` does. */
+    listEngines(): Promise<EngineInfo[]>;
+    /** Asks whether a constraint holds. */
+    verifyConstraint(modelHash: string, symbolId: string, options?: VerifyOptions): Promise<Verdict>;
+    /** Asks whether a requirement is satisfied. */
+    verifyRequirement(modelHash: string, symbolId: string, options?: VerifyOptions): Promise<Verdict>;
+    /** Asks whether the model's satisfaction assertions hold. */
+    verifySatisfaction(modelHash: string, options?: {
+        symbolId?: string;
+        engine?: string;
+        question?: string;
+    }): Promise<Verdict[]>;
+    /** Checks every assertion about an object of one of this model's parts. */
+    validateInstance(modelHash: string, symbolId: string, options?: {
+        engine?: string;
+    }): Promise<Validation>;
+    /** Invokes a calculation. */
+    calc(modelHash: string, symbolId: string, options?: {
+        arguments?: readonly ValueInput[];
+        engine?: string;
+    }): Promise<CalcResult>;
+    /** Runs an analysis case. */
+    runAnalysis(modelHash: string, symbolId: string, options?: {
+        subject?: string;
+        arguments?: readonly ValueInput[];
+        namedArguments?: Readonly<Record<string, ValueInput>>;
+        schedule?: string;
+        engine?: string;
+    }): Promise<AnalysisResult>;
+    /** Runs an analysis case once per valid order of its choice points. */
+    exploreAnalysis(modelHash: string, symbolId: string, options?: {
+        subject?: string;
+        arguments?: readonly ValueInput[];
+        namedArguments?: Readonly<Record<string, ValueInput>>;
+        schedule?: string;
+    }): Promise<Exploration>;
+    private sendRunAnalysis;
+    /** Runs an analysis case or calc once per row of a parameter sweep. */
+    runSweep(modelHash: string, symbolId: string, ranges: Readonly<Record<string, readonly [ValueInput, ValueInput] | readonly [ValueInput, ValueInput, ValueInput]>>, options?: {
+        subject?: string;
+        arguments?: readonly ValueInput[];
+        namedArguments?: Readonly<Record<string, ValueInput>>;
+        samples?: bigint | number;
+        seed?: bigint | number;
+        engine?: string;
+    }): Promise<SweepTable>;
+    private sweepRange;
+    private verdictOf;
+    private instancesOf;
+    private requireVerification;
+    private requireEngines;
+    private requireEngine;
+    private requireArguments;
+    private requireQuestion;
+    private requireSchedule;
+    private requireStrictConformance;
+    private runCapabilities;
+    private warn;
     /** Asks the service what it is and what it can do, again. */
     serverInfo(): Promise<ServerInfo>;
     /**