@sylphx/sdk 0.10.3 → 0.10.5

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { SdkBillingPlan, SdkBillingSubscription, BillingCheckoutRequest, BillingCheckoutResponse, BillingPortalRequest, BillingPortalResponse, BillingBalanceResponse, BillingUsageResponse, SdkConsentType, UserConsent as UserConsent$1, AIModel as AIModel$1, GetModelsResponse, GetRateLimitResponse, GetUsageResponse, ReferralLeaderboardEntry, ReferralRewardDefaults as ReferralRewardDefaults$1, WebhookDelivery as WebhookDelivery$1, DeviceApproveRequest, DeviceApproveResponse, DeviceDenyRequest, DeviceDenyResponse, DeviceInitResponse, DeviceInitRequest, DevicePollResponse, LoginRequest as LoginRequest$1, LoginResponse as LoginResponse$1, UserFullProfile as UserFullProfile$1, LogoutInput, PlatformPasswordChangeRequest, PlatformPasswordChangeResponse, PlatformPasswordSetRequest, PlatformPasswordSetResponse, PlatformPasswordStatusResponse, RefreshTokenInput, RefreshTokenResult, PlatformSessionRenameRequest, PlatformSessionRenameResponse, PlatformSessionRevokeAllResponse, PlatformSessionRevokeRequest, PlatformSessionRevokeOtherResponse, PlatformSessionRevokeResponse, PlatformSessionsListResponse, AuthUserDeleteRequest, AuthUserDeleteResponse, AuthUserExportResponse, RegisterRequest as RegisterRequest$1, RegisterResponse as RegisterResponse$1, ResendEmailVerificationRequest as ResendEmailVerificationRequest$1, ResendEmailVerificationResponse as ResendEmailVerificationResponse$1, AuthTokensResponse, TwoFactorVerifyRequest as TwoFactorVerifyRequest$1, OAuthIntrospectResponse, PlatformAuditQueryRequest, PlatformAuditQueryResponse, PlatformRateLimitStatusRequest, PlatformRateLimitStatusResponse, PlatformRateLimitStrategiesListRequest, PlatformRateLimitStrategiesListResponse, PlatformRateLimitStrategyDeleteRequest, PlatformRateLimitStrategyDeleteResponse, PlatformRateLimitStrategyUpsertRequest, PlatformRateLimitStrategyUpsertResponse, File as File$1, UploadId, FileId, FileVersion, FileVersionId, CreateOrgInput as CreateOrgInput$1, InviteMemberInput as InviteMemberInput$1, OrgSdkRole, OrgInvitation, OrgMember, MembershipInfo, Organization, UpdateOrgInput as UpdateOrgInput$1, UserOrganizationMembership, UserOrganizationsResponse } from '@sylphx/contract';
+import { SdkBillingPlan, SdkBillingSubscription, BillingCheckoutRequest, BillingCheckoutResponse, BillingPortalRequest, BillingPortalResponse, BillingBalanceResponse, BillingUsageResponse, SdkConsentType, UserConsent as UserConsent$1, AIModel as AIModel$1, GetModelsResponse, GetRateLimitResponse, GetUsageResponse, ReferralLeaderboardEntry, ReferralRewardDefaults as ReferralRewardDefaults$1, WebhookDelivery as WebhookDelivery$1, DeviceApproveRequest, DeviceApproveResponse, DeviceDenyRequest, DeviceDenyResponse, DeviceInitResponse, DeviceInitRequest, DevicePollResponse, LoginRequest as LoginRequest$1, LoginResponse as LoginResponse$1, UserFullProfile as UserFullProfile$1, LogoutInput, PlatformPasswordChangeRequest, PlatformPasswordChangeResponse, PlatformPasswordSetRequest, PlatformPasswordSetResponse, PlatformPasswordStatusResponse, RefreshTokenInput, RefreshTokenResult, PlatformSessionRenameRequest, PlatformSessionRenameResponse, PlatformSessionRevokeAllResponse, PlatformSessionRevokeRequest, PlatformSessionRevokeOtherResponse, PlatformSessionRevokeResponse, PlatformSessionsListResponse, AuthUserDeleteRequest, AuthUserDeleteResponse, AuthUserExportResponse, RegisterRequest as RegisterRequest$1, RegisterResponse as RegisterResponse$1, ResendEmailVerificationRequest as ResendEmailVerificationRequest$1, ResendEmailVerificationResponse as ResendEmailVerificationResponse$1, AuthTokensResponse, TwoFactorVerifyRequest as TwoFactorVerifyRequest$1, OAuthIntrospectResponse, PlatformAuditQueryRequest, PlatformAuditQueryResponse, PlatformRateLimitStatusRequest, PlatformRateLimitStatusResponse, PlatformRateLimitStrategiesListRequest, PlatformRateLimitStrategiesListResponse, PlatformRateLimitStrategyDeleteRequest, PlatformRateLimitStrategyDeleteResponse, PlatformRateLimitStrategyUpsertRequest, PlatformRateLimitStrategyUpsertResponse, File as File$1, UploadId, FileId, TakedownFileRequest, TakedownFileResult, FileVersion, FileVersionId, CreateOrgInput as CreateOrgInput$1, InviteMemberInput as InviteMemberInput$1, OrgSdkRole, OrgInvitation, OrgMember, MembershipInfo, Organization, UpdateOrgInput as UpdateOrgInput$1, UserOrganizationMembership, UserOrganizationsResponse } from '@sylphx/contract';
 export { BillingBalanceResponse as BalanceResponse, BillingCheckoutRequest as CheckoutRequest, BillingCheckoutResponse as CheckoutResponse, FileId, FileVersion, FileVersionId, FileVisibility, Organization, BillingPortalRequest as PortalRequest, BillingPortalResponse as PortalResponse, SignedUrlDisposition, File as StorageFile, UploadId, BillingUsageResponse as UsageResponse } from '@sylphx/contract';
 
 /**
@@ -1782,6 +1782,8 @@ interface AccessTokenPayload {
     email_verified: boolean;
     app_id: string;
     role?: string;
+    /** Project session id when the token was minted from a BaaS auth session. */
+    sid?: string;
     iat: number;
     exp: number;
 }
