@doist/comms-sdk 0.4.4 → 0.4.6

package/dist/cjs/clients/comments-client.js

@@ -23,10 +23,6 @@ class CommentsClient extends base_client_1.BaseClient {
         this.commentListSchema = this.linkBaseUrl
             ? zod_1.z.array(this.commentSchema)
             : exports.CommentListSchema;
-        // `getone` wraps the comment in `{ comment: ... }`; built once per client.
-        this.wrappedCommentSchema = zod_1.z
-            .object({ comment: this.commentSchema })
-            .transform((data) => data.comment);
     }
     /**
      * Gets all comments for a thread. `newerThan` / `olderThan` (`Date`) are
@@ -67,7 +63,8 @@ class CommentsClient extends base_client_1.BaseClient {
         }).then((response) => this.commentListSchema.parse(response.data));
     }
     /**
-     * Gets a single comment object by id. The API wraps it in `{comment: ...}`.
+     * Gets a single comment object by id. The `getone` endpoint returns the
+     * comment object directly (the same shape as `add`), not wrapped.
      *
      * @param id - The comment ID.
      * @returns The comment object.
@@ -80,7 +77,7 @@ class CommentsClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: { id },
             customFetch: this.customFetch,
-        }).then((response) => this.wrappedCommentSchema.parse(response.data));
+        }).then((response) => this.commentSchema.parse(response.data));
     }
     /**
      * Creates a new comment on a thread. `id` is auto-generated if not supplied.

package/dist/cjs/testUtils/test-defaults.js

@@ -35,7 +35,7 @@ exports.mockChannel = {
     archived: false,
     created: new Date('2021-01-01T00:00:00Z'),
     version: 0,
-    url: `https://comms.todoist.com/a/1/ch/${exports.TEST_CHANNEL_ID}/`,
+    url: `https://comms.todoist.com/1/ch/${exports.TEST_CHANNEL_ID}/`,
 };
 exports.mockThread = {
     id: exports.TEST_THREAD_ID,
@@ -51,7 +51,7 @@ exports.mockThread = {
     snippet: 'This is a test thread',
     snippetCreator: 1,
     isArchived: false,
-    url: `https://comms.todoist.com/a/1/ch/${exports.TEST_CHANNEL_ID}/t/${exports.TEST_THREAD_ID}/`,
+    url: `https://comms.todoist.com/1/ch/${exports.TEST_CHANNEL_ID}/t/${exports.TEST_THREAD_ID}/`,
 };
 exports.mockGroup = {
     id: exports.TEST_GROUP_ID,
@@ -72,7 +72,7 @@ exports.mockConversation = {
     archived: false,
     created: new Date('2021-01-01T00:00:00Z'),
     creator: 1,
-    url: `https://comms.todoist.com/a/1/msg/${exports.TEST_CONVERSATION_ID}/`,
+    url: `https://comms.todoist.com/1/msg/${exports.TEST_CONVERSATION_ID}/`,
 };
 exports.mockComment = {
     id: exports.TEST_COMMENT_ID,
@@ -82,7 +82,7 @@ exports.mockComment = {
     workspaceId: 1,
     channelId: exports.TEST_CHANNEL_ID,
     posted: new Date('2021-01-01T00:00:00Z'),
-    url: `https://comms.todoist.com/a/1/ch/${exports.TEST_CHANNEL_ID}/t/${exports.TEST_THREAD_ID}/c/${exports.TEST_COMMENT_ID}`,
+    url: `https://comms.todoist.com/1/ch/${exports.TEST_CHANNEL_ID}/t/${exports.TEST_THREAD_ID}/c/${exports.TEST_COMMENT_ID}`,
 };
 exports.mockWorkspaceUser = {
     id: 1,

package/dist/cjs/utils/url-helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * Helper functions for creating Comms permalinks (`https://comms.todoist.com/a/...`).
+ * Helper functions for creating Comms permalinks (`https://comms.todoist.com/...`).
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCommsURL = getCommsURL;
@@ -27,11 +27,11 @@ const COMMS_BASE_URL = 'https://comms.todoist.com';
  * @returns A relative URL path
  * @example
  * getCommsURL({ workspaceId: 1, channelId: '7Yp...', threadId: '7Yq...' })
- * // returns '/a/1/ch/7Yp.../t/7Yq.../'
+ * // returns '/1/ch/7Yp.../t/7Yq.../'
  */
 function getCommsURL(params) {
     const { workspaceId, channelId, conversationId, threadId, commentId, messageId, userId } = params;
-    let url = `/a/${workspaceId}/`;
+    let url = `/${workspaceId}/`;
     if (channelId) {
         url += `ch/${channelId}/`;
         if (threadId) {
@@ -90,44 +90,44 @@ function getCommentURL(params) {
 }
 /** Returns the URL for the threads root (channels view). */
 function getThreadsRootURL(workspaceId) {
-    return `/a/${workspaceId}/ch`;
+    return `/${workspaceId}/ch`;
 }
 /** Returns the URL for the inbox. */
 function getInboxURL(workspaceId, tab) {
     const tabParam = tab ? `/${tab}` : '';
-    return `/a/${workspaceId}/inbox${tabParam}`;
+    return `/${workspaceId}/inbox${tabParam}`;
 }
 /** Returns the URL for the messages/conversations root. */
 function getMessagesRootURL(workspaceId) {
-    return `/a/${workspaceId}/msg`;
+    return `/${workspaceId}/msg`;
 }
 /** Returns the URL for a user profile. */
 function getUserProfileURL(params) {
-    return `/a/${params.workspaceId}/people/u/${params.userId}`;
+    return `/${params.workspaceId}/people/u/${params.userId}`;
 }
 /** Returns the URL for the saved threads view. */
 function getSavedThreadsRootURL(workspaceId) {
-    return `/a/${workspaceId}/saved`;
+    return `/${workspaceId}/saved`;
 }
 /** Returns the URL for a saved thread. */
 function getSavedThreadURL(params) {
-    return `/a/${params.workspaceId}/saved/t/${params.threadId}`;
+    return `/${params.workspaceId}/saved/t/${params.threadId}`;
 }
 /** Returns the URL for the search root. */
 function getSearchRootURL(workspaceId) {
-    return `/a/${workspaceId}/search`;
+    return `/${workspaceId}/search`;
 }
 /** Returns the URL for a search with a query. */
 function getSearchQueryURL(params) {
-    return `/a/${params.workspaceId}/search?q=${decodeURIComponent(params.query)}`;
+    return `/${params.workspaceId}/search?q=${decodeURIComponent(params.query)}`;
 }
 /** Returns the URL for settings. */
 function getSettingsURL(params) {
     return params.initialLocation
-        ? `/a/${params.workspaceId}/settings/${params.initialLocation}`
-        : `/a/${params.workspaceId}/settings`;
+        ? `/${params.workspaceId}/settings/${params.initialLocation}`
+        : `/${params.workspaceId}/settings`;
 }
 /** Returns the URL for the team members root. */
 function getTeamMembersRootURL(workspaceId) {
-    return `/a/${workspaceId}/people/u`;
+    return `/${workspaceId}/people/u`;
 }

package/dist/esm/clients/comments-client.js

@@ -20,10 +20,6 @@ export class CommentsClient extends BaseClient {
         this.commentListSchema = this.linkBaseUrl
             ? z.array(this.commentSchema)
             : CommentListSchema;
-        // `getone` wraps the comment in `{ comment: ... }`; built once per client.
-        this.wrappedCommentSchema = z
-            .object({ comment: this.commentSchema })
-            .transform((data) => data.comment);
     }
     /**
      * Gets all comments for a thread. `newerThan` / `olderThan` (`Date`) are
@@ -64,7 +60,8 @@ export class CommentsClient extends BaseClient {
         }).then((response) => this.commentListSchema.parse(response.data));
     }
     /**
-     * Gets a single comment object by id. The API wraps it in `{comment: ...}`.
+     * Gets a single comment object by id. The `getone` endpoint returns the
+     * comment object directly (the same shape as `add`), not wrapped.
      *
      * @param id - The comment ID.
      * @returns The comment object.
@@ -77,7 +74,7 @@ export class CommentsClient extends BaseClient {
             apiToken: this.apiToken,
             payload: { id },
             customFetch: this.customFetch,
-        }).then((response) => this.wrappedCommentSchema.parse(response.data));
+        }).then((response) => this.commentSchema.parse(response.data));
     }
     /**
      * Creates a new comment on a thread. `id` is auto-generated if not supplied.

package/dist/esm/testUtils/test-defaults.js

@@ -32,7 +32,7 @@ export const mockChannel = {
     archived: false,
     created: new Date('2021-01-01T00:00:00Z'),
     version: 0,
-    url: `https://comms.todoist.com/a/1/ch/${TEST_CHANNEL_ID}/`,
+    url: `https://comms.todoist.com/1/ch/${TEST_CHANNEL_ID}/`,
 };
 export const mockThread = {
     id: TEST_THREAD_ID,
@@ -48,7 +48,7 @@ export const mockThread = {
     snippet: 'This is a test thread',
     snippetCreator: 1,
     isArchived: false,
-    url: `https://comms.todoist.com/a/1/ch/${TEST_CHANNEL_ID}/t/${TEST_THREAD_ID}/`,
+    url: `https://comms.todoist.com/1/ch/${TEST_CHANNEL_ID}/t/${TEST_THREAD_ID}/`,
 };
 export const mockGroup = {
     id: TEST_GROUP_ID,
@@ -69,7 +69,7 @@ export const mockConversation = {
     archived: false,
     created: new Date('2021-01-01T00:00:00Z'),
     creator: 1,
-    url: `https://comms.todoist.com/a/1/msg/${TEST_CONVERSATION_ID}/`,
+    url: `https://comms.todoist.com/1/msg/${TEST_CONVERSATION_ID}/`,
 };
 export const mockComment = {
     id: TEST_COMMENT_ID,
@@ -79,7 +79,7 @@ export const mockComment = {
     workspaceId: 1,
     channelId: TEST_CHANNEL_ID,
     posted: new Date('2021-01-01T00:00:00Z'),
-    url: `https://comms.todoist.com/a/1/ch/${TEST_CHANNEL_ID}/t/${TEST_THREAD_ID}/c/${TEST_COMMENT_ID}`,
+    url: `https://comms.todoist.com/1/ch/${TEST_CHANNEL_ID}/t/${TEST_THREAD_ID}/c/${TEST_COMMENT_ID}`,
 };
 export const mockWorkspaceUser = {
     id: 1,

package/dist/esm/utils/url-helpers.js

@@ -1,5 +1,5 @@
 /**
- * Helper functions for creating Comms permalinks (`https://comms.todoist.com/a/...`).
+ * Helper functions for creating Comms permalinks (`https://comms.todoist.com/...`).
  */
 const COMMS_BASE_URL = 'https://comms.todoist.com';
 /**
@@ -8,11 +8,11 @@ const COMMS_BASE_URL = 'https://comms.todoist.com';
  * @returns A relative URL path
  * @example
  * getCommsURL({ workspaceId: 1, channelId: '7Yp...', threadId: '7Yq...' })
- * // returns '/a/1/ch/7Yp.../t/7Yq.../'
+ * // returns '/1/ch/7Yp.../t/7Yq.../'
  */
 export function getCommsURL(params) {
     const { workspaceId, channelId, conversationId, threadId, commentId, messageId, userId } = params;
-    let url = `/a/${workspaceId}/`;
+    let url = `/${workspaceId}/`;
     if (channelId) {
         url += `ch/${channelId}/`;
         if (threadId) {
@@ -71,44 +71,44 @@ export function getCommentURL(params) {
 }
 /** Returns the URL for the threads root (channels view). */
 export function getThreadsRootURL(workspaceId) {
-    return `/a/${workspaceId}/ch`;
+    return `/${workspaceId}/ch`;
 }
 /** Returns the URL for the inbox. */
 export function getInboxURL(workspaceId, tab) {
     const tabParam = tab ? `/${tab}` : '';
-    return `/a/${workspaceId}/inbox${tabParam}`;
+    return `/${workspaceId}/inbox${tabParam}`;
 }
 /** Returns the URL for the messages/conversations root. */
 export function getMessagesRootURL(workspaceId) {
-    return `/a/${workspaceId}/msg`;
+    return `/${workspaceId}/msg`;
 }
 /** Returns the URL for a user profile. */
 export function getUserProfileURL(params) {
-    return `/a/${params.workspaceId}/people/u/${params.userId}`;
+    return `/${params.workspaceId}/people/u/${params.userId}`;
 }
 /** Returns the URL for the saved threads view. */
 export function getSavedThreadsRootURL(workspaceId) {
-    return `/a/${workspaceId}/saved`;
+    return `/${workspaceId}/saved`;
 }
 /** Returns the URL for a saved thread. */
 export function getSavedThreadURL(params) {
-    return `/a/${params.workspaceId}/saved/t/${params.threadId}`;
+    return `/${params.workspaceId}/saved/t/${params.threadId}`;
 }
 /** Returns the URL for the search root. */
 export function getSearchRootURL(workspaceId) {
-    return `/a/${workspaceId}/search`;
+    return `/${workspaceId}/search`;
 }
 /** Returns the URL for a search with a query. */
 export function getSearchQueryURL(params) {
-    return `/a/${params.workspaceId}/search?q=${decodeURIComponent(params.query)}`;
+    return `/${params.workspaceId}/search?q=${decodeURIComponent(params.query)}`;
 }
 /** Returns the URL for settings. */
 export function getSettingsURL(params) {
     return params.initialLocation
-        ? `/a/${params.workspaceId}/settings/${params.initialLocation}`
-        : `/a/${params.workspaceId}/settings`;
+        ? `/${params.workspaceId}/settings/${params.initialLocation}`
+        : `/${params.workspaceId}/settings`;
 }
 /** Returns the URL for the team members root. */
 export function getTeamMembersRootURL(workspaceId) {
-    return `/a/${workspaceId}/people/u`;
+    return `/${workspaceId}/people/u`;
 }

package/dist/types/clients/comments-client.d.ts

@@ -137,7 +137,6 @@ export declare class CommentsClient extends BaseClient {
     private readonly linkBaseUrl;
     private readonly commentSchema;
     private readonly commentListSchema;
-    private readonly wrappedCommentSchema;
     /**
      * Gets all comments for a thread. `newerThan` / `olderThan` (`Date`) are
      * converted to `newer_than_ts` / `older_than_ts` epoch seconds on the
@@ -161,7 +160,8 @@ export declare class CommentsClient extends BaseClient {
      */
     getComments(args: GetCommentsArgs): Promise<Comment[]>;
     /**
-     * Gets a single comment object by id. The API wraps it in `{comment: ...}`.
+     * Gets a single comment object by id. The `getone` endpoint returns the
+     * comment object directly (the same shape as `add`), not wrapped.
      *
      * @param id - The comment ID.
      * @returns The comment object.

package/dist/types/utils/url-helpers.d.ts

@@ -1,5 +1,5 @@
 /**
- * Helper functions for creating Comms permalinks (`https://comms.todoist.com/a/...`).
+ * Helper functions for creating Comms permalinks (`https://comms.todoist.com/...`).
  */
 export type CommsURLParams = {
     workspaceId: number;
@@ -16,7 +16,7 @@ export type CommsURLParams = {
  * @returns A relative URL path
  * @example
  * getCommsURL({ workspaceId: 1, channelId: '7Yp...', threadId: '7Yq...' })
- * // returns '/a/1/ch/7Yp.../t/7Yq.../'
+ * // returns '/1/ch/7Yp.../t/7Yq.../'
  */
 export declare function getCommsURL(params: CommsURLParams): string;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/comms-sdk",
-    "version": "0.4.4",
+    "version": "0.4.6",
     "description": "A TypeScript wrapper for the Comms REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/comms-sdk-typescript/",