@synapticon/motion-master-client 6.0.0-alpha.76 → 6.0.0-alpha.78

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.
@@ -50,7 +50,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
50
50
  */
51
51
  getSwaggerYml: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<string, any>>;
52
52
  /**
53
- * @description The effective configuration after merging the JSONC config file (if any) over the built-in defaults — the same `Config` the server booted with. The config file is either the one passed via `--config` or a `motion-master.jsonc` auto-discovered next to the executable (`--config` wins). Read-only; changing it requires editing the config file and restarting. The shape mirrors the config file (server, fieldbus, logLevel, tls, gameLoop, recorder, parameterCache, parameters).
53
+ * @description The effective configuration after merging the JSONC config file (if any) over the built-in defaults — the same `Config` the server booted with. The config file is either the one passed via `--config` or a `motion-master.jsonc` auto-discovered next to the executable (`--config` wins). Read-only; changing it requires editing the config file and restarting. The shape mirrors the config file (server, fieldbus, logging, tls, gameLoop, recorder, parameterCache, parameters).
54
54
  *
55
55
  * @name GetStartedConfig
56
56
  * @summary Get the configuration Motion Master was started with
@@ -1504,7 +1504,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
1504
1504
  size: number;
1505
1505
  }, void>>;
1506
1506
  /**
1507
- * @description Removes a file, or a directory and everything under it. Directories left empty between the removed path and the cache root are pruned, so no husks remain.
1507
+ * @description Removes a file, or a directory and everything under it. Directories left empty between the removed path and the cache root are pruned, so no husks remain. A file the running server holds open is refused — see `deletable` on `UserCacheFile`.
1508
1508
  *
1509
1509
  * @name DeleteUserCacheFile
1510
1510
  * @summary Delete a user-cache file or directory
@@ -50,7 +50,7 @@ export class Api extends HttpClient {
50
50
  ...params,
51
51
  });
52
52
  /**
53
- * @description The effective configuration after merging the JSONC config file (if any) over the built-in defaults — the same `Config` the server booted with. The config file is either the one passed via `--config` or a `motion-master.jsonc` auto-discovered next to the executable (`--config` wins). Read-only; changing it requires editing the config file and restarting. The shape mirrors the config file (server, fieldbus, logLevel, tls, gameLoop, recorder, parameterCache, parameters).
53
+ * @description The effective configuration after merging the JSONC config file (if any) over the built-in defaults — the same `Config` the server booted with. The config file is either the one passed via `--config` or a `motion-master.jsonc` auto-discovered next to the executable (`--config` wins). Read-only; changing it requires editing the config file and restarting. The shape mirrors the config file (server, fieldbus, logging, tls, gameLoop, recorder, parameterCache, parameters).
54
54
  *
55
55
  * @name GetStartedConfig
56
56
  * @summary Get the configuration Motion Master was started with
@@ -1119,7 +1119,7 @@ export class Api extends HttpClient {
1119
1119
  ...params,
1120
1120
  });
1121
1121
  /**
1122
- * @description Removes a file, or a directory and everything under it. Directories left empty between the removed path and the cache root are pruned, so no husks remain.
1122
+ * @description Removes a file, or a directory and everything under it. Directories left empty between the removed path and the cache root are pruned, so no husks remain. A file the running server holds open is refused — see `deletable` on `UserCacheFile`.
1123
1123
  *
1124
1124
  * @name DeleteUserCacheFile
1125
1125
  * @summary Delete a user-cache file or directory
@@ -191,6 +191,11 @@ export interface UserCacheFile {
191
191
  * @example 1783968687738
192
192
  */
193
193
  modifiedMs: number;
194
+ /**
195
+ * Whether `DELETE` will accept this path. False for a file the running server holds open — today only its own log file, `logs/motion-master.log`. Deleting such a file cannot do what it appears to (Windows refuses; Linux and macOS unlink it while the server keeps writing to it, reclaiming nothing), so the request is refused with `409 Conflict` and a client should not offer the action. Rotated copies are closed and remain deletable, which is how the space is reclaimed.
196
+ * @example true
197
+ */
198
+ deletable: boolean;
194
199
  }
195
200
  /** Summary of one on-disk parameter-cache file (its identity, size, and count). */
196
201
  export interface ParameterCacheEntry {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@synapticon/motion-master-client",
3
- "version": "6.0.0-alpha.76",
3
+ "version": "6.0.0-alpha.78",
4
4
  "description": "Isomorphic TypeScript client for Motion Master: the generated HTTP API client, the WebSocket connection, and helpers.",
5
5
  "license": "MIT",
6
6
  "repository": {