Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/fresh-camels-clap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@effector/model-react': patch
'@effector/model': patch
---

Implement callback api for keyval: `keyval(() => ({state, api, key}))`
8 changes: 4 additions & 4 deletions .github/workflows/changes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: pnpm/action-setup@v2
- uses: actions/setup-node@v3
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'
cache: 'pnpm'
- run: pnpm install --frozen-lockfile
- run: pnpm lint:changes
- run: pnpm lint:changes --since='origin/main'
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: pnpm/action-setup@v2
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'
cache: 'pnpm'
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: pnpm/action-setup@v2
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'
cache: 'pnpm'
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ jobs:
version:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: pnpm/action-setup@v2
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'
cache: 'pnpm'
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@
"dependencies": {
"@typescript-eslint/eslint-plugin": "^8.0.1",
"@typescript-eslint/parser": "^8.0.1",
"effector": "^23.2.2",
"effector": "^23.3.0",
"effector-react": "^23.2.1",
"patronum": "^2.3.0",
"react": "^18.3.1",
"react-dom": "^18.3.1"
},
Expand Down Expand Up @@ -48,7 +49,7 @@
"@vitest/ui": "^2.0.5",
"bytes-iec": "^3.1.1",
"dotenv": "^16.0.1",
"effector": "^23.2.2",
"effector": "^23.3.0",
"eslint": "^9.9.0",
"eslint-config-airbnb": "^19.0.4",
"eslint-config-airbnb-typescript": "^18.0.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"version": "0.0.2",
"type": "commonjs",
"peerDependencies": {
"effector": "^23.2.2"
"effector": "^23.3.0"
}
}
70 changes: 33 additions & 37 deletions packages/core/src/__tests__/keyval/edit.test.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
import { expect, test, describe } from 'vitest';
import { combine } from 'effector';
import { keyval, define } from '@effector/model';
import { createStore, combine } from 'effector';
import { keyval } from '@effector/model';

