@nebula.js/sn-org-chart 1.9.0 → 1.10.0

package/README.md

@@ -64,9 +64,22 @@ pnpm install
 pnpm start        # dev server on http://localhost:8000
 pnpm test:unit    # vitest
 pnpm test:e2e     # playwright rendering tests
-pnpm build        # dist/, core/esm/ and the Qlik Sense extension in sn-org-chart-ext/
 ```
 
+### Building
+
+`pnpm install` runs the `prepare` script, which generates translations and then runs `pnpm run generate` to generate the TypeSpec outputs, including the JSON Schema at `tsp-output/@typespec/json-schema/sn-org-chart.json`. These generated files are ignored by Git, so installation must complete before building, including in CI.
+
+Run `pnpm generate` again after changing the TypeSpec definitions. If installation was run with lifecycle scripts disabled (for example, `pnpm install --ignore-scripts`), run `pnpm run prepare` manually to generate both translations and TypeSpec outputs.
+
+Builds copy the existing schema without regenerating it. The build calls `copyJsonSchema()` from `tools/copy-json-schema.js` to copy it to `api-specifications/sn-org-chart.json` before bundling:
+
+```sh
+pnpm build
+```
+
+For a development build, run `pnpm build:dev`. To rebuild on changes, run `pnpm build:watch`.
+
 See [.github/CONTRIBUTION.md](./.github/CONTRIBUTION.md) for the contribution workflow.
 
 ## Documentation

package/api-specifications/properties.json

@@ -3,7 +3,7 @@
   "info": {
     "name": "@nebula.js/sn-org-chart:properties",
     "description": "Org chart generic object definition",
-    "version": "1.9.0",
+    "version": "1.10.0",
     "license": "MIT",
     "stability": "experimental",
     "x-qlik-visibility": "public"

package/api-specifications/sn-org-chart.json

@@ -1,16 +1,16 @@
 {
-    "x-schema-version": "1.9.0",
+    "x-schema-version": "1.10.0",
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "sn-org-chart.json",
     "$defs": {
-        "OrgChartProperties": {
+        "/schemas/properties": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
             "$id": "/schemas/properties",
             "type": "object",
             "properties": {
                 "version": {
                     "type": "string",
-                    "default": "1.9.0",
+                    "default": "1.10.0",
                     "description": "Current version of this generic object definition"
                 },
                 "qInfo": {
@@ -188,7 +188,7 @@
             "$id": "NxMetaDef.json",
             "type": "object",
             "properties": {},
-            "description": "Used to collect meta data.\n\n### Properties\nSemantic type with an empty structure."
+            "description": "Used to collect metadata.\n\n### Properties\nSemantic type with an empty structure."
         },
         "HyperCubeDef": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
@@ -321,11 +321,11 @@
                 },
                 "qContextSetExpression": {
                     "type": "string",
-                    "description": "Set Expression valid for the whole cube. Used to limit computations to the set specified."
+                    "description": "Set expression valid for the whole cube, limiting computations to the specified set."
                 },
                 "qSuppressMeasureTotals": {
                     "type": "boolean",
-                    "description": "If set to true, suppress any measure grand totals, ignoring any AggrFunc."
+                    "description": "When true, suppresses any grand totals for measures, regardless of the AggrFunc setting."
                 }
             },
             "description": "Defines the properties of a hypercube.\nFor more information about the definition of a hypercube, see _Generic object_."
@@ -993,7 +993,7 @@
                 },
                 "qAggrFunc": {
                     "type": "string",
-                    "description": "Flag indicating how the measure should be aggregated to create a grand total. \\\"None\\\" - No total calculation. \\\"Expr\\\" - Calculate total according to the measure expression. \\\"\\\"     - Empty string is default and has same effect as \\\"Expr\\\". This parameter is optional."
+                    "description": "Indicates how to aggregate the measure to create a grand total. \\\"None\\\" - No total calculation is performed. \\\"Expr\\\" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as \\\"Expr\\\". This parameter is optional."
                 },
                 "qAccumulate": {
                     "type": "integer",
@@ -2240,7 +2240,7 @@
             },
             "description": "Image placement and shape settings for chart cards."
         },
-        "OrgChartLayout": {
+        "/schemas/layout": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
             "$id": "/schemas/layout",
             "type": "object",