@openmbee/opensysml 0.9.2 → 0.10.1

package/dist/core/exploration.js

@@ -0,0 +1,116 @@
+// What exploring a behavior under the `explore` scheduling policy found: every
+// distinct outcome the runs reached, rather than one run's result.
+import { byCodeUnit } from "./capabilities.js";
+import { ExecutionError } from "./errors.js";
+import { formatValue } from "./values.js";
+/** One distinct outcome an exploration reached. */
+export class Outcome {
+    /** The values the behavior holds at the end, by name; empty for a failed run. */
+    outputs;
+    /** The state a state machine rests in; empty for an action. */
+    finalState;
+    /** The states a state machine entered, in order. */
+    statesVisited;
+    /** Why the run failed; empty for a run that completed. */
+    error;
+    /** How many of the explored orders reached this outcome. */
+    linearizations;
+    /** Share of the explored orders' likelihood reaching this outcome; a lower bound while incomplete. */
+    probability;
+    /** The choices one run reaching it made, in run order; empty with no choice point. */
+    witness;
+    /** What the witness run reported, its choice points among them. */
+    diagnostics;
+    constructor(init) {
+        this.outputs = init.outputs;
+        this.finalState = init.finalState;
+        this.statesVisited = init.statesVisited;
+        this.error = init.error;
+        this.linearizations = init.linearizations;
+        this.probability = init.probability;
+        this.witness = init.witness;
+        this.diagnostics = init.diagnostics;
+    }
+    /** Whether the runs reaching this outcome failed rather than completed. */
+    get failed() {
+        return this.error !== "";
+    }
+    /** Raise the run's failure as an {@link ExecutionError}, if it failed. */
+    raiseForError() {
+        if (this.error !== "") {
+            throw new ExecutionError(this.error, "unspecified", this.diagnostics);
+        }
+        return this;
+    }
+    toString() {
+        if (this.error !== "") {
+            return `error: ${this.error}`;
+        }
+        const parts = [];
+        if (this.finalState !== "") {
+            parts.push(`finalState ${this.finalState}`);
+        }
+        if (this.statesVisited.length > 0) {
+            parts.push(`visits ${this.statesVisited.join(", ")}`);
+        }
+        for (const [name, value] of [...this.outputs.entries()].sort(([a], [b]) => byCodeUnit(a, b))) {
+            parts.push(`${name} = ${typeof value === "object" && "kind" in value ? formatValue(value) : String(value)}`);
+        }
+        return parts.length > 0 ? parts.join("; ") : "no outputs";
+    }
+}
+/** Every distinct outcome a behavior reached under `explore`, and how the exploration ended. */
+export class Exploration {
+    /** The distinct outcomes reached, in the service's canonical order. */
+    outcomes;
+    /** Whether every linearization within the budget was run. */
+    complete;
+    /** How many runs were made. */
+    runs;
+    /** The budgets the exploration ran into; empty when complete. */
+    budgetsHit;
+    /** The most runs the exploration would make. */
+    runsBudget;
+    /** The most choice points one run would resolve. */
+    depthBudget;
+    /** Whether the outcomes' probabilities are lower bounds. */
+    probabilitiesLowerBound;
+    constructor(init) {
+        this.outcomes = init.outcomes;
+        this.complete = init.complete;
+        this.runs = init.runs;
+        this.budgetsHit = init.budgetsHit;
+        this.runsBudget = init.runsBudget;
+        this.depthBudget = init.depthBudget;
+        this.probabilitiesLowerBound = init.probabilitiesLowerBound ?? false;
+    }
+    get length() {
+        return this.outcomes.length;
+    }
+    [Symbol.iterator]() {
+        return this.outcomes[Symbol.iterator]();
+    }
+    /** How the exploration ended, as `sysml -schedule explore` prints it. */
+    get status() {
+        if (this.complete) {
+            return `complete (${this.runs} runs)`;
+        }
+        const named = this.budgetsHit
+            .map((budget) => `${budget} budget ${budget === "depth" ? this.depthBudget : this.runsBudget}`)
+            .join(" and ");
+        return `incomplete: ${named} hit after ${this.runs} runs; probabilities are lower bounds`;
+    }
+    /** Raise an {@link ExecutionError} unless every linearization was run. */
+    raiseForIncomplete() {
+        if (!this.complete) {
+            throw new ExecutionError(this.status);
+        }
+        return this;
+    }
+    toString() {
+        const lines = this.outcomes.map((outcome) => `${outcome.toString()} (${outcome.linearizations} linearizations; ` +
+            `${outcome.witness.join("; ") || "no choice points"})`);
+        lines.push(this.status);
+        return lines.join("\n");
+    }
+}

package/dist/core/graphs.d.ts

