From ad88599dd95c9d0cbde52fd2544ff52e10882a45 Mon Sep 17 00:00:00 2001 From: Yanick Champoux Date: Thu, 2 Mar 2023 11:10:25 -0500 Subject: [PATCH] it begins --- docs/recipes.md | 15 +- docs/recipes.test.js | 1 - docs/tutorial-reactions.test.js | 1 - docs/tutorial.md | 9 +- foo.ts | 6 + out/Updux.html | 160 ++++++++++----------- out/Updux.js.html | 4 +- out/fonts/OpenSans-Bold-webfont.svg | 2 +- out/fonts/OpenSans-BoldItalic-webfont.svg | 2 +- out/fonts/OpenSans-Italic-webfont.svg | 2 +- out/fonts/OpenSans-Light-webfont.svg | 2 +- out/fonts/OpenSans-LightItalic-webfont.svg | 2 +- out/fonts/OpenSans-Regular-webfont.svg | 2 +- out/index.html | 8 +- package.json | 1 + pnpm-lock.yaml | 8 ++ src/Updux.ts | 1 + src/buildMiddleware/index.ts | 10 +- src/buildSelectors/index.ts | 8 +- src/index.ts | 3 + src/tutorial.test.ts | 22 +++ tsconfig.json | 105 ++++++++++++++ vitest.config.ts | 8 ++ 23 files changed, 265 insertions(+), 117 deletions(-) create mode 100644 foo.ts create mode 100644 src/Updux.ts create mode 100644 src/index.ts create mode 100644 src/tutorial.test.ts create mode 100644 tsconfig.json create mode 100644 vitest.config.ts diff --git a/docs/recipes.md b/docs/recipes.md index 3dd308d..ef7369d 100644 --- a/docs/recipes.md +++ b/docs/recipes.md @@ -4,7 +4,7 @@ Say you have a `todos` state that is an array of `todo` sub-states, with some actions that should percolate to all todos, and some that should only -percolate to one. One way to model this is via updux's splat subduxes +percolate to one. One way to model this is via updux's splat subduxes (backed by `updeep`'s own '*'-key behavior). ``` @@ -55,7 +55,7 @@ const updux = new Updux({ add: (inc=1) => state => ({ counter: state.counter + inc }) } }); - + ``` Converting it to Immer would look like: @@ -68,10 +68,10 @@ import { produce } from 'immer'; const updux = new Updux({ initial: { counter: 0 }, mutations: { - add: (inc=1) => produce( draft => draft.counter += inc ) } + add: (inc=1) => produce( draft => draft.counter += inc ) } } }); - + ``` But since typing `produce` over and over is no fun, `groomMutations` @@ -86,11 +86,8 @@ const updux = new Updux({ initial: { counter: 0 }, groomMutations: mutation => (...args) => produce( mutation(...args) ), mutations: { - add: (inc=1) => draft => draft.counter += inc + add: (inc=1) => draft => draft.counter += inc } }); - + ``` - - - diff --git a/docs/recipes.test.js b/docs/recipes.test.js index 8560675..ef0a13a 100644 --- a/docs/recipes.test.js +++ b/docs/recipes.test.js @@ -51,4 +51,3 @@ test( "tutorial", async () => { ]); }); - diff --git a/docs/tutorial-reactions.test.js b/docs/tutorial-reactions.test.js index 61dfe85..cdba1d9 100644 --- a/docs/tutorial-reactions.test.js +++ b/docs/tutorial-reactions.test.js @@ -37,4 +37,3 @@ test( "basic tests", async () => { expect(store.getState().nbrTodos).toEqual(2); }); - diff --git a/docs/tutorial.md b/docs/tutorial.md index 6ecb348..61d87d1 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -15,7 +15,7 @@ plain JavaScript. To begin with, let's define that has nothing but an initial state. ```js -import { Updux } from 'updux'; +import Updux from 'updux'; const todosDux = new Updux({ initial: { @@ -158,9 +158,9 @@ todosDux.setSelector('getTodoById', getTodoById); ### Accessing selectors -The `getState` method of a dux store is augmented +The `getState` method of a dux store is augmented with its selectors, with the first call for the state already -called in for you. +called in for you. ```js const store = todosDux.createStore(); @@ -204,7 +204,7 @@ const todosDux = new Updux({ addTodoWithId: todo => u.updateIn( 'todos', todos => [ ...todos, todo] ), incrementNextId: () => u({ nextId: fp.add(1) }), - todoDone: (id) => u.updateIn('todos', + todoDone: (id) => u.updateIn('todos', u.map( u.if( fp.matches({id}), todo => u({done: true}, todo) ) ) ), }, @@ -404,4 +404,3 @@ const myDux = new Updux({ [immer]: https://www.npmjs.com/package/immer [lodash]: https://www.npmjs.com/package/lodash [ts-action]: https://www.npmjs.com/package/ts-action - diff --git a/foo.ts b/foo.ts new file mode 100644 index 0000000..589e79a --- /dev/null +++ b/foo.ts @@ -0,0 +1,6 @@ +const foo = (x: Partial<{ a: A; b: B }>) => x as B; + +const y = foo({ + a: 'potato', + b: 2, +}); diff --git a/out/Updux.html b/out/Updux.html index 44126a5..c1e8090 100644 --- a/out/Updux.html +++ b/out/Updux.html @@ -19,7 +19,7 @@

Class: Updux

- + @@ -27,24 +27,24 @@
- +

Updux()

- - + +
- - - - + + + +

new Updux()

- - + + @@ -62,42 +62,42 @@
- - - - - - - - - - - - - + + + + + + + + + + + + +
Source:
- - - - + + + +
@@ -119,33 +119,33 @@ - +
- - - + + +

Classes

Updux
- - - - - + + + + +

Members

- - + +

actions

@@ -159,42 +159,42 @@
- - - - - - - - - - - - - + + + + + + + + + + + + +
Source:
- - - - + + + +
@@ -202,8 +202,8 @@ - - + +

initial

@@ -217,42 +217,42 @@
- - - - - - - - - - - - - + + + + + + + + + + + + +
Source:
- - - - + + + +
@@ -260,14 +260,14 @@ - - - - - + + + + +
@@ -290,4 +290,4 @@ - \ No newline at end of file + diff --git a/out/Updux.js.html b/out/Updux.js.html index 3541151..7456b35 100644 --- a/out/Updux.js.html +++ b/out/Updux.js.html @@ -19,11 +19,11 @@

Source: Updux.js

- - + + 
/* TODO change * for leftovers to +, change subscriptions to reactions */
diff --git a/out/fonts/OpenSans-Bold-webfont.svg b/out/fonts/OpenSans-Bold-webfont.svg
index 3ed7be4..8ad2a60 100644
--- a/out/fonts/OpenSans-Bold-webfont.svg
+++ b/out/fonts/OpenSans-Bold-webfont.svg
@@ -1827,4 +1827,4 @@
 
 
 
- 
\ No newline at end of file
+
diff --git a/out/fonts/OpenSans-BoldItalic-webfont.svg b/out/fonts/OpenSans-BoldItalic-webfont.svg
index 6a2607b..d4f4960 100644
--- a/out/fonts/OpenSans-BoldItalic-webfont.svg
+++ b/out/fonts/OpenSans-BoldItalic-webfont.svg
@@ -1827,4 +1827,4 @@
 
 
 
- 
\ No newline at end of file
+
diff --git a/out/fonts/OpenSans-Italic-webfont.svg b/out/fonts/OpenSans-Italic-webfont.svg
index e1075dc..2ee9499 100644
--- a/out/fonts/OpenSans-Italic-webfont.svg
+++ b/out/fonts/OpenSans-Italic-webfont.svg
@@ -1827,4 +1827,4 @@
 
 
 
- 
\ No newline at end of file
+
diff --git a/out/fonts/OpenSans-Light-webfont.svg b/out/fonts/OpenSans-Light-webfont.svg
index 11a472c..42152bc 100644
--- a/out/fonts/OpenSans-Light-webfont.svg
+++ b/out/fonts/OpenSans-Light-webfont.svg
@@ -1828,4 +1828,4 @@
 
 
 
- 
\ No newline at end of file
+
diff --git a/out/fonts/OpenSans-LightItalic-webfont.svg b/out/fonts/OpenSans-LightItalic-webfont.svg
index 431d7e3..e9bfbc3 100644
--- a/out/fonts/OpenSans-LightItalic-webfont.svg
+++ b/out/fonts/OpenSans-LightItalic-webfont.svg
@@ -1832,4 +1832,4 @@
 
 
 
- 
\ No newline at end of file
+
diff --git a/out/fonts/OpenSans-Regular-webfont.svg b/out/fonts/OpenSans-Regular-webfont.svg
index 25a3952..bad5cca 100644
--- a/out/fonts/OpenSans-Regular-webfont.svg
+++ b/out/fonts/OpenSans-Regular-webfont.svg
@@ -1828,4 +1828,4 @@
 
 
 
- 
\ No newline at end of file
+
diff --git a/out/index.html b/out/index.html
index 790e731..d623206 100644
--- a/out/index.html
+++ b/out/index.html
@@ -19,11 +19,11 @@
 
     
Home

 
-    
 
 
 
-    
+
+
 
 
     
 

@@ -37,7 +37,7 @@
 
 
 
-    
+
 
 
 
@@ -62,4 +62,4 @@
 
 
 
-
\ No newline at end of file
+
diff --git a/package.json b/package.json
index 2b14539..7f13d80 100644
--- a/package.json
+++ b/package.json
@@ -36,6 +36,7 @@
         "eslint-plugin-todo-plz": "^1.2.1",
         "jsdoc-to-markdown": "^7.1.1",
         "prettier": "^2.7.1",
+        "typescript": "^4.9.5",
         "vitest": "0.23.1"
     }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index f5ea925..2226279 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -12,6 +12,7 @@ specifiers:
   prettier: ^2.7.1
   redux: ^4.2.0
   remeda: ^1.0.1
+  typescript: ^4.9.5
   updeep: ^1.2.1
   vitest: 0.23.1
 
@@ -30,6 +31,7 @@ devDependencies:
   eslint-plugin-todo-plz: 1.2.1_eslint@8.22.0
   jsdoc-to-markdown: 7.1.1
   prettier: 2.7.1
+  typescript: 4.9.5
   vitest: 0.23.1_kkczkm7y7wgspdnr2rpymavxge
 
 packages:
@@ -2028,6 +2030,12 @@ packages:
     engines: {node: '>=10'}
     dev: true
 
+  /typescript/4.9.5:
+    resolution: {integrity: sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==}
+    engines: {node: '>=4.2.0'}
+    hasBin: true
+    dev: true
+
   /typical/2.6.1:
     resolution: {integrity: sha512-ofhi8kjIje6npGozTip9Fr8iecmYfEbS06i0JnIg+rh51KakryWF4+jX8lLKZVhy6N+ID45WYSFCxPOdTWCzNg==}
     dev: true
diff --git a/src/Updux.ts b/src/Updux.ts
new file mode 100644
index 0000000..eeb5984
--- /dev/null
+++ b/src/Updux.ts
@@ -0,0 +1 @@
+export default class Updux { }
diff --git a/src/buildMiddleware/index.ts b/src/buildMiddleware/index.ts
index 433c531..e1a2bd1 100644
--- a/src/buildMiddleware/index.ts
+++ b/src/buildMiddleware/index.ts
@@ -26,14 +26,14 @@ export function augmentMiddlewareApi(api, actions, selectors) {
 
                 return result;
             };
-        })
+        }),
     );
 
     Object.assign(
         dispatch,
         mapValues(actions, (action) => {
             return (...args) => api.dispatch(action(...args));
-        })
+        }),
     );
 
     return {
@@ -70,16 +70,16 @@ export function buildMiddleware(
     dux = undefined,
 ) {
     let inner = map(sub, ({ middleware }, slice) =>
-        slice !== '*' && middleware ? sliceMw(slice, middleware) : undefined
+        slice !== '*' && middleware ? sliceMw(slice, middleware) : undefined,
     ).filter((x) => x);
 
     const local = effects.map((effect) =>
-        effectToMiddleware(effect, actions, selectors)
+        effectToMiddleware(effect, actions, selectors),
     );
 
     let mws = [...local, ...inner];
 
-    if( wrapper ) mws = wrapper(mws,dux);
+    if (wrapper) mws = wrapper(mws, dux);
 
     return composeMw(mws);
 }
diff --git a/src/buildSelectors/index.ts b/src/buildSelectors/index.ts
index 3b58af7..2fba5f8 100644
--- a/src/buildSelectors/index.ts
+++ b/src/buildSelectors/index.ts
@@ -3,7 +3,7 @@ import { map, mapValues, merge } from 'lodash-es';
 export function buildSelectors(
     localSelectors,
     splatSelector = {},
-    subduxes = {}
+    subduxes = {},
 ) {
     const subSelectors = map(subduxes, ({ selectors }, slice) => {
         if (!selectors) return {};
@@ -11,7 +11,7 @@ export function buildSelectors(
 
         return mapValues(
             selectors,
-            (func: Function) => (state) => func(state[slice])
+            (func: Function) => (state) => func(state[slice]),
         );
     });
 
@@ -28,8 +28,8 @@ export function buildSelectors(
                     res,
                     mapValues(
                         subduxes['*'].selectors,
-                        (selector) => () => selector(value)
-                    )
+                        (selector) => () => selector(value),
+                    ),
                 );
             };
     }
