@legendapp/state 2.2.0-next.3 → 2.2.0-next.30

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 (108) hide show
  1. package/babel.js.map +1 -1
  2. package/config/enableDirectAccess.d.ts +1 -1
  3. package/config/enableDirectPeek.d.ts +1 -1
  4. package/config/enableReactDirectRender.js.map +1 -1
  5. package/config/enableReactDirectRender.mjs.map +1 -1
  6. package/config/enableReactTracking.d.ts +4 -3
  7. package/config/enableReactTracking.js.map +1 -1
  8. package/config/enableReactTracking.mjs.map +1 -1
  9. package/config/enableReactUse.d.ts +1 -1
  10. package/helpers/fetch.d.ts +4 -3
  11. package/helpers/fetch.js.map +1 -1
  12. package/helpers/fetch.mjs.map +1 -1
  13. package/helpers/pageHash.js.map +1 -1
  14. package/helpers/pageHash.mjs.map +1 -1
  15. package/helpers/pageHashParams.js.map +1 -1
  16. package/helpers/pageHashParams.mjs.map +1 -1
  17. package/helpers/time.d.ts +2 -2
  18. package/helpers/time.js.map +1 -1
  19. package/helpers/time.mjs.map +1 -1
  20. package/history.js.map +1 -1
  21. package/history.mjs.map +1 -1
  22. package/index.d.ts +15 -4
  23. package/index.js +534 -242
  24. package/index.js.map +1 -1
  25. package/index.mjs +533 -243
  26. package/index.mjs.map +1 -1
  27. package/package.json +2 -10
  28. package/persist-plugins/async-storage.js.map +1 -1
  29. package/persist-plugins/async-storage.mjs.map +1 -1
  30. package/persist-plugins/fetch.js.map +1 -1
  31. package/persist-plugins/fetch.mjs.map +1 -1
  32. package/persist-plugins/firebase.js.map +1 -1
  33. package/persist-plugins/firebase.mjs.map +1 -1
  34. package/persist-plugins/indexeddb.js.map +1 -1
  35. package/persist-plugins/indexeddb.mjs.map +1 -1
  36. package/persist-plugins/local-storage.js +10 -2
  37. package/persist-plugins/local-storage.js.map +1 -1
  38. package/persist-plugins/local-storage.mjs +10 -2
  39. package/persist-plugins/local-storage.mjs.map +1 -1
  40. package/persist-plugins/mmkv.js.map +1 -1
  41. package/persist-plugins/mmkv.mjs.map +1 -1
  42. package/persist-plugins/query.js.map +1 -1
  43. package/persist-plugins/query.mjs.map +1 -1
  44. package/persist.d.ts +15 -1
  45. package/persist.js +365 -116
  46. package/persist.js.map +1 -1
  47. package/persist.mjs +366 -117
  48. package/persist.mjs.map +1 -1
  49. package/react-hooks/createObservableHook.js +1 -1
  50. package/react-hooks/createObservableHook.js.map +1 -1
  51. package/react-hooks/createObservableHook.mjs +1 -1
  52. package/react-hooks/createObservableHook.mjs.map +1 -1
  53. package/react-hooks/useFetch.d.ts +4 -3
  54. package/react-hooks/useFetch.js.map +1 -1
  55. package/react-hooks/useFetch.mjs.map +1 -1
  56. package/react-hooks/useHover.js.map +1 -1
  57. package/react-hooks/useHover.mjs.map +1 -1
  58. package/react-hooks/useMeasure.js.map +1 -1
  59. package/react-hooks/useMeasure.mjs.map +1 -1
  60. package/react-hooks/useObservableNextRouter.js.map +1 -1
  61. package/react-hooks/useObservableNextRouter.mjs.map +1 -1
  62. package/react-hooks/useObservableQuery.js.map +1 -1
  63. package/react-hooks/useObservableQuery.mjs.map +1 -1
  64. package/react-hooks/usePersistedObservable.d.ts +2 -2
  65. package/react-hooks/usePersistedObservable.js +3 -3
  66. package/react-hooks/usePersistedObservable.js.map +1 -1
  67. package/react-hooks/usePersistedObservable.mjs +3 -3
  68. package/react-hooks/usePersistedObservable.mjs.map +1 -1
  69. package/react.js +13 -8
  70. package/react.js.map +1 -1
  71. package/react.mjs +14 -9
  72. package/react.mjs.map +1 -1
  73. package/src/ObservableObject.d.ts +8 -4
  74. package/src/ObservablePrimitive.d.ts +2 -1
  75. package/src/activated.d.ts +3 -0
  76. package/src/batching.d.ts +3 -1
  77. package/src/computed.d.ts +1 -1
  78. package/src/config/enableDirectAccess.d.ts +1 -1
  79. package/src/config/enableDirectPeek.d.ts +1 -1
  80. package/src/config/enableReactTracking.d.ts +4 -3
  81. package/src/config/enableReactUse.d.ts +1 -1
  82. package/src/createObservable.d.ts +2 -2
  83. package/src/globals.d.ts +11 -4
  84. package/src/helpers/fetch.d.ts +4 -3
  85. package/src/helpers/time.d.ts +2 -2
  86. package/src/helpers.d.ts +3 -2
  87. package/src/history/trackHistory.d.ts +1 -1
  88. package/src/observable.d.ts +6 -15
  89. package/src/observableInterfaces.d.ts +60 -331
  90. package/src/observableTypes.d.ts +93 -0
  91. package/src/persist/observablePersistRemoteFunctionsAdapter.d.ts +1 -1
  92. package/src/persist/persistActivateNode.d.ts +1 -0
  93. package/src/persist/persistHelpers.d.ts +1 -1
  94. package/src/persist/persistObservable.d.ts +3 -12
  95. package/src/persistTypes.d.ts +229 -0
  96. package/src/proxy.d.ts +2 -1
  97. package/src/react/Computed.d.ts +1 -1
  98. package/src/react/Switch.d.ts +3 -3
  99. package/src/react/reactInterfaces.d.ts +2 -1
  100. package/src/react/usePauseProvider.d.ts +3 -3
  101. package/src/react/useWhen.d.ts +2 -2
  102. package/src/react-hooks/useFetch.d.ts +4 -3
  103. package/src/react-hooks/usePersistedObservable.d.ts +2 -2
  104. package/src/retry.d.ts +6 -0
  105. package/src/trackSelector.d.ts +3 -2
  106. package/src/when.d.ts +6 -2
  107. package/trace.js.map +1 -1
  108. package/trace.mjs.map +1 -1