@@ -0,0 +1,15 @@
+import type { ExportGraphsResponse } from "../generated/sysml_pb.js";
+/**
+ * The lowered graph of an action or state machine and of every behavior it
+ * performs, in the canonical `graphs:<version>` JSON form an external analysis
+ * engine is sent.
+ */
+export interface Graphs {
+    /** The form as canonical JSON, ending in one newline. */
+    content: string;
+    /** The version of the form, the `version` field of the JSON. */
+    version: number;
+    /** The qualified name of the behavior as resolved. */
+    subject: string;
+}
+export declare function graphsOf(response: ExportGraphsResponse): Graphs;

package/dist/core/graphs.js

@@ -0,0 +1,3 @@
+export function graphsOf(response) {
+    return { content: response.content, version: response.version, subject: response.subject };
+}

package/dist/core/index.d.ts

@@ -1,14 +1,35 @@
 export { Connection } from "./connection.js";
-export type { ConnectionBackend, Encoding, ResponseTap, TransportOptions, } from "./connection.js";
-export { Instance, InstanceTree, Model, ModelSymbol } from "./model.js";
-export type { AttributeFacts, EvalOptions, FeatureValue, ParseOptions, SpecializationFacts, TypeFacts, } from "./model.js";
-export { CAPABILITY_APPLY_EDITS, CAPABILITY_ACTION_BODY_STATEMENT_AUTHORING, CAPABILITY_CASE_EVALUATIONS, CAPABILITY_COMPLEX_VALUES, CAPABILITY_CONVERT, CAPABILITY_DIAGNOSTIC_CODES, CAPABILITY_EDIT_DOCUMENTS, CAPABILITY_ENGINES, CAPABILITY_ENUM_VALUES, CAPABILITY_EVALUATE_SUBJECT, CAPABILITY_FEATURE_VALUES, CAPABILITY_FINAL_TIME, CAPABILITY_FUNCTION_VALUES, CAPABILITY_INFINITY_VALUE, CAPABILITY_INLINE_LANGUAGE, CAPABILITY_MEASUREMENT_REFS, CAPABILITY_METAOBJECT_VALUES, CAPABILITY_PERFORMER, CAPABILITY_QUERY, CAPABILITY_SCHEDULE, CAPABILITY_SCHEDULE_EXPLORE, CAPABILITY_SEQUENCE_AUTHORING, CAPABILITY_SET_VALUES, CAPABILITY_STRICT_CONFORMANCE, CAPABILITY_STRUCTURED_VALUES, CAPABILITY_UNDETERMINED_VALUE, CAPABILITY_VERIFICATION_VERDICTS, CAPABILITY_SYMBOL_ATTRIBUTES, CAPABILITY_TENSOR_VALUES, CAPABILITY_TYPE_FACTS, CAPABILITY_UNSET_VALUE, CAPABILITY_VERIFICATION, MissingCapabilityError, ServerInfo, requireCapability, upgradeRemedy, } from "./capabilities.js";
-export { ChecksumMismatchError, ClosedConnectionError, DownloadError, EvaluationError, InvalidRequestError, MalformedValueError, ManifestSignatureError, ModelFileNotFoundError, ModelNotFoundError, OpenSysMLError, ParseError, ServiceError, ServiceStartError, ServiceTimeoutError, SymbolNotFoundError, UnpinnedReleaseError, UnsignedReleaseError, UnsupportedOperationError, } from "./errors.js";
+export type { ConnectionBackend, Encoding, ResponseTap, TransportOptions, VerifyArguments, VerifyOptions, } from "./connection.js";
+export type { WasmHost } from "./wasm.js";
+export { Instance, InstanceTree, Model, ModelSymbol, decodeDiagnostic } from "./model.js";
+export type { AttributeFacts, EvalOptions, FeatureValue, Multiplicity, ParseOptions, SpecializationFacts, TypeFacts, } from "./model.js";
+export { LANGUAGES, SourceDocument, sourceDocuments } from "./sources.js";
+export type { Source } from "./sources.js";
+export { Conversion, EXPERIMENTAL_NOTICE, FORMAT_API_JSON, FORMAT_SYSML, FORMAT_TURTLE, MIGRATED_NOT_CONVERTED, MIGRATION_NOTICE, Migration, MigrationReport, formatOfPath, isExperimental, isV1, migrationReportOf, pathIsV1, } from "./conversion.js";
+export type { MigrateOptions, MigrationEntry } from "./conversion.js";
+export { QueryElement, TYPE_COMPOSITE_CONSTRAINT, TYPE_PRIMITIVE_CONSTRAINT, TYPE_QUERY, buildQuery, } from "./query.js";
+export type { ConstraintPayload, QueryForm, QueryPayload, ScopeEntry } from "./query.js";
+export { DocumentQueryResult, DocumentRow, DocumentEvent, documentEventOf, DocumentState, DocumentVerdict, ElementRef, ObjectRef, buildBindings, } from "./document.js";
+export type { BindingValues, DocumentValue } from "./document.js";
+export type { RenderCanvas, RenderEdge, RenderGeometry, RenderNode, RenderNote, RenderPoint, RenderPort, RenderRow, RenderSpan, RenderStyle, RenderedView, } from "./render-view.js";
+export type { Graphs } from "./graphs.js";
+export { ENGINE_ALL, ENGINE_AUTO, STRENGTH_BOUNDED, STRENGTH_NOT_COVERED, STRENGTH_OBSERVED, STRENGTH_PROVED, STRENGTH_WITNESSED, engineInfoOf, explainEngine, explainStanding, standingOf, standingReached, standingReported, } from "./engines.js";
+export type { EngineBound, EngineInfo, Standing } from "./engines.js";
+export { Exploration, Outcome } from "./exploration.js";
+export type { OutcomeValues } from "./exploration.js";
+export { AppliedEdit, Body, EditedDocument, EditRequestBuilder, EditResult, Editor, editErrorOf, editResultOf, errorForFailure, failureName, referrersOf, } from "./edit.js";
+export type { EditOperationData, EditTarget } from "./edit.js";
+export { AnalysisResult, CalcResult, CaseEvaluation, KIND_ASSERTION, KIND_CONSTRAINT, KIND_OBJECT, KIND_OBJECTIVE, KIND_REQUIREMENT, KIND_SATISFY, QUESTION_EVALUATE, QUESTION_HOLDS, QUESTION_SATISFIABLE, STATUS_HOLDS, STATUS_SATISFIABLE, STATUS_UNDECIDED, STATUS_UNSATISFIABLE, STATUS_VIOLATED, SweepRow, SweepTable, Validation, VERDICT_ERROR, VERDICT_FAIL, VERDICT_INCONCLUSIVE, VERDICT_PASS, explainVerificationVerdict, explainVerdict, raiseVerdictError, verificationPassed, verdictEvaluated, verdictHolds, } from "./verdict.js";
+export type { Verdict } from "./verdict.js";
+export { CAPABILITY_APPLY_EDITS, CAPABILITY_ACTION_BODY_STATEMENT_AUTHORING, CAPABILITY_CASE_EVALUATIONS, CAPABILITY_COMPLEX_VALUES, CAPABILITY_BIG_INT_VALUES, CAPABILITY_RATIONAL_VALUES, CAPABILITY_CONVERT, CAPABILITY_CONVERT_DOCUMENTS, CAPABILITY_CONVERT_COMPACT, CAPABILITY_PARSE_SOURCES_AFFECTED, CAPABILITY_MIGRATE, CAPABILITY_DIAGNOSTIC_CODES, CAPABILITY_EDIT_DOCUMENTS, CAPABILITY_ENGINES, CAPABILITY_ENUM_VALUES, CAPABILITY_EVALUATE_SUBJECT, CAPABILITY_FEATURE_VALUES, CAPABILITY_FINAL_TIME, CAPABILITY_FUNCTION_VALUES, CAPABILITY_INFINITY_VALUE, CAPABILITY_INLINE_LANGUAGE, CAPABILITY_MEASUREMENT_REFS, CAPABILITY_METAOBJECT_VALUES, CAPABILITY_PERFORMER, CAPABILITY_STATE_TRACE, CAPABILITY_QUERY, CAPABILITY_SCHEDULE, CAPABILITY_SCHEDULE_EXPLORE, CAPABILITY_SEQUENCE_AUTHORING, CAPABILITY_SET_VALUES, CAPABILITY_STRICT_CONFORMANCE, CAPABILITY_STRUCTURED_VALUES, CAPABILITY_UNDETERMINED_VALUE, CAPABILITY_VERIFICATION_VERDICTS, CAPABILITY_SYMBOL_ATTRIBUTES, CAPABILITY_TENSOR_VALUES, CAPABILITY_TYPE_FACTS, CAPABILITY_UNSET_VALUE, CAPABILITY_VERIFICATION, CAPABILITY_AUTHORING, CAPABILITY_COMMENT_AUTHORING, CAPABILITY_CONNECTION_AUTHORING, CAPABILITY_CONSTRAINT_BODY_AUTHORING, CAPABILITY_DOCUMENTATION_AUTHORING, CAPABILITY_DOCUMENT_QUERY, CAPABILITY_IMPLICIT_PARAMETERS, CAPABILITY_IMPORT_AUTHORING, CAPABILITY_MEMBER_MODIFIERS, CAPABILITY_METADATA_AUTHORING, CAPABILITY_METADATA_PREFIX_AUTHORING, CAPABILITY_PARSE_SOURCES, CAPABILITY_RENDER_DOCUMENT, CAPABILITY_RENDER_DOCUMENT_HTML, CAPABILITY_REQUIREMENT_CONSTRAINT_AUTHORING, CAPABILITY_SATISFY_AUTHORING, CAPABILITY_STATE_ACTION_AUTHORING, CAPABILITY_TRANSITION_AUTHORING, CAPABILITY_VERIFICATION_OBJECTIVE_AUTHORING, CAPABILITY_VERIFICATION_QUESTIONS, CAPABILITY_VERIFICATION_ARGUMENTS, MissingCapabilityError, ServerInfo, capabilityRefusal, mismatchReason, requireCapability, upgradeRemedy, } from "./capabilities.js";
+export { AnalysisRunError, ChecksumMismatchError, ClosedConnectionError, ConversionError, DeleteReferencedError, DocumentQueryError, DownloadError, EditError, EditResultError, EditTargetError, EvaluationError, ExecutionError, FeatureValueError, IllegalMemberKindError, InstanceTypeError, InvalidEditError, InvalidRequestError, MemberNameTakenError, MigrationError, MoveReferencedError, NoEditsError, OverlappingEditsError, OwnerInsideTargetError, OwnerNotFoundError, OwnerNotNamespaceError, ReferencedElsewhereError, Referrer, RenameReferencedError, MalformedValueError, ManifestSignatureError, ModelFileNotFoundError, ModelNotFoundError, OpenSysMLError, ParseError, QueryError, ServiceError, ServiceStartError, ServiceTimeoutError, ServiceUnavailableError, StaleServiceError, SymbolNotFoundError, TypeMismatchError, UnpinnedReleaseError, UnsignedReleaseError, UnsupportedOperationError, UnsupportedValueError, WrongKindError, } from "./errors.js";
 export type { FailureCause, ModelDiagnostic } from "./errors.js";
