@api-client/core 0.12.2 → 0.12.4

package/build/src/modeling/DomainVersioning.js

@@ -6,7 +6,22 @@
  */
 export function createGraphVersion(root, version) {
     root.info.version = version;
-    return serializeForVersionRelease(root);
+    const graph = serializeForVersionRelease(root);
+    const result = {
+        key: root.key,
+        kind: root.kind,
+        info: root.info.toJSON(),
+        graph,
+    };
+    if (root.dependencyList.length) {
+        // Note: the used dependencies are serialized in the graph.
+        // The dependency list is only preserved for linage purposes.
+        result.dependencyList = [...root.dependencyList];
+    }
+    if (root.fields.length) {
+        result.fields = [...root.fields];
+    }
+    return result;
 }
 /**
  * Serializes a DataDomain for version release, including only relevant foreign nodes.

package/build/src/modeling/DomainVersioning.js.map

@@ -1 +1 @@
-{"version":3,"file":"DomainVersioning.js","sourceRoot":"","sources":["../../../src/modeling/DomainVersioning.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAgB,EAAE,OAAe;IAClE,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IAC3B,OAAO,0BAA0B,CAAC,IAAI,CAAC,CAAA;AACzC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,UAAsB;IAC/D,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,UAAU,CAAA;IAC5C,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAU,CAAA;IAE9C,yEAAyE;IACzE,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAQ;QACV,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACvC,SAAQ,CAAC,mBAAmB;QAC9B,CAAC;QAED,mFAAmF;QACnF,IAAI,kBAAkB,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC;YAC/C,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IAED,gDAAgD;IAChD,MAAM,KAAK,GAAG,EAAE,CAAA;IAChB,MAAM,KAAK,GAAG,EAAE,CAAA;IAEhB,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAQ;QACV,CAAC;QAED,IAAI,SAAS,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,IAAI,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACzE,MAAM,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;YACxC,MAAM,cAAc,GAAiB,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,CAAA;YAC3E,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,cAAc,CAAC,OAAO,GAAG,OAAO,CAAA;YAClC,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAC5B,CAAC;IACH,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,CAAC,SAAS;YAAE,SAAQ;QAExB,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACrC,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAErC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU;YAAE,SAAQ;QAExC,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,IAAI,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAChG,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,IAAI,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAEhG,IAAI,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;YACzC,MAAM,cAAc,GAA8B,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,EAAE,CAAA;YAC7G,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YACjC,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAC5B,CAAC;IACH,CAAC;IAED,oCAAoC;IACpC,MAAM,IAAI,GAAoB;QAC5B,OAAO,EAAE;YACP,QAAQ,EAAE,KAAK,CAAC,UAAU,EAAE;YAC5B,UAAU,EAAE,KAAK,CAAC,YAAY,EAAE;YAChC,QAAQ,EAAE,KAAK,CAAC,UAAU,EAAE;SAC7B;QACD,KAAK;QACL,KAAK;KACN,CAAA;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,kBAAkB,CAAC,CAAkB,EAAE,IAAY,EAAE,SAAiB;IAC7E,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAA;IACjC,MAAM,KAAK,GAAa,CAAC,IAAI,CAAC,CAAA;IAE9B,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,EAAY,CAAA;QACvC,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACzB,SAAQ;QACV,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAEpB,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,SAAQ;QACV,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACnC,0DAA0D;YAC1D,OAAO,IAAI,CAAA;QACb,CAAC;QAED,6DAA6D;QAC7D,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACtC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACpB,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAC1B,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAA;YACf,IAAI,KAAK,EAAE,OAAO,EAAE,CAAC;gBACnB,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,EAAE,CAAA;YAClC,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAChB,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAA,CAAC,uCAAuC;AACtD,CAAC","sourcesContent":["import type { JsonEdge, Node } from '@api-client/graph'\nimport type { DataDomain } from './DataDomain.js'\nimport type { DomainGraphEdge, DataDomainGraph, SerializedGraph } from './types.js'\n\n/**\n * Serializes a DataDomain for version release, including only relevant foreign nodes.\n * @param root The DataDomain to serialize.\n * @param version The version to set in the serialized graph. This mutates the DataDomain.\n * @returns The serialized graph with the version set.\n */\nexport function createGraphVersion(root: DataDomain, version: string): SerializedGraph {\n  root.info.version = version\n  return serializeForVersionRelease(root)\n}\n\n/**\n * Serializes a DataDomain for version release, including only relevant foreign nodes.\n *\n * @param dataDomain The DataDomain to serialize.\n * @returns A SerializedGraph containing the versioned data.\n */\nexport function serializeForVersionRelease(dataDomain: DataDomain): SerializedGraph {\n  const { graph, key: domainKey } = dataDomain\n  const relevantForeignNodes = new Set<string>()\n\n  // 1. Identify relevant foreign nodes: those connected to local entities.\n  for (const node of graph.nodes()) {\n    const nodeValue = graph.node(node)\n    if (!nodeValue) {\n      continue\n    }\n    if (nodeValue.domain.key === domainKey) {\n      continue // Skip local nodes\n    }\n\n    // Check if the foreign node is connected to a local node (directly or indirectly).\n    if (isConnectedToLocal(graph, node, domainKey)) {\n      relevantForeignNodes.add(node)\n    }\n  }\n\n  // 2. Filter nodes and edges based on relevance.\n  const nodes = []\n  const edges = []\n\n  for (const node of graph.nodes()) {\n    const nodeValue = graph.node(node)\n    if (!nodeValue) {\n      continue\n    }\n\n    if (nodeValue.domain.key === domainKey || relevantForeignNodes.has(node)) {\n      const parents = [...graph.parents(node)]\n      const serializedNode: Node<object> = { v: node, value: nodeValue.toJSON() }\n      if (parents.length) {\n        serializedNode.parents = parents\n      }\n      nodes.push(serializedNode)\n    }\n  }\n\n  for (const edge of graph.edges()) {\n    const edgeValue = graph.edge(edge)\n    if (!edgeValue) continue\n\n    const sourceNode = graph.node(edge.v)\n    const targetNode = graph.node(edge.w)\n\n    if (!sourceNode || !targetNode) continue\n\n    const isSourceRelevant = sourceNode.domain.key === domainKey || relevantForeignNodes.has(edge.v)\n    const isTargetRelevant = targetNode.domain.key === domainKey || relevantForeignNodes.has(edge.w)\n\n    if (isSourceRelevant && isTargetRelevant) {\n      const serializedEdge: JsonEdge<DomainGraphEdge> = { v: edge.v, w: edge.w, value: structuredClone(edgeValue) }\n      if (edge.name) {\n        serializedEdge.name = edge.name\n      }\n      edges.push(serializedEdge)\n    }\n  }\n\n  // 3. Construct the SerializedGraph.\n  const json: SerializedGraph = {\n    options: {\n      directed: graph.isDirected(),\n      multigraph: graph.isMultigraph(),\n      compound: graph.isCompound(),\n    },\n    nodes,\n    edges,\n  }\n\n  return json\n}\n\n/**\n * Checks if a foreign node is connected to a local node (directly or indirectly).\n *\n * This function performs a breadth-first search (BFS) to determine if a foreign node\n * is connected to any local node.\n *\n * @param g The DataDomain graph.\n * @param node The key of the foreign node to check.\n * @param domainKey The key of the local domain.\n * @returns True if the foreign node is connected to a local node.\n */\nfunction isConnectedToLocal(g: DataDomainGraph, node: string, domainKey: string): boolean {\n  const visited = new Set<string>()\n  const queue: string[] = [node]\n\n  while (queue.length > 0) {\n    const current = queue.shift() as string\n    if (visited.has(current)) {\n      continue\n    }\n    visited.add(current)\n\n    const value = g.node(current)\n    if (!value) {\n      continue\n    }\n\n    if (value.domain.key === domainKey) {\n      // It means the foreign node is connected to a local node.\n      return true\n    }\n\n    // Explore adjacent nodes (both incoming and outgoing edges).\n    for (const edge of g.inEdges(current)) {\n      queue.push(edge.v)\n    }\n    for (const edge of g.outEdges(current)) {\n      const label = g.edge(edge)\n      let id = edge.w\n      if (label?.foreign) {\n        id = `${label.domain}:${edge.w}`\n      }\n      queue.push(id)\n    }\n  }\n\n  return false // No connection to a local node found.\n}\n"]}
+{"version":3,"file":"DomainVersioning.js","sourceRoot":"","sources":["../../../src/modeling/DomainVersioning.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAgB,EAAE,OAAe;IAClE,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IAC3B,MAAM,KAAK,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAA;IAC9C,MAAM,MAAM,GAAqB;QAC/B,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;QACxB,KAAK;KACN,CAAA;IACD,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAC/B,2DAA2D;QAC3D,6DAA6D;QAC7D,MAAM,CAAC,cAAc,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAA;IAClD,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAA;IAClC,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,UAAsB;IAC/D,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,UAAU,CAAA;IAC5C,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAU,CAAA;IAE9C,yEAAyE;IACzE,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAQ;QACV,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACvC,SAAQ,CAAC,mBAAmB;QAC9B,CAAC;QAED,mFAAmF;QACnF,IAAI,kBAAkB,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC;YAC/C,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IAED,gDAAgD;IAChD,MAAM,KAAK,GAAG,EAAE,CAAA;IAChB,MAAM,KAAK,GAAG,EAAE,CAAA;IAEhB,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAQ;QACV,CAAC;QAED,IAAI,SAAS,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,IAAI,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACzE,MAAM,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;YACxC,MAAM,cAAc,GAAiB,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,CAAA;YAC3E,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,cAAc,CAAC,OAAO,GAAG,OAAO,CAAA;YAClC,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAC5B,CAAC;IACH,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,CAAC,SAAS;YAAE,SAAQ;QAExB,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACrC,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAErC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU;YAAE,SAAQ;QAExC,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,IAAI,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAChG,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,IAAI,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAEhG,IAAI,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;YACzC,MAAM,cAAc,GAA8B,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,EAAE,CAAA;YAC7G,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YACjC,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAC5B,CAAC;IACH,CAAC;IAED,oCAAoC;IACpC,MAAM,IAAI,GAAoB;QAC5B,OAAO,EAAE;YACP,QAAQ,EAAE,KAAK,CAAC,UAAU,EAAE;YAC5B,UAAU,EAAE,KAAK,CAAC,YAAY,EAAE;YAChC,QAAQ,EAAE,KAAK,CAAC,UAAU,EAAE;SAC7B;QACD,KAAK;QACL,KAAK;KACN,CAAA;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,kBAAkB,CAAC,CAAkB,EAAE,IAAY,EAAE,SAAiB;IAC7E,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAA;IACjC,MAAM,KAAK,GAAa,CAAC,IAAI,CAAC,CAAA;IAE9B,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,EAAY,CAAA;QACvC,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACzB,SAAQ;QACV,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAEpB,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,SAAQ;QACV,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACnC,0DAA0D;YAC1D,OAAO,IAAI,CAAA;QACb,CAAC;QAED,6DAA6D;QAC7D,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACtC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACpB,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAC1B,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAA;YACf,IAAI,KAAK,EAAE,OAAO,EAAE,CAAC;gBACnB,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,EAAE,CAAA;YAClC,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAChB,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAA,CAAC,uCAAuC;AACtD,CAAC","sourcesContent":["import type { JsonEdge, Node } from '@api-client/graph'\nimport type { DataDomain, DataDomainSchema } from './DataDomain.js'\nimport type { DomainGraphEdge, DataDomainGraph, SerializedGraph } from './types.js'\n\n/**\n * Serializes a DataDomain for version release, including only relevant foreign nodes.\n * @param root The DataDomain to serialize.\n * @param version The version to set in the serialized graph. This mutates the DataDomain.\n * @returns The serialized graph with the version set.\n */\nexport function createGraphVersion(root: DataDomain, version: string): DataDomainSchema {\n  root.info.version = version\n  const graph = serializeForVersionRelease(root)\n  const result: DataDomainSchema = {\n    key: root.key,\n    kind: root.kind,\n    info: root.info.toJSON(),\n    graph,\n  }\n  if (root.dependencyList.length) {\n    // Note: the used dependencies are serialized in the graph.\n    // The dependency list is only preserved for linage purposes.\n    result.dependencyList = [...root.dependencyList]\n  }\n  if (root.fields.length) {\n    result.fields = [...root.fields]\n  }\n  return result\n}\n\n/**\n * Serializes a DataDomain for version release, including only relevant foreign nodes.\n *\n * @param dataDomain The DataDomain to serialize.\n * @returns A SerializedGraph containing the versioned data.\n */\nexport function serializeForVersionRelease(dataDomain: DataDomain): SerializedGraph {\n  const { graph, key: domainKey } = dataDomain\n  const relevantForeignNodes = new Set<string>()\n\n  // 1. Identify relevant foreign nodes: those connected to local entities.\n  for (const node of graph.nodes()) {\n    const nodeValue = graph.node(node)\n    if (!nodeValue) {\n      continue\n    }\n    if (nodeValue.domain.key === domainKey) {\n      continue // Skip local nodes\n    }\n\n    // Check if the foreign node is connected to a local node (directly or indirectly).\n    if (isConnectedToLocal(graph, node, domainKey)) {\n      relevantForeignNodes.add(node)\n    }\n  }\n\n  // 2. Filter nodes and edges based on relevance.\n  const nodes = []\n  const edges = []\n\n  for (const node of graph.nodes()) {\n    const nodeValue = graph.node(node)\n    if (!nodeValue) {\n      continue\n    }\n\n    if (nodeValue.domain.key === domainKey || relevantForeignNodes.has(node)) {\n      const parents = [...graph.parents(node)]\n      const serializedNode: Node<object> = { v: node, value: nodeValue.toJSON() }\n      if (parents.length) {\n        serializedNode.parents = parents\n      }\n      nodes.push(serializedNode)\n    }\n  }\n\n  for (const edge of graph.edges()) {\n    const edgeValue = graph.edge(edge)\n    if (!edgeValue) continue\n\n    const sourceNode = graph.node(edge.v)\n    const targetNode = graph.node(edge.w)\n\n    if (!sourceNode || !targetNode) continue\n\n    const isSourceRelevant = sourceNode.domain.key === domainKey || relevantForeignNodes.has(edge.v)\n    const isTargetRelevant = targetNode.domain.key === domainKey || relevantForeignNodes.has(edge.w)\n\n    if (isSourceRelevant && isTargetRelevant) {\n      const serializedEdge: JsonEdge<DomainGraphEdge> = { v: edge.v, w: edge.w, value: structuredClone(edgeValue) }\n      if (edge.name) {\n        serializedEdge.name = edge.name\n      }\n      edges.push(serializedEdge)\n    }\n  }\n\n  // 3. Construct the SerializedGraph.\n  const json: SerializedGraph = {\n    options: {\n      directed: graph.isDirected(),\n      multigraph: graph.isMultigraph(),\n      compound: graph.isCompound(),\n    },\n    nodes,\n    edges,\n  }\n\n  return json\n}\n\n/**\n * Checks if a foreign node is connected to a local node (directly or indirectly).\n *\n * This function performs a breadth-first search (BFS) to determine if a foreign node\n * is connected to any local node.\n *\n * @param g The DataDomain graph.\n * @param node The key of the foreign node to check.\n * @param domainKey The key of the local domain.\n * @returns True if the foreign node is connected to a local node.\n */\nfunction isConnectedToLocal(g: DataDomainGraph, node: string, domainKey: string): boolean {\n  const visited = new Set<string>()\n  const queue: string[] = [node]\n\n  while (queue.length > 0) {\n    const current = queue.shift() as string\n    if (visited.has(current)) {\n      continue\n    }\n    visited.add(current)\n\n    const value = g.node(current)\n    if (!value) {\n      continue\n    }\n\n    if (value.domain.key === domainKey) {\n      // It means the foreign node is connected to a local node.\n      return true\n    }\n\n    // Explore adjacent nodes (both incoming and outgoing edges).\n    for (const edge of g.inEdges(current)) {\n      queue.push(edge.v)\n    }\n    for (const edge of g.outEdges(current)) {\n      const label = g.edge(edge)\n      let id = edge.w\n      if (label?.foreign) {\n        id = `${label.domain}:${edge.w}`\n      }\n      queue.push(id)\n    }\n  }\n\n  return false // No connection to a local node found.\n}\n"]}

package/build/src/modeling/validation/entity_validation.js

@@ -126,9 +126,9 @@ export class EntityValidation {
             return results;
         }
         const name = entity.info.name;
-        if (name.length < 3) {
+        if (name.length < 2) {
             const message = `The "${label}" entity name is too short.`;
-            const help = `The name must be at least 3 characters long.`;
+            const help = `The name must be at least 2 characters long.`;
             results.push({
                 field: 'name',
                 rule: 'length',

package/build/src/modeling/validation/entity_validation.js.map

@@ -1 +1 @@
-{"version":3,"file":"entity_validation.js","sourceRoot":"","sources":["../../../../src/modeling/validation/entity_validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAGxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAGlD;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IACL;IAAtB,YAAsB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAE5C;;;;OAIG;IACH,QAAQ,CAAC,MAA6B;QACpC,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,IAAI,MAAgC,CAAA;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACzC,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,MAAM,CAAA;QACjB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,OAAO,GAAG,QAAQ,MAAM,0BAA0B,CAAA;YACxD,MAAM,IAAI,GAAG,2CAA2C,CAAA;YACxD,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,GAAG;gBACV,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,GAAG,EAAE,MAAgB;gBACrB,IAAI,EAAE,gBAAgB;gBACtB,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAA;YACF,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;QAC/C,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;QACtD,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QACtC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAC1C,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAA;QAC3B,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAAoB;QACrC,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAA;QACnC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,6BAA6B,CAAA;YAC3E,MAAM,IAAI,GAAG,mEAAmE,CAAA;YAChF,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,aAAa;gBACnB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,MAAoB;QAC5C,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,CAAC;YACzD,MAAM,OAAO,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,iDAAiD,CAAA;YAC/F,MAAM,IAAI,GAAG,sGAAsG,CAAA;YACnH,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,SAAS;gBACnB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,MAAoB;QAC/B,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;QACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,QAAQ,KAAK,uBAAuB,CAAA;YACpD,MAAM,IAAI,GAAG,6BAA6B,CAAA;YAC1C,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;YACF,OAAO,OAAO,CAAA;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;QAC7B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,OAAO,GAAG,QAAQ,KAAK,6BAA6B,CAAA;YAC1D,MAAM,IAAI,GAAG,8CAA8C,CAAA;YAC3D,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YACrB,MAAM,OAAO,GAAG,QAAQ,KAAK,4BAA4B,CAAA;YACzD,MAAM,IAAI,GAAG,8CAA8C,CAAA;YAC3D,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,QAAQ,KAAK,2BAA2B,CAAA;YACxD,MAAM,IAAI,GAAG,oIAAoI,CAAA;YACjJ,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,qCAAqC,CAAA;YAClE,MAAM,IAAI,GAAG,uEAAuE,CAAA;YACpF,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,YAAY;gBAClB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,MAAM;gBAChB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,QAAQ,KAAK,sCAAsC,CAAA;YACnE,MAAM,IAAI,GAAG,4CAA4C,CAAA;YACzD,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,MAAoB;QAC7B,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,CAAA;QAC5C,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,6EAA6E;QAC7E,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAC/C,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxE,MAAM,OAAO,GAAG,QAAQ,IAAI,mDAAmD,CAAA;gBAC/E,MAAM,IAAI,GAAG,0EAA0E,CAAA;gBACvF,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;oBACd,OAAO;oBACP,IAAI;oBACJ,QAAQ,EAAE,OAAO;oBACjB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,IAAI,EAAE,KAAK,CAAC,IAAI;iBACjB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;YACtD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxE,MAAM,OAAO,GAAG,QAAQ,IAAI,2DAA2D,CAAA;gBACvF,MAAM,IAAI,GAAG,0EAA0E,CAAA;gBACvF,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;oBACd,OAAO;oBACP,IAAI;oBACJ,QAAQ,EAAE,OAAO;oBACjB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG;iBACzB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;CACF","sourcesContent":["import { DomainEntityKind } from '../../models/kinds.js'\nimport type { DataDomain } from '../DataDomain.js'\nimport type { DomainEntity } from '../DomainEntity.js'\nimport { ReservedKeywords } from './postgresql.js'\nimport type { DomainValidation } from './rules.js'\n\n/**\n * EntityValidation is a class that performs validation on entities in a data domain.\n *\n * @remarks\n * - We do not need to check for parent uniqueness here, because in the graph there can only be one edge\n *   between two nodes. Parent relationships are described by an edge in the graph.\n */\nexport class EntityValidation {\n  constructor(protected domain: DataDomain) {}\n\n  /**\n   * Performs all the validation rules on the entity.\n   * If you are interested in a specific rule, use the specific method.\n   * @param target The target entity to validate. Can be a string with the entity key or a DomainEntity object.\n   */\n  validate(target: string | DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    let entity: DomainEntity | undefined\n    if (typeof target === 'string') {\n      entity = this.domain.findEntity(target)\n    } else {\n      entity = target\n    }\n    if (!entity) {\n      const message = `The \"${target}\" entity does not exist.`\n      const help = `The entity must be defined in the domain.`\n      results.push({\n        field: '*',\n        rule: 'exists',\n        message,\n        help,\n        key: target as string,\n        kind: DomainEntityKind,\n        severity: 'error',\n      })\n      return results\n    }\n    const primary = this.validatePrimaryKey(entity)\n    results.push(...primary)\n    const minimum = this.minimumRequiredProperties(entity)\n    results.push(...minimum)\n    const name = this.validateName(entity)\n    results.push(...name)\n    const uniqueName = this.uniqueName(entity)\n    results.push(...uniqueName)\n    return results\n  }\n\n  /**\n   * Validates the entity against the primary key validation rules.\n   * @param entity The entity to validate\n   * @returns The list of validation messages.\n   */\n  validatePrimaryKey(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    const primary = entity.primaryKey()\n    if (!primary) {\n      const message = `The \"${entity.info.getLabel()}\" entity has no identifier.`\n      const help = `An entity that can exists by itself must have identifier defined.`\n      results.push({\n        field: 'properties',\n        rule: 'primary_key',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Checks if the entity has the minimum required properties.\n   * @param entity The entity to validate\n   */\n  minimumRequiredProperties(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    if (!entity.hasProperties() && !entity.hasAssociations()) {\n      const message = `The \"${entity.info.getLabel()}\" entity has no properties. It will be ignored.`\n      const help = `Entities that have no properties are ignored in the data domain. No schema will be generated for it.`\n      results.push({\n        field: 'properties',\n        rule: 'required',\n        message,\n        help,\n        severity: 'warning',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Validates the entity name.\n   *\n   * @remarks\n   * - An entity must have a name defined.\n   * - The name has to follow the same rules as the names in a PostgreSQL database.\n   *   - Table names must start with a letter (a-z) or underscore (_).\n   *   - Subsequent characters can be letters, digits (0-9), or underscores (_).\n   *   - Names are case-insensitive.\n   *   - The maximum length of a table name is 31 characters\n   *   - Should be snake case (it's a convention, not an error).\n   *   - Should not be a reserved word (for example: \"IN\", \"SELECT\", \"FROM\", etc.).\n   * @param entity The entity to validate\n   */\n  validateName(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    const label = entity.info.getLabel()\n    if (!entity.info.name) {\n      const message = `The \"${label}\" entity has no name.`\n      const help = `An entity must have a name.`\n      results.push({\n        field: 'name',\n        rule: 'required',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n      return results\n    }\n\n    const name = entity.info.name\n    if (name.length < 3) {\n      const message = `The \"${label}\" entity name is too short.`\n      const help = `The name must be at least 3 characters long.`\n      results.push({\n        field: 'name',\n        rule: 'length',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (name.length > 31) {\n      const message = `The \"${label}\" entity name is too long.`\n      const help = `The name must be at most 31 characters long.`\n      results.push({\n        field: 'name',\n        rule: 'length',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {\n      const message = `The \"${label}\" entity name is invalid.`\n      const help = `The name must start with a letter (a-z) or underscore (_). Subsequent characters can be letters, digits (0-9), or underscores (_).`\n      results.push({\n        field: 'name',\n        rule: 'format',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (/^[A-Z]/.test(name)) {\n      const message = `The \"${label}\" entity name is not in snake case.`\n      const help = `The name should be in snake case (lowercase letters and underscores).`\n      results.push({\n        field: 'name',\n        rule: 'snake_case',\n        message,\n        help,\n        severity: 'info',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (ReservedKeywords.has(name.toUpperCase())) {\n      const message = `The \"${label}\" entity name is a reserved keyword.`\n      const help = `The name should not be a reserved keyword.`\n      results.push({\n        field: 'name',\n        rule: 'reserved',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Checks if the entity name is unique in the data domain.\n   * @param entity The entity to validate\n   */\n  uniqueName(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    const name = entity.info.name?.toLowerCase()\n    if (!name) {\n      return results\n    }\n    // We need to check the unique names in all entities, including foreign ones.\n    for (const other of this.domain.listEntities()) {\n      if (other.info.name?.toLowerCase() === name && other.key !== entity.key) {\n        const message = `The \"${name}\" entity name is already used in the data domain.`\n        const help = `The name must be unique. This includes references to other data domains.`\n        results.push({\n          field: 'name',\n          rule: 'unique',\n          message,\n          help,\n          severity: 'error',\n          key: other.key,\n          kind: other.kind,\n        })\n      }\n    }\n    for (const other of this.domain.listForeignEntities()) {\n      if (other.info.name?.toLowerCase() === name && other.key !== entity.key) {\n        const message = `The \"${name}\" entity name is already used in the foreign data domain.`\n        const help = `The name must be unique. This includes references to other data domains.`\n        results.push({\n          field: 'name',\n          rule: 'unique',\n          message,\n          help,\n          severity: 'error',\n          key: other.key,\n          kind: other.kind,\n          parent: other.domain.key,\n        })\n      }\n    }\n    return results\n  }\n}\n"]}
+{"version":3,"file":"entity_validation.js","sourceRoot":"","sources":["../../../../src/modeling/validation/entity_validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAGxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAGlD;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IACL;IAAtB,YAAsB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAE5C;;;;OAIG;IACH,QAAQ,CAAC,MAA6B;QACpC,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,IAAI,MAAgC,CAAA;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACzC,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,MAAM,CAAA;QACjB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,OAAO,GAAG,QAAQ,MAAM,0BAA0B,CAAA;YACxD,MAAM,IAAI,GAAG,2CAA2C,CAAA;YACxD,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,GAAG;gBACV,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,GAAG,EAAE,MAAgB;gBACrB,IAAI,EAAE,gBAAgB;gBACtB,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAA;YACF,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;QAC/C,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;QACtD,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QACtC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAC1C,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAA;QAC3B,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAAoB;QACrC,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAA;QACnC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,6BAA6B,CAAA;YAC3E,MAAM,IAAI,GAAG,mEAAmE,CAAA;YAChF,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,aAAa;gBACnB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,MAAoB;QAC5C,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,CAAC;YACzD,MAAM,OAAO,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,iDAAiD,CAAA;YAC/F,MAAM,IAAI,GAAG,sGAAsG,CAAA;YACnH,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,SAAS;gBACnB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,MAAoB;QAC/B,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;QACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,QAAQ,KAAK,uBAAuB,CAAA;YACpD,MAAM,IAAI,GAAG,6BAA6B,CAAA;YAC1C,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;YACF,OAAO,OAAO,CAAA;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;QAC7B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,OAAO,GAAG,QAAQ,KAAK,6BAA6B,CAAA;YAC1D,MAAM,IAAI,GAAG,8CAA8C,CAAA;YAC3D,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YACrB,MAAM,OAAO,GAAG,QAAQ,KAAK,4BAA4B,CAAA;YACzD,MAAM,IAAI,GAAG,8CAA8C,CAAA;YAC3D,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,QAAQ,KAAK,2BAA2B,CAAA;YACxD,MAAM,IAAI,GAAG,oIAAoI,CAAA;YACjJ,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,qCAAqC,CAAA;YAClE,MAAM,IAAI,GAAG,uEAAuE,CAAA;YACpF,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,YAAY;gBAClB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,MAAM;gBAChB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,QAAQ,KAAK,sCAAsC,CAAA;YACnE,MAAM,IAAI,GAAG,4CAA4C,CAAA;YACzD,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,MAAoB;QAC7B,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,CAAA;QAC5C,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,6EAA6E;QAC7E,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAC/C,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxE,MAAM,OAAO,GAAG,QAAQ,IAAI,mDAAmD,CAAA;gBAC/E,MAAM,IAAI,GAAG,0EAA0E,CAAA;gBACvF,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;oBACd,OAAO;oBACP,IAAI;oBACJ,QAAQ,EAAE,OAAO;oBACjB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,IAAI,EAAE,KAAK,CAAC,IAAI;iBACjB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;YACtD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxE,MAAM,OAAO,GAAG,QAAQ,IAAI,2DAA2D,CAAA;gBACvF,MAAM,IAAI,GAAG,0EAA0E,CAAA;gBACvF,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;oBACd,OAAO;oBACP,IAAI;oBACJ,QAAQ,EAAE,OAAO;oBACjB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG;iBACzB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;CACF","sourcesContent":["import { DomainEntityKind } from '../../models/kinds.js'\nimport type { DataDomain } from '../DataDomain.js'\nimport type { DomainEntity } from '../DomainEntity.js'\nimport { ReservedKeywords } from './postgresql.js'\nimport type { DomainValidation } from './rules.js'\n\n/**\n * EntityValidation is a class that performs validation on entities in a data domain.\n *\n * @remarks\n * - We do not need to check for parent uniqueness here, because in the graph there can only be one edge\n *   between two nodes. Parent relationships are described by an edge in the graph.\n */\nexport class EntityValidation {\n  constructor(protected domain: DataDomain) {}\n\n  /**\n   * Performs all the validation rules on the entity.\n   * If you are interested in a specific rule, use the specific method.\n   * @param target The target entity to validate. Can be a string with the entity key or a DomainEntity object.\n   */\n  validate(target: string | DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    let entity: DomainEntity | undefined\n    if (typeof target === 'string') {\n      entity = this.domain.findEntity(target)\n    } else {\n      entity = target\n    }\n    if (!entity) {\n      const message = `The \"${target}\" entity does not exist.`\n      const help = `The entity must be defined in the domain.`\n      results.push({\n        field: '*',\n        rule: 'exists',\n        message,\n        help,\n        key: target as string,\n        kind: DomainEntityKind,\n        severity: 'error',\n      })\n      return results\n    }\n    const primary = this.validatePrimaryKey(entity)\n    results.push(...primary)\n    const minimum = this.minimumRequiredProperties(entity)\n    results.push(...minimum)\n    const name = this.validateName(entity)\n    results.push(...name)\n    const uniqueName = this.uniqueName(entity)\n    results.push(...uniqueName)\n    return results\n  }\n\n  /**\n   * Validates the entity against the primary key validation rules.\n   * @param entity The entity to validate\n   * @returns The list of validation messages.\n   */\n  validatePrimaryKey(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    const primary = entity.primaryKey()\n    if (!primary) {\n      const message = `The \"${entity.info.getLabel()}\" entity has no identifier.`\n      const help = `An entity that can exists by itself must have identifier defined.`\n      results.push({\n        field: 'properties',\n        rule: 'primary_key',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Checks if the entity has the minimum required properties.\n   * @param entity The entity to validate\n   */\n  minimumRequiredProperties(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    if (!entity.hasProperties() && !entity.hasAssociations()) {\n      const message = `The \"${entity.info.getLabel()}\" entity has no properties. It will be ignored.`\n      const help = `Entities that have no properties are ignored in the data domain. No schema will be generated for it.`\n      results.push({\n        field: 'properties',\n        rule: 'required',\n        message,\n        help,\n        severity: 'warning',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Validates the entity name.\n   *\n   * @remarks\n   * - An entity must have a name defined.\n   * - The name has to follow the same rules as the names in a PostgreSQL database.\n   *   - Table names must start with a letter (a-z) or underscore (_).\n   *   - Subsequent characters can be letters, digits (0-9), or underscores (_).\n   *   - Names are case-insensitive.\n   *   - The maximum length of a table name is 31 characters\n   *   - Should be snake case (it's a convention, not an error).\n   *   - Should not be a reserved word (for example: \"IN\", \"SELECT\", \"FROM\", etc.).\n   * @param entity The entity to validate\n   */\n  validateName(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    const label = entity.info.getLabel()\n    if (!entity.info.name) {\n      const message = `The \"${label}\" entity has no name.`\n      const help = `An entity must have a name.`\n      results.push({\n        field: 'name',\n        rule: 'required',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n      return results\n    }\n\n    const name = entity.info.name\n    if (name.length < 2) {\n      const message = `The \"${label}\" entity name is too short.`\n      const help = `The name must be at least 2 characters long.`\n      results.push({\n        field: 'name',\n        rule: 'length',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (name.length > 31) {\n      const message = `The \"${label}\" entity name is too long.`\n      const help = `The name must be at most 31 characters long.`\n      results.push({\n        field: 'name',\n        rule: 'length',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {\n      const message = `The \"${label}\" entity name is invalid.`\n      const help = `The name must start with a letter (a-z) or underscore (_). Subsequent characters can be letters, digits (0-9), or underscores (_).`\n      results.push({\n        field: 'name',\n        rule: 'format',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (/^[A-Z]/.test(name)) {\n      const message = `The \"${label}\" entity name is not in snake case.`\n      const help = `The name should be in snake case (lowercase letters and underscores).`\n      results.push({\n        field: 'name',\n        rule: 'snake_case',\n        message,\n        help,\n        severity: 'info',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (ReservedKeywords.has(name.toUpperCase())) {\n      const message = `The \"${label}\" entity name is a reserved keyword.`\n      const help = `The name should not be a reserved keyword.`\n      results.push({\n        field: 'name',\n        rule: 'reserved',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Checks if the entity name is unique in the data domain.\n   * @param entity The entity to validate\n   */\n  uniqueName(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    const name = entity.info.name?.toLowerCase()\n    if (!name) {\n      return results\n    }\n    // We need to check the unique names in all entities, including foreign ones.\n    for (const other of this.domain.listEntities()) {\n      if (other.info.name?.toLowerCase() === name && other.key !== entity.key) {\n        const message = `The \"${name}\" entity name is already used in the data domain.`\n        const help = `The name must be unique. This includes references to other data domains.`\n        results.push({\n          field: 'name',\n          rule: 'unique',\n          message,\n          help,\n          severity: 'error',\n          key: other.key,\n          kind: other.kind,\n        })\n      }\n    }\n    for (const other of this.domain.listForeignEntities()) {\n      if (other.info.name?.toLowerCase() === name && other.key !== entity.key) {\n        const message = `The \"${name}\" entity name is already used in the foreign data domain.`\n        const help = `The name must be unique. This includes references to other data domains.`\n        results.push({\n          field: 'name',\n          rule: 'unique',\n          message,\n          help,\n          severity: 'error',\n          key: other.key,\n          kind: other.kind,\n          parent: other.domain.key,\n        })\n      }\n    }\n    return results\n  }\n}\n"]}

package/build/src/modeling/validation/rules.js

@@ -35,9 +35,9 @@ export function validatePropertyName(property) {
         return results;
     }
     const name = property.info.name;
-    if (name.length < 3) {
+    if (name.length < 2) {
         const message = `The "${label}" ${type} name is too short.`;
-        const help = `The name must be at least 3 characters long.`;
+        const help = `The name must be at least 2 characters long.`;
         results.push({
             field: 'name',
             rule: 'length',

package/build/src/modeling/validation/rules.js.map

@@ -1 +1 @@
-{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../../../src/modeling/validation/rules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAKlD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAwC1D;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,oBAAoB,CAAC,QAA4C;IAC/E,MAAM,OAAO,GAAuB,EAAE,CAAA;IACtC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;IACtC,MAAM,YAAY,GAAG,QAAQ,CAAC,iBAAiB,EAAkB,CAAA;IACjE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAA;IAC9E,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,eAAe,CAAA;QACrD,MAAM,IAAI,GAAG,OAAO,IAAI,oBAAoB,CAAA;QAC5C,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,UAAU;YAChB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;QACF,OAAO,OAAO,CAAA;IAChB,CAAC;IACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAA;IAC/B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,qBAAqB,CAAA;QAC3D,MAAM,IAAI,GAAG,8CAA8C,CAAA;QAC3D,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,oBAAoB,CAAA;QAC1D,MAAM,IAAI,GAAG,8CAA8C,CAAA;QAC3D,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,mBAAmB,CAAA;QACzD,MAAM,IAAI,GAAG,oIAAoI,CAAA;QACjJ,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,6BAA6B,CAAA;QACnE,MAAM,IAAI,GAAG,uEAAuE,CAAA;QACpF,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,YAAY;YAClB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,MAAM;YAChB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,8BAA8B,CAAA;QACpE,MAAM,IAAI,GAAG,4CAA4C,CAAA;QACzD,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,UAAU;YAChB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC","sourcesContent":["import { ReservedKeywords } from './postgresql.js'\nimport type { DomainProperty } from '../DomainProperty.js'\nimport type { DomainAssociation } from '../DomainAssociation.js'\nimport type { DomainImpactItem } from '../DomainImpactAnalysis.js'\nimport type { DomainEntity } from '../DomainEntity.js'\nimport { DomainPropertyKind } from '../../models/kinds.js'\n\n/**\n * `DomainImpactItem` mapping:\n * - `impact` -> `message`\n * - `resolution` -> `help`\n * - `type` -> unused\n * - `blocking` -> unused (deprecated)\n * - `relationship` -> unused\n */\nexport interface DomainValidation\n  extends Omit<DomainImpactItem, 'type' | 'impact' | 'blocking' | 'relationship' | 'resolution'> {\n  /**\n   * The field that did not pass validation.\n   */\n  field: string\n  /**\n   * The name of the rule that was violated.\n   */\n  rule: string\n  /**\n   * Optional help message that can be used to provide\n   * more information about the error.\n   */\n  help?: string\n  /**\n   * Optional URL that can be used to provide more information\n   * about the error.\n   */\n  url?: string\n  /**\n   * The validation error message.\n   * This message should be user-friendly and should not\n   * contain any technical details.\n   * It should be used to display the error to the user.\n   * It should be short and concise.\n   */\n  message: string\n}\n\n/**\n * Validates the property name. This includes associations.\n *\n * @remarks\n * - A property must have a name defined.\n * - The name has to follow the same rules as the names in a PostgreSQL database.\n *   - Column names can only contain letters (a-z, A-Z), numbers (0-9), and underscores (_).\n *   - The name must start with a letter (a-z, A-Z) or an underscore (_).\n *   - PostgreSQL limits column names to a maximum of 59 characters.\n *   - (our rule) Column names are case insensitive.\n *   - (recommendation) Column names should be in lower case.\n *\n * @param property The property to validate\n */\nexport function validatePropertyName(property: DomainProperty | DomainAssociation): DomainValidation[] {\n  const results: DomainValidation[] = []\n  const label = property.info.getLabel()\n  const parentEntity = property.getParentInstance() as DomainEntity\n  const type = property.kind === DomainPropertyKind ? 'property' : 'association'\n  if (!property.info.name) {\n    const message = `The \"${label}\" ${type} has no name.`\n    const help = `The ${type} must have a name.`\n    results.push({\n      field: 'name',\n      rule: 'required',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n    return results\n  }\n  const name = property.info.name\n  if (name.length < 3) {\n    const message = `The \"${label}\" ${type} name is too short.`\n    const help = `The name must be at least 3 characters long.`\n    results.push({\n      field: 'name',\n      rule: 'length',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (name.length > 59) {\n    const message = `The \"${label}\" ${type} name is too long.`\n    const help = `The name must be at most 59 characters long.`\n    results.push({\n      field: 'name',\n      rule: 'length',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {\n    const message = `The \"${label}\" ${type} name is invalid.`\n    const help = `The name must start with a letter (a-z) or underscore (_). Subsequent characters can be letters, digits (0-9), or underscores (_).`\n    results.push({\n      field: 'name',\n      rule: 'format',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (/^[A-Z]/.test(name)) {\n    const message = `The \"${label}\" ${type} name is not in snake case.`\n    const help = `The name should be in snake case (lowercase letters and underscores).`\n    results.push({\n      field: 'name',\n      rule: 'snake_case',\n      message,\n      help,\n      severity: 'info',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (ReservedKeywords.has(name.toUpperCase())) {\n    const message = `The \"${label}\" ${type} name is a reserved keyword.`\n    const help = `The name should not be a reserved keyword.`\n    results.push({\n      field: 'name',\n      rule: 'reserved',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  return results\n}\n"]}
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../../../src/modeling/validation/rules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAKlD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAwC1D;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,oBAAoB,CAAC,QAA4C;IAC/E,MAAM,OAAO,GAAuB,EAAE,CAAA;IACtC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;IACtC,MAAM,YAAY,GAAG,QAAQ,CAAC,iBAAiB,EAAkB,CAAA;IACjE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAA;IAC9E,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,eAAe,CAAA;QACrD,MAAM,IAAI,GAAG,OAAO,IAAI,oBAAoB,CAAA;QAC5C,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,UAAU;YAChB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;QACF,OAAO,OAAO,CAAA;IAChB,CAAC;IACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAA;IAC/B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,qBAAqB,CAAA;QAC3D,MAAM,IAAI,GAAG,8CAA8C,CAAA;QAC3D,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,oBAAoB,CAAA;QAC1D,MAAM,IAAI,GAAG,8CAA8C,CAAA;QAC3D,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,mBAAmB,CAAA;QACzD,MAAM,IAAI,GAAG,oIAAoI,CAAA;QACjJ,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,6BAA6B,CAAA;QACnE,MAAM,IAAI,GAAG,uEAAuE,CAAA;QACpF,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,YAAY;YAClB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,MAAM;YAChB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,8BAA8B,CAAA;QACpE,MAAM,IAAI,GAAG,4CAA4C,CAAA;QACzD,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,UAAU;YAChB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC","sourcesContent":["import { ReservedKeywords } from './postgresql.js'\nimport type { DomainProperty } from '../DomainProperty.js'\nimport type { DomainAssociation } from '../DomainAssociation.js'\nimport type { DomainImpactItem } from '../DomainImpactAnalysis.js'\nimport type { DomainEntity } from '../DomainEntity.js'\nimport { DomainPropertyKind } from '../../models/kinds.js'\n\n/**\n * `DomainImpactItem` mapping:\n * - `impact` -> `message`\n * - `resolution` -> `help`\n * - `type` -> unused\n * - `blocking` -> unused (deprecated)\n * - `relationship` -> unused\n */\nexport interface DomainValidation\n  extends Omit<DomainImpactItem, 'type' | 'impact' | 'blocking' | 'relationship' | 'resolution'> {\n  /**\n   * The field that did not pass validation.\n   */\n  field: string\n  /**\n   * The name of the rule that was violated.\n   */\n  rule: string\n  /**\n   * Optional help message that can be used to provide\n   * more information about the error.\n   */\n  help?: string\n  /**\n   * Optional URL that can be used to provide more information\n   * about the error.\n   */\n  url?: string\n  /**\n   * The validation error message.\n   * This message should be user-friendly and should not\n   * contain any technical details.\n   * It should be used to display the error to the user.\n   * It should be short and concise.\n   */\n  message: string\n}\n\n/**\n * Validates the property name. This includes associations.\n *\n * @remarks\n * - A property must have a name defined.\n * - The name has to follow the same rules as the names in a PostgreSQL database.\n *   - Column names can only contain letters (a-z, A-Z), numbers (0-9), and underscores (_).\n *   - The name must start with a letter (a-z, A-Z) or an underscore (_).\n *   - PostgreSQL limits column names to a maximum of 59 characters.\n *   - (our rule) Column names are case insensitive.\n *   - (recommendation) Column names should be in lower case.\n *\n * @param property The property to validate\n */\nexport function validatePropertyName(property: DomainProperty | DomainAssociation): DomainValidation[] {\n  const results: DomainValidation[] = []\n  const label = property.info.getLabel()\n  const parentEntity = property.getParentInstance() as DomainEntity\n  const type = property.kind === DomainPropertyKind ? 'property' : 'association'\n  if (!property.info.name) {\n    const message = `The \"${label}\" ${type} has no name.`\n    const help = `The ${type} must have a name.`\n    results.push({\n      field: 'name',\n      rule: 'required',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n    return results\n  }\n  const name = property.info.name\n  if (name.length < 2) {\n    const message = `The \"${label}\" ${type} name is too short.`\n    const help = `The name must be at least 2 characters long.`\n    results.push({\n      field: 'name',\n      rule: 'length',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (name.length > 59) {\n    const message = `The \"${label}\" ${type} name is too long.`\n    const help = `The name must be at most 59 characters long.`\n    results.push({\n      field: 'name',\n      rule: 'length',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {\n    const message = `The \"${label}\" ${type} name is invalid.`\n    const help = `The name must start with a letter (a-z) or underscore (_). Subsequent characters can be letters, digits (0-9), or underscores (_).`\n    results.push({\n      field: 'name',\n      rule: 'format',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (/^[A-Z]/.test(name)) {\n    const message = `The \"${label}\" ${type} name is not in snake case.`\n    const help = `The name should be in snake case (lowercase letters and underscores).`\n    results.push({\n      field: 'name',\n      rule: 'snake_case',\n      message,\n      help,\n      severity: 'info',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (ReservedKeywords.has(name.toUpperCase())) {\n    const message = `The \"${label}\" ${type} name is a reserved keyword.`\n    const help = `The name should not be a reserved keyword.`\n    results.push({\n      field: 'name',\n      rule: 'reserved',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  return results\n}\n"]}

package/build/src/models/DataCatalog.d.ts

@@ -0,0 +1,142 @@
+import { DataCatalogKind } from './kinds.js';
+export type DataCatalogScope = 'public' | 'private' | 'organization';
+export interface DataCatalogSchema {
+    /**
+     * The key of the data catalog entry.
+     * When the value is missing it will be generated by the API.
+     *
+     * The key can only be set when creating a new data catalog entry.
+     * @readonly
+     */
+    key: string;
+    /**
+     * The kind of the schema
+     * This is set by the API and is used to identify the schema.
+     * @readonly
+     */
+    readonly kind: typeof DataCatalogKind;
+    /**
+     * The key of the organization.
+     * @required
+     */
+    organization: string;
+    /**
+     * The key of the related data catalog file entry.
+     * @required
+     */
+    file: string;
+    /**
+     * The scope of the data catalog entry.
+     * @required
+     */
+    scope: DataCatalogScope;
+    /**
+     * The name of the data catalog entry.
+     * It is required when creating a new data catalog entry.
+     * @required
+     */
+    name: string;
+    /**
+     * A short description of the data catalog entry.
+     * @required
+     */
+    description: string;
+    /**
+     * The id of the user who created the data catalog entry.
+     * It is ignored when creating or updating a data catalog entry.
+     * @readonly
+     */
+    publishedBy: string;
+    /**
+     * The time when the last version was published.
+     * It is ignored when creating or updating a data catalog entry.
+     * @readonly
+     */
+    publishedAt: number;
+    /**
+     * The time when the data catalog entry was created.
+     * It is ignored when creating or updating a data catalog entry.
+     * @readonly
+     */
+    createdAt: number;
+    /**
+     * The time when the data catalog entry was last updated.
+     * It is ignored when creating or updating a data catalog entry.
+     * @readonly
+     */
+    updatedAt: number;
+    /**
+     * The timestamp when this entry was unpublished.
+     * Only set when the entry was unpublished.
+     * @readonly
+     */
+    unpublishedAt?: number;
+    /**
+     * A flag indicating if the entry is deprecated.
+     * @readonly
+     */
+    deprecated?: boolean;
+    /**
+     * The timestamp when the entry was deprecated.
+     * Only set when the entry was deprecated.
+     * @readonly
+     */
+    deprecatedAt?: number;
+    /**
+     * The id of the user who deprecated the entry.
+     * Only set when the entry was deprecated.
+     * @readonly
+     */
+    deprecatedBy?: string;
+    /**
+     * The reason why the entry was deprecated.
+     * Only set when the entry was deprecated.
+     */
+    deprecationReason?: string;
+    /**
+     * The list of tags associated with the data catalog entry.
+     * @readonly Use the API endpoints to manage tags.
+     */
+    tags: string[];
+}
+/**
+ * Used with API communication when listing data catalog entries.
+ */
+export interface DataCatalogSchemaWithVersion extends DataCatalogSchema {
+    /**
+     * The list of published versions of the data catalog entry.
+     * Note, this is limited to the last 20 versions.
+     */
+    versions: string[];
+}
+export interface DataCatalogVersionInfo {
+    key: string;
+    version: string;
+    published: number;
+}
+export interface DataCatalogStatus extends DataCatalogSchema {
+    versions: DataCatalogVersionInfo[];
+}
+export declare class DataCatalog implements DataCatalogSchema {
+    key: string;
+    get kind(): typeof DataCatalogKind;
+    organization: string;
+    file: string;
+    scope: DataCatalogScope;
+    name: string;
+    description: string;
+    publishedBy: string;
+    publishedAt: number;
+    createdAt: number;
+    updatedAt: number;
+    unpublishedAt?: number | undefined;
+    deprecated?: boolean | undefined;
+    deprecatedAt?: number | undefined;
+    deprecatedBy?: string | undefined;
+    deprecationReason?: string | undefined;
+    tags: string[];
+    static createSchema(input: Partial<DataCatalogSchema>): DataCatalogSchema;
+    constructor(input?: Partial<DataCatalogSchema>);
+    toJSON(): DataCatalogSchema;
+}
+//# sourceMappingURL=DataCatalog.d.ts.map

package/build/src/models/DataCatalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataCatalog.d.ts","sourceRoot":"","sources":["../../../src/models/DataCatalog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,SAAS,GAAG,cAAc,CAAA;AAEpE,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,eAAe,CAAA;IACrC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,KAAK,EAAE,gBAAgB,CAAA;IACvB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,IAAI,EAAE,MAAM,EAAE,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,iBAAiB;IACrE;;;OAGG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,QAAQ,EAAE,sBAAsB,EAAE,CAAA;CACnC;AAED,qBAAa,WAAY,YAAW,iBAAiB;IACnD,GAAG,EAAE,MAAM,CAAA;IAEX,IAAI,IAAI,IAAI,OAAO,eAAe,CAEjC;IAED,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,gBAAgB,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,IAAI,EAAE,MAAM,EAAE,CAAA;IAEd,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,iBAAiB;gBAiD7D,KAAK,GAAE,OAAO,CAAC,iBAAiB,CAAM;IA8BlD,MAAM,IAAI,iBAAiB;CAgC5B"}

package/build/src/models/DataCatalog.js

@@ -0,0 +1,120 @@
+import { DataCatalogKind } from './kinds.js';
+export class DataCatalog {
+    key;
+    get kind() {
+        return DataCatalogKind;
+    }
+    organization;
+    file;
+    scope;
+    name;
+    description;
+    publishedBy;
+    publishedAt;
+    createdAt;
+    updatedAt;
+    unpublishedAt;
+    deprecated;
+    deprecatedAt;
+    deprecatedBy;
+    deprecationReason;
+    tags;
+    static createSchema(input) {
+        const { key = '', organization = '', file = '', scope = 'private', name = '', description = '', publishedBy = '', publishedAt = 0, createdAt = 0, updatedAt = 0, tags = [], } = input;
+        if (['public', 'private', 'organization'].indexOf(scope) === -1) {
+            throw new Error(`Invalid scope: ${scope}`);
+        }
+        const result = {
+            key,
+            kind: DataCatalogKind,
+            organization,
+            file,
+            scope,
+            name,
+            description,
+            publishedBy,
+            publishedAt,
+            createdAt,
+            updatedAt,
+            tags,
+        };
+        if (typeof input.deprecated === 'boolean') {
+            result.deprecated = input.deprecated;
+        }
+        if (typeof input.deprecatedAt === 'number') {
+            result.deprecatedAt = input.deprecatedAt;
+        }
+        if (typeof input.deprecatedBy === 'string') {
+            result.deprecatedBy = input.deprecatedBy;
+        }
+        if (typeof input.deprecationReason === 'string') {
+            result.deprecationReason = input.deprecationReason;
+        }
+        if (typeof input.unpublishedAt === 'number') {
+            result.unpublishedAt = input.unpublishedAt;
+        }
+        return result;
+    }
+    constructor(input = {}) {
+        const init = DataCatalog.createSchema(input);
+        this.key = init.key;
+        this.organization = init.organization;
+        this.file = init.file;
+        this.scope = init.scope;
+        this.name = init.name;
+        this.description = init.description;
+        this.publishedBy = init.publishedBy;
+        this.publishedAt = init.publishedAt;
+        this.createdAt = init.createdAt;
+        this.updatedAt = init.updatedAt;
+        this.tags = init.tags;
+        if (typeof init.deprecated === 'boolean') {
+            this.deprecated = init.deprecated;
+        }
+        if (typeof init.deprecatedAt === 'number') {
+            this.deprecatedAt = init.deprecatedAt;
+        }
+        if (typeof init.deprecatedBy === 'string') {
+            this.deprecatedBy = init.deprecatedBy;
+        }
+        if (typeof init.deprecationReason === 'string') {
+            this.deprecationReason = init.deprecationReason;
+        }
+        if (typeof init.unpublishedAt === 'number') {
+            this.unpublishedAt = init.unpublishedAt;
+        }
+    }
+    toJSON() {
+        const result = {
+            key: this.key,
+            kind: DataCatalogKind,
+            organization: this.organization,
+            file: this.file,
+            scope: this.scope,
+            name: this.name,
+            description: this.description,
+            publishedBy: this.publishedBy,
+            publishedAt: this.publishedAt,
+            createdAt: this.createdAt,
+            updatedAt: this.updatedAt,
+            tags: [...this.tags],
+        };
+        if (typeof this.deprecated === 'boolean') {
+            result.deprecated = this.deprecated;
+        }
+        if (typeof this.deprecatedAt === 'number') {
+            result.deprecatedAt = this.deprecatedAt;
+        }
+        if (typeof this.deprecatedBy === 'string') {
+            result.deprecatedBy = this.deprecatedBy;
+        }
+        if (typeof this.deprecationReason === 'string') {
+            result.deprecationReason = this.deprecationReason;
+        }
+        if (typeof this.unpublishedAt === 'number') {
+            result.unpublishedAt = this.unpublishedAt;
+        }
+        return result;
+    }
+}
+//# sourceMappingURL=DataCatalog.js.map

package/build/src/models/DataCatalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataCatalog.js","sourceRoot":"","sources":["../../../src/models/DataCatalog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AA6H5C,MAAM,OAAO,WAAW;IACtB,GAAG,CAAQ;IAEX,IAAI,IAAI;QACN,OAAO,eAAe,CAAA;IACxB,CAAC;IAED,YAAY,CAAQ;IACpB,IAAI,CAAQ;IACZ,KAAK,CAAkB;IACvB,IAAI,CAAQ;IACZ,WAAW,CAAQ;IACnB,WAAW,CAAQ;IACnB,WAAW,CAAQ;IACnB,SAAS,CAAQ;IACjB,SAAS,CAAQ;IACjB,aAAa,CAAqB;IAClC,UAAU,CAAsB;IAChC,YAAY,CAAqB;IACjC,YAAY,CAAqB;IACjC,iBAAiB,CAAqB;IACtC,IAAI,CAAU;IAEd,MAAM,CAAC,YAAY,CAAC,KAAiC;QACnD,MAAM,EACJ,GAAG,GAAG,EAAE,EACR,YAAY,GAAG,EAAE,EACjB,IAAI,GAAG,EAAE,EACT,KAAK,GAAG,SAAS,EACjB,IAAI,GAAG,EAAE,EACT,WAAW,GAAG,EAAE,EAChB,WAAW,GAAG,EAAE,EAChB,WAAW,GAAG,CAAC,EACf,SAAS,GAAG,CAAC,EACb,SAAS,GAAG,CAAC,EACb,IAAI,GAAG,EAAE,GACV,GAAG,KAAK,CAAA;QACT,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,EAAE,CAAC,CAAA;QAC5C,CAAC;QACD,MAAM,MAAM,GAAsB;YAChC,GAAG;YACH,IAAI,EAAE,eAAe;YACrB,YAAY;YACZ,IAAI;YACJ,KAAK;YACL,IAAI;YACJ,WAAW;YACX,WAAW;YACX,WAAW;YACX,SAAS;YACT,SAAS;YACT,IAAI;SACL,CAAA;QACD,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YAC1C,MAAM,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAA;QACtC,CAAC;QACD,IAAI,OAAO,KAAK,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC3C,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;QAC1C,CAAC;QACD,IAAI,OAAO,KAAK,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC3C,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;QAC1C,CAAC;QACD,IAAI,OAAO,KAAK,CAAC,iBAAiB,KAAK,QAAQ,EAAE,CAAC;YAChD,MAAM,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAA;QACpD,CAAC;QACD,IAAI,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;YAC5C,MAAM,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;QAC5C,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED,YAAY,QAAoC,EAAE;QAChD,MAAM,IAAI,GAAG,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;QAC5C,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;QACnB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACnC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACnC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACnC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,OAAO,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;QACnC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC1C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QACvC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC1C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QACvC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,iBAAiB,KAAK,QAAQ,EAAE,CAAC;YAC/C,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAA;QACjD,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;QACzC,CAAC;IACH,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAsB;YAChC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,eAAe;YACrB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;SACrB,CAAA;QACD,IAAI,OAAO,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACzC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;QACrC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC1C,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QACzC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC1C,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QACzC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,iBAAiB,KAAK,QAAQ,EAAE,CAAC;YAC/C,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAA;QACnD,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;YAC3C,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;QAC3C,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF","sourcesContent":["import { DataCatalogKind } from './kinds.js'\n\nexport type DataCatalogScope = 'public' | 'private' | 'organization'\n\nexport interface DataCatalogSchema {\n  /**\n   * The key of the data catalog entry.\n   * When the value is missing it will be generated by the API.\n   *\n   * The key can only be set when creating a new data catalog entry.\n   * @readonly\n   */\n  key: string\n  /**\n   * The kind of the schema\n   * This is set by the API and is used to identify the schema.\n   * @readonly\n   */\n  readonly kind: typeof DataCatalogKind\n  /**\n   * The key of the organization.\n   * @required\n   */\n  organization: string\n  /**\n   * The key of the related data catalog file entry.\n   * @required\n   */\n  file: string\n  /**\n   * The scope of the data catalog entry.\n   * @required\n   */\n  scope: DataCatalogScope\n  /**\n   * The name of the data catalog entry.\n   * It is required when creating a new data catalog entry.\n   * @required\n   */\n  name: string\n  /**\n   * A short description of the data catalog entry.\n   * @required\n   */\n  description: string\n  /**\n   * The id of the user who created the data catalog entry.\n   * It is ignored when creating or updating a data catalog entry.\n   * @readonly\n   */\n  publishedBy: string\n  /**\n   * The time when the last version was published.\n   * It is ignored when creating or updating a data catalog entry.\n   * @readonly\n   */\n  publishedAt: number\n  /**\n   * The time when the data catalog entry was created.\n   * It is ignored when creating or updating a data catalog entry.\n   * @readonly\n   */\n  createdAt: number\n  /**\n   * The time when the data catalog entry was last updated.\n   * It is ignored when creating or updating a data catalog entry.\n   * @readonly\n   */\n  updatedAt: number\n  /**\n   * The timestamp when this entry was unpublished.\n   * Only set when the entry was unpublished.\n   * @readonly\n   */\n  unpublishedAt?: number\n  /**\n   * A flag indicating if the entry is deprecated.\n   * @readonly\n   */\n  deprecated?: boolean\n  /**\n   * The timestamp when the entry was deprecated.\n   * Only set when the entry was deprecated.\n   * @readonly\n   */\n  deprecatedAt?: number\n  /**\n   * The id of the user who deprecated the entry.\n   * Only set when the entry was deprecated.\n   * @readonly\n   */\n  deprecatedBy?: string\n  /**\n   * The reason why the entry was deprecated.\n   * Only set when the entry was deprecated.\n   */\n  deprecationReason?: string\n  /**\n   * The list of tags associated with the data catalog entry.\n   * @readonly Use the API endpoints to manage tags.\n   */\n  tags: string[]\n}\n\n/**\n * Used with API communication when listing data catalog entries.\n */\nexport interface DataCatalogSchemaWithVersion extends DataCatalogSchema {\n  /**\n   * The list of published versions of the data catalog entry.\n   * Note, this is limited to the last 20 versions.\n   */\n  versions: string[]\n}\n\nexport interface DataCatalogVersionInfo {\n  key: string\n  version: string\n  published: number\n}\n\nexport interface DataCatalogStatus extends DataCatalogSchema {\n  versions: DataCatalogVersionInfo[]\n}\n\nexport class DataCatalog implements DataCatalogSchema {\n  key: string\n\n  get kind(): typeof DataCatalogKind {\n    return DataCatalogKind\n  }\n\n  organization: string\n  file: string\n  scope: DataCatalogScope\n  name: string\n  description: string\n  publishedBy: string\n  publishedAt: number\n  createdAt: number\n  updatedAt: number\n  unpublishedAt?: number | undefined\n  deprecated?: boolean | undefined\n  deprecatedAt?: number | undefined\n  deprecatedBy?: string | undefined\n  deprecationReason?: string | undefined\n  tags: string[]\n\n  static createSchema(input: Partial<DataCatalogSchema>): DataCatalogSchema {\n    const {\n      key = '',\n      organization = '',\n      file = '',\n      scope = 'private',\n      name = '',\n      description = '',\n      publishedBy = '',\n      publishedAt = 0,\n      createdAt = 0,\n      updatedAt = 0,\n      tags = [],\n    } = input\n    if (['public', 'private', 'organization'].indexOf(scope) === -1) {\n      throw new Error(`Invalid scope: ${scope}`)\n    }\n    const result: DataCatalogSchema = {\n      key,\n      kind: DataCatalogKind,\n      organization,\n      file,\n      scope,\n      name,\n      description,\n      publishedBy,\n      publishedAt,\n      createdAt,\n      updatedAt,\n      tags,\n    }\n    if (typeof input.deprecated === 'boolean') {\n      result.deprecated = input.deprecated\n    }\n    if (typeof input.deprecatedAt === 'number') {\n      result.deprecatedAt = input.deprecatedAt\n    }\n    if (typeof input.deprecatedBy === 'string') {\n      result.deprecatedBy = input.deprecatedBy\n    }\n    if (typeof input.deprecationReason === 'string') {\n      result.deprecationReason = input.deprecationReason\n    }\n    if (typeof input.unpublishedAt === 'number') {\n      result.unpublishedAt = input.unpublishedAt\n    }\n    return result\n  }\n\n  constructor(input: Partial<DataCatalogSchema> = {}) {\n    const init = DataCatalog.createSchema(input)\n    this.key = init.key\n    this.organization = init.organization\n    this.file = init.file\n    this.scope = init.scope\n    this.name = init.name\n    this.description = init.description\n    this.publishedBy = init.publishedBy\n    this.publishedAt = init.publishedAt\n    this.createdAt = init.createdAt\n    this.updatedAt = init.updatedAt\n    this.tags = init.tags\n    if (typeof init.deprecated === 'boolean') {\n      this.deprecated = init.deprecated\n    }\n    if (typeof init.deprecatedAt === 'number') {\n      this.deprecatedAt = init.deprecatedAt\n    }\n    if (typeof init.deprecatedBy === 'string') {\n      this.deprecatedBy = init.deprecatedBy\n    }\n    if (typeof init.deprecationReason === 'string') {\n      this.deprecationReason = init.deprecationReason\n    }\n    if (typeof init.unpublishedAt === 'number') {\n      this.unpublishedAt = init.unpublishedAt\n    }\n  }\n\n  toJSON(): DataCatalogSchema {\n    const result: DataCatalogSchema = {\n      key: this.key,\n      kind: DataCatalogKind,\n      organization: this.organization,\n      file: this.file,\n      scope: this.scope,\n      name: this.name,\n      description: this.description,\n      publishedBy: this.publishedBy,\n      publishedAt: this.publishedAt,\n      createdAt: this.createdAt,\n      updatedAt: this.updatedAt,\n      tags: [...this.tags],\n    }\n    if (typeof this.deprecated === 'boolean') {\n      result.deprecated = this.deprecated\n    }\n    if (typeof this.deprecatedAt === 'number') {\n      result.deprecatedAt = this.deprecatedAt\n    }\n    if (typeof this.deprecatedBy === 'string') {\n      result.deprecatedBy = this.deprecatedBy\n    }\n    if (typeof this.deprecationReason === 'string') {\n      result.deprecationReason = this.deprecationReason\n    }\n    if (typeof this.unpublishedAt === 'number') {\n      result.unpublishedAt = this.unpublishedAt\n    }\n    return result\n  }\n}\n"]}

package/build/src/models/DataCatalogVersion.d.ts

@@ -0,0 +1,123 @@
+import { DataCatalogScope } from './DataCatalog.js';
+import { DataCatalogVersionKind } from './kinds.js';
+export type DataCatalogLifecycle = 'stable' | 'beta' | 'dev';
+export interface DataCatalogVersionSchema {
+    /**
+     * The key of the version.
+     *
+     * The key can only be set when creating a new data catalog entry.
+     * @readonly
+     */
+    key: string;
+    /**
+     * The kind of the schema
+     */
+    readonly kind: typeof DataCatalogVersionKind;
+    /**
+     * The key of the parent data catalog entry.
+     * It is only populated by the API when creating the version.
+     * @readonly
+     */
+    catalogKey: string;
+    /**
+     * The publication scope of the data catalog entry.
+     *
+     * When the scope is set to a different value than the one of the parent data catalog entry,
+     * then this value is used to determine the visibility of the data catalog entry. However,
+     * the reader cannot access the version with a "public" scope if the parent data catalog entry is private.
+     *
+     * @required
+     */
+    scope: DataCatalogScope;
+    /**
+     * The lifecycle of the data catalog entry.
+     *
+     * - `stable`: The data catalog entry is stable and can be used in production.
+     * - `beta`: The data catalog entry is in beta and may change in the future.
+     * - `dev`: The data catalog entry is in development and likely will change in the future.
+     *
+     * The lifecycle is a readonly property and is set by the API when creating or updating the data catalog entry.
+     * A version is immutable and to change the lifecycle, a new version must be created.
+     *
+     * @required
+     */
+    lifecycle: DataCatalogLifecycle;
+    /**
+     * The version string according to the [semantic versioning](https://semver.org/) specification.
+     * Note, this value is limited to 32 characters by the API.
+     * @required
+     */
+    version: string;
+    /**
+     * The id of the user who created the version.
+     * It is ignored when creating or updating a data catalog entry.
+     * @readonly
+     */
+    publishedBy: string;
+    /**
+     * The timestamp when this version was unpublished.
+     * Only set when the version was unpublished.
+     * @readonly
+     */
+    unpublishedAt?: number;
+    /**
+     * A flag indicating if the version is deprecated.
+     * @readonly
+     */
+    deprecated?: boolean;
+    /**
+     * The timestamp when the version was deprecated.
+     * Only set when the version was deprecated.
+     * @readonly
+     */
+    deprecatedAt?: number;
+    /**
+     * The id of the user who deprecated the version.
+     * Only set when the version was deprecated.
+     * @readonly
+     */
+    deprecatedBy?: string;
+    /**
+     * The reason why the version was deprecated.
+     * Only set when the version was deprecated.
+     */
+    deprecationReason?: string;
+    /**
+     * The timestamp when the data catalog entry was created.
+     * It is ignored when creating or updating a data catalog entry.
+     * @readonly
+     */
+    createdAt: number;
+    /**
+     * The timestamp when the data catalog entry was last updated.
+     * It is ignored when creating or updating a data catalog entry.
+     * @readonly
+     */
+    updatedAt: number;
+    /**
+     * The changelog of the data catalog entry.
+     * Note, this value is required by the API when creating the version.
+     */
+    changelog?: string;
+}
+export declare class DataCatalogVersion implements DataCatalogVersionSchema {
+    key: string;
+    get kind(): typeof DataCatalogVersionKind;
+    catalogKey: string;
+    scope: DataCatalogScope;
+    lifecycle: DataCatalogLifecycle;
+    version: string;
+    publishedBy: string;
+    unpublishedAt?: number | undefined;
+    deprecated?: boolean | undefined;
+    deprecatedAt?: number | undefined;
+    deprecatedBy?: string | undefined;
+    deprecationReason?: string | undefined;
+    createdAt: number;
+    updatedAt: number;
+    changelog?: string | undefined;
+    static createSchema(input: Partial<DataCatalogVersionSchema>): DataCatalogVersionSchema;
+    constructor(input?: Partial<DataCatalogVersionSchema>);
+    toJSON(): DataCatalogVersionSchema;
+}
+//# sourceMappingURL=DataCatalogVersion.d.ts.map

package/build/src/models/DataCatalogVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataCatalogVersion.d.ts","sourceRoot":"","sources":["../../../src/models/DataCatalogVersion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AAEnD,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAA;AAE5D,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,sBAAsB,CAAA;IAC5C;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;;;;OAQG;IACH,KAAK,EAAE,gBAAgB,CAAA;IACvB;;;;;;;;;;;OAWG;IACH,SAAS,EAAE,oBAAoB,CAAA;IAC/B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,qBAAa,kBAAmB,YAAW,wBAAwB;IACjE,GAAG,EAAE,MAAM,CAAA;IAEX,IAAI,IAAI,IAAI,OAAO,sBAAsB,CAExC;IAED,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,gBAAgB,CAAA;IACvB,SAAS,EAAE,oBAAoB,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE9B,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,wBAAwB;gBA8C3E,KAAK,GAAE,OAAO,CAAC,wBAAwB,CAAM;IA8BzD,MAAM,IAAI,wBAAwB;CAgCnC"}