@loro-extended/change 5.2.0 → 5.3.0

package/dist/index.d.ts

@@ -1195,6 +1195,27 @@ interface RecordContainerShape<NestedShape extends ContainerOrValueShape = Conta
 interface AnyContainerShape extends Shape<unknown, unknown, undefined> {
     readonly _type: "any";
 }
+/**
+ * Union of all container shape types.
+ *
+ * Each container shape has a `_mutable` type parameter that maps to the
+ * corresponding TypedRef class (e.g., TextContainerShape → TextRef).
+ * This enables deriving ref types from shapes:
+ *
+ * ```typescript
+ * // Get the ref type for any container shape
+ * type RefType = ContainerShape["_mutable"]
+ *
+ * // Exclude AnyContainerShape to get only typed refs
+ * type AnyTypedRef = Exclude<ContainerShape, AnyContainerShape>["_mutable"]
+ * ```
+ *
+ * This creates intentional parallel hierarchies:
+ * - ContainerShape → defines what data looks like (schema)
+ * - TypedRef (via _mutable) → defines how you interact with data
+ * - loro() overloads → CRDT escape hatch (IDE DX)
+ * - change() overloads → mutation boundaries (IDE DX)
+ */
 type ContainerShape = AnyContainerShape | CounterContainerShape | ListContainerShape | MovableListContainerShape | RecordContainerShape | StructContainerShape | TextContainerShape | TreeContainerShape;
 type ContainerType = ContainerShape["_type"];
 interface StringValueShape<T extends string = string> extends Shape<T, T, T> {