@istar-ts/core 0.8.0 → 0.9.0

package/dist/index.d.cts

@@ -122,7 +122,9 @@ export interface ModelIssue<LK extends string = LinkKind> {
  * first (each checked before its own links are added), then the remaining links in file
  * order, each against the graph built so far. Invalid links are reported, not removed.
  */
-export declare function validateModel<EK extends string = ElementKind, LK extends string = LinkKind>(model: IstarModel<EK, LK>, options?: CanLinkOptions<EK, LK>): ModelIssue<LK>[];
+export declare function validateModel<EK extends string, LK extends string>(model: IstarModel<EK, LK>, options: CanLinkOptions<EK, LK>): ModelIssue<LK>[];
+export declare function validateModel<EK extends string, LK extends string>(model: IstarModel<EK, LK>): ModelIssue<LK>[];
+export declare function validateModel(model: IstarModel): ModelIssue[];
 //#endregion
 //#region src/metamodels.d.ts
 export type ElementCategory = "actor" | "node";
@@ -390,10 +392,20 @@ export declare function createEmptyModel(diagram?: Diagram): IstarModel;
  * iStar 2.0. Constraints, operations and serialization use it unless given another one.
  */
 export declare function metamodelOf<EK extends string, LK extends string>(model: IstarModel<EK, LK>): Metamodel<EK, LK>;
-/** True for actor-category elements; pass the metamodel for extended actor kinds. */
-export declare function isActor(element: IstarElement<string> | undefined, metamodel?: AnyMetamodel): element is IstarActor;
-/** True for node-category elements; pass the metamodel for extended node kinds. */
-export declare function isNode(element: IstarElement<string> | undefined, metamodel?: AnyMetamodel): element is IstarNode;
+/**
+ * True for iStar 2.0 actors (Actor, Agent, Role). One argument, so it is safe as an array
+ * callback (`elements.filter(isActor)`). For extended actor kinds use `isActorIn(metamodel)`.
+ */
+export declare function isActor(element: IstarElement<string> | undefined): element is IstarActor;
+/** True for iStar 2.0 intentional elements. For extended kinds use `isNodeIn(metamodel)`. */
+export declare function isNode(element: IstarElement<string> | undefined): element is IstarNode;
+/**
+ * A predicate for actor-category elements of `metamodel`, extended actor kinds included:
+ * `elements.filter(isActorIn(metamodelOf(model)))`.
+ */
+export declare function isActorIn(metamodel: AnyMetamodel): (element: IstarElement<string> | undefined) => boolean;
+/** A predicate for node-category elements of `metamodel`, extended node kinds included. */
+export declare function isNodeIn(metamodel: AnyMetamodel): (element: IstarElement<string> | undefined) => boolean;
 /** Inner elements of an actor, in model order. */
 export declare function childrenOf<EK extends string, LK extends string>(model: IstarModel<EK, LK>, actorId: string): IstarElement<EK>[];
 /** Links that have the element as source or target. */

package/dist/index.d.ts

@@ -122,7 +122,9 @@ export interface ModelIssue<LK extends string = LinkKind> {
  * first (each checked before its own links are added), then the remaining links in file
  * order, each against the graph built so far. Invalid links are reported, not removed.
  */
-export declare function validateModel<EK extends string = ElementKind, LK extends string = LinkKind>(model: IstarModel<EK, LK>, options?: CanLinkOptions<EK, LK>): ModelIssue<LK>[];
+export declare function validateModel<EK extends string, LK extends string>(model: IstarModel<EK, LK>, options: CanLinkOptions<EK, LK>): ModelIssue<LK>[];
+export declare function validateModel<EK extends string, LK extends string>(model: IstarModel<EK, LK>): ModelIssue<LK>[];
+export declare function validateModel(model: IstarModel): ModelIssue[];
 //#endregion
 //#region src/metamodels.d.ts
 export type ElementCategory = "actor" | "node";
@@ -390,10 +392,20 @@ export declare function createEmptyModel(diagram?: Diagram): IstarModel;
  * iStar 2.0. Constraints, operations and serialization use it unless given another one.
  */
 export declare function metamodelOf<EK extends string, LK extends string>(model: IstarModel<EK, LK>): Metamodel<EK, LK>;
-/** True for actor-category elements; pass the metamodel for extended actor kinds. */
-export declare function isActor(element: IstarElement<string> | undefined, metamodel?: AnyMetamodel): element is IstarActor;
-/** True for node-category elements; pass the metamodel for extended node kinds. */
-export declare function isNode(element: IstarElement<string> | undefined, metamodel?: AnyMetamodel): element is IstarNode;
+/**
+ * True for iStar 2.0 actors (Actor, Agent, Role). One argument, so it is safe as an array
+ * callback (`elements.filter(isActor)`). For extended actor kinds use `isActorIn(metamodel)`.
+ */
+export declare function isActor(element: IstarElement<string> | undefined): element is IstarActor;
+/** True for iStar 2.0 intentional elements. For extended kinds use `isNodeIn(metamodel)`. */
+export declare function isNode(element: IstarElement<string> | undefined): element is IstarNode;
+/**
+ * A predicate for actor-category elements of `metamodel`, extended actor kinds included:
+ * `elements.filter(isActorIn(metamodelOf(model)))`.
+ */
+export declare function isActorIn(metamodel: AnyMetamodel): (element: IstarElement<string> | undefined) => boolean;
+/** A predicate for node-category elements of `metamodel`, extended node kinds included. */
+export declare function isNodeIn(metamodel: AnyMetamodel): (element: IstarElement<string> | undefined) => boolean;
 /** Inner elements of an actor, in model order. */
 export declare function childrenOf<EK extends string, LK extends string>(model: IstarModel<EK, LK>, actorId: string): IstarElement<EK>[];
 /** Links that have the element as source or target. */

package/dist/index.js

@@ -414,13 +414,27 @@ function createEmptyModel(diagram = DEFAULT_DIAGRAM, options = {}) {
 function metamodelOf(model) {
 	return metamodels.get(model) ?? ISTAR_2_0;
 }
-/** True for actor-category elements; pass the metamodel for extended actor kinds. */
-function isActor(element, metamodel = ISTAR_2_0) {
-	return element !== void 0 && isActorKindIn(metamodel, element.kind);
+/**
+* True for iStar 2.0 actors (Actor, Agent, Role). One argument, so it is safe as an array
+* callback (`elements.filter(isActor)`). For extended actor kinds use `isActorIn(metamodel)`.
+*/
+function isActor(element) {
+	return element !== void 0 && isActorKindIn(ISTAR_2_0, element.kind);
+}
+/** True for iStar 2.0 intentional elements. For extended kinds use `isNodeIn(metamodel)`. */
+function isNode(element) {
+	return element !== void 0 && !isActorKindIn(ISTAR_2_0, element.kind);
 }
-/** True for node-category elements; pass the metamodel for extended node kinds. */
-function isNode(element, metamodel = ISTAR_2_0) {
-	return element !== void 0 && !isActorKindIn(metamodel, element.kind);
+/**
+* A predicate for actor-category elements of `metamodel`, extended actor kinds included:
+* `elements.filter(isActorIn(metamodelOf(model)))`.
+*/
+function isActorIn(metamodel) {
+	return (element) => element !== void 0 && isActorKindIn(metamodel, element.kind);
+}
+/** A predicate for node-category elements of `metamodel`, extended node kinds included. */
+function isNodeIn(metamodel) {
+	return (element) => element !== void 0 && metamodel.elements.get(element.kind)?.category === "node";
 }
 /** Inner elements of an actor, in model order. */
 function childrenOf(model, actorId) {
@@ -689,13 +703,8 @@ const CHECKS = {
 	"istar.ContributionLink": contributionLink,
 	"istar.QualificationLink": qualificationLink
 };
-/**
-* Re-validates every link of a model, the way piStar does when loading a file: dependencies
-* first (each checked before its own links are added), then the remaining links in file
-* order, each against the graph built so far. Invalid links are reported, not removed.
-*/
-function validateModel(model, options = {}) {
-	const metamodel = options.metamodel ?? metamodelOf(model);
+function validateModel(model, options) {
+	const metamodel = (typeof options === "object" && options !== null ? options.metamodel : void 0) ?? metamodelOf(model);
 	const any = model;
 	const issues = [];
 	const accepted = /* @__PURE__ */ new Map();
@@ -1075,7 +1084,7 @@ function typed(model) {
 function metaOf(model) {
 	return metamodelOf(model);
 }
-function isActorIn(model, kind) {
+function isActorIn$1(model, kind) {
 	return metaOf(model).elements.get(kind)?.category === "actor";
 }
 function derive(from, changes) {
@@ -1108,7 +1117,7 @@ function addElement(model, input, ctx = {}) {
 	if (m.elements.has(id) || m.links.has(id)) throw new ModelOperationError(`id "${id}" is already in use`);
 	if (input.parent !== void 0) {
 		if (definition.category === "actor") throw new ModelOperationError("actors cannot be nested");
-		if (!isActorIn(m, requireElement(m, input.parent).kind)) throw new ModelOperationError(`parent "${input.parent}" is not an actor`);
+		if (!isActorIn$1(m, requireElement(m, input.parent).kind)) throw new ModelOperationError(`parent "${input.parent}" is not an actor`);
 	}
 	const element = withoutUndefined({
 		id,
@@ -1160,7 +1169,7 @@ function moveElement(model, id, x, y) {
 		x,
 		y
 	});
-	if (isActorIn(m, current.kind)) {
+	if (isActorIn$1(m, current.kind)) {
 		for (const child of m.elements.values()) if (child.parent === id) elements.set(child.id, {
 			...child,
 			x: child.x + dx,
@@ -1177,10 +1186,10 @@ function moveElement(model, id, x, y) {
 function nestElement(model, id, parent) {
 	const m = any(model);
 	const current = requireElement(m, id);
-	if (isActorIn(m, current.kind)) throw new ModelOperationError("actors cannot be nested");
+	if (isActorIn$1(m, current.kind)) throw new ModelOperationError("actors cannot be nested");
 	if (current.isDependum) throw new ModelOperationError("a dependum cannot be nested");
 	if ((current.parent ?? null) === parent) return model;
-	if (parent !== null && !isActorIn(m, requireElement(m, parent).kind)) throw new ModelOperationError(`parent "${parent}" is not an actor`);
+	if (parent !== null && !isActorIn$1(m, requireElement(m, parent).kind)) throw new ModelOperationError(`parent "${parent}" is not an actor`);
 	const elements = new Map(m.elements);
 	elements.delete(id);
 	const { parent: _old, ...rest } = current;
@@ -1832,6 +1841,6 @@ function validateModelProperties(model, schemas) {
 	return issues;
 }
 //#endregion
-export { ACTOR_KINDS, ACTOR_LINK_KINDS, CONTRIBUTION_LABELS, DEFAULT_DIAGRAM, DEFAULT_ELEMENT_SIZE, DEPENDENCY_LINK_KINDS, ELEMENT_KINDS, ISTAR_2_0, ISTAR_PREFIX, ISTAR_VERSION, LINK_KINDS, LINK_KIND_INFO, METAMODEL_VERSION, MetamodelError, ModelOperationError, NODE_KINDS, NODE_KIND_INFO, NODE_LINK_KINDS, PISTAR_TOOL, PistarParseError, PistarWriteError, addDependency, addElement, boolean, canLink, childrenOf, connect, createEmptyModel, createModelStore, defaultIdGenerator, defineMetamodelExtension, defineProperties, dependencyEnds, dependencyLinksOf, disconnect, effectiveElementKind, effectiveLinkKind, elementBehavesLike, elementKindDefinition, enumOf, extendMetamodel, getSourceLayout, inheritMetamodel, inheritSourceLayout, isActor, isActorKind, isActorKindIn, isActorLinkKind, isContributionLabel, isDependencyLinkKind, isElementKind, isLinkKind, isNode, isNodeKind, isNodeKindIn, isNodeLinkKind, linkKindDefinition, linksOf, metamodelOf, moveElement, nestElement, number, parsePistar, prop, removeElement, removeElements, shortKindName, string, toPistar, toPistarObject, updateDiagram, updateElement, updateLink, validateModel, validateModelProperties, withMetamodel };
+export { ACTOR_KINDS, ACTOR_LINK_KINDS, CONTRIBUTION_LABELS, DEFAULT_DIAGRAM, DEFAULT_ELEMENT_SIZE, DEPENDENCY_LINK_KINDS, ELEMENT_KINDS, ISTAR_2_0, ISTAR_PREFIX, ISTAR_VERSION, LINK_KINDS, LINK_KIND_INFO, METAMODEL_VERSION, MetamodelError, ModelOperationError, NODE_KINDS, NODE_KIND_INFO, NODE_LINK_KINDS, PISTAR_TOOL, PistarParseError, PistarWriteError, addDependency, addElement, boolean, canLink, childrenOf, connect, createEmptyModel, createModelStore, defaultIdGenerator, defineMetamodelExtension, defineProperties, dependencyEnds, dependencyLinksOf, disconnect, effectiveElementKind, effectiveLinkKind, elementBehavesLike, elementKindDefinition, enumOf, extendMetamodel, getSourceLayout, inheritMetamodel, inheritSourceLayout, isActor, isActorIn, isActorKind, isActorKindIn, isActorLinkKind, isContributionLabel, isDependencyLinkKind, isElementKind, isLinkKind, isNode, isNodeIn, isNodeKind, isNodeKindIn, isNodeLinkKind, linkKindDefinition, linksOf, metamodelOf, moveElement, nestElement, number, parsePistar, prop, removeElement, removeElements, shortKindName, string, toPistar, toPistarObject, updateDiagram, updateElement, updateLink, validateModel, validateModelProperties, withMetamodel };
 
 //# sourceMappingURL=index.js.map