function createEntities(fill?: Array<{ id: string }>) {
const entities = keyval({
key: 'id',
props: {
id: define.store<string>(),
},
create({ id: $id }) {
return {
const entities = keyval(() => {
const $id = createStore('');
return {
key: 'id',
state: {
id: $id,
idSize: combine($id, (id) => id.length),
};
},
},
};
});
if (fill) {
entities.edit.replaceAll(fill);
Expand All @@ -23,16 +22,14 @@ function createEntities(fill?: Array<{ id: string }>) {
function createUpdatableEntities(
fill?: Array<{ id: string; count: number; tag: string }>,
) {
const entities = keyval({
key: 'id',
props: {
id: define.store<string>(),
count: define.store<number>(),
tag: define.store<string>(),
},
create() {
return {};
},
const entities = keyval(() => {
const $id = createStore('');
const $count = createStore(0);
const $tag = createStore('');
return {
key: 'id',
state: { id: $id, count: $count, tag: $tag },
};
});
if (fill) {
entities.edit.replaceAll(fill);
Expand Down Expand Up @@ -170,24 +167,23 @@ describe('edit.replaceAll', () => {
expect(entities.$items.getState()).toEqual([{ id: 'baz', idSize: 3 }]);
});
test('nested replaceAll', () => {
const entities = keyval({
key: 'id',
props: {
id: define.store<string>(),
},
create() {
const childs = keyval({
const entities = keyval(() => {
const $id = createStore('');
const childs = keyval(() => {
const $id = createStore('');
return {
key: 'id',
props: {
id: define.store<string>(),
},
create() {
return {};
},
});
return { childs };
},
state: { id: $id },
};
});
return {
key: 'id',
state: { id: $id, childs },
optional: ['childs'],
};
});
entities.edit.replaceAll([{ id: 'foo', childs: [{ id: 'fooA' }] }]);
entities.edit.replaceAll([{ id: 'bar' }]);
entities.edit.replaceAll([
{ id: 'foo', childs: [{ id: 'fooA' }] },
{ id: 'bar' },
Expand Down
128 changes: 70 additions & 58 deletions packages/core/src/__tests__/keyval/index.test.ts
Original file line number Diff line number Diff line change
@@ -1,61 +1,58 @@
import { expect, test, describe } from 'vitest';
import { keyval, define } from '@effector/model';
import { expect, test, describe, vi } from 'vitest';
import { keyval } from '@effector/model';
import { createEvent, createStore } from 'effector';
import { readonly } from 'patronum';

describe('support nested keyval', () => {
test('nested keyval becomes an array', () => {
const entities = keyval({
key: 'id',
props: {
id: define.store<string>(),
},
create() {
const childs = keyval({
const entities = keyval(() => {
const $id = createStore('');
const childs = keyval(() => {
const $id = createStore('');
const $count = createStore(0);
return {
key: 'id',
props: {
id: define.store<string>(),
count: define.store<number>(),
state: {
id: $id,
count: $count,
},
create() {
return {};
},
});
return { childs };
},
};
});
return {
key: 'id',
state: { id: $id, childs },
optional: ['childs'],
};
});
entities.edit.add({ id: 'baz' });
expect(entities.$items.getState()).toEqual([{ id: 'baz', childs: [] }]);
});
test('updates nested keyval', () => {
const entities = keyval({
key: 'id',
props: {
id: define.store<string>(),
},
create() {
const childs = keyval({
key: 'id',
props: {
id: define.store<string>(),
},
create() {
const sum = createEvent<number>();
const $count = createStore(0);
$count.on(sum, (x, y) => x + y);
return {
state: { count: $count },
api: { sum },
};
},
});
const entities = keyval(() => {
const childs = keyval(() => {
const $id = createStore('');
const sum = createEvent<number>();
const $count = createStore(0);
$count.on(sum, (x, y) => x + y);
return {
state: { childs },
api: {
sum: childs.api.sum,
addChild: childs.edit.add,
key: 'id',
state: {
id: $id,
count: readonly($count),
},
api: { sum },
};
},
});
const $id = createStore('');
return {
key: 'id',
state: { id: $id, childs },
api: {
sum: childs.api.sum,
addChild: childs.edit.add,
},
optional: ['childs'],
};
});
entities.edit.add([{ id: 'foo' }, { id: 'bar' }]);
entities.api.addChild({
Expand Down Expand Up @@ -93,20 +90,16 @@ describe('support nested keyval', () => {
});

test('api support', () => {
const entities = keyval({
key: 'id',
props: {
id: define.store<string>(),
},
create() {
const incBy = createEvent<number>();
const $count = createStore(0);
$count.on(incBy, (x, y) => x + y);
return {
state: { count: $count },
api: { incBy },
};
},
const entities = keyval(() => {
const $id = createStore('');
const incBy = createEvent<number>();
const $count = createStore(0);
$count.on(incBy, (x, y) => x + y);
return {
key: 'id',
state: { id: $id, count: readonly($count) },
api: { incBy },
};
});
entities.edit.add([{ id: 'foo' }, { id: 'bar' }]);
entities.api.incBy({ key: 'foo', data: 2 });
Expand All @@ -115,3 +108,22 @@ test('api support', () => {
{ id: 'bar', count: 0 },
]);
});

test('onMount support', () => {
const fn = vi.fn();
const entities = keyval(() => {
const $id = createStore(0);
const onMount = createEvent();
onMount.watch(() => fn());
return {
key: 'id',
state: { id: $id },
onMount,
};
});
expect(fn).toBeCalledTimes(0);
entities.edit.add({ id: 1 });
expect(fn).toBeCalledTimes(1);
entities.edit.add({ id: 2 });
expect(fn).toBeCalledTimes(2);
});
41 changes: 9 additions & 32 deletions packages/core/src/__tests__/keyval/key.test.ts
Original file line number Diff line number Diff line change
@@ -1,38 +1,15 @@
import { expect, test } from 'vitest';
import { keyval, define } from '@effector/model';

test('key function', () => {
const entities = keyval({
key: ({ id }) => id,
props: {
id: define.store<string>(),
count: define.store<number>(),
},
create() {
return {};
},
});
entities.edit.add([
{ id: 'foo', count: 0 },
{ id: 'bar', count: 0 },
]);
entities.edit.update({ id: 'foo', count: 1 });
expect(entities.$items.getState()).toEqual([
{ id: 'foo', count: 1 },
{ id: 'bar', count: 0 },
]);
});
import { createStore } from 'effector';
import { keyval } from '@effector/model';

test('key string', () => {
const entities = keyval({
key: 'id',
props: {
id: define.store<string>(),
count: define.store<number>(),
},
create() {
return {};
},
const entities = keyval(() => {
const $id = createStore('');
const $count = createStore(0);
return {
key: 'id',
state: { id: $id, count: $count },
};
});
entities.edit.add([
{ id: 'foo', count: 0 },
Expand Down
Loading