1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
// Copyright (c) 2023 Vaughn Nugent
//
// 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.
import { clone, isEqual, assign } from 'lodash-es'
import { reactive, computed, type UnwrapNestedRefs, type Ref } from 'vue'
/**
* Represents a server object that has been buffered for editing
* and can be reverted to the original state, or new state data
* applied from the server
*/
export interface ServerObjectBuffer<T> {
/**
* The data is a reactive clone of the initial data state. It is used to store the current state of the resource.
*/
readonly data: UnwrapNestedRefs<T>;
/**
* The buffer is a reactive clone of the initial data state. It is used to track changes.
*/
readonly buffer: UnwrapNestedRefs<T>;
/**
* A computed value that indicates if the buffer has been modified from the data
*/
readonly modified: Readonly<Ref<boolean>>;
/**
* Applies the new server response data to the resource data and reverts the buffer to the resource data
* @param newData The new server response data to apply to the buffer
*/
apply(newData: T): void;
/**
* Reverts the buffer to the resource data
*/
revert(): void;
}
export type UpdateCallback<T, TResut> = (state: ServerObjectBuffer<T>) => Promise<TResut>;
/**
* Represents a server object that has been buffered for editing
* and can be reverted to the original state or updated on the server
*/
export interface ServerDataBuffer<T, TResut> extends ServerObjectBuffer<T>{
/**
* Pushes buffered changes to the server if configured
*/
update(): Promise<TResut>;
}
export interface UseDataBuffer {
/**
* Configures a helper type that represents a data buffer that reflects the state of a resource
* on the server. This is useful for editing forms, where the user may want to revert their
* changes, or reload them from the server after an edit;
* @param initialData The intiial data to wrap in the buffer
* @returns
*/
<T extends object>(initialData: T): ServerObjectBuffer<T>;
/**
* Configures a helper type that represents a data buffer that reflects the state of a resource
* on the server. This is useful for editing forms, where the user may want to revert their
* changes, or reload them from the server after an edit;
* @param initialData
* @returns
*/
<T extends object, TState = unknown>(initialData: T, onUpdate: UpdateCallback<T, TState>): ServerDataBuffer<T, TState>;
}
const createObjectBuffer = <T extends object>(initialData: T): ServerObjectBuffer<T> => {
/**
* The data is a reactive clone of the initial data state. It is used to store the current state of the resource.
*/
const data = reactive(clone(initialData || {}))
/**
* The buffer is a reactive clone of the initial data state. It is used to track changes.
*/
const buffer = reactive(clone(initialData || {}))
/**
* A computed value that indicates if the buffer has been modified from the data
* @returns {boolean} True if the buffer has been modified from the data
*/
const modified = computed(() => !isEqual(buffer, data))
/**
* Applies the new server response data to the resource data and reverts the buffer to the resource data
* @param newData The new server response data to apply to the buffer
*/
const apply = (newData: T): void => {
// Apply the new data to the buffer
assign(data, newData);
// Revert the buffer to the resource data
assign(buffer, data)
}
/**
* Reverts the buffer to the resource data
*/
const revert = (): void => {
assign(buffer, data);
}
return { data, buffer, modified, apply, revert }
}
const createUpdatableBuffer = <T extends object, TState = unknown> (initialData: T, onUpdate: UpdateCallback<T, TState>): ServerDataBuffer<T, TState> => {
//Configure the initial data state and the buffer
const state: ServerObjectBuffer<T> = createObjectBuffer(initialData)
/**
* Pushes buffered changes to the server if configured
*/
const update = async (): Promise<TState> => {
return onUpdate ? onUpdate(state) : Promise.resolve(undefined as unknown as TState);
}
return{ ...state, update }
}
const _useDataBuffer = <T extends object, TState = unknown>(initialData: T, onUpdate?: UpdateCallback<T, TState>)
: ServerObjectBuffer<T> | ServerDataBuffer<T, TState> => {
return onUpdate ? createUpdatableBuffer<T, TState>(initialData, onUpdate) : createObjectBuffer<T>(initialData)
}
/**
* Cretes a buffer object that represents server data, tracks changes,
* can revert changes, and can optionally push buffered changes to the server
*/
export const useDataBuffer: UseDataBuffer = (_useDataBuffer as UseDataBuffer)
|
