@iuxs/solid-keep-alive 0.0.1 → 0.0.2

package/README.md

@@ -1,4 +1,4 @@
-# solid-keepalive
+# solid-keep-alive
 
 #### 安装(install)
 

package/dist/index.js

@@ -0,0 +1 @@
+import{createComponent as e}from"solid-js/web";import{createStore as n,produce as t}from"solid-js/store";import{createContext as o,createMemo as s,runWithOwner as c,useContext as d,createComponent as r,createRoot as i,getOwner as l,createEffect as a,onCleanup as u}from"solid-js";const h=o(),v=o();function f(o){const[d,r]=n({}),i=s(e=>{if(!Array.isArray(o.include))return new Set([]);if(e&&e.size){for(const n of o.include)e.delete(n);e.size&&(n=e,r(t(e=>{(n=>{var t,o,s,c;for(const d of n)e[d]&&(e[d].parentId&&(null===(o=null===(t=e[e[d].parentId])||void 0===t?void 0:t.childIds)||void 0===o||o.delete(d)),e[d].hasEl=!1,e[d].init&&!e[d].noCache||(null===(c=(s=e[d]).dispose)||void 0===c||c.call(s),delete e[d]))})(n)})))}var n;return new Set(o.include)});return e(h.Provider,{value:{caches:d,include:i,currentIds:new Set,setCaches:r,setActive:(e,n,o,s)=>{"aOnceSet"===n&&"add"===s&&d[e].init&&d[e].hasEl?c(d[e].owner,o):r(t(t=>{t[e][n]?t[e][n][s](o):"add"===s&&(t[e][n]=new Set([o]))}))}},get children(){return o.children}})}let I=!1;const p=(n,o,s)=>((null==s?void 0:s.isolated)||(I=!0),function(f){var p;const S=d(h);if(!S||!o&&console.error(`[solid-keepalive]:id='${o}' error`))return r(n,f);const C=null===(p=d(v))||void 0===p?void 0:p.id,m=()=>{var e;return!C||(null===(e=S.caches[o])||void 0===e?void 0:e.parentId)===C},w=null==s?void 0:s.isolated;if(S.caches[o])w||S.currentIds.add(o);else{const s=w?null:[...S.currentIds].at(-1);s&&S.caches[s]&&S.setCaches(t(e=>{const n=e[s];n.childIds?n.childIds.add(o):n.childIds=new Set([o])})),w||S.currentIds.add(o);const c=!S.include().has(o);S.setCaches({[o]:Object.assign({id:o,parentId:s},c&&{noCache:c})}),i(s=>S.setCaches(t(t=>{t[o].dispose=s,t[o].owner=l(),t[o].component=e(v.Provider,{get value(){return Object.assign({id:o},c&&{noCache:c})},get children(){return r(n,f)}})})))}return a(()=>{var e;const n=S.caches[o];if(n&&m()&&(!I||w||(null===(e=n.childIds)||void 0===e?void 0:e.size)||(I=!1),!n.init&&(n.hasEl||(()=>{var e,n;if(null===(n=null===(e=S.caches[o])||void 0===e?void 0:e.component)||void 0===n?void 0:n.call(e))return S.setCaches(t(e=>{e[o].hasEl=!0,e[o].owner=l();for(const n of e[o].aOnceSet||[])n();delete e[o].aOnceSet})),!0})()))){S.setCaches(o,"init",!0);for(const e of n.aSet||[])e()}}),u(()=>{const e=S.caches[o];if(!w&&(I||!e))return;if(e.parentId){if(S.currentIds.has(o)){const e=n=>{var t;for(const o of n){S.currentIds.delete(o);const n=null===(t=S.caches[o])||void 0===t?void 0:t.childIds;(null==n?void 0:n.size)&&e(n)}};e([o])}}else S.currentIds.clear();if(!m())return;const n=!e.noCache&&e.hasEl;n&&S.setCaches(o,"init",!1);for(const n of e.dSet||[])n();n||S.setCaches(t(e=>{var n,t,s,c;e[o].parentId&&(null===(t=null===(n=e[e[o].parentId])||void 0===n?void 0:n.childIds)||void 0===t||t.delete(o)),null===(c=(s=e[o]).dispose)||void 0===c||c.call(s),delete e[o]}))}),m()&&c(S.caches[o].owner,()=>S.caches[o].component)}),S=(e,n)=>{if("function"!=typeof n)return;const{id:t,noCache:o}=d(v)||{};if(o&&"aOnceSet"!==e)return;const s=d(h);t&&s&&(s.setActive(t,e,n,"add"),"aOnceSet"!==e&&u(()=>{s.setActive(t,e,n,"delete")}))},C=e=>{S("aSet",e)},m=e=>{S("dSet",e)},w=e=>{const[t,o]=n();return S("aOnceSet",()=>{c(l(),()=>{o(d(e))})}),t};export{f as AliveProvider,p as aliveTransfer,C as onActivated,m as onDeactivated,w as useAliveContext};

package/dist/types/AliveProvider.d.ts

@@ -0,0 +1,13 @@
+import type { AliveProviderProps } from "./types";
+/**
+ * @description 容器
+ * @param {JSXElement} children
+ * @param {Array<string>} [include] ['home','about']
+ * @example
+ * ```jsx
+ *  <AliveProvider  include={['home','about']} >
+      <Router root={Contain} children={routes} />
+    </AliveProvider>
+ * ```
+ * */
+export default function (props: AliveProviderProps): import("solid-js").JSX.Element;