@@ -1,4 +1,4 @@
1
1
  import { ObservableReadable, ObservableWriteable } from '@legendapp/state';
2
2
  type TimestampAsString = string;
3
- export declare function trackHistory<T>(obs: ObservableReadable<T>, targetObservable?: ObservableWriteable<Record<TimestampAsString, Partial<T>>>): ObservableWriteable<Record<string, Partial<T>>>;
3
+ export declare function trackHistory<T>(obs: ObservableReadable<T>, targetObservable?: ObservableWriteable<Record<TimestampAsString, Partial<T>>>): ObservableWriteable<Record<TimestampAsString, any>>;
4
4
  export {};
@@ -1,16 +1,7 @@
1
- import type { ActivateParams, ActivateProxyParams, Observable, ObservableComputed, ObservablePrimitive, RecordValue, WithState } from './observableInterfaces';
2
- type TWithFunctions<T> = T | {
3
- [K in keyof T]: ((params: ActivateProxyParams<T[K] | RecordValue<T[K]>>) => TWithFunctions<T[K]> | Promise<TWithFunctions<T[K]>> | void) | TWithFunctions<T[K]>;
4
- };
5
- export declare function observable<T>(value: Promise<T>): Observable<T & WithState>;
6
- export declare function observable<T>(value: () => Observable<T>): Observable<T>;
7
- export declare function observable<T>(value: () => Promise<T>): Observable<T & WithState>;
8
- export declare function observable<T>(value: () => T): ObservableComputed<T>;
9
- export declare function observable<T>(value: (params: ActivateParams) => Observable<T>): Observable<T & WithState>;
10
- export declare function observable<T>(value: (params: ActivateParams) => Promise<T>): Observable<T & WithState>;
11
- export declare function observable<T>(value: (params: ActivateParams) => T): Observable<T>;
12
- export declare function observable<T>(value: (params: ActivateProxyParams<T>) => void): Observable<Record<string, T> & WithState>;
13
- export declare function observable<T>(value?: TWithFunctions<T>): Observable<T>;
14
- export declare function observablePrimitive<T>(value: Promise<T>): ObservablePrimitive<T & WithState>;
1
+ import { ObservablePersistState } from './persistTypes';
2
+ import type { Observable, ObservablePrimitive, ObservableReadable, RecursiveValueOrFunction } from './observableTypes';
3
+ export declare function observable<T>(): Observable<T | undefined>;
4
+ export declare function observable<T>(value: Promise<RecursiveValueOrFunction<T>> | RecursiveValueOrFunction<T>): Observable<T>;
5
+ export declare function observablePrimitive<T>(value: Promise<T>): ObservablePrimitive<T>;
15
6
  export declare function observablePrimitive<T>(value?: T): ObservablePrimitive<T>;
16
- export {};
7
+ export declare function syncState(obs: ObservableReadable): Observable<ObservablePersistState>;
@@ -1,122 +1,24 @@
1
- import type { AsyncStorageStatic } from '@react-native-async-storage/async-storage';
2
1
  import type { symbolGetNode, symbolOpaque } from './globals';
3
- import { DatabaseReference, Query } from 'firebase/database';
4
- interface MMKVConfiguration {
5
- /**
6
- * The MMKV instance's ID. If you want to use multiple instances, make sure to use different IDs!
7
- *
8
- * @example
9
- * ```ts
10
- * const userStorage = new MMKV({ id: `user-${userId}-storage` })
11
- * const globalStorage = new MMKV({ id: 'global-app-storage' })
12
- * ```
13
- *
14
- * @default 'mmkv.default'
15
- */
16
- id: string;
17
- /**
18
- * The MMKV instance's root path. By default, MMKV stores file inside `$(Documents)/mmkv/`. You can customize MMKV's root directory on MMKV initialization:
19
- *
20
- * @example
21
- * ```ts
22
- * const temporaryStorage = new MMKV({ path: '/tmp/' })
23
- * ```
24
- */
25
- path?: string;
26
- /**
27
- * The MMKV instance's encryption/decryption key. By default, MMKV stores all key-values in plain text on file, relying on iOS's sandbox to make sure the file is encrypted. Should you worry about information leaking, you can choose to encrypt MMKV.
28
- *
29
- * Encryption keys can have a maximum length of 16 bytes.
30
- *
31
- * @example
32
- * ```ts
33
- * const secureStorage = new MMKV({ encryptionKey: 'my-encryption-key!' })
34
- * ```
35
- */
36
- encryptionKey?: string;
37
- }
38
- type Nullable<T> = T | null | undefined;
2
+ import type { Observable, ObservableComputed, ObservableComputed as ObservableComputedNew, ObservableComputedTwoWay, Observable as ObservableNew, ObservableReadable, ObservableReadable as ObservableReadableNew } from './observableTypes';
3
+ import type { ObservablePersistState } from './persistTypes';
39
4
  export type TrackingType = undefined | true | symbol;
40
- export interface MapGet<T extends Map<any, any> | WeakMap<any, any>> {
41
- get(key: Parameters<T['get']>[0]): ObservableChild<Parameters<T['set']>[1]>;
42
- get(): T;
43
- size: ObservableChild<number>;
44
- }
45
5
  export interface GetOptions {
46
6
  shallow: boolean;
47
7
  }
