@stonecrop/stonecrop 0.6.1 → 0.6.3

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 (30) hide show
  1. package/dist/composable.js +348 -0
  2. package/dist/composables/operation-log.js +221 -0
  3. package/dist/doctype.js +73 -0
  4. package/dist/exceptions.js +16 -0
  5. package/dist/field-triggers.js +564 -0
  6. package/dist/index.js +18 -0
  7. package/dist/operation-log-DB-dGNT9.js +593 -0
  8. package/dist/operation-log-DB-dGNT9.js.map +1 -0
  9. package/dist/plugins/index.js +90 -0
  10. package/dist/registry.js +72 -0
  11. package/dist/src/stores/data.d.ts +11 -0
  12. package/dist/src/stores/data.d.ts.map +1 -0
  13. package/dist/src/stores/xstate.d.ts +31 -0
  14. package/dist/src/stores/xstate.d.ts.map +1 -0
  15. package/dist/src/tsdoc-metadata.json +1 -1
  16. package/dist/stonecrop.d.ts +47 -58
  17. package/dist/stonecrop.js +851 -859
  18. package/dist/stonecrop.js.map +1 -1
  19. package/dist/stonecrop.umd.cjs +3 -7
  20. package/dist/stonecrop.umd.cjs.map +1 -1
  21. package/dist/stores/data.js +7 -0
  22. package/dist/stores/hst.js +483 -0
  23. package/dist/stores/index.js +12 -0
  24. package/dist/stores/operation-log.js +571 -0
  25. package/dist/stores/xstate.js +29 -0
  26. package/dist/types/field-triggers.js +4 -0
  27. package/dist/types/index.js +4 -0
  28. package/dist/types/operation-log.js +0 -0
  29. package/dist/types/registry.js +0 -0
  30. package/package.json +4 -4
package/dist/stonecrop.d.ts CHANGED
@@ -2,25 +2,14 @@ import type { AnyStateNodeConfig } from 'xstate';
2
2
  import { Component } from 'vue';
3
3
  import { ComputedRef } from 'vue';
4
4
  import { CSSProperties } from 'vue';
5
- import { HSTOperation as HSTOperation_2 } from './types';
6
- import { HSTOperation as HSTOperation_3 } from '..';
7
- import { HSTOperationInput as HSTOperationInput_2 } from './types';
8
- import { HSTOperationType as HSTOperationType_2 } from './types';
9
- import { HSTOperationType as HSTOperationType_3 } from '..';
10
5
  import { List } from 'immutable';
11
6
  import { Map as Map_2 } from 'immutable';
12
- import { OperationLogSnapshot as OperationLogSnapshot_2 } from './types';
13
- import { OperationLogSnapshot as OperationLogSnapshot_3 } from '..';
14
- import { OperationSource as OperationSource_2 } from './types';
15
- import { OperationSource as OperationSource_3 } from '..';
16
7
  import { Plugin as Plugin_2 } from 'vue';
17
8
  import { Ref } from 'vue';
18
9
  import { Router } from 'vue-router';
19
10
  import type { ShallowRef } from 'vue';
20
11
  import { Store } from 'pinia';
21
12
  import { StoreDefinition } from 'pinia';
22
- import { UndoRedoState as UndoRedoState_2 } from './types';
23
- import { UndoRedoState as UndoRedoState_3 } from '..';
24
13
  import type { UnknownMachineConfig } from 'xstate';
25
14
  import { useElementBounding } from '@vueuse/core';
26
15
  import { WritableComputedRef } from 'vue';
