@kosdev-code/kos-ui-sdk 2.0.45 → 2.0.46
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/common/events/eventBus.d.ts +0 -30
- package/common/events/eventBus.d.ts.map +1 -1
- package/common/events/eventBus.functional.d.ts +0 -48
- package/common/events/eventBus.functional.d.ts.map +1 -1
- package/common/events/eventBus.state.d.ts +0 -33
- package/common/events/eventBus.state.d.ts.map +1 -1
- package/core/core/decorators/index.d.ts +0 -11
- package/core/core/decorators/index.d.ts.map +1 -1
- package/core/core/decorators/kos-child.d.ts +0 -2
- package/core/core/decorators/kos-child.d.ts.map +1 -1
- package/core/core/decorators/kos-companion.d.ts +8 -158
- package/core/core/decorators/kos-companion.d.ts.map +1 -1
- package/core/core/decorators/kos-context.d.ts +0 -6
- package/core/core/decorators/kos-context.d.ts.map +1 -1
- package/core/core/decorators/kos-http-decorators.d.ts +0 -15
- package/core/core/decorators/kos-http-decorators.d.ts.map +1 -1
- package/core/core/decorators/kos-log.d.ts +0 -4
- package/core/core/decorators/kos-log.d.ts.map +1 -1
- package/core/core/decorators/kos-model-effect.d.ts +0 -9
- package/core/core/decorators/kos-model-effect.d.ts.map +1 -1
- package/core/core/decorators/kos-parent.d.ts +0 -4
- package/core/core/decorators/kos-parent.d.ts.map +1 -1
- package/core/core/decorators/kos-reference.d.ts +0 -9
- package/core/core/decorators/kos-reference.d.ts.map +1 -1
- package/core/core/decorators/kos-topic-handler-flow-control.d.ts +1 -17
- package/core/core/decorators/kos-topic-handler-flow-control.d.ts.map +1 -1
- package/core/core/decorators/kosDependency.d.ts +1 -4
- package/core/core/decorators/kosDependency.d.ts.map +1 -1
- package/core/core/decorators/kosModel.d.ts +2 -17
- package/core/core/decorators/kosModel.d.ts.map +1 -1
- package/core/core/decorators/kosSubscribe.d.ts +0 -9
- package/core/core/decorators/kosSubscribe.d.ts.map +1 -1
- package/core/core/decorators/kosTopicHandler.d.ts +5 -87
- package/core/core/decorators/kosTopicHandler.d.ts.map +1 -1
- package/core/core/decorators/propKeys.d.ts +0 -14
- package/core/core/decorators/propKeys.d.ts.map +1 -1
- package/core/core/decorators/resolve-parameters.d.ts.map +1 -1
- package/core/core/extension/extension-manager.d.ts +4 -64
- package/core/core/extension/extension-manager.d.ts.map +1 -1
- package/core/core/extension/initialize-extension.d.ts +0 -24
- package/core/core/extension/initialize-extension.d.ts.map +1 -1
- package/core/core/extension/plugin-extension-manager.d.ts +0 -11
- package/core/core/extension/plugin-extension-manager.d.ts.map +1 -1
- package/core/core/kos-container-model.d.ts +0 -188
- package/core/core/kos-container-model.d.ts.map +1 -1
- package/core/core/kos-data-container.d.ts +1 -93
- package/core/core/kos-data-container.d.ts.map +1 -1
- package/core/core/kos-registration.d.ts.map +1 -1
- package/core/core/kos-singleton-registration.d.ts.map +1 -1
- package/core/core/kosCore.d.ts.map +1 -1
- package/core/core/kosModel.d.ts +2 -55
- package/core/core/kosModel.d.ts.map +1 -1
- package/core/core/kosModelManager.d.ts +1 -11
- package/core/core/kosModelManager.d.ts.map +1 -1
- package/core/core/log/log.d.ts.map +1 -1
- package/core/core/model/apply-kos-dev-tool-support.d.ts.map +1 -1
- package/core/core/model/kos-fsm-manager.d.ts +4 -1
- package/core/core/model/kos-fsm-manager.d.ts.map +1 -1
- package/core/core/model/kos-model-component-factory.d.ts +0 -4
- package/core/core/model/kos-model-component-factory.d.ts.map +1 -1
- package/core/core/model/kos-offline-queue.d.ts +1 -78
- package/core/core/model/kos-offline-queue.d.ts.map +1 -1
- package/core/core/model/kos-online-lifecycle-manager.d.ts.map +1 -1
- package/core/core/model/kos-subscription-manager.d.ts +0 -20
- package/core/core/model/kos-subscription-manager.d.ts.map +1 -1
- package/core/core/model/model-introspection-utils.d.ts +0 -1
- package/core/core/model/model-introspection-utils.d.ts.map +1 -1
- package/core/core/model-instantiator.d.ts +0 -19
- package/core/core/model-instantiator.d.ts.map +1 -1
- package/core/core/registration/index.d.ts +0 -1
- package/core/core/registration/index.d.ts.map +1 -1
- package/core/core/services/browser-router.d.ts.map +1 -1
- package/core/core/transport/webSocketTransport.d.ts +1 -2
- package/core/core/transport/webSocketTransport.d.ts.map +1 -1
- package/core/core/types/registration.d.ts +0 -7
- package/core/core/types/registration.d.ts.map +1 -1
- package/core/index.d.ts +1 -2
- package/core/index.d.ts.map +1 -1
- package/core/types/index.d.ts +0 -1
- package/core/types/index.d.ts.map +1 -1
- package/core/types/kos-dependency.d.ts +1 -48
- package/core/types/kos-dependency.d.ts.map +1 -1
- package/core/types/utils/kos-fetch.d.ts +0 -121
- package/core/types/utils/kos-fetch.d.ts.map +1 -1
- package/core/util/api-request-id.d.ts +0 -4
- package/core/util/api-request-id.d.ts.map +1 -1
- package/core/util/apply-mixins.d.ts +0 -4
- package/core/util/apply-mixins.d.ts.map +1 -1
- package/core/util/array-utils.d.ts +0 -4
- package/core/util/array-utils.d.ts.map +1 -1
- package/core/util/container-utils.d.ts +11 -264
- package/core/util/container-utils.d.ts.map +1 -1
- package/core/util/date-utils.d.ts +0 -29
- package/core/util/date-utils.d.ts.map +1 -1
- package/core/util/debounce.d.ts +0 -3
- package/core/util/debounce.d.ts.map +1 -1
- package/core/util/feature-flags.d.ts +0 -19
- package/core/util/feature-flags.d.ts.map +1 -1
- package/core/util/get-query-params.d.ts +0 -4
- package/core/util/get-query-params.d.ts.map +1 -1
- package/core/util/hsl-to-hex.d.ts +0 -16
- package/core/util/hsl-to-hex.d.ts.map +1 -1
- package/core/util/index.d.ts +0 -3
- package/core/util/index.d.ts.map +1 -1
- package/core/util/kos-config-init.d.ts +0 -37
- package/core/util/kos-config-init.d.ts.map +1 -1
- package/core/util/kos-data-mapper-utils.d.ts +0 -9
- package/core/util/kos-data-mapper-utils.d.ts.map +1 -1
- package/core/util/kos-fetch.d.ts +0 -12
- package/core/util/kos-fetch.d.ts.map +1 -1
- package/core/util/kos-message-utils.d.ts +0 -88
- package/core/util/kos-message-utils.d.ts.map +1 -1
- package/core/util/kos-model-utils.d.ts +0 -46
- package/core/util/kos-model-utils.d.ts.map +1 -1
- package/core/util/kos-model-visitor.d.ts +0 -2
- package/core/util/kos-model-visitor.d.ts.map +1 -1
- package/core/util/kos-service-request.d.ts +3 -43
- package/core/util/kos-service-request.d.ts.map +1 -1
- package/core/util/log-utils.d.ts +0 -12
- package/core/util/log-utils.d.ts.map +1 -1
- package/core/util/middleware.d.ts +0 -15
- package/core/util/middleware.d.ts.map +1 -1
- package/core/util/model-attribute-utils.d.ts +0 -7
- package/core/util/model-attribute-utils.d.ts.map +1 -1
- package/core/util/model-factory.d.ts +0 -4
- package/core/util/model-factory.d.ts.map +1 -1
- package/core/util/model-registration-utils.d.ts +0 -8
- package/core/util/model-registration-utils.d.ts.map +1 -1
- package/core/util/model-utils.d.ts +29 -40
- package/core/util/model-utils.d.ts.map +1 -1
- package/core/util/observable-proxy-map.d.ts +0 -11
- package/core/util/observable-proxy-map.d.ts.map +1 -1
- package/core/util/paired-client-heartbeat.d.ts +0 -2
- package/core/util/paired-client-heartbeat.d.ts.map +1 -1
- package/core/util/pipe.d.ts +0 -4
- package/core/util/pipe.d.ts.map +1 -1
- package/core/util/retry-with-exponential-backoff.d.ts +0 -3
- package/core/util/retry-with-exponential-backoff.d.ts.map +1 -1
- package/core/util/service-factory.d.ts +0 -10
- package/core/util/service-factory.d.ts.map +1 -1
- package/core/util/session-utils.d.ts +0 -8
- package/core/util/session-utils.d.ts.map +1 -1
- package/core/util/wait-for-request.d.ts +0 -16
- package/core/util/wait-for-request.d.ts.map +1 -1
- package/core/util/when-ready.d.ts +0 -3
- package/core/util/when-ready.d.ts.map +1 -1
- package/index.cjs +123 -26909
- package/index.cjs.map +1 -1
- package/index.d.cts +3 -6
- package/index.d.ts +3 -6
- package/index.d.ts.map +1 -1
- package/index.js +13460 -25275
- package/index.js.map +1 -1
- package/models/constants/index.d.ts +1 -3
- package/models/constants/index.d.ts.map +1 -1
- package/models/decorators/future-service.d.ts +2 -27
- package/models/decorators/future-service.d.ts.map +1 -1
- package/models/models/browser-router/browser-router-model.d.ts +1 -80
- package/models/models/browser-router/browser-router-model.d.ts.map +1 -1
- package/models/models/browser-router/types/index.d.ts +1 -26
- package/models/models/canvas-dispatcher/types/index.d.ts +0 -5
- package/models/models/canvas-renderer/types/index.d.ts +0 -5
- package/models/models/config-bean/config-bean-model-builder.d.ts +2 -4
- package/models/models/config-bean/config-bean-model-builder.d.ts.map +1 -1
- package/models/models/config-bean/config-bean-model.d.ts +13 -117
- package/models/models/config-bean/config-bean-model.d.ts.map +1 -1
- package/models/models/config-bean/config-bean-types.d.ts +3 -6
- package/models/models/config-bean/config-bean-types.d.ts.map +1 -1
- package/models/models/config-bean-prop/config-bean-prop-model.d.ts +1 -112
- package/models/models/config-bean-prop/config-bean-prop-model.d.ts.map +1 -1
- package/models/models/config-bean-prop/types/index.d.ts +19 -301
- package/models/models/device/device-model.d.ts +9 -219
- package/models/models/device/device-model.d.ts.map +1 -1
- package/models/models/device/device-registration.d.ts +48 -61
- package/models/models/device/device-registration.d.ts.map +1 -1
- package/models/models/device/types/index.d.ts +0 -42
- package/models/models/future/future-aware.d.ts +0 -82
- package/models/models/future/future-aware.d.ts.map +1 -1
- package/models/models/future/future-model.d.ts +5 -34
- package/models/models/future/future-model.d.ts.map +1 -1
- package/models/models/future/future-types.d.ts +9 -202
- package/models/models/future/future-types.d.ts.map +1 -1
- package/models/models/future-container/future-container-model.d.ts +2 -2
- package/models/models/index.d.ts +0 -1
- package/models/models/index.d.ts.map +1 -1
- package/models/models/key-value/index.d.ts +0 -4
- package/models/models/key-value/index.d.ts.map +1 -1
- package/models/models/key-value/key-value-model.d.ts +0 -111
- package/models/models/key-value/key-value-model.d.ts.map +1 -1
- package/models/models/key-value/services/key-value-services.d.ts +2 -124
- package/models/models/key-value/services/key-value-services.d.ts.map +1 -1
- package/models/models/key-value/types/index.d.ts +0 -57
- package/models/models/kos-log-manager/kos-log-manager-model.d.ts +14 -61
- package/models/models/kos-log-manager/kos-log-manager-model.d.ts.map +1 -1
- package/models/models/kos-log-manager/types/index.d.ts +0 -191
- package/models/models/kos-time/kos-time-model.d.ts +0 -64
- package/models/models/kos-time/kos-time-model.d.ts.map +1 -1
- package/models/models/kos-time/types/index.d.ts +0 -83
- package/models/models/log-block/log-block-container-model.d.ts +0 -132
- package/models/models/log-block/log-block-container-model.d.ts.map +1 -1
- package/models/models/log-block/log-block-model.d.ts +0 -185
- package/models/models/log-block/log-block-model.d.ts.map +1 -1
- package/models/models/log-block/types/index.d.ts +0 -133
- package/models/models/log-stream/index.d.ts +2 -6
- package/models/models/log-stream/index.d.ts.map +1 -1
- package/models/models/log-stream/log-stream-container-model.d.ts +0 -62
- package/models/models/log-stream/log-stream-container-model.d.ts.map +1 -1
- package/models/models/log-stream/log-stream-model.d.ts +0 -55
- package/models/models/log-stream/log-stream-model.d.ts.map +1 -1
- package/models/models/log-stream/services/log-stream-services.d.ts +1 -2
- package/models/models/log-stream/services/log-stream-services.d.ts.map +1 -1
- package/models/models/log-stream/types/index.d.ts +0 -79
- package/models/models/network-interface/index.d.ts +2 -6
- package/models/models/network-interface/index.d.ts.map +1 -1
- package/models/models/network-interface/network-interface-container-model.d.ts +0 -62
- package/models/models/network-interface/network-interface-container-model.d.ts.map +1 -1
- package/models/models/network-interface/network-interface-container-registration.d.ts +1 -2
- package/models/models/network-interface/network-interface-container-registration.d.ts.map +1 -1
- package/models/models/network-interface/network-interface-model.d.ts +0 -77
- package/models/models/network-interface/network-interface-model.d.ts.map +1 -1
- package/models/models/network-interface/network-interface-registration.d.ts +1 -2
- package/models/models/network-interface/network-interface-registration.d.ts.map +1 -1
- package/models/models/network-interface/services/network-interface-services.d.ts +0 -54
- package/models/models/network-interface/services/network-interface-services.d.ts.map +1 -1
- package/models/models/network-interface/types/index.d.ts +0 -22
- package/models/models/ota/ota-model.d.ts +0 -79
- package/models/models/ota/ota-model.d.ts.map +1 -1
- package/models/models/ota/types/index.d.ts +0 -177
- package/models/models/region-info/region-info-model.d.ts +3 -8
- package/models/models/region-info/region-info-model.d.ts.map +1 -1
- package/models/models/region-info/services/region-info-services.d.ts +2 -2
- package/models/models/region-info/services/region-info-services.d.ts.map +1 -1
- package/models/models/region-info/types/index.d.ts +13 -191
- package/models/models/region-info/types/index.d.ts.map +1 -1
- package/models/models/region-info/utils/unit-system-utils.d.ts.map +1 -1
- package/models/models/software-info/services/software-info-services.d.ts.map +1 -1
- package/models/models/software-info/software-info-model.d.ts +2 -74
- package/models/models/software-info/software-info-model.d.ts.map +1 -1
- package/models/models/software-info/types/index.d.ts +17 -52
- package/models/models/state-bean/state-bean-model.d.ts +9 -86
- package/models/models/state-bean/state-bean-model.d.ts.map +1 -1
- package/models/models/state-bean/types/index.d.ts +6 -117
- package/models/models/state-prop/state-prop-model.d.ts +1 -78
- package/models/models/state-prop/state-prop-model.d.ts.map +1 -1
- package/models/models/state-prop/types/index.d.ts +7 -57
- package/models/models/storage-device/services/storage-device-services.d.ts +0 -1
- package/models/models/storage-device/services/storage-device-services.d.ts.map +1 -1
- package/models/models/storage-device/storage-device-container-model.d.ts +2 -289
- package/models/models/storage-device/storage-device-container-model.d.ts.map +1 -1
- package/models/models/storage-device/storage-device-model.d.ts +2 -84
- package/models/models/storage-device/storage-device-model.d.ts.map +1 -1
- package/models/models/storage-device/types/index.d.ts +0 -114
- package/models/models/studio-properties/studio-properties-model.d.ts +0 -75
- package/models/models/studio-properties/studio-properties-model.d.ts.map +1 -1
- package/models/models/studio-properties/types/index.d.ts +0 -29
- package/models/models/translation/services/translation-services.d.ts +2 -128
- package/models/models/translation/services/translation-services.d.ts.map +1 -1
- package/models/models/translation/translation-container-model.d.ts +10 -100
- package/models/models/translation/translation-container-model.d.ts.map +1 -1
- package/models/models/translation/translation-container-registration.d.ts +1 -2
- package/models/models/translation/translation-container-registration.d.ts.map +1 -1
- package/models/models/translation/translation-context.d.ts +16 -1
- package/models/models/translation/translation-context.d.ts.map +1 -1
- package/models/models/translation/translation-model.d.ts +1 -113
- package/models/models/translation/translation-model.d.ts.map +1 -1
- package/models/models/translation/types/index.d.ts +0 -343
- package/models/models/trouble/index.d.ts +1 -2
- package/models/models/trouble/index.d.ts.map +1 -1
- package/models/models/trouble/services/trouble-services.d.ts +4 -6
- package/models/models/trouble/services/trouble-services.d.ts.map +1 -1
- package/models/models/trouble/trouble-model.d.ts +1 -4
- package/models/models/trouble/trouble-model.d.ts.map +1 -1
- package/models/models/trouble/types/index.d.ts +93 -34
- package/models/models/trouble/utils/is-trouble-aware.d.ts +2 -2
- package/models/models/trouble/utils/is-trouble-aware.d.ts.map +1 -1
- package/models/models/trouble-container/index.d.ts +3 -4
- package/models/models/trouble-container/index.d.ts.map +1 -1
- package/models/models/trouble-container/trouble-container-model.d.ts +6 -10
- package/models/models/trouble-container/trouble-container-model.d.ts.map +1 -1
- package/models/models/trouble-container/trouble-container-registration.d.ts +5 -0
- package/models/models/trouble-container/trouble-container-registration.d.ts.map +1 -0
- package/models/models/trouble-container/types/index.d.ts +15 -6
- package/models/models/usb-update/types/index.d.ts +0 -10
- package/models/services/config-bean/index.d.ts +2 -2
- package/models/services/config-bean/index.d.ts.map +1 -1
- package/models/utils/client.d.ts +12 -16
- package/models/utils/client.d.ts.map +1 -1
- package/models/utils/core-registration-manager.d.ts +1 -1
- package/models/utils/core-registration-manager.d.ts.map +1 -1
- package/models/utils/extension-manager.d.ts +13 -54
- package/models/utils/extension-manager.d.ts.map +1 -1
- package/models/utils/index.d.ts +2 -3
- package/models/utils/index.d.ts.map +1 -1
- package/models/utils/kosmodel-compatible-future-mixin.d.ts +142 -0
- package/models/utils/kosmodel-compatible-future-mixin.d.ts.map +1 -0
- package/models/utils/kosmodel-interface-companion-mixin.d.ts +83 -0
- package/models/utils/kosmodel-interface-companion-mixin.d.ts.map +1 -0
- package/models/utils/service.d.ts +13 -91
- package/models/utils/service.d.ts.map +1 -1
- package/package.json +2 -16
- package/ui/contexts/kos-core-context.d.ts.map +1 -1
- package/ui/contexts/state-bean/state-bean-provider.d.ts.map +1 -1
- package/ui/hooks/device/use-device.d.ts +0 -6
- package/ui/hooks/device/use-device.d.ts.map +1 -1
- package/ui/hooks/index.d.ts +0 -1
- package/ui/hooks/index.d.ts.map +1 -1
- package/ui/hooks/kos-time/use-kos-time.d.ts +0 -6
- package/ui/hooks/kos-time/use-kos-time.d.ts.map +1 -1
- package/ui/hooks/network-interface-container/use-network-interface-container.d.ts +0 -6
- package/ui/hooks/network-interface-container/use-network-interface-container.d.ts.map +1 -1
- package/ui/hooks/ota/use-ota.d.ts +0 -6
- package/ui/hooks/ota/use-ota.d.ts.map +1 -1
- package/ui/hooks/software-info/use-software-info.d.ts +0 -6
- package/ui/hooks/software-info/use-software-info.d.ts.map +1 -1
- package/ui/hooks/state-bean/use-state-bean.d.ts +2 -2
- package/ui/hooks/state-bean/use-state-bean.d.ts.map +1 -1
- package/ui/hooks/state-bean/with-state-bean.d.ts.map +1 -1
- package/ui/hooks/storage-device-container/use-storage-device-container.d.ts +0 -6
- package/ui/hooks/storage-device-container/use-storage-device-container.d.ts.map +1 -1
- package/ui/hooks/translation-container/trans.d.ts +0 -6
- package/ui/hooks/translation-container/trans.d.ts.map +1 -1
- package/ui/hooks/translation-container/use-translation-container.d.ts +33 -10
- package/ui/hooks/translation-container/use-translation-container.d.ts.map +1 -1
- package/ui/hooks/translation-container/use-translation.d.ts +0 -7
- package/ui/hooks/translation-container/use-translation.d.ts.map +1 -1
- package/ui/hooks/translation-container/with-translation-container.d.ts +0 -6
- package/ui/hooks/translation-container/with-translation-container.d.ts.map +1 -1
- package/ui/hooks/usb-update-container/use-usb-update-container.d.ts +0 -6
- package/ui/hooks/usb-update-container/use-usb-update-container.d.ts.map +1 -1
- package/ui/hooks/use-config-bean.d.ts +0 -6
- package/ui/hooks/use-config-bean.d.ts.map +1 -1
- package/ui/hooks/use-config-property.d.ts +0 -6
- package/ui/hooks/use-config-property.d.ts.map +1 -1
- package/ui/hooks/use-kos-model.d.ts +0 -7
- package/ui/hooks/use-kos-model.d.ts.map +1 -1
- package/ui/hooks/use-kos-regions.d.ts.map +1 -1
- package/core/constants/model-constants.d.ts +0 -9
- package/core/constants/model-constants.d.ts.map +0 -1
- package/core/core/companion-instantiator.d.ts +0 -71
- package/core/core/companion-instantiator.d.ts.map +0 -1
- package/core/core/decorators/fsm-injection-utils.d.ts +0 -16
- package/core/core/decorators/fsm-injection-utils.d.ts.map +0 -1
- package/core/core/decorators/kos-container-aware.d.ts +0 -619
- package/core/core/decorators/kos-container-aware.d.ts.map +0 -1
- package/core/core/decorators/kos-execution-context.d.ts +0 -63
- package/core/core/decorators/kos-execution-context.d.ts.map +0 -1
- package/core/core/decorators/kos-future-aware.d.ts +0 -162
- package/core/core/decorators/kos-future-aware.d.ts.map +0 -1
- package/core/core/decorators/kos-logger-aware.d.ts +0 -105
- package/core/core/decorators/kos-logger-aware.d.ts.map +0 -1
- package/core/core/decorators/kos-multiple-future-aware.d.ts +0 -217
- package/core/core/decorators/kos-multiple-future-aware.d.ts.map +0 -1
- package/core/core/decorators/kos-service-request-helpers.d.ts +0 -60
- package/core/core/decorators/kos-service-request-helpers.d.ts.map +0 -1
- package/core/core/decorators/kos-service-request.d.ts +0 -498
- package/core/core/decorators/kos-service-request.d.ts.map +0 -1
- package/core/core/decorators/kos-state-machine.d.ts +0 -534
- package/core/core/decorators/kos-state-machine.d.ts.map +0 -1
- package/core/core/decorators/kos-trouble-aware.d.ts +0 -77
- package/core/core/decorators/kos-trouble-aware.d.ts.map +0 -1
- package/core/core/decorators/kos-view-model.d.ts +0 -176
- package/core/core/decorators/kos-view-model.d.ts.map +0 -1
- package/core/core/model/kos-service-request-manager.d.ts +0 -102
- package/core/core/model/kos-service-request-manager.d.ts.map +0 -1
- package/core/core/model/service-response-store.d.ts +0 -164
- package/core/core/model/service-response-store.d.ts.map +0 -1
- package/core/types/service-response-store.d.ts +0 -162
- package/core/types/service-response-store.d.ts.map +0 -1
- package/core/util/ancestor-path-visitor.d.ts +0 -60
- package/core/util/ancestor-path-visitor.d.ts.map +0 -1
- package/core/util/error-logger.d.ts +0 -16
- package/core/util/error-logger.d.ts.map +0 -1
- package/core/util/model-error-utils.d.ts +0 -61
- package/core/util/model-error-utils.d.ts.map +0 -1
- package/core/util/model-transition-utils.d.ts +0 -41
- package/core/util/model-transition-utils.d.ts.map +0 -1
- package/core/util/model-type-guards.d.ts +0 -26
- package/core/util/model-type-guards.d.ts.map +0 -1
- package/core/util/promise-utils.d.ts +0 -58
- package/core/util/promise-utils.d.ts.map +0 -1
- package/core/util/service-request-error.d.ts +0 -60
- package/core/util/service-request-error.d.ts.map +0 -1
- package/core/util/service-response.d.ts +0 -125
- package/core/util/service-response.d.ts.map +0 -1
- package/kos-models.json +0 -426
- package/models/models/config-bean/types/index.d.ts +0 -34
- package/models/models/gpio-chip/gpio-chip-container-model.d.ts +0 -25
- package/models/models/gpio-chip/gpio-chip-container-model.d.ts.map +0 -1
- package/models/models/gpio-chip/gpio-chip-model.d.ts +0 -30
- package/models/models/gpio-chip/gpio-chip-model.d.ts.map +0 -1
- package/models/models/gpio-chip/index.d.ts +0 -7
- package/models/models/gpio-chip/index.d.ts.map +0 -1
- package/models/models/gpio-chip/services/gpio-chip-services.d.ts +0 -86
- package/models/models/gpio-chip/services/gpio-chip-services.d.ts.map +0 -1
- package/models/models/gpio-chip/services/index.d.ts +0 -2
- package/models/models/gpio-chip/services/index.d.ts.map +0 -1
- package/models/models/gpio-chip/types/index.d.ts +0 -24
- package/models/models/gpio-pin/gpio-pin-container-model.d.ts +0 -23
- package/models/models/gpio-pin/gpio-pin-container-model.d.ts.map +0 -1
- package/models/models/gpio-pin/gpio-pin-model.d.ts +0 -26
- package/models/models/gpio-pin/gpio-pin-model.d.ts.map +0 -1
- package/models/models/gpio-pin/index.d.ts +0 -6
- package/models/models/gpio-pin/index.d.ts.map +0 -1
- package/models/models/gpio-pin/types/index.d.ts +0 -23
- package/models/models/kos-expression-evaluator/index.d.ts +0 -4
- package/models/models/kos-expression-evaluator/index.d.ts.map +0 -1
- package/models/models/kos-expression-evaluator/kos-expression-evaluator-model.d.ts +0 -209
- package/models/models/kos-expression-evaluator/kos-expression-evaluator-model.d.ts.map +0 -1
- package/models/models/kos-expression-evaluator/services/index.d.ts +0 -6
- package/models/models/kos-expression-evaluator/services/index.d.ts.map +0 -1
- package/models/models/kos-expression-evaluator/services/kos-expression-evaluator-services.d.ts +0 -15
- package/models/models/kos-expression-evaluator/services/kos-expression-evaluator-services.d.ts.map +0 -1
- package/models/models/kos-expression-evaluator/types/index.d.ts +0 -6
- package/models/utils/get-kos-connection-id.d.ts +0 -2
- package/models/utils/get-kos-connection-id.d.ts.map +0 -1
- package/models/utils/openapi-index.d.ts +0 -3
- package/models/utils/openapi-index.d.ts.map +0 -1
- package/models/utils/service-accessor.d.ts +0 -86
- package/models/utils/service-accessor.d.ts.map +0 -1
- package/models/utils/services/kos/1.6.5/openapi.d.ts +0 -3809
- package/models/utils/services/kos/1.6.5/service.d.ts +0 -124
- package/models/utils/services/kos/1.6.5/service.d.ts.map +0 -1
- package/models/utils/services/kos/1.8.1/openapi.d.ts +0 -4344
- package/models/utils/services/kos/1.8.1/service.d.ts +0 -124
- package/models/utils/services/kos/1.8.1/service.d.ts.map +0 -1
- package/models/utils/services/kos/1.9.x/openapi.d.ts +0 -4597
- package/models/utils/services/kos/1.9.x/service.d.ts +0 -124
- package/models/utils/services/kos/1.9.x/service.d.ts.map +0 -1
- package/models/utils/services/kos/daily/openapi.d.ts +0 -4349
- package/models/utils/services/kos/daily/service.d.ts +0 -124
- package/models/utils/services/kos/daily/service.d.ts.map +0 -1
- package/models/utils/services/vfs/1.6.5/openapi.d.ts +0 -51
- package/models/utils/services/vfs/1.6.5/service.d.ts +0 -124
- package/models/utils/services/vfs/1.6.5/service.d.ts.map +0 -1
- package/models/utils/services/vfs/1.8.1/openapi.d.ts +0 -51
- package/models/utils/services/vfs/1.8.1/service.d.ts +0 -124
- package/models/utils/services/vfs/1.8.1/service.d.ts.map +0 -1
- package/models/utils/services/vfs/1.9.x/openapi.d.ts +0 -51
- package/models/utils/services/vfs/1.9.x/service.d.ts +0 -124
- package/models/utils/services/vfs/1.9.x/service.d.ts.map +0 -1
- package/models/utils/services/vfs/daily/openapi.d.ts +0 -51
- package/models/utils/services/vfs/daily/service.d.ts +0 -124
- package/models/utils/services/vfs/daily/service.d.ts.map +0 -1
- package/models/utils/services-index.d.ts +0 -9
- package/models/utils/services-index.d.ts.map +0 -1
- package/ui/hooks/view-model/index.d.ts +0 -2
- package/ui/hooks/view-model/index.d.ts.map +0 -1
- package/ui/hooks/view-model/use-view-model.d.ts +0 -80
- package/ui/hooks/view-model/use-view-model.d.ts.map +0 -1
|
@@ -4,355 +4,73 @@ import { SchemaNodeType, SchemaOptionsType } from '../../../services/config-bean
|
|
|
4
4
|
import { UnitConverter } from '../../../decorators';
|
|
5
5
|
|
|
6
6
|
|
|
7
|
-
/**
|
|
8
|
-
* Unit conversion configuration for KosConfigProperty instances.
|
|
9
|
-
*
|
|
10
|
-
* Defines how configuration property values should be converted between backend
|
|
11
|
-
* storage units (typically SI) and regional display units. The converter enables
|
|
12
|
-
* automatic unit conversion based on device region while maintaining precision.
|
|
13
|
-
*
|
|
14
|
-
* @example Temperature Conversion
|
|
15
|
-
* ```typescript
|
|
16
|
-
* const temperatureConverter: ConfigPropConverter = {
|
|
17
|
-
* measure: 'temperature',
|
|
18
|
-
* from: { unit: 'kelvin', system: 'si' }, // Backend storage
|
|
19
|
-
* to: { system: 'auto' } // Auto-detect regional display
|
|
20
|
-
* };
|
|
21
|
-
* ```
|
|
22
|
-
*
|
|
23
|
-
* @example Volume Conversion with Specific Units
|
|
24
|
-
* ```typescript
|
|
25
|
-
* const volumeConverter: ConfigPropConverter = {
|
|
26
|
-
* measure: 'volume',
|
|
27
|
-
* from: { unit: 'liter' }, // Backend in liters
|
|
28
|
-
* to: { unit: 'fluid-ounce', system: 'imperial' } // Force US fluid ounces
|
|
29
|
-
* };
|
|
30
|
-
* ```
|
|
31
|
-
*
|
|
32
|
-
* @kosService core.use-config-property
|
|
33
|
-
* @group KOS Model
|
|
34
|
-
* @category Configuration
|
|
35
|
-
*/
|
|
36
7
|
export interface ConfigPropConverter {
|
|
37
|
-
/**
|
|
38
|
-
* The physical measure being converted (temperature, volume, pressure, etc.).
|
|
39
|
-
* This helps the system understand what type of conversion to perform.
|
|
40
|
-
*/
|
|
41
8
|
measure?: string;
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* Source unit configuration (typically backend storage units).
|
|
45
|
-
* Defines the unit system and specific unit that values are stored in.
|
|
46
|
-
*/
|
|
47
9
|
from?: UnitConverter;
|
|
48
|
-
|
|
49
|
-
/**
|
|
50
|
-
* Target unit configuration (display units).
|
|
51
|
-
* Defines how values should be displayed to users, including regional preferences.
|
|
52
|
-
*/
|
|
53
10
|
to?: UnitConverter;
|
|
54
11
|
}
|
|
55
12
|
|
|
56
|
-
/**
|
|
57
|
-
* Formatting options for numeric configuration property display values.
|
|
58
|
-
*
|
|
59
|
-
* Supports both static formatting options and dynamic formatting based on unit system.
|
|
60
|
-
* Built on top of the Intl.NumberFormat API for internationalization support.
|
|
61
|
-
*
|
|
62
|
-
* @example Static Formatting Options
|
|
63
|
-
* ```typescript
|
|
64
|
-
* const staticFormatter: FormatOptions = {
|
|
65
|
-
* style: 'unit',
|
|
66
|
-
* unit: 'celsius',
|
|
67
|
-
* maximumFractionDigits: 1
|
|
68
|
-
* };
|
|
69
|
-
* ```
|
|
70
|
-
*
|
|
71
|
-
* @example Dynamic System-Based Formatting
|
|
72
|
-
* ```typescript
|
|
73
|
-
* const dynamicFormatter: FormatOptions = (system: string) => {
|
|
74
|
-
* if (system === 'imperial') {
|
|
75
|
-
* return { style: 'unit', unit: 'fahrenheit', maximumFractionDigits: 0 };
|
|
76
|
-
* }
|
|
77
|
-
* return { style: 'unit', unit: 'celsius', maximumFractionDigits: 1 };
|
|
78
|
-
* };
|
|
79
|
-
* ```
|
|
80
|
-
*
|
|
81
|
-
* @kosService core.use-config-property
|
|
82
|
-
* @group KOS Model
|
|
83
|
-
* @category Configuration
|
|
84
|
-
*/
|
|
85
13
|
export type FormatOptions =
|
|
86
14
|
| Intl.NumberFormatOptions
|
|
87
15
|
| ((system: string) => Intl.NumberFormatOptions);
|
|
88
16
|
|
|
89
|
-
/**
|
|
90
|
-
* Option definition for enumerated configuration properties.
|
|
91
|
-
*
|
|
92
|
-
* Represents a single selectable option with a display label and internal value.
|
|
93
|
-
* Used for configuration properties that have predefined valid values.
|
|
94
|
-
*
|
|
95
|
-
* @example Basic Options
|
|
96
|
-
* ```typescript
|
|
97
|
-
* const optionsList: OptionsType[] = [
|
|
98
|
-
* { label: 'Low Speed', value: 'low' },
|
|
99
|
-
* { label: 'Medium Speed', value: 'medium' },
|
|
100
|
-
* { label: 'High Speed', value: 'high' }
|
|
101
|
-
* ];
|
|
102
|
-
* ```
|
|
103
|
-
*
|
|
104
|
-
* @kosService core.use-config-property
|
|
105
|
-
* @group KOS Model
|
|
106
|
-
* @category Configuration
|
|
107
|
-
*/
|
|
108
17
|
export interface OptionsType {
|
|
109
|
-
/** The internal value used by the system */
|
|
110
18
|
value: string;
|
|
111
|
-
/** The human-readable display label */
|
|
112
19
|
label: string;
|
|
113
20
|
}
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* Options provider for configuration properties with enumerated values.
|
|
117
|
-
*
|
|
118
|
-
* Can be either a static list of options or a dynamic function that generates
|
|
119
|
-
* options based on the current unit system. Useful for configuration properties
|
|
120
|
-
* that need different option sets based on regional settings.
|
|
121
|
-
*
|
|
122
|
-
* @example Static Options List
|
|
123
|
-
* ```typescript
|
|
124
|
-
* const staticOptions: OptionsExpander = [
|
|
125
|
-
* { label: 'Automatic', value: 'auto' },
|
|
126
|
-
* { label: 'Manual', value: 'manual' },
|
|
127
|
-
* { label: 'Disabled', value: 'disabled' }
|
|
128
|
-
* ];
|
|
129
|
-
* ```
|
|
130
|
-
*
|
|
131
|
-
* @example Dynamic System-Based Options
|
|
132
|
-
* ```typescript
|
|
133
|
-
* const dynamicOptions: OptionsExpander = (system: string, schemaOptions?: string[]) => {
|
|
134
|
-
* const baseOptions = [
|
|
135
|
-
* { label: 'Automatic', value: 'auto' },
|
|
136
|
-
* { label: 'Manual', value: 'manual' }
|
|
137
|
-
* ];
|
|
138
|
-
*
|
|
139
|
-
* // Add system-specific options
|
|
140
|
-
* if (system === 'imperial') {
|
|
141
|
-
* baseOptions.push({ label: 'Imperial Mode', value: 'imperial' });
|
|
142
|
-
* } else if (system === 'metric') {
|
|
143
|
-
* baseOptions.push({ label: 'Metric Mode', value: 'metric' });
|
|
144
|
-
* }
|
|
145
|
-
*
|
|
146
|
-
* return baseOptions;
|
|
147
|
-
* };
|
|
148
|
-
* ```
|
|
149
|
-
*
|
|
150
|
-
* @kosService core.use-config-property
|
|
151
|
-
* @group KOS Model
|
|
152
|
-
* @category Configuration
|
|
153
|
-
*/
|
|
154
21
|
export type OptionsExpander =
|
|
155
22
|
| OptionsType[]
|
|
156
23
|
| ((system: string, options?: string[]) => OptionsType[]);
|
|
157
|
-
|
|
158
24
|
/**
|
|
159
|
-
*
|
|
25
|
+
* Options that are passed into the model via the constructor
|
|
160
26
|
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
* @example Basic Property Configuration
|
|
166
|
-
* ```typescript
|
|
167
|
-
* const pumpRateOptions: ConfigBeanPropOptions = {
|
|
168
|
-
* path: 'assembly:core:board:micro:pump:S4',
|
|
169
|
-
* attribute: 'nominalRate'
|
|
170
|
-
* };
|
|
171
|
-
* ```
|
|
172
|
-
*
|
|
173
|
-
* @example Property with Unit Conversion
|
|
174
|
-
* ```typescript
|
|
175
|
-
* const temperatureOptions: ConfigBeanPropOptions = {
|
|
176
|
-
* path: 'assembly:core:board:cooling',
|
|
177
|
-
* attribute: 'targetTemperature',
|
|
178
|
-
* converter: {
|
|
179
|
-
* measure: 'temperature',
|
|
180
|
-
* from: { unit: 'kelvin' },
|
|
181
|
-
* to: { system: 'auto' }
|
|
182
|
-
* },
|
|
183
|
-
* formatter: {
|
|
184
|
-
* style: 'unit',
|
|
185
|
-
* maximumFractionDigits: 1
|
|
186
|
-
* }
|
|
187
|
-
* };
|
|
188
|
-
* ```
|
|
189
|
-
*
|
|
190
|
-
* @kosService core.use-config-property
|
|
191
|
-
* @group KOS Model
|
|
192
|
-
* @category Configuration
|
|
27
|
+
* @property path - the handle path for the config bean
|
|
28
|
+
* @property attribute - the attribute on the config bean
|
|
29
|
+
* @property converter - the converter indicating the source and target unit conversions
|
|
30
|
+
* @property formatter - the formatting to be applied to numeric values. Uses the Intl.NumberFormatOptions
|
|
193
31
|
*/
|
|
194
32
|
export interface ConfigBeanPropOptions {
|
|
195
|
-
/**
|
|
196
|
-
* The hierarchical configuration path using colon-separated notation.
|
|
197
|
-
*
|
|
198
|
-
* This path identifies the specific configuration bean that contains
|
|
199
|
-
* the target attribute. Must match the path used by the parent ConfigBeanModel.
|
|
200
|
-
*
|
|
201
|
-
* @example Common Configuration Paths
|
|
202
|
-
* ```typescript
|
|
203
|
-
* // Hardware component configuration
|
|
204
|
-
* path: 'assembly:core:board:micro:pump:S4'
|
|
205
|
-
*
|
|
206
|
-
* // System-level configuration
|
|
207
|
-
* path: 'system:app'
|
|
208
|
-
*
|
|
209
|
-
* // Service configuration
|
|
210
|
-
* path: 'kos:service:CANPumpMgr'
|
|
211
|
-
* ```
|
|
212
|
-
*/
|
|
213
33
|
path: string;
|
|
214
|
-
|
|
215
|
-
/**
|
|
216
|
-
* The specific attribute name within the configuration bean.
|
|
217
|
-
*
|
|
218
|
-
* This identifies which property within the configuration bean
|
|
219
|
-
* this KosConfigProperty instance should access and manage.
|
|
220
|
-
*
|
|
221
|
-
* @example Attribute Examples
|
|
222
|
-
* ```typescript
|
|
223
|
-
* attribute: 'nominalRate' // For pump flow rates
|
|
224
|
-
* attribute: 'targetTemperature' // For temperature settings
|
|
225
|
-
* attribute: 'enabled' // For boolean flags
|
|
226
|
-
* attribute: 'retryCount' // For numeric counters
|
|
227
|
-
* ```
|
|
228
|
-
*/
|
|
229
34
|
attribute: string;
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
* Optional unit conversion configuration.
|
|
233
|
-
*
|
|
234
|
-
* When provided, enables automatic conversion between backend storage units
|
|
235
|
-
* and regional display units. If omitted, no unit conversion is performed.
|
|
236
|
-
*
|
|
237
|
-
* @example Temperature Conversion
|
|
238
|
-
* ```typescript
|
|
239
|
-
* converter: {
|
|
240
|
-
* from: { unit: 'kelvin', system: 'si' },
|
|
241
|
-
* to: { system: 'auto' } // Auto-detect regional system
|
|
242
|
-
* }
|
|
243
|
-
* ```
|
|
244
|
-
*/
|
|
245
|
-
converter?: { measure?: string; from?: UnitConverter; to?: UnitConverter };
|
|
246
|
-
|
|
247
|
-
/**
|
|
248
|
-
* Optional display formatting configuration.
|
|
249
|
-
*
|
|
250
|
-
* Configures how numeric values are formatted for display, including
|
|
251
|
-
* decimal places, units, and locale-specific formatting rules.
|
|
252
|
-
*
|
|
253
|
-
* @example Custom Formatting
|
|
254
|
-
* ```typescript
|
|
255
|
-
* formatter: {
|
|
256
|
-
* style: 'unit',
|
|
257
|
-
* unit: 'celsius',
|
|
258
|
-
* maximumFractionDigits: 1,
|
|
259
|
-
* minimumFractionDigits: 1
|
|
260
|
-
* }
|
|
261
|
-
* ```
|
|
262
|
-
*/
|
|
35
|
+
converter?: { from?: UnitConverter; to?: UnitConverter };
|
|
263
36
|
formatter?: FormatOptions;
|
|
264
|
-
|
|
265
|
-
/**
|
|
266
|
-
* Optional predefined options for enumerated properties.
|
|
267
|
-
*
|
|
268
|
-
* Provides a list of valid values for configuration properties that
|
|
269
|
-
* have discrete options rather than continuous values.
|
|
270
|
-
*
|
|
271
|
-
* @example Static Options
|
|
272
|
-
* ```typescript
|
|
273
|
-
* optionsExpander: [
|
|
274
|
-
* { label: 'Low', value: 'low' },
|
|
275
|
-
* { label: 'Medium', value: 'medium' },
|
|
276
|
-
* { label: 'High', value: 'high' }
|
|
277
|
-
* ]
|
|
278
|
-
* ```
|
|
279
|
-
*/
|
|
280
37
|
optionsExpander?: OptionsExpander;
|
|
281
|
-
|
|
282
|
-
/**
|
|
283
|
-
* Optional custom service base path.
|
|
284
|
-
*
|
|
285
|
-
* When provided, overrides the default configuration service endpoint.
|
|
286
|
-
* Useful for testing, development, or alternative service implementations.
|
|
287
|
-
*
|
|
288
|
-
* @default undefined (uses default KOS configuration service path)
|
|
289
|
-
*/
|
|
290
|
-
readonly serviceBasePath?: string;
|
|
38
|
+
serviceBasePath?: string;
|
|
291
39
|
}
|
|
292
40
|
|
|
293
41
|
/**
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
*
|
|
42
|
+
* @property id - the unique identifier of the config bean property
|
|
43
|
+
* @property value - the raw value of the config property after any unit conversion
|
|
44
|
+
* The value does not perform any rounding or formatting
|
|
45
|
+
* @property displayValue - the string value of the value after all formatting, rounding
|
|
46
|
+
* and unit conversion
|
|
47
|
+
* @property unit - the unit of measure for the property. This unit will be formatted based
|
|
48
|
+
* on the formatter options provided.
|
|
298
49
|
*
|
|
299
|
-
* @
|
|
300
|
-
* ```typescript
|
|
301
|
-
* const pumpRate = KosConfigProperty.create('pump-rate', {
|
|
302
|
-
* path: 'assembly:core:board:micro:pump:S4',
|
|
303
|
-
* attribute: 'nominalRate'
|
|
304
|
-
* });
|
|
305
|
-
* ```
|
|
50
|
+
* @category Configuration Service
|
|
306
51
|
*
|
|
307
|
-
* @kosService core.use-config-property
|
|
308
|
-
* @group KOS Model
|
|
309
|
-
* @category Configuration
|
|
310
52
|
*/
|
|
311
53
|
export interface KosConfigProperty<
|
|
312
54
|
PropertyType extends ConfigPropertyTypes = ConfigPropertyTypes
|
|
313
55
|
> extends ConfigBeanPropOptions,
|
|
314
56
|
IKosDataModel {
|
|
315
|
-
/** Unique identifier for the config property instance */
|
|
316
57
|
id: string;
|
|
317
|
-
|
|
318
|
-
/** Optional custom service base path for configuration endpoints */
|
|
319
58
|
serviceBasePath?: string;
|
|
320
|
-
|
|
321
|
-
/** The unit of measure for the property after regional conversion (e.g., "°F", "mL/s") */
|
|
322
59
|
readonly unit?: string;
|
|
323
|
-
|
|
324
|
-
/** The property value converted to regional units */
|
|
325
60
|
readonly value?: PropertyType;
|
|
326
|
-
|
|
327
|
-
/** The raw backend value before any unit conversion (typically SI units) */
|
|
328
61
|
readonly rawValue?: PropertyType;
|
|
329
|
-
|
|
330
|
-
/** The property value with appropriate decimal precision for display */
|
|
331
62
|
readonly significantValue?: PropertyType;
|
|
332
|
-
|
|
333
|
-
/** The previous value before the last update */
|
|
334
63
|
readonly previousValue?: PropertyType;
|
|
335
|
-
|
|
336
|
-
/** Formatted string representation of the value with units and localization */
|
|
337
64
|
readonly displayValue?: string;
|
|
338
|
-
|
|
339
|
-
/** Display configuration options from the backend schema */
|
|
340
65
|
readonly displayOptions?: SchemaOptionsType;
|
|
341
|
-
|
|
342
|
-
/** Available enumerated options for this property (if applicable) */
|
|
343
66
|
readonly options?: OptionsType[];
|
|
344
|
-
|
|
345
|
-
/** The data type of this property as defined in the backend schema */
|
|
346
67
|
readonly schemaType: SchemaNodeType | "enum";
|
|
347
|
-
|
|
348
|
-
/** Optional format specifier from the backend schema (e.g., "s", "ml", "drt") */
|
|
349
68
|
readonly schemaFormat?: string;
|
|
350
|
-
|
|
351
69
|
/**
|
|
352
|
-
*
|
|
353
|
-
*
|
|
354
|
-
*
|
|
355
|
-
* @
|
|
70
|
+
* Update the property value of the config bean property resulting in a
|
|
71
|
+
* the value being pushed to the backend for persistence.
|
|
72
|
+
* @param value - the value of the property
|
|
73
|
+
* @returns - void
|
|
356
74
|
*/
|
|
357
75
|
updateProperty: (value: PropertyType | string) => void;
|
|
358
76
|
}
|
|
@@ -6,238 +6,27 @@ export declare const TOPIC_CRITICAL_DATA_CHANGED = "/kos/criticalData/changed";
|
|
|
6
6
|
export declare const TOPIC_CRITICAL_DATA_AVAILABLE = "/kos/criticalData/available";
|
|
7
7
|
export declare const TOPIC_CRITICAL_DATA_UNAVAILABLE = "/kos/criticalData/unavailable";
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* The Device model provides centralized management of device identity, node configuration,
|
|
12
|
-
* and hardware identification within KOS systems. It handles device serial numbers,
|
|
13
|
-
* names, and node topology information essential for system coordination and administration.
|
|
14
|
-
*
|
|
15
|
-
* ## Key Features
|
|
16
|
-
*
|
|
17
|
-
* ### Device Identity Management
|
|
18
|
-
* - **Serial Number Tracking**: Hardware-based device identification
|
|
19
|
-
* - **Name Management**: Human-readable device naming for administration
|
|
20
|
-
* - **Node Configuration**: Multi-node deployment topology handling
|
|
21
|
-
*
|
|
22
|
-
* ### Real-time Synchronization
|
|
23
|
-
* - **Critical Data Events**: Automatic updates on system data changes
|
|
24
|
-
* - **WebSocket Integration**: Live device state synchronization
|
|
25
|
-
* - **Lazy Loading**: Efficient data retrieval when needed
|
|
26
|
-
*
|
|
27
|
-
* ### Node Topology Support
|
|
28
|
-
* - **Node Type/Name Parsing**: Automatic node identifier decomposition
|
|
29
|
-
* - **Multi-node Deployments**: Support for complex system architectures
|
|
30
|
-
* - **Role-based Configuration**: Node-specific parameter management
|
|
31
|
-
*
|
|
32
|
-
* ## Common Integration Patterns
|
|
33
|
-
*
|
|
34
|
-
* ### System Administration Dashboards
|
|
35
|
-
* ```typescript
|
|
36
|
-
* const device = Device.factory({
|
|
37
|
-
* serialNumber: 'KOS-DEV-001',
|
|
38
|
-
* name: 'Production Dispenser Alpha',
|
|
39
|
-
* nodeId: 'primary-main'
|
|
40
|
-
* });
|
|
41
|
-
*
|
|
42
|
-
* // Access device identity
|
|
43
|
-
* console.log(`Device: ${device.name}`);
|
|
44
|
-
* console.log(`Serial: ${device.serialNumber}`);
|
|
45
|
-
* console.log(`Node: ${device.nodeType}-${device.nodeName}`);
|
|
46
|
-
* ```
|
|
47
|
-
*
|
|
48
|
-
* ### Multi-node System Coordination
|
|
49
|
-
* ```typescript
|
|
50
|
-
* const primaryDevice = Device.factory({
|
|
51
|
-
* nodeId: 'primary-controller'
|
|
52
|
-
* });
|
|
53
|
-
*
|
|
54
|
-
* const secondaryDevice = Device.factory({
|
|
55
|
-
* nodeId: 'secondary-backup'
|
|
56
|
-
* });
|
|
57
|
-
*
|
|
58
|
-
* // Coordinate based on node roles
|
|
59
|
-
* if (primaryDevice.nodeType === 'primary') {
|
|
60
|
-
* // Handle primary node logic
|
|
61
|
-
* }
|
|
62
|
-
* ```
|
|
63
|
-
*
|
|
64
|
-
* ### Device Registration and Setup
|
|
65
|
-
* ```typescript
|
|
66
|
-
* const newDevice = Device.factory({
|
|
67
|
-
* serialNumber: await getHardwareSerial(),
|
|
68
|
-
* name: userProvidedName,
|
|
69
|
-
* nodeId: deploymentConfiguration.nodeId
|
|
70
|
-
* });
|
|
71
|
-
*
|
|
72
|
-
* // Device automatically loads additional data
|
|
73
|
-
* // from critical data events
|
|
74
|
-
* ```
|
|
75
|
-
*
|
|
76
|
-
* ## Real-time Updates
|
|
77
|
-
*
|
|
78
|
-
* The Device model automatically responds to critical data changes:
|
|
79
|
-
* - Monitors `/kos/criticalData/changed` and `/kos/criticalData/available` topics
|
|
80
|
-
* - Updates serial number and configuration when system data becomes available
|
|
81
|
-
* - Maintains consistency across device restarts and configuration changes
|
|
82
|
-
*
|
|
83
|
-
* ## Singleton Behavior
|
|
84
|
-
*
|
|
85
|
-
* Device models use singleton pattern - each device type has one instance:
|
|
86
|
-
* - Subsequent factory calls return the existing instance
|
|
87
|
-
* - Options are ignored after first creation
|
|
88
|
-
* - Ensures system-wide device identity consistency
|
|
89
|
-
*
|
|
9
|
+
* A model representing a device.
|
|
90
10
|
* This is an alias for the implementation {@link DeviceModelImpl}.
|
|
91
11
|
*
|
|
92
|
-
* @
|
|
93
|
-
*
|
|
94
|
-
* @category Device Data
|
|
95
|
-
* @useDeclaredType
|
|
12
|
+
* @category Model
|
|
13
|
+
*
|
|
96
14
|
*/
|
|
97
15
|
export type DeviceModel = PublicModelInterface<DeviceModelImpl>;
|
|
98
16
|
export declare class DeviceModelImpl implements IKosDataModel, IKosIdentifiable {
|
|
99
17
|
id: string;
|
|
100
18
|
private logger;
|
|
101
19
|
private _serialNumber;
|
|
102
|
-
/**
|
|
103
|
-
* Hardware-based device serial number for unique identification.
|
|
104
|
-
*
|
|
105
|
-
* Returns the device's hardware serial number or "unassigned" if not yet loaded.
|
|
106
|
-
* Serial numbers are typically retrieved from the device's hardware identification
|
|
107
|
-
* system during critical data events.
|
|
108
|
-
*
|
|
109
|
-
* @example
|
|
110
|
-
* ```typescript
|
|
111
|
-
* const device = Device.factory({});
|
|
112
|
-
*
|
|
113
|
-
* // Check if serial number is available
|
|
114
|
-
* if (device.serialNumber !== "unassigned") {
|
|
115
|
-
* console.log(`Device Serial: ${device.serialNumber}`);
|
|
116
|
-
* }
|
|
117
|
-
* ```
|
|
118
|
-
*/
|
|
119
20
|
get serialNumber(): string | "unassigned";
|
|
120
21
|
private _name;
|
|
121
|
-
/**
|
|
122
|
-
* Human-readable device name for administrative identification.
|
|
123
|
-
*
|
|
124
|
-
* Returns the configured device name or "unassigned" if not yet set.
|
|
125
|
-
* Device names are typically configured during device setup and used
|
|
126
|
-
* in administrative interfaces for device identification and management.
|
|
127
|
-
*
|
|
128
|
-
* @example
|
|
129
|
-
* ```typescript
|
|
130
|
-
* const device = Device.factory({
|
|
131
|
-
* name: 'Main Production Dispenser'
|
|
132
|
-
* });
|
|
133
|
-
*
|
|
134
|
-
* console.log(`Device Name: ${device.name}`);
|
|
135
|
-
* // Output: "Device Name: Main Production Dispenser"
|
|
136
|
-
* ```
|
|
137
|
-
*/
|
|
138
22
|
get name(): string | "unassigned";
|
|
139
23
|
private _nodeId;
|
|
140
|
-
/**
|
|
141
|
-
* Full node identifier within the KOS deployment.
|
|
142
|
-
*
|
|
143
|
-
* Returns the complete node ID or "unassigned" if not yet configured.
|
|
144
|
-
* Node IDs follow the pattern "type-instance" (e.g., "primary-main", "secondary-backup")
|
|
145
|
-
* and identify the specific node role and instance within multi-node deployments.
|
|
146
|
-
*
|
|
147
|
-
* @example
|
|
148
|
-
* ```typescript
|
|
149
|
-
* const device = Device.factory({
|
|
150
|
-
* nodeId: 'primary-controller'
|
|
151
|
-
* });
|
|
152
|
-
*
|
|
153
|
-
* console.log(`Node ID: ${device.nodeId}`);
|
|
154
|
-
* // Output: "Node ID: primary-controller"
|
|
155
|
-
* ```
|
|
156
|
-
*
|
|
157
|
-
* @see {@link nodeType} for extracting the node type portion
|
|
158
|
-
* @see {@link nodeName} for extracting the node name portion
|
|
159
|
-
*/
|
|
160
24
|
get nodeId(): string | "unassigned";
|
|
161
|
-
/**
|
|
162
|
-
* Node type extracted from the node identifier.
|
|
163
|
-
*
|
|
164
|
-
* Returns the first part of the node ID (before the hyphen).
|
|
165
|
-
* For node ID "primary-controller", this returns "primary".
|
|
166
|
-
* Used for role-based logic and node coordination.
|
|
167
|
-
*
|
|
168
|
-
* @example
|
|
169
|
-
* ```typescript
|
|
170
|
-
* const device = Device.factory({
|
|
171
|
-
* nodeId: 'primary-controller'
|
|
172
|
-
* });
|
|
173
|
-
*
|
|
174
|
-
* console.log(`Node Type: ${device.nodeType}`);
|
|
175
|
-
* // Output: "Node Type: primary"
|
|
176
|
-
*
|
|
177
|
-
* // Role-based coordination
|
|
178
|
-
* if (device.nodeType === 'primary') {
|
|
179
|
-
* // Handle primary node responsibilities
|
|
180
|
-
* }
|
|
181
|
-
* ```
|
|
182
|
-
*/
|
|
183
25
|
get nodeType(): string;
|
|
184
|
-
/**
|
|
185
|
-
* Node name extracted from the node identifier.
|
|
186
|
-
*
|
|
187
|
-
* Returns the second part of the node ID (after the hyphen).
|
|
188
|
-
* For node ID "primary-controller", this returns "controller".
|
|
189
|
-
* Used for instance-specific identification within node types.
|
|
190
|
-
*
|
|
191
|
-
* @example
|
|
192
|
-
* ```typescript
|
|
193
|
-
* const device = Device.factory({
|
|
194
|
-
* nodeId: 'secondary-backup'
|
|
195
|
-
* });
|
|
196
|
-
*
|
|
197
|
-
* console.log(`Node Name: ${device.nodeName}`);
|
|
198
|
-
* // Output: "Node Name: backup"
|
|
199
|
-
*
|
|
200
|
-
* // Instance-specific logic
|
|
201
|
-
* if (device.nodeName === 'backup') {
|
|
202
|
-
* // Handle backup node configuration
|
|
203
|
-
* }
|
|
204
|
-
* ```
|
|
205
|
-
*/
|
|
206
26
|
get nodeName(): string;
|
|
207
27
|
constructor(modelId: string, _options: DeviceOptions, context: KosCreationContext);
|
|
208
28
|
/**
|
|
209
|
-
* Update the
|
|
210
|
-
*
|
|
211
|
-
* Allows dynamic updating of device identity and node configuration.
|
|
212
|
-
* Any undefined values will be set to "unassigned". This method is typically
|
|
213
|
-
* called internally during device data loading or external configuration changes.
|
|
214
|
-
*
|
|
215
|
-
* @param options - Device configuration options to apply
|
|
216
|
-
*
|
|
217
|
-
* @example
|
|
218
|
-
* ```typescript
|
|
219
|
-
* const device = Device.factory({});
|
|
220
|
-
*
|
|
221
|
-
* // Update with new device information
|
|
222
|
-
* device.updateModel({
|
|
223
|
-
* serialNumber: 'KOS-DEVICE-12345',
|
|
224
|
-
* name: 'Updated Dispenser Name',
|
|
225
|
-
* nodeId: 'primary-main'
|
|
226
|
-
* });
|
|
227
|
-
*
|
|
228
|
-
* console.log(device.serialNumber); // "KOS-DEVICE-12345"
|
|
229
|
-
* console.log(device.name); // "Updated Dispenser Name"
|
|
230
|
-
* console.log(device.nodeId); // "primary-main"
|
|
231
|
-
* ```
|
|
232
|
-
*
|
|
233
|
-
* @example Partial Updates
|
|
234
|
-
* ```typescript
|
|
235
|
-
* // Only update specific fields
|
|
236
|
-
* device.updateModel({
|
|
237
|
-
* name: 'New Device Name'
|
|
238
|
-
* // serialNumber and nodeId remain unchanged
|
|
239
|
-
* });
|
|
240
|
-
* ```
|
|
29
|
+
* Update the model with new options.
|
|
241
30
|
*/
|
|
242
31
|
updateModel(options: DeviceOptions): void;
|
|
243
32
|
private loadDeviceData;
|
|
@@ -246,12 +35,13 @@ export declare class DeviceModelImpl implements IKosDataModel, IKosIdentifiable
|
|
|
246
35
|
* Handle critical data changes to load the serial number at the appropriate time.
|
|
247
36
|
*/
|
|
248
37
|
handleCriticalDataChanged(): Promise<void>;
|
|
249
|
-
/**
|
|
250
|
-
* @internal
|
|
251
|
-
*/
|
|
252
38
|
init(): Promise<void>;
|
|
253
39
|
/**
|
|
254
|
-
*
|
|
40
|
+
* Load the device data.
|
|
41
|
+
*
|
|
42
|
+
* This method is called when the device model is loaded.
|
|
43
|
+
*
|
|
44
|
+
*
|
|
255
45
|
*/
|
|
256
46
|
load(): Promise<void>;
|
|
257
47
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"device-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/device/device-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,eAAe,CAAC;AAGvB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,eAAO,MAAM,UAAU,iBAAiB,CAAC;AACzC,eAAO,MAAM,2BAA2B,8BAA8B,CAAC;AACvE,eAAO,MAAM,6BAA6B,gCAAgC,CAAC;AAC3E,eAAO,MAAM,+BAA+B,kCAAkC,CAAC;AAE/E
|
|
1
|
+
{"version":3,"file":"device-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/device/device-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,eAAe,CAAC;AAGvB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,eAAO,MAAM,UAAU,iBAAiB,CAAC;AACzC,eAAO,MAAM,2BAA2B,8BAA8B,CAAC;AACvE,eAAO,MAAM,6BAA6B,gCAAgC,CAAC;AAC3E,eAAO,MAAM,+BAA+B,kCAAkC,CAAC;AAE/E;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,oBAAoB,CAAC,eAAe,CAAC,CAAC;AAEhE,qBACa,eAAgB,YAAW,aAAa,EAAE,gBAAgB;IACrE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,aAAa,CAAwB;IAE7C,IAAI,YAAY,IAAI,MAAM,GAAG,YAAY,CAExC;IAED,OAAO,CAAC,KAAK,CAAwB;IAErC,IAAI,IAAI,IAAI,MAAM,GAAG,YAAY,CAEhC;IAED,OAAO,CAAC,OAAO,CAAwB;IAEvC,IAAI,MAAM,IAAI,MAAM,GAAG,YAAY,CAElC;IAED,IAAI,QAAQ,IAAI,MAAM,CAGrB;IAED,IAAI,QAAQ,IAAI,MAAM,CAGrB;gBAGC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,kBAAkB;IAS7B;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;YAM3B,cAAc;YAYd,gBAAgB;IAU9B;;OAEG;IAKG,yBAAyB;IAOzB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B;;;;;;OAMG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAK5B"}
|