@@ -3769,6 +3771,7 @@ interface CopyFileOptions {
     visibility?: 'public' | 'private';
     metadata?: Record<string, unknown>;
 }
+type TakedownFileOptions = TakedownFileRequest;
 declare function uploadsCreate(config: SylphxConfig, blob: Blob | File, options: UploadCreateOptions): Promise<File$1>;
 declare function uploadsAbort(config: SylphxConfig, uploadId: UploadId | string): Promise<void>;
 interface ListPage {
@@ -3783,6 +3786,7 @@ declare function filesDelete(config: SylphxConfig, fileId: FileId | string): Pro
     id: FileId;
     isDeleted: true;
 }>;
+declare function filesTakedown(config: SylphxConfig, fileId: FileId | string, options: TakedownFileOptions): Promise<TakedownFileResult>;
 declare function filesRestore(config: SylphxConfig, fileId: FileId | string): Promise<File$1>;
 declare function filesSignedUrl(config: SylphxConfig, fileId: FileId | string, options?: SignedUrlOptions): Promise<{
     url: string;
@@ -3822,6 +3826,7 @@ declare const storage: {
         readonly list: typeof filesList;
         readonly get: typeof filesGet;
         readonly delete: typeof filesDelete;
+        readonly takedown: typeof filesTakedown;
         readonly restore: typeof filesRestore;
         readonly signedUrl: typeof filesSignedUrl;
         readonly copy: typeof filesCopy;
@@ -3995,6 +4000,27 @@ interface PushNotification {
     icon?: string;
     url?: string;
 }
+interface PushDeliveryPlatformCounts {
+    readonly web?: number;
+    readonly ios?: number;
+    readonly android?: number;
+}
+interface SendPushWireResult {
+    readonly status?: 'delivered' | 'queued' | 'failed';
+    readonly messageId?: string;
+    readonly reason?: string;
+    readonly sent?: number;
+    readonly failed?: number;
+    readonly platforms?: PushDeliveryPlatformCounts;
+    readonly sentTo?: number;
+    readonly expired?: number;
+}
+type SendPushResult = SendPushWireResult & {
+    readonly sent: number;
+    readonly failed: number;
+    readonly sentTo: number;
+    readonly expired: number;
+};
 /**
  * Register a push subscription
  *
@@ -4039,10 +4065,7 @@ declare function unregisterPush(config: SylphxConfig, endpoint: string): Promise
  * })
  * ```
  */
-declare function sendPush(config: SylphxConfig, userId: string, notification: PushNotification): Promise<{
-    sentTo: number;
-    expired: number;
-}>;
+declare function sendPush(config: SylphxConfig, userId: string, notification: PushNotification): Promise<SendPushResult>;
 /**
  * Get push notification preferences
  *
@@ -6696,7 +6719,7 @@ interface DatabaseConnectionInfo {
     /** Database name */
     databaseName: string;
     /** Database role/user name */
-    roleName: string | null;
+    roleName: string;
     /** Database provisioning status */
     status: Exclude<DatabaseStatus, 'not_provisioned'>;
 }
@@ -6811,6 +6834,8 @@ interface KvSetRequest extends KvSetOptions {
     key: string;
     /** Value to store (any JSON-serializable value) */
     value: unknown;
+    /** @deprecated Use `ex`. Kept for compatibility with early SDK adopters. */
+    ttl?: number;
 }
 interface KvMsetRequest {
     /** Key-value pairs to set in a single atomic operation */
@@ -6886,12 +6911,14 @@ interface KvExpireRequest {
     seconds: number;
 }
 interface KvRateLimitRequest {
-    /** Rate limit identifier (e.g., userId, IP) */
-    identifier: string;
+    /** Rate limit key (e.g., userId, IP) */
+    key?: string;
+    /** @deprecated Use `key`. Kept for compatibility with early SDK adopters. */
+    identifier?: string;
     /** Maximum requests allowed in the window */
     limit: number;
     /** Window duration in seconds */
-    window: number;
+    window: number | string;
 }
 /**
  * Set a key-value pair, with optional TTL and conditional flags.
@@ -7062,9 +7089,9 @@ declare function kvZrange(config: SylphxConfig, request: KvZrangeRequest): Promi
  * ```ts
  * // 10 requests per 60 seconds per user
  * const result = await kvRateLimit(config, {
- *   identifier: `user:${userId}`,
+ *   key: `user:${userId}`,
  *   limit: 10,
- *   window: 60,
+ *   window: '60s',
  * })
  *
  * if (!result.success) {
@@ -7536,7 +7563,7 @@ interface SandboxOptions {
     createTimeoutMs?: number;
     /** Idle timeout in ms before auto-termination (default: 300_000 = 5 min) */
     idleTimeoutMs?: number;
-    /** Storage size in GiB (enables persistent PVC; default: disabled) */
+    /** Scratch storage size in GiB at /data, scoped to the sandbox lifecycle. */
     storageGi?: number;
     /** CPU/memory resource spec */
     resources?: {
@@ -7553,8 +7580,8 @@ interface SandboxOptions {
     env?: Record<string, string>;
     /**
      * Shared volume mounts from org-level managed volumes.
-     * Requires ReadWriteMany volumes (CephFS). Multiple sandboxes can mount
-     * the same volume for shared filesystem access.
+     * Use volumes created with sharing="shared" when multiple sandboxes need
+     * concurrent filesystem access.
      */
     volumeMounts?: Array<{
         /** Volume resource ID (from `sylphx volumes list`) */
@@ -7759,7 +7786,7 @@ declare class SandboxClient {
     /**
      * Create a new sandbox.
      *
-     * Platform provisions the K8s pod, waits for readiness, and returns
+     * Platform provisions the sandbox runtime, waits for readiness, and returns
      * { endpoint, token } once the sandbox is fully ready to accept traffic.
      * No client-side polling required.
      */
@@ -7845,7 +7872,7 @@ declare class SandboxClient {
  *
  * Fire-and-forget batch compute API (Modal-style run-to-completion jobs).
  *
- * Runs are ephemeral K8s Jobs that run to completion. Use them for:
+ * Runs are ephemeral isolated jobs that run to completion. Use them for:
  * - ML training folds (walk-forward cross-validation)
  * - Data processing pipelines
  * - Batch inference
@@ -7892,11 +7919,11 @@ declare class SandboxClient {
  *
  * ## Architecture
  *
- * - Workers are K8s Jobs (backoffLimit: 0, no restarts)
+ * - Workers are isolated one-shot runs (backoffLimit: 0, no restarts)
  * - Images must be from registry.sylphx.com (scanned, private)
- * - Volumes: org-level volumeResources mounted as PVCs
- *   - ReadWriteOnce → rook-ceph-block (single pod)
- *   - ReadWriteMany → rook-cephfs (concurrent pods — use for shared feature caches)
+ * - Volumes: org-level volume resources mounted into the run
+ *   - single-writer for one active writer at a time
+ *   - shared for concurrent runs and shared feature caches
  * - Auth: sk_* secret key (server-side only)
  * - Quota: 20 concurrent workers per org
  *
@@ -7954,12 +7981,12 @@ interface CreateRunOptions {
     resources?: RunResourceSpec;
     /**
      * Hard timeout in seconds (default: 3600 = 1 hour, max: 86400 = 24 hours).
-     * K8s terminates the Job when the deadline is reached (status: 'timeout').
+     * The platform terminates the run when the deadline is reached (status: 'timeout').
      */
     timeoutSeconds?: number;
     /**
      * Volume mounts from org-level volumeResources.
-     * ReadWriteMany volumes (rook-cephfs) allow concurrent access by multiple parallel workers.
+     * Shared volumes allow concurrent access by multiple parallel workers.
      */
     volumeMounts?: RunVolumeMount[];
 }
@@ -8067,7 +8094,7 @@ declare class RunHandle {
     /**
      * Fetch captured logs for this worker.
      *
-     * - For a running worker: returns live logs streamed from K8s (may be incomplete)
+     * - For a running worker: returns live logs streamed from the runtime (may be incomplete)
      * - For a completed worker: returns the full captured output stored in DB
      *
      * @example
@@ -8081,8 +8108,8 @@ declare class RunHandle {
     /**
      * Cancel this worker.
      *
-     * - If still pending: immediately cancelled (no K8s Job created)
-     * - If running: K8s Job deleted (pod terminated)
+     * - If still pending: immediately cancelled
+     * - If running: runtime is terminated
      * - If already completed: no-op
      */
     cancel(): Promise<void>;
@@ -8104,9 +8131,9 @@ declare class RunHandle {
  */
 declare const RunsClient: {
     /**
-     * Spawn a new worker (K8s Job) and return a handle.
+     * Spawn a new worker and return a handle.
      *
-     * The Job is created immediately and starts pulling the image.
+     * The run is created immediately and starts pulling the image.
      * Use the returned handle to `.wait()` for completion or `.cancel()`.
      *
      * @example
@@ -8166,9 +8193,9 @@ declare const RunsClient: {
 /** @deprecated Use RunsClient */
 declare const WorkersClient: {
     /**
-     * Spawn a new worker (K8s Job) and return a handle.
+     * Spawn a new worker and return a handle.
      *
-     * The Job is created immediately and starts pulling the image.
+     * The run is created immediately and starts pulling the image.
      * Use the returned handle to `.wait()` for completion or `.cancel()`.
      *
      * @example

package/dist/index.mjs

@@ -8138,6 +8138,7 @@ var PATHS = {
   uploadPart: (id, n) => `/storage/uploads/${encodeURIComponent(String(id))}/parts/${n}`,
   files: "/storage/files",
   file: (id) => `/storage/files/${encodeURIComponent(String(id))}`,
+  fileTakedown: (id) => `/storage/files/${encodeURIComponent(String(id))}:takedown`,
   fileRestore: (id) => `/storage/files/${encodeURIComponent(String(id))}:restore`,
   fileSignedUrl: (id) => `/storage/files/${encodeURIComponent(String(id))}:signedUrl`,
   fileCopy: (id) => `/storage/files/${encodeURIComponent(String(id))}:copy`,
@@ -8462,6 +8463,12 @@ async function filesGet(config, fileId) {
 async function filesDelete(config, fileId) {
   return callApi(config, PATHS.file(fileId), { method: "DELETE" });
 }
+async function filesTakedown(config, fileId, options) {
+  return callApi(config, PATHS.fileTakedown(fileId), {
+    method: "POST",
+    body: options
+  });
+}
 async function filesRestore(config, fileId) {
   return callApi(config, PATHS.fileRestore(fileId), { method: "POST" });
 }
@@ -8506,6 +8513,7 @@ var storage = {
     list: filesList,
     get: filesGet,
     delete: filesDelete,
+    takedown: filesTakedown,
     restore: filesRestore,
     signedUrl: filesSignedUrl,
     copy: filesCopy,
@@ -8668,6 +8676,16 @@ async function registerPushServiceWorker(swPath = "/sw.js") {
 }
 
 // src/notifications.ts
+function resolveSentCount(result) {
+  if (result.sent !== void 0) return result.sent;
+  if (result.sentTo !== void 0) return result.sentTo;
+  return result.status === "delivered" ? 1 : 0;
+}
+function resolveFailedCount(result) {
+  if (result.failed !== void 0) return result.failed;
+  if (result.expired !== void 0) return result.expired;
+  return result.status === "failed" ? 1 : 0;
+}
 async function registerPush(config, subscription) {
   await callApi(config, "/notifications/register", {
     method: "POST",
@@ -8688,10 +8706,19 @@ async function sendPush(config, userId, notification) {
     ...notification.icon !== void 0 && { icon: notification.icon },
     ...notification.url !== void 0 && { url: notification.url }
   };
-  return callApi(config, "/notifications/send", {
+  const result = await callApi(config, "/notifications/send", {
     method: "POST",
     body
   });
+  const sent = resolveSentCount(result);
+  const failed = resolveFailedCount(result);
+  return {
+    ...result,
+    sent,
+    failed,
+    sentTo: result.sentTo ?? sent,
+    expired: result.expired ?? failed
+  };
 }
 async function getPushPreferences(config) {
   return callApi(config, "/notifications/preferences", { method: "GET" });
@@ -9724,13 +9751,39 @@ function interpolatePath2(template, params) {
   }
   return path;
 }
+var KV_PATHS = {
+  mset: "/kv/mset",
+  mget: "/kv/mget",
+  hset: "/kv/hset",
+  hget: "/kv/hget",
+  hgetall: "/kv/hgetall",
+  lpush: "/kv/lpush",
+  lrange: "/kv/lrange",
+  zadd: "/kv/zadd",
+  zrange: "/kv/zrange"
+};
+function toLegacyOkResult(result) {
+  if (result.success !== void 0) return { ok: result.success };
+  if (result.ok !== void 0) return { ok: result.ok };
+  return { ok: false };
+}
+function resolveCreatedCount(result) {
+  if (result.created !== void 0) return result.created;
+  if (result.count !== void 0) return result.count;
+  return 0;
+}
 async function kvSet(config, request) {
-  const body = request;
+  const { ttl, ...rest } = request;
+  const body = {
+    ...rest,
+    ...rest.ex === void 0 && ttl !== void 0 ? { ex: ttl } : {}
+  };
   const endpoint = kvEndpoints.set;
-  return callApi(config, endpoint.path, {
+  const result = await callApi(config, endpoint.path, {
     method: endpoint.method,
     body
   });
+  return toLegacyOkResult(result);
 }
 async function kvGet(config, key) {
   const endpoint = kvEndpoints.get;
@@ -9756,10 +9809,11 @@ async function kvExists(config, key) {
 async function kvExpire(config, request) {
   const body = request;
   const endpoint = kvEndpoints.expire;
-  return callApi(config, endpoint.path, {
+  const result = await callApi(config, endpoint.path, {
     method: endpoint.method,
     body
   });
+  return toLegacyOkResult(result);
 }
 async function kvIncr(config, request) {
   const body = request;
@@ -9770,66 +9824,88 @@ async function kvIncr(config, request) {
   });
 }
 async function kvMset(config, request) {
-  return callApi(config, "/sdk/kv/mset", {
+  const result = await callApi(config, KV_PATHS.mset, {
     method: "POST",
     body: request
   });
+  return toLegacyOkResult(result);
 }
 async function kvMget(config, request) {
-  const result = await callApi(config, "/sdk/kv/mget", {
-    method: "POST",
-    body: request
-  });
-  return result.values;
+  const result = await callApi(
+    config,
+    KV_PATHS.mget,
+    {
+      method: "POST",
+      body: request
+    }
+  );
+  const values = result.values;
+  if (Array.isArray(values)) {
+    return values;
+  }
+  return request.keys.map((key) => values[key] ?? null);
 }
 async function kvHset(config, request) {
-  return callApi(config, "/sdk/kv/hset", {
+  const result = await callApi(config, KV_PATHS.hset, {
     method: "POST",
     body: request
   });
+  return { count: resolveCreatedCount(result) };
 }
 async function kvHget(config, request) {
-  const result = await callApi(config, "/sdk/kv/hget", {
+  const result = await callApi(config, KV_PATHS.hget, {
     method: "POST",
     body: request
   });
   return result.value;
 }
 async function kvHgetall(config, request) {
-  const result = await callApi(config, "/sdk/kv/hgetall", {
+  const result = await callApi(config, KV_PATHS.hgetall, {
     method: "POST",
     body: request
   });
-  return result.value;
+  if (result.fields !== void 0) return result.fields;
+  if (result.value !== void 0) return result.value;
+  return null;
 }
 async function kvLpush(config, request) {
-  return callApi(config, "/sdk/kv/lpush", {
+  return callApi(config, KV_PATHS.lpush, {
     method: "POST",
     body: request
   });
 }
 async function kvLrange(config, request) {
-  const result = await callApi(config, "/sdk/kv/lrange", {
+  const result = await callApi(config, KV_PATHS.lrange, {
     method: "POST",
     body: request
   });
-  return result.items;
+  if (result.values !== void 0) return result.values;
+  if (result.items !== void 0) return result.items;
+  return [];
 }
 async function kvZadd(config, request) {
-  return callApi(config, "/sdk/kv/zadd", {
+  return callApi(config, KV_PATHS.zadd, {
     method: "POST",
     body: request
   });
 }
 async function kvZrange(config, request) {
-  const result = await callApi(config, "/sdk/kv/zrange", {
+  const result = await callApi(config, KV_PATHS.zrange, {
     method: "POST",
     body: request
   });
   return result.members;
 }
 async function kvRateLimit(config, request) {
-  const body = request;
+  const key = request.key ?? request.identifier;
+  if (!key) {
+    throw new Error("kvRateLimit requires `key`");
+  }
+  const body = {
+    key,
+    limit: request.limit,
+    window: typeof request.window === "number" ? `${request.window}s` : request.window
+  };
   const endpoint = kvEndpoints.rateLimit;
   return callApi(config, endpoint.path, {
     method: endpoint.method,
@@ -10183,7 +10259,7 @@ var SandboxClient = class _SandboxClient {
   /**
    * Create a new sandbox.
    *
-   * Platform provisions the K8s pod, waits for readiness, and returns
+   * Platform provisions the sandbox runtime, waits for readiness, and returns
    * { endpoint, token } once the sandbox is fully ready to accept traffic.
    * No client-side polling required.
    */
@@ -10472,7 +10548,7 @@ var RunHandle = class {
   /**
    * Fetch captured logs for this worker.
    *
-   * - For a running worker: returns live logs streamed from K8s (may be incomplete)
+   * - For a running worker: returns live logs streamed from the runtime (may be incomplete)
    * - For a completed worker: returns the full captured output stored in DB
    *
    * @example
@@ -10491,8 +10567,8 @@ var RunHandle = class {
   /**
    * Cancel this worker.
    *
-   * - If still pending: immediately cancelled (no K8s Job created)
-   * - If running: K8s Job deleted (pod terminated)
+   * - If still pending: immediately cancelled
+   * - If running: runtime is terminated
    * - If already completed: no-op
    */
   async cancel() {
@@ -10504,9 +10580,9 @@ var RunsClient = {
   // Run
   // --------------------------------------------------------------------------
   /**
-   * Spawn a new worker (K8s Job) and return a handle.
+   * Spawn a new worker and return a handle.
    *
-   * The Job is created immediately and starts pulling the image.
+   * The run is created immediately and starts pulling the image.
    * Use the returned handle to `.wait()` for completion or `.cancel()`.
    *
    * @example