@doist/todoist-api-typescript 5.2.0 → 5.2.1

package/dist/testUtils/testDefaults.d.ts

@@ -80,6 +80,7 @@ export declare const PROJECT_WITH_OPTIONALS_AS_NULL: PersonalProject;
 export declare const DEFAULT_SECTION: Section;
 export declare const INVALID_SECTION: {
     projectId: undefined;
+    url: string;
     id: string;
     userId: string;
     addedAt: string;

package/dist/testUtils/testDefaults.js

@@ -46,6 +46,7 @@ var DEFAULT_IS_COLLAPSED = false;
 // URL constants using the helper functions
 var DEFAULT_TASK_URL = (0, urlHelpers_1.getTaskUrl)(exports.DEFAULT_TASK_ID, exports.DEFAULT_TASK_CONTENT);
 var DEFAULT_PROJECT_URL = (0, urlHelpers_1.getProjectUrl)(exports.DEFAULT_PROJECT_ID, exports.DEFAULT_PROJECT_NAME);
+var DEFAULT_SECTION_URL = (0, urlHelpers_1.getSectionUrl)(DEFAULT_SECTION_ID, DEFAULT_SECTION_NAME);
 exports.DEFAULT_AUTH_TOKEN = 'AToken';
 exports.DEFAULT_REQUEST_ID = 'ARequestID';
 exports.INVALID_ENTITY_ID = 1234;
@@ -154,6 +155,7 @@ exports.DEFAULT_SECTION = {
     isArchived: false,
     isDeleted: false,
     isCollapsed: false,
+    url: DEFAULT_SECTION_URL,
 };
 exports.INVALID_SECTION = __assign(__assign({}, exports.DEFAULT_SECTION), { projectId: undefined });
 exports.DEFAULT_LABEL = {

package/dist/types/entities.d.ts

@@ -331,7 +331,7 @@ export type WorkspaceProject = z.infer<typeof WorkspaceProjectSchema>;
  * @see https://todoist.com/api/v1/docs#tag/Projects
  */
 export type ProjectViewStyle = 'list' | 'board' | 'calendar';
-export declare const SectionSchema: z.ZodObject<{
+export declare const SectionSchema: z.ZodPipe<z.ZodObject<{
     id: z.ZodString;
     userId: z.ZodString;
     projectId: z.ZodString;
@@ -343,7 +343,32 @@ export declare const SectionSchema: z.ZodObject<{
     isArchived: z.ZodBoolean;
     isDeleted: z.ZodBoolean;
     isCollapsed: z.ZodBoolean;
-}, z.core.$strip>;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    userId: string;
+    projectId: string;
+    addedAt: string;
+    updatedAt: string;
+    archivedAt: string | null;
+    name: string;
+    sectionOrder: number;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+}, {
+    id: string;
+    userId: string;
+    projectId: string;
+    addedAt: string;
+    updatedAt: string;
+    archivedAt: string | null;
+    name: string;
+    sectionOrder: number;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+}>>;
 /**
  * Represents a section in a Todoist project.
  * @see https://todoist.com/api/v1/docs#tag/Sections

package/dist/types/entities.js

@@ -119,7 +119,8 @@ exports.WorkspaceProjectSchema = exports.BaseProjectSchema.extend({
 }).transform(function (data) {
     return __assign(__assign({}, data), { url: (0, urlHelpers_1.getProjectUrl)(data.id, data.name) });
 });
-exports.SectionSchema = zod_1.z.object({
+exports.SectionSchema = zod_1.z
+    .object({
     id: zod_1.z.string(),
     userId: zod_1.z.string(),
     projectId: zod_1.z.string(),
@@ -131,6 +132,9 @@ exports.SectionSchema = zod_1.z.object({
     isArchived: zod_1.z.boolean(),
     isDeleted: zod_1.z.boolean(),
     isCollapsed: zod_1.z.boolean(),
+})
+    .transform(function (data) {
+    return __assign(__assign({}, data), { url: (0, urlHelpers_1.getSectionUrl)(data.id, data.name) });
 });
 exports.LabelSchema = zod_1.z.object({
     id: zod_1.z.string(),

package/dist/utils/urlHelpers.d.ts

@@ -14,3 +14,11 @@ export declare function getTaskUrl(taskId: string, content?: string): string;
  * @returns The URL string for the project view.
  */
 export declare function getProjectUrl(projectId: string, name?: string): string;
+/**
+ * Generate the URL for a given section.
+ *
+ * @param sectionId The ID of the section.
+ * @param name The name of the section.
+ * @returns The URL string for the section view.
+ */
+export declare function getSectionUrl(sectionId: string, name?: string): string;

package/dist/utils/urlHelpers.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTaskUrl = getTaskUrl;
 exports.getProjectUrl = getProjectUrl;
+exports.getSectionUrl = getSectionUrl;
 var endpoints_1 = require("../consts/endpoints");
 /**
  * Generate the URL for a given task.
@@ -27,6 +28,18 @@ function getProjectUrl(projectId, name) {
     var path = slug ? "".concat(slug, "-").concat(projectId) : projectId;
     return "".concat(endpoints_1.TODOIST_WEB_URI, "/project/").concat(path);
 }
+/**
+ * Generate the URL for a given section.
+ *
+ * @param sectionId The ID of the section.
+ * @param name The name of the section.
+ * @returns The URL string for the section view.
+ */
+function getSectionUrl(sectionId, name) {
+    var slug = name ? slugify(name) : undefined;
+    var path = slug ? "".concat(slug, "-").concat(sectionId) : sectionId;
+    return "".concat(endpoints_1.TODOIST_WEB_URI, "/section/").concat(path);
+}
 /**
  * Slugify function borrowed from Django.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "5.2.0",
+    "version": "5.2.1",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "git@github.com:doist/todoist-api-typescript.git",