jprdonnelly/nebula.js
1
0
Fork 0
mirror of https://github.com/qlik-oss/nebula.js.git synced 2025-12-19 09:48:18 -05:00
Code Issues Projects Releases Wiki Activity

feat: change qix typescript definition to @qlik/api (#1493)

Browse Source 
BREAKING CHANGE: @qlik/api typescript definition is not compatible with @types/qlik-engineapi

Signed-off-by: Johan Enell <johan.enell@qlik.com>
This commit is contained in:
Johan Enell
2024-03-19 15:13:33 +01:00
committed by GitHub
parent 35af332a83
commit f7b631051b
19 changed files with 189 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
apis/conversion/src/export-format.js
View File

@@ -13,10 +13,10 @@
/**
* @since 1.1.0
* @interface ExportDataDef
* @property {EngineAPI.INxDimension[]} dimensions
* @property {EngineAPI.INxMeasure[]} measures
* @property {EngineAPI.INxDimension[]} excludedDimensions
* @property {EngineAPI.INxMeasure[]} excludedMeasures
* @property {qix.NxDimension[]} dimensions
* @property {qix.NxMeasure[]} measures
* @property {qix.NxDimension[]} excludedDimensions
* @property {qix.NxMeasure[]} excludedMeasures
* @property {number[]} interColumnSortOrder
*/

6
apis/enigma-mocker/src/index.js
View File

@@ -16,7 +16,7 @@ import fGO from './from-generic-objects';
*/
const mocker = /** @lends EnigmaMocker# */ {
/**
* Mocks Engima app functionality. It accepts one / many generic objects as input argument and returns the mocked Enigma app. Each generic object represents one visulization and specifies how it behaves. For example, what layout to use the data to present.
* Mocks Engima app functionality. It accepts one / many generic objects as input argument and returns the mocked Enigma app. Each generic object represents one visualisation and specifies how it behaves. For example, what layout to use the data to present.
*
* The generic object is represented with a Javascript object with a number of properties. The name of the property correlates to the name in the Enigma model for `app.getObject(id)`. For example, the property `getLayout` in the generic object is used to define `app.getObject(id).getLayout()`. Any property can be added to the fixture (just make sure it exists and behaves as in the Enigma model!).
*
@@ -24,9 +24,9 @@ const mocker = /** @lends EnigmaMocker# */ {
* @type function
* @experimental
* @since 3.0.0
* @param {Array<object>} genericObjects Generic objects controling behaviour of visualizations.
* @param {Array<object>} genericObjects Generic objects controlling behaviour of visualizations.
* @param {EnigmaMockerOptions=} options Options
* @returns {Promise<EngineAPI.IApp>}
* @returns {Promise<qix.Doc>}
* @example
* const genericObject = {
* getLayout() {

10
apis/nucleus/spec/spec.conf.js
View File

@@ -12,19 +12,19 @@ module.exports = {
},
parse: {
types: {
'EngineAPI.IApp': {
Doc: {
url: 'https://qlik.dev/apis/json-rpc/qix/doc#%23%2Fentries%2FDoc',
},
'EngineAPI.IGenericObjectLayout': {
GenericObjectLayout: {
url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FGenericObjectLayout',
},
'EngineAPI.IGenericObjectProperties': {
GenericObjectProperties: {
url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FGenericObjectProperties',
},
'EngineAPI.INxDimension': {
NxDimension: {
url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FNxDimension',
},
'EngineAPI.INxMeasure': {
NxMeasure: {
url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FNxMeasure',
},
},

2
apis/nucleus/src/components/listbox/default-properties.js
View File

@@ -8,7 +8,7 @@
/**
* Extends `ListObjectDef`, see Engine API: `ListObjectDef`.
* @interface ListObjectDef
* @extends EngineAPI.IListObjectDef
* @extends qix.ListObjectDef
* @property {boolean} [frequencyEnabled=false] Show frequency count. also requires qListObjectDef.qFrequencyMode to be set
*/

4
apis/nucleus/src/index.js
View File

@@ -198,7 +198,7 @@ function nuked(configuration = {}) {
* Initiates a new `Embed` instance using the specified enigma `app`.
* @entry
* @function embed
* @param {EngineAPI.IApp} app
* @param {qix.Doc} app
* @param {Configuration=} instanceConfig
* @returns {Embed}
* @example
@@ -327,7 +327,7 @@ function nuked(configuration = {}) {
* Creates a visualization model
* @param {CreateConfig} cfg The create configuration.
* @experimental
* @returns {Promise<EngineAPI.IGenericObject>} An engima model
* @returns {Promise<qix.GenericObject>} An engima model
* @example
* // create a barchart in the app and return the model
* const model = await n.create({

4
apis/nucleus/src/object/create-object.js
View File

@@ -1,7 +1,7 @@
import populateData from './populator';
/**
* @typedef {string | EngineAPI.INxDimension | EngineAPI.INxMeasure | LibraryField} Field
* @typedef {string | qix.NxDimension | qix.NxMeasure | LibraryField} Field
*/
/**
@@ -10,7 +10,7 @@ import populateData from './populator';
* @property {string} type
* @property {string=} version
* @property {(Field[])=} fields
* @property {EngineAPI.IGenericObjectProperties=} properties
* @property {qix.GenericObjectProperties=} properties
*/
export default async function createObject(

4
apis/nucleus/src/object/create-session-object.js
View File

@@ -2,7 +2,7 @@ import populateData from './populator';
import init from './initiate';
/**
* @typedef {string | EngineAPI.INxDimension | EngineAPI.INxMeasure | LibraryField} Field
* @typedef {string | qix.NxDimension | qix.NxMeasure | LibraryField} Field
*/
/**
@@ -16,7 +16,7 @@ import init from './initiate';
* @property {string=} version For creating objects: Version of visualization to render
* @property {(Field[])=} fields For creating objects: Data fields to use
* @property {boolean=} [extendProperties=false] For creating objects: Whether to deeply extend properties or not. If false then subtrees will be overwritten.
* @property {EngineAPI.IGenericObjectProperties=} properties For creating objects: Explicit properties to set
* @property {qix.GenericObjectProperties=} properties For creating objects: Explicit properties to set
* @example
* // A config for Creating objects:
* const createConfig = {

2
apis/nucleus/src/viz.js
View File

@@ -92,7 +92,7 @@ export default function viz({ model, halo, initialError, onDestroy = async () =>
id: model.id,
/**
* This visualizations Enigma model, a representation of the generic object.
* @type {EngineAPI.IGenericObject}
* @type {qix.GenericObject}
*/
model,
/**

2
apis/stardust/api-spec/listbox-spec.conf.js
View File

@@ -19,7 +19,7 @@ module.exports = {
parse: {
types: {
undefined: {},
'EngineAPI.IListObjectDef': {
'qix.ListObjectDef': {
url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FListObjectDef',
},
},

2
apis/stardust/api-spec/listbox-spec.json
View File

@@ -161,7 +161,7 @@
"description": "Extends `ListObjectDef`, see Engine API: `ListObjectDef`.",
"extends": [
{
"type": "EngineAPI.IListObjectDef"
"type": "qix.ListObjectDef"
}
],
"kind": "interface",

18
apis/stardust/api-spec/spec.conf.js
View File

@@ -23,22 +23,22 @@ module.exports = {
parse: {
types: {
undefined: {},
'EngineAPI.INxAppLayout': {},
'EngineAPI.IGenericObject': {},
'EngineAPI.IGlobal': {},
'EngineAPI.IApp': {
'qix.NxAppLayout': {},
'qix.GenericObject': {},
'qix.Global': {},
'qix.Doc': {
url: 'https://qlik.dev/apis/json-rpc/qix/doc#%23%2Fentries%2FDoc',
},
'EngineAPI.IGenericObjectLayout': {
'qix.GenericObjectLayout': {
url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FGenericObjectLayout',
},
'EngineAPI.IGenericObjectProperties': {
'qix.GenericObjectProperties': {
url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FGenericObjectProperties',
},
'EngineAPI.INxDimension': {
'qix.NxDimension': {
url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FNxDimension',
},
'EngineAPI.INxMeasure': {
'qix.NxMeasure': {
url: 'https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FNxMeasure',
},
},
@@ -50,7 +50,7 @@ module.exports = {
file: './types/index.d.ts',
},
dependencies: {
references: ['qlik-engineapi'],
imports: [{ type: '* as qix', package: "'@qlik/api/qix'" }],
},
},
};

114
apis/stardust/api-spec/spec.json
View File

@@ -14,7 +14,7 @@
"params": [
{
"name": "app",
"type": "EngineAPI.IApp"
"type": "qix.Doc"
},
{
"name": "instanceConfig",
@@ -231,7 +231,7 @@
"kind": "function",
"params": [],
"returns": {
"type": "EngineAPI.IGenericObjectLayout"
"type": "qix.GenericObjectLayout"
},
"examples": [
"import { useLayout } from '@nebula.js/stardust';\n// ...\nconst layout = useLayout();\nconsole.log(layout);"
@@ -242,7 +242,7 @@
"kind": "function",
"params": [],
"returns": {
"type": "EngineAPI.IGenericObjectLayout"
"type": "qix.GenericObjectLayout"
},
"examples": [
"import { useStaleLayout } from '@nebula.js/stardust';\n// ...\nconst staleLayout = useStaleLayout();\nconsole.log(staleLayout);"
@@ -254,7 +254,7 @@
"params": [],
"returns": {
"description": "The app layout",
"type": "EngineAPI.INxAppLayout"
"type": "qix.NxAppLayout"
},
"examples": [
"import { useAppLayout } from '@nebula.js/stardust';\n// ...\nconst appLayout = useAppLayout();\nconsole.log(appLayout.qLocaleInfo);"
@@ -268,7 +268,7 @@
"kind": "union",
"items": [
{
"type": "EngineAPI.IGenericObject"
"type": "qix.GenericObject"
},
{
"type": "undefined"
@@ -288,7 +288,7 @@
"kind": "union",
"items": [
{
"type": "EngineAPI.IApp"
"type": "qix.Doc"
},
{
"type": "undefined"
@@ -308,7 +308,7 @@
"kind": "union",
"items": [
{
"type": "EngineAPI.IGlobal"
"type": "qix.Global"
},
{
"type": "undefined"
@@ -340,7 +340,7 @@
"type": "#/definitions/Theme"
},
"examples": [
"import { useTheme } from '@nebula.js/stardust';\n\nconst theme = useTheme();\nconsole.log(theme.getContrastinColorTo('#ff0000'));"
"import { useTheme } from '@nebula.js/stardust';\n\nconst theme = useTheme();\nconsole.log(theme.getContrastingColorTo('#ff0000'));"
]
},
"useEmbed": {
@@ -516,14 +516,14 @@
"kind": "function",
"params": [
{
"type": "EngineAPI.IGenericObjectLayout"
"type": "qix.GenericObjectLayout"
}
],
"returns": {
"type": "Promise",
"generics": [
{
"type": "EngineAPI.IGenericObjectLayout"
"type": "qix.GenericObjectLayout"
}
]
}
@@ -543,7 +543,7 @@
"type": "#/definitions/RenderState"
},
"examples": [
"import { useRenderState } from '@nebula.js/stardust';\n\nconst renderState = useRenderState();\nuseState(() => {\n if(needProperteisUpdate(...)) {\n useRenderState.pending();\n updateProperties(...);\n } else {\n useRenderState.restore();\n ...\n }\n}, [...]);"
"import { useRenderState } from '@nebula.js/stardust';\n\nconst renderState = useRenderState();\nuseState(() => {\n if(needPropertiesUpdate(...)) {\n useRenderState.pending();\n updateProperties(...);\n } else {\n useRenderState.restore();\n ...\n }\n}, [...]);"
]
},
"useEmitter": {
@@ -594,7 +594,7 @@
"kind": "namespace",
"entries": {
"fromGenericObjects": {
"description": "Mocks Engima app functionality. It accepts one / many generic objects as input argument and returns the mocked Enigma app. Each generic object represents one visulization and specifies how it behaves. For example, what layout to use the data to present.\n\nThe generic object is represented with a Javascript object with a number of properties. The name of the property correlates to the name in the Enigma model for `app.getObject(id)`. For example, the property `getLayout` in the generic object is used to define `app.getObject(id).getLayout()`. Any property can be added to the fixture (just make sure it exists and behaves as in the Enigma model!).\n\nThe value for each property is either fixed (string / boolean / number / object) or a function. Arguments are forwarded to the function to allow for greater flexibility. For example, this can be used to return different hypercube data when scrolling in the chart.",
"description": "Mocks Engima app functionality. It accepts one / many generic objects as input argument and returns the mocked Enigma app. Each generic object represents one visualisation and specifies how it behaves. For example, what layout to use the data to present.\n\nThe generic object is represented with a Javascript object with a number of properties. The name of the property correlates to the name in the Enigma model for `app.getObject(id)`. For example, the property `getLayout` in the generic object is used to define `app.getObject(id).getLayout()`. Any property can be added to the fixture (just make sure it exists and behaves as in the Enigma model!).\n\nThe value for each property is either fixed (string / boolean / number / object) or a function. Arguments are forwarded to the function to allow for greater flexibility. For example, this can be used to return different hypercube data when scrolling in the chart.",
"stability": "experimental",
"availability": {
"since": "3.0.0"
@@ -603,7 +603,7 @@
"params": [
{
"name": "genericObjects",
"description": "Generic objects controling behaviour of visualizations.",
"description": "Generic objects controlling behaviour of visualizations.",
"kind": "array",
"items": {
"type": "object"
@@ -620,7 +620,7 @@
"type": "Promise",
"generics": [
{
"type": "EngineAPI.IApp"
"type": "qix.Doc"
}
]
},
@@ -813,7 +813,7 @@
"type": "Promise",
"generics": [
{
"type": "EngineAPI.IGenericObject"
"type": "qix.GenericObject"
}
]
},
@@ -1280,7 +1280,7 @@
},
"model": {
"description": "This visualizations Enigma model, a representation of the generic object.",
"type": "EngineAPI.IGenericObject"
"type": "qix.GenericObject"
},
"destroy": {
"description": "Destroys the visualization and removes it from the the DOM.",
@@ -1662,33 +1662,6 @@
}
}
},
"Plugin": {
"description": "An object literal containing meta information about the plugin and a function containing the plugin implementation.",
"stability": "experimental",
"availability": {
"since": "1.2.0"
},
"kind": "interface",
"entries": {
"info": {
"description": "Object that can hold various meta info about the plugin",
"kind": "object",
"entries": {
"name": {
"description": "The name of the plugin",
"type": "string"
}
}
},
"fn": {
"description": "The implementation of the plugin. Input and return value is up to the plugin implementation to decide based on its purpose.",
"type": "function"
}
},
"examples": [
"const plugin = {\n info: {\n name: \"example-plugin\",\n type: \"meta-type\",\n },\n fn: () => {\n // Plugin implementation goes here\n }\n};"
]
},
"Field": {
"kind": "alias",
"items": {
@@ -1698,10 +1671,10 @@
"type": "string"
},
{
"type": "EngineAPI.INxDimension"
"type": "qix.NxDimension"
},
{
"type": "EngineAPI.INxMeasure"
"type": "qix.NxMeasure"
},
{
"type": "#/definitions/LibraryField"
@@ -1734,7 +1707,7 @@
},
"properties": {
"optional": true,
"type": "EngineAPI.IGenericObjectProperties"
"type": "qix.GenericObjectProperties"
}
}
},
@@ -1796,7 +1769,7 @@
"properties": {
"description": "For creating objects: Explicit properties to set",
"optional": true,
"type": "EngineAPI.IGenericObjectProperties"
"type": "qix.GenericObjectProperties"
}
},
"examples": [
@@ -1824,6 +1797,33 @@
}
}
},
"Plugin": {
"description": "An object literal containing meta information about the plugin and a function containing the plugin implementation.",
"stability": "experimental",
"availability": {
"since": "1.2.0"
},
"kind": "interface",
"entries": {
"info": {
"description": "Object that can hold various meta info about the plugin",
"kind": "object",
"entries": {
"name": {
"description": "The name of the plugin",
"type": "string"
}
}
},
"fn": {
"description": "The implementation of the plugin. Input and return value is up to the plugin implementation to decide based on its purpose.",
"type": "function"
}
},
"examples": [
"const plugin = {\n info: {\n name: \"example-plugin\",\n type: \"meta-type\",\n },\n fn: () => {\n // Plugin implementation goes here\n }\n};"
]
},
"LoadType": {
"kind": "interface",
"params": [
@@ -2215,7 +2215,7 @@
"type": "boolean"
},
"select": {
"description": "Whether or not select interactions are on. Alows selection actions. Implied when active is false.",
"description": "Whether or not select interactions are on. Allows selection actions. Implied when active is false.",
"optional": true,
"defaultValue": true,
"type": "boolean"
@@ -2360,7 +2360,7 @@
"entries": {
"properties": {
"optional": true,
"type": "EngineAPI.IGenericObjectProperties"
"type": "qix.GenericObjectProperties"
},
"data": {
"optional": true,
@@ -2395,7 +2395,7 @@
"type": "#/definitions/FieldTarget",
"generics": [
{
"type": "EngineAPI.INxDimension"
"type": "qix.NxDimension"
}
]
},
@@ -2404,7 +2404,7 @@
"type": "#/definitions/FieldTarget",
"generics": [
{
"type": "EngineAPI.INxMeasure"
"type": "qix.NxMeasure"
}
]
}
@@ -2424,7 +2424,7 @@
},
{
"name": "properties",
"type": "EngineAPI.IGenericObjectProperties"
"type": "qix.GenericObjectProperties"
}
]
},
@@ -2442,7 +2442,7 @@
},
{
"name": "properties",
"type": "EngineAPI.IGenericObjectProperties"
"type": "qix.GenericObjectProperties"
},
{
"name": "index",
@@ -2873,25 +2873,25 @@
"dimensions": {
"kind": "array",
"items": {
"type": "EngineAPI.INxDimension"
"type": "qix.NxDimension"
}
},
"measures": {
"kind": "array",
"items": {
"type": "EngineAPI.INxMeasure"
"type": "qix.NxMeasure"
}
},
"excludedDimensions": {
"kind": "array",
"items": {
"type": "EngineAPI.INxDimension"
"type": "qix.NxDimension"
}
},
"excludedMeasures": {
"kind": "array",
"items": {
"type": "EngineAPI.INxMeasure"
"type": "qix.NxMeasure"
}
},
"interColumnSortOrder": {

4
apis/stardust/package.json
View File

@@ -40,9 +40,6 @@
"ts": "sy to-dts -c ./api-spec/spec.conf.js",
"version": "yarn run spec && yarn run ts && git add ./api-spec/spec.json ./api-spec/listbox-spec.json ./types/index.d.ts"
},
"dependencies": {
"@types/qlik-engineapi": "12.67.16"
},
"devDependencies": {
"@emotion/react": "^11.11.4",
"@emotion/styled": "^11.11.0",
@@ -55,6 +52,7 @@
"@nebula.js/supernova": "^4.14.0",
"@nebula.js/theme": "^4.14.0",
"@nebula.js/ui": "^4.14.0",
"@qlik/api": "^0.3.0",
"@scriptappy/cli": "0.10.0",
"@scriptappy/from-jsdoc": "0.19.0",
"@scriptappy/to-dts": "1.0.0",

72
apis/stardust/types/index.d.ts vendored
View File

@@ -1,11 +1,11 @@
// File generated automatically by "@scriptappy/to-dts"; DO NOT EDIT.
/// <reference types="qlik-engineapi" />
import * as qix from '@qlik/api/qix';
/**
* Initiates a new `Embed` instance using the specified enigma `app`.
* @param app
* @param instanceConfig
*/
export function embed(app: EngineAPI.IApp, instanceConfig?: stardust.Configuration): stardust.Embed;
export function embed(app: qix.Doc, instanceConfig?: stardust.Configuration): stardust.Embed;
export namespace embed {
/**
@@ -64,7 +64,7 @@ export function useRect(): stardust.Rect;
/**
* Gets the layout of the generic object associated with this visualization.
*/
export function useLayout(): EngineAPI.IGenericObjectLayout;
export function useLayout(): qix.GenericObjectLayout;
/**
* Gets the layout of the generic object associated with this visualization.
@@ -75,27 +75,27 @@ export function useLayout(): EngineAPI.IGenericObjectLayout;
* The returned value from `useStaleLayout()` and `useLayout()` are identical when the object
* is not in a modal state.
*/
export function useStaleLayout(): EngineAPI.IGenericObjectLayout;
export function useStaleLayout(): qix.GenericObjectLayout;
/**
* Gets the layout of the app associated with this visualization.
*/
export function useAppLayout(): EngineAPI.INxAppLayout;
export function useAppLayout(): qix.NxAppLayout;
/**
* Gets the generic object API of the generic object connected to this visualization.
*/
export function useModel(): EngineAPI.IGenericObject | undefined;
export function useModel(): qix.GenericObject | undefined;
/**
* Gets the doc API.
*/
export function useApp(): EngineAPI.IApp | undefined;
export function useApp(): qix.Doc | undefined;
/**
* Gets the global API.
*/
export function useGlobal(): EngineAPI.IGlobal | undefined;
export function useGlobal(): qix.Global | undefined;
/**
* Gets the object selections.
@@ -176,7 +176,7 @@ export function useImperativeHandle<T>(factory: ()=>T, deps?: any[]): void;
* Registers a callback that is called when a snapshot is taken.
* @param snapshotCallback
*/
export function onTakeSnapshot(snapshotCallback: ($: EngineAPI.IGenericObjectLayout)=>Promise<EngineAPI.IGenericObjectLayout>): void;
export function onTakeSnapshot(snapshotCallback: ($: qix.GenericObjectLayout)=>Promise<qix.GenericObjectLayout>): void;
/**
* Gets render state instance.
@@ -215,15 +215,15 @@ export namespace Conversion {
*/
export namespace EnigmaMocker {
/**
* Mocks Engima app functionality. It accepts one / many generic objects as input argument and returns the mocked Enigma app. Each generic object represents one visulization and specifies how it behaves. For example, what layout to use the data to present.
* Mocks Engima app functionality. It accepts one / many generic objects as input argument and returns the mocked Enigma app. Each generic object represents one visualisation and specifies how it behaves. For example, what layout to use the data to present.
*
* The generic object is represented with a Javascript object with a number of properties. The name of the property correlates to the name in the Enigma model for `app.getObject(id)`. For example, the property `getLayout` in the generic object is used to define `app.getObject(id).getLayout()`. Any property can be added to the fixture (just make sure it exists and behaves as in the Enigma model!).
*
* The value for each property is either fixed (string / boolean / number / object) or a function. Arguments are forwarded to the function to allow for greater flexibility. For example, this can be used to return different hypercube data when scrolling in the chart.
* @param genericObjects Generic objects controling behaviour of visualizations.
* @param genericObjects Generic objects controlling behaviour of visualizations.
* @param options Options
*/
function fromGenericObjects(genericObjects: object[], options?: stardust.EnigmaMockerOptions): Promise<EngineAPI.IApp>;
function fromGenericObjects(genericObjects: object[], options?: stardust.EnigmaMockerOptions): Promise<qix.Doc>;
}
@@ -277,7 +277,7 @@ declare namespace stardust {
* Creates a visualization model
* @param cfg The create configuration.
*/
create(cfg: stardust.CreateConfig): Promise<EngineAPI.IGenericObject>;
create(cfg: stardust.CreateConfig): Promise<qix.GenericObject>;
/**
* Generates properties for a visualization object
@@ -404,7 +404,7 @@ declare namespace stardust {
id: string;
model: EngineAPI.IGenericObject;
model: qix.GenericObject;
/**
* Destroys the visualization and removes it from the the DOM.
@@ -536,17 +536,7 @@ declare namespace stardust {
}
/**
* An object literal containing meta information about the plugin and a function containing the plugin implementation.
*/
interface Plugin {
info: {
name: string;
};
fn: ()=>void;
}
type Field = string | EngineAPI.INxDimension | EngineAPI.INxMeasure | stardust.LibraryField;
type Field = string | qix.NxDimension | qix.NxMeasure | stardust.LibraryField;
/**
* Rendering configuration for creating and rendering a new object
@@ -555,7 +545,7 @@ declare namespace stardust {
type: string;
version?: string;
fields?: stardust.Field[];
properties?: EngineAPI.IGenericObjectProperties;
properties?: qix.GenericObjectProperties;
}
/**
@@ -570,7 +560,7 @@ declare namespace stardust {
version?: string;
fields?: stardust.Field[];
extendProperties?: boolean;
properties?: EngineAPI.IGenericObjectProperties;
properties?: qix.GenericObjectProperties;
}
interface LibraryField {
@@ -578,6 +568,16 @@ declare namespace stardust {
type: "dimension" | "measure";
}
/**
* An object literal containing meta information about the plugin and a function containing the plugin implementation.
*/
interface Plugin {
info: {
name: string;
};
fn: ()=>void;
}
interface LoadType {
(type: {
name: string;
@@ -736,7 +736,7 @@ declare namespace stardust {
})=>stardust.ExportFormat;
interface QAEDefinition {
properties?: EngineAPI.IGenericObjectProperties;
properties?: qix.GenericObjectProperties;
data?: {
targets: stardust.DataTarget[];
};
@@ -746,13 +746,13 @@ declare namespace stardust {
interface DataTarget {
path: string;
dimensions?: stardust.FieldTarget<EngineAPI.INxDimension>;
measures?: stardust.FieldTarget<EngineAPI.INxMeasure>;
dimensions?: stardust.FieldTarget<qix.NxDimension>;
measures?: stardust.FieldTarget<qix.NxMeasure>;
}
type fieldTargetAddedCallback<T> = (field: T, properties: EngineAPI.IGenericObjectProperties)=>void;
type fieldTargetAddedCallback<T> = (field: T, properties: qix.GenericObjectProperties)=>void;
type fieldTargetRemovedCallback<T> = (field: T, properties: EngineAPI.IGenericObjectProperties, index: number)=>void;
type fieldTargetRemovedCallback<T> = (field: T, properties: qix.GenericObjectProperties, index: number)=>void;
interface FieldTarget<T> {
min?: (()=>void) | number;
@@ -878,10 +878,10 @@ declare namespace stardust {
}
interface ExportDataDef {
dimensions: EngineAPI.INxDimension[];
measures: EngineAPI.INxMeasure[];
excludedDimensions: EngineAPI.INxDimension[];
excludedMeasures: EngineAPI.INxMeasure[];
dimensions: qix.NxDimension[];
measures: qix.NxMeasure[];
excludedDimensions: qix.NxDimension[];
excludedMeasures: qix.NxMeasure[];
interColumnSortOrder: number[];
}

44
apis/supernova/spec/spec.conf.js
View File

@@ -1,44 +0,0 @@
module.exports = {
fromJsdoc: {
glob: [
'./src/**/*.js',
'!./src/**/*.spec.js',
'!../nucleus/src/components/listbox/default-properties.js',
'../nucleus/src/hooks/useObjectSelections.js',
'../locale/src/translator.js',
'../theme/src/**/*.js',
],
api: {
stability: 'experimental',
},
output: {
sort: {
alpha: false,
},
file: './spec/spec.json',
},
parse: {
types: {
'EngineAPI.IGenericObjectProperties': {},
'EngineAPI.IGenericObjectLayout': {},
'EngineAPI.INxAppLayout': {},
'EngineAPI.INxDimension': {},
'EngineAPI.INxMeasure': {},
'EngineAPI.IGenericObject': {},
'EngineAPI.IDoc': {},
'EngineAPI.IGlobal': {},
},
},
},
toMd: {
output: '../../docs/supernova-api.md',
type(e) {
if (e.indexOf('qae.') === 0) {
return {
url: `https://core.qlik.com/services/qix-engine/apis/qix/definitions/#${e.substr(4).toLowerCase()}`,
};
}
return undefined;
},
},
};

20
apis/supernova/src/hooks.js
View File

@@ -582,7 +582,7 @@ export function useRect() {
/**
* Gets the layout of the generic object associated with this visualization.
* @entry
* @returns {EngineAPI.IGenericObjectLayout}
* @returns {qix.GenericObjectLayout}
* @example
* import { useLayout } from '@nebula.js/stardust';
* // ...
@@ -602,7 +602,7 @@ export function useLayout() {
* The returned value from `useStaleLayout()` and `useLayout()` are identical when the object
* is not in a modal state.
* @entry
* @returns {EngineAPI.IGenericObjectLayout}
* @returns {qix.GenericObjectLayout}
* @example
* import { useStaleLayout } from '@nebula.js/stardust';
* // ...
@@ -621,7 +621,7 @@ export function useStaleLayout() {
/**
* Gets the layout of the app associated with this visualization.
* @entry
* @returns {EngineAPI.INxAppLayout} The app layout
* @returns {qix.NxAppLayout} The app layout
* @example
* import { useAppLayout } from '@nebula.js/stardust';
* // ...
@@ -635,7 +635,7 @@ export function useAppLayout() {
/**
* Gets the generic object API of the generic object connected to this visualization.
* @entry
* @returns {EngineAPI.IGenericObject|undefined}
* @returns {qix.GenericObject|undefined}
* @example
* import { useModel } from '@nebula.js/stardust';
* // ...
@@ -654,7 +654,7 @@ export function useModel() {
/**
* Gets the doc API.
* @entry
* @returns {EngineAPI.IApp|undefined} The doc API.
* @returns {qix.Doc|undefined} The doc API.
* @example
* import { useApp } from '@nebula.js/stardust';
* // ...
@@ -673,7 +673,7 @@ export function useApp() {
/**
* Gets the global API.
* @entry
* @returns {EngineAPI.IGlobal|undefined} The global API.
* @returns {qix.Global|undefined} The global API.
* @example
* import { useGlobal } from '@nebula.js/stardust';
*
@@ -723,7 +723,7 @@ export function useSelections() {
* import { useTheme } from '@nebula.js/stardust';
*
* const theme = useTheme();
* console.log(theme.getContrastinColorTo('#ff0000'));
* console.log(theme.getContrastingColorTo('#ff0000'));
*/
export function useTheme() {
return useInternalContext('theme');
@@ -923,7 +923,7 @@ export function useConstraints() {
* @interface Interactions
* @property {boolean=} passive=true Whether or not passive interactions are on. Allows passive interaction by users, ie: tooltips
* @property {boolean=} active=true Whether or not active interactions are on. Allows active interaction by users, ie: scroll, click
* @property {boolean=} select=true Whether or not select interactions are on. Alows selection actions. Implied when active is false.
* @property {boolean=} select=true Whether or not select interactions are on. Allows selection actions. Implied when active is false.
* @property {boolean=} edit=false Whether or not edit actions are on. Allows edit actions.
*/
/**
@@ -1052,7 +1052,7 @@ export function useImperativeHandle(fn, deps) {
/**
* Registers a callback that is called when a snapshot is taken.
* @entry
* @param {function(EngineAPI.IGenericObjectLayout): Promise<EngineAPI.IGenericObjectLayout>} snapshotCallback
* @param {function(qix.GenericObjectLayout): Promise<qix.GenericObjectLayout>} snapshotCallback
* @example
* import { onTakeSnapshot } from '@nebula.js/stardust';
* import { useState } from '@nebula.js/stardust';
@@ -1113,7 +1113,7 @@ export function onContextMenu(cb) {
*
* const renderState = useRenderState();
* useState(() => {
* if(needProperteisUpdate(...)) {
* if(needPropertiesUpdate(...)) {
* useRenderState.pending();
* updateProperties(...);
* } else {

10
apis/supernova/src/qae.js
View File

@@ -25,7 +25,7 @@ const noop = () => {};
/**
* @interface QAEDefinition
* @property {EngineAPI.IGenericObjectProperties=} properties
* @property {qix.GenericObjectProperties=} properties
* @property {object=} data
* @property {DataTarget[]} data.targets
* @property {importProperties=} importProperties
@@ -35,22 +35,22 @@ const noop = () => {};
/**
* @interface DataTarget
* @property {string} path
* @property {FieldTarget<EngineAPI.INxDimension>=} dimensions
* @property {FieldTarget<EngineAPI.INxMeasure>=} measures
* @property {FieldTarget<qix.NxDimension>=} dimensions
* @property {FieldTarget<qix.NxMeasure>=} measures
*/
/**
* @callback fieldTargetAddedCallback
* @template T
* @param {T} field
* @param {EngineAPI.IGenericObjectProperties} properties
* @param {qix.GenericObjectProperties} properties
*/
/**
* @callback fieldTargetRemovedCallback
* @template T
* @param {T} field
* @param {EngineAPI.IGenericObjectProperties} properties
* @param {qix.GenericObjectProperties} properties
* @param {number} index
*/

4
rollup.config.js
View File

@@ -73,7 +73,7 @@ const GLOBALS = {
const watch = process.argv.indexOf('-w') > 2;
const TYPES_SCOPE_RX = /^@types\//;
const TYPES_SCOPE_RX = /^@qlik\/api/;
const config = ({ format = 'umd', debug = false, file, targetPkg }) => {
const umdName = targetName
@@ -82,6 +82,8 @@ const config = ({ format = 'umd', debug = false, file, targetPkg }) => {
.join('');
if (Object.keys(targetPkg.dependencies || {}).filter((dep) => !TYPES_SCOPE_RX.test(dep)).length) {
console.log(targetPkg.name);
console.log(JSON.stringify(Object.keys(targetPkg.dependencies || {}).filter((dep) => !TYPES_SCOPE_RX.test(dep))));
throw new Error('Dependencies for a web javascript library makes no sense');
}

54
yarn.lock
View File

@@ -3779,6 +3779,32 @@
unbzip2-stream "1.4.3"
yargs "17.7.1"
"@qlik/api@^0.3.0":
version "0.3.0"
resolved "https://registry.yarnpkg.com/@qlik/api/-/api-0.3.0.tgz#18e6d3863523af172429403500e64219acf323d9"
integrity sha512-plsVMrTVBmZY88TK/4UmZbj/icmEO/ySFHHVzXZ9tdtDu4NvN6rWTT8eNH2P7YQwmwn+nZdxgYnFfrsKkGF5ag==
dependencies:
"@qlik/embed-runtime" "^0.7.0"
"@qlik/runtime-module-loader" "^0.2.6"
ajv "^8.12.0"
bufferutil "^4.0.8"
enigma.js "^2.14.0"
lodash "^4.17.21"
nanoid "^5.0.6"
ws "^8.16.0"
"@qlik/embed-runtime@0.7.0", "@qlik/embed-runtime@^0.7.0":
version "0.7.0"
resolved "https://registry.yarnpkg.com/@qlik/embed-runtime/-/embed-runtime-0.7.0.tgz#016582a119e84aeab6dd24c4457a93fad61361bf"
integrity sha512-D0nlB7rQRGSjbLdO53yy5K/VgYhSQDNSs4iywJlbaIjkpTBXzPZBL75WX9Ezkh+ZYfXz0TZo8SuagreTbzz+4g==
"@qlik/runtime-module-loader@^0.2.6":
version "0.2.6"
resolved "https://registry.yarnpkg.com/@qlik/runtime-module-loader/-/runtime-module-loader-0.2.6.tgz#1f3a57f43f5f2978ef93bef86c64b1372ec60edc"
integrity sha512-XU1Jw1D2H36JOs5qOROJ+U2ThrkgEL8chFVwfeqXTrT+tKcM95MMm5W2qGHR0hsyEvD1fh2sQMI1mk9Sf+ol9w==
dependencies:
"@qlik/embed-runtime" "0.7.0"
"@qlik/sdk@^0.25.0":
version "0.25.0"
resolved "https://registry.yarnpkg.com/@qlik/sdk/-/sdk-0.25.0.tgz#839dbb9547e8197b215021a2193c5ae1ba6b647b"
@@ -4444,11 +4470,6 @@
resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.11.tgz#2596fb352ee96a1379c657734d4b913a613ad563"
integrity sha512-ga8y9v9uyeiLdpKddhxYQkxNDrfvuPrlFb0N1qnZZByvcElJaXthF1UhvCh9TLWJBEHeNtdnbysW7Y6Uq8CVng==
"@types/qlik-engineapi@12.67.16":
version "12.67.16"
resolved "https://registry.yarnpkg.com/@types/qlik-engineapi/-/qlik-engineapi-12.67.16.tgz#3c4d3c6282275cfd7ce2efb393098bb6d0a82caf"
integrity sha512-NiwMX6zrV162lRcupTdrgoT2YtKZy97zJ70rRGLdJTWcaMOWUgAhM1ufzhmp3ir1KlNArI4Ds8ojfxA80SpwKQ==
"@types/qs@*":
version "6.9.7"
resolved "https://registry.yarnpkg.com/@types/qs/-/qs-6.9.7.tgz#63bb7d067db107cc1e457c303bc25d511febf6cb"
@@ -4915,7 +4936,7 @@ ajv-keywords@^5.0.0:
dependencies:
fast-deep-equal "^3.1.3"
ajv@8.12.0:
ajv@8.12.0, ajv@^8.12.0:
version "8.12.0"
resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.12.0.tgz#d1a0527323e22f53562c567c00991577dfbe19d1"
integrity sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==
@@ -5751,6 +5772,13 @@ buffer@^5.2.0, buffer@^5.2.1, buffer@^5.5.0:
base64-js "^1.3.1"
ieee754 "^1.1.13"
bufferutil@^4.0.8:
version "4.0.8"
resolved "https://registry.yarnpkg.com/bufferutil/-/bufferutil-4.0.8.tgz#1de6a71092d65d7766c4d8a522b261a6e787e8ea"
integrity sha512-4T53u4PdgsXqKaIctwF8ifXlRTTmEPJ8iEPWFdGZvcf7sbwYo6FKFEX9eNNAnzFZ7EzJAQ3CJeOtCRA4rDp7Pw==
dependencies:
node-gyp-build "^4.3.0"
builtin-modules@^3.3.0:
version "3.3.0"
resolved "https://registry.yarnpkg.com/builtin-modules/-/builtin-modules-3.3.0.tgz#cae62812b89801e9656336e46223e030386be7b6"
@@ -7473,7 +7501,7 @@ enigma.js@2.11.0:
resolved "https://registry.yarnpkg.com/enigma.js/-/enigma.js-2.11.0.tgz#e9313c96fb29b43ce519c74538594cf783d8b8c8"
integrity sha512-JkyfvaGR/DhMGuui1+jaj5lPoSeY1gv6GDycPPLr9BMxah3E8+PsmcxHasWBoBbwxhxIue8QIT7sDzain1G1lA==
enigma.js@2.14.0:
enigma.js@2.14.0, enigma.js@^2.14.0:
version "2.14.0"
resolved "https://registry.yarnpkg.com/enigma.js/-/enigma.js-2.14.0.tgz#1c428ed4a19485a045637779774237c23b9b35ea"
integrity sha512-M84VjtO2w9+AUDK5NEn5j7FOPBdiSkwRbbgVFWxkLXxutH/z8ATGFh0Ko/4pTNwWF/9On/lEEr4BOI+ZewSw9g==
@@ -12481,6 +12509,11 @@ nanoid@^3.3.7:
resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.7.tgz#d0c301a691bc8d54efa0a2226ccf3fe2fd656bd8"
integrity sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==
nanoid@^5.0.6:
version "5.0.6"
resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-5.0.6.tgz#7f99a033aa843e4dcf9778bdaec5eb02f4dc44d5"
integrity sha512-rRq0eMHoGZxlvaFOUdK1Ev83Bd1IgzzR+WJ3IbDJ7QOSdAxYjlurSPqFs9s4lJg29RT6nPwizFtJhQS6V5xgiA==
natural-compare@^1.4.0:
version "1.4.0"
resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7"
@@ -12545,6 +12578,11 @@ node-forge@^1:
resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.1.tgz#be8da2af243b2417d5f646a770663a92b7e9ded3"
integrity sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA==
node-gyp-build@^4.3.0:
version "4.8.0"
resolved "https://registry.yarnpkg.com/node-gyp-build/-/node-gyp-build-4.8.0.tgz#3fee9c1731df4581a3f9ead74664369ff00d26dd"
integrity sha512-u6fs2AEUljNho3EYTJNBfImO5QTo/J/1Etd+NVdCj7qWKUSN/bSLkZwhDv7I+w/MSC6qJ4cknepkAYykDdK8og==
node-gyp@^10.0.0:
version "10.0.1"
resolved "https://registry.yarnpkg.com/node-gyp/-/node-gyp-10.0.1.tgz#205514fc19e5830fa991e4a689f9e81af377a966"
@@ -17216,7 +17254,7 @@ ws@8.13.0, ws@^8.13.0:
resolved "https://registry.yarnpkg.com/ws/-/ws-8.13.0.tgz#9a9fb92f93cf41512a0735c8f4dd09b8a1211cd0"
integrity sha512-x9vcZYTrFPC7aSIbj7sRCYo7L/Xb8Iy+pW0ng0wt2vCJv7M9HOMy0UoN3rr+IFC7hb7vXoqS+P9ktyLLLhO+LA==
ws@8.16.0:
ws@8.16.0, ws@^8.16.0:
version "8.16.0"
resolved "https://registry.yarnpkg.com/ws/-/ws-8.16.0.tgz#d1cd774f36fbc07165066a60e40323eab6446fd4"
integrity sha512-HS0c//TP7Ina87TfiPUz1rQzMhHrl/SG2guqRcTOIUYD2q8uhUdNHZYJUaQ8aTGPzCh+c6oawMKW35nFl1dxyQ==