@doist/todoist-sdk 10.1.3 → 10.2.0-next.2

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 (42) hide show
  1. package/dist/cjs/clients/goals-client.js +145 -0
  2. package/dist/cjs/consts/endpoints.js +6 -1
  3. package/dist/cjs/test-utils/test-defaults.js +26 -2
  4. package/dist/cjs/todoist-api.js +33 -0
  5. package/dist/cjs/types/goals/index.js +18 -0
  6. package/dist/cjs/types/goals/requests.js +2 -0
  7. package/dist/cjs/types/goals/types.js +56 -0
  8. package/dist/cjs/types/index.js +1 -0
  9. package/dist/cjs/types/sync/commands/goals.js +2 -0
  10. package/dist/cjs/types/sync/commands/index.js +1 -0
  11. package/dist/cjs/types/sync/resource-types.js +1 -0
  12. package/dist/cjs/types/sync/response.js +12 -10
  13. package/dist/cjs/utils/validators.js +53 -51
  14. package/dist/esm/clients/goals-client.js +141 -0
  15. package/dist/esm/consts/endpoints.js +5 -0
  16. package/dist/esm/test-utils/test-defaults.js +24 -0
  17. package/dist/esm/todoist-api.js +33 -0
  18. package/dist/esm/types/goals/index.js +2 -0
  19. package/dist/esm/types/goals/requests.js +1 -0
  20. package/dist/esm/types/goals/types.js +53 -0
  21. package/dist/esm/types/index.js +1 -0
  22. package/dist/esm/types/sync/commands/goals.js +1 -0
  23. package/dist/esm/types/sync/commands/index.js +1 -0
  24. package/dist/esm/types/sync/resource-types.js +1 -0
  25. package/dist/esm/types/sync/response.js +2 -0
  26. package/dist/esm/utils/validators.js +2 -0
  27. package/dist/types/clients/goals-client.d.ts +20 -0
  28. package/dist/types/consts/endpoints.d.ts +5 -0
  29. package/dist/types/test-utils/test-defaults.d.ts +4 -1
  30. package/dist/types/todoist-api.d.ts +12 -0
  31. package/dist/types/types/goals/index.d.ts +2 -0
  32. package/dist/types/types/goals/requests.d.ts +33 -0
  33. package/dist/types/types/goals/types.d.ts +51 -0
  34. package/dist/types/types/index.d.ts +1 -0
  35. package/dist/types/types/sync/commands/goals.d.ts +33 -0
  36. package/dist/types/types/sync/commands/index.d.ts +9 -0
  37. package/dist/types/types/sync/resource-types.d.ts +1 -1
  38. package/dist/types/types/sync/resources/view-options.d.ts +6 -6
  39. package/dist/types/types/sync/response.d.ts +29 -4
  40. package/dist/types/types/tasks/requests.d.ts +1 -0
  41. package/dist/types/utils/validators.d.ts +55 -8
  42. package/package.json +1 -1