-export { fromHandshakeError, fromRpcError, statusName } from "./status.js";
-export type { NotFoundSubject } from "./status.js";
-export { decodeValue, decodeVerdict, decodeStanding, encodeValue, formatValue, valuesEqual, } from "./values.js";
-export type { ArrayValue, ComplexValue, EnumValue, FunctionValue, Magnitude, MeasurementRefValue, MetaobjectValue, QuantityValue, SysMLValue, SysMLVerdict, VerdictBound, VerdictStanding, TensorQuantityValue, UndeterminedValue, UnitFactor, UnitFactorization, VerdictSubject, } from "./values.js";
+export { TypedObject, asBoolean, asComplex, asEnum, asInt, asObject, asQuantity, asRational, asReal, asString, asTyped, featureValue, listFeatureValue, optionalFeatureValue, registerTyped, } from "./typed.js";
+export type { FeatureDecoder, InstanceResolver, Quantity, TypedObjectClass, } from "./typed.js";
+export { callRpc, fromHandshakeError, fromRpcError, statusName } from "./status.js";
+export type { NotFoundSubject, UnimplementedMapping } from "./status.js";
+export { decodeValue, decodeVerdict, decodeStanding, encodeValue, formatRational, formatValue, rational, rationalOfDouble, rationalToNumber, rationalsAsReals, requireInput, toValue, valuesEqual, } from "./values.js";
+export type { ArrayValue, ComplexValue, EnumValue, FunctionValue, Magnitude, MeasurementRefValue, MetaobjectValue, QuantityValue, RationalValue, SysMLValue, SysMLVerdict, ValueInput, VerdictBound, VerdictStanding, VerificationVerdict, WitnessAssignment, TensorQuantityValue, UndeterminedValue, UnitFactor, UnitFactorization, VerdictSubject, } from "./values.js";
 export { baseUrl } from "./transport.js";
 export { PACKAGE_NAME, PLATFORM_PACKAGE_PREFIX } from "./package.js";
 export { SysMLService } from "../generated/sysml_pb.js";

