@intellegens/cornerstone-client 0.0.24 → 0.0.26

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.
@@ -2,7 +2,7 @@ import { ReadSelectedPaginationDefinition, ReadSelectedOrderingDefinition, ReadS
2
2
  /**
3
3
  * Defines the selection criteria for a controller to fetch multiple records
4
4
  */
5
- export declare class ReadSelectedDefinition {
5
+ export type ReadSelectedDefinition = {
6
6
  /**
7
7
  * Pagination definition
8
8
  */
@@ -15,4 +15,4 @@ export declare class ReadSelectedDefinition {
15
15
  * Filtering definition
16
16
  */
17
17
  filteringDefinition?: ReadSelectedFilteringDefinition;
18
- }
18
+ };
@@ -1,17 +1 @@
1
- /**
2
- * Defines the selection criteria for a controller to fetch multiple records
3
- */
4
- export class ReadSelectedDefinition {
5
- /**
6
- * Pagination definition
7
- */
8
- paginationDefinition;
9
- /**
10
- * Ordering definition
11
- */
12
- orderingDefinition;
13
- /**
14
- * Filtering definition
15
- */
16
- filteringDefinition;
17
- }
1
+ export {};
@@ -2,13 +2,13 @@ import { ReadSelectedFilteringPropertyDefinition, ReadSelectedLogicalOperator }
2
2
  /**
3
3
  * Defines the filtering options for a controller, including the logical operator and an array of property definitions.
4
4
  */
5
- export declare class ReadSelectedFilteringDefinition {
5
+ export type ReadSelectedFilteringDefinition = {
6
6
  /**
7
7
  * Array of filtering property definitions to be applied.
8
8
  */
9
- Filters: ReadSelectedFilteringPropertyDefinition[];
9
+ filters: ReadSelectedFilteringPropertyDefinition[];
10
10
  /**
11
11
  * Logical operator to be used when applying the filters.
12
12
  */
13
13
  logicalOperator: ReadSelectedLogicalOperator;
14
- }
14
+ };
@@ -1,13 +1 @@
1
- /**
2
- * Defines the filtering options for a controller, including the logical operator and an array of property definitions.
3
- */
4
- export class ReadSelectedFilteringDefinition {
5
- /**
6
- * Array of filtering property definitions to be applied.
7
- */
8
- Filters = [];
9
- /**
10
- * Logical operator to be used when applying the filters.
11
- */
12
- logicalOperator;
13
- }
1
+ export {};
@@ -2,7 +2,11 @@ import { ReadSelectedComparisonOperator, ReadSelectedPropertyType } from '../..'
2
2
  /**
3
3
  * Defines a property used for filtering in a controller.
4
4
  */
5
- export declare class ReadSelectedFilteringPropertyDefinition {
5
+ export type ReadSelectedFilteringPropertyDefinition = Partial_ReadSelectedFilteringPropertyDefinition_IndependentProperties & Partial_ReadSelectedFilteringPropertyDefinition_TypedValueProperty & Partial_ReadSelectedFilteringPropertyDefinition_TypedComparisonOperators;
6
+ /**
7
+ * Defines independent properties
8
+ */
9
+ type Partial_ReadSelectedFilteringPropertyDefinition_IndependentProperties = {
6
10
  /**
7
11
  * The path to the property being filtered.
8
12
  */
@@ -19,4 +23,85 @@ export declare class ReadSelectedFilteringPropertyDefinition {
19
23
  * The value to use for the filter.
20
24
  */
21
25
  value: unknown;
22
- }
26
+ };
27
+ /**
28
+ * Defines the dependence between the .valueType and the type of the .value properties
29
+ */
30
+ type Partial_ReadSelectedFilteringPropertyDefinition_TypedValueProperty = {
31
+ /**
32
+ * The type of the property value being filtered.
33
+ */
34
+ valueType: ReadSelectedPropertyType.Bool;
35
+ /**
36
+ * The value to use for the filter.
37
+ */
38
+ value: boolean;
39
+ } | {
40
+ /**
41
+ * The type of the property value being filtered.
42
+ */
43
+ valueType: ReadSelectedPropertyType.Int | ReadSelectedPropertyType.Short | ReadSelectedPropertyType.Long | ReadSelectedPropertyType.Decimal | ReadSelectedPropertyType.Double | ReadSelectedPropertyType.Float;
44
+ /**
45
+ * The value to use for the filter.
46
+ */
47
+ value: number;
48
+ } | {
49
+ /**
50
+ * The type of the property value being filtered.
51
+ */
52
+ valueType: ReadSelectedPropertyType.String;
53
+ /**
54
+ * The value to use for the filter.
55
+ */
56
+ value: string;
57
+ } | {
58
+ /**
59
+ * The type of the property value being filtered.
60
+ */
61
+ valueType: ReadSelectedPropertyType.DateTime | ReadSelectedPropertyType.DateTimeOffset | ReadSelectedPropertyType.TimeSpan | ReadSelectedPropertyType.DateOnly | ReadSelectedPropertyType.TimeOnly;
62
+ /**
63
+ * The value to use for the filter.
64
+ */
65
+ value: string;
66
+ };
67
+ /**
68
+ * Defines the dependence between the .valueType and the type of the .comparisonOperator properties
69
+ */
70
+ type Partial_ReadSelectedFilteringPropertyDefinition_TypedComparisonOperators = {
71
+ /**
72
+ * The type of the property value being filtered.
73
+ */
74
+ valueType: ReadSelectedPropertyType.Bool;
75
+ /**
76
+ * The comparison operator to use for the filter.
77
+ */
78
+ comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual;
79
+ } | {
80
+ /**
81
+ * The type of the property value being filtered.
82
+ */
83
+ valueType: ReadSelectedPropertyType.Int | ReadSelectedPropertyType.Short | ReadSelectedPropertyType.Long | ReadSelectedPropertyType.Decimal | ReadSelectedPropertyType.Double | ReadSelectedPropertyType.Float;
84
+ /**
85
+ * The comparison operator to use for the filter.
86
+ */
87
+ comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual | ReadSelectedComparisonOperator.LessThan | ReadSelectedComparisonOperator.LessOrEqual | ReadSelectedComparisonOperator.GreaterThan | ReadSelectedComparisonOperator.GreaterOrEqual;
88
+ } | {
89
+ /**
90
+ * The type of the property value being filtered.
91
+ */
92
+ valueType: ReadSelectedPropertyType.String;
93
+ /**
94
+ * The comparison operator to use for the filter.
95
+ */
96
+ comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual | ReadSelectedComparisonOperator.Contains | ReadSelectedComparisonOperator.StartsWith | ReadSelectedComparisonOperator.EndsWith;
97
+ } | {
98
+ /**
99
+ * The type of the property value being filtered.
100
+ */
101
+ valueType: ReadSelectedPropertyType.DateTime | ReadSelectedPropertyType.DateTimeOffset | ReadSelectedPropertyType.TimeSpan | ReadSelectedPropertyType.DateOnly | ReadSelectedPropertyType.TimeOnly;
102
+ /**
103
+ * The comparison operator to use for the filter.
104
+ */
105
+ comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual | ReadSelectedComparisonOperator.LessThan | ReadSelectedComparisonOperator.LessOrEqual | ReadSelectedComparisonOperator.GreaterThan | ReadSelectedComparisonOperator.GreaterOrEqual;
106
+ };
107
+ export {};
@@ -1,21 +1 @@
1
- /**
2
- * Defines a property used for filtering in a controller.
3
- */
4
- export class ReadSelectedFilteringPropertyDefinition {
5
- /**
6
- * The path to the property being filtered.
7
- */
8
- propertyPath;
9
- /**
10
- * The comparison operator to use for the filter.
11
- */
12
- comparisonOperator;
13
- /**
14
- * The type of the property value being filtered.
15
- */
16
- valueType;
17
- /**
18
- * The value to use for the filter.
19
- */
20
- value = undefined;
21
- }
1
+ export {};
@@ -2,6 +2,6 @@ import { ReadSelectedOrderingPropertyDefinition } from '../..';
2
2
  /**
3
3
  * Represents the ordering definition for a controller.
4
4
  */
5
- export declare class ReadSelectedOrderingDefinition {
5
+ export type ReadSelectedOrderingDefinition = {
6
6
  order: ReadSelectedOrderingPropertyDefinition[];
7
- }
7
+ };
@@ -1,6 +1 @@
1
- /**
2
- * Represents the ordering definition for a controller.
3
- */
4
- export class ReadSelectedOrderingDefinition {
5
- order = [];
6
- }
1
+ export {};
@@ -2,7 +2,7 @@ import { ReadSelectedOrderingDirection } from '../..';
2
2
  /**
3
3
  * Defines the ordering property for a controller.
4
4
  */
5
- export declare class ReadSelectedOrderingPropertyDefinition {
5
+ export type ReadSelectedOrderingPropertyDefinition = {
6
6
  /**
7
7
  * Gets or sets the property path.
8
8
  */
@@ -11,4 +11,4 @@ export declare class ReadSelectedOrderingPropertyDefinition {
11
11
  * Gets or sets the sort direction.
12
12
  */
13
13
  direction: ReadSelectedOrderingDirection;
14
- }
14
+ };
@@ -1,14 +1 @@
1
- import { ReadSelectedOrderingDirection } from '../..';
2
- /**
3
- * Defines the ordering property for a controller.
4
- */
5
- export class ReadSelectedOrderingPropertyDefinition {
6
- /**
7
- * Gets or sets the property path.
8
- */
9
- propertyPath;
10
- /**
11
- * Gets or sets the sort direction.
12
- */
13
- direction = ReadSelectedOrderingDirection.Ascending;
14
- }
1
+ export {};
@@ -1,13 +1,13 @@
1
1
  /**
2
2
  * Defines the pagination parameters for a controller.
3
3
  */
4
- export declare class ReadSelectedPaginationDefinition {
4
+ export type ReadSelectedPaginationDefinition = {
5
5
  /**
6
6
  * Pagination offset
7
7
  */
8
- Skip?: number;
8
+ skip: number;
9
9
  /**
10
10
  * Pagination limit
11
11
  */
12
- Limit?: number;
13
- }
12
+ limit: number;
13
+ };
@@ -1,13 +1 @@
1
- /**
2
- * Defines the pagination parameters for a controller.
3
- */
4
- export class ReadSelectedPaginationDefinition {
5
- /**
6
- * Pagination offset
7
- */
8
- Skip = 0;
9
- /**
10
- * Pagination limit
11
- */
12
- Limit = undefined;
13
- }
1
+ export {};
@@ -9,5 +9,33 @@ export declare enum ReadSelectedComparisonOperator {
9
9
  /**
10
10
  * Represents the not equal comparison operator.
11
11
  */
12
- NotEqual = 1
12
+ NotEqual = 1,
13
+ /**
14
+ * Represents the less than comparison operator.
15
+ */
16
+ LessThan = 100,
17
+ /**
18
+ * Represents the less than or equal comparison operator.
19
+ */
20
+ LessOrEqual = 101,
21
+ /**
22
+ * Represents the greater than comparison operator.
23
+ */
24
+ GreaterThan = 102,
25
+ /**
26
+ * Represents the greater than or equal comparison operator.
27
+ */
28
+ GreaterOrEqual = 103,
29
+ /**
30
+ * Represents the contains comparison operator.
31
+ */
32
+ Contains = 200,
33
+ /**
34
+ * Represents the starts with comparison operator.
35
+ */
36
+ StartsWith = 201,
37
+ /**
38
+ * Represents the ends with comparison operator.
39
+ */
40
+ EndsWith = 202
13
41
  }
@@ -14,10 +14,36 @@ export var ReadSelectedComparisonOperator;
14
14
  ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["NotEqual"] = 1] = "NotEqual";
15
15
  //#endregion
16
16
  //#region Number
17
- // ...
17
+ /**
18
+ * Represents the less than comparison operator.
19
+ */
20
+ ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["LessThan"] = 100] = "LessThan";
21
+ /**
22
+ * Represents the less than or equal comparison operator.
23
+ */
24
+ ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["LessOrEqual"] = 101] = "LessOrEqual";
25
+ /**
26
+ * Represents the greater than comparison operator.
27
+ */
28
+ ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["GreaterThan"] = 102] = "GreaterThan";
29
+ /**
30
+ * Represents the greater than or equal comparison operator.
31
+ */
32
+ ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["GreaterOrEqual"] = 103] = "GreaterOrEqual";
18
33
  //#endregion
