teak-sdk 1.0.87 → 1.0.89

package/README.md

@@ -1,8 +1,8 @@
 # Teak SDK
 
-Typed API client and OAuth discovery for Teak. The distribution bundles the
-canonical implementation from `packages/convex/client/sdk.ts`; it has no runtime
-dependencies and works without the Teak monorepo.
+Typed API client and OAuth discovery for Teak. The source lives in `src/`, and
+`bun run build` writes the npm package to `dist/`: one bundle with no runtime
+dependencies, so it works without the Teak monorepo.
 
 ```ts
 import { createTeakClient, discoverAuthServer } from "teak-sdk";

package/{dist/sdk.js → index.js}

@@ -1,6 +1,6 @@
 // ../convex/shared/utils/formatBytes.ts
 var BYTE_UNITS = ["B", "KB", "MB", "GB"];
-var formatBytes = (bytes) => {
+var formatBytes = (bytes, locale) => {
   if (!(bytes && Number.isFinite(bytes) && bytes > 0)) {
     return "0 B";
   }
@@ -11,7 +11,12 @@ var formatBytes = (bytes) => {
     unit += 1;
   }
   const digits = unit > 0 && value < 10 ? 1 : 0;
-  return `${value.toFixed(digits)} ${BYTE_UNITS[unit]}`;
+  const number = locale ? new Intl.NumberFormat(locale, {
+    maximumFractionDigits: digits,
+    minimumFractionDigits: digits,
+    useGrouping: false
+  }).format(value) : value.toFixed(digits);
+  return `${number} ${BYTE_UNITS[unit]}`;
 };
 // ../convex/shared/boundedResponse.ts
 class ResponseSizeLimitError extends Error {
@@ -46,6 +51,9 @@ var consumeResponseWithinLimit = async (response, maxBytes, consume) => {
 };
 var readResponseTextWithinLimit = (response, maxBytes) => consumeResponseWithinLimit(response, maxBytes, (boundedResponse) => boundedResponse.text());
 
+// ../convex/shared/oauthSurfaces.ts
+var OAUTH_SURFACES = ["cli", "raycast", "chrome", "firefox"];
+
 // ../convex/devUrls.ts
 var TEAK_DEV_DEPLOYMENT_NAME = "reminiscent-kangaroo-59";
 var DEFAULT_TEAK_DEV_CONVEX_URL = `https://${TEAK_DEV_DEPLOYMENT_NAME}.convex.cloud`;
@@ -66,7 +74,8 @@ var validateOAuthUrl = (raw, local = false) => {
     throw new Error("Missing OAuth discovery URL");
   }
   const url = new URL(raw);
