18 | ? Label | LabelGenerator
19 | : never;
20 | }>;
21 |
22 | export type LabelGenerators = {
23 | [key: string]: LabelGenerator;
24 | };
25 |
26 | /**
27 | * Events
28 | */
29 | export type ReducerEventTypes<
30 | Event extends string,
31 | CaseReducers extends SliceCaseReducers
32 | > = {
33 | [K in keyof CaseReducerActions]: Event;
34 | };
35 |
36 | /**
37 | * Action Name and Type map
38 | */
39 |
40 | export type ActionNameToTypeMap<
41 | CaseReducers extends SliceCaseReducers,
42 | CRA extends CaseReducerActions = CaseReducerActions<
43 | CaseReducers,
44 | any
45 | >
46 | > = {
47 | [K in keyof CRA]: CRA[K] extends ActionCreatorWithPayload
48 | ? T
49 | : never;
50 | };
51 |
52 | /**
53 | * Do Undo Action Creators
54 | */
55 | export const NO_OP_ACTION = createAction('NO_OP');
56 |
57 | type NoOpActionType = typeof NO_OP_ACTION;
58 |
59 | type DoUndoActionCreator<
60 | Payload,
61 | DoPayload = Payload,
62 | UndoPayload = DoPayload
63 | > = (args: {
64 | action: PayloadAction;
65 | currentState: any;
66 | previousState: any;
67 | }) => {
68 | do?: NoOpActionType | PayloadAction;
69 | undo: NoOpActionType | PayloadAction;
70 | };
71 |
72 | export type DoUndoActionCreators> =
73 | Partial<{
74 | [key: string]: DoUndoActionCreator;
75 | // [K in keyof CaseReducerActions]: CaseReducerActions[K] extends PayloadActionCreator<
76 | // infer P
77 | // >
78 | // ? DoUndoActionCreator
79 | // : never;
80 | }>;
81 |
82 | export type GeneratedDoUndoActionCreators = {
83 | [key: string]: (
84 | args: Parameters>[0]
85 | ) => Required>>;
86 | };
87 |
88 | export const LABELS = Symbol('label');
89 | export const DO_UNDO_ACTION_CREATORS = Symbol('do_undo_action_creators');
90 | export const TRRACKABLE = Symbol('trrackable');
91 | export const EVENTS = Symbol('events');
92 | export const ACTION_NAME_TYPE_MAP = Symbol('action_name_type_map');
93 | export const ASYNC_THUNKS = Symbol('async_thunks');
94 |
95 | export type TrrackableSlice<
96 | State,
97 | CaseReducers extends SliceCaseReducers,
98 | Event extends string = string,
99 | Name extends string = string
100 | > = Slice & {
101 | [LABELS]: LabelGenerators;
102 | [EVENTS]: ReducerEventTypes;
103 | [TRRACKABLE]: boolean;
104 | [DO_UNDO_ACTION_CREATORS]: GeneratedDoUndoActionCreators;
105 | [ACTION_NAME_TYPE_MAP]: ActionNameToTypeMap;
106 | [ASYNC_THUNKS]: Array>;
107 | };
108 |
--------------------------------------------------------------------------------
/packages/redux/src/slice/utils.ts:
--------------------------------------------------------------------------------
1 | import { Slice } from '@reduxjs/toolkit';
2 |
3 | import { TRRACKABLE, TrrackableSlice } from './types';
4 |
5 | export function isSliceTrrackable(
6 | slice: Slice
7 | ): slice is TrrackableSlice {
8 | return TRRACKABLE ? TRRACKABLE in slice : false;
9 | }
10 |
--------------------------------------------------------------------------------
/packages/redux/src/store/index.ts:
--------------------------------------------------------------------------------
1 | export * from './trrackableStoreCreator';
2 | export * from './types';
3 | export * from './utils';
4 | export * from './trrackStore';
5 |
--------------------------------------------------------------------------------
/packages/redux/src/store/trrackStore.ts:
--------------------------------------------------------------------------------
1 | import { configureStore, createSlice, PayloadAction } from '@reduxjs/toolkit';
2 | import { NodeId } from '@trrack/core';
3 |
4 | type TrrackSliceState = {
5 | current: NodeId;
6 | };
7 |
8 | const initialState: TrrackSliceState = {
9 | current: null as any,
10 | };
11 |
12 | const trrackSlice = createSlice({
13 | name: 'trrack',
14 | initialState,
15 | reducers: {
16 | changeCurrent: (_, action: PayloadAction) => ({
17 | current: action.payload,
18 | }),
19 | },
20 | });
21 |
22 | export const { changeCurrent } = trrackSlice.actions;
23 |
24 | export function getTrrackStore(init: TrrackSliceState) {
25 | return configureStore({
26 | reducer: trrackSlice.reducer,
27 | preloadedState: init as any,
28 | });
29 | }
30 |
31 | type TrrackStore = ReturnType;
32 |
33 | export type TrrackStoreType = ReturnType;
34 |
--------------------------------------------------------------------------------
/packages/redux/src/store/types.ts:
--------------------------------------------------------------------------------
1 | import { Middleware, Slice } from '@reduxjs/toolkit';
2 | import { CurriedGetDefaultMiddleware } from '@reduxjs/toolkit/dist/getDefaultMiddleware';
3 |
4 | export type SliceMapLike = {
5 | [K in keyof State]: Slice;
6 | };
7 |
8 | export type StateFromSliceMap = M extends SliceMapLike
9 | ? { [P in keyof M]: M[P] extends Slice ? S : never }
10 | : never;
11 |
12 | export type Middlewares = ReadonlyArray<
13 | Middleware, State>
14 | >;
15 |
16 | export type PossibleMiddleware<
17 | State = any,
18 | M extends Middlewares = Middlewares
19 | > = ((g: CurriedGetDefaultMiddleware) => M) | M;
20 |
--------------------------------------------------------------------------------
/packages/redux/src/store/utils.ts:
--------------------------------------------------------------------------------
1 | import { createAction } from '@reduxjs/toolkit';
2 |
3 | import { Middlewares, PossibleMiddleware } from './types';
4 |
5 | export function isMiddlewareArray(
6 | middleware: PossibleMiddleware
7 | ): middleware is Middlewares {
8 | return Array.isArray(middleware);
9 | }
10 |
11 | export function asyncDoUndoActionCreatorHelper(type: string, payload: T) {
12 | return createAction(type, function prepare(c: T) {
13 | return {
14 | payload: c,
15 | };
16 | })(payload);
17 | }
18 |
--------------------------------------------------------------------------------
/packages/redux/tests/index.spec.ts:
--------------------------------------------------------------------------------
1 | import { createAsyncThunk, PayloadAction } from '@reduxjs/toolkit';
2 |
3 | import { configureTrrackableStore, createTrrackableSlice } from '../src';
4 |
5 | describe('it', () => {
6 | it('should work', () => {
7 | const getPostById = createAsyncThunk(
8 | 'test/getpostById',
9 | async (postId: number, _api) => {
10 | const response = await fetch(
11 | ` https://jsonplaceholder.typicode.com/posts/${postId} `
12 | );
13 |
14 | return response.json();
15 | }
16 | );
17 |
18 | const testSlice = createTrrackableSlice({
19 | name: 'test',
20 | initialState: {
21 | hello: 'World',
22 | post: {
23 | userId: -1,
24 | id: -1,
25 | title: '',
26 | body: '',
27 | },
28 | },
29 | reducers: {
30 | sayHello(state, action: PayloadAction) {
31 | state.hello = action.payload;
32 | },
33 | },
34 | extraReducers: (builder) => {
35 | builder.addCase(getPostById.fulfilled, (state, action) => {
36 | state.post = action.payload;
37 | });
38 | },
39 | labels: {
40 | sayHello: (args) => `Say hello to ${args}`,
41 | },
42 | doUndoActionCreators: {
43 | sayHello({ previousState }) {
44 | return {
45 | undo: sayHello(previousState.test.hello),
46 | };
47 | },
48 | },
49 | });
50 |
51 | const { sayHello } = testSlice.actions as any;
52 |
53 | const { store, trrack } = configureTrrackableStore({
54 | reducer: {
55 | test: testSlice.reducer,
56 | },
57 | slices: [testSlice],
58 | });
59 |
60 | // store.dispatch(sayHello('Mars'));
61 | // trrack.undo();
62 |
63 | expect(true).toBeTruthy();
64 | });
65 | });
66 |
--------------------------------------------------------------------------------
/packages/redux/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../tsconfig.base.json",
3 | "compilerOptions": {
4 | "module": "commonjs",
5 | "forceConsistentCasingInFileNames": true,
6 | "strict": true,
7 | "noImplicitOverride": true,
8 | "noPropertyAccessFromIndexSignature": true,
9 | "noImplicitReturns": true,
10 | "noFallthroughCasesInSwitch": true,
11 | "types": ["vitest", "vitest/globals"]
12 | },
13 | "files": [],
14 | "include": [],
15 | "references": [
16 | {
17 | "path": "./tsconfig.lib.json"
18 | },
19 | {
20 | "path": "./tsconfig.spec.json"
21 | }
22 | ]
23 | }
24 |
--------------------------------------------------------------------------------
/packages/redux/tsconfig.lib.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "./tsconfig.json",
3 | "compilerOptions": {
4 | "outDir": "../../dist/out-tsc",
5 | "declaration": true,
6 | "types": ["node"]
7 | },
8 | "include": ["**/*.ts"],
9 | "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
10 | }
11 |
--------------------------------------------------------------------------------
/packages/redux/tsconfig.spec.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "./tsconfig.json",
3 | "compilerOptions": {
4 | "outDir": "../../dist/out-tsc",
5 | "types": ["vitest/globals", "node"]
6 | },
7 | "include": [
8 | "vite.config.ts",
9 | "tests/**/*.test.ts",
10 | "tests**/*.spec.ts",
11 | "tests/**/*.test.tsx",
12 | "tests/**/*.spec.tsx",
13 | "tests/**/*.test.js",
14 | "tests/**/*.spec.js",
15 | "tests/**/*.test.jsx",
16 | "tests/**/*.spec.jsx",
17 | "tests/**/*.d.ts"
18 | ]
19 | }
20 |
--------------------------------------------------------------------------------
/packages/redux/vite.config.ts:
--------------------------------------------------------------------------------
1 | ///
2 | import { defineConfig } from 'vite';
3 |
4 | import { join } from 'path';
5 | import dts from 'vite-plugin-dts';
6 | import viteTsConfigPaths from 'vite-tsconfig-paths';
7 |
8 | export default defineConfig({
9 | cacheDir: '../../node_modules/.vite/redux',
10 | define: {
11 | 'process.env': {},
12 | },
13 | plugins: [
14 | dts({
15 | tsConfigFilePath: join(__dirname, 'tsconfig.lib.json'),
16 | // Faster builds by skipping tests. Set this to false to enable type checking.
17 | skipDiagnostics: true,
18 | }),
19 |
20 | viteTsConfigPaths({
21 | root: '../../',
22 | }),
23 | ],
24 |
25 | // Uncomment this if you are using workers.
26 | // worker: {
27 | // plugins: [
28 | // viteTsConfigPaths({
29 | // root: '../../',
30 | // }),
31 | // ],
32 | // },
33 |
34 | // Configuration for building your library.
35 | // See: https://vitejs.dev/guide/build.html#library-mode
36 | build: {
37 | sourcemap: true,
38 | lib: {
39 | // Could also be a dictionary or array of multiple entry points.
40 | entry: 'src/index.ts',
41 | fileName: 'index',
42 |
43 | // UMD name
44 | name: 'TrrackRTK',
45 | // Change this to the formats you want to support.
46 | // Don't forgot to update your package.json as well.
47 | formats: ['es', 'cjs', 'umd'],
48 | },
49 | rollupOptions: {
50 | // External packages that should not be bundled into your library.
51 | external: ['@reduxjs/toolkit', '@trrack/core'],
52 | output: {
53 | globals: {
54 | '@reduxjs/toolkit': 'RTK',
55 | '@trrack/core': 'Trrack',
56 | },
57 | },
58 | },
59 | },
60 |
61 | test: {
62 | globals: true,
63 | cache: {
64 | dir: '../../node_modules/.vitest',
65 | },
66 | environment: 'jsdom',
67 | include: ['tests/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
68 | },
69 | });
70 |
--------------------------------------------------------------------------------
/release.config.base.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | extends: 'semantic-release-npm-github-publish',
3 | };
4 |
--------------------------------------------------------------------------------
/tools/generators/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Trrack/trrackjs/31af0ead8c2bd805e2cfe296b24b7376892db256/tools/generators/.gitkeep
--------------------------------------------------------------------------------
/tools/scripts/publish.mjs:
--------------------------------------------------------------------------------
1 | /**
2 | * This is a minimal script to publish your package to "npm".
3 | * This is meant to be used as-is or customize as you see fit.
4 | *
5 | * This script is executed on "dist/path/to/library" as "cwd" by default.
6 | *
7 | * You might need to authenticate with NPM before running this script.
8 | */
9 |
10 | import { readCachedProjectGraph } from '@nrwl/devkit';
11 | import { execSync } from 'child_process';
12 | import { readFileSync, writeFileSync } from 'fs';
13 | import chalk from 'chalk';
14 |
15 | function invariant(condition, message) {
16 | if (!condition) {
17 | console.error(chalk.bold.red(message));
18 | process.exit(1);
19 | }
20 | }
21 |
22 | // Executing publish script: node path/to/publish.mjs {name} --version {version} --tag {tag}
23 | // Default "tag" to "next" so we won't publish the "latest" tag by accident.
24 | const [, , name, version, tag = 'next'] = process.argv;
25 |
26 | // A simple SemVer validation to validate the version
27 | const validVersion = /^\d+\.\d+\.\d(-\w+\.\d+)?/;
28 | invariant(
29 | version && validVersion.test(version),
30 | `No version provided or version did not match Semantic Versioning, expected: #.#.#-tag.# or #.#.#, got ${version}.`
31 | );
32 |
33 | const graph = readCachedProjectGraph();
34 | const project = graph.nodes[name];
35 |
36 | invariant(
37 | project,
38 | `Could not find project "${name}" in the workspace. Is the project.json configured correctly?`
39 | );
40 |
41 | const outputPath = project.data?.targets?.build?.options?.outputPath;
42 | invariant(
43 | outputPath,
44 | `Could not find "build.options.outputPath" of project "${name}". Is project.json configured correctly?`
45 | );
46 |
47 | process.chdir(outputPath);
48 |
49 | // Updating the version in "package.json" before publishing
50 | try {
51 | const json = JSON.parse(readFileSync(`package.json`).toString());
52 | json.version = version;
53 | writeFileSync(`package.json`, JSON.stringify(json, null, 2));
54 | } catch (e) {
55 | console.error(
56 | chalk.bold.red(`Error reading package.json file from library build output.`)
57 | );
58 | }
59 |
60 | // Execute "npm publish" to publish
61 | execSync(`npm publish --access public --tag ${tag}`);
62 |
--------------------------------------------------------------------------------
/tools/tsconfig.tools.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../tsconfig.base.json",
3 | "compilerOptions": {
4 | "outDir": "../dist/out-tsc/tools",
5 | "rootDir": ".",
6 | "module": "commonjs",
7 | "target": "es5",
8 | "types": ["node"],
9 | "importHelpers": false
10 | },
11 | "include": ["**/*.ts"]
12 | }
13 |
--------------------------------------------------------------------------------
/tsconfig.base.json:
--------------------------------------------------------------------------------
1 | {
2 | "compileOnSave": false,
3 | "compilerOptions": {
4 | "rootDir": ".",
5 | "sourceMap": true,
6 | "declaration": false,
7 | "moduleResolution": "node",
8 | "emitDecoratorMetadata": true,
9 | "downlevelIteration": true,
10 | "experimentalDecorators": true,
11 | "importHelpers": true,
12 | "target": "es2015",
13 | "module": "esnext",
14 | "lib": ["es2017", "dom"],
15 | "skipLibCheck": true,
16 | "skipDefaultLibCheck": true,
17 | "baseUrl": ".",
18 | "paths": {
19 | "@trrack/core": ["./packages/core/src/index.ts"],
20 | "react": ["node_modules/@types/react"]
21 | }
22 | },
23 | "exclude": ["node_modules", "tmp"]
24 | }
25 |
--------------------------------------------------------------------------------
/vercel.json:
--------------------------------------------------------------------------------
1 | {
2 | "rewrites": [{ "source": "/", "destination": "/trrack" }]
3 | }
4 |
--------------------------------------------------------------------------------