@createstore/createstore 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gaurav Asawa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,68 @@
-# Temporary Holding Version
+# @createstore/createstore
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Global state that works like `useState`, shared by every component. No provider, no reducers, no action types.
+
+```sh
+npm install @createstore/createstore
+```
+
+Requires React 19 or newer. Works in the browser, in Node, and with Next.js Server Components.
+
+## Quick start
+
+```tsx
+import { createStore } from '@createstore/createstore';
+
+const store = createStore({ count: 0 });
+
+function Counter() {
+  const [count, setCount] = store.useGlobalState('count');
+  return <button onClick={() => setCount((c) => c + 1)}>{count}</button>;
+}
+```
+
+Every component that reads `'count'` re-renders when any of them changes it. Outside React, use
+`store.getState('count')` and `store.setState('count', 2)`.
+
+### Share state between components
+
+Take `useGlobalState` out of the store, and any component can read or change the same list. No provider, no props
+passed down:
+
+```tsx
+const { useGlobalState } = createStore({ todos: [] as { text: string }[] });
+
+function TodoCount() {
+  const [todos] = useGlobalState('todos');
+  return <p>{todos.length} todos</p>;
+}
+
+function AddTodo() {
+  const [todos, setTodos] = useGlobalState('todos');
+  const add = (text: string) => setTodos([...todos, { text }]);
+  return <Form onAdd={add} />;
+}
+```
+
+`<Form>` stands for your own form component. When `AddTodo` adds a todo, `TodoCount` updates by itself.
+
+Everything else stays off until you use it: computed values, server data with `query()`, persistence, offline
+support, undo/redo, tab sync, events and server rendering.
+
+## Package
+
+- ESM and CommonJS builds with TypeScript types, `"sideEffects": false`, so unused code is tree-shaken.
+- Published with [npm provenance](https://docs.npmjs.com/generating-provenance-statements).
+- Versioned with [semantic versioning](https://semver.org); see [CHANGELOG.md](./CHANGELOG.md) once a release exists.
+
+## Links
+
+- [GitHub repository](https://github.com/Gauravasawa/createstore): source code, issues and releases
+- [npm package](https://www.npmjs.com/package/@createstore/createstore)
+- [Documentation](https://createstore-docs.pages.dev)
+- [Report a bug or request a feature](https://github.com/Gauravasawa/createstore/issues/new/choose)
+- [Security policy](https://github.com/Gauravasawa/createstore/security/policy)
+
+## License
+
+[MIT](./LICENSE)

package/dist/cjs/client-root.cjs

@@ -0,0 +1,39 @@
+"use strict";
+"use client";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var client_root_exports = {};
+__export(client_root_exports, {
+  ClientRoot: () => ClientRoot
+});
+module.exports = __toCommonJS(client_root_exports);
+var import_react = require("react");
+var import_createStore = require("./createStore.cjs");
+function ClientRoot({ name, snapshot, children }) {
+  const parent = (0, import_react.useContext)(import_createStore.__SnapshotContext);
+  const value = (0, import_react.useMemo)(() => ({ ...parent ?? {}, [name]: { snapshot } }), [parent, name, snapshot]);
+  (0, import_react.useLayoutEffect)(() => {
+    (0, import_createStore.__mergeSnapshot)(name, snapshot);
+  }, [name, snapshot]);
+  return (0, import_react.createElement)(import_createStore.__SnapshotContext.Provider, { value }, children);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ClientRoot
+});
+//# sourceMappingURL=client-root.cjs.map

package/dist/cjs/client-root.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/client-root.tsx"],"sourcesContent":["'use client';\n// What <Store.Root> in a Server Component renders: it hands the request's snapshot down by store name.\n// The store's first hook below picks it up; later snapshots (client-side navigation) are merged in a\n// layout effect, before components subscribe, so a new page's data isn't fetched again.\nimport { createElement, useContext, useLayoutEffect, useMemo, type ReactNode } from 'react';\nimport { __SnapshotContext, __mergeSnapshot } from './createStore';\n\nexport function ClientRoot({ name, snapshot, children }: { name: string; snapshot: unknown; children?: ReactNode }) {\n  const parent = useContext(__SnapshotContext);\n  const value = useMemo(() => ({ ...(parent ?? {}), [name]: { snapshot } }), [parent, name, snapshot]);\n  useLayoutEffect(() => {\n    __mergeSnapshot(name, snapshot);\n  }, [name, snapshot]);\n  return createElement(__SnapshotContext.Provider, { value }, children);\n}"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIA,mBAAoF;AACpF,yBAAmD;AAE5C,SAAS,WAAW,EAAE,MAAM,UAAU,SAAS,GAA8D;AAClH,QAAM,aAAS,yBAAW,oCAAiB;AAC3C,QAAM,YAAQ,sBAAQ,OAAO,EAAE,GAAI,UAAU,CAAC,GAAI,CAAC,IAAI,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,MAAM,QAAQ,CAAC;AACnG,oCAAgB,MAAM;AACpB,4CAAgB,MAAM,QAAQ;AAAA,EAChC,GAAG,CAAC,MAAM,QAAQ,CAAC;AACnB,aAAO,4BAAc,qCAAkB,UAAU,EAAE,MAAM,GAAG,QAAQ;AACtE;","names":[]}