48
- export interface ObservableBaseFns<T> {
49
- peek(): T;
50
- get(options?: TrackingType | GetOptions): T;
51
- onChange(cb: ListenerFn<T>, options?: {
52
- trackingType?: TrackingType;
53
- initial?: boolean;
54
- immediate?: boolean;
55
- noArgs?: boolean;
56
- }): ObservableListenerDispose;
57
- }
58
- export interface ObservablePrimitiveBaseFns<T> extends ObservableBaseFns<T> {
59
- delete(): ObservablePrimitiveBaseFns<T>;
60
- set(value: Nullable<T> | CallbackSetter<T> | Promise<T> | Observable<T>): ObservablePrimitiveChild<T>;
61
- }
62
- export interface ObservablePrimitiveBooleanFns<T> {
63
- toggle(): T;
64
- }
65
- export interface ObservableObjectFns<T> extends ObservableBaseFns<T> {
66
- set(value: Nullable<T> | CallbackSetter<T> | Promise<T> | Observable<T>): ObservableChild<T>;
67
- assign(value: T | Partial<T>): ObservableChild<T>;
68
- delete(): ObservableChild<T>;
69
- }
70
- export type ObservablePrimitive<T> = [T] extends [boolean] ? ObservablePrimitiveBaseFns<T> & ObservablePrimitiveBooleanFns<T> : ObservablePrimitiveBaseFns<T>;
71
- export interface ObservablePrimitiveChildFns<T> extends ObservablePrimitiveBaseFns<T> {
72
- delete(): ObservablePrimitiveChild<T>;
73
- }
74
- type CallbackSetter<T> = {
75
- bivarianceHack(prev: T): T;
76
- }['bivarianceHack'];
77
8
  export type OpaqueObject<T> = T & {
78
9
  [symbolOpaque]: true;
79
10
  };
80
- type ArrayOverrideFnNames = 'find' | 'every' | 'some' | 'filter' | 'reduce' | 'reduceRight' | 'forEach' | 'map';
81
- type RemoveIndex<T> = {
82
- [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K];
83
- };
84
- export type ObservableArrayOverride<T> = Omit<RemoveIndex<Array<T>>, ArrayOverrideFnNames> & Pick<Array<Observable<T>>, ArrayOverrideFnNames> & {
85
- [n: number]: Observable<T>;
86
- };
87
11
  export interface ListenerParams<T = any> {
88
12
  value: T;
89
13
  getPrevious: () => T;
90
14
  changes: Change[];
91
15
  }
92
16
  export type ListenerFn<T = any> = (params: ListenerParams<T>) => void;
93
- type PrimitiveKeys<T> = Pick<T, {
94
- [K in keyof T]-?: T[K] extends Primitive ? K : never;
95
- }[keyof T]>;
96
- type NonPrimitiveKeys<T> = Pick<T, {
97
- [K in keyof T]-?: T[K] extends Primitive ? never : K;
98
- }[keyof T]>;
99
- type Recurse<T, K extends keyof T, TRecurse> = T[K] extends ObservableReadable ? T[K] : T[K] extends Promise<infer t> ? Observable<t & WithState> : T[K] extends () => infer t ? t extends Observable ? t : Observable<t> & T[K] : T[K] extends (params: ActivateParams) => infer t ? t extends Observable ? t : Observable<t> : T[K] extends (params: ActivateProxyParams<infer t>) => void ? t extends Observable ? Record<string, t> : Observable<Record<string, t>> : T[K] extends Function ? T[K] : T[K] extends ObservableProxyTwoWay<infer t, infer t2> ? ObservableProxyTwoWay<t, t2> : T[K] extends ObservableProxy<infer t> ? ObservableProxy<t> : T[K] extends ObservableProxyLink<infer t> ? ObservableProxyLink<t> : T[K] extends Map<any, any> | WeakMap<any, any> ? ObservableMap<T[K]> : T[K] extends Set<any> | WeakSet<any> ? ObservableSet<T[K]> : T[K] extends Set<any> | WeakSet<any> ? T[K] & ObservablePrimitiveBaseFns<T[K]> : T[K] extends OpaqueObject<T[K]> ? T[K] & ObservablePrimitiveChildFns<T[K]> : T[K] extends Primitive ? ObservablePrimitiveChild<T[K]> : T[K] extends Array<any> ? ObservableObjectFns<T[K]> & ObservableArrayOverride<T[K][number]> : T extends object ? TRecurse : T[K];
100
- type ObservableFnsRecursiveUnsafe<T> = {
101
- [K in keyof T]-?: Recurse<T, K, ObservableObject<NonNullable<T[K]>>>;
102
- };
103
- type ObservableFnsRecursiveSafe<T> = {
104
- readonly [K in keyof T]-?: Recurse<T, K, ObservableObject<NonNullable<T[K]>>>;
105
- };
106
- type ObservableFnsRecursive<T> = ObservableFnsRecursiveSafe<NonPrimitiveKeys<T>> & ObservableFnsRecursiveUnsafe<PrimitiveKeys<T>>;
107
- type ObservableComputedFnsRecursive<T> = {
108
- readonly [K in keyof T]-?: Recurse<T, K, ObservableBaseFns<NonNullable<T[K]>>>;
109
- };
110
17
  export interface ObservableEvent {
111
18
  fire(): void;
112
19
  on(cb?: () => void): ObservableListenerDispose;
113
20
  get(): void;
114
21
  }
115
- export type QueryByModified<T> = boolean | {
116
- [K in keyof T]?: QueryByModified<T[K]>;
117
- } | {
118
- '*'?: boolean;
119
- };
120
22
  export type TypeAtPath = 'object' | 'array';