19
34
  //#region String
20
- // ...
35
+ /**
36
+ * Represents the contains comparison operator.
37
+ */
38
+ ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["Contains"] = 200] = "Contains";
39
+ /**
40
+ * Represents the starts with comparison operator.
41
+ */
42
+ ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["StartsWith"] = 201] = "StartsWith";
43
+ /**
44
+ * Represents the ends with comparison operator.
45
+ */
46
+ ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["EndsWith"] = 202] = "EndsWith";
21
47
  //#endregion
22
48
  //#region Time
23
49
  // ...
@@ -11,12 +11,48 @@ export declare enum ReadSelectedPropertyType {
11
11
  * Represents an integer property type.
12
12
  */
13
13
  Int = 100,
14
+ /**
15
+ * Represents a short property type.
16
+ */
17
+ Short = 101,
14
18
  /**
15
19
  * Represents a long property type.
16
20
  */
17
- Long = 101,
21
+ Long = 102,
22
+ /**
23
+ * Represents a decimal property type.
24
+ */
25
+ Decimal = 103,
26
+ /**
27
+ * Represents a double property type.
28
+ */
29
+ Double = 104,
30
+ /**
31
+ * Represents a float property type.
32
+ */
33
+ Float = 105,
18
34
  /**
19
35
  * Represents a string property type.
20
36
  */
21
- String = 200
37
+ String = 200,
38
+ /**
39
+ * Represents a DateTime property type.
40
+ */
41
+ DateTime = 300,
42
+ /**
43
+ * Represents a DateTimeOffset property type.
44
+ */
45
+ DateTimeOffset = 301,
46
+ /**
47
+ * Represents a TimeSpan property type.
48
+ */
49
+ TimeSpan = 302,
50
+ /**
51
+ * Represents a DateOnly property type.
52
+ */
53
+ DateOnly = 303,
54
+ /**
55
+ * Represents a TimeOnly property type.
56
+ */
57
+ TimeOnly = 304
22
58
  }
