jourycms-sdk 1.0.3 → 1.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. package/package.json +1 -1
  2. package/typings/v1/cache-manager/entity.d.ts +12 -1
  3. package/typings/v1/index.d.ts +1 -0
  4. package/typings/v1/services/auth/api/auth.d.ts +5 -1
  5. package/typings/v1/services/auth/entities/role.d.ts +7 -1
  6. package/typings/v1/services/auth/entities/user.d.ts +1 -56
  7. package/typings/v1/services/content/api/article.d.ts +3 -2
  8. package/typings/v1/services/content/entities/article-type.d.ts +2 -2
  9. package/typings/v1/services/content/entities/article.d.ts +3 -5
  10. package/typings/v1/services/content/entities/comment.d.ts +1 -1
  11. package/typings/v1/services/content/entities/custom-fieds/custom-field.d.ts +160 -0
  12. package/typings/v1/services/content/entities/custom-fieds/fields/article_object.custom-field.d.ts +27 -0
  13. package/typings/v1/services/content/entities/custom-fieds/fields/boolean.custom-field.d.ts +22 -0
  14. package/typings/v1/services/content/entities/custom-fieds/fields/checkbox.custom-field.d.ts +24 -0
  15. package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/date.custom-field.d.ts +2 -4
  16. package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/date_range.custom-field.d.ts +2 -4
  17. package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/file.custom-field.d.ts +2 -4
  18. package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/image.custom-field.d.ts +2 -4
  19. package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/number.custom-field.d.ts +2 -4
  20. package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/radiobox.custom-field.d.ts +5 -7
  21. package/typings/v1/services/content/entities/custom-fieds/fields/select.custom-field.d.ts +25 -0
  22. package/typings/v1/services/content/entities/custom-fieds/fields/text.custom-field.d.ts +24 -0
  23. package/typings/v1/services/content/entities/custom-fieds/fields/time.custom-field.d.ts +22 -0
  24. package/typings/v1/services/content/entities/custom-fieds/index.d.ts +2 -0
  25. package/typings/v1/services/content/entities/review.d.ts +1 -1
  26. package/typings/v1/services/content/entities/taxonomy.d.ts +1 -1
  27. package/typings/v1/services/content/entities/term.d.ts +1 -1
  28. package/typings/v1/services/storage/entities/uploaded-file.d.ts +0 -2
  29. package/typings/v1/services/system/entities/config.d.ts +40 -0
  30. package/typings/v1/theme/component.d.ts +9 -0
  31. package/typings/v1/theme/index.d.ts +3 -0
  32. package/typings/v1/theme/layout.d.ts +10 -0
  33. package/typings/v1/theme/page.d.ts +9 -0
  34. package/typings/v1/ui/forms/article/index.d.ts +0 -1
  35. package/typings/v1/ui/routes/icons.d.ts +28 -0
  36. package/typings/v1/ui/routes/index.d.ts +1 -0
  37. package/typings/v1/ui/routes/routes.d.ts +0 -19
  38. package/typings/v1/utils/api/request.d.ts +34 -31
  39. package/typings/v1/utils/api/response.d.ts +20 -54
  40. package/typings/v1/utils/common/common.d.ts +5 -0
  41. package/typings/v1/utils/entities/snapshots.d.ts +0 -11
  42. package/typings/v1/utils/system/models.d.ts +18 -16
  43. package/typings/v1/utils/utils.d.ts +3 -0
  44. package/typings/v1/ui/forms/article/custom-fieds/custom-field.d.ts +0 -189
  45. package/typings/v1/ui/forms/article/custom-fieds/fields/article_object.custom-field.d.ts +0 -29
  46. package/typings/v1/ui/forms/article/custom-fieds/fields/boolean.custom-field.d.ts +0 -24
  47. package/typings/v1/ui/forms/article/custom-fieds/fields/checkbox.custom-field.d.ts +0 -26
  48. package/typings/v1/ui/forms/article/custom-fieds/fields/select.custom-field.d.ts +0 -27
  49. package/typings/v1/ui/forms/article/custom-fieds/fields/text.custom-field.d.ts +0 -26
  50. package/typings/v1/ui/forms/article/custom-fieds/fields/time.custom-field.d.ts +0 -24
  51. package/typings/v1/ui/forms/article/custom-fieds/index.d.ts +0 -1
  52. /package/typings/v1/{ui/forms/article → services/content/entities}/custom-fieds/fields/index.d.ts +0 -0