package/dist/types/types/sync/resources/view-options.d.ts CHANGED
@@ -32,6 +32,7 @@ export declare const GROUPED_BY_OPTIONS: readonly ["ASSIGNEE", "ADDED_DATE", "DU
32
32
  /** Field to group tasks by. */
33
33
  export type GroupedBy = (typeof GROUPED_BY_OPTIONS)[number];
34
34
  export declare const GroupedBySchema: z.ZodNullable<z.ZodEnum<{
35
+ WORKSPACE: "WORKSPACE";
35
36
  PROJECT: "PROJECT";
36
37
  LABEL: "LABEL";
37
38
  ASSIGNEE: "ASSIGNEE";
@@ -39,20 +40,19 @@ export declare const GroupedBySchema: z.ZodNullable<z.ZodEnum<{
39
40
  DUE_DATE: "DUE_DATE";
40
41
  DEADLINE: "DEADLINE";
41
42
  PRIORITY: "PRIORITY";
42
- WORKSPACE: "WORKSPACE";
43
43
  }>>;
44
44
  /** Available sorting options. */
45
45
  export declare const SORTED_BY_OPTIONS: readonly ["MANUAL", "ALPHABETICALLY", "ASSIGNEE", "DUE_DATE", "DEADLINE", "ADDED_DATE", "PRIORITY", "PROJECT", "WORKSPACE"];
46
46
  /** Field to sort tasks by. */
47
47
  export type SortedBy = (typeof SORTED_BY_OPTIONS)[number];
48
48
  export declare const SortedBySchema: z.ZodNullable<z.ZodEnum<{
49
+ WORKSPACE: "WORKSPACE";
49
50
  PROJECT: "PROJECT";
50
51
  ASSIGNEE: "ASSIGNEE";
51
52
  ADDED_DATE: "ADDED_DATE";
52
53
  DUE_DATE: "DUE_DATE";
53
54
  DEADLINE: "DEADLINE";
54
55
  PRIORITY: "PRIORITY";
55
- WORKSPACE: "WORKSPACE";
56
56
  MANUAL: "MANUAL";
57
57
  ALPHABETICALLY: "ALPHABETICALLY";
58
58
  }>>;
@@ -92,6 +92,7 @@ export declare const ViewOptionsSchema: z.ZodObject<{
92
92
  }>;
93
93
  objectId: z.ZodOptional<z.ZodString>;
94
94
  groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
95
+ WORKSPACE: "WORKSPACE";
95
96
  PROJECT: "PROJECT";
96
97
  LABEL: "LABEL";
97
98
  ASSIGNEE: "ASSIGNEE";
@@ -99,7 +100,6 @@ export declare const ViewOptionsSchema: z.ZodObject<{
99
100
  DUE_DATE: "DUE_DATE";
100
101
  DEADLINE: "DEADLINE";
101
102
  PRIORITY: "PRIORITY";
102
- WORKSPACE: "WORKSPACE";
103
103
  }>>>;
104
104
  filteredBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
105
105
  viewMode: z.ZodOptional<z.ZodEnum<{
@@ -109,13 +109,13 @@ export declare const ViewOptionsSchema: z.ZodObject<{
109
109
  }>>;
110
110
  showCompletedTasks: z.ZodOptional<z.ZodBoolean>;
111
111
  sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
112
+ WORKSPACE: "WORKSPACE";
112
113
  PROJECT: "PROJECT";
113
114
  ASSIGNEE: "ASSIGNEE";
114
115
  ADDED_DATE: "ADDED_DATE";
115
116
  DUE_DATE: "DUE_DATE";
116
117
  DEADLINE: "DEADLINE";
117
118
  PRIORITY: "PRIORITY";
118
- WORKSPACE: "WORKSPACE";
119
119
  MANUAL: "MANUAL";
120
120
  ALPHABETICALLY: "ALPHABETICALLY";
121
121
  }>>>;
@@ -133,6 +133,7 @@ export declare const ProjectViewOptionsDefaultsSchema: z.ZodObject<{
133
133
  CALENDAR: "CALENDAR";
134
134
  }>>>;
135
135
  groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
136
+ WORKSPACE: "WORKSPACE";
136
137
  PROJECT: "PROJECT";
137
138
  LABEL: "LABEL";
138
139
  ASSIGNEE: "ASSIGNEE";
@@ -140,16 +141,15 @@ export declare const ProjectViewOptionsDefaultsSchema: z.ZodObject<{
140
141
  DUE_DATE: "DUE_DATE";
141
142
  DEADLINE: "DEADLINE";
142
143
  PRIORITY: "PRIORITY";
143
- WORKSPACE: "WORKSPACE";
144
144
  }>>>;
145
145
  sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
146
+ WORKSPACE: "WORKSPACE";
146
147
  PROJECT: "PROJECT";
147
148
  ASSIGNEE: "ASSIGNEE";
148
149
  ADDED_DATE: "ADDED_DATE";
149
150
  DUE_DATE: "DUE_DATE";
150
151
  DEADLINE: "DEADLINE";
151
152
  PRIORITY: "PRIORITY";
152
- WORKSPACE: "WORKSPACE";
153
153
  MANUAL: "MANUAL";
154
154
  ALPHABETICALLY: "ALPHABETICALLY";
155
155
  }>>>;
package/dist/types/types/sync/response.d.ts CHANGED
@@ -750,6 +750,7 @@ export declare const SyncResponseSchema: z.ZodObject<{
750
750
  }>;
751
751
  objectId: z.ZodOptional<z.ZodString>;
752
752
  groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
753
+ WORKSPACE: "WORKSPACE";
753
754
  PROJECT: "PROJECT";
754
755
  LABEL: "LABEL";
755
756
  ASSIGNEE: "ASSIGNEE";
@@ -757,7 +758,6 @@ export declare const SyncResponseSchema: z.ZodObject<{
757
758
  DUE_DATE: "DUE_DATE";
758
759
  DEADLINE: "DEADLINE";
759
760
  PRIORITY: "PRIORITY";
760
- WORKSPACE: "WORKSPACE";
761
761
  }>>>;
762
762
  filteredBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
763
763
  viewMode: z.ZodOptional<z.ZodEnum<{
@@ -767,13 +767,13 @@ export declare const SyncResponseSchema: z.ZodObject<{
767
767
  }>>;
768
768
  showCompletedTasks: z.ZodOptional<z.ZodBoolean>;
769
769
  sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
770
+ WORKSPACE: "WORKSPACE";
770
771
  PROJECT: "PROJECT";
771
772
  ASSIGNEE: "ASSIGNEE";
772
773
  ADDED_DATE: "ADDED_DATE";
773
774
  DUE_DATE: "DUE_DATE";
774
775
  DEADLINE: "DEADLINE";
775
776
  PRIORITY: "PRIORITY";
776
- WORKSPACE: "WORKSPACE";
777
777
  MANUAL: "MANUAL";
778
778
  ALPHABETICALLY: "ALPHABETICALLY";
779
779
  }>>>;
@@ -790,6 +790,7 @@ export declare const SyncResponseSchema: z.ZodObject<{
790
790
  CALENDAR: "CALENDAR";
791
791
  }>>>;
792
792
  groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
793
+ WORKSPACE: "WORKSPACE";
793
794
  PROJECT: "PROJECT";
794
795
  LABEL: "LABEL";
795
796
  ASSIGNEE: "ASSIGNEE";
@@ -797,16 +798,15 @@ export declare const SyncResponseSchema: z.ZodObject<{
797
798
  DUE_DATE: "DUE_DATE";
798
799
  DEADLINE: "DEADLINE";
799
800
  PRIORITY: "PRIORITY";
800
- WORKSPACE: "WORKSPACE";
801
801
  }>>>;
802
802
  sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
803
+ WORKSPACE: "WORKSPACE";
803
804
  PROJECT: "PROJECT";
804
805
  ASSIGNEE: "ASSIGNEE";
805
806
  ADDED_DATE: "ADDED_DATE";
806
807
  DUE_DATE: "DUE_DATE";
807
808
  DEADLINE: "DEADLINE";
808
809
  PRIORITY: "PRIORITY";
809
- WORKSPACE: "WORKSPACE";
810
810
  MANUAL: "MANUAL";
811
811
  ALPHABETICALLY: "ALPHABETICALLY";
812
812
  }>>>;
