teak-sdk 1.0.83 → 1.0.85

package/README.md

@@ -26,5 +26,5 @@ the token used by a retry-eligible 401 response. Return a new or already-refresh
 token to retry once, or `null` to stop. Check the rejected token against the current
 session before refreshing so an older response cannot invalidate newer credentials.
 
-This package is prepared for the WorkOS migration and is not published yet.
-Publication requires lockstep release preparation and npm publisher setup.
+Install it from npm as `teak-sdk`. Each release shares the lockstep version of
+the other Teak products and is published by the `SDK Release` workflow.

package/dist/sdk.js

@@ -1,4 +1,7 @@
 // ../convex/devUrls.ts
+var TEAK_DEV_DEPLOYMENT_NAME = "reminiscent-kangaroo-59";
+var DEFAULT_TEAK_DEV_CONVEX_URL = `https://${TEAK_DEV_DEPLOYMENT_NAME}.convex.cloud`;
+var DEFAULT_TEAK_DEV_CONVEX_SITE_URL = `https://${TEAK_DEV_DEPLOYMENT_NAME}.convex.site`;
 var isLocalDevelopmentHostname = (hostname) => {
   const normalizedHostname = hostname.trim().toLowerCase();
   return normalizedHostname === "localhost" || normalizedHostname === "127.0.0.1" || normalizedHostname.endsWith(".localhost");
@@ -907,20 +910,22 @@ var byteLengthForBody = (bytes) => {
   }
   return null;
 };