@@ -22,7 +22,7 @@ declare module Levelup {
22
22
 
23
23
  body: string;
24
24
  body_unformatted: string;
25
- body_structured: { [Key: string]: any };
25
+ body_structured: JSONContent;
26
26
 
27
27
  value: number;
28
28
 
@@ -16,7 +16,7 @@ declare module Levelup {
16
16
 
17
17
  description: string;
18
18
  description_unformatted: string;
19
- description_structured: { [Key: string]: any };
19
+ description_structured: JSONContent;
20
20
 
21
21
  // hierarchy
22
22
  is_multi: boolean;
@@ -31,7 +31,7 @@ declare module Levelup {
31
31
 
32
32
  description: string;
33
33
  description_unformatted: string;
34
- description_structured: { [Key: string]: any };
34
+ description_structured: JSONContent;
35
35
 
36
36
  snapshots: ITermSnapshots;
37
37
  insights: ITermInsights;
@@ -4,11 +4,9 @@ declare module Levelup {
4
4
  namespace Storage {
5
5
  export namespace Entity {
6
6
  export interface IUploadedFileAttributes {
7
- store?: Utils.Common.ID;
8
7
  }
9
8
 
10
9
  export interface IUploadedFileSnapshots {
11
- store?: Utils.Entity.Snapshots.Accounts.Store;
12
10
  }
13
11
 
14
12
  export interface UploadedFile
@@ -0,0 +1,40 @@
1
+ declare module Levelup {
2
+ namespace CMS {
3
+ namespace V1 {
4
+ namespace System {
5
+
6
+ export namespace Entity {
7
+ /**
8
+ * Represents the settings for an app.
9
+ */
10
+ export interface WebsiteConfig {
11
+ name?: string;
12
+ description?: string;
13
+ version?: string;
14
+ contact_phones?: string[];
15
+ contact_email?: string;
16
+ contact_whatsapp?: string;
17
+ social_links?: {
18
+ network: Utils.Common.SocialNetworks;
19
+ url: string;
20
+ }[];
21
+ address?: string;
22
+ months?: {
23
+ [month: number]: string
24
+ };
25
+ states?: {
26
+ code: string;
27
+ name: string;
28
+ }[];
29
+ cities?: {
30
+ state_code: string;
31
+ code: string;
32
+ name: string;
33
+ }[];
34
+ }
35
+ }
36
+ }
37
+ }
38
+ }
39
+ }
40
+
@@ -0,0 +1,9 @@
1
+
2
+
3
+ declare module JouryCMS {
4
+ export namespace Theme {
5
+ export type ComponentProps = {
6
+ children?: React.ReactNode;
7
+ }
8
+ }
9
+ }
@@ -0,0 +1,3 @@
1
+ export * from "./layout.d.ts";
2
+ export * from "./page.d.ts";
3
+
@@ -0,0 +1,10 @@
1
+
2
+
3
+ declare module JouryCMS {
4
+ export namespace Theme {
5
+ export type LayoutProps = {
6
+ route: Levelup.CMS.V1.UI.Routes.RouteItem;
7
+ children: React.ReactNode;
8
+ }
9
+ }
10
+ }
@@ -0,0 +1,9 @@
1
+
2
+
3
+ declare module JouryCMS {
4
+ export namespace Theme {
5
+ export type PageProps = {
6
+ route: Levelup.CMS.V1.UI.Routes.RouteItem;
7
+ }
8
+ }
9
+ }
@@ -1 +0,0 @@
1
- export * from "./custom-fields/index..d.ts";
@@ -0,0 +1,28 @@
1
+ declare module Levelup {
2
+ namespace CMS {
3
+ namespace V1 {
4
+ export namespace UI {
5
+ type IconType = (props: {
6
+ className?: string | undefined;
7
+ height?: number | string | undefined;
8
+ id?: string | undefined;
9
+ lang?: string | undefined;
10
+ max?: number | string | undefined;
11
+ media?: string | undefined;
12
+ method?: string | undefined;
13
+ min?: number | string | undefined;
14
+ name?: string | undefined;
15
+ style?: CSSProperties | undefined;
16
+ target?: string | undefined;
17
+ type?: string | undefined;
18
+ width?: number | string | undefined;
19
+ children?: React.ReactNode;
20
+ size?: string | number;
21
+ color?: string;
22
+ title?: string;
23
+ }) => JSX.Element;
24
+
25
+ }
26
+ }
27
+ }
28
+ }
@@ -1 +1,2 @@
1
1
  export * from "./routes.d.ts";
2
+ export * from "./icons.d.ts";
@@ -3,25 +3,6 @@ declare module Levelup {
3
3
  namespace V1 {
4
4
  export namespace UI {
5
5
  export namespace Routes {
6
- type IconType = (props: {
7
- className?: string | undefined;
8
- height?: number | string | undefined;
9
- id?: string | undefined;
10
- lang?: string | undefined;
11
- max?: number | string | undefined;
12
- media?: string | undefined;
13
- method?: string | undefined;
14
- min?: number | string | undefined;
15
- name?: string | undefined;
16
- style?: CSSProperties | undefined;
17
- target?: string | undefined;
18
- type?: string | undefined;
19
- width?: number | string | undefined;
20
- children?: React.ReactNode;
21
- size?: string | number;
22
- color?: string;
23
- title?: string;
24
- }) => JSX.Element;
25
6
 
26
7
  type TACAction = "read" | "create" | "update" | "delete" | "manage";
27
8
 
@@ -97,13 +97,16 @@ declare module Levelup {
97
97
  };
98
98
  };
99
99
 
100
+ type TProjectableFields<T extends object> =
101
+ | Utils.DocumentProperties<T>
102
+ | Utils.ExcludeDocumentProperties<T>
103
+ ;
100
104
  type Projectable<T extends object> = {
101
- fields?: (
102
- | Utils.DocumentProperties<T>
103
- | Utils.ExcludeDocumentProperties<T>
104
- )[];
105
+ fields?: ProjectableFields<T>[];
105
106
  };
106
107
 
108
+
109
+
107
110
  type Build<T> = Request<T>;
108
111
  type BuildSearchable = Request<Searchable>;
109
112
  type BuildPaged = Request<Paged>;
@@ -120,71 +123,71 @@ declare module Levelup {
120
123
  Request<Searchable & Paged & Sortable<T> & Projectable<T>>;
121
124
  type BuildSearchablePagedFilterable<T> = Request<
122
125
  Searchable &
123
- Paged &
124
- Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>>
126
+ Paged &
127
+ Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>>
125
128
  >;
126
129
  type BuildSearchablePagedFilterableProjectable<T extends object> =
127
130
  Request<
128
131
  Searchable &
129
- Paged &
130
- Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
131
- Projectable<T>
132
+ Paged &
133
+ Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
134
+ Projectable<T>
132
135
  >;
133
136
  type BuildSearchablePagedSortableFilterable<T extends object> =
134
137
  Request<
135
138
  Searchable &
136
- Paged &
137
- Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
138
- Sortable<T>
139
+ Paged &
140
+ Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
141
+ Sortable<T>
139
142
  >;
140
143
  type BuildSearchablePagedSortableFilterableProjectable<
141
144
  T extends object,
142
145
  > = Request<
143
146
  Searchable &
144
- Paged &
145
- Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
146
- Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
147
- Sortable<T> &
148
- Projectable<T>
147
+ Paged &
148
+ Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
149
+ Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
150
+ Sortable<T> &
151
+ Projectable<T>
149
152
  >;
150
153
  type BuildSortableFilterable<T extends object> = Request<
151
154
  Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>> & Sortable<T>
152
155
  >;
153
156
  type BuildSortableFilterableProjectable<T extends object> = Request<
154
157
  Filterable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
155
- Sortable<T> &
156
- Projectable<T>
158
+ Sortable<T> &
159
+ Projectable<T>
157
160
  >;
158
161
  type BuildSearchablePagedFilterableDeliverable<T extends object> =
159
162
  Request<
160
163
  Searchable &
161
- Paged &
162
- FilterableDeliverable<Levelup.CMS.V1.Utils.DocumentProperties<T>>
164
+ Paged &
165
+ FilterableDeliverable<Levelup.CMS.V1.Utils.DocumentProperties<T>>
163
166
  >;
164
167
  type BuildSearchablePagedFilterableDeliverableProjectable<
165
168
  T extends object,
166
169
  > = Request<
167
170
  Searchable &
168
- Paged &
169
- FilterableDeliverable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
170
- Projectable<T>
171
+ Paged &
172
+ FilterableDeliverable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
173
+ Projectable<T>
171
174
  >;
172
175
  type BuildSearchablePagedSortableFilterableDeliverable<
173
176
  T extends object,
174
177
  > = Request<
175
178
  Searchable &
176
- Paged &
177
- FilterableDeliverable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
178
- Sortable<T>
179
+ Paged &
180
+ FilterableDeliverable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
181
+ Sortable<T>
179
182
  >;
180
183
  type BuildSearchablePagedSortableFilterableDeliverableProjectable<
181
184
  T extends object,
182
185
  > = Request<
183
186
  Searchable &
184
- Paged &
185
- FilterableDeliverable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
186
- Sortable<T> &
187
- Projectable<T>
187
+ Paged &
188
+ FilterableDeliverable<Levelup.CMS.V1.Utils.DocumentProperties<T>> &
189
+ Sortable<T> &
190
+ Projectable<T>
188
191
  >;
189
192
 
190
193
  // create
@@ -5,7 +5,7 @@ declare module Levelup {
5
5
  namespace CMS {
6
6
  namespace V1 {
7
7
  namespace Utils {
8
-
8
+
9
9
  export namespace Api {
10
10
  export namespace Response {
11
11
  type ErrorObject = {
@@ -41,13 +41,13 @@ declare module Levelup {
41
41
  Obj extends object,
42
42
  F extends Levelup.CMS.V1.Utils.DocumentRootProperties<Obj>,
43
43
  > = {
44
- [key in F]?: {
45
- value: any;
46
- message: string;
47
- label?: string;
48
- meta?: any;
44
+ [key in F]?: {
45
+ value: any;
46
+ message: string;
47
+ label?: string;
48
+ meta?: any;
49
+ };
49
50
  };
50
- };
51
51
 
52
52
  type Error = {
53
53
  message: string;
@@ -118,58 +118,24 @@ declare module Levelup {
118
118
  } & DefaultResponse;
119
119
 
120
120
  type TResponseEdge = {
121
- companies: {
122
- [ID: string]: Utils.Entity.Snapshots.Accounts.Company | null;
123
- };
124
- company:
125
- | Utils.Entity.Snapshots.Accounts.Company
126
- | Accounts.Entity.Company
127
- | null;
128
- stores: {
129
- [ID: string]: Utils.Entity.Snapshots.Accounts.Store | null;
130
- };
131
- store:
132
- | Utils.Entity.Snapshots.Accounts.Store
133
- | Accounts.Entity.Store
134
- | null;
135
121
  users: {
136
122
  [ID: string]: Utils.Entity.Snapshots.Auth.User | null;
137
123
  };
138
124
  user: Utils.Entity.Snapshots.Auth.User | Users.Entity.User | null;
139
- offices: {
140
- [ID: string]: Utils.Entity.Snapshots.Logistics.Office | null;
141
- };
142
- office:
143
- | Utils.Entity.Snapshots.Logistics.Office
144
- | Logistics.Entity.Office
145
- | null;
146
- regional_managements: {
147
- [
148
- ID: string
149
- ]: Utils.Entity.Snapshots.Logistics.RegionalManagement | null;
150
- };
151
- warehouses: {
152
- [ID: string]: Utils.Entity.Snapshots.Logistics.Warehouse | null;
153
- };
154
- product_categories: {
155
- [
156
- ID: string
157
- ]: Utils.Entity.Snapshots.Products.ProductCategory | null;
158
- };
159
- products: {
160
- [ID: string]: Products.Entity.Product | null;
161
- };
162
- product_snapshots: {
163
- [
164
- TrackingID: string
165
- ]: Utils.Entity.Snapshots.Products.ProductCategory | null;
166
- };
167
- parcels: {
168
- [ID: string]: Shipping.Entity.Parcel | null;
169
- };
125
+ article_types: {
126
+ [ID: string]: Content.Entity.ArticleType | null;
127
+ }
128
+ linked_articles: {
129
+ [ID: string]: Omit<Content.Entity.Article,
130
+ 'body' |
131
+ 'body_unformatted' |
132
+ 'body_structured' |
133
+ 'attributes' |
134
+ 'snapshots' |
135
+ 'insights'
136
+ > | null;
137
+ }
170
138
 
171
- deposits: Payment.Entity.Deposit[];
172
- payments: Payment.Entity.Payment[];
173
139
  };
174
140
 
175
141
  type BuildResponseEdge<K extends keyof TResponseEdge> = Pick<
@@ -28,6 +28,7 @@ declare module Levelup {
28
28
 
29
29
  type SocialNetworks =
30
30
  | "facebook"
31
+ | "pinterest"
31
32
  | "youtube"
32
33
  | "linkedin"
33
34
  | "instagram"
@@ -46,6 +47,10 @@ declare module Levelup {
46
47
  | "thursday"
47
48
  | "friday"
48
49
  | "saturday";
50
+
51
+ export type SingleValue<Option> = Option | null;
52
+ export type MultiValue<Option> = Option[];
53
+
49
54
  }
50
55
  }
51
56
  }
@@ -21,40 +21,29 @@ declare module Levelup {
21
21
  /* ----------------------- COMMON LOCATIONS INTERFACES ---------------------- */
22
22
  export namespace Locations {
23
23
  interface Address {
24
- country_id: string;
25
24
  country_code: string;
26
25
  country_name: string;
27
- state_id: string;
28
26
  state_code: string;
29
27
  state_name: string;
30
- state_zone?: number;
31
- city_id: string;
32
28
  city_code: string;
33
29
  city_name: string;
34
- city_zone?: number;
35
30
  street_address?: string;
36
31
  }
37
32
  interface City {
38
- _id: string;
39
33
  code: string;
40
34
  name: string;
41
- country_id: string;
42
- state_id: string;
43
35
  country_code: string;
44
36
  state_code: string;
45
37
  country_name: string;
46
38
  state_name: string;
47
39
  }
48
40
  interface State {
49
- _id: string;
50
41
  code: string;
51
42
  name: string;
52
- country_id: string;
53
43
  country_code: string;
54
44
  country_name: string;
55
45
  }
56
46
  interface Country {
57
- _id: string;
58
47
  code: string;
59
48
  name: string;
60
49
  }
@@ -23,10 +23,12 @@ declare module Levelup {
23
23
  | "article"
24
24
  | "articleType";
25
25
  export type SystemModels = "app";
26
+ export type StorageModels = "uploadedFile";
26
27
 
27
28
  export type AllModels =
28
29
  | AuthModels
29
30
  | CmModels
31
+ | StorageModels
30
32
  | SystemModels;
31
33
 
32
34
  /**
@@ -36,41 +38,41 @@ declare module Levelup {
36
38
  export type EntityType<E extends AllModels> =
37
39
  // auth
38
40
  E extends "user"
39
- ? Levelup.V2.Users.Entity.ExposedUser &
41
+ ? Levelup.CMS.V1.Users.Entity.ExposedUser &
40
42
  Record<"password" | "confirm_password", string>
41
43
  : E extends "permission"
42
- ? Levelup.V2.Auth.Entity.Permission
44
+ ? Levelup.CMS.V1.Auth.Entity.Permission
43
45
  : E extends "permissionGroup"
44
- ? Levelup.V2.Auth.Entity.PermissionGroup
46
+ ? Levelup.CMS.V1.Auth.Entity.PermissionGroup
45
47
  : E extends "role"
46
- ? Levelup.V2.Auth.Entity.Role
48
+ ? Levelup.CMS.V1.Auth.Entity.Role
47
49
  : E extends "apiKey"
48
- ? Levelup.V2.Auth.Entity.ApiKey
50
+ ? Levelup.CMS.V1.Auth.Entity.ApiKey
49
51
  : // cm
50
52
  E extends "article"
51
- ? Levelup.V2.Cm.Entity.Article
53
+ ? Levelup.CMS.V1.Content.Entity.Article
52
54
  : E extends "articleType"
53
- ? Levelup.V2.Cm.Entity.ArticleType
55
+ ? Levelup.CMS.V1.Content.Entity.ArticleType
54
56
  : E extends "review"
55
- ? Levelup.V2.Cm.Entity.Review
57
+ ? Levelup.CMS.V1.Content.Entity.Review
56
58
  : E extends "comment"
57
- ? Levelup.V2.Cm.Entity.Comment
59
+ ? Levelup.CMS.V1.Content.Entity.Comment
58
60
  : E extends "term"
59
- ? Levelup.V2.Cm.Entity.Term
61
+ ? Levelup.CMS.V1.Content.Entity.Term
60
62
  : E extends "taxonomy"
61
- ? Levelup.V2.Cm.Entity.Taxonomy
63
+ ? Levelup.CMS.V1.Content.Entity.Taxonomy
62
64
  : E extends "translationItem"
63
- ? Levelup.V2.Cm.Translation.Entity.Item
65
+ ? Levelup.CMS.V1.Content.Translation.Entity.Item
64
66
  : E extends "translationProject"
65
- ? Levelup.V2.Cm.Translation.Entity.Project
67
+ ? Levelup.CMS.V1.Content.Translation.Entity.Project
66
68
  : E extends "translationNamespace"
67
- ? Levelup.V2.Cm.Translation.Entity.Namespace
69
+ ? Levelup.CMS.V1.Content.Translation.Entity.Namespace
68
70
  : // Storage
69
71
  E extends "uploadedFile"
70
- ? Levelup.V2.Storage.Entity.UploadedFile
72
+ ? Levelup.CMS.V1.Storage.Entity.UploadedFile
71
73
  : // system
72
74
  E extends "app"
73
- ? Levelup.V2.System.Entity.App
75
+ ? Levelup.CMS.V1.System.Entity.App
74
76
  : never;
75
77
  }
76
78
  }
@@ -56,6 +56,9 @@ declare module Levelup {
56
56
  export type DocumentProperties<T> = T extends object & {
57
57
  push?: never;
58
58
  unshift?: never;
59
+ getUTCDate?: never;
60
+ getUTCFullYear?: never;
61
+ getUTCHours?: never;
59
62
  }
60
63
  ? {
61
64
  [K in keyof T]-?: K extends string | number