///
/// Copyright © 2016-2026 The Thingsboard Authors
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
import { TbEditorCompleter, TbEditorCompletions } from '@shared/models/ace/completion.models';
import {
widgetContextCompletions,
widgetContextCompletionsWithSettings
} from '@shared/models/ace/widget-completion.models';
import { serviceCompletions } from '@shared/models/ace/service-completion.models';
const widgetEditorCompletions = (settingsCompletions?: TbEditorCompletions): TbEditorCompletions => {
return {
... {self: {
description: 'Built-in variable self that is a reference to the widget instance',
type: 'WidgetTypeInstance',
meta: 'object',
children: {
...{
onInit: {
description: 'The first function which is called when widget is ready for initialization.
Should be used to prepare widget DOM, process widget settings and initial subscription information.',
meta: 'function'
},
onDataUpdated: {
description: 'Called when the new data is available from the widget subscription.
Latest data can be accessed from ' +
'the defaultSubscription property of widget context (ctx).',
meta: 'function'
},
onResize: {
description: 'Called when widget container is resized. Latest width and height can be obtained from widget context (ctx).',
meta: 'function'
},
onEditModeChanged: {
description: 'Called when dashboard editing mode is changed. Latest mode is handled by isEdit property of widget context (ctx).',
meta: 'function'
},
onMobileModeChanged: {
description: 'Called when dashboard view width crosses mobile breakpoint. Latest state is handled by isMobile property of widget context (ctx).',
meta: 'function'
},
onDestroy: {
description: 'Called when widget element is destroyed. Should be used to cleanup all resources if necessary.',
meta: 'function'
},
getSettingsForm: {
description: 'Optional function returning widget settings form array as alternative to Settings form tab of settings section.',
meta: 'function',
return: {
description: 'An array of widget settings form properties',
type: 'Array<FormProperty>'
}
},
getDataKeySettingsForm: {
description: 'Optional function returning particular data key settings form array as alternative to Data key settings form tab of settings section.',
meta: 'function',
return: {
description: 'An array of data key settings form properties',
type: 'Array<FormProperty>'
}
},
getSettingsSchema: {
description: 'Deprecated. Use getSettingsForm() function.',
meta: 'function',
return: {
description: 'An widget settings schema json',
type: 'object'
}
},
getDataKeySettingsSchema: {
description: 'Deprecated. Use getDataKeySettingsForm() function.',
meta: 'function',
return: {
description: 'A particular data key settings schema json',
type: 'object'
}
},
typeParameters: {
description: 'Returns object describing widget datasource parameters.',
meta: 'function',
return: {
description: 'An object describing widget datasource parameters.',
type: 'WidgetTypeParameters'
}
},
actionSources: {
description: 'Returns map describing available widget action sources used to define user actions.',
meta: 'function',
return: {
description: 'A map of action sources by action source id.',
type: '{[actionSourceId: string]: WidgetActionSource}'
}
}
},
...widgetContextCompletionsWithSettings(settingsCompletions)
}
}}
}
};
export const widgetEditorCompleter = (settingsCompletions?: TbEditorCompletions): TbEditorCompleter => {
return new TbEditorCompleter(widgetEditorCompletions(settingsCompletions));
}