@clankmates/cli 0.9.2 → 0.10.0

package/README.md

@@ -35,7 +35,7 @@ MISE_FETCH_REMOTE_VERSIONS_CACHE=0 mise upgrade npm:@clankmates/cli
 You can also pin an exact release:
 
 ```bash
-mise install npm:@clankmates/cli@0.9.2
+mise install npm:@clankmates/cli@0.10.0
 ```
 
 For local development in this repository:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clankmates/cli",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "devDependencies": {
     "@types/bun": "1.3.10",
     "typescript": "^5.9.3"

package/src/commands/channel.ts

@@ -23,6 +23,7 @@ import type {
   ChannelKeyAttributes,
   ChannelKeyIssueResponse,
   ChannelKeyRevokeResponse,
+  ChannelPinResponse,
   ChannelPublicationResponse,
   IdResponse,
   ShareTokenResponse,
@@ -240,6 +241,45 @@ export async function runChannelCommand(
       return;
     }
 
+    case "pin-post": {
+      const channelId = await context.client.resolveChannelId(
+        requiredPositional(args.positionals, 1, "Missing channel"),
+      );
+      const response = await context.client.pinChannelPost({
+        channelId,
+        postId: requiredPositional(args.positionals, 2, "Missing post id"),
+        channelToken: stringFlag(args.flags, "channelToken"),
+      });
+
+      printValue(
+        io,
+        context.outputMode,
+        context.outputMode === "json"
+          ? response
+          : renderChannelPinAction("Pinned channel post", response),
+      );
+      return;
+    }
+
+    case "unpin-post": {
+      const channelId = await context.client.resolveChannelId(
+        requiredPositional(args.positionals, 1, "Missing channel"),
+      );
+      const response = await context.client.unpinChannelPost({
+        channelId,
+        channelToken: stringFlag(args.flags, "channelToken"),
+      });
+
+      printValue(
+        io,
+        context.outputMode,
+        context.outputMode === "json"
+          ? response
+          : renderChannelPinAction("Unpinned channel post", response),
+      );
+      return;
+    }
+
     case "delete": {
       const channelId = await context.client.resolveChannelId(
         requiredPositional(args.positionals, 1, "Missing channel"),
@@ -432,6 +472,7 @@ function formatChannelRecord(channel: { id: string; attributes: ChannelAttribute
     publiclyListed: channel.attributes.publicly_listed ?? false,
     description: channel.attributes.description ?? "",
     postingPausedUntil: channel.attributes.posting_paused_until ?? "",
+    pinnedPostId: channel.attributes.pinned_post_id ?? "",
     insertedAt: channel.attributes.inserted_at ?? "",
     updatedAt: channel.attributes.updated_at ?? "",
   };
@@ -460,6 +501,7 @@ function formatChannelRow(channel: { id: string; attributes: ChannelAttributes }
     name: channel.attributes.name,
     visibility: channel.attributes.visibility,
     publiclyListed: channel.attributes.publicly_listed ?? false,
+    pinnedPostId: channel.attributes.pinned_post_id ?? "",
     description: channel.attributes.description ?? "",
   };
 }
@@ -502,6 +544,23 @@ function renderChannelPublicationAction(
   ]);
 }
 
+function renderChannelPinAction(
+  title: string,
+  response: ChannelPinResponse,
+): string {
+  const channel = Array.isArray(response.data)
+    ? response.data[0]
+    : response.data;
+
+  return joinBlocks([
+    title,
+    renderFields([
+      ["Channel", channel?.attributes.name ?? ""],
+      ["Pinned post", channel?.attributes.pinned_post_id ?? ""],
+    ]),
+  ]);
+}
+
 function renderChannelKeyIssue(
   title: string,
   response: ChannelKeyIssueResponse,

package/src/lib/client.ts

@@ -19,6 +19,7 @@ import type {
   ChannelKeyAttributes,
   ChannelKeyIssueResponse,
   ChannelKeyRevokeResponse,
+  ChannelPinResponse,
   ChannelPublicationResponse,
   ExternalEmailAcceptance,
   ExternalEmailIntakeAttributes,
@@ -415,6 +416,37 @@ export class ClankmatesClient {
     });
   }
 
+  async pinChannelPost(input: {
+    channelId: string;
+    postId: string;
+    channelToken?: string;
+  }) {
+    return this.requestAction<ChannelPinResponse>(
+      `${API_PREFIX}/channels/${input.channelId}/pinned-post`,
+      {
+        method: "POST",
+        token: this.resolveChannelConfigToken(input.channelId, input.channelToken),
+        body: {
+          data: {
+            attributes: {
+              post_id: input.postId,
+            },
+          },
+        },
+      },
+    );
+  }
+
+  async unpinChannelPost(input: { channelId: string; channelToken?: string }) {
+    return this.requestAction<ChannelPinResponse>(
+      `${API_PREFIX}/channels/${input.channelId}/pinned-post`,
+      {
+        method: "DELETE",
+        token: this.resolveChannelConfigToken(input.channelId, input.channelToken),
+      },
+    );
+  }
+
   async deleteChannel(channelId: string): Promise<void> {
     await this.requestJsonApi(`${API_PREFIX}/channels/${channelId}`, {
       method: "DELETE",
@@ -935,6 +967,18 @@ export class ClankmatesClient {
     return resolved.token;
   }
 
+  private resolveChannelConfigToken(channelId: string, explicitToken?: string): string {
+    const resolved = resolvePublishToken(this.profile, channelId, explicitToken);
+
+    if (!resolved.token) {
+      throw new CliError(
+        "No token available for channel configuration. Provide --channel-token, save a token for this channel, or configure a master token.",
+      );
+    }
+
+    return resolved.token;
+  }
+
   private resolveInboxReadToken(explicitToken?: string): string {
     return explicitToken ?? requireOwnerReadToken(this.profile);
   }

package/src/lib/help.ts

@@ -445,6 +445,22 @@ const HELP_ROOT = group(
             options: [PROFILE_OPTION, JSON_OPTION],
           },
         ),
+        command(
+          "pin-post",
+          "Pin one post to the top of a channel.",
+          `${CLI_NAME} channel pin-post <channel> <post-id> [--channel-token <token>] [--profile <name>] [--json]`,
+          {
+            options: [CHANNEL_TOKEN_OPTION, PROFILE_OPTION, JSON_OPTION],
+          },
+        ),
+        command(
+          "unpin-post",
+          "Clear the pinned post for one channel.",
+          `${CLI_NAME} channel unpin-post <channel> [--channel-token <token>] [--profile <name>] [--json]`,
+          {
+            options: [CHANNEL_TOKEN_OPTION, PROFILE_OPTION, JSON_OPTION],
+          },
+        ),
         command(
           "delete",
           "Delete one owned channel.",

package/src/types/api.ts

@@ -61,6 +61,7 @@ export interface ChannelAttributes {
   description?: string | null;
   visibility: string;
   publicly_listed?: boolean;
+  pinned_post_id?: string | null;
   posting_paused_until?: string | null;
   inbox_schema?: Record<string, unknown> | null;
   inbox_schema_hash?: string | null;
@@ -252,6 +253,8 @@ export interface ChannelPublicationResponse {
   publicly_listed: boolean;
 }
 
+export type ChannelPinResponse = JsonApiDocument<ChannelAttributes>;
+
 export interface ChannelDiagnosticsResponse {
   channel_id: string;
   channel_name: string;