@solid-primitives/deep 0.0.100

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Solid Primitives Working Group
+
+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

@@ -0,0 +1,57 @@
+<p>
+  <img width="100%" src="https://assets.solidjs.com/banner?type=Primitives&background=tiles&project=deep" alt="Solid Primitives deep">
+</p>
+
+# @solid-primitives/deep
+
+[![turborepo](https://img.shields.io/badge/built%20with-turborepo-cc00ff.svg?style=for-the-badge&logo=turborepo)](https://turborepo.org/)
+[![size](https://img.shields.io/bundlephobia/minzip/@solid-primitives/deep?style=for-the-badge&label=size)](https://bundlephobia.com/package/@solid-primitives/deep)
+[![version](https://img.shields.io/npm/v/@solid-primitives/deep?style=for-the-badge)](https://www.npmjs.com/package/@solid-primitives/deep)
+[![stage](https://img.shields.io/endpoint?style=for-the-badge&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsolidjs-community%2Fsolid-primitives%2Fmain%2Fassets%2Fbadges%2Fstage-0.json)](https://github.com/solidjs-community/solid-primitives#contribution-process)
+
+A function that allows to trigger effects when deep properties for a store change:
+
+`deepTrack` - Provides a traversed store object.
+
+## Installation
+
+```bash
+npm install @solid-primitives/deep
+# or
+yarn add @solid-primitives/deep
+# or
+pnpm add @solid-primitives/deep
+```
+
+## How to use it
+
+You can explicitly pass dependencies to effect functions like `on` and `defer` to deeply track its dependencies.
+
+```ts
+createEffect(
+  on(
+    () => deepTrack(sign),
+    () => {
+      /* function to execute */
+    },
+  ),
+);
+```
+
+Or since this has a composable design, you can create _derivative_ functions and use them similar to derivative signals.
+
+```ts
+const deeplyTrackedStore = () => deepTrack(sign);
+createEffect(() => {
+  console.log("Store is: ", deeplyTrackedStore());
+  //                        ^ this causes a re-execution of the effect on deep changes of properties
+});
+```
+
+## Demo
+
+You can use this template for publishing your demo on CodeSandbox: https://codesandbox.io/s/solid-primitives-demo-template-sz95h
+
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md)

package/dist/index.cjs

@@ -0,0 +1,28 @@
+'use strict';
+
+var solidJs = require('solid-js');
+
+// src/index.ts
+function deepTrack(store) {
+  return deepTraverse(store);
+}
+function deepTraverse(value, seen) {
+  if (!isWrappable(value)) {
+    return value;
+  }
+  seen = seen || /* @__PURE__ */ new Set();
+  if (seen.has(value)) {
+    return value;
+  }
+  seen.add(value);
+  for (const key in value) {
+    deepTraverse(value[key], seen);
+  }
+  return value;
+}
+function isWrappable(obj) {
+  let proto;
+  return obj != null && typeof obj === "object" && (obj[solidJs.$PROXY] || !(proto = Object.getPrototypeOf(obj)) || proto === Object.prototype || Array.isArray(obj));
+}
+
+exports.deepTrack = deepTrack;

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { Store } from 'solid-js/store';
+
+/**
+ * deepTrack - create a deep getter on the given object
+ * ```typescript
+ * export function deepTrack<T>(
+ *   store: Store<T>
+ * ): T;
+ * ```
+ * @param store reactive store dependency
+ * @returns same dependency, just traversed deeply to trigger effects on deeply nested properties. For example:
+ *
+ * ```typescript
+ * createEffect(
+ *     on(
+ *         deepTrack(store),
+ *         () => {
+ *            // this effect will run when any property of store changes
+ *         }
+ *     )
+ *
+ * );
+ * ```
+ */
+declare function deepTrack<T>(store: Store<T>): T;
+
+export { deepTrack };

package/dist/index.js

@@ -0,0 +1,26 @@
+import { $PROXY } from 'solid-js';
+
+// src/index.ts
+function deepTrack(store) {
+  return deepTraverse(store);
+}
+function deepTraverse(value, seen) {
+  if (!isWrappable(value)) {
+    return value;
+  }
+  seen = seen || /* @__PURE__ */ new Set();
+  if (seen.has(value)) {
+    return value;
+  }
+  seen.add(value);
+  for (const key in value) {
+    deepTraverse(value[key], seen);
+  }
+  return value;
+}
+function isWrappable(obj) {
+  let proto;
+  return obj != null && typeof obj === "object" && (obj[$PROXY] || !(proto = Object.getPrototypeOf(obj)) || proto === Object.prototype || Array.isArray(obj));
+}
+
+export { deepTrack };

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@solid-primitives/deep",
+  "version": "0.0.100",
+  "description": "Deep trigger effects for Stores.",
+  "author": "Samuel Burbano <me@iosamuel.dev>",
+  "contributors": [],
+  "license": "MIT",
+  "homepage": "https://github.com/solidjs-community/solid-primitives/tree/main/packages/deep#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/solidjs-community/solid-primitives.git"
+  },
+  "bugs": {
+    "url": "https://github.com/solidjs-community/solid-primitives/issues"
+  },
+  "primitive": {
+    "name": "deep",
+    "stage": 0,
+    "list": [
+      "deepTrack"
+    ],
+    "category": "Reactivity"
+  },
+  "keywords": [
+    "solid",
+    "primitives",
+    "deep"
+  ],
+  "private": false,
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "browser": {},
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "require": "./dist/index.cjs"
+  },
+  "peerDependencies": {
+    "solid-js": "^1.6.0"
+  },
+  "typesVersions": {},
+  "scripts": {
+    "dev": "vite serve dev",
+    "page": "vite build dev",
+    "build": "jiti ../../scripts/build.ts",
+    "test": "vitest -c ../../configs/vitest.config.ts",
+    "test:ssr": "pnpm run test --mode ssr"
+  }
+}