@@ -15,10 +15,26 @@ export var ReadSelectedPropertyType;
15
15
  * Represents an integer property type.
16
16
  */
17
17
  ReadSelectedPropertyType[ReadSelectedPropertyType["Int"] = 100] = "Int";
18
+ /**
19
+ * Represents a short property type.
20
+ */
21
+ ReadSelectedPropertyType[ReadSelectedPropertyType["Short"] = 101] = "Short";
18
22
  /**
19
23
  * Represents a long property type.
20
24
  */
21
- ReadSelectedPropertyType[ReadSelectedPropertyType["Long"] = 101] = "Long";
25
+ ReadSelectedPropertyType[ReadSelectedPropertyType["Long"] = 102] = "Long";
26
+ /**
27
+ * Represents a decimal property type.
28
+ */
29
+ ReadSelectedPropertyType[ReadSelectedPropertyType["Decimal"] = 103] = "Decimal";
30
+ /**
31
+ * Represents a double property type.
32
+ */
33
+ ReadSelectedPropertyType[ReadSelectedPropertyType["Double"] = 104] = "Double";
34
+ /**
35
+ * Represents a float property type.
36
+ */
37
+ ReadSelectedPropertyType[ReadSelectedPropertyType["Float"] = 105] = "Float";
22
38
  //#endregion
