1
0
mirror of synced 2025-12-19 17:17:05 -05:00

fix: clean spec

This commit is contained in:
caele
2023-08-18 10:51:13 +02:00
parent 1148aa900e
commit 96880cd441
3 changed files with 51 additions and 25 deletions

View File

@@ -10,8 +10,11 @@
}, },
"entries": { "entries": {
"properties": { "properties": {
"kind": "function", "extends": [
"params": [], {
"type": "GenericObjectProperties"
}
],
"entries": { "entries": {
"version": { "version": {
"description": "Current version of this generic object definition", "description": "Current version of this generic object definition",
@@ -21,7 +24,7 @@
"description": "Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.", "description": "Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.",
"extends": [ "extends": [
{ {
"type": "HyperCubeDef" "type": "EngineAPI.HyperCubeDef"
} }
], ],
"kind": "object" "kind": "object"
@@ -157,7 +160,8 @@
"defaultValue": false, "defaultValue": false,
"type": "boolean" "type": "boolean"
} }
} },
"kind": "object"
} }
}, },
"definitions": {} "definitions": {}

View File

@@ -1,27 +1,48 @@
const path = require('path'); const path = require("path");
const pkg = require(path.resolve(__dirname, '../package.json')); // eslint-disable-line const pkg = require(path.resolve(__dirname, "../package.json")); // eslint-disable-line
module.exports = { module.exports = {
glob: ["./src/extension/properties.js"], fromJsdoc: {
package: path.resolve(__dirname, "../package.json"), glob: ["./src/extension/properties.js"],
api: { api: {
stability: "stable", stability: "stable",
properties: { visibility: "public",
"x-qlik-visibility": "public", properties: {
"x-qlik-visibility": "public",
},
name: `${pkg.name}:properties`,
version: pkg.version,
description: "Network chart generic object definition",
},
output: {
sort: {
alpha: false,
},
file: "./api-specifications/properties.json",
},
parse: {
types: {
GenericObjectProperties: {
url: "https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FGenericObjectProperties",
},
undefined: {},
"EngineAPI.ValueExpression": {
url: "https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FValueExpression",
},
"EngineAPI.HyperCubeDef": {
url: "https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FListObjectDef",
},
},
}, },
visibility: "public",
name: `${pkg.name}:properties`,
version: pkg.version,
description: "Network chart generic object definition",
}, },
output: { toDts: {
file: path.resolve(__dirname, "../api-specifications/properties.json"), spec: "./api-specifications/properties.json",
}, output: {
parse: { file: "./types/index.d.ts",
types: { },
NxMeasure: {}, dependencies: {
HyperCubeDef: {}, references: ["qlik-engineapi"],
}, },
}, },
}; };

View File

@@ -1,5 +1,6 @@
/** /**
* @typedef {object} * @type {object}
* @extends {GenericObjectProperties}
* @entry * @entry
*/ */
const properties = { const properties = {
@@ -10,7 +11,7 @@ const properties = {
version: process.env.PACKAGE_VERSION, version: process.env.PACKAGE_VERSION,
/** /**
* Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`. * Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.
* @extends {HyperCubeDef} * @extends {EngineAPI.HyperCubeDef}
*/ */
qHyperCubeDef: { qHyperCubeDef: {
qDimensions: [], qDimensions: [],