feat(interpreter): expose all interpreter store options and make avai…

…lable in useInterpreterStore
coltorapps · Jan 3, 2025 · 5b6ef19 · 5b6ef19
1 parent 8365d79
commit 5b6ef19
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 26 deletions.
diff --git a/docs/package.json b/docs/package.json
@@ -13,8 +13,8 @@
   "browserslist": "defaults, not ie <= 11",
   "dependencies": {
     "@algolia/autocomplete-core": "^1.9.2",
-    "@coltorapps/builder": "^0.2.1",
-    "@coltorapps/builder-react": "^0.2.1",
+    "@coltorapps/builder": "^0.2.2",
+    "@coltorapps/builder-react": "^0.2.2",
     "@dnd-kit/core": "^6.1.0",
     "@dnd-kit/modifiers": "^7.0.0",
     "@dnd-kit/sortable": "^8.0.0",

diff --git a/docs/src/app/docs/api/create-interpreter-store/page.md b/docs/src/app/docs/api/create-interpreter-store/page.md
@@ -50,10 +50,10 @@ In the example above, we've hardcoded the schema, but typically, you would retri
 
 The `options` parameter properties:
 
-| Property                            | Type                                                           | Description {% class="api-description" %}                                      |
-| ----------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------ |
-| `initialData`                       | {% badge content="object" /%} {% badge content="optional" /%}  | The optional partial initial data.                                             |
-| `initialEntitiesValuesWithDefaults` | {% badge content="boolean" /%} {% badge content="optional" /%} | A flag to disable the automatic setting of default values. Defaults to `true`. |
+| Property                            | Type                                                           | Description {% class="api-description" %}                                                |
+| ----------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `initialData`                       | {% badge content="object" /%} {% badge content="optional" /%}  | The optional partial initial data.                                                       |
+| `initialEntitiesValuesWithDefaults` | {% badge content="boolean" /%} {% badge content="optional" /%} | A flag to enable or disable the automatic setting of default values. Defaults to `true`. |
 
 ### Returns
 

diff --git a/docs/src/app/docs/api/react/use-interpreter-store/page.md b/docs/src/app/docs/api/react/use-interpreter-store/page.md
@@ -50,10 +50,11 @@ In the example above, we've hardcoded the schema, but typically, you would retri
 
 The `options` parameter properties:
 
-| Property      | Type                                                          | Description {% class="api-description" %}                                                              |
-| ------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
-| `initialData` | {% badge content="object" /%} {% badge content="optional" /%} | The optional partial initial data of the [interpreter store](/docs/api/create-interpreter-store#data). |
-| `events`      | {% badge content="object" /%} {% badge content="optional" /%} | An optional partial object with [events callbacks](#events-callbacks).                                 |
+| Property                            | Type                                                           | Description {% class="api-description" %}                                                              |
+| ----------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| `initialData`                       | {% badge content="object" /%} {% badge content="optional" /%}  | The optional partial initial data of the [interpreter store](/docs/api/create-interpreter-store#data). |
+| `initialEntitiesValuesWithDefaults` | {% badge content="boolean" /%} {% badge content="optional" /%} | A flag to enable or disable the automatic setting of default values. Defaults to `true`.               |
+| `events`                            | {% badge content="object" /%} {% badge content="optional" /%}  | An optional partial object with [events callbacks](#events-callbacks).                                 |
 
 ### Returns
 

diff --git a/packages/builder-react/CHANGELOG.md b/packages/builder-react/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @coltorapps/builder-react
 
+## 0.2.2
+
+### Patch Changes
+
+- Expose all interpreter store options and make them available in useInterpreterStore.
+
 ## 0.2.1
 
 ### Patch Changes

diff --git a/packages/builder-react/package.json b/packages/builder-react/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@coltorapps/builder-react",
   "private": false,
-  "version": "0.2.1",
+  "version": "0.2.2",
   "homepage": "https://builder.coltorapps.com/",
   "repository": {
     "type": "git",
@@ -32,7 +32,7 @@
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
   },
   "devDependencies": {
-    "@coltorapps/builder": "^0.2.1",
+    "@coltorapps/builder": "^0.2.2",
     "@coltorapps/eslint-config": "0.1.0",
     "@types/react": "^18.2.32",
     "eslint": "^8.52.0",
@@ -41,7 +41,7 @@
     "vitest": "^0.34.6"
   },
   "peerDependencies": {
-    "@coltorapps/builder": "^0.2.0",
+    "@coltorapps/builder": "^0.2.2",
     "react": "^18.0.0 || ^19.0.0"
   },
   "publishConfig": {

diff --git a/packages/builder-react/src/interpreter.tsx b/packages/builder-react/src/interpreter.tsx
@@ -9,6 +9,7 @@ import {
   type InterpreterStore,
   type InterpreterStoreData,
   type InterpreterStoreEvent,
+  type InterpreterStoreOptions,
   type Schema,
 } from "@coltorapps/builder";
 
@@ -24,15 +25,11 @@ export function useInterpreterStore<TBuilder extends Builder>(
   builder: TBuilder,
   schema: Schema<TBuilder>,
   options: {
-    initialData?: Partial<InterpreterStoreData<TBuilder>>;
     events?: EventsListeners<InterpreterStoreEvent<TBuilder>>;
-  } = {},
+  } & InterpreterStoreOptions<TBuilder> = {},
 ): InterpreterStore<TBuilder> {
   const interpreterStore = useMemo(
-    () =>
-      createInterpreterStore(builder, schema, {
-        initialData: options.initialData,
-      }),
+    () => createInterpreterStore(builder, schema, options),
     // eslint-disable-next-line react-hooks/exhaustive-deps
     [builder, schema],
   );

diff --git a/packages/builder/CHANGELOG.md b/packages/builder/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @coltorapps/builder
 
+## 0.2.2
+
+### Patch Changes
+
+- Expose all interpreter store options and make them available in useInterpreterStore.
+
 ## 0.2.1
 
 ### Patch Changes

diff --git a/packages/builder/package.json b/packages/builder/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@coltorapps/builder",
   "private": false,
-  "version": "0.2.1",
+  "version": "0.2.2",
   "homepage": "https://builder.coltorapps.com/",
   "repository": {
     "type": "git",

diff --git a/packages/builder/src/index.ts b/packages/builder/src/index.ts
@@ -29,6 +29,7 @@ export type {
   InterpreterStore,
   InterpreterStoreData,
   InterpreterStoreEvent,
+  InterpreterStoreOptions,
   InterpreterStoreEventName,
 } from "./interpreter-store";
 

diff --git a/packages/builder/src/interpreter-store.ts b/packages/builder/src/interpreter-store.ts
@@ -488,15 +488,17 @@ function ensureEntityProcessable(
   }
 }
 
+export type InterpreterStoreOptions<TBuilder extends Builder> = {
+  initialData?: Partial<
+    Omit<InterpreterStoreData<TBuilder>, "unprocessableEntitiesIds">
+  >;
+  initialEntitiesValuesWithDefaults?: boolean;
+};
+
 export function createInterpreterStore<TBuilder extends Builder>(
   builder: TBuilder,
   schema: Schema<TBuilder>,
-  options?: {
-    initialData?: Partial<
-      Omit<InterpreterStoreData<TBuilder>, "unprocessableEntitiesIds">
-    >;
-    initialEntitiesValuesWithDefaults?: boolean;
-  },
+  options?: InterpreterStoreOptions<TBuilder>,
 ): InterpreterStore<TBuilder> {
   const schemaValidationResult = validateSchemaShape(schema, builder);