@karakeep/cli 0.27.1 → 0.29.1

package/dist/index.mjs

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
-import * as require$$3 from "node:fs";
-import require$$3__default from "node:fs";
 import process$1, { stdout, stdin } from "node:process";
 import os from "node:os";
 import tty from "node:tty";
 import require$$0 from "node:events";
 import require$$1, { spawn } from "node:child_process";
 import path from "node:path";
+import * as require$$3 from "node:fs";
+import require$$3__default from "node:fs";
 import fsp from "node:fs/promises";
 import readline from "node:readline/promises";
 let globalOpts = void 0;
@@ -11216,6 +11216,70 @@ function requireSrc() {
   return src;
 }
 var srcExports = /* @__PURE__ */ requireSrc();
+const adminCmd = new Command().name("admin").description("admin commands");
+function toHumanReadableSize(size) {
+  const sizes = ["Bytes", "KB", "MB", "GB", "TB"];
+  if (size === 0) return "0 Bytes";
+  const i = Math.floor(Math.log(size) / Math.log(1024));
+  return (size / Math.pow(1024, i)).toFixed(2) + " " + sizes[i];
+}
+const usersCmd = new Command().name("users").description("user management commands");
+usersCmd.command("list").description("list all users").action(async () => {
+  const api2 = getAPIClient();
+  try {
+    const [usersResp, userStats] = await Promise.all([
+      api2.users.list.query(),
+      api2.admin.userStats.query()
+    ]);
+    if (getGlobalOptions().json) {
+      printObject({
+        users: usersResp.users.map((u) => ({
+          ...u,
+          numBookmarks: userStats[u.id]?.numBookmarks ?? 0,
+          assetSizes: userStats[u.id]?.assetSizes ?? 0
+        }))
+      });
+    } else {
+      const data = [
+        [
+          "Name",
+          "Email",
+          "Num Bookmarks",
+          "Asset Sizes",
+          "Role",
+          "Local User"
+        ]
+      ];
+      usersResp.users.forEach((user) => {
+        const stats = userStats[user.id] ?? {
+          numBookmarks: 0,
+          assetSizes: 0
+        };
+        const numBookmarksDisplay = `${stats.numBookmarks} / ${user.bookmarkQuota?.toString() ?? "Unlimited"}`;
+        const assetSizesDisplay = `${toHumanReadableSize(stats.assetSizes)} / ${user.storageQuota ? toHumanReadableSize(user.storageQuota) : "Unlimited"}`;
+        data.push([
+          user.name,
+          user.email,
+          numBookmarksDisplay,
+          assetSizesDisplay,
+          user.role ?? "",
+          user.localUser ? "✓" : "✗"
+        ]);
+      });
+      console.log(
+        srcExports.table(data, {
+          border: srcExports.getBorderCharacters("ramac"),
+          drawHorizontalLine: (lineIndex, rowCount) => {
+            return lineIndex === 0 || lineIndex === 1 || lineIndex === rowCount;
+          }
+        })
+      );
+    }
+  } catch (error2) {
+    printErrorMessageWithReason("Failed to list all users", error2);
+  }
+});
+adminCmd.addCommand(usersCmd);
 function listsToTree(lists) {
   const idToList = lists.reduce((acc, list) => {
     acc[list.id] = list;
@@ -15408,6 +15472,7 @@ const zCursorV2 = z.object({
 function normalizeTagName(raw) {
   return raw.trim().replace(/^#+/, "");
 }
+const MAX_NUM_TAGS_PER_PAGE = 1e3;
 const zTagNameSchemaWithValidation = z.string().transform((s) => normalizeTagName(s).trim()).pipe(z.string().min(1));
 z.object({
   name: zTagNameSchemaWithValidation
@@ -15418,7 +15483,7 @@ const zBookmarkTagSchema = z.object({
   name: z.string(),
   attachedBy: zAttachedByEnumSchema
 });
-z.object({
+const zGetTagResponseSchema = z.object({
   id: z.string(),
   name: z.string(),
   numBookmarks: z.number(),
@@ -15432,6 +15497,49 @@ z.object({
   id: z.string(),
   name: z.string()
 });
+const zTagCursorSchema = z.object({
+  page: z.number().int().min(0)
+});
+const zTagListRequestSchema = z.object({
+  nameContains: z.string().optional(),
+  attachedBy: z.enum([...zAttachedByEnumSchema.options, "none"]).optional(),
+  sortBy: z.enum(["name", "usage", "relevance"]).optional().default("usage"),
+  cursor: zTagCursorSchema.nullish().default({ page: 0 }),
+  // TODO: Remove the optional to enforce a limit after the next release
+  limit: z.number().int().min(1).max(MAX_NUM_TAGS_PER_PAGE).optional()
+});
+zTagListRequestSchema.refine(
+  (val) => val.sortBy != "relevance" || val.nameContains !== void 0,
+  {
+    message: "Relevance sorting requires a nameContains filter",
+    path: ["sortBy"]
+  }
+);
+const zTagListResponseSchema = z.object({
+  tags: z.array(zGetTagResponseSchema),
+  nextCursor: zTagCursorSchema.nullish()
+});
+z.object({
+  nameContains: zTagListRequestSchema.shape.nameContains,
+  sort: zTagListRequestSchema.shape.sortBy,
+  attachedBy: zTagListRequestSchema.shape.attachedBy,
+  cursor: z.string().transform((val, ctx) => {
+    try {
+      return JSON.parse(Buffer.from(val, "base64url").toString("utf8"));
+    } catch {
+      ctx.addIssue({
+        code: "custom",
+        message: "Invalid cursor"
+      });
+      return z.NEVER;
+    }
+  }).optional().pipe(zTagListRequestSchema.shape.cursor),
+  limit: z.coerce.number().optional()
+});
+z.object({
+  tags: zTagListResponseSchema.shape.tags,
+  nextCursor: z.string().nullish()
+});
 const MAX_BOOKMARK_TITLE_LENGTH = 1e3;
 var BookmarkTypes = /* @__PURE__ */ ((BookmarkTypes2) => {
   BookmarkTypes2["LINK"] = "link";
@@ -15450,11 +15558,13 @@ const zAssetTypesSchema = z.enum([
   "video",
   "bookmarkAsset",
   "precrawledArchive",
+  "userUploaded",
   "unknown"
 ]);
 const zAssetSchema = z.object({
   id: z.string(),
-  assetType: zAssetTypesSchema
+  assetType: zAssetTypesSchema,
+  fileName: z.string().nullish()
 });
 const zBookmarkedLinkSchema = z.object({
   type: z.literal(
@@ -15508,6 +15618,16 @@ const zBookmarkContentSchema = z.discriminatedUnion("type", [
     /* UNKNOWN */
   ) })
 ]);
+const zBookmarkSourceSchema = z.enum([
+  "api",
+  "web",
+  "cli",
+  "mobile",
+  "extension",
+  "singlefile",
+  "rss",
+  "import"
+]);
 const zBareBookmarkSchema = z.object({
   id: z.string(),
   createdAt: z.date(),
@@ -15518,7 +15638,9 @@ const zBareBookmarkSchema = z.object({
   taggingStatus: z.enum(["success", "failure", "pending"]).nullable(),
   summarizationStatus: z.enum(["success", "failure", "pending"]).nullable(),
   note: z.string().nullish(),
-  summary: z.string().nullish()
+  summary: z.string().nullish(),
+  source: zBookmarkSourceSchema.nullish(),
+  userId: z.string()
 });
 const zBookmarkSchema = zBareBookmarkSchema.merge(
   z.object({
@@ -15557,7 +15679,9 @@ z.object({
   createdAt: z.coerce.date().optional(),
   // A mechanism to prioritize crawling of bookmarks depending on whether
   // they were created by a user interaction or by a bulk import.
-  crawlPriority: z.enum(["low", "normal"]).optional()
+  crawlPriority: z.enum(["low", "normal"]).optional(),
+  importSessionId: z.string().optional(),
+  source: zBookmarkSourceSchema.optional()
 }).and(
   z.discriminatedUnion("type", [
     z.object({
@@ -15734,12 +15858,22 @@ bookmarkCmd.command("add").description("creates a new bookmark").option(
   const results = [];
   const promises = [
     ...opts.link.map(
-      (url) => api2.bookmarks.createBookmark.mutate({ type: BookmarkTypes.LINK, url, title: opts.title }).then((bookmark) => {
+      (url) => api2.bookmarks.createBookmark.mutate({
+        type: BookmarkTypes.LINK,
+        url,
+        title: opts.title,
+        source: "cli"
+      }).then((bookmark) => {
         results.push(normalizeBookmark(bookmark));
       }).catch(printError(`Failed to add a link bookmark for url "${url}"`))
     ),
     ...opts.note.map(
-      (text) => api2.bookmarks.createBookmark.mutate({ type: BookmarkTypes.TEXT, text, title: opts.title }).then((bookmark) => {
+      (text) => api2.bookmarks.createBookmark.mutate({
+        type: BookmarkTypes.TEXT,
+        text,
+        title: opts.title,
+        source: "cli"
+      }).then((bookmark) => {
         results.push(normalizeBookmark(bookmark));
       }).catch(
         printError(
@@ -15751,7 +15885,12 @@ bookmarkCmd.command("add").description("creates a new bookmark").option(
   if (opts.stdin) {
     const text = require$$3.readFileSync(0, "utf-8");
     promises.push(
-      api2.bookmarks.createBookmark.mutate({ type: BookmarkTypes.TEXT, text, title: opts.title }).then((bookmark) => {
+      api2.bookmarks.createBookmark.mutate({
+        type: BookmarkTypes.TEXT,
+        text,
+        title: opts.title,
+        source: "cli"
+      }).then((bookmark) => {
         results.push(normalizeBookmark(bookmark));
       }).catch(
         printError(
@@ -15989,9 +16128,18 @@ const dumpCmd = new Command().name("dump").description("dump all account data an
     }
     if (!opts.excludeTags) {
       stepStart$2("Exporting tags");
-      const { tags } = await api2.tags.list.query();
-      await writeJson(path.join(workRoot, "tags", "index.json"), tags);
-      manifest.counts.tags = tags.length;
+      let cursor = null;
+      let allTags = [];
+      do {
+        const { tags, nextCursor } = await api2.tags.list.query({
+          limit: MAX_NUM_TAGS_PER_PAGE,
+          cursor
+        });
+        allTags.push(...tags);
+        cursor = nextCursor;
+      } while (cursor);
+      await writeJson(path.join(workRoot, "tags", "index.json"), allTags);
+      manifest.counts.tags = allTags.length;
       stepEndSuccess$2();
     }
     if (!opts.excludeRules) {
@@ -16539,7 +16687,7 @@ async function migrateWebhooks(src2, dest, onProgress) {
 }
 async function migrateTags(src2, dest, onProgress) {
   try {
-    const { tags: srcTags } = await src2.tags.list.query();
+    const { tags: srcTags } = await src2.tags.list.query({});
     let ensured = 0;
     for (const t of srcTags) {
       try {
@@ -16549,7 +16697,7 @@ async function migrateTags(src2, dest, onProgress) {
       ensured++;
       onProgress?.(ensured, srcTags.length);
     }
-    const { tags: destTags } = await dest.tags.list.query();
+    const { tags: destTags } = await dest.tags.list.query({});
     const nameToDestId = destTags.reduce((acc, t) => {
       acc[t.name] = t.id;
       return acc;
@@ -16802,7 +16950,7 @@ const tagsCmd = new Command().name("tags").description("manipulating tags");
 tagsCmd.command("list").description("lists all tags").action(async () => {
   const api2 = getAPIClient();
   try {
-    const tags = (await api2.tags.list.query()).tags;
+    const tags = (await api2.tags.list.query({})).tags;
     tags.sort((a, b) => b.numBookmarks - a.numBookmarks);
     if (getGlobalOptions().json) {
       printObject(tags);
@@ -17153,7 +17301,7 @@ async function wipeTags(api2) {
     throw error2;
   }
 }
-const __vite_import_meta_env__ = { "BASE_URL": "/", "CLI_VERSION": "0.27.1", "DEV": false, "MODE": "production", "PROD": true, "SSR": true };
+const __vite_import_meta_env__ = { "BASE_URL": "/", "CLI_VERSION": "0.29.1", "DEV": false, "MODE": "production", "PROD": true, "SSR": true };
 const program = new Command().name("karakeep").description("A CLI interface to interact with the karakeep api").addOption(
   new Option("--api-key <key>", "the API key to interact with the API").makeOptionMandatory(true).env("KARAKEEP_API_KEY")
 ).addOption(
@@ -17162,8 +17310,9 @@ const program = new Command().name("karakeep").description("A CLI interface to i
     "the address of the server to connect to"
   ).makeOptionMandatory(true).env("KARAKEEP_SERVER_ADDR")
 ).addOption(new Option("--json", "to output the result as JSON")).version(
-  __vite_import_meta_env__ && "CLI_VERSION" in __vite_import_meta_env__ ? "0.27.1" : "0.0.0"
+  __vite_import_meta_env__ && "CLI_VERSION" in __vite_import_meta_env__ ? "0.29.1" : "0.0.0"
 );
+program.addCommand(adminCmd);
 program.addCommand(bookmarkCmd);
 program.addCommand(listsCmd);
 program.addCommand(tagsCmd);

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@karakeep/cli",
-  "version": "0.27.1",
+  "version": "0.29.1",
   "description": "Command Line Interface (CLI) for Karakeep",
   "license": "GNU Affero General Public License version 3",
   "type": "module",