@@ -832,6 +832,31 @@ export declare const SyncResponseSchema: z.ZodObject<{
832
832
  defaultOrder: z.ZodNumber;
833
833
  childOrder: z.ZodNumber;
834
834
  }, z.core.$loose>>>;
835
+ goals: z.ZodOptional<z.ZodArray<z.ZodObject<{
836
+ id: z.ZodString;
837
+ ownerType: z.ZodEnum<{
838
+ USER: "USER";
839
+ WORKSPACE: "WORKSPACE";
840
+ }>;
841
+ ownerId: z.ZodString;
842
+ name: z.ZodString;
843
+ description: z.ZodNullable<z.ZodString>;
844
+ deadline: z.ZodNullable<z.ZodString>;
845
+ parentGoalId: z.ZodNullable<z.ZodString>;
846
+ childOrder: z.ZodNumber;
847
+ isCompleted: z.ZodBoolean;
848
+ completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
849
+ responsibleUid: z.ZodNullable<z.ZodString>;
850
+ isDeleted: z.ZodBoolean;
851
+ progress: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
852
+ totalTaskCount: z.ZodNumber;
853
+ completedTaskCount: z.ZodNumber;
854
+ percentage: z.ZodNumber;
855
+ }, z.core.$loose>>>;
856
+ creatorUid: z.ZodString;
857
+ createdAt: z.ZodCoercedDate<unknown>;
858
+ updatedAt: z.ZodCoercedDate<unknown>;
859
+ }, z.core.$loose>>>;
835
860
  workspaceGoals: z.ZodOptional<z.ZodArray<z.ZodObject<{
836
861
  id: z.ZodString;
837
862
  workspaceId: z.ZodString;
package/dist/types/types/tasks/requests.d.ts CHANGED
@@ -36,6 +36,7 @@ export type GetTasksArgs = {
36
36
  parentId?: string;
37
37
  label?: string;
38
38
  ids?: string[];
39
+ goalId?: string;
39
40
  cursor?: string | null;
40
41
  limit?: number;
41
42
  };
package/dist/types/utils/validators.d.ts CHANGED
@@ -818,6 +818,53 @@ export declare const validateFolder: (input: unknown) => {
818
818
  defaultOrder: number;
819
819
  childOrder: number;
820
820
  }[];
821
+ export declare const validateGoal: (input: unknown) => {
822
+ [x: string]: unknown;
823
+ id: string;
824
+ ownerType: "USER" | "WORKSPACE";
825
+ ownerId: string;
826
+ name: string;
827
+ description: string | null;
828
+ deadline: string | null;
829
+ parentGoalId: string | null;
830
+ childOrder: number;
831
+ isCompleted: boolean;
832
+ completedAt: Date | null;
833
+ responsibleUid: string | null;
834
+ isDeleted: boolean;
835
+ creatorUid: string;
836
+ createdAt: Date;
837
+ updatedAt: Date;
838
+ progress?: {
839
+ [x: string]: unknown;
840
+ totalTaskCount: number;
841
+ completedTaskCount: number;
842
+ percentage: number;
843
+ } | undefined;
844
+ }, validateGoalArray: (input: unknown) => {
845
+ [x: string]: unknown;
846
+ id: string;
847
+ ownerType: "USER" | "WORKSPACE";
848
+ ownerId: string;
849
+ name: string;
850
+ description: string | null;
851
+ deadline: string | null;
852
+ parentGoalId: string | null;
853
+ childOrder: number;
854
+ isCompleted: boolean;
855
+ completedAt: Date | null;
856
+ responsibleUid: string | null;
857
+ isDeleted: boolean;
858
+ creatorUid: string;
859
+ createdAt: Date;
860
+ updatedAt: Date;
861
+ progress?: {
862
+ [x: string]: unknown;
863
+ totalTaskCount: number;
864
+ completedTaskCount: number;
865
+ percentage: number;
866
+ } | undefined;
867
+ }[];
821
868
  export declare const validateNote: (input: unknown) => {
822
869
  [x: string]: unknown;
823
870
  id: string;
@@ -1139,29 +1186,29 @@ export declare const validateViewOptions: (input: unknown) => {
1139
1186
  [x: string]: unknown;
1140
1187
  viewType: "PROJECT" | "TODAY" | "UPCOMING" | "LABEL" | "FILTER" | "WORKSPACE_FILTER" | "SEARCH" | "TEMPLATE_PREVIEW" | "TASK_DETAIL" | "AUTOMATION" | "ASSIGNED" | "OVERDUE" | "WORKSPACE_OVERVIEW";
1141
1188
  objectId?: string | undefined;
1142
- groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
1189
+ groupedBy?: "WORKSPACE" | "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
1143
1190
  filteredBy?: string | null | undefined;
1144
1191
  viewMode?: "LIST" | "BOARD" | "CALENDAR" | undefined;
1145
1192
  showCompletedTasks?: boolean | undefined;
1146
- sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
1193
+ sortedBy?: "WORKSPACE" | "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
1147
1194
  sortOrder?: "ASC" | "DESC" | null | undefined;
1148
1195
  }, validateViewOptionsArray: (input: unknown) => {
1149
1196
  [x: string]: unknown;
1150
1197
  viewType: "PROJECT" | "TODAY" | "UPCOMING" | "LABEL" | "FILTER" | "WORKSPACE_FILTER" | "SEARCH" | "TEMPLATE_PREVIEW" | "TASK_DETAIL" | "AUTOMATION" | "ASSIGNED" | "OVERDUE" | "WORKSPACE_OVERVIEW";
1151
1198
  objectId?: string | undefined;
1152
- groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
1199
+ groupedBy?: "WORKSPACE" | "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
1153
1200
  filteredBy?: string | null | undefined;
1154
1201
  viewMode?: "LIST" | "BOARD" | "CALENDAR" | undefined;
1155
1202
  showCompletedTasks?: boolean | undefined;
1156
- sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
1203
+ sortedBy?: "WORKSPACE" | "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
1157
1204
  sortOrder?: "ASC" | "DESC" | null | undefined;
1158
1205
  }[];
1159
1206
  export declare const validateProjectViewOptionsDefaults: (input: unknown) => {
1160
1207
  [x: string]: unknown;
1161
1208
  projectId: string;
1162
1209
  viewMode?: "LIST" | "BOARD" | "CALENDAR" | null | undefined;
1163
- groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
1164
- sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
1210
+ groupedBy?: "WORKSPACE" | "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
1211
+ sortedBy?: "WORKSPACE" | "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
1165
1212
  sortOrder?: "ASC" | "DESC" | null | undefined;
1166
1213
  showCompletedTasks?: boolean | undefined;
1167
1214
  filteredBy?: string | null | undefined;
@@ -1173,8 +1220,8 @@ export declare const validateProjectViewOptionsDefaults: (input: unknown) => {
1173
1220
  [x: string]: unknown;
1174
1221
  projectId: string;
1175
1222
  viewMode?: "LIST" | "BOARD" | "CALENDAR" | null | undefined;
1176
- groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
1177
- sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
1223
+ groupedBy?: "WORKSPACE" | "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
1224
+ sortedBy?: "WORKSPACE" | "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
1178
1225
  sortOrder?: "ASC" | "DESC" | null | undefined;
1179
1226
  showCompletedTasks?: boolean | undefined;
1180
1227
  filteredBy?: string | null | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@doist/todoist-sdk",
3
- "version": "10.1.3",
3
+ "version": "10.2.0-next.2",
4
4
  "description": "The official TypeScript SDK for the Todoist REST API.",
5
5
  "author": "Doist developers",
6
6
  "repository": "https://github.com/Doist/todoist-sdk-typescript",