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": {
"properties": {
"kind": "function",
"params": [],
"extends": [
{
"type": "GenericObjectProperties"
}
],
"entries": {
"version": {
"description": "Current version of this generic object definition",
@@ -21,7 +24,7 @@
"description": "Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.",
"extends": [
{
"type": "HyperCubeDef"
"type": "EngineAPI.HyperCubeDef"
}
],
"kind": "object"
@@ -157,7 +160,8 @@
"defaultValue": false,
"type": "boolean"
}
}
},
"kind": "object"
}
},
"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 = {
glob: ["./src/extension/properties.js"],
package: path.resolve(__dirname, "../package.json"),
api: {
stability: "stable",
properties: {
"x-qlik-visibility": "public",
fromJsdoc: {
glob: ["./src/extension/properties.js"],
api: {
stability: "stable",
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: {
file: path.resolve(__dirname, "../api-specifications/properties.json"),
},
parse: {
types: {
NxMeasure: {},
HyperCubeDef: {},
toDts: {
spec: "./api-specifications/properties.json",
output: {
file: "./types/index.d.ts",
},
dependencies: {
references: ["qlik-engineapi"],
},
},
};

View File

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