package/dist/types/aliveActive.d.ts

@@ -0,0 +1,25 @@
+/**
+ *  @description 进入缓存
+ * ```tsx
+ * import { onActivated } from 'solid-keepalive'
+ * //use
+ * onActivated(()=> console.log(234))
+ * ```
+ */
+export declare const onActivated: (cb: () => void) => void;
+/**
+ * @description  离开缓存
+ * ```tsx
+ * import { onDeactivated } from 'solid-keepalive'
+ * onDeactivated(()=> console.log(234))
+ * ```
+ */
+export declare const onDeactivated: (cb: () => void) => void;
+/**
+ * @description  进入缓存,只会执行一次
+ * ```tsx
+ * import { onActivatedOnce } from 'solid-keepalive'
+ * onDeactivated(()=> console.log(234))
+ * ```
+ */
+export declare const onActivatedOnce: (cb: () => void) => void;

package/dist/types/aliveTransfer.d.ts

@@ -0,0 +1,14 @@
+import { type JSXElement } from "solid-js";
+/**
+ * @description 转换
+ * @example
+ * ```tsx
+ *  import Home from 'xxx'
+ *  const Home1 = aliveTransfer(Home, 'home')
+ * ```
+ * */
+declare const aliveTransfer: <T extends Record<string, any>>(Component: (props: T) => JSXElement, id: string, params?: {
+    /** 成一个独立缓存组件 */
+    isolated?: boolean;
+}) => (props: T) => import("solid-js").JSX.Element;
+export default aliveTransfer;

package/dist/types/context.d.ts

@@ -0,0 +1,12 @@
+declare const Context: import("solid-js").Context<{
+    currentIds: Set<string>;
+    include: import("solid-js").Accessor<Set<string>>;
+    caches: Record<string, import("./types").Cache>;
+    setCaches: import("solid-js/store").SetStoreFunction<import("./types").Caches>;
+    setActive: (id: string, t: import("./types").Activate, cb: () => void, t1: import("./types").SetType) => void;
+} | undefined>;
+declare const ChildContext: import("solid-js").Context<{
+    id: string;
+    noCache?: boolean;
+} | undefined>;
+export { ChildContext, Context };

package/dist/types/hooks.d.ts

@@ -0,0 +1,10 @@
+import { type Context } from "solid-js";
+/**
+ * @description 子路由组件级获取父路由组件的 context
+ * @example
+ * ```
+ * import UserContext from 'xxx'
+ * const data = useAliveContext(UserContext)
+ * ```
+ */
+export declare const useAliveContext: <T>(context: Context<T>) => T;

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+import AliveProvider from "./AliveProvider";
+import aliveTransfer from "./aliveTransfer";
+import { onActivated, onDeactivated } from "./aliveActive";
+import { useAliveContext } from "./hooks";
+export { AliveProvider, onActivated, onDeactivated, useAliveContext, aliveTransfer, };

package/dist/types/types.d.ts

@@ -0,0 +1,60 @@
+import type { JSXElement, Accessor, Owner } from "solid-js"
+import type { SetStoreFunction } from "solid-js/store"
+
+export type Expand<T> = T extends infer O ? { [K in keyof O]: O[K] } : never
+
+export type AliveProviderProps = {
+  /** 子组件 */
+  children: JSXElement
+  /** 缓存的路由, 如 include:['home','about'] */
+  include?: Array<string>
+}
+
+/** 缓存的数据 */
+export type Cache = Expand<{
+  /** 唯一值 */
+  id: string
+  /** 没有在 include 中的路由 */
+  noCache?: boolean
+  /** 表明dom加载过了 */
+  hasEl?: boolean
+  /** 是否有加载过,  */
+  init?: boolean
+  /** 其子数据 */
+  childIds?: Set<string>
+  /** 父级 */
+  parentId?: string | null
+  /** JSX */
+  component?: JSXElement
+  /** 上下文 */
+  owner: Owner | null
+  /** 销毁函数 */
+  dispose?: () => void
+  /** 只执行一次的 active, 会在页面加载时执行, */
+  aOnceSet?: Set<() => void>
+  /** 激活 */
+  aSet?: Set<() => void>
+  /** 离开 */
+  dSet?: Set<() => void>
+}>
+
+/** 所有缓存数据 */
+export type Caches = Record<string, Cache>
+
+/** 共享数据 */
+export type ContextProps = Expand<{
+  /** 当前正在展示的 所有id */
+  currentIds: Set<string>
+  /** 需要缓存的组件 id */
+  include: Accessor<Set<string>>
+  /** 数据 */
+  caches: Record<string, Cache>
+  /** 加 缓存 */
+  setCaches: SetStoreFunction<Caches>
+  /** 缓存回调函数 */
+  setActive: (id: string, t: Activate, cb: () => void, t1: SetType) => void
+}>
+
+export type Activate = "aSet" | "dSet" | "aOnceSet"
+export type MapType = "set" | "delete"
+export type SetType = "add" | "delete"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iuxs/solid-keep-alive",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "1iuxs",
   "description": "@iuxs/solid-keep-alive",
   "type": "module",