@kosdev-code/kos-ui-sdk 2.0.3 → 2.0.5

package/models/utils/persistence-store.d.ts

@@ -43,7 +43,7 @@ export interface KosPersistenceStore {
     unsubscribe(): void;
 }
 /**
- * Subscribe to a kOS Persistence Store or create a new one
+ * Subscribe to a KOS Persistence Store or create a new one
  * The store will be namespaced by the stateKey and the sessionId allows
  * for multiple instances of data to be created with the same store using eh session id
  * as the discriminator.

package/models/utils/service.d.ts

@@ -2,7 +2,7 @@ import { paths } from './openapi';
 import { PathsByMethod } from '../../core';
 
 declare const api: {
-    get: <K extends "/api/vfs" | "/api/ext/dispense/soldOuts/troubles" | "/api/ext/dispense/soldOuts/db" | "/api/kos/time/timezone" | "/api/kos/storage/devices" | "/api/ext/freestyle/can/read/float/{boardPath}/{index}/{subIndex}" | "/api/ext/freestyle/can/read/int/{boardPath}/{index}/{subIndex}" | "/api/ext/freestyle/can/stats" | "/api/ext/freestyle/can/stats/raw" | "/api/app/kosdev.ddk/cui" | "/api/app/kosdev.ddk/cui/open" | "/api/kos/criticalData/sources" | "/api/kos/criticalData/data" | "/api/kos/criticalData/data/{name}" | "/api/app/kosdev.ddk/ncui/plugins" | "/api/app/kosdev.ddk/ncui/open" | "/api/kos/browser" | "/api/kos/browser/redirect" | "/api/kos/future/traces" | "/api/kos/future/traces/{traceId}/events" | "/api/app/tccc.fits/medusa/profiles" | "/api/app/tccc.fits/medusa/profiles/{profileId}/recipes" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/{testId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/blocks" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/bevs" | "/api/app/tccc.fits/medusa/profiles/{profileId}/map" | "/api/app/tccc.fits/medusa/profiles/{profileId}/results" | "/api/app/tccc.fits/medusa/profiles/{profileId}/results/{resultsId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/results/{resultsId}/entries/{startIdx}/{endIdx}" | "/api/kos/descriptor/{path}" | "/api/kos/descriptor/{path}/{dotted}" | "/api/kos/logs/groups" | "/api/kos/logs/overrides" | "/api/kos/logs/overrides/{nodeType}" | "/api/kos/logs/overrides/{nodeType}/{typePrefix}" | "/api/kos/device" | "/api/kos/device/assemblies" | "/api/kos/device/serialNumber" | "/api/app/kosdev.ddk/auth/role" | "/api/ext/freestyle/microCalibration/report/{board}" | "/api/ext/freestyle/microCalibration/cal/{pump}" | "/api/ext/freestyle/fcm/calibration/{pump}/baseline" | "/api/ext/dispense/nozzle/nozzle/pipeline/ingredient/intent/{path}/{intent}" | "/api/ext/dispense/nozzle/nozzle/pipeline/ingredient/intent/{path}/{intent}/volume" | "/api/ext/dispense/nozzle/nozzle/pipeline/ingredient/intent/{path}/{intent}/time" | "/api/ext/freestyle/fuelGauges/{holder}" | "/api/kos/localization/context/{*path}" | "/api/kos/localization/contexts" | "/api/kos/ota/paused" | "/api/kos/ota/artifacts" | "/api/app/kosdev.ddk/setup/steps" | "/api/app/kosdev.ddk/setup/steps/reset" | "/api/kos/troubles" | "/api/kos/troubles/{troubleId}" | "/api/kos/update/available" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests" | "/api/kos/nodeMgr/blockedManifests" | "/api/kos/manifest/node" | "/api/kos/manifest/device" | "/api/kos/manifest/info" | "/api/kos/config/schema" | "/api/kos/config/schema/{path}" | "/api/kos/config/{path}" | "/api/kos/config/details/{options}" | "/api/kos/config/details/{path}/{options}" | "/api/kos/config/value/merged/{scopedPath}/{attr}" | "/api/kos/config/value/{scopedPath}/{attr}" | "/api/kos/config/bean/defaults/{scopedPath}" | "/api/kos/config/bean/merged/{path}" | "/api/kos/config/bean/overrides/{scopedPath}" | "/api/kos/logs/node/{nodeId}/streams" | "/api/kos/logs/node/{nodeId}/{stream}/blocks" | "/api/kos/logs/node/{nodeId}/{stream}/blocks/{blockId}" | "/api/ext/dispense/insertion/filters" | "/api/app/kosdev.ddk/network/reports" | "/api/app/kosdev.ddk/network/tests" | "/api/app/kosdev.ddk/network/tests/run/{id}" | "/api/app/kosdev.ddk/network/tests/run/group/{group}" | "/api/kos/network/interfaces" | "/api/app/tccc.fits/scales" | "/api/app/tccc.fits/scales/ifaces" | "/api/ext/freestyle/ice/types" | "/api/app/tccc.fits/persistence/sources" | "/api/kos/state/paths" | "/api/kos/state/{path}" | "/api/ext/dispense/ingredients" | "/api/ext/dispense/ingredients/sources" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/select" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/availability" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/availability/groups/{group}" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/graph/node/{id}" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/graph/beverages" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/graph/nodes" | "/api/kos/handles" | "/api/kos/handles/{path}" | "/api/kos/handles/{path}/{view}" | "/api/kos/handles/views" | "/api/ext/dispense/metrics" | "/api/ext/dispense/metrics/names" | "/api/ext/dispense/metrics/{name}" | "/api/ext/dispense/metrics/{nozzle}/names" | "/api/ext/dispense/metrics/{nozzle}/{name}" | "/api/kos/regions" | "/api/kos/regions/info" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/engine/nutrition/{bevId}" | "/api/ext/freestyle/cartridges" | "/api/ext/freestyle/cartridges/{id}" | "/api/ext/dispense/assignments" | "/api/ext/freestyle/brandset/nutrition/{bevId}" | "/api/ext/freestyle/brandset/grantProperties" | "/api/kos/openapi/{*baseUrl}" | "/api/app/kosdev.ddk/copyLogs/volumes/size" | "/api/app/kosdev.ddk/copyLogs/files/size" | "/api/app/tccc.fits/session" | "/api/app/tccc.fits/session/data/{key}">(endpoint: K, params?: (paths[K]["get"] extends {
+    get: <K extends "/api/kos/browser" | "/api/kos/browser/redirect" | "/api/kos/ota/paused" | "/api/kos/ota/artifacts" | "/api/kos/time/timezone" | "/api/kos/manifest/node" | "/api/kos/manifest/device" | "/api/kos/manifest/info" | "/api/kos/future/traces" | "/api/kos/future/traces/{traceId}/events" | "/api/kos/config/schema" | "/api/kos/config/schema/{path}" | "/api/kos/config/{path}" | "/api/kos/config/details/{options}" | "/api/kos/config/details/{path}/{options}" | "/api/kos/config/value/merged/{scopedPath}/{attr}" | "/api/kos/config/value/{scopedPath}/{attr}" | "/api/kos/config/bean/defaults/{scopedPath}" | "/api/kos/config/bean/merged/{path}" | "/api/kos/config/bean/overrides/{scopedPath}" | "/api/kos/update/available" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests" | "/api/kos/nodeMgr/blockedManifests" | "/api/kos/localization/context/{*path}" | "/api/kos/localization/contexts" | "/api/kos/studio/properties" | "/api/kos/openapi/{*baseUrl}" | "/api/kos/regions" | "/api/kos/regions/info" | "/api/kos/device" | "/api/kos/device/assemblies" | "/api/kos/device/serialNumber" | "/api/vfs" | "/api/kos/descriptor/{path}" | "/api/kos/descriptor/{path}/{dotted}" | "/api/kos/troubles" | "/api/kos/troubles/{troubleId}" | "/api/kos/handles" | "/api/kos/handles/{path}" | "/api/kos/handles/{path}/{view}" | "/api/kos/handles/views" | "/api/kos/storage/devices" | "/api/kos/network/interfaces" | "/api/kos/logs/rotateAll" | "/api/kos/logs/node/{nodeId}/streams" | "/api/kos/logs/node/{nodeId}/{stream}/blocks" | "/api/kos/logs/node/{nodeId}/{stream}/blocks/{blockId}" | "/api/kos/logs/rotate/{stream}" | "/api/kos/logs/overrides" | "/api/kos/logs/groups" | "/api/kos/logs/overrides/{nodeType}" | "/api/kos/logs/overrides/{nodeType}/{typePrefix}" | "/api/kos/state/paths" | "/api/kos/state/{path}" | "/api/kos/criticalData/sources" | "/api/kos/criticalData/data" | "/api/kos/criticalData/data/{name}">(endpoint: K, params?: (paths[K]["get"] extends {
         parameters: infer P;
     } ? P : never) | undefined, options?: {
         ordered?: boolean | undefined;
@@ -14,7 +14,7 @@ declare const api: {
         studio?: boolean | undefined;
         signal?: AbortSignal | undefined;
     } | undefined) => Promise<import('../../core').ServiceResponse<import('../../core').ClientResponse<paths, K, "get">>>;
-    post: <K_1 extends "/api/ext/dispense/soldOuts/container/{pump}/{reason}" | "/api/ext/dispense/soldOuts/slice/{pump}/{reason}" | "/api/kos/time/date" | "/api/kos/time/timezone" | "/api/kos/time/time" | "/api/ext/freestyle/can/stats" | "/api/ext/freestyle/can/write/byte/{boardPath}/{index}/{subIndex}/{val}" | "/api/ext/freestyle/can/write/short/{boardPath}/{index}/{subIndex}/{val}" | "/api/ext/freestyle/can/write/float/{boardPath}/{index}/{subIndex}/{val}" | "/api/ext/freestyle/can/write/int/{boardPath}/{index}/{subIndex}/{val}" | "/api/kos/criticalData/data" | "/api/kos/criticalData/data/{name}" | "/api/app/kosdev.ddk/ncui/reboot" | "/api/kos/browser/{nodeId}" | "/api/kos/browser/{nodeId}/{name}" | "/api/kos/browser/intent" | "/api/kos/browser/url" | "/api/kos/future/{futureId}/cancel" | "/api/app/tccc.fits/medusa/profile" | "/api/app/tccc.fits/medusa/profiles/{profileId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/resume" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/exit" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/stop" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/{testId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/{testId}/json" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/{testId}/run" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/pause" | "/api/app/tccc.fits/medusa/profiles/{profileId}/test" | "/api/app/tccc.fits/medusa/profiles/{profileId}/activate" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/blocks" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/bevs/{bevId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/recipe" | "/api/app/tccc.fits/medusa/profiles/{profileId}/mapper/discovery" | "/api/app/tccc.fits/medusa/profiles/{profileId}/mapper/builder" | "/api/app/tccc.fits/medusa/profiles/{profileId}/results/{resultsId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/validate" | "/api/app/tccc.fits/medusa/profiles/{profileId}/validate/all" | "/api/kos/logs/overrides" | "/api/kos/device/serialNumber/{serialNum}" | "/api/app/kosdev.ddk/auth/pincode/{pin}" | "/api/ext/freestyle/microCalibration/cal/{pump}/running/{val}" | "/api/ext/freestyle/microCalibration/cal/{pump}/code/{code}" | "/api/ext/freestyle/microCalibration/cal/{pump}/baseline/{val}" | "/api/ext/freestyle/microCalibration/cal/{pump}/both/{val}" | "/api/ext/freestyle/fcm/calibration/{pump}/calibrate" | "/api/ext/freestyle/fcm/calibration/{pump}/preCalibrate" | "/api/ext/freestyle/fcm/calibration/{pump}/verify/{calVolume}" | "/api/ext/freestyle/fcm/calibration/{pump}/baseline/{value}" | "/api/ext/freestyle/fcm/calibration/{pump}/complete/{calVolume}/{verifyVolume}" | "/api/ext/dispense/nozzle/nozzle/pipeline/ingredient/pour/{path}/{intent}" | "/api/ext/freestyle/fuelGauges/{holder}/{val}" | "/api/kos/ota/resume/{name}" | "/api/kos/ota/cancel" | "/api/kos/ota/cancel/{name}" | "/api/kos/ota/pause/{name}" | "/api/app/kosdev.ddk/setup/complete/{stepName}" | "/api/app/kosdev.ddk/lockout/unlock/{pin}" | "/api/kos/troubles/resolve" | "/api/kos/troubles/resolve/{troubleId}" | "/api/kos/update/install" | "/api/kos/nodeMgr/reboot" | "/api/kos/nodeMgr/node/{nodeId}/reboot" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests/{manifestId}" | "/api/kos/nodeMgr/blockedManifests/{manifestId}" | "/api/kos/config/{path}" | "/api/kos/config/bulk" | "/api/ext/dispense/pumpEvents/replaceLine/{holder}" | "/api/ext/dispense/pumpEvents/replacePump/{pump}" | "/api/kos/logs/node/{nodeId}/{stream}/subscribe" | "/api/kos/logs/node/{nodeId}/{stream}/unsubscribe" | "/api/app/tccc.fits/scales/{serialNum}" | "/api/ext/freestyle/ice/type/{path}/{type}" | "/api/app/tccc.fits/persistence/sources/{storageId}/{name}" | "/api/handle/assembly:core:board:macro:agitator:agit/test" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/select" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/pour" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/fixed/{name}" | "/api/ext/dispense/metrics/{name}" | "/api/ext/dispense/metrics/{nozzle}/{name}" | "/api/ext/dispense/assignments" | "/api/ext/freestyle/fcm/diagnostics/{pump}/pressureTest" | "/api/ext/freestyle/fcm/diagnostics/{pump}/opennessTest" | "/api/ext/freestyle/fcm/diagnostics/{pump}/flowTest" | "/api/ext/freestyle/fcm/diagnostics/{pump}/electricalTest" | "/api/ext/freestyle/brandset/grantProperties" | "/api/app/kosdev.ddk/copyLogs/eraseAndCopy/{id}" | "/api/app/kosdev.ddk/copyLogs/{id}" | "/api/app/tccc.fits/session/pop/all" | "/api/app/tccc.fits/session/pop/include/{type}" | "/api/app/tccc.fits/session/pop/to/{type}" | "/api/app/tccc.fits/session/data/{key}">(endpoint: K_1, params?: (paths[K_1]["post"] extends {
+    post: <K_1 extends "/api/kos/browser/{nodeId}" | "/api/kos/browser/{nodeId}/{name}" | "/api/kos/browser/intent" | "/api/kos/browser/url" | "/api/kos/ota/resume/{name}" | "/api/kos/ota/cancel" | "/api/kos/ota/cancel/{name}" | "/api/kos/ota/pause/{name}" | "/api/kos/time/date" | "/api/kos/time/timezone" | "/api/kos/time/time" | "/api/kos/future/{futureId}/cancel" | "/api/kos/config/{path}" | "/api/kos/config/bulk" | "/api/kos/update/install" | "/api/kos/nodeMgr/reboot" | "/api/kos/nodeMgr/node/{nodeId}/reboot" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests/{manifestId}" | "/api/kos/nodeMgr/blockedManifests/{manifestId}" | "/api/kos/device/serialNumber/{serialNum}" | "/api/kos/troubles/resolve" | "/api/kos/troubles/resolve/{troubleId}" | "/api/kos/logs/node/{nodeId}/{stream}/subscribe" | "/api/kos/logs/node/{nodeId}/{stream}/unsubscribe" | "/api/kos/logs/overrides" | "/api/kos/criticalData/data" | "/api/kos/criticalData/data/{name}">(endpoint: K_1, params?: (paths[K_1]["post"] extends {
         parameters: infer P_1;
     } ? P_1 : never) | undefined, body?: (paths[K_1]["post"] extends {
         requestBody: {
@@ -46,7 +46,7 @@ declare const api: {
         studio?: boolean | undefined;
         signal?: AbortSignal | undefined;
     } | undefined) => Promise<import('../../core').ServiceResponse<import('../../core').ClientResponse<paths, K_2, "put">>>;
-    delete: <K_3 extends "/api/kos/criticalData/data/{name}" | "/api/app/tccc.fits/medusa/profiles/{profileId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/recipes/{name}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/tests/{testId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/blocks" | "/api/app/tccc.fits/medusa/profiles/{profileId}/builder/bevs/{bevId}" | "/api/app/tccc.fits/medusa/profiles/{profileId}/results/{resultsId}" | "/api/kos/logs/overrides" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests/{manifestId}" | "/api/kos/nodeMgr/blockedManifests/{manifestId}" | "/api/app/tccc.fits/scales/{serialNum}" | "/api/ext/dispense/nozzle/nozzle/pipeline/beverage/select" | "/api/ext/dispense/metrics/{name}" | "/api/ext/dispense/metrics/{nozzle}/{name}" | "/api/ext/dispense/assignments/{holderPath}" | "/api/app/kosdev.ddk/copyLogs/{id}" | "/api/app/tccc.fits/session/data/{key}">(endpoint: K_3, params?: (paths[K_3]["delete"] extends {
+    delete: <K_3 extends "/api/kos/nodeMgr/node/{nodeId}/blockedManifests" | "/api/kos/nodeMgr/node/{nodeId}/blockedManifests/{manifestId}" | "/api/kos/nodeMgr/blockedManifests/{manifestId}" | "/api/kos/logs/overrides" | "/api/kos/criticalData/data/{name}">(endpoint: K_3, params?: (paths[K_3]["delete"] extends {
         parameters: infer P_3;
     } ? P_3 : never) | undefined, options?: {
         ordered?: boolean | undefined;

package/models/utils/types.d.ts

@@ -292,7 +292,7 @@ export interface paths {
             cookie?: never;
         };
         /** Return schema data about all known config data. This describes the structure of every known
-         *     ConfigBean. This is used by kOS Studio tools. (v1.0) */
+         *     ConfigBean. This is used by KOS Studio tools. (v1.0) */
         get: {
             parameters: {
                 query?: never;
@@ -329,7 +329,7 @@ export interface paths {
             cookie?: never;
         };
         /** Return schema data about the ConfigBean identified by the handle path. This describes
-         *     the structure of the config bean for use by tools in kOS Studio. (v1.0) */
+         *     the structure of the config bean for use by tools in KOS Studio. (v1.0) */
         get: {
             parameters: {
                 query?: never;
@@ -451,7 +451,7 @@ export interface paths {
          *     useful for tooling and for inspecting what changes have been persisted in the config
          *     service.
          *
-         *     A stock kOS install defines default values as the initial values of a config bean as
+         *     A stock KOS install defines default values as the initial values of a config bean as
          *     set in the bean constructor with any values from system xml files loaded on top.
          *     Override values are any changes applied via endpoints which are persisted in the database.
          *