@fjell/core 4.4.65 → 4.4.66
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.
- package/dist/items.d.ts +15 -4
- package/package.json +1 -1
package/dist/items.d.ts
CHANGED
|
@@ -29,16 +29,27 @@ export interface Deletable extends Partial<Evented> {
|
|
|
29
29
|
deleted: ItemEvent;
|
|
30
30
|
}
|
|
31
31
|
export type ManagedEvents = Timestamped & Deletable;
|
|
32
|
+
/**
|
|
33
|
+
* Reference type that flattens item properties directly onto the reference object.
|
|
34
|
+
* When populated, the reference contains the key plus all item properties directly,
|
|
35
|
+
* allowing access via refs.name.property instead of refs.name.item.property.
|
|
36
|
+
*
|
|
37
|
+
* Structure:
|
|
38
|
+
* - Unpopulated: { key: ComKey | PriKey }
|
|
39
|
+
* - Populated: { key: ComKey | PriKey, ...itemProperties }
|
|
40
|
+
*/
|
|
32
41
|
export type Reference<S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> = {
|
|
33
42
|
key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>;
|
|
34
|
-
|
|
35
|
-
};
|
|
43
|
+
} & Partial<Omit<Item<S, L1, L2, L3, L4, L5>, 'key'>>;
|
|
36
44
|
export type ReferenceItem<S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> = Reference<S, L1, L2, L3, L4, L5>;
|
|
37
45
|
export type References = Record<string, Reference<any, any, any, any, any, any>>;
|
|
46
|
+
/**
|
|
47
|
+
* Aggregation type that flattens item properties directly onto the aggregation object.
|
|
48
|
+
* Similar to Reference, when populated, the aggregation contains the key plus all item properties.
|
|
49
|
+
*/
|
|
38
50
|
export type Aggregation<S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> = {
|
|
39
51
|
key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>;
|
|
40
|
-
|
|
41
|
-
};
|
|
52
|
+
} & Partial<Omit<Item<S, L1, L2, L3, L4, L5>, 'key'>>;
|
|
42
53
|
export interface Item<S extends string = never, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> extends Identified<S, L1, L2, L3, L4, L5> {
|
|
43
54
|
events: ManagedEvents & Evented;
|
|
44
55
|
aggs?: Record<string, Aggregation<any, any, any, any, any, any>[]>;
|