-  if (url.username || url.password || url.hash || url.protocol !== "https:" && !(local && url.protocol === "http:" && isLoopbackHostname(url.hostname)) || !local && isLoopbackHostname(url.hostname) || privateHost(url.hostname) && !(local && isLoopbackHostname(url.hostname))) {
+  const hostname = url.hostname.replace(/\.+$/, "");
+  if (url.username || url.password || url.hash || url.protocol !== "https:" && !(local && url.protocol === "http:" && isLoopbackHostname(hostname)) || !local && isLoopbackHostname(hostname) || privateHost(hostname) && !(local && isLoopbackHostname(hostname))) {
     throw new Error("Unsafe OAuth discovery URL");
   }
   return url;
@@ -80,8 +89,7 @@ var workosResourcesFor = (url) => {
 };
 var PRODUCTION_WORKOS_RESOURCES = workosResourcesFor(PRODUCTION_WORKOS_RESOURCE_ORIGIN);
 
-// ../convex/client/authDiscovery.ts
-var OAUTH_SURFACES = ["cli", "raycast", "chrome", "firefox"];
+// src/authDiscovery.ts
 var caches = new WeakMap;
 var object = (value) => {
   if (!value || typeof value !== "object" || Array.isArray(value)) {
@@ -195,7 +203,18 @@ function discoverAuthServer(siteUrl, options = {}) {
   });
   return pending;
 }
-// ../convex/client/workosConnect.ts
+// src/oauthCredentials.ts
+var isWorkosCredential = (saved) => Boolean(saved?.origin && saved.issuer && saved.clientId?.startsWith("client_"));
+var matchesBinding = (saved, current) => saved?.origin === current.origin && saved.issuer === current.issuer && saved.clientId === current.clientId;
+var isRefreshTokenDead = (result) => !result.ok && result.reason === "refresh_token_rejected";
+var refreshAndSave = async (refresh, save) => {
+  const renewed = await refresh();
+  if (renewed !== null && renewed !== undefined) {
+    await save(renewed);
+  }
+  return renewed;
+};
+// src/workosConnect.ts
 var WORKOS_CONNECT_SCOPE = "openid profile email offline_access";
 var MAX_RESPONSE_BYTES = 64 * 1024;
 var MAX_TOKEN_LIFETIME_SECONDS = 365 * 24 * 3600;
@@ -347,11 +366,49 @@ var FILES_OBJECT_KEY_ROOTS = ["", FILES_DEV_KEY_PREFIX].flatMap((envPrefix) => [
 // ../files-protocol/src/inspect.ts
 var FILES_INSPECT_MAX_ARCHIVE_BYTES = 25 * 1024 * 1024;
 var FILES_INSPECT_MAX_SOURCE_BYTES = 2 * 1024 * 1024;
+// ../files-protocol/src/metadata.ts
+var SHARED_LANGUAGE_RULES = `- In Japanese, Chinese and Korean, each tag is one term with no spaces, such as "デザイン", "设计" or "디자인".
+- Never use "secret" or "hidden", or a translation of either, as a tag.`;
+var CONTENT_LANGUAGE_RULES = `- Write the tags and the summary in the same language as the content. If the content mixes languages, use the main one. If you can't tell the language, use English.
+${SHARED_LANGUAGE_RULES}
+- Language is the content's main language as a lowercase ISO 639-1 code, such as "en", "ja" or "es".`;
+var IMAGE_LANGUAGE_RULES = `- Write the tags and the summary in the language of the text in the image. If the text mixes languages, use the main one. If the image has no legible text, use English.
+${SHARED_LANGUAGE_RULES}
+- Language is the main language of the text in the image as a lowercase ISO 639-1 code, such as "en", "ja" or "es", and "en" when it has no legible text.`;
+var TEXT_ANALYSIS_SYSTEM_PROMPT = `You are an expert content analyzer. Generate relevant tags and a concise summary for the given content. /no_think
+
+Guidelines:
+- Tags should be 5-6 specific, relevant single words only (no spaces, no hyphens)
+- Summary should be 1-2 sentences that capture the essence
+- Focus on the main topics, themes, and key information
+- Use clear, searchable language
+${CONTENT_LANGUAGE_RULES}
+
+Respond with a single JSON object using exactly this shape and no other keys:
+{"tags": ["word", "word"], "summary": "...", "language": "xx"}`;
+var LINK_ANALYSIS_SYSTEM_PROMPT = `You are an expert web content analyzer. Generate relevant tags and a concise summary for the given web page content. /no_think
+
+Guidelines:
+- Tags should be 5-6 single words capturing main topics, categories, and key concepts (no spaces, no hyphens)
+- Include relevant technology, industry, or topic tags where applicable
+- Summary should be 1-2 sentences capturing the essence and value of the content
+- Focus on what makes this link useful and searchable
+- Use clear, specific language that helps with discovery
+- Consider the source, author, and context when available
+${CONTENT_LANGUAGE_RULES}
+
+Respond with a single JSON object using exactly this shape and no other keys:
+{"tags": ["word", "word"], "summary": "...", "language": "xx"}`;
+var ISO_639_1 = new Set(("aa ab ae af ak am an ar as av ay az ba be bg bi bm bn bo br bs ca ce ch " + "co cr cs cu cv cy da de dv dz ee el en eo es et eu fa ff fi fj fo fr fy " + "ga gd gl gn gu gv ha he hi ho hr ht hu hy hz ia id ie ig ii ik io is it " + "iu ja jv ka kg ki kj kk kl km kn ko kr ks ku kv kw ky la lb lg li ln lo " + "lt lu lv mg mh mi mk ml mn mr ms mt my na nb nd ne ng nl nn no nr nv ny " + "oc oj om or os pa pi pl ps pt qu rm rn ro ru rw sa sc sd se sg si sk sl " + "sm sn so sq sr ss st su sv sw ta te tg th ti tk tl tn to tr ts tt tw ty " + "ug uk ur uz ve vi vo wa wo xh yi yo za zh zu").split(" "));
 // ../files-protocol/src/remoteAsset.ts
 var FILES_REMOTE_ASSET_MAX_BYTES = {
   image: 20 * 1024 * 1024,
   video: 50 * 1024 * 1024
 };
+var GENERIC_CONTENT_TYPES = new Set([
+  "application/octet-stream",
+  "binary/octet-stream"
+]);
 // ../files-protocol/src/workflows.ts
 var WORKFLOW_RPC_MAX_TTL_SECONDS = 5 * 60;
 var WORKFLOW_RPC_MAX_BODY_BYTES = 4 * 1024 * 1024;
@@ -837,6 +894,11 @@ var TAG_ERROR_MESSAGES = {
 };
 var HIDDEN_TAG_KEYS = ["secret", "hidden"];
 var hiddenTagKeys = new Set(HIDDEN_TAG_KEYS);
+var MAX_CARD_TAGS = 100;
+var CARD_TAG_ERROR_MESSAGES = {
+  TAG_TOO_LONG: `Each tag must be at most ${MAX_TAG_NAME_LENGTH} characters`,
+  TOO_MANY_TAGS: `A card can have at most ${MAX_CARD_TAGS} tags`
+};
 // ../convex/shared/constants.ts
 var cardTypes = [
   "text",
@@ -903,7 +965,7 @@ var RESERVED_KEYWORDS = [
   { value: "trash", label: "Trash" }
 ];
 
-// ../convex/client/sdk.ts
+// src/index.ts
 var CARD_TYPES2 = cardTypes;
 var CARD_SORTS = ["newest", "oldest", "relevance", "shuffle"];
 var ERROR_CODES = [
@@ -1045,7 +1107,7 @@ var buildCardsSearchParams = (input) => {
   if (input.mode === "keyword" || input.mode === "semantic") {
     search.set("mode", input.mode);
   }
-  if (input.sort === "oldest" || input.sort === "shuffle") {
+  if (input.sort && input.sort !== "newest") {
     search.set("sort", input.sort);
   }
   if (input.sort === "shuffle" && typeof input.shuffleSeed === "number") {
@@ -1060,12 +1122,38 @@ var buildCardsSearchParams = (input) => {
   search.set("limit", String(normalizeLimit(input.limit)));
   return search.toString();
 };
-var parseJson = async (response) => {
-  if (response.status === 204) {
-    return null;
+var readStream = async (reader) => {
+  const decoder = new TextDecoder;
+  let text = "";
+  for (;; ) {
+    const { done, value } = await reader.read();
+    if (done) {
+      return text + decoder.decode();
+    }
+    text += decoder.decode(value, { stream: true });
   }
-  const text = await response.text();
-  if (!text.trim()) {
+};
+var readBody = (response, signal) => new Promise((resolve, reject) => {
+  const reader = response.body?.getReader();
+  const onAbort = () => {
+    reject(new TeakApiError("TIMEOUT"));
+    reader?.cancel().catch(() => {
+      return;
+    });
+  };
+  if (signal.aborted) {
+    onAbort();
+    return;
+  }
+  if (!reader) {
+    resolve("");
+    return;
+  }
+  signal.addEventListener("abort", onAbort, { once: true });
+  readStream(reader).then(resolve, () => reject(new TeakApiError(signal.aborted ? "TIMEOUT" : "NETWORK_ERROR"))).finally(() => signal.removeEventListener("abort", onAbort));
+});
+var parseJson = (response, text) => {
+  if (response.status === 204 || !text.trim()) {
     return null;
   }
   try {
@@ -1195,14 +1283,18 @@ var createTeakClient = (options) => {
       headers.set("Content-Type", "application/json");
     }
     let response;
+    let text;
     try {
-      response = await fetchImpl(`${baseUrl}${path}`, {
-        ...init,
-        headers,
-        signal: controller.signal
-      });
-    } catch (error) {
-      throw new TeakApiError(error instanceof DOMException && error.name === "AbortError" ? "TIMEOUT" : "NETWORK_ERROR");
+      try {
+        response = await fetchImpl(`${baseUrl}${path}`, {
+          ...init,
+          headers,
+          signal: controller.signal
+        });
+      } catch (error) {
+        throw new TeakApiError(error instanceof DOMException && error.name === "AbortError" ? "TIMEOUT" : "NETWORK_ERROR");
+      }
+      text = response.status === 204 ? "" : await readBody(response, controller.signal);
     } finally {
       clearTimeout(timeout);
     }
@@ -1212,7 +1304,7 @@ var createTeakClient = (options) => {
         return request(path, init, parser, false, next);
       }
     }
-    const payload = await parseJson(response);
+    const payload = parseJson(response, text);
     if (!response.ok) {
       const object = isObject(payload) ? payload : {};
       throw new TeakApiError(codeFrom(object.code, response.status === 404 ? "NOT_FOUND" : "REQUEST_FAILED"), String(object.error || response.statusText), {
@@ -1347,10 +1439,14 @@ export {
   fetchConnectOwnerId,
   formatBytes,
   isCardType,
+  isRefreshTokenDead,
   isStringList,
+  isWorkosCredential,
+  matchesBinding,
   normalizeLimit,
   parseTags,
   randomBase64Url,
+  refreshAndSave,
   requestConnectTokens,
   staticTokenProvider,
   validateOAuthUrl

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "teak-sdk",
-  "version": "1.0.87",
+  "version": "1.0.89",
   "description": "Teak API client and OAuth discovery for browser and Node applications.",
   "repository": {
     "type": "git",
@@ -11,25 +11,10 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/client/sdk.d.ts",
-      "import": "./dist/sdk.js"
+      "types": "./types/index.d.ts",
+      "import": "./index.js"
     }
   },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "scripts": {
-    "build": "bun --no-env-file run build.ts",
-    "prepack": "bun run build",
-    "typecheck": "tsc build.ts ../convex/client/sdk.ts --strict --noEmit --moduleResolution bundler --module esnext --target es2022 --skipLibCheck --types bun,node"
-  },
-  "devDependencies": {
-    "@teak/convex": "workspace:*",
-    "@types/bun": "^1.4.0",
-    "@types/node": "^26.6.5",
-    "typescript": "^6.0.3"
-  },
   "publishConfig": {
     "access": "public",
     "provenance": true

package/{dist/types/client → types}/authDiscovery.d.ts

@@ -1,6 +1,6 @@
-export { validateOAuthUrl } from "../shared/oauthUrl.js";
-export declare const OAUTH_SURFACES: readonly ["cli", "raycast", "chrome", "firefox"];
-export type OAuthSurface = (typeof OAUTH_SURFACES)[number];
+import { type OAuthSurface } from "./convex/shared/oauthSurfaces.js";
+export { OAUTH_SURFACES, type OAuthSurface, } from "./convex/shared/oauthSurfaces.js";
+export { validateOAuthUrl } from "./convex/shared/oauthUrl.js";
 export interface AuthDiscovery {
     readonly authorizationEndpoint: string;
     readonly clients: Readonly<Record<OAuthSurface, string>>;

package/types/convex/shared/oauthSurfaces.d.ts

@@ -0,0 +1,2 @@
+export declare const OAUTH_SURFACES: readonly ["cli", "raycast", "chrome", "firefox"];
+export type OAuthSurface = (typeof OAUTH_SURFACES)[number];

package/{dist/types → types/convex}/shared/tags.d.ts

@@ -19,6 +19,19 @@ export declare const isCardHidden: (card: {
     tags?: readonly string[];
 }) => boolean;
 export declare const explainInvalidTagName: (name: string) => string | null;
+export declare const MAX_CARD_TAGS = 100;
+export declare const CARD_TAG_ERROR_MESSAGES: {
+    readonly TAG_TOO_LONG: "Each tag must be at most 64 characters";
+    readonly TOO_MANY_TAGS: "A card can have at most 100 tags";
+};
+/** Trims each tag, drops empty ones and keeps the first of each case variant. */
+export declare const normalizeTagList: (tags: readonly string[]) => string[];
+/**
+ * Why a card can't hold these normalized tags, or null. Tags the card already
+ * has (saved before the limits existed) may stay, and a card already past the
+ * count may keep or drop tags, never add.
+ */
+export declare const explainInvalidCardTags: (tags: readonly string[], previousTags?: readonly string[]) => string | null;
 export declare const MAX_TAG_KEY_LENGTH = 256;
 export declare const explainInvalidTagSource: (name: string) => string | null;
 export declare const tagExistsMessage: (name: string) => string;

package/types/convex/shared/utils/formatBytes.d.ts

@@ -0,0 +1,5 @@
+/**
+ * A byte size such as "2.1 MB". Pass a locale to write the number in that
+ * language ("2,1 MB" in German); without one it keeps the "." of before.
+ */
+export declare const formatBytes: (bytes?: number | null, locale?: string) => string;

package/{dist/types/client/sdk.d.ts → types/index.d.ts}

@@ -1,10 +1,11 @@
-export { formatBytes } from "../shared/utils/formatBytes.js";
+export { formatBytes } from "./convex/shared/utils/formatBytes.js";
 export { type AuthDiscovery, discoverAuthServer, type OAuthSurface, validateOAuthUrl, } from "./authDiscovery.js";
+export { type CredentialBinding, isRefreshTokenDead, isWorkosCredential, matchesBinding, refreshAndSave, } from "./oauthCredentials.js";
 export { type ConnectTokenResult, type ConnectTokens, createConnectAuthorizeUrl, createPkceChallenge, disconnectConnectGrant, fetchConnectOwnerId, randomBase64Url, requestConnectTokens, WORKOS_CONNECT_SCOPE, } from "./workosConnect.js";
-import { type CardType } from "../shared/constants.js";
-import type { FileKind, FilePreviewFacts } from "../shared/fileFormats.js";
-import type { FOLDER_COLORS } from "../shared/folders.js";
-export type { CardType } from "../shared/constants.js";
+import { type CardType } from "./convex/shared/constants.js";
+import type { FileKind, FilePreviewFacts } from "./convex/shared/fileFormats.js";
+import type { FOLDER_COLORS } from "./convex/shared/folders.js";
+export type { CardType } from "./convex/shared/constants.js";
 export declare const CARD_TYPES: readonly ["text", "link", "image", "video", "audio", "document", "palette", "quote"];
 export declare const CARD_SORTS: readonly ["newest", "oldest", "relevance", "shuffle"];
 export declare const ERROR_CODES: readonly ["AUTH_REQUIRED", "BAD_REQUEST", "CARD_LIMIT_REACHED", "CONFIG_ERROR", "CONFLICT", "CONTENT_TOO_LARGE", "FILE_TOO_LARGE", "FOLDER_LIMIT", "FORBIDDEN", "IN_PROGRESS", "INTERNAL_ERROR", "INVALID_API_KEY", "INVALID_INPUT", "INVALID_STORAGE_KEY", "INVALID_UTF8", "LIMIT_REACHED", "METHOD_NOT_ALLOWED", "NETWORK_ERROR", "NOT_FOUND", "NO_CONTENT", "NOT_IN_TRASH", "PARSE_ERROR", "RATE_LIMITED", "REQUEST_FAILED", "SERVICE_UNAVAILABLE", "SMART_FOLDER", "TAG_EXISTS", "TAG_OPERATION_RUNNING", "TIMEOUT", "TYPE_MISMATCH", "UNAUTHORIZED", "UNSUPPORTED_TYPE"];
@@ -289,6 +290,12 @@ export interface Me {
     cardLimit: number | null;
     email: string;
     id: string;
+    /**
+     * The account's Teak language, chosen in Settings: a BCP 47 code such as
+     * `en`, `de` or `pt-BR`. More may be added, so treat an unknown code as
+     * English.
+     */
+    locale: string;
     name?: string;
     plan: "free" | "pro";
     settingsUrl: string;
@@ -413,7 +420,9 @@ export declare const buildCardsSearchParams: (input: {
      * `is:fav`, `is:archived`, `site:github.com`, `folder:"Reading list"`,
      * `price:<100` (also `>`, `<=`, `>=` and `=`), `text:"total due"` (only
      * the words Teak read in images, video thumbnails, link previews and scanned
-     * PDFs) and `"quoted phrases"`.
+     * PDFs) and `"quoted phrases"`. A `-` leaves cards out (`design -figma`,
+     * `-tag:old`), uppercase `OR` matches either side and parentheses group:
+     * `(site:github.com OR site:gitlab.com) -is:archived`.
      */
     query?: string;
     /** Required with `sort: "shuffle"`: the same seed gives the same order. */

package/types/oauthCredentials.d.ts

@@ -0,0 +1,10 @@
+import type { ConnectTokenResult } from "./workosConnect.js";
+export interface CredentialBinding {
+    clientId: string;
+    issuer: string;
+    origin: string;
+}
+export declare const isWorkosCredential: (saved: Partial<CredentialBinding> | undefined) => saved is CredentialBinding;
+export declare const matchesBinding: (saved: Partial<CredentialBinding> | undefined, current: CredentialBinding) => boolean;
+export declare const isRefreshTokenDead: (result: ConnectTokenResult) => boolean;
+export declare const refreshAndSave: <T>(refresh: () => Promise<T>, save: (renewed: NonNullable<T>) => unknown) => Promise<T>;

package/dist/types/shared/utils/formatBytes.d.ts

@@ -1 +0,0 @@
-export declare const formatBytes: (bytes?: number | null) => string;