storage: tauri submodule

.changeset/few-baboons-promise.md

@@ -0,0 +1,5 @@
+---
+"@solid-primitives/storage": minor
+---
+
+move tauri storage to submodule

packages/share/package.json

@@ -2,7 +2,7 @@
   "name": "@solid-primitives/share",
   "version": "2.0.6",
   "description": "Primitives to help with sharing content on social media and beyond.",
-  "author": "David Di Biase <dave.dibiase@gmail.com",
+  "author": "David Di Biase <dave.dibiase@gmail.com>",
   "contributors": [
     "Omer Ma<mapinxue@qq.com>",
     "Tom Pichaud <dev.tompichaud@icloud.com>"

packages/storage/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @solid-primitives/storage
 
+## 3.5.0
+
+### Minor Changes
+
+- 72db58b: type fixes for makePersisted
+
 ## 3.4.0
 
 ### Minor Changes

packages/storage/README.md

@@ -138,6 +138,8 @@ fn main() {
 Once these preparations are finished, `tauriStorage(name?: string)` can be used as another storage option. To fallback to localStorage if the app does not run within tauri, you can check for `window.__TAURI_INTERNALS__`:
 
 ```ts
+import { tauriStorage } from "@solid-primitives/storage/tauri";
+
 const storage = window.__TAURI_INTERNALS__ ? tauriStorage() : localStorage;
 ```
 

packages/storage/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solid-primitives/storage",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Primitive that provides reactive wrappers for storage access",
   "author": "Alex Lohr <alex.lohr@logmein.com>",
   "contributors": [

packages/storage/src/index.ts

@@ -22,13 +22,11 @@ import {
   createSessionStorage,
 } from "./storage.js";
 import { type CookieOptions, cookieStorage, createCookieStorage } from "./cookies.js";
-import { tauriStorage } from "./tauri.js";
 import { addClearMethod, addWithOptionsMethod, multiplexStorage } from "./tools.js";
 import {
   type PersistenceOptions,
   type PersistenceSyncAPI,
   type PersistenceSyncData,
-  type PersistenceBaseOptions,
   type PersistenceSyncCallback,
   makePersisted,
   multiplexSync,
@@ -45,11 +43,9 @@ export {
   createSessionStorage,
   type CookieOptions,
   cookieStorage,
-  tauriStorage,
   addClearMethod,
   addWithOptionsMethod,
   multiplexStorage,
-  type PersistenceBaseOptions,
   type PersistenceOptions,
   type PersistenceSyncCallback,
   type PersistenceSyncData,

packages/storage/src/persisted.ts

@@ -1,4 +1,4 @@
-import type { Accessor, Setter, Signal } from "solid-js";
+import type { Setter, Signal } from "solid-js";
 import { createUniqueId, untrack } from "solid-js";
 import { isServer, isDev } from "solid-js/web";
 import type { SetStoreFunction, Store } from "solid-js/store";
@@ -20,121 +20,20 @@ export type PersistenceSyncAPI = [
   update: (key: string, value: string | null | undefined) => void,
 ];
 
-export type PersistenceBaseOptions<T> = {
+export type PersistenceOptions<T, O extends Record<string, any> | undefined> = {
   name?: string;
   serialize?: (data: T) => string;
   deserialize?: (data: string) => T;
   sync?: PersistenceSyncAPI;
-};
-
-export type PersistenceOptions<T, O extends Record<string, any>> = PersistenceBaseOptions<T> &
-  (
-    | {
-        storage: StorageWithOptions<O> | AsyncStorageWithOptions<O>;
-        storageOptions: O;
-      }
-    | { storage?: Storage | AsyncStorage }
-  );
-
-/**
- * Persists a signal, store or similar API
- *  ```ts
- *  const [getter, setter] = makePersisted(createSignal("data"), options);
- *  const options = {
- *    storage: cookieStorage,  // can be any synchronous or asynchronous storage
- *    storageOptions: { ... }, // for storages with options, otherwise not needed
- *    name: "solid-data",      // optional
- *    serialize: (value: string) => value, // optional
- *    deserialize: (data: string) => data, // optional
- *  };
- *  ```
- *  Can be used with `createSignal` or `createStore`. The initial value from the storage will overwrite the initial
- *  value of the signal or store unless overwritten. Overwriting a signal with `null` or `undefined` will remove the
- *  item from the storage.
- *
- * @param {Signal<T> | [get: Store<T>, set: SetStoreFunction<T>]} signal - The signal or store to be persisted.
- * @param {PersistenceOptions<T, O>} options - The options for persistence.
- * @returns {Signal<T> | [get: Store<T>, set: SetStoreFunction<T>]} - The persisted signal or store.
- */
-export function makePersisted<T>(
-  signal: [Accessor<T>, Setter<T>],
-  options?: PersistenceOptions<T, {}>,
-): [Accessor<T>, Setter<T>];
-
-/**
- * Persists a signal, store or similar API
- *  ```ts
- *  const [getter, setter] = makePersisted(createSignal("data"), options);
- *  const options = {
- *    storage: cookieStorage,  // can be any synchronous or asynchronous storage
- *    storageOptions: { ... }, // for storages with options, otherwise not needed
- *    name: "solid-data",      // optional
- *    serialize: (value: string) => value, // optional
- *    deserialize: (data: string) => data, // optional
- *  };
- *  ```
- *  Can be used with `createSignal` or `createStore`. The initial value from the storage will overwrite the initial
- *  value of the signal or store unless overwritten. Overwriting a signal with `null` or `undefined` will remove the
- *  item from the storage.
- *
- * @param {Signal<T> | [get: Store<T>, set: SetStoreFunction<T>]} signal - The signal or store to be persisted.
- * @param {PersistenceOptions<T, O>} options - The options for persistence.
- * @returns {Signal<T> | [get: Store<T>, set: SetStoreFunction<T>]} - The persisted signal or store.
- */
-export function makePersisted<T, O extends Record<string, any>>(
-  signal: Signal<T>,
-  options: PersistenceOptions<T, O>,
-): Signal<T>;
-
-/**
- * Persists a signal, store or similar API
- *  ```ts
- *  const [getter, setter] = makePersisted(createSignal("data"), options);
- *  const options = {
- *    storage: cookieStorage,  // can be any synchronous or asynchronous storage
- *    storageOptions: { ... }, // for storages with options, otherwise not needed
- *    name: "solid-data",      // optional
- *    serialize: (value: string) => value, // optional
- *    deserialize: (data: string) => data, // optional
- *  };
- *  ```
- *  Can be used with `createSignal` or `createStore`. The initial value from the storage will overwrite the initial
- *  value of the signal or store unless overwritten. Overwriting a signal with `null` or `undefined` will remove the
- *  item from the storage.
- *
- * @param {Signal<T> | [get: Store<T>, set: SetStoreFunction<T>]} signal - The signal or store to be persisted.
- * @param {PersistenceOptions<T, O>} options - The options for persistence.
- * @returns {Signal<T> | [get: Store<T>, set: SetStoreFunction<T>]} - The persisted signal or store.
- */
-export function makePersisted<T>(
-  signal: [get: Store<T>, set: SetStoreFunction<T>],
-  options?: PersistenceOptions<T, {}>,
-): [get: Store<T>, set: SetStoreFunction<T>];
+} & (undefined extends O
+  ? { storage?: Storage | AsyncStorage }
+  : {
+      storage: StorageWithOptions<O> | AsyncStorageWithOptions<O>;
+      storageOptions?: O;
+    });
 
-/**
- * Persists a signal, store or similar API
- *  ```ts
- *  const [getter, setter] = makePersisted(createSignal("data"), options);
- *  const options = {
- *    storage: cookieStorage,  // can be any synchronous or asynchronous storage
- *    storageOptions: { ... }, // for storages with options, otherwise not needed
- *    name: "solid-data",      // optional
- *    serialize: (value: string) => value, // optional
- *    deserialize: (data: string) => data, // optional
- *  };
- *  ```
- *  Can be used with `createSignal` or `createStore`. The initial value from the storage will overwrite the initial
- *  value of the signal or store unless overwritten. Overwriting a signal with `null` or `undefined` will remove the
- *  item from the storage.
- *
- * @param {Signal<T> | [get: Store<T>, set: SetStoreFunction<T>]} signal - The signal or store to be persisted.
- * @param {PersistenceOptions<T, O>} options - The options for persistence.
- * @returns {Signal<T> | [get: Store<T>, set: SetStoreFunction<T>]} - The persisted signal or store.
- */
-export function makePersisted<T, O extends Record<string, any>>(
-  signal: [get: Store<T>, set: SetStoreFunction<T>],
-  options: PersistenceOptions<T, O>,
-): [get: Store<T>, set: SetStoreFunction<T>];
+export type SignalType<S extends Signal<any> | [Store<any>, SetStoreFunction<any>]> =
+  S extends Signal<infer T> ? T : S extends [Store<infer T>, SetStoreFunction<infer T>] ? T : never;
 
 /**
  * Persists a signal, store or similar API
@@ -156,10 +55,19 @@ export function makePersisted<T, O extends Record<string, any>>(
  * @param {PersistenceOptions<T, O>} options - The options for persistence.
  * @returns {Signal<T> | [get: Store<T>, set: SetStoreFunction<T>]} - The persisted signal or store.
  */
-export function makePersisted<T, O extends Record<string, any> = {}>(
-  signal: Signal<T> | [get: Store<T>, set: SetStoreFunction<T>],
-  options: PersistenceOptions<T, O> = {},
-): Signal<T> | [get: Store<T>, set: SetStoreFunction<T>] {
+export function makePersisted<S extends Signal<any> | [Store<any>, SetStoreFunction<any>]>(
+  signal: S,
+  options?: PersistenceOptions<SignalType<S>, undefined>,
+): S;
+export function makePersisted<
+  S extends Signal<any> | [Store<any>, SetStoreFunction<any>],
+  O extends Record<string, any>,
+>(signal: S, options: PersistenceOptions<SignalType<S>, O>): S;
+export function makePersisted<
+  S extends Signal<any> | [Store<any>, SetStoreFunction<any>],
+  O extends Record<string, any> | undefined,
+  T = SignalType<S>,
+>(signal: S, options: PersistenceOptions<T, O> = {} as PersistenceOptions<T, O>): S {
   const storage = options.storage || globalThis.localStorage;
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   if (!storage) {
@@ -229,7 +137,7 @@ export function makePersisted<T, O extends Record<string, any> = {}>(
           storage.setItem(name, value, storageOptions);
           unchanged = false;
         },
-  ] as typeof signal;
+  ] as S;
 }
 
 /**

scripts/build.ts

@@ -26,6 +26,24 @@ const custom_entries: Record<string, preset.EntryOptions | preset.EntryOptions[]
   "controlled-props": {
     entry: "src/index.tsx",
   },
+  /*filesystem: [
+    {
+      entry: "src/index.ts",
+    },
+    {
+      entry: "src/tauri.ts",
+      name: "tauri",
+    },
+  ],*/
+  storage: [
+    {
+      entry: "src/index.ts",
+    },
+    {
+      entry: "src/tauri.ts",
+      name: "tauri",
+    },
+  ],
   utils: [
     {
       entry: "src/index.ts",