@cesdk/engine 1.60.0-nightly.20250903 → 1.60.0-nightly.20250905

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/index.d.ts CHANGED
@@ -8087,41 +8087,15 @@ export declare type SettingKey = keyof Settings;
8087
8087
  * Map of all available settings with their types.
8088
8088
  * This provides type-safe access to all editor settings.
8089
8089
  *
8090
- * @public
8090
+ * The settings are organized by type:
8091
+ * - Boolean settings control various on/off features in the editor
8092
+ * - String settings configure paths and textual values
8093
+ * - Float settings define numerical thresholds and limits
8094
+ * - Integer settings specify whole number limits
8095
+ * - Color settings control the visual appearance
8096
+ * - Enum settings provide predefined choice options
8091
8097
  *
8092
- * @categoryDescription Boolean Settings
8093
- * Boolean settings control various on/off features in the editor:
8094
- * - Control gizmo visibility settings (crop, move, resize, rotate, scale handles)
8095
- * - Feature flags (single page mode, page carousel, animations)
8096
- * - Interaction permissions (mouse scroll/zoom, touch gestures, page interactions)
8097
- * - Display options (build version, placeholders, page titles)
8098
- *
8099
- * @categoryDescription String Settings
8100
- * String settings configure paths and textual values:
8101
- * - Resource paths (base path, font URIs)
8102
- * - License configuration
8103
- * - Title formatting (separator, font)
8104
- *
8105
- * @categoryDescription Float Settings
8106
- * Float settings define numerical thresholds and limits:
8107
- * - Snapping thresholds for position and rotation
8108
- * - Scale limits for control gizmos
8109
- *
8110
- * @categoryDescription Integer Settings
8111
- * Integer settings specify whole number limits:
8112
- * - Maximum image size constraints
8113
- *
8114
- * @categoryDescription Color Settings
8115
- * Color settings control the visual appearance:
8116
- * - UI element colors (borders, overlays, highlights)
8117
- * - Guide colors (snapping, rotation, rule of thirds)
8118
- * - State colors (error, progress, placeholder highlights)
8119
- *
8120
- * @categoryDescription Enum Settings
8121
- * Enum settings provide predefined choice options:
8122
- * - Selection modes
8123
- * - Touch gesture actions
8124
- * - Camera behavior modes
8098
+ * @public
8125
8099
  */
8126
8100
  export declare interface Settings {
8127
8101
  /** Whether to show handles for adjusting the crop area during crop mode. */
@@ -8271,6 +8245,7 @@ export declare interface Settings {
8271
8245
  *
8272
8246
  * @deprecated Use keyof Settings or extract the boolean keys from Settings instead.
8273
8247
  * @public
8248
+ * @category Boolean Settings
8274
8249
  */
8275
8250
  export declare type SettingsBool = {
8276
8251
  [K in keyof Settings]: Settings[K] extends boolean ? K : never;
@@ -8281,6 +8256,7 @@ export declare type SettingsBool = {
8281
8256
  *
8282
8257
  * @deprecated Use keyof Settings or extract the color keys from Settings instead.
8283
8258
  * @public
8259
+ * @category Color Settings
8284
8260
  */
8285
8261
  export declare type SettingsColor = {
8286
8262
  [K in keyof Settings]: Settings[K] extends Color ? K : never;
@@ -8291,6 +8267,7 @@ export declare type SettingsColor = {
8291
8267
  *
8292
8268
  * @public
8293
8269
  * @deprecated Use SettingsColor instead.
8270
+ * @category Color Settings
8294
8271
  */
8295
8272
  export declare type SettingsColorRGBA = SettingsColor;
8296
8273
 
@@ -8299,6 +8276,7 @@ export declare type SettingsColorRGBA = SettingsColor;
8299
8276
  *
8300
8277
  * @deprecated Use keyof Settings or extract the enum keys from Settings instead.
8301
8278
  * @public
8279
+ * @category Enum Settings
8302
8280
  */
8303
8281
  export declare type SettingsEnum = Pick<Settings, 'doubleClickSelectionMode' | 'touch/pinchAction' | 'touch/rotateAction' | 'camera/clamping/overshootMode'>;
8304
8282
 
@@ -8307,6 +8285,7 @@ export declare type SettingsEnum = Pick<Settings, 'doubleClickSelectionMode' | '
8307
8285
  *
8308
8286
  * @deprecated Use keyof Settings or extract the float keys from Settings instead.
8309
8287
  * @public
8288
+ * @category Float Settings
8310
8289
  */
8311
8290
  export declare type SettingsFloat = Exclude<{
8312
8291
  [K in keyof Settings]: Settings[K] extends number ? K : never;
@@ -8316,6 +8295,7 @@ export declare type SettingsFloat = Exclude<{
8316
8295
  * Represents the integer settings available in the editor.
8317
8296
  *
8318
8297
  * @public
8298
+ * @category Integer Settings
8319
8299
  */
8320
8300
  export declare type SettingsInt = 'maxImageSize';
8321
8301
 
@@ -8324,6 +8304,7 @@ export declare type SettingsInt = 'maxImageSize';
8324
8304
  *
8325
8305
  * @deprecated Use keyof Settings or extract the string keys from Settings instead.
8326
8306
  * @public
8307
+ * @category String Settings
8327
8308
  */
8328
8309
  export declare type SettingsString = Exclude<{
8329
8310
  [K in keyof Settings]: Settings[K] extends string ? K : never;