edges-svelte 3.1.0 → 3.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +46 -6
  2. package/package.json +3 -5
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # EdgeS
2
2
 
3
+ ## Last new releases in package [@azure-net/edges](https://www.npmjs.com/package/@azure-net/edges). This package is no longer supported.
4
+
3
5
  ### A blazing-fast, extremely lightweight and SSR-friendly store for SvelteKit.
4
6
 
5
7
  **EdgeS** brings seamless, per-request state management to Svelte apps.
@@ -254,6 +256,43 @@ window.__EDGES_DEVTOOLS__.clearCache(); // Clear state cache
254
256
  // - Slow operations (>16ms)
255
257
  ```
256
258
 
259
+ ### Built-in Dev Component (dev-only)
260
+
261
+ EdgeS provides a small in-app DevTools component for development.
262
+
263
+ - A `50x50` floating button appears in the bottom-right corner.
264
+ - Clicking it opens an inspector panel with tabs:
265
+ - `presenters`
266
+ - `stores`
267
+ - `info`
268
+ - `presenters` shows an accordion of registered presenters with key/runtime metadata.
269
+ - `stores` shows registered stores plus state tree entries, previews, and size estimates.
270
+ - `info` includes key uniqueness checks, cache stats, and high-level resource usage.
271
+
272
+ How to enable:
273
+
274
+ - `edges-svelte/dev` — enables DevTools runtime API (`window.__EDGES_DEVTOOLS__`) and mounts the in-app dev UI.
275
+ - `edges-svelte/dev-component` — exports the Svelte component itself if you want to mount it manually.
276
+
277
+ ```ts
278
+ // e.g. in +layout.svelte or app bootstrap (dev only)
279
+ import 'edges-svelte/dev';
280
+ ```
281
+
282
+ ```svelte
283
+ <!-- manual mount variant -->
284
+ <script lang="ts">
285
+ import DevToolsComponent from 'edges-svelte/dev-component';
286
+ </script>
287
+
288
+ <DevToolsComponent />
289
+ ```
290
+
291
+ Notes:
292
+
293
+ - This UI is intended only for `dev` and is not a production UI feature.
294
+ - If you do not import `edges-svelte/dev` (or mount `edges-svelte/dev-component` manually), the UI will not appear.
295
+
257
296
  ---
258
297
 
259
298
  ## Monitoring & Debugging
@@ -313,12 +352,13 @@ EdgeS serializes SSR state as plain script payloads. Transport-level compression
313
352
 
314
353
  ## Exports summary
315
354
 
316
- | Feature | Import from |
317
- | -------------------------------------------------------------------------------------------------------- | --------------------- |
318
- | `createStore`, `createStoreFactory`, `createPresenter`, `createPresenterFactory`, `batch`, `transaction` | `edges-svelte` |
319
- | `edgesPlugin`, `createEdgesPluginFactory` | `edges-svelte/plugin` |
320
- | `edgesHandle` | `edges-svelte/server` |
321
- | `DevTools` | `edges-svelte/dev` |
355
+ | Feature | Import from |
356
+ | -------------------------------------------------------------------------------------------------------- | ---------------------------- |
357
+ | `createStore`, `createStoreFactory`, `createPresenter`, `createPresenterFactory`, `batch`, `transaction` | `edges-svelte` |
358
+ | `edgesPlugin`, `createEdgesPluginFactory` | `edges-svelte/plugin` |
359
+ | `edgesHandle` | `edges-svelte/server` |
360
+ | `DevTools` | `edges-svelte/dev` |
361
+ | `DevToolsComponent` | `edges-svelte/dev-component` |
322
362
 
323
363
  ---
324
364
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edges-svelte",
3
- "version": "3.1.0",
3
+ "version": "3.1.1",
4
4
  "license": "MIT",
5
5
  "author": "Pixel1917",
6
6
  "description": "A blazing-fast, extremely lightweight and SSR-friendly store for Svelte",
@@ -123,9 +123,7 @@
123
123
  "test:unit": "vitest",
124
124
  "test": "npm run test:unit -- --run && npm run test:e2e",
125
125
  "test:e2e": "playwright test",
126
- "precommit": "pnpm lint && pnpm check",
127
- "semantic-release": "env-cmd semantic-release",
128
- "commit": "pnpm format && git add . && git-cz && git push",
129
- "release": "pnpm commit && pnpm semantic-release"
126
+ "precommit": "pnpm format",
127
+ "commit": "pnpm format && git add . && git-cz && git push"
130
128
  }
131
129
  }