@@ -2204,7 +2193,7 @@ export declare class Stonecrop {
2204
2193
  getOperationLogStore(): Store<"hst-operation-log", Pick<{
2205
2194
  operations: Ref< {
2206
2195
  id: string;
2207
- type: HSTOperationType_2;
2196
+ type: HSTOperationType;
2208
2197
  path: string;
2209
2198
  fieldname: string;
2210
2199
  beforeValue: any;
@@ -2212,7 +2201,7 @@ export declare class Stonecrop {
2212
2201
  doctype: string;
2213
2202
  recordId?: string | undefined;
2214
2203
  timestamp: Date;
2215
- source?: OperationSource_2 | undefined;
2204
+ source?: OperationSource | undefined;
2216
2205
  reversible: boolean;
2217
2206
  irreversibleReason?: string | undefined;
2218
2207
  transition?: string | undefined;
@@ -2226,9 +2215,9 @@ export declare class Stonecrop {
2226
2215
  metadata?: Record<string, any> | undefined;
2227
2216
  parentOperationId?: string | undefined;
2228
2217
  childOperationIds?: string[] | undefined;
2229
- }[], HSTOperation_2[] | {
2218
+ }[], HSTOperation[] | {
2230
2219
  id: string;
2231
- type: HSTOperationType_2;
2220
+ type: HSTOperationType;
2232
2221
  path: string;
2233
2222
  fieldname: string;
2234
2223
  beforeValue: any;
@@ -2236,7 +2225,7 @@ export declare class Stonecrop {
2236
2225
  doctype: string;
2237
2226
  recordId?: string | undefined;
2238
2227
  timestamp: Date;
2239
- source?: OperationSource_2 | undefined;
2228
+ source?: OperationSource | undefined;
2240
2229
  reversible: boolean;
2241
2230
  irreversibleReason?: string | undefined;
2242
2231
  transition?: string | undefined;
@@ -2259,7 +2248,7 @@ export declare class Stonecrop {
2259
2248
  enablePersistence?: boolean | undefined;
2260
2249
  persistenceKeyPrefix?: string | undefined;
2261
2250
  userId?: string | undefined;
2262
- operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
2251
+ operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
2263
2252
  }, OperationLogConfig | {
2264
2253
  maxOperations?: number | undefined;
2265
2254
  enableCrossTabSync?: boolean | undefined;
@@ -2267,30 +2256,30 @@ export declare class Stonecrop {
2267
2256
  enablePersistence?: boolean | undefined;
2268
2257
  persistenceKeyPrefix?: string | undefined;
2269
2258
  userId?: string | undefined;
2270
- operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
2259
+ operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
2271
2260
  }>;
2272
2261
  clientId: Ref<string, string>;
2273
- undoRedoState: ComputedRef<UndoRedoState_2>;
2262
+ undoRedoState: ComputedRef<UndoRedoState>;
2274
2263
  canUndo: ComputedRef<boolean>;
2275
2264
  canRedo: ComputedRef<boolean>;
2276
2265
  undoCount: ComputedRef<number>;
2277
2266
  redoCount: ComputedRef<number>;
2278
2267
  configure: (options: Partial<OperationLogConfig>) => void;
2279
- addOperation: (operation: HSTOperationInput_2, source?: OperationSource_2) => string;
2268
+ addOperation: (operation: HSTOperationInput, source?: OperationSource) => string;
2280
2269
  startBatch: () => void;
2281
2270
  commitBatch: (description?: string) => string | null;
2282
2271
  cancelBatch: () => void;
2283
2272
  undo: (store: HSTNode) => boolean;
2284
2273
  redo: (store: HSTNode) => boolean;
2285
2274
  clear: () => void;
2286
- getOperationsFor: (doctype: string, recordId?: string) => HSTOperation_2[];
2287
- getSnapshot: () => OperationLogSnapshot_2;
2275
+ getOperationsFor: (doctype: string, recordId?: string) => HSTOperation[];
2276
+ getSnapshot: () => OperationLogSnapshot;
2288
2277
  markIrreversible: (operationId: string, reason: string) => void;
2289
2278
  logAction: (doctype: string, actionName: string, recordIds?: string[], result?: "success" | "failure" | "pending", error?: string) => string;
2290
2279
  }, "operations" | "clientId" | "currentIndex" | "config">, Pick<{
2291
2280
  operations: Ref< {
2292
2281
  id: string;
2293
- type: HSTOperationType_2;
2282
+ type: HSTOperationType;
2294
2283
  path: string;
2295
2284
  fieldname: string;
2296
2285
  beforeValue: any;
@@ -2298,7 +2287,7 @@ export declare class Stonecrop {
2298
2287
  doctype: string;
2299
2288
  recordId?: string | undefined;
2300
2289
  timestamp: Date;
2301
- source?: OperationSource_2 | undefined;
2290
+ source?: OperationSource | undefined;
2302
2291
  reversible: boolean;
2303
2292
  irreversibleReason?: string | undefined;
2304
2293
  transition?: string | undefined;
@@ -2312,9 +2301,9 @@ export declare class Stonecrop {
2312
2301
  metadata?: Record<string, any> | undefined;
2313
2302
  parentOperationId?: string | undefined;
2314
2303
  childOperationIds?: string[] | undefined;
2315
- }[], HSTOperation_2[] | {
2304
+ }[], HSTOperation[] | {
2316
2305
  id: string;
2317
- type: HSTOperationType_2;
2306
+ type: HSTOperationType;
2318
2307
  path: string;
2319
2308
  fieldname: string;
2320
2309
  beforeValue: any;
@@ -2322,7 +2311,7 @@ export declare class Stonecrop {
2322
2311
  doctype: string;
2323
2312
  recordId?: string | undefined;
2324
2313
  timestamp: Date;
2325
- source?: OperationSource_2 | undefined;
2314
+ source?: OperationSource | undefined;
2326
2315
  reversible: boolean;
2327
2316
  irreversibleReason?: string | undefined;
2328
2317
  transition?: string | undefined;
@@ -2345,7 +2334,7 @@ export declare class Stonecrop {
2345
2334
  enablePersistence?: boolean | undefined;
2346
2335
  persistenceKeyPrefix?: string | undefined;
2347
2336
  userId?: string | undefined;
2348
- operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
2337
+ operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
2349
2338
  }, OperationLogConfig | {
2350
2339
  maxOperations?: number | undefined;
2351
2340
  enableCrossTabSync?: boolean | undefined;
@@ -2353,30 +2342,30 @@ export declare class Stonecrop {
2353
2342
  enablePersistence?: boolean | undefined;
2354
2343
  persistenceKeyPrefix?: string | undefined;
2355
2344
  userId?: string | undefined;
2356
- operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
2345
+ operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
2357
2346
  }>;
2358
2347
  clientId: Ref<string, string>;
2359
- undoRedoState: ComputedRef<UndoRedoState_2>;
2348
+ undoRedoState: ComputedRef<UndoRedoState>;
2360
2349
  canUndo: ComputedRef<boolean>;
2361
2350
  canRedo: ComputedRef<boolean>;
2362
2351
  undoCount: ComputedRef<number>;
2363
2352
  redoCount: ComputedRef<number>;
2364
2353
  configure: (options: Partial<OperationLogConfig>) => void;
2365
- addOperation: (operation: HSTOperationInput_2, source?: OperationSource_2) => string;
2354
+ addOperation: (operation: HSTOperationInput, source?: OperationSource) => string;
2366
2355
  startBatch: () => void;
2367
2356
  commitBatch: (description?: string) => string | null;
2368
2357
  cancelBatch: () => void;
2369
2358
  undo: (store: HSTNode) => boolean;
2370
2359
  redo: (store: HSTNode) => boolean;
2371
2360
  clear: () => void;
2372
- getOperationsFor: (doctype: string, recordId?: string) => HSTOperation_2[];
2373
- getSnapshot: () => OperationLogSnapshot_2;
2361
+ getOperationsFor: (doctype: string, recordId?: string) => HSTOperation[];
2362
+ getSnapshot: () => OperationLogSnapshot;
2374
2363
  markIrreversible: (operationId: string, reason: string) => void;
2375
2364
  logAction: (doctype: string, actionName: string, recordIds?: string[], result?: "success" | "failure" | "pending", error?: string) => string;
2376
2365
  }, "undoRedoState" | "canUndo" | "canRedo" | "undoCount" | "redoCount">, Pick<{
2377
2366
  operations: Ref< {
2378
2367
  id: string;
2379
- type: HSTOperationType_2;
2368
+ type: HSTOperationType;
2380
2369
  path: string;
2381
2370
  fieldname: string;
2382
2371
  beforeValue: any;
@@ -2384,7 +2373,7 @@ export declare class Stonecrop {
2384
2373
  doctype: string;
2385
2374
  recordId?: string | undefined;
2386
2375
  timestamp: Date;
2387
- source?: OperationSource_2 | undefined;
2376
+ source?: OperationSource | undefined;
2388
2377
  reversible: boolean;
2389
2378
  irreversibleReason?: string | undefined;
2390
2379
  transition?: string | undefined;
@@ -2398,9 +2387,9 @@ export declare class Stonecrop {
2398
2387
  metadata?: Record<string, any> | undefined;
2399
2388
  parentOperationId?: string | undefined;
2400
2389
  childOperationIds?: string[] | undefined;
2401
- }[], HSTOperation_2[] | {
2390
+ }[], HSTOperation[] | {
2402
2391
  id: string;
2403
- type: HSTOperationType_2;
2392
+ type: HSTOperationType;
2404
2393
  path: string;
2405
2394
  fieldname: string;
2406
2395
  beforeValue: any;
@@ -2408,7 +2397,7 @@ export declare class Stonecrop {
2408
2397
  doctype: string;
2409
2398
  recordId?: string | undefined;
2410
2399
  timestamp: Date;
2411
- source?: OperationSource_2 | undefined;
2400
+ source?: OperationSource | undefined;
2412
2401
  reversible: boolean;
2413
2402
  irreversibleReason?: string | undefined;
2414
2403
  transition?: string | undefined;
@@ -2431,7 +2420,7 @@ export declare class Stonecrop {
2431
2420
  enablePersistence?: boolean | undefined;
2432
2421
  persistenceKeyPrefix?: string | undefined;
2433
2422
  userId?: string | undefined;
2434
- operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
2423
+ operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
2435
2424
  }, OperationLogConfig | {
2436
2425
  maxOperations?: number | undefined;
2437
2426
  enableCrossTabSync?: boolean | undefined;
@@ -2439,24 +2428,24 @@ export declare class Stonecrop {
2439
2428
  enablePersistence?: boolean | undefined;
2440
2429
  persistenceKeyPrefix?: string | undefined;
2441
2430
  userId?: string | undefined;
2442
- operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
2431
+ operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
2443
2432
  }>;
2444
2433
  clientId: Ref<string, string>;
2445
- undoRedoState: ComputedRef<UndoRedoState_2>;
2434
+ undoRedoState: ComputedRef<UndoRedoState>;
2446
2435
  canUndo: ComputedRef<boolean>;
2447
2436
  canRedo: ComputedRef<boolean>;
2448
2437
  undoCount: ComputedRef<number>;
2449
2438
  redoCount: ComputedRef<number>;
2450
2439
  configure: (options: Partial<OperationLogConfig>) => void;
2451
- addOperation: (operation: HSTOperationInput_2, source?: OperationSource_2) => string;
2440
+ addOperation: (operation: HSTOperationInput, source?: OperationSource) => string;
2452
2441
  startBatch: () => void;
2453
2442
  commitBatch: (description?: string) => string | null;
2454
2443
  cancelBatch: () => void;
2455
2444
  undo: (store: HSTNode) => boolean;
2456
2445
  redo: (store: HSTNode) => boolean;
2457
2446
  clear: () => void;
2458
- getOperationsFor: (doctype: string, recordId?: string) => HSTOperation_2[];
2459
- getSnapshot: () => OperationLogSnapshot_2;
2447
+ getOperationsFor: (doctype: string, recordId?: string) => HSTOperation[];
2448
+ getSnapshot: () => OperationLogSnapshot;
2460
2449
  markIrreversible: (operationId: string, reason: string) => void;
2461
2450
  logAction: (doctype: string, actionName: string, recordIds?: string[], result?: "success" | "failure" | "pending", error?: string) => string;
2462
2451
  }, "undo" | "redo" | "configure" | "addOperation" | "startBatch" | "commitBatch" | "cancelBatch" | "clear" | "getOperationsFor" | "getSnapshot" | "markIrreversible" | "logAction">>;
@@ -3079,7 +3068,7 @@ export declare interface UndoRedoState {
3079
3068
  export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
3080
3069
  operations: Ref< {
3081
3070
  id: string;
3082
- type: HSTOperationType_3;
3071
+ type: HSTOperationType;
3083
3072
  path: string;
3084
3073
  fieldname: string;
3085
3074
  beforeValue: any;
@@ -3087,7 +3076,7 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
3087
3076
  doctype: string;
3088
3077
  recordId?: string | undefined;
3089
3078
  timestamp: Date;
3090
- source?: OperationSource_3 | undefined;
3079
+ source?: OperationSource | undefined;
3091
3080
  reversible: boolean;
3092
3081
  irreversibleReason?: string | undefined;
3093
3082
  transition?: string | undefined;
@@ -3101,9 +3090,9 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
3101
3090
  metadata?: Record<string, any> | undefined;
3102
3091
  parentOperationId?: string | undefined;
3103
3092
  childOperationIds?: string[] | undefined;
3104
- }[], HSTOperation_3[] | {
3093
+ }[], HSTOperation[] | {
3105
3094
  id: string;
3106
- type: HSTOperationType_3;
3095
+ type: HSTOperationType;
3107
3096
  path: string;
3108
3097
  fieldname: string;
3109
3098
  beforeValue: any;
@@ -3111,7 +3100,7 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
3111
3100
  doctype: string;
3112
3101
  recordId?: string | undefined;
3113
3102
  timestamp: Date;
3114
- source?: OperationSource_3 | undefined;
3103
+ source?: OperationSource | undefined;
3115
3104
  reversible: boolean;
3116
3105
  irreversibleReason?: string | undefined;
3117
3106
  transition?: string | undefined;
@@ -3127,7 +3116,7 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
3127
3116
  childOperationIds?: string[] | undefined;
3128
3117
  }[]>;
3129
3118
  currentIndex: Ref<number, number>;
3130
- undoRedoState: ComputedRef<UndoRedoState_3>;
3119
+ undoRedoState: ComputedRef<UndoRedoState>;
3131
3120
  canUndo: ComputedRef<boolean>;
3132
3121
  canRedo: ComputedRef<boolean>;
3133
3122
  undoCount: ComputedRef<number>;
@@ -3138,8 +3127,8 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
3138
3127
  commitBatch: (description?: string) => string | null;
3139
3128
  cancelBatch: () => void;
3140
3129
  clear: () => void;
3141
- getOperationsFor: (doctype: string, recordId?: string) => HSTOperation_3[];
3142
- getSnapshot: () => OperationLogSnapshot_3;
3130
+ getOperationsFor: (doctype: string, recordId?: string) => HSTOperation[];
3131
+ getSnapshot: () => OperationLogSnapshot;
3143
3132
  markIrreversible: (operationId: string, reason: string) => void;
3144
3133
  logAction: (doctype: string, actionName: string, recordIds?: string[], result?: "success" | "failure" | "pending", error?: string) => string;
3145
3134
  configure: (options: Partial<OperationLogConfig>) => void;
@@ -3154,7 +3143,7 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
3154
3143
  export declare const useOperationLogStore: StoreDefinition<"hst-operation-log", Pick<{
3155
3144
  operations: Ref< {
3156
3145
  id: string;
3157
- type: HSTOperationType_3;
3146
+ type: HSTOperationType;
3158
3147
  path: string;
3159
3148
  fieldname: string;
3160
3149
  beforeValue: any;
@@ -3178,7 +3167,7 @@ parentOperationId?: string | undefined;
3178
3167
  childOperationIds?: string[] | undefined;
3179
3168
  }[], HSTOperation[] | {
3180
3169
  id: string;
3181
- type: HSTOperationType_3;
3170
+ type: HSTOperationType;
3182
3171
  path: string;
3183
3172
  fieldname: string;
3184
3173
  beforeValue: any;
@@ -3240,7 +3229,7 @@ logAction: (doctype: string, actionName: string, recordIds?: string[], result?:
3240
3229
  }, "operations" | "clientId" | "currentIndex" | "config">, Pick<{
3241
3230
  operations: Ref< {
3242
3231
  id: string;
3243
- type: HSTOperationType_3;
3232
+ type: HSTOperationType;
3244
3233
  path: string;
3245
3234
  fieldname: string;
3246
3235
  beforeValue: any;
@@ -3264,7 +3253,7 @@ parentOperationId?: string | undefined;
3264
3253
  childOperationIds?: string[] | undefined;
3265
3254
  }[], HSTOperation[] | {
3266
3255
  id: string;
3267
- type: HSTOperationType_3;
3256
+ type: HSTOperationType;
3268
3257
  path: string;
3269
3258
  fieldname: string;
3270
3259
  beforeValue: any;
@@ -3326,7 +3315,7 @@ logAction: (doctype: string, actionName: string, recordIds?: string[], result?:
3326
3315
  }, "undoRedoState" | "canUndo" | "canRedo" | "undoCount" | "redoCount">, Pick<{
3327
3316
  operations: Ref< {
3328
3317
  id: string;
3329
- type: HSTOperationType_3;
3318
+ type: HSTOperationType;
3330
3319
  path: string;
3331
3320
  fieldname: string;
3332
3321
  beforeValue: any;
@@ -3350,7 +3339,7 @@ parentOperationId?: string | undefined;
3350
3339
  childOperationIds?: string[] | undefined;
3351
3340
  }[], HSTOperation[] | {
3352
3341
  id: string;
3353
- type: HSTOperationType_3;
3342
+ type: HSTOperationType;
3354
3343
  path: string;
3355
3344
  fieldname: string;
3356
3345
  beforeValue: any;