package/dist/core/index.js

@@ -1,10 +1,19 @@
 // The isomorphic core: everything that does not need a process to spawn.
 export { Connection } from "./connection.js";
-export { Instance, InstanceTree, Model, ModelSymbol } from "./model.js";
-export { CAPABILITY_APPLY_EDITS, CAPABILITY_ACTION_BODY_STATEMENT_AUTHORING, CAPABILITY_CASE_EVALUATIONS, CAPABILITY_COMPLEX_VALUES, CAPABILITY_CONVERT, CAPABILITY_DIAGNOSTIC_CODES, CAPABILITY_EDIT_DOCUMENTS, CAPABILITY_ENGINES, CAPABILITY_ENUM_VALUES, CAPABILITY_EVALUATE_SUBJECT, CAPABILITY_FEATURE_VALUES, CAPABILITY_FINAL_TIME, CAPABILITY_FUNCTION_VALUES, CAPABILITY_INFINITY_VALUE, CAPABILITY_INLINE_LANGUAGE, CAPABILITY_MEASUREMENT_REFS, CAPABILITY_METAOBJECT_VALUES, CAPABILITY_PERFORMER, CAPABILITY_QUERY, CAPABILITY_SCHEDULE, CAPABILITY_SCHEDULE_EXPLORE, CAPABILITY_SEQUENCE_AUTHORING, CAPABILITY_SET_VALUES, CAPABILITY_STRICT_CONFORMANCE, CAPABILITY_STRUCTURED_VALUES, CAPABILITY_UNDETERMINED_VALUE, CAPABILITY_VERIFICATION_VERDICTS, CAPABILITY_SYMBOL_ATTRIBUTES, CAPABILITY_TENSOR_VALUES, CAPABILITY_TYPE_FACTS, CAPABILITY_UNSET_VALUE, CAPABILITY_VERIFICATION, MissingCapabilityError, ServerInfo, requireCapability, upgradeRemedy, } from "./capabilities.js";
-export { ChecksumMismatchError, ClosedConnectionError, DownloadError, EvaluationError, InvalidRequestError, MalformedValueError, ManifestSignatureError, ModelFileNotFoundError, ModelNotFoundError, OpenSysMLError, ParseError, ServiceError, ServiceStartError, ServiceTimeoutError, SymbolNotFoundError, UnpinnedReleaseError, UnsignedReleaseError, UnsupportedOperationError, } from "./errors.js";
-export { fromHandshakeError, fromRpcError, statusName } from "./status.js";
-export { decodeValue, decodeVerdict, decodeStanding, encodeValue, formatValue, valuesEqual, } from "./values.js";
+export { Instance, InstanceTree, Model, ModelSymbol, decodeDiagnostic } from "./model.js";
+export { LANGUAGES, SourceDocument, sourceDocuments } from "./sources.js";
+export { Conversion, EXPERIMENTAL_NOTICE, FORMAT_API_JSON, FORMAT_SYSML, FORMAT_TURTLE, MIGRATED_NOT_CONVERTED, MIGRATION_NOTICE, Migration, MigrationReport, formatOfPath, isExperimental, isV1, migrationReportOf, pathIsV1, } from "./conversion.js";
+export { QueryElement, TYPE_COMPOSITE_CONSTRAINT, TYPE_PRIMITIVE_CONSTRAINT, TYPE_QUERY, buildQuery, } from "./query.js";
+export { DocumentQueryResult, DocumentRow, DocumentEvent, documentEventOf, DocumentState, DocumentVerdict, ElementRef, ObjectRef, buildBindings, } from "./document.js";
+export { ENGINE_ALL, ENGINE_AUTO, STRENGTH_BOUNDED, STRENGTH_NOT_COVERED, STRENGTH_OBSERVED, STRENGTH_PROVED, STRENGTH_WITNESSED, engineInfoOf, explainEngine, explainStanding, standingOf, standingReached, standingReported, } from "./engines.js";
+export { Exploration, Outcome } from "./exploration.js";
+export { AppliedEdit, Body, EditedDocument, EditRequestBuilder, EditResult, Editor, editErrorOf, editResultOf, errorForFailure, failureName, referrersOf, } from "./edit.js";
+export { AnalysisResult, CalcResult, CaseEvaluation, KIND_ASSERTION, KIND_CONSTRAINT, KIND_OBJECT, KIND_OBJECTIVE, KIND_REQUIREMENT, KIND_SATISFY, QUESTION_EVALUATE, QUESTION_HOLDS, QUESTION_SATISFIABLE, STATUS_HOLDS, STATUS_SATISFIABLE, STATUS_UNDECIDED, STATUS_UNSATISFIABLE, STATUS_VIOLATED, SweepRow, SweepTable, Validation, VERDICT_ERROR, VERDICT_FAIL, VERDICT_INCONCLUSIVE, VERDICT_PASS, explainVerificationVerdict, explainVerdict, raiseVerdictError, verificationPassed, verdictEvaluated, verdictHolds, } from "./verdict.js";
+export { CAPABILITY_APPLY_EDITS, CAPABILITY_ACTION_BODY_STATEMENT_AUTHORING, CAPABILITY_CASE_EVALUATIONS, CAPABILITY_COMPLEX_VALUES, CAPABILITY_BIG_INT_VALUES, CAPABILITY_RATIONAL_VALUES, CAPABILITY_CONVERT, CAPABILITY_CONVERT_DOCUMENTS, CAPABILITY_CONVERT_COMPACT, CAPABILITY_PARSE_SOURCES_AFFECTED, CAPABILITY_MIGRATE, CAPABILITY_DIAGNOSTIC_CODES, CAPABILITY_EDIT_DOCUMENTS, CAPABILITY_ENGINES, CAPABILITY_ENUM_VALUES, CAPABILITY_EVALUATE_SUBJECT, CAPABILITY_FEATURE_VALUES, CAPABILITY_FINAL_TIME, CAPABILITY_FUNCTION_VALUES, CAPABILITY_INFINITY_VALUE, CAPABILITY_INLINE_LANGUAGE, CAPABILITY_MEASUREMENT_REFS, CAPABILITY_METAOBJECT_VALUES, CAPABILITY_PERFORMER, CAPABILITY_STATE_TRACE, CAPABILITY_QUERY, CAPABILITY_SCHEDULE, CAPABILITY_SCHEDULE_EXPLORE, CAPABILITY_SEQUENCE_AUTHORING, CAPABILITY_SET_VALUES, CAPABILITY_STRICT_CONFORMANCE, CAPABILITY_STRUCTURED_VALUES, CAPABILITY_UNDETERMINED_VALUE, CAPABILITY_VERIFICATION_VERDICTS, CAPABILITY_SYMBOL_ATTRIBUTES, CAPABILITY_TENSOR_VALUES, CAPABILITY_TYPE_FACTS, CAPABILITY_UNSET_VALUE, CAPABILITY_VERIFICATION, CAPABILITY_AUTHORING, CAPABILITY_COMMENT_AUTHORING, CAPABILITY_CONNECTION_AUTHORING, CAPABILITY_CONSTRAINT_BODY_AUTHORING, CAPABILITY_DOCUMENTATION_AUTHORING, CAPABILITY_DOCUMENT_QUERY, CAPABILITY_IMPLICIT_PARAMETERS, CAPABILITY_IMPORT_AUTHORING, CAPABILITY_MEMBER_MODIFIERS, CAPABILITY_METADATA_AUTHORING, CAPABILITY_METADATA_PREFIX_AUTHORING, CAPABILITY_PARSE_SOURCES, CAPABILITY_RENDER_DOCUMENT, CAPABILITY_RENDER_DOCUMENT_HTML, CAPABILITY_REQUIREMENT_CONSTRAINT_AUTHORING, CAPABILITY_SATISFY_AUTHORING, CAPABILITY_STATE_ACTION_AUTHORING, CAPABILITY_TRANSITION_AUTHORING, CAPABILITY_VERIFICATION_OBJECTIVE_AUTHORING, CAPABILITY_VERIFICATION_QUESTIONS, CAPABILITY_VERIFICATION_ARGUMENTS, MissingCapabilityError, ServerInfo, capabilityRefusal, mismatchReason, requireCapability, upgradeRemedy, } from "./capabilities.js";
+export { AnalysisRunError, ChecksumMismatchError, ClosedConnectionError, ConversionError, DeleteReferencedError, DocumentQueryError, DownloadError, EditError, EditResultError, EditTargetError, EvaluationError, ExecutionError, FeatureValueError, IllegalMemberKindError, InstanceTypeError, InvalidEditError, InvalidRequestError, MemberNameTakenError, MigrationError, MoveReferencedError, NoEditsError, OverlappingEditsError, OwnerInsideTargetError, OwnerNotFoundError, OwnerNotNamespaceError, ReferencedElsewhereError, Referrer, RenameReferencedError, MalformedValueError, ManifestSignatureError, ModelFileNotFoundError, ModelNotFoundError, OpenSysMLError, ParseError, QueryError, ServiceError, ServiceStartError, ServiceTimeoutError, ServiceUnavailableError, StaleServiceError, SymbolNotFoundError, TypeMismatchError, UnpinnedReleaseError, UnsignedReleaseError, UnsupportedOperationError, UnsupportedValueError, WrongKindError, } from "./errors.js";
+export { TypedObject, asBoolean, asComplex, asEnum, asInt, asObject, asQuantity, asRational, asReal, asString, asTyped, featureValue, listFeatureValue, optionalFeatureValue, registerTyped, } from "./typed.js";
+export { callRpc, fromHandshakeError, fromRpcError, statusName } from "./status.js";
+export { decodeValue, decodeVerdict, decodeStanding, encodeValue, formatRational, formatValue, rational, rationalOfDouble, rationalToNumber, rationalsAsReals, requireInput, toValue, valuesEqual, } from "./values.js";
 export { baseUrl } from "./transport.js";
 export { PACKAGE_NAME, PLATFORM_PACKAGE_PREFIX } from "./package.js";
 export { SysMLService } from "../generated/sysml_pb.js";