+var asList = (value) => {
+  if (Array.isArray(value)) {
+    return value;
+  }
+  return typeof value === "string" ? [value] : [];
+};
 var buildCardsSearchParams = (input) => {
   const search = new URLSearchParams;
   if (input.query?.trim()) {
     search.set("q", input.query.trim());
   }
-  let types = [];
-  if (Array.isArray(input.type)) {
-    types = input.type;
-  } else if (typeof input.type === "string") {
-    types = [input.type];
-  }
-  for (const type of types) {
-    if (type.trim()) {
-      search.append("type", type.trim());
+  for (const name of ["type", "style", "hue", "hex"]) {
+    for (const value of asList(input[name])) {
+      if (value.trim()) {
+        search.append(name, value.trim());
+      }
     }
   }
   if (input.tag?.trim()) {
@@ -935,6 +940,9 @@ var buildCardsSearchParams = (input) => {
   if (input.favorited) {
     search.set("favorited", "true");
   }
+  if (input.trashed) {
+    search.set("trashed", "true");
+  }
   if (input.sort === "oldest") {
     search.set("sort", "oldest");
   }
@@ -992,6 +1000,18 @@ var asCreate = (value) => {
   }
   return value;
 };
+var asMe = (value) => {
+  if (!(isObject(value) && isObject(value.data)) || typeof value.data.id !== "string") {
+    throw new TeakApiError("PARSE_ERROR");
+  }
+  return value.data;
+};
+var asLatestExport = (value) => {
+  if (!isObject(value) || typeof value.canStartNew !== "boolean") {
+    throw new TeakApiError("PARSE_ERROR");
+  }
+  return value;
+};
 var asUpload = (value) => {
   if (!isObject(value) || typeof value.uploadUrl !== "string" || typeof value.fileKey !== "string" || value.method !== "PUT" || typeof value.maxFileSize !== "number" || typeof value.expiresIn !== "number") {
     throw new TeakApiError("PARSE_ERROR");
@@ -1044,7 +1064,7 @@ var createTeakClient = (options) => {
     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), {
-        requestId: typeof object.requestId === "string" ? object.requestId : undefined,
+        requestId: response.headers.get("x-request-id") ?? undefined,
         retryAt: typeof object.retryAt === "number" ? object.retryAt : undefined,
         status: response.status
       });
@@ -1052,23 +1072,40 @@ var createTeakClient = (options) => {
     return parser(payload);
   };
   const qs = (params) => buildCardsSearchParams(params);
+  const idempotency = (requestOptions) => requestOptions?.idempotencyKey ? { "Idempotency-Key": requestOptions.idempotencyKey } : {};
+  const cardPath = (id) => `/v1/cards/${encodeURIComponent(id)}`;
   return {
     cards: {
-      bulk: (operation, items) => request("/v1/cards/bulk", { body: JSON.stringify({ items, operation }), method: "POST" }, (v) => v),
+      bulk: (operation, items, requestOptions) => request("/v1/cards/bulk", {
+        body: JSON.stringify({ items, operation }),
+        headers: idempotency(requestOptions),
+        method: "POST"
+      }, (v) => v),
       changes: (input) => {
         const search = new URLSearchParams(qs(input));
         search.set("since", String(input.since));
         return request(`/v1/cards/changes?${search.toString()}`, { method: "GET" }, (v) => v);
       },
-      create: (input) => request("/v1/cards", { body: JSON.stringify(input), method: "POST" }, asCreate),
-      delete: (id) => request(`/v1/cards/${encodeURIComponent(id)}`, { method: "DELETE" }, () => null),
-      favorites: (input = {}) => request(`/v1/cards?${qs({ ...input, favorited: true, include: "content,metadata" })}`, { method: "GET" }, asPage),
-      get: (id) => request(`/v1/cards/${encodeURIComponent(id)}`, { method: "GET" }, asCard),
+      create: (input, requestOptions) => request("/v1/cards", {
+        body: JSON.stringify(input),
+        headers: idempotency(requestOptions),
+        method: "POST"
+      }, asCreate),
+      delete: (id, deleteOptions) => request(`${cardPath(id)}${deleteOptions?.permanent ? "?permanent=true" : ""}`, { method: "DELETE" }, () => null),
+      duplicate: (url) => request(`/v1/cards/duplicate?${new URLSearchParams({ url }).toString()}`, { method: "GET" }, (v) => isObject(v) && typeof v.cardId === "string" ? v.cardId : null),
+      favorites: (input = {}) => request(`/v1/cards?${qs({ include: "content,metadata", ...input, favorited: true })}`, { method: "GET" }, asPage),
+      get: (id) => request(cardPath(id), { method: "GET" }, asCard),
       list: (input = {}) => request(`/v1/cards?${qs(input)}`, { method: "GET" }, asPage),
-      search: (input = {}) => request(`/v1/cards?${qs({ ...input, include: "content,metadata" })}`, { method: "GET" }, asPage),
-      setFavorite: (id, isFavorited) => request(`/v1/cards/${encodeURIComponent(id)}/favorite`, { body: JSON.stringify({ isFavorited }), method: "PATCH" }, asCard),
-      update: (id, input) => request(`/v1/cards/${encodeURIComponent(id)}`, { body: JSON.stringify(input), method: "PATCH" }, asCard)
+      restore: (id) => request(`${cardPath(id)}/restore`, { method: "POST" }, () => null),
+      search: (input = {}) => request(`/v1/cards?${qs({ include: "content,metadata", ...input })}`, { method: "GET" }, asPage),
+      setFavorite: (id, isFavorited) => request(`${cardPath(id)}/favorite`, { body: JSON.stringify({ isFavorited }), method: "PATCH" }, asCard),
+      update: (id, input) => request(cardPath(id), { body: JSON.stringify(input), method: "PATCH" }, asCard)
+    },
+    exports: {
+      latest: () => request("/v1/exports/latest", { method: "GET" }, asLatestExport),
+      start: () => request("/v1/exports", { method: "POST" }, (v) => v.job)
     },
+    me: () => request("/v1/me", { method: "GET" }, asMe),
     tags: {
       list: () => request("/v1/tags", { method: "GET" }, asTags)
     },

package/dist/types/client/sdk.d.ts

@@ -34,8 +34,13 @@ export interface Card {
     fileSize: number | null;
     fileUrl: string | null;
     id: string;
+    isDeleted: boolean;
     isFavorited: boolean;
     linkAuthor: string | null;
+    linkFacts: Array<{
+        label: string;
+        value: string;
+    }>;
     linkPreviewImageUrl: string | null;
     linkPreviewMedia: Array<{
         type: "image" | "video";
@@ -52,10 +57,12 @@ export interface Card {
     linkPublisher: string | null;
     linkSiteName: string | null;
     metadataDescription: string | null;
+    metadataStatus: string | null;
     metadataTitle: string | null;
     mimeType: string | null;
     notes: string | null;
     placeholderUrl: string | null;
+    processingStatus: Record<string, unknown> | null;
     screenshotUrl: string | null;
     tags: string[];
     thumbnailUrl: string | null;
@@ -98,9 +105,46 @@ export interface UpdateCardInput {
     content?: string;
     metadataTitle?: string | null;
     notes?: string | null;
+    /** AI tags to drop. `tags` replaces only the card's own tags. */
+    removeAiTags?: string[];
     tags?: string[];
     url?: string;
 }
+export interface Me {
+    cardCount: number;
+    /** Null on Pro, which has no card limit. */
+    cardLimit: number | null;
+    email: string;
+    id: string;
+    name?: string;
+    plan: "free" | "pro";
+    settingsUrl: string;
+}
+export interface ExportJob {
+    cardCount: number | null;
+    completedAt: number | null;
+    createdAt: number;
+    downloadUrl: string | null;
+    expiresAt: number | null;
+    failureClass: string | null;
+    filesIncluded: number | null;
+    filesOmitted: number | null;
+    id: string;
+    processedCount: number | null;
+    sizeBytes: number | null;
+    stage: "snapshotting" | "archiving" | null;
+    status: "pending" | "running" | "ready" | "failed" | "canceled" | "expired";
+    updatedAt: number;
+}
+export interface LatestExport {
+    canStartNew: boolean;
+    job: ExportJob | null;
+    nextAvailableAt: number | null;
+}
+export interface RequestOptions {
+    /** Makes a retried create or bulk request safe to repeat. */
+    idempotencyKey?: string;
+}
 export interface CreateUploadInput {
     fileName: string;
     fileSize: number;
@@ -146,11 +190,15 @@ export declare const buildCardsSearchParams: (input: {
     createdBefore?: number;
     cursor?: string;
     favorited?: boolean;
+    hex?: string | readonly string[];
+    hue?: string | readonly string[];
     include?: string;
     limit?: number;
     query?: string;
     sort?: CardSort;
+    style?: string | readonly string[];
     tag?: string;
+    trashed?: boolean;
     type?: CardType | string | readonly (CardType | string)[];
 }) => string;
 export declare const createTeakClient: (options: {
@@ -161,21 +209,32 @@ export declare const createTeakClient: (options: {
     userAgent?: string;
 }) => {
     cards: {
-        bulk: (operation: BulkCardsResponse["operation"], items: unknown[]) => Promise<BulkCardsResponse>;
+        bulk: (operation: BulkCardsResponse["operation"], items: unknown[], requestOptions?: RequestOptions) => Promise<BulkCardsResponse>;
         changes: (input: {
             cursor?: string;
             limit?: number;
             since: number;
         }) => Promise<CardChangesResponse>;
-        create: (input: CreateCardInput) => Promise<CreateCardResponse>;
-        delete: (id: string) => Promise<null>;
+        create: (input: CreateCardInput, requestOptions?: RequestOptions) => Promise<CreateCardResponse>;
+        /** Moves the card to Trash, or deletes it for good with `permanent`. */
+        delete: (id: string, deleteOptions?: {
+            permanent?: boolean;
+        }) => Promise<null>;
+        /** The ID of a saved card with exactly this URL, or null. */
+        duplicate: (url: string) => Promise<string | null>;
         favorites: (input?: Parameters<(params: Parameters<typeof buildCardsSearchParams>[0]) => string>[0]) => Promise<CardsPage>;
         get: (id: string) => Promise<Card>;
         list: (input?: Parameters<(params: Parameters<typeof buildCardsSearchParams>[0]) => string>[0]) => Promise<CardsPage>;
+        restore: (id: string) => Promise<null>;
         search: (input?: Parameters<(params: Parameters<typeof buildCardsSearchParams>[0]) => string>[0]) => Promise<CardsPage>;
         setFavorite: (id: string, isFavorited: boolean) => Promise<Card>;
         update: (id: string, input: UpdateCardInput) => Promise<Card>;
     };
+    exports: {
+        latest: () => Promise<LatestExport>;
+        start: () => Promise<ExportJob>;
+    };
+    me: () => Promise<Me>;
     tags: {
         list: () => Promise<{
             items: TagSummary[];

package/dist/types/devUrls.d.ts

@@ -1,4 +1,7 @@
+/** The shared cloud dev deployment every checkout and cloud session uses. */
+export declare const TEAK_DEV_DEPLOYMENT_NAME = "reminiscent-kangaroo-59";
 export declare const DEFAULT_TEAK_DEV_APP_URL = "http://localhost:3000";
+export declare const DEFAULT_TEAK_DEV_CONVEX_URL = "https://reminiscent-kangaroo-59.convex.cloud";
 export declare const DEFAULT_TEAK_DEV_CONVEX_SITE_URL = "https://reminiscent-kangaroo-59.convex.site";
 export declare const DEFAULT_TEAK_DEV_API_URL = "https://reminiscent-kangaroo-59.convex.site";
 export declare const DEFAULT_TEAK_DEV_DOCS_URL = "http://localhost:3001";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "teak-sdk",
-  "version": "1.0.83",
+  "version": "1.0.85",
   "description": "Teak API client and OAuth discovery for browser and Node applications.",
   "repository": {
     "type": "git",