diff --git a/src/index.ts b/src/index.ts
new file mode 100644
index 0000000..5528203
--- /dev/null
+++ b/src/index.ts
@@ -0,0 +1,3 @@
+import Updux from './Updux';
+
+export default Updux;
diff --git a/src/tutorial.test.ts b/src/tutorial.test.ts
new file mode 100644
index 0000000..e8264a3
--- /dev/null
+++ b/src/tutorial.test.ts
@@ -0,0 +1,22 @@
+import Updux from './index.js';
+
+const expectType = (value: T) => value;
+
+test('initial state', () => {
+    const { initial } = new Updux({
+        initial: {
+            next_id: 1,
+            todos: [],
+        },
+    });
+
+    expectType<{
+        next_id: number;
+        todos: unknown[];
+    }>(initial);
+
+    expect(initial).toEqual({
+        next_id: 1,
+        todos: [],
+    });
+});
diff --git a/tsconfig.json b/tsconfig.json
new file mode 100644
index 0000000..7820d85
--- /dev/null
+++ b/tsconfig.json
@@ -0,0 +1,105 @@
+{
+    "compilerOptions": {
+        /* Visit https://aka.ms/tsconfig to read more about this file */
+
+        /* Projects */
+        // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+        // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+        // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+        // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+        // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+        // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+        /* Language and Environment */
+        "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+        // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+        // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+        // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+        // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+        // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+        // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+        // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+        // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+        // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+        // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+        // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+        /* Modules */
+        "module": "ES2020" /* Specify what module code is generated. */,
+        // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+        // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+        // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+        // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+        // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+        // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+        "types": [
+            "vitest/globals"
+        ] /* Specify type package names to be included without being referenced in a source file. */,
+        // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+        // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+        // "resolveJsonModule": true,                        /* Enable importing .json files. */
+        // "noResolve": true,                                /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */
+
+        /* JavaScript Support */
+        // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+        // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+        // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+        /* Emit */
+        // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+        // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+        // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+        // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+        // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+        // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+        // "removeComments": true,                           /* Disable emitting comments. */
+        // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+        // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+        // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+        // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+        // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+        // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+        // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+        // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+        // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+        // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+        // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+        // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+        // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+        // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+        // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+        // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+        /* Interop Constraints */
+        // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+        // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+        "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+        // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+        "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+        /* Type Checking */
+        "strict": true /* Enable all strict type-checking options. */,
+        // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+        // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+        // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+        // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+        // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+        // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+        // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+        // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+        // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+        // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+        // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+        // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+        // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+        // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+        // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+        // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+        // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+        // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+        /* Completeness */
+        // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+        "skipLibCheck": true /* Skip type checking all .d.ts files. */
+    }
+}
diff --git a/vitest.config.ts b/vitest.config.ts
new file mode 100644
index 0000000..1c015a0
--- /dev/null
+++ b/vitest.config.ts
@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        globals: true,
+        isolate: false,
+    },
+});