@stacksjs/stx-vscode 0.2.405 → 0.2.407

package/dist/typescript-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacksjs/stx-typescript-plugin",
-  "version": "0.2.405",
+  "version": "0.2.407",
   "private": true,
   "main": "index.js"
 }

package/dist/typescript-plugin/types/stx-module.d.ts

@@ -112,6 +112,9 @@ declare module 'stx' {
   export const useSessionStorage: typeof globalThis.useSessionStorage
   export const keptState: typeof globalThis.keptState
   export const forgetKeptState: typeof globalThis.forgetKeptState
+  export const setKeptScope: typeof globalThis.setKeptScope
+  export const flushKeptState: typeof globalThis.flushKeptState
+  export const cachedQuery: typeof globalThis.cachedQuery
   export const useSlots: typeof globalThis.useSlots
   export const useStore: typeof globalThis.useStore
   export const useThrottle: typeof globalThis.useThrottle

package/dist/typescript-plugin/types/stx.d.ts

@@ -484,7 +484,51 @@ declare function useSessionStorage<T>(_key: string, _defaultValue: T): StxSignal
 /** A value kept between visits (a phone app between launches) in a scope such as the signed-in account; a scope of false keeps nothing. */
 declare function keptState<T>(_name: string, _initialValue: T, _options?: { scope?: string | number | false | null }): StxSignal<T>
 /** Remove a scope's kept values, or every kept value. */
-declare function forgetKeptState(_scope?: string | number | false | null): void
+declare function forgetKeptState(_scope?: string | number | false | null): Promise<void>
+/** The account kept state and cached queries belong to when they name no scope. */
+declare function setKeptScope(_scope: string | number | false | null | undefined): void
+/** Finish writing what is kept (large values are written behind, to IndexedDB). */
+declare function flushKeptState(): Promise<void>
+
+/** Options of `cachedQuery`: see offline/query-cache.ts. */
+interface StxCachedQueryOptions<T> {
+  /** The URL to GET (answered as JSON), or a function giving it. */
+  url?: string | (() => string | null | undefined)
+  /** Load the data some other way than a GET of `url`. */
+  load?: (_context: { force: boolean, url: string | null, signal?: AbortSignal }) => Promise<T>
+  /** How to send the GET, with current credentials. */
+  fetch?: (_url: string, _init: RequestInit) => Promise<Response>
+  /** Whose data this is, as for keptState; a function is read at every load. Default: setKeptScope's. */
+  scope?: string | number | false | null | (() => string | number | false | null | undefined)
+  /** How long an answer counts as fresh, ms. Default 0. */
+  staleTime?: number
+  initial?: T
+  transform?: (_raw: any) => T
+  /** Give up on a request after this long, ms. Default 15000. */
+  timeoutMs?: number
+  /** Fetch when created. */
+  immediate?: boolean
+}
+
+interface StxCachedQuery<T> {
+  /** The last answer, with writes still waiting in the outbox applied. */
+  data: StxSignal<T>
+  loading: StxSignal<boolean>
+  isFetching: StxSignal<boolean>
+  error: StxSignal<string | null>
+  /** When the data shown was fetched (ms); 0 for none. */
+  updatedAt: StxSignal<number>
+  /** Fetch when older than staleTime (or always, with force). One request for every caller. */
+  load: (_force?: boolean) => Promise<T>
+  /** Fetch now, past every cache. */
+  refresh: () => Promise<T>
+  set: (_value: T | ((_current: T) => T)) => void
+  invalidate: () => void
+  readonly key: string
+}
+
+/** Data kept per account, shown at once from last time and refreshed behind. Same key, same query. */
+declare function cachedQuery<T = any>(_key: string, _options?: StxCachedQueryOptions<T>): StxCachedQuery<T>
 
 /**
  * Options accepted by the auto-imported `useCookie` global.
@@ -921,6 +965,9 @@ interface StxRuntimeRegistry {
   useSessionStorage: typeof useSessionStorage
   keptState: typeof keptState
   forgetKeptState: typeof forgetKeptState
+  setKeptScope: typeof setKeptScope
+  flushKeptState: typeof flushKeptState
+  cachedQuery: typeof cachedQuery
   useEventListener: typeof useEventListener
   useScrollLock: typeof useScrollLock
   useWebSocket: typeof useWebSocket

package/dist/typescript-plugin/typescript-stx-plugin.js

@@ -7,7 +7,7 @@ var w2=Object.create;var{getPrototypeOf:B2,defineProperty:D$,getOwnPropertyNames
 `?`
 `:" ",J++}Q+=" ",J++,Z=a,K="";continue}if(j==="/"&&C2(Z,K)){let z=y2($,J);if(z!==-1){Q+=`/${" ".repeat(z-J-2)}/`,J=z,Z=a,K="";continue}}if(j==="`"){Q+=" ",J++;while(J<$.length&&$[J]!=="`"){if($[J]==="\\"){Q+="  ",J+=2;continue}if($[J]==="$"&&$[J+1]==="{"){let z=J+2,V=I$($,z);if(Q+="  ",Q+=E($.slice(z,V)),V<$.length)Q+=" ";J=V+1;continue}Q+=$[J]===`
 `?`
-`:" ",J++}Q+=" ",J++,Z=a,K="";continue}if(Q+=j,J++,/[\w$]/.test(j))K=/[\w$]/.test(Z)?K+j:j,Z=j;else if(!/\s/.test(j))Z=j,K=""}return Q}function o($){let Q=new Uint16Array($.length),J=0,Z=!0;for(let K=0;K<$.length;K++){let Y=$[K];if(Y===")"||Y==="]"||Y==="}")if(J===0)Z=!1;else J--;if(Q[K]=J,Y==="("||Y==="["||Y==="{")J++}return{depths:Q,balanced:Z&&J===0}}function P$($){let Q=$.indexOf(" as ");if(Q!==-1){let Y=$.slice(0,Q).trim(),j=$.slice(Q+4).trim();return Y&&j?{arrayExpr:Y,itemVar:j}:null}let J=/^\s*(.+?)\s+in\s+([\s\S]+)$/.exec($);if(!J)return null;let Z=J[1].trim().replace(/^\(([\s\S]*)\)$/,"$1").trim(),K=J[2].trim();return Z&&K?{arrayExpr:K,itemVar:Z}:null}var p=["batch","clearServerData","computed","configureFetch","defineEmits","defineExpose","definePageMeta","defineProps","defineSlots","defineStore","derived","effect","forgetKeptState","goBack","goForward","inject","invalidateRoute","isDerived","isSignal","keptState","navigate","nextTick","onBeforeMount","onBeforeUnmount","onDestroy","onMount","onMounted","onUnmounted","peek","provide","reactive","ref","refresh","registerStoresClient","setRouteParams","state","untrack","useAsync","useClickOutside","useColorMode","useCookie","useCounter","useDark","useDebounce","useDebouncedValue","useDocumentVisibility","useEventListener","useFetch","useFocus","useHead","useId","useInterval","useLocalStorage","useMediaQuery","useModel","useMutation","useOptimistic","usePreferredContrast","usePreferredDark","usePreferredLight","usePreferredReducedMotion","useQuery","useReactiveProp","useRef","useRoute","useRouteParam","useRouteParams","useScrollLock","useSearchParams","useSeoMeta","useSessionStorage","useSlots","useStore","useThrottle","useTimeout","useToggle","useWebSocket","watch","watchEffect","watchMultiple","withDefaults"];var A2=["defineEmits","defineExpose","definePageMeta","defineProps","defineSlots","withDefaults"];var I4=p.filter(($)=>!A2.includes($));var R2=["x-text","x-html","x-model","x-show","x-if","x-for","x-cloak","x-ref","x-data","x-bind","x-class","x-style","x-tooltip","x-tooltip-position"],_2=["x-init","x-transition","x-effect","x-on"],P4=[...R2,..._2];var t=h(require("node:fs")),m=h(require("node:path"));function L$($,Q,J,Z){let K=0;for(let Y=Q;Y<$.length;Y++)if($[Y]===J)K++;else if($[Y]===Z&&!(Z===">"&&$[Y-1]==="=")){if(--K===0)return Y}return-1}function S2($){let Q=E($),J=0,Z=0,K=[];for(let Y=0;Y<Q.length;Y++)if("([{".includes(Q[Y]))J++;else if(")]}".includes(Q[Y]))J--;else if(Q[Y]===","&&J===0)K.push($.slice(Z,Y).trim()),Z=Y+1;return K.push($.slice(Z).trim()),K}function Y$($,Q){let J=E($),Z=new RegExp(`\\b(?:${Q.map((K)=>K.replace(/[$]/g,"\\$&")).join("|")})\\s*(?=[<(])`,"g");for(let K of J.matchAll(Z)){let Y=K.index+K[0].length,j="";if(J[Y]==="<"){let V=L$(J,Y,"<",">");if(V<0)continue;j=$.slice(Y+1,V),Y=V+1;while(/\s/.test(J[Y]||"")&&Y<J.length)Y++}if(J[Y]!=="(")continue;let z=L$(J,Y,"(",")");if(z>=0)return{type:j,args:S2($.slice(Y+1,z))}}return null}var C$=`
+`:" ",J++}Q+=" ",J++,Z=a,K="";continue}if(Q+=j,J++,/[\w$]/.test(j))K=/[\w$]/.test(Z)?K+j:j,Z=j;else if(!/\s/.test(j))Z=j,K=""}return Q}function o($){let Q=new Uint16Array($.length),J=0,Z=!0;for(let K=0;K<$.length;K++){let Y=$[K];if(Y===")"||Y==="]"||Y==="}")if(J===0)Z=!1;else J--;if(Q[K]=J,Y==="("||Y==="["||Y==="{")J++}return{depths:Q,balanced:Z&&J===0}}function P$($){let Q=$.indexOf(" as ");if(Q!==-1){let Y=$.slice(0,Q).trim(),j=$.slice(Q+4).trim();return Y&&j?{arrayExpr:Y,itemVar:j}:null}let J=/^\s*(.+?)\s+in\s+([\s\S]+)$/.exec($);if(!J)return null;let Z=J[1].trim().replace(/^\(([\s\S]*)\)$/,"$1").trim(),K=J[2].trim();return Z&&K?{arrayExpr:K,itemVar:Z}:null}var p=["batch","cachedQuery","clearServerData","computed","configureFetch","defineEmits","defineExpose","definePageMeta","defineProps","defineSlots","defineStore","derived","effect","flushKeptState","forgetKeptState","goBack","goForward","inject","invalidateRoute","isDerived","isSignal","keptState","navigate","nextTick","onBeforeMount","onBeforeUnmount","onDestroy","onMount","onMounted","onUnmounted","peek","provide","reactive","ref","refresh","registerStoresClient","setKeptScope","setRouteParams","state","untrack","useAsync","useClickOutside","useColorMode","useCookie","useCounter","useDark","useDebounce","useDebouncedValue","useDocumentVisibility","useEventListener","useFetch","useFocus","useHead","useId","useInterval","useLocalStorage","useMediaQuery","useModel","useMutation","useOptimistic","usePreferredContrast","usePreferredDark","usePreferredLight","usePreferredReducedMotion","useQuery","useReactiveProp","useRef","useRoute","useRouteParam","useRouteParams","useScrollLock","useSearchParams","useSeoMeta","useSessionStorage","useSlots","useStore","useThrottle","useTimeout","useToggle","useWebSocket","watch","watchEffect","watchMultiple","withDefaults"];var A2=["defineEmits","defineExpose","definePageMeta","defineProps","defineSlots","withDefaults"];var I4=p.filter(($)=>!A2.includes($));var R2=["x-text","x-html","x-model","x-show","x-if","x-for","x-cloak","x-ref","x-data","x-bind","x-class","x-style","x-tooltip","x-tooltip-position"],_2=["x-init","x-transition","x-effect","x-on"],P4=[...R2,..._2];var t=h(require("node:fs")),m=h(require("node:path"));function L$($,Q,J,Z){let K=0;for(let Y=Q;Y<$.length;Y++)if($[Y]===J)K++;else if($[Y]===Z&&!(Z===">"&&$[Y-1]==="=")){if(--K===0)return Y}return-1}function S2($){let Q=E($),J=0,Z=0,K=[];for(let Y=0;Y<Q.length;Y++)if("([{".includes(Q[Y]))J++;else if(")]}".includes(Q[Y]))J--;else if(Q[Y]===","&&J===0)K.push($.slice(Z,Y).trim()),Z=Y+1;return K.push($.slice(Z).trim()),K}function Y$($,Q){let J=E($),Z=new RegExp(`\\b(?:${Q.map((K)=>K.replace(/[$]/g,"\\$&")).join("|")})\\s*(?=[<(])`,"g");for(let K of J.matchAll(Z)){let Y=K.index+K[0].length,j="";if(J[Y]==="<"){let V=L$(J,Y,"<",">");if(V<0)continue;j=$.slice(Y+1,V),Y=V+1;while(/\s/.test(J[Y]||"")&&Y<J.length)Y++}if(J[Y]!=="(")continue;let z=L$(J,Y,"(",")");if(z>=0)return{type:j,args:S2($.slice(Y+1,z))}}return null}var C$=`
 type __StxCtor<T> = T extends StringConstructor ? string : T extends NumberConstructor ? number : T extends BooleanConstructor ? boolean : T extends ArrayConstructor ? unknown[] : T extends ObjectConstructor ? object : T extends readonly unknown[] ? __StxCtor<T[number]> : T extends abstract new (...args: any[]) => infer V ? V : unknown;
 type __StxWiden<T> = T extends string ? string : T extends number ? number : T extends boolean ? boolean : T;
 type __StxOption<T> = T extends { type: infer C } ? __StxCtor<C> : T extends { default: infer D } ? D extends (...args: any[]) => infer V ? V : __StxWiden<D> : __StxCtor<T>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/stx-vscode",
   "type": "module",
-  "version": "0.2.405",
+  "version": "0.2.407",
   "description": "stx language support for VS Code extensions to embed: the hovers, completions, diagnostics, grammar, snippets, language configuration and TypeScript server plugin behind the stx extension.",
   "author": "Chris Breuer <chris@stacksjs.org>",
   "license": "MIT",