package/dist/core/model.d.ts

@@ -1,14 +1,32 @@
-import type { Connection } from "./connection.js";
+import type { Connection, VerifyOptions } from "./connection.js";
 import type { ModelDiagnostic } from "./errors.js";
-import type { Instance as PbInstance, ParseFileRequest, SymbolInfo } from "../generated/sysml_pb.js";
-import { type SysMLValue } from "./values.js";
+import type { Conversion } from "./conversion.js";
+import type { QueryForm, QueryElement, QueryPayload } from "./query.js";
+import type { BindingValues, DocumentQueryResult } from "./document.js";
+import type { RenderedView } from "./render-view.js";
+import type { Graphs } from "./graphs.js";
+import type { Editor } from "./edit.js";
+import type { Exploration } from "./exploration.js";
+import type { AnalysisResult, CalcResult, SweepTable, Validation, Verdict } from "./verdict.js";
+import type { Diagnostic, Instance as PbInstance, ParseFileRequest, SymbolInfo } from "../generated/sysml_pb.js";
+import { type SysMLValue, type ValueInput } from "./values.js";
 /** How a source is parsed. */
 export interface ParseOptions {
     /** Language of inline content ("sysml" or "kerml"); requires `inline_language`. */
     language?: string;
     /** Reject the OpenSysML notation extensions; requires `strict_conformance`. */
+    strictConformance?: boolean;
+    /**
+     * @deprecated Use `strictConformance`; `strict` is its alias. Passing both
+     * with different values is refused.
+     */
     strict?: boolean;
 }
