@contentstack/studio-internal 0.0.2
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/README.md +79 -0
- package/dist/constants/condition.d.ts +4513 -0
- package/dist/constants/condition.d.ts.map +1 -0
- package/dist/constants/condition.js +150 -0
- package/dist/constants/condition.js.map +1 -0
- package/dist/core/apply.d.ts +3 -0
- package/dist/core/apply.d.ts.map +1 -0
- package/dist/core/apply.js +41 -0
- package/dist/core/apply.js.map +1 -0
- package/dist/core/batch-dirty-paths.d.ts +4 -0
- package/dist/core/batch-dirty-paths.d.ts.map +1 -0
- package/dist/core/batch-dirty-paths.js +7 -0
- package/dist/core/batch-dirty-paths.js.map +1 -0
- package/dist/core/get-dirty-paths.d.ts +4 -0
- package/dist/core/get-dirty-paths.d.ts.map +1 -0
- package/dist/core/get-dirty-paths.js +45 -0
- package/dist/core/get-dirty-paths.js.map +1 -0
- package/dist/core/index.d.ts +5 -0
- package/dist/core/index.d.ts.map +1 -0
- package/dist/core/normalize-node.d.ts +4 -0
- package/dist/core/normalize-node.d.ts.map +1 -0
- package/dist/core/normalize-node.js +16 -0
- package/dist/core/normalize-node.js.map +1 -0
- package/dist/core/should-normalize.d.ts +4 -0
- package/dist/core/should-normalize.d.ts.map +1 -0
- package/dist/core/should-normalize.js +10 -0
- package/dist/core/should-normalize.js.map +1 -0
- package/dist/core/update-dirty-paths.d.ts +3 -0
- package/dist/core/update-dirty-paths.d.ts.map +1 -0
- package/dist/core/update-dirty-paths.js +37 -0
- package/dist/core/update-dirty-paths.js.map +1 -0
- package/dist/create-editor.d.ts +3 -0
- package/dist/create-editor.d.ts.map +1 -0
- package/dist/create-editor.js +102 -0
- package/dist/create-editor.js.map +1 -0
- package/dist/editor/index.d.ts +11 -0
- package/dist/editor/index.d.ts.map +1 -0
- package/dist/editor/is-editor.d.ts +3 -0
- package/dist/editor/is-editor.d.ts.map +1 -0
- package/dist/editor/is-editor.js +17 -0
- package/dist/editor/is-editor.js.map +1 -0
- package/dist/editor/is-normalizing.d.ts +3 -0
- package/dist/editor/is-normalizing.d.ts.map +1 -0
- package/dist/editor/is-normalizing.js +9 -0
- package/dist/editor/is-normalizing.js.map +1 -0
- package/dist/editor/node.d.ts +3 -0
- package/dist/editor/node.d.ts.map +1 -0
- package/dist/editor/node.js +11 -0
- package/dist/editor/node.js.map +1 -0
- package/dist/editor/nodes.d.ts +4 -0
- package/dist/editor/nodes.d.ts.map +1 -0
- package/dist/editor/nodes.js +63 -0
- package/dist/editor/nodes.js.map +1 -0
- package/dist/editor/normalize.d.ts +3 -0
- package/dist/editor/normalize.d.ts.map +1 -0
- package/dist/editor/normalize.js +54 -0
- package/dist/editor/normalize.js.map +1 -0
- package/dist/editor/path-refs.d.ts +3 -0
- package/dist/editor/path-refs.d.ts.map +1 -0
- package/dist/editor/path-refs.js +13 -0
- package/dist/editor/path-refs.js.map +1 -0
- package/dist/editor/pathRef.d.ts +3 -0
- package/dist/editor/pathRef.d.ts.map +1 -0
- package/dist/editor/pathRef.js +25 -0
- package/dist/editor/pathRef.js.map +1 -0
- package/dist/editor/set-active-context.d.ts +3 -0
- package/dist/editor/set-active-context.d.ts.map +1 -0
- package/dist/editor/set-active-context.js +10 -0
- package/dist/editor/set-active-context.js.map +1 -0
- package/dist/editor/set-normalizing.d.ts +3 -0
- package/dist/editor/set-normalizing.d.ts.map +1 -0
- package/dist/editor/set-normalizing.js +8 -0
- package/dist/editor/set-normalizing.js.map +1 -0
- package/dist/editor/unsaved-changes.d.ts +4 -0
- package/dist/editor/unsaved-changes.d.ts.map +1 -0
- package/dist/editor/unsaved-changes.js +11 -0
- package/dist/editor/unsaved-changes.js.map +1 -0
- package/dist/editor/without-normalizing.d.ts +3 -0
- package/dist/editor/without-normalizing.d.ts.map +1 -0
- package/dist/editor/without-normalizing.js +19 -0
- package/dist/editor/without-normalizing.js.map +1 -0
- package/dist/index.d.ts +5190 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +36 -0
- package/dist/index.js.map +1 -0
- package/dist/interfaces/editor.d.ts +103 -0
- package/dist/interfaces/editor.d.ts.map +1 -0
- package/dist/interfaces/editor.js +43 -0
- package/dist/interfaces/editor.js.map +1 -0
- package/dist/interfaces/get-default-node-styles.d.ts +3 -0
- package/dist/interfaces/get-default-node-styles.d.ts.map +1 -0
- package/dist/interfaces/get-default-node-styles.js +9 -0
- package/dist/interfaces/get-default-node-styles.js.map +1 -0
- package/dist/interfaces/index.d.ts +7 -0
- package/dist/interfaces/index.d.ts.map +1 -0
- package/dist/interfaces/node.d.ts +182 -0
- package/dist/interfaces/node.d.ts.map +1 -0
- package/dist/interfaces/node.js +158 -0
- package/dist/interfaces/node.js.map +1 -0
- package/dist/interfaces/operation.d.ts +86 -0
- package/dist/interfaces/operation.d.ts.map +1 -0
- package/dist/interfaces/operation.js +117 -0
- package/dist/interfaces/operation.js.map +1 -0
- package/dist/interfaces/path-ref.d.ts +15 -0
- package/dist/interfaces/path-ref.d.ts.map +1 -0
- package/dist/interfaces/path-ref.js +18 -0
- package/dist/interfaces/path-ref.js.map +1 -0
- package/dist/interfaces/path.d.ts +56 -0
- package/dist/interfaces/path.d.ts.map +1 -0
- package/dist/interfaces/path.js +205 -0
- package/dist/interfaces/path.js.map +1 -0
- package/dist/interfaces/transforms/general.d.ts +9 -0
- package/dist/interfaces/transforms/general.d.ts.map +1 -0
- package/dist/interfaces/transforms/general.js +125 -0
- package/dist/interfaces/transforms/general.js.map +1 -0
- package/dist/interfaces/transforms/index.d.ts +4 -0
- package/dist/interfaces/transforms/index.d.ts.map +1 -0
- package/dist/interfaces/transforms/index.js +10 -0
- package/dist/interfaces/transforms/index.js.map +1 -0
- package/dist/interfaces/transforms/node.d.ts +107 -0
- package/dist/interfaces/transforms/node.d.ts.map +1 -0
- package/dist/interfaces/transforms/node.js +50 -0
- package/dist/interfaces/transforms/node.js.map +1 -0
- package/dist/transforms-node/index.d.ts +15 -0
- package/dist/transforms-node/index.d.ts.map +1 -0
- package/dist/transforms-node/insert-nodes.d.ts +3 -0
- package/dist/transforms-node/insert-nodes.d.ts.map +1 -0
- package/dist/transforms-node/insert-nodes.js +45 -0
- package/dist/transforms-node/insert-nodes.js.map +1 -0
- package/dist/transforms-node/insert-slot.d.ts +3 -0
- package/dist/transforms-node/insert-slot.d.ts.map +1 -0
- package/dist/transforms-node/insert-slot.js +18 -0
- package/dist/transforms-node/insert-slot.js.map +1 -0
- package/dist/transforms-node/lift-nodes.d.ts +3 -0
- package/dist/transforms-node/lift-nodes.d.ts.map +1 -0
- package/dist/transforms-node/lift-nodes.js +38 -0
- package/dist/transforms-node/lift-nodes.js.map +1 -0
- package/dist/transforms-node/move-nodes.d.ts +3 -0
- package/dist/transforms-node/move-nodes.d.ts.map +1 -0
- package/dist/transforms-node/move-nodes.js +21 -0
- package/dist/transforms-node/move-nodes.js.map +1 -0
- package/dist/transforms-node/remove-nodes.d.ts +3 -0
- package/dist/transforms-node/remove-nodes.d.ts.map +1 -0
- package/dist/transforms-node/remove-nodes.js +20 -0
- package/dist/transforms-node/remove-nodes.js.map +1 -0
- package/dist/transforms-node/set-classes.d.ts +3 -0
- package/dist/transforms-node/set-classes.d.ts.map +1 -0
- package/dist/transforms-node/set-classes.js +48 -0
- package/dist/transforms-node/set-classes.js.map +1 -0
- package/dist/transforms-node/set-nodes.d.ts +3 -0
- package/dist/transforms-node/set-nodes.d.ts.map +1 -0
- package/dist/transforms-node/set-nodes.js +50 -0
- package/dist/transforms-node/set-nodes.js.map +1 -0
- package/dist/transforms-node/set-props.d.ts +3 -0
- package/dist/transforms-node/set-props.d.ts.map +1 -0
- package/dist/transforms-node/set-props.js +74 -0
- package/dist/transforms-node/set-props.js.map +1 -0
- package/dist/transforms-node/set-responsive-styles.d.ts +3 -0
- package/dist/transforms-node/set-responsive-styles.d.ts.map +1 -0
- package/dist/transforms-node/set-responsive-styles.js +41 -0
- package/dist/transforms-node/set-responsive-styles.js.map +1 -0
- package/dist/transforms-node/set-selection.d.ts +3 -0
- package/dist/transforms-node/set-selection.d.ts.map +1 -0
- package/dist/transforms-node/set-selection.js +21 -0
- package/dist/transforms-node/set-selection.js.map +1 -0
- package/dist/transforms-node/unset-classes.d.ts +3 -0
- package/dist/transforms-node/unset-classes.d.ts.map +1 -0
- package/dist/transforms-node/unset-classes.js +32 -0
- package/dist/transforms-node/unset-classes.js.map +1 -0
- package/dist/transforms-node/unset-props.d.ts +3 -0
- package/dist/transforms-node/unset-props.d.ts.map +1 -0
- package/dist/transforms-node/unset-props.js +35 -0
- package/dist/transforms-node/unset-props.js.map +1 -0
- package/dist/transforms-node/unset-responsive-styles.d.ts +3 -0
- package/dist/transforms-node/unset-responsive-styles.d.ts.map +1 -0
- package/dist/transforms-node/unset-responsive-styles.js +38 -0
- package/dist/transforms-node/unset-responsive-styles.js.map +1 -0
- package/dist/transforms-node/unwrap-nodes.d.ts +3 -0
- package/dist/transforms-node/unwrap-nodes.d.ts.map +1 -0
- package/dist/transforms-node/unwrap-nodes.js +19 -0
- package/dist/transforms-node/unwrap-nodes.js.map +1 -0
- package/dist/transforms-node/wrap-nodes.d.ts +3 -0
- package/dist/transforms-node/wrap-nodes.d.ts.map +1 -0
- package/dist/transforms-node/wrap-nodes.js +23 -0
- package/dist/transforms-node/wrap-nodes.js.map +1 -0
- package/dist/types/condition-types.d.ts +70 -0
- package/dist/types/condition-types.d.ts.map +1 -0
- package/dist/types/custom-types.d.ts +10 -0
- package/dist/types/custom-types.d.ts.map +1 -0
- package/dist/types/index.d.ts +4 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/types.d.ts +12 -0
- package/dist/types/types.d.ts.map +1 -0
- package/dist/utils/index.d.ts +2 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/index.js +6 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/is-plain-object.d.ts +9 -0
- package/dist/utils/is-plain-object.d.ts.map +1 -0
- package/dist/utils/is-plain-object.js +32 -0
- package/dist/utils/is-plain-object.js.map +1 -0
- package/dist/utils/match-path.d.ts +5 -0
- package/dist/utils/match-path.d.ts.map +1 -0
- package/dist/utils/types.d.ts +3 -0
- package/dist/utils/types.d.ts.map +1 -0
- package/dist/utils/weak-maps.d.ts +8 -0
- package/dist/utils/weak-maps.d.ts.map +1 -0
- package/dist/utils/weak-maps.js +9 -0
- package/dist/utils/weak-maps.js.map +1 -0
- package/package.json +52 -0
package/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Studio Internal
|
|
2
|
+
|
|
3
|
+
> Core editor engine for the Studio visual builder platform
|
|
4
|
+
|
|
5
|
+
<details>
|
|
6
|
+
<summary>Table of Contents</summary>
|
|
7
|
+
|
|
8
|
+
- [Studio Internal](#studio-internal)
|
|
9
|
+
- [Overview](#overview)
|
|
10
|
+
- [What it does](#what-it-does)
|
|
11
|
+
- [Key Features](#key-features)
|
|
12
|
+
- [**Editor Core**](#editor-core)
|
|
13
|
+
- [**Visual Builder Capabilities**](#visual-builder-capabilities)
|
|
14
|
+
- [**Node Transformations**](#node-transformations)
|
|
15
|
+
- [**Operation System**](#operation-system)
|
|
16
|
+
- [Architecture](#architecture)
|
|
17
|
+
- [Use Cases](#use-cases)
|
|
18
|
+
- [Integration](#integration)
|
|
19
|
+
|
|
20
|
+
</details>
|
|
21
|
+
|
|
22
|
+
# Overview
|
|
23
|
+
|
|
24
|
+
`studio-internal` is the foundational editor engine that powers the Studio. It's a custom implementation inspired by Slate.js, specifically designed for page building and component composition.
|
|
25
|
+
|
|
26
|
+
# What it does
|
|
27
|
+
|
|
28
|
+
This package provides a complete editor system for managing hierarchical component structures, responsive styles, and interactive editing operations. It serves as the core data model and transformation engine for visual page builders.
|
|
29
|
+
|
|
30
|
+
# Key Features
|
|
31
|
+
|
|
32
|
+
## **Editor Core**
|
|
33
|
+
- Custom Slate.js-inspired editor implementation
|
|
34
|
+
- Hierarchical node management with parent-child relationships
|
|
35
|
+
- Slot-based component system for flexible layouts
|
|
36
|
+
- Operation-based state management with history tracking
|
|
37
|
+
|
|
38
|
+
## **Visual Builder Capabilities**
|
|
39
|
+
- **Responsive Styles**: Manage breakpoint-specific styling
|
|
40
|
+
- **CSS Classes**: Dynamic class assignment and management
|
|
41
|
+
- **Component Properties**: Flexible prop system for component configuration
|
|
42
|
+
- **Slot Management**: Insert and manage component slots for dynamic content
|
|
43
|
+
|
|
44
|
+
## **Node Transformations**
|
|
45
|
+
- **Insert/Remove**: Add and delete components from the page
|
|
46
|
+
- **Move/Lift**: Reposition components within the hierarchy
|
|
47
|
+
- **Wrap/Unwrap**: Group and ungroup components
|
|
48
|
+
- **Selection Management**: Track and manage user selections
|
|
49
|
+
- **Path References**: Maintain stable references during operations
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
## **Operation System**
|
|
53
|
+
- **Operation Serialization**: Transfer operations between contexts
|
|
54
|
+
- **History Management**: Undo/redo functionality
|
|
55
|
+
- **Batch Operations**: Efficient bulk transformations
|
|
56
|
+
- **Change Detection**: Optimized re-rendering
|
|
57
|
+
|
|
58
|
+
# Architecture
|
|
59
|
+
|
|
60
|
+
The editor follows a plugin-based architecture with:
|
|
61
|
+
|
|
62
|
+
- **Core Engine**: Base editor functionality and state management
|
|
63
|
+
- **Transform Plugins**: Node manipulation operations
|
|
64
|
+
- **Interface Layer**: Type-safe API definitions
|
|
65
|
+
- **Utility Functions**: Helper functions for common operations
|
|
66
|
+
|
|
67
|
+
# Use Cases
|
|
68
|
+
|
|
69
|
+
- **Visual Page Builders**: Drag-and-drop page composition
|
|
70
|
+
- **Component Editors**: Nested component editing
|
|
71
|
+
- **Style Management**: Responsive design tools
|
|
72
|
+
- **Content Management**: Dynamic content insertion and editing
|
|
73
|
+
|
|
74
|
+
# Integration
|
|
75
|
+
|
|
76
|
+
This package is designed to be consumed by higher-level packages like:
|
|
77
|
+
- `studio-react` - React integration layer
|
|
78
|
+
- `studio-client` - Client-side SDK
|
|
79
|
+
- `studio-registry` - Component registry system
|