quidproquo-web-react 0.1.15 → 0.1.17

package/README.md

@@ -1,13 +1,41 @@
-# quidproquo
+# quidproquo-web-react
 
-JS Library for building web servers using pure functions and generators.
+React bindings for [quidproquo](https://github.com/qpqjs/quidproquo).
 
-## tsconfig
+This is what a qpq frontend is built on. It runs the qpq runtime in the browser, so the same kind of stories that run on the server can drive your UI, and it provides the state, auth, and connection plumbing around them.
 
-core for quidproquo library packages ~ Should probably not be used by itself
+```bash
+npm install quidproquo-web-react
+```
 
-use `quidproquo`
+React 18 or newer is a peer dependency.
 
-### Note
+## What is in here
 
-Currently under development ~ Not for production
+| Area | What it gives you |
+| --- | --- |
+| `runtime` | The browser runtime, wired to the web action processors |
+| `store` | The qpq state store: reference-counted, `set_state` only, with an `onInit` hook on the definition and immediate teardown when the last consumer unmounts |
+| `state` | Effect and reducer wiring for state modules, matching the layout `quidproquo-features` uses |
+| `api` | Typed clients for your service apis |
+| `auth` | Sign in, sign out, tokens, and the auth context |
+| `websocket`, `webSocketQueue` | Live connections, including the ordered, reliable queue |
+| `hooks` | The general-purpose hooks, plus `useFieldBinding` for forms and `useSharedQueryParams` for url-backed state |
+| `qpqContext` | Getting qpq config and service info into your components |
+| `dateTime`, `baseUrl` | Formatting and url resolution consistent with the backend |
+
+## How it fits
+
+Frontend state is a fold over dispatched effects, the same shape the backend uses for event documents. Components stay presentational: a handler dispatches an effect or runs a story, a reducer produces the next state, and a selector reads it. Data is fetched in the event handler that needs it, not in an effect that fires after render.
+
+## Status
+
+Pre-1.0. The whole `quidproquo-*` family releases in lockstep, so versions that share a number were built and tested together. Expect APIs to move between releases, and pin your versions.
+
+## Documentation
+
+[docs.quidproquojs.com](https://docs.quidproquojs.com)
+
+## License
+
+MIT. See [LICENSE](https://github.com/qpqjs/quidproquo/blob/main/LICENSE).

package/lib/commonjs/runtime/actionProcessor/getStateDispatchActionProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"getStateDispatchActionProcessor.js","sourceRoot":"","sources":["../../../../src/runtime/actionProcessor/getStateDispatchActionProcessor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAgJ;AAIhJ,MAAM,uBAAuB,GAC3B,CAAC,QAAuB,EAAqC,EAAE,CAC/D,KAAmB,EAAE,4CAAd,EAAE,MAAM,EAAE;IACf,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEjB,OAAO,IAAA,8BAAY,EAAC,SAAS,CAAC,CAAC;AACjC,CAAC,CAAA,CAAC;AAEG,MAAM,kCAAkC,GAC7C,CAAC,QAAuB,EAA+B,EAAE,CACzD,CAAO,UAAU,EAAE,oBAAoB,EAAgC,EAAE;IAAC,OAAA,CAAC;QACzE,CAAC,iCAAe,CAAC,QAAQ,CAAC,EAAE,uBAAuB,CAAC,QAAQ,CAAC;KAC9D,CAAC,CAAA;EAAA,CAAC;AAJQ,QAAA,kCAAkC,sCAI1C","sourcesContent":["import { ActionProcessorList, ActionProcessorListResolver, actionResult, StateActionType, StateDispatchActionProcessor } from 'quidproquo-core';\n\nimport { Dispatch } from 'react';\n\nconst getProcessStateDispatch =\n  (dispatch: Dispatch<any>): StateDispatchActionProcessor<any> =>\n  async ({ action }) => {\n    dispatch(action);\n\n    return actionResult(undefined);\n  };\n\nexport const getStateDispatchActionListResolver =\n  (dispatch: Dispatch<any>): ActionProcessorListResolver =>\n  async (_qpqConfig, _dynamicModuleLoader): Promise<ActionProcessorList> => ({\n    [StateActionType.Dispatch]: getProcessStateDispatch(dispatch),\n  });\n"]}
+{"version":3,"file":"getStateDispatchActionProcessor.js","sourceRoot":"","sources":["../../../../src/runtime/actionProcessor/getStateDispatchActionProcessor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAQyB;AAIzB,MAAM,uBAAuB,GAC3B,CAAC,QAAuB,EAA6C,EAAE,CACvE,KAAmB,EAAE,4CAAd,EAAE,MAAM,EAAE;IACf,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEjB,OAAO,IAAA,8BAAY,EAAC,SAAS,CAAC,CAAC;AACjC,CAAC,CAAA,CAAC;AAEG,MAAM,kCAAkC,GAC7C,CAAC,QAAuB,EAA+B,EAAE,CACzD,CAAO,UAAU,EAAE,oBAAoB,EAAgC,EAAE;IAAC,OAAA,CAAC;QACzE,CAAC,iCAAe,CAAC,QAAQ,CAAC,EAAE,uBAAuB,CAAC,QAAQ,CAAC;KAC9D,CAAC,CAAA;EAAA,CAAC;AAJQ,QAAA,kCAAkC,sCAI1C","sourcesContent":["import {\n  ActionProcessorList,\n  ActionProcessorListResolver,\n  actionResult,\n  askStateDispatchBase,\n  createActionProcessor,\n  ProcessorFor,\n  StateActionType,\n} from 'quidproquo-core';\n\nimport { Dispatch } from 'react';\n\nconst getProcessStateDispatch =\n  (dispatch: Dispatch<any>): ProcessorFor<typeof askStateDispatchBase> =>\n  async ({ action }) => {\n    dispatch(action);\n\n    return actionResult(undefined);\n  };\n\nexport const getStateDispatchActionListResolver =\n  (dispatch: Dispatch<any>): ActionProcessorListResolver =>\n  async (_qpqConfig, _dynamicModuleLoader): Promise<ActionProcessorList> => ({\n    [StateActionType.Dispatch]: getProcessStateDispatch(dispatch),\n  });\n"]}

package/lib/commonjs/runtime/actionProcessor/getStateReadActionProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"getStateReadActionProcessor.js","sourceRoot":"","sources":["../../../../src/runtime/actionProcessor/getStateReadActionProcessor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA4I;AAE5I,MAAM,mBAAmB,GACvB,CAAQ,eAA4B,EAAiC,EAAE,CACvE,GAAS,EAAE;IACT,OAAO,IAAA,8BAAY,EAAC,eAAe,EAAE,CAAC,CAAC;AACzC,CAAC,CAAA,CAAC;AAEG,MAAM,8BAA8B,GACzC,CAAQ,eAA4B,EAA+B,EAAE,CACrE,CAAO,UAAU,EAAE,oBAAoB,EAAgC,EAAE;IAAC,OAAA,CAAC;QACzE,CAAC,iCAAe,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAC,eAAe,CAAC;KAC7D,CAAC,CAAA;EAAA,CAAC;AAJQ,QAAA,8BAA8B,kCAItC","sourcesContent":["import { ActionProcessorList, ActionProcessorListResolver, actionResult, StateActionType, StateReadActionProcessor } from 'quidproquo-core';\n\nconst getProcessStateRead =\n  <State>(getCurrentState: () => State): StateReadActionProcessor<any> =>\n  async () => {\n    return actionResult(getCurrentState());\n  };\n\nexport const getStateReadActionListResolver =\n  <State>(getCurrentState: () => State): ActionProcessorListResolver =>\n  async (_qpqConfig, _dynamicModuleLoader): Promise<ActionProcessorList> => ({\n    [StateActionType.Read]: getProcessStateRead(getCurrentState),\n  });\n"]}
+{"version":3,"file":"getStateReadActionProcessor.js","sourceRoot":"","sources":["../../../../src/runtime/actionProcessor/getStateReadActionProcessor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAQyB;AAEzB,MAAM,mBAAmB,GACvB,CAAQ,eAA4B,EAAyC,EAAE,CAC/E,GAAS,EAAE;IACT,OAAO,IAAA,8BAAY,EAAC,eAAe,EAAE,CAAC,CAAC;AACzC,CAAC,CAAA,CAAC;AAEG,MAAM,8BAA8B,GACzC,CAAQ,eAA4B,EAA+B,EAAE,CACrE,CAAO,UAAU,EAAE,oBAAoB,EAAgC,EAAE;IAAC,OAAA,CAAC;QACzE,CAAC,iCAAe,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAC,eAAe,CAAC;KAC7D,CAAC,CAAA;EAAA,CAAC;AAJQ,QAAA,8BAA8B,kCAItC","sourcesContent":["import {\n  ActionProcessorList,\n  ActionProcessorListResolver,\n  actionResult,\n  askStateReadBase,\n  createActionProcessor,\n  ProcessorFor,\n  StateActionType,\n} from 'quidproquo-core';\n\nconst getProcessStateRead =\n  <State>(getCurrentState: () => State): ProcessorFor<typeof askStateReadBase> =>\n  async () => {\n    return actionResult(getCurrentState());\n  };\n\nexport const getStateReadActionListResolver =\n  <State>(getCurrentState: () => State): ActionProcessorListResolver =>\n  async (_qpqConfig, _dynamicModuleLoader): Promise<ActionProcessorList> => ({\n    [StateActionType.Read]: getProcessStateRead(getCurrentState),\n  });\n"]}

package/lib/esm/runtime/actionProcessor/getStateDispatchActionProcessor.js

@@ -1,4 +1,4 @@
-import { actionResult, StateActionType } from 'quidproquo-core';
+import { actionResult, StateActionType, } from 'quidproquo-core';
 const getProcessStateDispatch = (dispatch) => async ({ action }) => {
     dispatch(action);
     return actionResult(undefined);

package/lib/esm/runtime/actionProcessor/getStateDispatchActionProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"getStateDispatchActionProcessor.js","sourceRoot":"","sources":["../../../../src/runtime/actionProcessor/getStateDispatchActionProcessor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoD,YAAY,EAAE,eAAe,EAAgC,MAAM,iBAAiB,CAAC;AAIhJ,MAAM,uBAAuB,GAC3B,CAAC,QAAuB,EAAqC,EAAE,CAC/D,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;IACnB,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEjB,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,kCAAkC,GAC7C,CAAC,QAAuB,EAA+B,EAAE,CACzD,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAgC,EAAE,CAAC,CAAC;IACzE,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC9D,CAAC,CAAC","sourcesContent":["import { ActionProcessorList, ActionProcessorListResolver, actionResult, StateActionType, StateDispatchActionProcessor } from 'quidproquo-core';\n\nimport { Dispatch } from 'react';\n\nconst getProcessStateDispatch =\n  (dispatch: Dispatch<any>): StateDispatchActionProcessor<any> =>\n  async ({ action }) => {\n    dispatch(action);\n\n    return actionResult(undefined);\n  };\n\nexport const getStateDispatchActionListResolver =\n  (dispatch: Dispatch<any>): ActionProcessorListResolver =>\n  async (_qpqConfig, _dynamicModuleLoader): Promise<ActionProcessorList> => ({\n    [StateActionType.Dispatch]: getProcessStateDispatch(dispatch),\n  });\n"]}
+{"version":3,"file":"getStateDispatchActionProcessor.js","sourceRoot":"","sources":["../../../../src/runtime/actionProcessor/getStateDispatchActionProcessor.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,EAIZ,eAAe,GAChB,MAAM,iBAAiB,CAAC;AAIzB,MAAM,uBAAuB,GAC3B,CAAC,QAAuB,EAA6C,EAAE,CACvE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;IACnB,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEjB,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,kCAAkC,GAC7C,CAAC,QAAuB,EAA+B,EAAE,CACzD,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAgC,EAAE,CAAC,CAAC;IACzE,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC9D,CAAC,CAAC","sourcesContent":["import {\n  ActionProcessorList,\n  ActionProcessorListResolver,\n  actionResult,\n  askStateDispatchBase,\n  createActionProcessor,\n  ProcessorFor,\n  StateActionType,\n} from 'quidproquo-core';\n\nimport { Dispatch } from 'react';\n\nconst getProcessStateDispatch =\n  (dispatch: Dispatch<any>): ProcessorFor<typeof askStateDispatchBase> =>\n  async ({ action }) => {\n    dispatch(action);\n\n    return actionResult(undefined);\n  };\n\nexport const getStateDispatchActionListResolver =\n  (dispatch: Dispatch<any>): ActionProcessorListResolver =>\n  async (_qpqConfig, _dynamicModuleLoader): Promise<ActionProcessorList> => ({\n    [StateActionType.Dispatch]: getProcessStateDispatch(dispatch),\n  });\n"]}

package/lib/esm/runtime/actionProcessor/getStateReadActionProcessor.js

@@ -1,4 +1,4 @@
-import { actionResult, StateActionType } from 'quidproquo-core';
+import { actionResult, StateActionType, } from 'quidproquo-core';
 const getProcessStateRead = (getCurrentState) => async () => {
     return actionResult(getCurrentState());
 };

package/lib/esm/runtime/actionProcessor/getStateReadActionProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"getStateReadActionProcessor.js","sourceRoot":"","sources":["../../../../src/runtime/actionProcessor/getStateReadActionProcessor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoD,YAAY,EAAE,eAAe,EAA4B,MAAM,iBAAiB,CAAC;AAE5I,MAAM,mBAAmB,GACvB,CAAQ,eAA4B,EAAiC,EAAE,CACvE,KAAK,IAAI,EAAE;IACT,OAAO,YAAY,CAAC,eAAe,EAAE,CAAC,CAAC;AACzC,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,8BAA8B,GACzC,CAAQ,eAA4B,EAA+B,EAAE,CACrE,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAgC,EAAE,CAAC,CAAC;IACzE,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAC,eAAe,CAAC;CAC7D,CAAC,CAAC","sourcesContent":["import { ActionProcessorList, ActionProcessorListResolver, actionResult, StateActionType, StateReadActionProcessor } from 'quidproquo-core';\n\nconst getProcessStateRead =\n  <State>(getCurrentState: () => State): StateReadActionProcessor<any> =>\n  async () => {\n    return actionResult(getCurrentState());\n  };\n\nexport const getStateReadActionListResolver =\n  <State>(getCurrentState: () => State): ActionProcessorListResolver =>\n  async (_qpqConfig, _dynamicModuleLoader): Promise<ActionProcessorList> => ({\n    [StateActionType.Read]: getProcessStateRead(getCurrentState),\n  });\n"]}
+{"version":3,"file":"getStateReadActionProcessor.js","sourceRoot":"","sources":["../../../../src/runtime/actionProcessor/getStateReadActionProcessor.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,EAIZ,eAAe,GAChB,MAAM,iBAAiB,CAAC;AAEzB,MAAM,mBAAmB,GACvB,CAAQ,eAA4B,EAAyC,EAAE,CAC/E,KAAK,IAAI,EAAE;IACT,OAAO,YAAY,CAAC,eAAe,EAAE,CAAC,CAAC;AACzC,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,8BAA8B,GACzC,CAAQ,eAA4B,EAA+B,EAAE,CACrE,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAgC,EAAE,CAAC,CAAC;IACzE,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAC,eAAe,CAAC;CAC7D,CAAC,CAAC","sourcesContent":["import {\n  ActionProcessorList,\n  ActionProcessorListResolver,\n  actionResult,\n  askStateReadBase,\n  createActionProcessor,\n  ProcessorFor,\n  StateActionType,\n} from 'quidproquo-core';\n\nconst getProcessStateRead =\n  <State>(getCurrentState: () => State): ProcessorFor<typeof askStateReadBase> =>\n  async () => {\n    return actionResult(getCurrentState());\n  };\n\nexport const getStateReadActionListResolver =\n  <State>(getCurrentState: () => State): ActionProcessorListResolver =>\n  async (_qpqConfig, _dynamicModuleLoader): Promise<ActionProcessorList> => ({\n    [StateActionType.Read]: getProcessStateRead(getCurrentState),\n  });\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quidproquo-web-react",
-  "version": "0.1.15",
+  "version": "0.1.17",
   "description": "",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/esm/index.js",
@@ -9,6 +9,9 @@
   "files": [
     "lib/**/*"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "clean": "npx rimraf lib && npx rimraf node_modules",
@@ -22,31 +25,31 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/joe-coady/quidproquo.git"
+    "url": "git+https://github.com/qpqjs/quidproquo.git"
   },
   "keywords": [],
   "author": "",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/joe-coady/quidproquo/issues"
+    "url": "https://github.com/qpqjs/quidproquo/issues"
   },
-  "homepage": "https://github.com/joe-coady/quidproquo#readme",
+  "homepage": "https://github.com/qpqjs/quidproquo#readme",
   "devDependencies": {
     "@testing-library/dom": "^10.4.1",
     "@testing-library/react": "^16.3.2",
-    "quidproquo-core": "0.1.15",
-    "quidproquo-tsconfig": "0.1.15",
+    "quidproquo-core": "0.1.17",
+    "quidproquo-tsconfig": "0.1.17",
     "typescript": "^5.8.2"
   },
   "peerDependencies": {
     "react": ">=18.3.1"
   },
   "dependencies": {
-    "quidproquo-actionprocessor-node": "0.1.15",
-    "quidproquo-actionprocessor-web": "0.1.15",
-    "quidproquo-features": "0.1.15",
-    "quidproquo-web": "0.1.15",
-    "quidproquo-webserver": "0.1.15",
+    "quidproquo-actionprocessor-node": "0.1.17",
+    "quidproquo-actionprocessor-web": "0.1.17",
+    "quidproquo-features": "0.1.17",
+    "quidproquo-web": "0.1.17",
+    "quidproquo-webserver": "0.1.17",
     "symbol-observable": "^4.0.0"
   }
 }