+/** Resolves `strictConformance` and its `strict` alias; differing values refuse. */
+export declare function strictConformanceOf(options: {
+    strict?: boolean;
+    strictConformance?: boolean;
+}): boolean | undefined;
 /** Where an expression is evaluated. */
 export interface EvalOptions {
     /** FQN of the symbol whose scope the expression's names resolve in. */
@@ -16,6 +34,15 @@ export interface EvalOptions {
     /** FQN of a usage to instantiate and evaluate against; requires `evaluate_subject`. */
     subject?: string;
 }
+/** A declared multiplicity range. A bound the service could not evaluate is empty. */
+export interface Multiplicity {
+    readonly lower: string;
+    readonly upper: string;
+    /** Whether the range admits no value; undefined when the lower bound is unknown. */
+    readonly isOptional: boolean | undefined;
+    /** Whether the range admits more than one value; undefined when the upper bound is unknown. */
+    readonly isCollection: boolean | undefined;
+}
 /** A model the service has parsed and holds under its hash. */
 export declare class Model {
     readonly connection: Connection;
@@ -23,15 +50,33 @@ export declare class Model {
     readonly hash: string;
     /** Diagnostics the parse reported, in the order the service reported them. */
     readonly diagnostics: readonly ModelDiagnostic[];
-    private readonly rootSymbol;
+    /** The name of each document this model was parsed from, empty for an adopted model. */
+    readonly documents: readonly string[];
+    private readonly rootSymbols;
     private readonly ownsConnection;
     private constructor();
     /** Adopts a model the service already holds, by the hash it holds it under. */
     static adopt(connection: Connection, hash: string): Model;
+    /** Builds a model of several roots, from a ParseSources response. */
+    static fromRoots(connection: Connection, hash: string, roots: readonly SymbolInfo[], diagnostics: readonly ModelDiagnostic[], options?: {
+        ownsConnection?: boolean;
+        documents?: readonly string[];
+    }): Model;
     /** Whether this model was parsed here, and so knows its root symbol. */
     get parsed(): boolean;
     /** The model's root namespace. An adopted model has none: look symbols up by id. */
     get root(): ModelSymbol;
+    /** One root per document parsed; the one symbol {@link root} names is the first. */
+    get roots(): readonly ModelSymbol[];
+    /** The path this model was loaded from, when it was parsed from a file;
+     * inline content and parseSources models have none, whatever they are named. */
+    readonly sourcePath: string | undefined;
+    /** The error-severity diagnostics the parse reported. */
+    get errors(): ModelDiagnostic[];
+    /** Whether the parse reported no error-severity diagnostic. */
+    get ok(): boolean;
+    /** Raises a {@link ParseError} carrying this model when its parse reported errors. */
+    raiseForErrors(): this;
     /** Parses a source over `connection`. Used by Connection.load / Connection.loads. */
     static parse(connection: Connection, source: Pick<ParseFileRequest, "source">, options?: ParseOptions, ownsConnection?: boolean): Promise<Model>;
     /** Whether the parse reported an error-severity diagnostic. */
@@ -40,6 +85,122 @@ export declare class Model {
     eval(expression: string, options?: EvalOptions): Promise<SysMLValue>;
     /** Looks a symbol up by short name, FQN or id; throws when the model declares none. */
     symbol(name: string): Promise<ModelSymbol>;
+    /** Writes this model out in `toFormat`. */
+    convert(toFormat: string, options?: {
+        fromFormat?: string;
+        tolerateSyntaxErrors?: boolean;
+    }): Promise<Conversion>;
+    /** This model written in SysML notation. */
+    toSysml(): Promise<Conversion>;
+    /** This model written as RDF Turtle. */
+    toTurtle(): Promise<Conversion>;
+    /** This model written as API JSON. */
+    toApiJson(): Promise<Conversion>;
+    /** Runs a SysML v2 API & Services Query over this model. */
+    query(options?: {
+        payload?: QueryPayload;
+    } & QueryForm): Promise<QueryElement[]>;
+    /** Runs a named document query against this model. */
+    runDocumentQuery(queryId: string, bindings?: Readonly<Record<string, BindingValues>>): Promise<DocumentQueryResult>;
+    /** Renders a named document of this model to Markdown or HTML. */
+    renderDocument(documentId: string, options?: {
+        form?: "markdown" | "html";
+    }): Promise<string>;
+    /** Renders a named view or targeted pseudo-view as diagram data. */
+    renderView(viewName: string, options?: {
+        ports?: "minimal" | "full";
+    }): Promise<RenderedView>;
+    /** Exports the lowered graph of an action or state machine of this model as `graphs:1` JSON. */
+    exportGraphs(subject: string): Promise<Graphs>;
+    /** Starts an edit of this model, to be applied in one call. */
+    edit(): Editor;
+    /** Executes an action definition of this model. */
+    executeAction(actionSymbolId: string, options?: {
+        inputs?: Readonly<Record<string, ValueInput>>;
+        schedule?: string;
+        performer?: string;
+    }): Promise<{
+        outputs: ReadonlyMap<string, SysMLValue | import("./errors.js").UnsupportedValueError>;
+        performer: ReadonlyMap<string, SysMLValue | import("./errors.js").UnsupportedValueError>;
+        finalTime: number;
+    }>;
+    /** Runs an action once per valid order of its choice points. */
+    exploreAction(actionSymbolId: string, options?: {
+        inputs?: Readonly<Record<string, ValueInput>>;
+        schedule?: string;
+        performer?: string;
+    }): Promise<Exploration>;
+    /** Executes a state machine of this model. */
+    executeState(stateMachineSymbolId: string, options?: {
+        events?: readonly string[];
+        schedule?: string;
+        performer?: string;
+        trace?: boolean;
+    }): Promise<{
+        statesVisited: string[];
+        finalContext: ReadonlyMap<string, SysMLValue | import("./errors.js").UnsupportedValueError>;
+        finalTime: number;
+        trace: import("./document.js").DocumentEvent[];
+        traceDropped: number;
+    }>;
+    /** Runs a state machine once per valid order of its choice points. */
+    exploreState(stateMachineSymbolId: string, options?: {
+        events?: readonly string[];
+        schedule?: string;
+        performer?: string;
+    }): Promise<Exploration>;
+    /** Asks whether a constraint of this model holds. */
+    verifyConstraint(symbolId: string, options?: VerifyOptions): Promise<Verdict>;
+    /** Asks whether a requirement of this model is satisfied. */
+    verifyRequirement(symbolId: string, options?: VerifyOptions): Promise<Verdict>;
+    /** Asks whether this model's satisfaction assertions hold. */
+    verifySatisfaction(options?: {
+        symbolId?: string;
+        engine?: string;
+        question?: string;
+    }): Promise<Verdict[]>;
+    /** Whether every verdict {@link verifySatisfaction} returns holds. */
+    satisfied(options?: {
+        symbolId?: string;
+        engine?: string;
+        question?: string;
+    }): Promise<boolean>;
+    /** Checks every assertion about an object of this model's parts. */
+    validateInstance(symbolId: string, options?: {
+        engine?: string;
+    }): Promise<Validation>;
+    /** Invokes a calculation of this model. */
+    calc(symbolId: string, options?: {
+        arguments?: readonly ValueInput[];
+        engine?: string;
+    }): Promise<CalcResult>;
+    /** Runs an analysis case of this model. */
+    runAnalysis(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(symbolId: string, options?: {
+        subject?: string;
+        arguments?: readonly ValueInput[];
+        namedArguments?: Readonly<Record<string, ValueInput>>;
+        schedule?: string;
+    }): Promise<Exploration>;
+    /** Runs an analysis case or calc of this model once per row of a sweep. */
+    runSweep(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>;
+    /** The diagnostics the service reports for this model now — for a model of
+     * several documents, or one parsed before later edits changed it. */
+    refreshDiagnostics(): Promise<ModelDiagnostic[]>;
     /** Looks a symbol up by its qualified name, in one call. */
     symbolById(id: string): Promise<ModelSymbol>;
     /** Looks a symbol up by short name, FQN or id, breadth-first from the root. */
@@ -89,10 +250,7 @@ export declare class ModelSymbol {
     readonly childIds: readonly string[];
     readonly attributes: readonly AttributeFacts[];
     readonly type: TypeFacts | undefined;
-    readonly multiplicity: {
-        lower: string;
-        upper: string;
-    } | undefined;
+    readonly multiplicity: Multiplicity | undefined;
     readonly specializations: readonly SpecializationFacts[];
     /** Library attributes the service did not send, when it withheld any. */
     readonly withheldLibraryAttributes: number;
@@ -137,3 +295,5 @@ export declare class InstanceTree {
     /** The object with this id, or undefined when the instantiation produced none. */
     byId(id: bigint): Instance | undefined;
 }
+/** Reads a wire `Diagnostic` into this client's own {@link ModelDiagnostic}. */
+export declare function decodeDiagnostic(diagnostic: Diagnostic): ModelDiagnostic;