121
23
  export interface Change {
122
24
  path: string[];
@@ -124,193 +26,10 @@ export interface Change {
124
26
  valueAtPath: any;
125
27
  prevAtPath: any;
126
28
  }
127
- export interface PersistTransform<T = any> {
128
- in?: (value: T) => T | Promise<T>;
129
- out?: (value: T) => T | Promise<T>;
130
- }
131
- export interface PersistOptionsLocal<T = any> {
132
- name: string;
133
- transform?: PersistTransform<T>;
134
- fieldTransforms?: FieldTransforms<T>;
135
- readonly?: boolean;
136
- mmkv?: MMKVConfiguration;
137
- indexedDB?: {
138
- prefixID?: string;
139
- itemID?: string;
140
- };
141
- options?: any;
142
- }
143
- export type PersistOptionsRemote<T = any> = ObservablePersistenceConfigRemoteGlobalOptions & {
144
- readonly?: boolean;
145
- waitForGet?: Promise<any> | ObservableReadable<any>;
146
- waitForSet?: Promise<any> | ObservableReadable<any>;
147
- manual?: boolean;
148
- fieldTransforms?: FieldTransforms<T>;
149
- allowSetIfError?: boolean;
150
- transform?: PersistTransform<T>;
151
- firebase?: {
152
- refPath: (uid: string | undefined) => string;
153
- query?: (ref: DatabaseReference) => DatabaseReference | Query;
154
- queryByModified?: QueryByModified<T>;
155
- ignoreKeys?: string[];
156
- requireAuth?: boolean;
157
- mode?: 'once' | 'realtime';
158
- };
159
- offlineBehavior?: false | 'retry';
160
- changeTimeout?: number;
161
- metadataTimeout?: number;
162
- retry?: RetryOptions;
163
- onGetError?: (error: Error) => void;
164
- onSetError?: (error: Error) => void;
165
- log?: (message?: any, ...optionalParams: any[]) => void;
166
- onBeforeSet?: () => void;
167
- onSet?: () => void;
168
- };
169
- export interface ObservablePersistenceConfigLocalGlobalOptions {
170
- onGetError?: (error: Error) => void;
171
- onSetError?: (error: Error) => void;
172
- indexedDB?: {
173
- databaseName: string;
174
- version: number;
175
- tableNames: string[];
176
- };
177
- asyncStorage?: {
178
- AsyncStorage: AsyncStorageStatic;
179
- preload?: boolean | string[];
180
- };
181
- }
182
- export interface ObservablePersistenceConfigRemoteGlobalOptions {
183
- saveTimeout?: number;
184
- dateModifiedKey?: string;
185
- offlineBehavior?: false | 'retry';
186
- onGetError?: (error: Error) => void;
187
- onSetError?: (error: Error) => void;
188
- log?: (logLevel: 'verbose' | 'warning' | 'error', message: any, ...optionalParams: any[]) => void;
189
- onBeforeSet?: () => void;
190
- onSet?: () => void;
191
- }
192
- export interface ObservablePersistenceConfig {
193
- pluginLocal?: ClassConstructor<ObservablePersistLocal>;
194
- pluginRemote?: ClassConstructor<ObservablePersistRemoteClass> | ObservablePersistRemoteFunctions;
195
- localOptions?: ObservablePersistenceConfigLocalGlobalOptions;
196
- remoteOptions?: ObservablePersistenceConfigRemoteGlobalOptions;
197
- }
198
- export interface PersistOptions<T = any> {
199
- local?: string | PersistOptionsLocal<T>;
200
- remote?: PersistOptionsRemote<T>;
201
- pluginLocal?: ClassConstructor<ObservablePersistLocal>;
202
- pluginRemote?: ClassConstructor<ObservablePersistRemoteClass> | ObservablePersistRemoteFunctions<T>;
203
- }
204
- export interface PersistMetadata {
205
- id?: '__legend_metadata';
206
- modified?: number;
207
- pending?: any;
208
- }
209
- export interface ObservablePersistLocal {
210
- initialize?(config: ObservablePersistenceConfigLocalGlobalOptions): void | Promise<void>;
211
- loadTable?(table: string, config: PersistOptionsLocal): Promise<any> | void;
212
- getTable<T = any>(table: string, config: PersistOptionsLocal): T;
213
- set(table: string, changes: Change[], config: PersistOptionsLocal): Promise<any> | void;
214
- deleteTable(table: string, config: PersistOptionsLocal): Promise<any> | void;
215
- getMetadata(table: string, config: PersistOptionsLocal): PersistMetadata;
216
- setMetadata(table: string, metadata: PersistMetadata, config: PersistOptionsLocal): Promise<any> | void;
217
- deleteMetadata(table: string, config: PersistOptionsLocal): Promise<any> | void;
218
- }
219
- export interface ObservableOnChangeParams {
220
- value: unknown;
221
- path?: string[];
222
- pathTypes?: TypeAtPath[];
223
- mode?: 'assign' | 'set' | 'dateModified';
224
- dateModified?: number | undefined;
225
- }
226
- export interface ObservablePersistRemoteSetParams<T> {
227
- syncState: Observable<ObservablePersistState>;
228
- obs: Observable<T>;
229
- options: PersistOptions<T>;
230
- changes: Change[];
231
- value: T;
232
- }
233
- export interface ObservablePersistRemoteGetParams<T> {
234
- state: Observable<ObservablePersistState>;
235
- obs: ObservableReadable<T>;
236
- options: PersistOptions<T>;
237
- dateModified?: number;
238
- onGet: () => void;
239
- onError: (error: Error) => void;
240
- onChange: (params: ObservableOnChangeParams) => void | Promise<void>;
241
- }
242
- export type ObservablePersistRemoteGetFnParams<T> = Omit<ObservablePersistRemoteGetParams<T>, 'onGet'>;
243
- export interface ObservablePersistRemoteClass {
244
- get?<T>(params: ObservablePersistRemoteGetParams<T>): void;
245
- set?<T>(params: ObservablePersistRemoteSetParams<T>): void | Promise<void | {
246
- changes?: object;
247
- dateModified?: number;
248
- pathStrs?: string[];
249
- }>;
250
- }
251
- export interface ObservablePersistRemoteFunctions<T = any> {
252
- get?(params: ObservablePersistRemoteGetFnParams<T>): T | Promise<T>;
253
- set?(params: ObservablePersistRemoteSetParams<T>): void | Promise<void | {
254
- changes?: object | undefined;
255
- dateModified?: number;
256
- }>;
257
- }
258
- export interface ObservableState {
259
- isLoaded: boolean;
260
- error?: Error;
261
- }
262
- export interface WithState {
263
- state?: ObservableState;
264
- _state?: ObservableState;
265
- }
266
- export interface ObservablePersistStateBase {
267
- isLoadedLocal: boolean;
268
- isEnabledLocal: boolean;
269
- isEnabledRemote: boolean;
270
- dateModified?: number;
271
- syncCount?: number;
272
- clearLocal: () => Promise<void>;
273
- sync: () => Promise<void>;
274
- getPendingChanges: () => Record<string, {
275
- p: any;
276
- v?: any;
277
- }> | undefined;
278
- }
279
- export type ObservablePersistState = ObservableState & ObservablePersistStateBase;
280
- export type ObservablePersistStateInternal = ObservablePersistState & {
281
- refreshNum: number;
282
- };
283
- export interface WithPersistState {
284
- state?: ObservablePersistState;
285
- _state?: ObservablePersistState;
286
- }
287
29
  export type RecordValue<T> = T extends Record<string, infer t> ? t : never;
288
30
  export type ArrayValue<T> = T extends Array<infer t> ? t : never;
289
31
  export type ObservableValue<T> = T extends Observable<infer t> ? t : never;
290
- declare type ObjectKeys<T> = Pick<T, {
291
- [K in keyof T]-?: K extends string ? T[K] extends Record<string, any> ? T[K] extends any[] ? never : K : never : never;
292
- }[keyof T]>;
293
- declare type DictKeys<T> = Pick<T, {
294
- [K in keyof T]-?: K extends string ? (T[K] extends Record<string, Record<string, any>> ? K : never) : never;
295
- }[keyof T]>;
296
- declare type ArrayKeys<T> = Pick<T, {
297
- [K in keyof T]-?: K extends string | number ? (T[K] extends any[] ? K : never) : never;
298
- }[keyof T]>;
299
- export declare type FieldTransforms<T> = (T extends Record<string, Record<string, any>> ? {
300
- _dict: FieldTransformsInner<RecordValue<T>>;
301
- } : never) | FieldTransformsInner<T>;
302
- export declare type FieldTransformsInner<T> = {
303
- [K in keyof T]: string;
304
- } & ({
305
- [K in keyof ObjectKeys<T> as `${K}_obj`]?: FieldTransforms<T[K]>;
306
- } | {
307
- [K in keyof DictKeys<T> as `${K}_dict`]?: FieldTransforms<RecordValue<T[K]>>;
308
- }) & {
309
- [K in keyof ArrayKeys<T> as `${K}_arr`]?: FieldTransforms<ArrayValue<T[K]>>;
310
- } & {
311
- [K in keyof ArrayKeys<T> as `${K}_val`]?: FieldTransforms<ArrayValue<T[K]>>;
312
- };
313
- export type Selector<T> = ObservableReadable<T> | ObservableEvent | (() => T) | T;
32
+ export type Selector<T> = ObservableReadableNew<T> | ObservableEvent | (() => T) | T;
314
33
  export type ClassConstructor<I, Args extends any[] = any[]> = new (...args: Args) => I;
315
34
  export type ObservableListenerDispose = () => void;
316
35
  export interface ObservableRoot {
@@ -322,25 +41,6 @@ export interface ObservableRoot {
322
41
  }
323
42
  export type Primitive = boolean | string | number | Date;
324
43
  export type NotPrimitive<T> = T extends Primitive ? never : T;
325
- export type ObservableMap<T extends Map<any, any> | WeakMap<any, any>> = Omit<T, 'get' | 'size'> & Omit<ObservablePrimitiveBaseFns<T>, 'get' | 'size'> & MapGet<T>;
326
- export type ObservableSet<T extends Set<any> | WeakSet<any>> = Omit<T, 'size'> & Omit<ObservablePrimitiveBaseFns<T>, 'size'> & {
327
- size: ObservablePrimitiveChild<number>;
328
- };
329
- export type ObservableMapIfMap<T> = T extends Map<any, any> | WeakMap<any, any> ? ObservableMap<T> : never;
330
- export type ObservableArray<T extends any[]> = ObservableObjectFns<T> & ObservableArrayOverride<T[number]>;
331
- export type ObservableObject<T = any> = ObservableFnsRecursive<T> & ObservableObjectFns<T>;
332
- export type ObservableChild<T = any> = [T] extends [Primitive] ? ObservablePrimitiveChild<T> : ObservableObject<T>;
333
- export type ObservablePrimitiveChild<T = any> = [T] extends [boolean] ? ObservablePrimitiveChildFns<T> & ObservablePrimitiveBooleanFns<T> : ObservablePrimitiveChildFns<T>;
334
- export type ObservableObjectOrArray<T> = T extends Map<any, any> | WeakMap<any, any> ? ObservableMap<T> : T extends Set<any> | WeakSet<any> ? ObservableSet<T> : T extends any[] ? ObservableArray<T> : ObservableObject<T>;
335
- export type ObservableComputed<T = any> = ObservableBaseFns<T> & ObservableComputedFnsRecursive<T>;
336
- export type ObservableComputedTwoWay<T = any, T2 = T> = ObservableComputed<T> & ObservablePrimitiveBaseFns<T2>;
337
- type Equals<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;
338
- export type Observable<T = any> = Equals<T, any> extends true ? ObservableObject<any> : [T] extends [object] ? ObservableObjectOrArray<T> : ObservablePrimitive<T>;
339
- export type ObservableReadable<T = any> = ObservableBaseFns<T> | ObservablePrimitiveBaseFns<T> | ObservablePrimitiveChildFns<T> | ObservableObjectFns<T> | ObservableMapIfMap<T>;
340
- export type ObservableWriteable<T = any> = ObservableReadable<T> & {
341
- set(value: Nullable<T> | CallbackSetter<T> | Promise<T>): any;
342
- delete?: () => any;
343
- };
344
44
  export interface NodeValueListener {
345
45
  track: TrackingType;
346
46
  noArgs?: boolean;
@@ -361,24 +61,15 @@ interface BaseNodeValue {
361
61
  isSetting?: number;
362
62
  isAssigning?: number;
363
63
  parentOther?: NodeValue;
364
- functions?: Map<string, Function | ObservableComputed<any>>;
64
+ functions?: Map<string, Function | ObservableComputedNew<any>>;
365
65
  lazy?: boolean | Function;
366
- state?: Observable<ObservablePersistState>;
66
+ state?: ObservableNew<ObservablePersistState>;
367
67
  activated?: boolean;
368
- proxyFn2?: (key: string, params: ActivateParams) => any;
369
- activationState?: {
370
- onSetFn?: (value: ListenerParams<any>) => void;
371
- update?: UpdateFn;
372
- subscriber?: (params: {
373
- update: UpdateFn;
374
- refresh: () => void;
375
- }) => void;
376
- retryOptions?: RetryOptions;
377
- lastSync: {
378
- value?: number;
379
- };
380
- cacheOptions?: CacheOptions;
68
+ activationState?: ActivateParams & {
69
+ onError?: () => void;
70
+ persistedRetry?: boolean;
381
71
  };
72
+ dirtyFn?: () => void;
382
73
  }
383
74
  export interface RootNodeValue extends BaseNodeValue {
384
75
  parent?: undefined;
@@ -389,6 +80,11 @@ export interface ChildNodeValue extends BaseNodeValue {
389
80
  key: string;
390
81
  }
391
82
  export type NodeValue = RootNodeValue | ChildNodeValue;
83
+ export interface TrackingNode {
84
+ node: NodeValue;
85
+ track: TrackingType;
86
+ num: number;
87
+ }
392
88
  export interface ObserveEvent<T> {
393
89
  num: number;
394
90
  previous?: T | undefined;
@@ -399,40 +95,56 @@ export interface ObserveEventCallback<T> {
399
95
  num: number;
400
96
  previous?: T | undefined;
401
97
  value?: T;
402
- cancel?: boolean;
98
+ cancel: boolean;
99
+ nodes: Map<NodeValue, TrackingNode> | undefined;
100
+ refresh: () => void;
403
101
  onCleanup?: () => void;
404
102
  onCleanupReaction?: () => void;
405
103
  }
406
104
  export type ObservableProxy<T extends Record<string, any>> = {
407
105
  [K in keyof T]: ObservableComputed<T[K]>;
408
- } & ObservableBaseFns<T> & {
106
+ } & Observable<T> & {
409
107
  [symbolGetNode]: NodeValue;
410
108
  };
411
109
  export type ObservableProxyLink<T extends Record<string, any>> = {
412
110
  [K in keyof T]: Observable<T[K]>;
413
- } & ObservableBaseFns<T> & {
111
+ } & Observable<T> & {
414
112
  [symbolGetNode]: NodeValue;
415
113
  };
416
114
  export type ObservableProxyTwoWay<T extends Record<string, any>, T2> = {
417
115
  [K in keyof T]: ObservableComputedTwoWay<T[K], T2>;
418
- } & ObservableBaseFns<T> & {
116
+ } & Observable<T> & {
419
117
  [symbolGetNode]: NodeValue;
420
118
  };
421
- export interface CacheOptions<T = any> {
422
- local: string | PersistOptionsLocal<T>;
423
- pluginLocal?: ClassConstructor<ObservablePersistLocal, T[]>;
119
+ export type OnSetParams<T> = ListenerParams<T extends Promise<infer t> ? t : T> & OnSetExtra;
120
+ export interface ActivateGetParams {
121
+ updateLastSync: (lastSync: number) => void;
122
+ setMode: (mode: 'assign' | 'set') => void;
123
+ refresh: () => void;
424
124
  }
425
125
  export interface ActivateParams<T = any> {
426
- onSet: (fn: (params: ListenerParams<T>) => void) => void;
427
- subscribe: (fn: (params: {
126
+ onSet?: (params: OnSetParams<T>) => void | Promise<any>;
127
+ subscribe?: (params: {
128
+ node: NodeValue;
428
129
  update: UpdateFn;
429
130
  refresh: () => void;
430
- }) => void) => void;
131
+ }) => void;
132
+ waitFor?: Selector<any>;
133
+ initial?: T extends Promise<infer t> ? t : T;
134
+ get?: (params: ActivateGetParams) => T;
135
+ retry?: RetryOptions;
136
+ offlineBehavior?: false | 'retry';
431
137
  }
432
- export interface ActivateProxyParams<T = any> extends ActivateParams {
433
- proxy: (fn: (key: string, params: ActivateParams<T>) => T | Promise<T>) => void;
138
+ export interface ActivateParamsWithLookup<T extends Record<string, any> = Record<string, any>> extends ActivateParams<T> {
139
+ lookup: (key: string) => Promise<RecordValue<T>> | Observable<RecordValue<T>> | RecordValue<T>;
434
140
  }
435
- export type UpdateFn = (params: ObservableOnChangeParams) => void;
141
+ export type Activated<T> = T;
142
+ export type UpdateFn = (params: {
143
+ value: unknown;
144
+ mode?: 'assign' | 'set' | 'lastSync' | 'dateModified' | 'merge';
145
+ dateModified?: number | undefined;
146
+ lastSync?: number | undefined;
147
+ }) => void;
436
148
  export interface RetryOptions {
437
149
  infinite?: boolean;
438
150
  times?: number;
@@ -440,4 +152,21 @@ export interface RetryOptions {
440
152
  backoff?: 'constant' | 'exponential';
441
153
  maxDelay?: number;
442
154
  }
155
+ export interface OnSetExtra {
156
+ node: NodeValue;
157
+ update: UpdateFn;
158
+ refresh: () => void;
159
+ cancelRetry: () => void;
160
+ retryNum: number;
161
+ fromSubscribe: boolean | undefined;
162
+ }
163
+ export interface SubscribeOptions {
164
+ node: NodeValue;
165
+ update: UpdateFn;
166
+ refresh: () => void;
167
+ }
168
+ export interface CacheReturnValue {
169
+ lastSync: number;
170
+ value: any;
171
+ }
443
172
  export {};
@@ -0,0 +1,93 @@
1
+ import type { GetOptions, ListenerFn, TrackingType } from './observableInterfaces';
2
+ type Primitive = string | number | boolean | symbol | bigint | undefined | null | Date;
3
+ type ArrayOverrideFnNames = 'find' | 'every' | 'some' | 'filter' | 'reduce' | 'reduceRight' | 'forEach' | 'map' | 'sort';
4
+ type ObservableComputed<T = any> = Readonly<ObservableNode<T>>;
5
+ type ObservableComputedTwoWay<T, T2> = Observable<T> & MutableObservableBase<T2>;
6
+ type MakeReadonlyInner<T> = Omit<T, keyof MutableObservableBase<any>>;
7
+ type Readonly<T> = MakeReadonlyInner<T> & {
8
+ [K in keyof MakeReadonlyInner<T>]: T extends Observable ? T[K] : Readonly<T[K]>;
9
+ };
10
+ type RemoveIndex<T> = {
11
+ [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K];
12
+ };
13
+ type BuiltIns = String | Boolean | Number | Date | Error | RegExp | Array<any> | Function | Promise<any>;
14
+ type IsUserDefinedObject<T> = T extends Function | BuiltIns | any[] ? false : T extends object ? true : false;
15
+ export type RemoveObservables<T> = T extends ImmutableObservableBase<infer t> ? t : IsUserDefinedObject<T> extends true ? {
16
+ [K in keyof T]: RemoveObservables<T[K]>;
17
+ } : T;
18
+ interface ObservableArray<T, U> extends ObservablePrimitive<T>, Pick<Array<Observable<U>>, ArrayOverrideFnNames>, Omit<RemoveIndex<Array<U>>, ArrayOverrideFnNames> {
19
+ }
20
+ interface ObservableObjectFns<T> {
21
+ assign(value: Partial<T>): Observable<T>;
22
+ }
23
+ interface ObservableObjectFunctions<T = Record<string, any>> extends ObservablePrimitive<T>, ObservableObjectFns<T> {
24
+ }
25
+ type ObservableMap<T extends Map<any, any> | WeakMap<any, any>> = Omit<T, 'get' | 'size'> & Omit<ObservablePrimitive<T>, 'get' | 'size'> & {
26
+ get(key: Parameters<T['get']>[0]): Observable<Parameters<T['set']>[1]>;
27
+ get(): T;
28
+ size: ImmutableObservableBase<number>;
29
+ };
30
+ type ObservableSet<T extends Set<any> | WeakSet<any>> = Omit<T, 'size'> & Omit<ObservablePrimitive<T>, 'size'> & {
31
+ size: ImmutableObservableBase<number>;
32
+ };
33
+ interface ObservableBoolean extends ObservablePrimitive<boolean> {
34
+ toggle(): boolean;
35
+ }
36
+ interface ObservablePrimitive<T> extends ImmutableObservableBase<T>, MutableObservableBase<T> {
37
+ }
38
+ type ObservableAny = Partial<ObservableObjectFns<any>> & ObservablePrimitive<any> & Record<string, any>;
39
+ interface ImmutableObservableBase<T> {
40
+ peek(): RemoveObservables<T>;
41
+ get(trackingType?: TrackingType | GetOptions): RemoveObservables<T>;
42
+ onChange(cb: ListenerFn<T>, options?: {
43
+ trackingType?: TrackingType;
44
+ initial?: boolean;
45
+ immediate?: boolean;
46
+ noArgs?: boolean;
47
+ }): () => void;
48
+ }
49
+ interface MutableObservableBase<T> {
50
+ set(value: (prev: RemoveObservables<T>) => RemoveObservables<T>): Observable<T>;
51
+ set(value: RecursiveValueOrFunction<T>): Observable<T>;
52
+ set(value: Promise<RemoveObservables<T>>): Observable<T>;
53
+ set(value: RemoveObservables<T>): Observable<T>;
54
+ set(value: Observable<RemoveObservables<T>>): Observable<T>;
55
+ delete(): void;
56
+ }
57
+ type UndefinedIf<T, U> = U extends true ? T | undefined : T;
58
+ type IsNullable<T> = undefined extends T ? true : null extends T ? true : false;
59
+ type NonObservable = Function | Observable;
60
+ type NonObservableKeys<T> = {
61
+ [K in keyof T]-?: IsStrictAny<T[K]> extends true ? never : T[K] extends undefined | null ? never : NonNullable<T[K]> extends NonObservable ? K : never;
62
+ }[keyof T];
63
+ type ObservableProps<T> = RestoreNullability<T, Simplify<Omit<NonNullable<T>, NonObservableKeys<NonNullable<T>>>>>;
64
+ type NonObservableProps<T> = RestoreNullability<T, Simplify<NullablePropsIf<Pick<NonNullable<T>, NonObservableKeys<NonNullable<T>>>, IsNullable<T>>>>;
65
+ type NullablePropsIf<T, U> = {
66
+ [K in keyof T]: UndefinedIf<T[K], U>;
67
+ };
68
+ type RestoreNullability<Source, Target> = IsNullable<Source> extends true ? Target | Extract<Source, null | undefined> : Target;
69
+ type ObservableChildren<T, Nullable = IsNullable<T>> = {
70
+ [K in keyof T]-?: Observable<UndefinedIf<T[K], Nullable>>;
71
+ };
72
+ type ObservableFunctionChildren<T> = {
73
+ [K in keyof T]-?: T[K] extends Observable ? T[K] : T[K] extends () => Promise<infer t> | infer t ? t extends void ? T[K] : ObservableComputed<t> & T[K] : T[K];
74
+ };
75
+ type IsStrictAny<T> = 0 extends 1 & T ? true : false;
76
+ export interface ObservableState {
77
+ isLoaded: boolean;
78
+ error?: Error;
79
+ }
80
+ type ObservableObject<T> = ObservableObjectFunctions<ObservableProps<T> & NonObservableProps<T>> & ObservableChildren<ObservableProps<T>> & ObservableFunctionChildren<NonObservableProps<T>>;
81
+ type ObservableNode<T, NT = NonNullable<T>> = [NT] extends [never] ? ObservablePrimitive<T> : IsStrictAny<T> extends true ? ObservableAny : [T] extends [() => infer t] ? t extends Observable ? t : ObservableComputed<t> : [NT] extends [ImmutableObservableBase<any>] ? NT : [NT] extends [Primitive] ? [NT] extends [boolean] ? ObservableBoolean : ObservablePrimitive<T> : NT extends Map<any, any> | WeakMap<any, any> ? ObservableMap<NT> : NT extends Set<infer U> ? ObservableSet<Set<UndefinedIf<U, IsNullable<T>>>> : NT extends WeakSet<any> ? ObservableSet<NT> : NT extends Array<infer U> ? ObservableArray<T, U> & ObservableChildren<T> : ObservableObject<T>;
82
+ type Simplify<T> = {
83
+ [K in keyof T]: T[K];
84
+ } & {};
85
+ type Observable<T = any> = ObservableNode<T> & {};
86
+ type ObservableReadable<T = any> = ImmutableObservableBase<T>;
87
+ type ObservableWriteable<T = any> = ObservableReadable<T> & MutableObservableBase<T>;
88
+ type ValueOrFunction<T> = T extends Function ? T : T | (() => T | Promise<T>);
89
+ type ValueOrFunctionKeys<T> = {
90
+ [K in keyof T]: RecursiveValueOrFunction<T[K]>;
91
+ };
92
+ type RecursiveValueOrFunction<T> = T extends Function ? T : T extends object ? Promise<ValueOrFunctionKeys<T>> | ValueOrFunctionKeys<T> | (() => T | Promise<T> | ValueOrFunctionKeys<T> | Promise<ValueOrFunctionKeys<T>> | Observable<T>) : ValueOrFunction<T>;
93
+ export type { ObservableComputed, ObservableComputedTwoWay, Observable, ObservableBoolean, ObservableObject, ObservablePrimitive, ObservableReadable, ObservableWriteable, ImmutableObservableBase, RecursiveValueOrFunction, };
@@ -1,2 +1,2 @@
1
- import type { ObservablePersistRemoteClass, ObservablePersistRemoteFunctions } from '@legendapp/state';
1
+ import { type ObservablePersistRemoteClass, type ObservablePersistRemoteFunctions } from '@legendapp/state';
2
2
  export declare function observablePersistRemoteFunctionsAdapter<T = {}>({ get, set, }: ObservablePersistRemoteFunctions<T>): ObservablePersistRemoteClass;
@@ -0,0 +1 @@
1
+ export declare function persistActivateNode(): void;
@@ -1 +1 @@
1
- export declare function removeNullUndefined<T extends Record<string, any>>(val: T): T | null;
1
+ export declare function removeNullUndefined<T extends Record<string, any>>(val: T): T;
@@ -1,8 +1,9 @@
1
- import type { CacheOptions, ClassConstructor, FieldTransforms, Observable, ObservablePersistLocal, ObservablePersistRemoteClass, ObservablePersistStateBase, ObservableWriteable, PersistOptions, PersistTransform, Primitive, RetryOptions, TypeAtPath, WithPersistState } from '@legendapp/state';
1
+ import type { ClassConstructor, FieldTransforms, Observable, ObservablePersistLocal, ObservablePersistRemoteClass, ObservablePersistState, ObservableWriteable, PersistOptions, PersistTransform, Primitive, TypeAtPath } from '@legendapp/state';
2
2
  export declare const mapPersistences: WeakMap<ClassConstructor<ObservablePersistLocal | ObservablePersistRemoteClass>, {
3
3
  persist: ObservablePersistLocal | ObservablePersistRemoteClass;
4
4
  initialized?: Observable<boolean>;
5
5
  }>;
6
+ export declare function onChangeRemote(cb: () => void): void;
6
7
  export declare function transformOutData(value: any, path: string[], pathTypes: TypeAtPath[], { transform, fieldTransforms }: {
7
8
  transform?: PersistTransform;
8
9
  fieldTransforms?: FieldTransforms<any>;
@@ -20,14 +21,4 @@ export declare function transformLoadData(value: any, { transform, fieldTransfor
20
21
  export type WithoutState = any[] | Primitive | (Record<string, any> & {
21
22
  _state?: never;
22
23
  });
23
- export declare function persistObservable<T extends WithoutState>(observable: ObservableWriteable<T>, persistOptions: PersistOptions<T>): Observable<WithPersistState & T>;
24
- export declare function persistObservable<T extends WithoutState>(initial: T | (() => T) | (() => Promise<T>), persistOptions: PersistOptions<T>): Observable<WithPersistState & T>;
25
- declare module '@legendapp/state' {
26
- interface ActivateParams<T> {
27
- cache: (cacheOptions: CacheOptions<T> | (() => CacheOptions<T>)) => void;
28
- updateLastSync: (lastSync: number) => void;
29
- retry: (options: RetryOptions) => void;
30
- }
31
- interface ObservableState extends ObservablePersistStateBase {
32
- }
33
- }
24
+ export declare function persistObservable<T>(obs: ObservableWriteable<T>, persistOptions: PersistOptions<T>): Observable<ObservablePersistState>;