23
39
  //#region string
24
40
  /**
@@ -27,6 +43,25 @@ export var ReadSelectedPropertyType;
27
43
  ReadSelectedPropertyType[ReadSelectedPropertyType["String"] = 200] = "String";
28
44
  //#endregion
29
45
  //#region Time
30
- // ...
46
+ /**
47
+ * Represents a DateTime property type.
48
+ */
49
+ ReadSelectedPropertyType[ReadSelectedPropertyType["DateTime"] = 300] = "DateTime";
50
+ /**
51
+ * Represents a DateTimeOffset property type.
52
+ */
53
+ ReadSelectedPropertyType[ReadSelectedPropertyType["DateTimeOffset"] = 301] = "DateTimeOffset";
54
+ /**
55
+ * Represents a TimeSpan property type.
56
+ */
57
+ ReadSelectedPropertyType[ReadSelectedPropertyType["TimeSpan"] = 302] = "TimeSpan";
58
+ /**
59
+ * Represents a DateOnly property type.
60
+ */
61
+ ReadSelectedPropertyType[ReadSelectedPropertyType["DateOnly"] = 303] = "DateOnly";
62
+ /**
63
+ * Represents a TimeOnly property type.
64
+ */
65
+ ReadSelectedPropertyType[ReadSelectedPropertyType["TimeOnly"] = 304] = "TimeOnly";
31
66
  //#endregion
