@caraer/client 2.0.630 → 2.0.632
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/api.ts +7 -3
- package/dist/api.d.ts +7 -3
- package/dist/esm/api.d.ts +7 -3
- package/docs/AppSettingFieldSchema.md +2 -2
- package/docs/FilledProperty.md +2 -2
- package/docs/PageContentSettingsDTO.md +2 -0
- package/docs/Record.md +2 -2
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -1026,8 +1026,8 @@ export interface AppSettingFieldSchema {
|
|
|
1026
1026
|
'clearValue'?: boolean;
|
|
1027
1027
|
'mappingValue'?: AppSettingFieldMappingStructure;
|
|
1028
1028
|
'valueScope'?: string;
|
|
1029
|
-
'action'?: boolean;
|
|
1030
1029
|
'settingsGroup'?: boolean;
|
|
1030
|
+
'action'?: boolean;
|
|
1031
1031
|
'filterPropertyTypes'?: Array<string>;
|
|
1032
1032
|
'filterPropertyFormats'?: Array<string>;
|
|
1033
1033
|
}
|
|
@@ -2897,10 +2897,10 @@ export interface FileListItemDTO {
|
|
|
2897
2897
|
'contentType'?: string;
|
|
2898
2898
|
}
|
|
2899
2899
|
export interface FilledProperty {
|
|
2900
|
+
'icon'?: string;
|
|
2900
2901
|
'name'?: string;
|
|
2901
2902
|
'value'?: any;
|
|
2902
2903
|
'type'?: string;
|
|
2903
|
-
'icon'?: string;
|
|
2904
2904
|
'label'?: string;
|
|
2905
2905
|
}
|
|
2906
2906
|
/**
|
|
@@ -3729,9 +3729,9 @@ export interface ModelRecord {
|
|
|
3729
3729
|
'complete'?: boolean;
|
|
3730
3730
|
'deleted'?: boolean;
|
|
3731
3731
|
'uuid': string;
|
|
3732
|
+
'user'?: PublicUserDTO;
|
|
3732
3733
|
'properties'?: Array<FilledProperty>;
|
|
3733
3734
|
'objects'?: { [key: string]: any | null; };
|
|
3734
|
-
'user'?: PublicUserDTO;
|
|
3735
3735
|
}
|
|
3736
3736
|
export interface MultiFile extends PropertyFormat {
|
|
3737
3737
|
}
|
|
@@ -4060,6 +4060,10 @@ export interface PageContentSettingsDTO {
|
|
|
4060
4060
|
* Whether the previews should be shown as webpages
|
|
4061
4061
|
*/
|
|
4062
4062
|
'asWebpages'?: boolean;
|
|
4063
|
+
/**
|
|
4064
|
+
* In record mode (asWebpages=false), require published pages. Defaults to true; false includes unpublished records while retaining protection checks.
|
|
4065
|
+
*/
|
|
4066
|
+
'publishedOnly'?: boolean;
|
|
4063
4067
|
/**
|
|
4064
4068
|
* Whether the previews should loop
|
|
4065
4069
|
*/
|
package/dist/api.d.ts
CHANGED
|
@@ -1016,8 +1016,8 @@ export interface AppSettingFieldSchema {
|
|
|
1016
1016
|
'clearValue'?: boolean;
|
|
1017
1017
|
'mappingValue'?: AppSettingFieldMappingStructure;
|
|
1018
1018
|
'valueScope'?: string;
|
|
1019
|
-
'action'?: boolean;
|
|
1020
1019
|
'settingsGroup'?: boolean;
|
|
1020
|
+
'action'?: boolean;
|
|
1021
1021
|
'filterPropertyTypes'?: Array<string>;
|
|
1022
1022
|
'filterPropertyFormats'?: Array<string>;
|
|
1023
1023
|
}
|
|
@@ -2890,10 +2890,10 @@ export interface FileListItemDTO {
|
|
|
2890
2890
|
'contentType'?: string;
|
|
2891
2891
|
}
|
|
2892
2892
|
export interface FilledProperty {
|
|
2893
|
+
'icon'?: string;
|
|
2893
2894
|
'name'?: string;
|
|
2894
2895
|
'value'?: any;
|
|
2895
2896
|
'type'?: string;
|
|
2896
|
-
'icon'?: string;
|
|
2897
2897
|
'label'?: string;
|
|
2898
2898
|
}
|
|
2899
2899
|
/**
|
|
@@ -3740,11 +3740,11 @@ export interface ModelRecord {
|
|
|
3740
3740
|
'complete'?: boolean;
|
|
3741
3741
|
'deleted'?: boolean;
|
|
3742
3742
|
'uuid': string;
|
|
3743
|
+
'user'?: PublicUserDTO;
|
|
3743
3744
|
'properties'?: Array<FilledProperty>;
|
|
3744
3745
|
'objects'?: {
|
|
3745
3746
|
[key: string]: any | null;
|
|
3746
3747
|
};
|
|
3747
|
-
'user'?: PublicUserDTO;
|
|
3748
3748
|
}
|
|
3749
3749
|
export interface MultiFile extends PropertyFormat {
|
|
3750
3750
|
}
|
|
@@ -4078,6 +4078,10 @@ export interface PageContentSettingsDTO {
|
|
|
4078
4078
|
* Whether the previews should be shown as webpages
|
|
4079
4079
|
*/
|
|
4080
4080
|
'asWebpages'?: boolean;
|
|
4081
|
+
/**
|
|
4082
|
+
* In record mode (asWebpages=false), require published pages. Defaults to true; false includes unpublished records while retaining protection checks.
|
|
4083
|
+
*/
|
|
4084
|
+
'publishedOnly'?: boolean;
|
|
4081
4085
|
/**
|
|
4082
4086
|
* Whether the previews should loop
|
|
4083
4087
|
*/
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1016,8 +1016,8 @@ export interface AppSettingFieldSchema {
|
|
|
1016
1016
|
'clearValue'?: boolean;
|
|
1017
1017
|
'mappingValue'?: AppSettingFieldMappingStructure;
|
|
1018
1018
|
'valueScope'?: string;
|
|
1019
|
-
'action'?: boolean;
|
|
1020
1019
|
'settingsGroup'?: boolean;
|
|
1020
|
+
'action'?: boolean;
|
|
1021
1021
|
'filterPropertyTypes'?: Array<string>;
|
|
1022
1022
|
'filterPropertyFormats'?: Array<string>;
|
|
1023
1023
|
}
|
|
@@ -2890,10 +2890,10 @@ export interface FileListItemDTO {
|
|
|
2890
2890
|
'contentType'?: string;
|
|
2891
2891
|
}
|
|
2892
2892
|
export interface FilledProperty {
|
|
2893
|
+
'icon'?: string;
|
|
2893
2894
|
'name'?: string;
|
|
2894
2895
|
'value'?: any;
|
|
2895
2896
|
'type'?: string;
|
|
2896
|
-
'icon'?: string;
|
|
2897
2897
|
'label'?: string;
|
|
2898
2898
|
}
|
|
2899
2899
|
/**
|
|
@@ -3740,11 +3740,11 @@ export interface ModelRecord {
|
|
|
3740
3740
|
'complete'?: boolean;
|
|
3741
3741
|
'deleted'?: boolean;
|
|
3742
3742
|
'uuid': string;
|
|
3743
|
+
'user'?: PublicUserDTO;
|
|
3743
3744
|
'properties'?: Array<FilledProperty>;
|
|
3744
3745
|
'objects'?: {
|
|
3745
3746
|
[key: string]: any | null;
|
|
3746
3747
|
};
|
|
3747
|
-
'user'?: PublicUserDTO;
|
|
3748
3748
|
}
|
|
3749
3749
|
export interface MultiFile extends PropertyFormat {
|
|
3750
3750
|
}
|
|
@@ -4078,6 +4078,10 @@ export interface PageContentSettingsDTO {
|
|
|
4078
4078
|
* Whether the previews should be shown as webpages
|
|
4079
4079
|
*/
|
|
4080
4080
|
'asWebpages'?: boolean;
|
|
4081
|
+
/**
|
|
4082
|
+
* In record mode (asWebpages=false), require published pages. Defaults to true; false includes unpublished records while retaining protection checks.
|
|
4083
|
+
*/
|
|
4084
|
+
'publishedOnly'?: boolean;
|
|
4081
4085
|
/**
|
|
4082
4086
|
* Whether the previews should loop
|
|
4083
4087
|
*/
|
|
@@ -33,8 +33,8 @@ Name | Type | Description | Notes
|
|
|
33
33
|
**clearValue** | **boolean** | | [optional] [default to undefined]
|
|
34
34
|
**mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) | | [optional] [default to undefined]
|
|
35
35
|
**valueScope** | **string** | | [optional] [default to undefined]
|
|
36
|
-
**action** | **boolean** | | [optional] [default to undefined]
|
|
37
36
|
**settingsGroup** | **boolean** | | [optional] [default to undefined]
|
|
37
|
+
**action** | **boolean** | | [optional] [default to undefined]
|
|
38
38
|
**filterPropertyTypes** | **Array<string>** | | [optional] [default to undefined]
|
|
39
39
|
**filterPropertyFormats** | **Array<string>** | | [optional] [default to undefined]
|
|
40
40
|
|
|
@@ -72,8 +72,8 @@ const instance: AppSettingFieldSchema = {
|
|
|
72
72
|
clearValue,
|
|
73
73
|
mappingValue,
|
|
74
74
|
valueScope,
|
|
75
|
-
action,
|
|
76
75
|
settingsGroup,
|
|
76
|
+
action,
|
|
77
77
|
filterPropertyTypes,
|
|
78
78
|
filterPropertyFormats,
|
|
79
79
|
};
|
package/docs/FilledProperty.md
CHANGED
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**icon** | **string** | | [optional] [default to undefined]
|
|
8
9
|
**name** | **string** | | [optional] [default to undefined]
|
|
9
10
|
**value** | **any** | | [optional] [default to undefined]
|
|
10
11
|
**type** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**icon** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**label** | **string** | | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
@@ -17,10 +17,10 @@ Name | Type | Description | Notes
|
|
|
17
17
|
import { FilledProperty } from '@caraer/client';
|
|
18
18
|
|
|
19
19
|
const instance: FilledProperty = {
|
|
20
|
+
icon,
|
|
20
21
|
name,
|
|
21
22
|
value,
|
|
22
23
|
type,
|
|
23
|
-
icon,
|
|
24
24
|
label,
|
|
25
25
|
};
|
|
26
26
|
```
|
|
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
|
|
|
29
29
|
**orderBy** | [**PropertyDTO**](PropertyDTO.md) | The order by property associated with the settings | [optional] [default to undefined]
|
|
30
30
|
**orderByDirection** | **string** | The order by direction associated with the settings. ASC or DESC, default is ASC | [optional] [default to undefined]
|
|
31
31
|
**asWebpages** | **boolean** | Whether the previews should be shown as webpages | [optional] [default to undefined]
|
|
32
|
+
**publishedOnly** | **boolean** | In record mode (asWebpages=false), require published pages. Defaults to true; false includes unpublished records while retaining protection checks. | [optional] [default to undefined]
|
|
32
33
|
**loop** | **boolean** | Whether the previews should loop | [optional] [default to undefined]
|
|
33
34
|
**limit** | **number** | The limit associated with the settings | [optional] [default to undefined]
|
|
34
35
|
**groupBy** | [**PropertyDTO**](PropertyDTO.md) | The group by property associated with the settings | [optional] [default to undefined]
|
|
@@ -90,6 +91,7 @@ const instance: PageContentSettingsDTO = {
|
|
|
90
91
|
orderBy,
|
|
91
92
|
orderByDirection,
|
|
92
93
|
asWebpages,
|
|
94
|
+
publishedOnly,
|
|
93
95
|
loop,
|
|
94
96
|
limit,
|
|
95
97
|
groupBy,
|
package/docs/Record.md
CHANGED
|
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**complete** | **boolean** | | [optional] [default to undefined]
|
|
18
18
|
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**uuid** | **string** | | [default to undefined]
|
|
20
|
+
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
20
21
|
**properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
|
|
21
22
|
**objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
22
|
-
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
|
@@ -39,9 +39,9 @@ const instance: ModelRecord = {
|
|
|
39
39
|
complete,
|
|
40
40
|
deleted,
|
|
41
41
|
uuid,
|
|
42
|
+
user,
|
|
42
43
|
properties,
|
|
43
44
|
objects,
|
|
44
|
-
user,
|
|
45
45
|
};
|
|
46
46
|
```
|
|
47
47
|
|