From f923fc934bf5be6428bddb5ed7d0ff4d1ac5752d Mon Sep 17 00:00:00 2001 From: Korenevskiy Denis Date: Mon, 18 May 2026 16:43:51 +0300 Subject: [PATCH 1/2] chore: add README describing the purpose of pl-model-common package --- .changeset/major-clocks-cheer.md | 2 ++ lib/model/common/README.md | 15 +++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 .changeset/major-clocks-cheer.md create mode 100644 lib/model/common/README.md diff --git a/.changeset/major-clocks-cheer.md b/.changeset/major-clocks-cheer.md new file mode 100644 index 0000000000..a845151cc8 --- /dev/null +++ b/.changeset/major-clocks-cheer.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/lib/model/common/README.md b/lib/model/common/README.md new file mode 100644 index 0000000000..3308e92aef --- /dev/null +++ b/lib/model/common/README.md @@ -0,0 +1,15 @@ +# What is it for? + +The purpose of this package is to keep primitives and functions, that have to be shared between all our execution contexts: + +- node +- quickjs sandbox +- browser +- browser preload + +We have code that can work in single specific context (like UI of the block) or in a mixture of contexts. + +This package is a meeting point for code that can exist in all possible places. + +- NEVER put context-dependent code here. This may (and probably will) ruin the build in some other place (i.e. Desktop App). +- Keep list of dependencies limited and clear. Each new dependency is a moment to think wether you really need it. From 3b9eecb504e2ab24613e664b98253c4671799a24 Mon Sep 17 00:00:00 2001 From: Denis Korenevskiy Date: Tue, 19 May 2026 11:28:26 +0300 Subject: [PATCH 2/2] Update lib/model/common/README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- lib/model/common/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/model/common/README.md b/lib/model/common/README.md index 3308e92aef..fe71d24f1b 100644 --- a/lib/model/common/README.md +++ b/lib/model/common/README.md @@ -7,7 +7,7 @@ The purpose of this package is to keep primitives and functions, that have to be - browser - browser preload -We have code that can work in single specific context (like UI of the block) or in a mixture of contexts. +We have code that can work in a single specific context (like UI of the block) or in a mixture of contexts. This package is a meeting point for code that can exist in all possible places.