Variable SysProMDocumentConst
SysProMDocument: ZodObject<
{
$schema: ZodOptional<ZodString>;
external_references: ZodOptional<
ZodArray<
ZodObject<
{
description: ZodOptional<
ZodUnion<(...)> & { is(value: ...): value is (...) },
>;
identifier: ZodString;
internalised: ZodOptional<
ZodUnion<(...)> & { is(value: ...): value is (...) },
>;
node_id: ZodOptional<ZodString>;
role: ZodEnum<
{
context: ...;
evidence: ...;
input: ...;
output: ...;
prior_art: ...;
source: ...;
standard: ...;
},
> & {
is(
value: unknown,
): value is (...) | (...) | (...) | (...) | (...) | (...) | (...);
};
},
$strip,
> & {
is(
value: unknown,
): value is {
description?: string | string[];
identifier: string;
internalised?: string | string[];
node_id?: string;
role:
| "output"
| "input"
| "context"
| "evidence"
| "source"
| "standard"
| "prior_art";
};
},
>,
>;
metadata: ZodOptional<
ZodObject<
{
doc_type: ZodOptional<ZodString>;
scope: ZodOptional<ZodString>;
status: ZodOptional<ZodString>;
title: ZodOptional<ZodString>;
version: ZodOptional<ZodUnion<readonly [ZodString, ZodInt]>>;
},
$loose,
> & {
is(
value: unknown,
): value is {
doc_type?: string;
scope?: string;
status?: string;
title?: string;
version?: string | number;
[key: string]: unknown;
};
},
>;
nodes: ZodArray<
ZodObject<
{
context: ZodOptional<
ZodUnion<readonly [ZodString, ZodArray<(...)>]> & {
is(value: unknown): value is string | (...)[];
},
>;
description: ZodOptional<
ZodUnion<readonly [ZodString, ZodArray<(...)>]> & {
is(value: unknown): value is string | (...)[];
},
>;
external_references: ZodOptional<
ZodArray<
ZodObject<
{
description: ...;
identifier: ...;
internalised: ...;
node_id: ...;
role: ...;
},
$strip,
> & {
is(
value: unknown,
): value is {
description?: ...;
identifier: ...;
internalised?: ...;
node_id?: ...;
role: ...;
};
},
>,
>;
id: ZodString;
includes: ZodOptional<ZodArray<ZodString>>;
lifecycle: ZodOptional<
ZodRecord<ZodString, ZodUnion<readonly [ZodBoolean, ZodString]>>,
>;
name: ZodString;
operations: ZodOptional<
ZodArray<
ZodObject<{ description: ...; target: ...; type: ... }, $loose> & {
is(
value: unknown,
): value is {
description?: ...;
target?: ...;
type: ...;
[key: ...]: ...;
};
},
>,
>;
options: ZodOptional<
ZodArray<
ZodObject<{ description: ...; id: ... }, $loose> & {
is(
value: unknown,
): value is { description: ...; id: ...; [key: ...]: ... };
},
>,
>;
propagation: ZodOptional<ZodRecord<ZodString, ZodBoolean>>;
rationale: ZodOptional<
ZodUnion<readonly [ZodString, ZodArray<(...)>]> & {
is(value: unknown): value is string | (...)[];
},
>;
scope: ZodOptional<ZodArray<ZodString>>;
selected: ZodOptional<ZodString>;
status: ZodOptional<ZodNever>;
type: ZodEnum<
{
artefact: "artefact";
capability: "capability";
change: "change";
concept: "concept";
decision: "decision";
element: "element";
gate: "gate";
intent: "intent";
invariant: "invariant";
milestone: "milestone";
mode: "mode";
policy: "policy";
principle: "principle";
protocol: "protocol";
realisation: "realisation";
role: "role";
stage: "stage";
view: "view";
},
> & {
is(
value: unknown,
): value is
| "intent"
| "concept"
| "capability"
| "element"
| "realisation"
| "invariant"
| "principle"
| "policy"
| "protocol"
| "stage"
| "role"
| "gate"
| "mode"
| "artefact"
| "decision"
| "change"
| "view"
| "milestone";
};
get subsystem(): ZodOptional<
(
ZodObject<{ $schema: ZodOptional<ZodString>; metadata: ZodOptional<ZodObject<{ title: ZodOptional<ZodString>; doc_type: ZodOptional<ZodString>; scope: ZodOptional<...>; status: ZodOptional<...>; version: ZodOptional<...>; }, $loose> & { ...; }>; nodes: ZodArray<...>; relationships: ZodOptional<...>; external_referen...
),
>;
},
$loose,
>,
>;
relationships: ZodOptional<
ZodArray<
ZodObject<
{
description: ZodOptional<
ZodUnion<(...)> & { is(value: ...): value is (...) },
>;
from: ZodString;
polarity: ZodOptional<
ZodEnum<(...)> & { is(value: ...): value is (...) },
>;
strength: ZodOptional<ZodNumber>;
to: ZodString;
type: ZodEnum<
{
affects: ...;
constrained_by: ...;
depends_on: ...;
governed_by: ...;
implements: ...;
modifies: ...;
must_follow: ...;
must_preserve: ...;
part_of: ...;
precedes: ...;
produces: ...;
realises: ...;
refines: ...;
supersedes: ...;
},
> & {
is(
value: unknown,
): value is
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
};
},
$loose,
> & {
is(
value: unknown,
): value is {
description?: string | string[];
from: string;
polarity?: "positive" | "negative" | "neutral" | "uncertain";
strength?: number;
to: string;
type:
| "refines"
| "realises"
| "implements"
| "depends_on"
| "constrained_by"
| "affects"
| "supersedes"
| "must_preserve"
| "part_of"
| "precedes"
| "must_follow"
| "governed_by"
| "modifies"
| "produces";
[key: string]: unknown;
};
},
>,
>;
},
$strip,
> & {
is(
value: unknown,
): value is {
$schema?: string;
external_references?: {
description?: string | string[];
identifier: string;
internalised?: string | string[];
node_id?: string;
role:
| "output"
| "input"
| "context"
| "evidence"
| "source"
| "standard"
| "prior_art";
}[];
metadata?: {
doc_type?: string;
scope?: string;
status?: string;
title?: string;
version?: string
| number;
[key: string]: unknown;
};
nodes: {
context?: string
| string[];
description?: string | string[];
external_references?: {
description?: string | string[];
identifier: string;
internalised?: string | string[];
node_id?: string;
role:
| "output"
| "input"
| "context"
| "evidence"
| "source"
| "standard"
| "prior_art";
}[];
id: string;
includes?: string[];
lifecycle?: Record<string, string | boolean>;
name: string;
operations?: {
description?: string | string[];
target?: string;
type: "link" | "add" | "update" | "remove";
[key: string]: unknown;
}[];
options?: {
description: string
| string[];
id: string;
[key: string]: unknown;
}[];
propagation?: Record<string, boolean>;
rationale?: string | string[];
scope?: string[];
selected?: string;
status?: undefined;
subsystem?: { nodes: { [x: string]: unknown; id: string; type: "intent" | "concept" | "capability" | "element" | "realisation" | "invariant" | "principle" | "policy" | "protocol" | "stage" | "role" | "gate" | ... 5 more ... | "milestone"; ... 13 more ...; subsystem?: ... | undefined; }[]; $schema?: string | undefined; metadata?...;
type:
| "intent"
| "concept"
| "capability"
| "element"
| "realisation"
| "invariant"
| "principle"
| "policy"
| "protocol"
| "stage"
| "role"
| "gate"
| "mode"
| "artefact"
| "decision"
| "change"
| "view"
| "milestone";
[key: string]: unknown;
}[];
relationships?: {
description?: string
| string[];
from: string;
polarity?: "positive" | "negative" | "neutral" | "uncertain";
strength?: number;
to: string;
type:
| "refines"
| "realises"
| "implements"
| "depends_on"
| "constrained_by"
| "affects"
| "supersedes"
| "must_preserve"
| "part_of"
| "precedes"
| "must_follow"
| "governed_by"
| "modifies"
| "produces";
[key: string]: unknown;
}[];
};
} = ...
Zod schema for a complete SysProM document — the root container holding nodes, relationships, external references, and metadata. Includes a
.is()type guard for runtime validation.