@unseenco/theatre-core 0.1.17 → 0.2.0

package/dist/index.d.ts

@@ -225,6 +225,11 @@ type Keyframe = {
     handles: [leftX: number, leftY: number, rightX: number, rightY: number];
     connectedRight: boolean;
     type?: KeyframeType;
+    /**
+     * Optional label for the tween to the right of this keyframe.
+     * Only meaningful when {@link connectedRight} is true.
+     */
+    tweenLabel?: string;
 };
 type TrackDataCommon<TypeName extends string> = {
     type: TypeName;
@@ -376,6 +381,9 @@ declare const image: (defaultValue: Asset['id'], opts?: {
  * // With custom nudging
  * const x = t.number(0, {nudgeMultiplier: 0.1}) // nudging will happen in 0.1 increments
  *
+ * // With custom precision (decimal places shown/stored in Studio)
+ * const x = t.number(0, {precision: 2})
+ *
  * // With custom nudging function
  * const x = t.number({
  *   nudgeFn: (
@@ -401,6 +409,7 @@ declare const number: (defaultValue: number, opts?: {
     nudgeFn?: PropTypeConfig_Number['nudgeFn'];
     range?: PropTypeConfig_Number['range'];
     nudgeMultiplier?: number;
+    precision?: number;
     label?: string;
 }) => PropTypeConfig_Number;
 declare const rgba: (defaultValue?: Rgba, opts?: CommonOpts) => PropTypeConfig_Rgba;
@@ -572,6 +581,11 @@ interface PropTypeConfig_Number extends ISimplePropType<'number', number> {
      * See {@link defaultNumberNudgeFn} to see how `nudgeMultiplier` is treated.
      */
     nudgeMultiplier: number | undefined;
+    /**
+     * The number of decimal places to use for this prop in the Studio.
+     * Falls back to the project's `numberPrecision` config, then to 3.
+     */
+    precision?: number;
 }
 type NumberNudgeFn = (p: {
     deltaX: number;
@@ -1415,6 +1429,13 @@ type IProjectConfig = {
     assets?: {
         baseUrl?: string;
     };
+    /**
+     * The default number of decimal places to use for number props in the Studio.
+     * Can be overridden per prop via `types.number(defaultValue, {precision})`.
+     *
+     * @defaultValue 3
+     */
+    numberPrecision?: number;
 };
 /**
  * A Theatre.js project

package/dist/index.js

@@ -3455,6 +3455,15 @@ var number = (defaultValue, opts = {}) => {
           );
         }
       }
+      if (Object.prototype.hasOwnProperty.call(opts, "precision")) {
+        if (typeof opts.precision !== "number" || !isFinite(opts.precision) || opts.precision < 0 || Math.floor(opts.precision) !== opts.precision) {
+          throw new Error(
+            "opts.precision in t.number(defaultValue, opts) must be a non-negative integer. ".concat(userReadableTypeOfValue_default(
+              opts.precision
+            ), " given.")
+          );
+        }
+      }
     }
   }
   return {
@@ -3466,6 +3475,7 @@ var number = (defaultValue, opts = {}) => {
     label: opts.label,
     nudgeFn: opts.nudgeFn ?? defaultNumberNudgeFn,
     nudgeMultiplier: typeof opts.nudgeMultiplier === "number" ? opts.nudgeMultiplier : void 0,
+    precision: typeof opts.precision === "number" ? opts.precision : void 0,
     interpolate: _interpolateNumber,
     deserializeAndSanitize: numberDeserializer(opts.range)
   };
@@ -5069,6 +5079,69 @@ function registerObjectPropConfig(projectId, sheetId, objectKey, config) {
   );
 }
 
+// shared/src/propTypes/numberPrecision.ts
+var DEFAULT_NUMBER_PRECISION = 3;
+function resolveNumberPrecision(propPrecision, projectPrecision) {
+  if (propPrecision !== void 0)
+    return propPrecision;
+  if (projectPrecision !== void 0)
+    return projectPrecision;
+  return DEFAULT_NUMBER_PRECISION;
+}
+function applyNumberPrecisionDefaultsToPropConfig(config, projectNumberPrecision) {
+  const defaultPrecision = resolveNumberPrecision(
+    void 0,
+    projectNumberPrecision
+  );
+  if (config.type === "number") {
+    if (config.precision !== void 0)
+      return config;
+    return {
+      ...config,
+      precision: defaultPrecision
+    };
+  }
+  if (config.type === "compound") {
+    return {
+      ...config,
+      props: mapCompoundProps(
+        config,
+        (subConfig) => applyNumberPrecisionDefaultsToPropConfig(
+          subConfig,
+          projectNumberPrecision
+        )
+      )
+    };
+  }
+  if (config.type === "enum") {
+    return {
+      ...config,
+      cases: mapEnumCases(
+        config,
+        (subConfig) => applyNumberPrecisionDefaultsToPropConfig(
+          subConfig,
+          projectNumberPrecision
+        )
+      )
+    };
+  }
+  return config;
+}
+function mapCompoundProps(config, fn2) {
+  const props = {};
+  for (const [key, subConfig] of Object.entries(config.props)) {
+    props[key] = fn2(subConfig);
+  }
+  return props;
+}
+function mapEnumCases(config, fn2) {
+  const cases = {};
+  for (const [key, subConfig] of Object.entries(config.cases)) {
+    cases[key] = fn2(subConfig);
+  }
+  return cases;
+}
+
 // core/src/sheetObjects/SheetObjectTemplate.ts
 function isObjectEmpty(obj) {
   return typeof obj === "object" && obj !== null && Object.keys(obj).length === 0;
@@ -5095,7 +5168,11 @@ var SheetObjectTemplate = class {
     __publicField(this, "_staticPropPaths", /* @__PURE__ */ new Set());
     __publicField(this, "_visibleInOutline", true);
     this.address = { ...sheetTemplate.address, objectKey };
-    this._config = new import_theatre_dataverse7.Atom(config);
+    const configWithPrecisionDefaults = this._withNumberPrecisionDefaults(
+      config,
+      sheetTemplate.project
+    );
+    this._config = new import_theatre_dataverse7.Atom(configWithPrecisionDefaults);
     this._temp_actions_atom = new import_theatre_dataverse7.Atom(_temp_actions);
     this.showPropsOf_atom = new import_theatre_dataverse7.Atom([]);
     this._transientPropPaths = normalizeTransientPropPaths(
@@ -5119,7 +5196,7 @@ var SheetObjectTemplate = class {
       this.address.projectId,
       this.address.sheetId,
       objectKey,
-      config
+      configWithPrecisionDefaults
     );
     this.pointerToSheetState = this.sheetTemplate.project.pointers.historic.sheetsById[this.address.sheetId];
     this.pointerToStaticOverrides = this.pointerToSheetState.staticOverrides.byObject[this.address.objectKey];
@@ -5132,6 +5209,12 @@ var SheetObjectTemplate = class {
   get staticConfig() {
     return this._config.get();
   }
+  _withNumberPrecisionDefaults(config, project = this.project) {
+    return applyNumberPrecisionDefaultsToPropConfig(
+      config,
+      project.config.numberPrecision
+    );
+  }
   get configPointer() {
     return this._config.pointer;
   }
@@ -5179,16 +5262,17 @@ var SheetObjectTemplate = class {
     );
   }
   createInstance(sheet, nativeObject, config) {
-    this._config.set(config);
+    this._config.set(this._withNumberPrecisionDefaults(config));
     return new SheetObject(sheet, this, nativeObject);
   }
   reconfigure(config) {
-    this._config.set(config);
+    const configWithPrecisionDefaults = this._withNumberPrecisionDefaults(config);
+    this._config.set(configWithPrecisionDefaults);
     this._stripNonPersistingPropsFromAhistoricState();
     this.project._stripPropsMissingFromConfig(
       this.address.sheetId,
       this.address.objectKey,
-      config
+      configWithPrecisionDefaults
     );
   }
   addProps(config) {
@@ -5201,10 +5285,12 @@ var SheetObjectTemplate = class {
         );
       }
     }
-    const merged = compoundFromSanitizedProps({
-      ...existing.props,
-      ...additional.props
-    });
+    const merged = this._withNumberPrecisionDefaults(
+      compoundFromSanitizedProps({
+        ...existing.props,
+        ...additional.props
+      })
+    );
     this._config.set(merged);
     registerObjectPropConfig(
       this.address.projectId,
@@ -8388,6 +8474,9 @@ function getProject(id, config = {}) {
   } else {
     plogger._debug("no config.state");
   }
+  if (process.env.NODE_ENV !== "production") {
+    validateProjectNumberPrecisionOrThrow(config.numberPrecision);
+  }
   return new TheatreProject(id, config);
 }
 var shallowValidateOnDiskState = (projectId, s2) => {
@@ -8402,6 +8491,17 @@ var shallowValidateOnDiskState = (projectId, s2) => {
 var deepValidateOnDiskState = (projectId, s2) => {
   shallowValidateOnDiskState(projectId, s2);
 };
+var validateProjectNumberPrecisionOrThrow = (numberPrecision) => {
+  if (numberPrecision === void 0)
+    return;
+  if (typeof numberPrecision !== "number" || !isFinite(numberPrecision) || numberPrecision < 0 || Math.floor(numberPrecision) !== numberPrecision) {
+    throw new InvalidArgumentError(
+      "Argument config.numberPrecision in Theatre.getProject(projectId, config) must be a non-negative integer. ".concat(userReadableTypeOfValue_default(
+        numberPrecision
+      ), " given.")
+    );
+  }
+};
 var validateProjectIdOrThrow = (value) => {
   if (typeof value !== "string") {
     throw new InvalidArgumentError(
@@ -8452,7 +8552,7 @@ var CoreBundle = class {
     return "Theatre_CoreBundle";
   }
   get version() {
-    return "0.1.17";
+    return "0.2.0";
   }
   getBitsForStudio(studio, callback) {
     if (this._studio) {