32
67
  })(ReadSelectedPropertyType || (ReadSelectedPropertyType = {}));
@@ -1,10 +1,10 @@
1
1
  /**
2
- * Interface for entities that have a Id property.
2
+ * Type for entities that have a Id property.
3
3
  * Will be used as a primary key in the database.
4
4
  */
5
- export interface IIdentifiable<TKey> {
5
+ export type IIdentifiable<TKey> = {
6
6
  /**
7
7
  * Gets or sets the Id of the entity.
8
8
  */
9
9
  id: TKey;
10
- }
10
+ };
@@ -1,9 +1,9 @@
1
1
  /**
2
- * Interface for entities that have a Guid property.
2
+ * Type for entities that have a Guid property.
3
3
  */
4
- export interface IIdentifiableByGuid {
4
+ export type IIdentifiableByGuid = {
5
5
  /**
6
6
  * Gets or sets the Guid of the entity.
7
7
  */
8
8
  guid: string;
9
- }
9
+ };
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Type for entities that can, but don't have to have an Id property.
3
+ * If present, will be used as a primary key in the database, and if not it signifies an entity that was not yet
4
+ * stored.
5
+ */
6
+ export type IOptionallyIdentifiable<TKey> = {
7
+ /**
8
+ * Gets or sets the Id of the entity.
9
+ */
10
+ id?: TKey;
11
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -1,2 +1,3 @@
1
1
  export * from './IIdentifiable';
2
+ export * from './IOptionallyIdentifiable';
2
3
  export * from './IIdentifiableByGuid';
@@ -1,2 +1,3 @@
1
1
  export * from './IIdentifiable';
2
+ export * from './IOptionallyIdentifiable';
2
3
  export * from './IIdentifiableByGuid';
@@ -1,4 +1,4 @@
1
- export interface Claim {
1
+ export type Claim = {
2
2
  type: string;
3
3
  value: string;
4
- }
4
+ };
@@ -1,5 +1,5 @@
1
1
  import { Claim } from '../..';
2
- export interface Role {
2
+ export type Role = {
3
3
  name: string;
4
4
  claims: Claim[];
5
- }
5
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@intellegens/cornerstone-client",
3
- "version": "0.0.24",
3
+ "version": "0.0.26",
4
4
  "main": "index.js",
5
5
  "type": "module",
6
6
  "scripts": {