@alienplatform/sdk 1.14.1 → 2.0.0

package/src/types.ts

@@ -1,397 +0,0 @@
-/**
- * Common types for the Alien bindings SDK.
- */
-
-// Re-export build types from core
-export type { BuildStatus, ComputeType } from "@alienplatform/core"
-
-/**
- * Branded type for binding names.
- */
-export type BindingName = string & { readonly __brand: unique symbol }
-
-// ============================================================================
-// Storage Types
-// ============================================================================
-
-/**
- * Options for storage get operations.
- */
-export interface StorageGetOptions {
-  /** Range start offset in bytes */
-  rangeStart?: number
-  /** Range end offset in bytes */
-  rangeEnd?: number
-  /** If-Match header value (ETag) */
-  ifMatch?: string
-  /** If-None-Match header value (ETag) */
-  ifNoneMatch?: string
-  /** If-Modified-Since timestamp */
-  ifModifiedSince?: Date
-  /** If-Unmodified-Since timestamp */
-  ifUnmodifiedSince?: Date
-}
-
-/**
- * Options for storage put operations.
- */
-export interface StoragePutOptions {
-  /** Content type of the object */
-  contentType?: string
-  /** Custom metadata */
-  metadata?: Record<string, string>
-  /** Only write if the object doesn't already exist */
-  ifNotExists?: boolean
-}
-
-/**
- * Object metadata from storage.
- */
-export interface StorageObjectMeta {
-  /** Full path of the object */
-  location: string
-  /** Last modified timestamp */
-  lastModified?: Date
-  /** Object size in bytes */
-  size: number
-  /** ETag (entity tag) for the object */
-  etag?: string
-  /** Object version */
-  version?: string
-}
-
-/**
- * Result of a storage get operation.
- */
-export interface StorageGetResult {
-  /** Object metadata */
-  meta: StorageObjectMeta
-  /** Object data as bytes */
-  data: Uint8Array
-}
-
-/**
- * Result of a storage list operation with delimiter.
- */
-export interface StorageListResult {
-  /** Common prefixes (directories) */
-  commonPrefixes: string[]
-  /** Object metadata entries */
-  objects: StorageObjectMeta[]
-}
-
-/**
- * Options for signed URL generation.
- */
-export interface SignedUrlOptions {
-  /** Operation type: get (download), put (upload), or delete */
-  operation: "get" | "put" | "delete"
-  /** URL expiration duration in seconds */
-  expiresInSeconds?: number
-  /** Content type for put operations */
-  contentType?: string
-}
-
-/**
- * Result of signed URL generation.
- */
-export interface SignedUrlResult {
-  /** The signed URL */
-  url: string
-  /** Headers that must be included when using the signed URL */
-  headers?: Record<string, string>
-  /** URL expiration timestamp */
-  expiresAt?: Date
-}
-
-// ============================================================================
-// KV Types
-// ============================================================================
-
-/**
- * Options for KV put operations.
- */
-export interface KvPutOptions {
-  /** Time-to-live in milliseconds */
-  ttlMs?: number
-  /** Only write if the key doesn't exist */
-  ifNotExists?: boolean
-}
-
-/**
- * Result of a KV scan operation.
- */
-export interface KvScanResult {
-  /** Key-value pairs */
-  items: Array<{ key: string; value: Uint8Array }>
-  /** Cursor for next page */
-  nextCursor?: string
-}
-
-// ============================================================================
-// Queue Types
-// ============================================================================
-
-/**
- * A message received from a queue via the Queue binding.
- * (Not to be confused with QueueMessage from @alienplatform/core which is used for event handlers)
- */
-export interface ReceivedQueueMessage<T = unknown> {
-  /** Message payload */
-  payload: T
-  /** Receipt handle for acknowledgment */
-  receiptHandle: string
-}
-
-// ============================================================================
-// Build Types
-// ============================================================================
-
-// BuildStatus and ComputeType are re-exported from @alienplatform/core above
-
-/**
- * Configuration for starting a build via the Build binding.
- * (SDK-specific - different from BuildConfig in core which is for resource definition)
- */
-export interface BuildStartConfig {
-  /** Build script to execute */
-  script: string
-  /** Environment variables */
-  environment?: Record<string, string>
-  /** Compute type */
-  computeType?: import("@alienplatform/core").ComputeType
-  /** Timeout in seconds */
-  timeoutSeconds?: number
-  /** Monitoring configuration */
-  monitoring?: {
-    endpoint: string
-    headers?: Record<string, string>
-    logsUri?: string
-    tlsEnabled?: boolean
-    tlsVerify?: boolean
-  }
-}
-
-/**
- * Information about a build execution.
- */
-export interface BuildExecution {
-  /** Build execution ID */
-  id: string
-  /** Current status */
-  status: import("@alienplatform/core").BuildStatus
-  /** Start timestamp */
-  startTime?: Date
-  /** End timestamp */
-  endTime?: Date
-}
-
-// ============================================================================
-// Artifact Registry Types
-// ============================================================================
-
-/**
- * Permission levels for artifact registry access.
- */
-export type ArtifactRegistryPermissions = "pull" | "push-pull"
-
-/**
- * Information about a repository.
- */
-export interface RepositoryInfo {
-  /** Repository name */
-  name: string
-  /** Repository URI */
-  uri: string
-  /** Creation timestamp */
-  createdAt?: Date
-}
-
-/**
- * How the registry expects credentials to be presented.
- * - "basic": HTTP Basic auth (ECR, GAR, Local)
- * - "bearer": HTTP Bearer token (ACR)
- */
-export type RegistryAuthMethod = "basic" | "bearer"
-
-/**
- * Credentials for repository access.
- */
-export interface ArtifactRegistryCredentials {
-  /** How to present these credentials to the registry */
-  authMethod: RegistryAuthMethod
-  /** Username for authentication */
-  username: string
-  /** Password/token for authentication */
-  password: string
-  /** Credential expiration timestamp */
-  expiresAt?: Date
-}
-
-/**
- * Types of compute services that can have cross-account access.
- */
-export type ComputeServiceType = "worker"
-
-/**
- * AWS-specific cross-account access configuration.
- */
-export interface AwsCrossAccountAccess {
-  /** AWS account IDs that should have access */
-  accountIds: string[]
-  /** Types of compute services that should have access */
-  allowedServiceTypes: ComputeServiceType[]
-  /** Specific IAM role ARNs to grant access to */
-  roleArns: string[]
-  /** AWS regions where target Lambda workers run (for sourceArn condition) */
-  regions: string[]
-}
-
-/**
- * GCP-specific cross-account access configuration.
- */
-export interface GcpCrossAccountAccess {
-  /** GCP project numbers that should have access */
-  projectNumbers: string[]
-  /** Types of compute services that should have access */
-  allowedServiceTypes: ComputeServiceType[]
-  /** Additional service account emails to grant access to */
-  serviceAccountEmails: string[]
-}
-
-/**
- * Cross-account access configuration (discriminated union).
- */
-export type CrossAccountAccess =
-  | { type: "aws"; aws: AwsCrossAccountAccess }
-  | { type: "gcp"; gcp: GcpCrossAccountAccess }
-
-/**
- * Current cross-account access permissions.
- */
-export interface CrossAccountPermissions {
-  /** Platform-specific access configuration */
-  access: CrossAccountAccess
-  /** Timestamp when permissions were last updated (ISO8601 format) */
-  lastUpdated?: string
-}
-
-// ============================================================================
-// Worker Types
-// ============================================================================
-
-/**
- * Request for worker invocation.
- */
-export interface WorkerInvokeRequest {
-  /** Target worker identifier */
-  targetWorker: string
-  /** HTTP method */
-  method: string
-  /** Request path */
-  path: string
-  /** Request headers */
-  headers?: Record<string, string>
-  /** Request body */
-  body?: Uint8Array
-  /** Timeout in milliseconds */
-  timeoutMs?: number
-}
-
-/**
- * Response from worker invocation.
- */
-export interface WorkerInvokeResponse {
-  /** HTTP status code */
-  status: number
-  /** Response headers */
-  headers: Record<string, string>
-  /** Response body */
-  body: Uint8Array
-}
-
-// ============================================================================
-// Service Account Types
-// ============================================================================
-
-/**
- * AWS service account information.
- */
-export interface AwsServiceAccountInfo {
-  platform: "aws"
-  roleName: string
-  roleArn: string
-}
-
-/**
- * GCP service account information.
- */
-export interface GcpServiceAccountInfo {
-  platform: "gcp"
-  email: string
-  uniqueId: string
-}
-
-/**
- * Azure service account information.
- */
-export interface AzureServiceAccountInfo {
-  platform: "azure"
-  clientId: string
-  resourceId: string
-  principalId: string
-}
-
-/**
- * Platform-specific service account information.
- */
-export type ServiceAccountInfo =
-  | AwsServiceAccountInfo
-  | GcpServiceAccountInfo
-  | AzureServiceAccountInfo
-
-/**
- * Request for service account impersonation.
- */
-export interface ImpersonationRequest {
-  /** Session name for AWS */
-  sessionName?: string
-  /** Duration in seconds */
-  durationSeconds?: number
-  /** OAuth scopes for GCP */
-  scopes?: string[]
-}
-
-// ============================================================================
-// Configuration Types
-// ============================================================================
-
-/**
- * Configuration for connecting to the Alien bindings server.
- */
-export interface AlienBindingsConfig {
-  /** gRPC server address */
-  grpcAddress?: string
-}
-
-/**
- * Interface for the bindings provider.
- */
-export interface AlienBindingsProvider {
-  /** Get a storage binding */
-  storage(name: string): import("./bindings/storage.js").Storage
-  /** Get a KV binding */
-  kv(name: string): import("./bindings/kv.js").Kv
-  /** Get a queue binding */
-  queue(name: string): import("./bindings/queue.js").Queue
-  /** Get a vault binding */
-  vault(name: string): import("./bindings/vault.js").Vault
-  /** Get a build binding */
-  build(name: string): import("./bindings/build.js").Build
-  /** Get an artifact registry binding */
-  artifactRegistry(name: string): import("./bindings/artifact-registry.js").ArtifactRegistry
-  /** Get a worker binding */
-  worker(name: string): import("./bindings/worker.js").WorkerBinding
-  /** Get a service account binding */
-  serviceAccount(name: string): import("./bindings/service-account.js").ServiceAccount
-}

package/src/wait-until.ts

@@ -1,273 +0,0 @@
-/**
- * WaitUntil functionality for background task management.
- *
- * Allows workers to continue running after the response has been sent.
- */
-
-import { type Channel, createClient } from "nice-grpc"
-import { getChannel } from "./channel.js"
-import {
-  type WaitUntilServiceClient as GeneratedClient,
-  WaitUntilServiceDefinition,
-} from "./generated/wait_until.js"
-import { wrapGrpcCall } from "./grpc-utils.js"
-
-/**
- * Task tracker for managing background tasks.
- */
-export interface TaskTracker {
-  /** Unique task ID */
-  id: string
-  /** Task promise */
-  promise: Promise<unknown>
-  /** When the task was registered */
-  registeredAt: Date
-  /** Whether the task has completed */
-  completed: boolean
-  /** Error if the task failed */
-  error?: Error
-}
-
-// Internal storage for tracked tasks
-const tasks: Map<string, TaskTracker> = new Map()
-let taskIdCounter = 0
-
-/**
- * WaitUntil manager for coordinating background tasks with the runtime.
- *
- * @internal
- */
-export class WaitUntilManager {
-  private readonly client: GeneratedClient
-  private readonly applicationId: string
-
-  constructor(channel: Channel, applicationId: string) {
-    this.client = createClient(WaitUntilServiceDefinition, channel)
-    this.applicationId = applicationId
-  }
-
-  /**
-   * Register a background task.
-   *
-   * @param promise - The promise to track
-   * @param description - Optional task description for debugging
-   * @returns Task tracker
-   */
-  async register(promise: Promise<unknown>, description?: string): Promise<TaskTracker> {
-    const id = `task-${++taskIdCounter}`
-    const registeredAt = new Date()
-
-    const tracker: TaskTracker = {
-      id,
-      promise,
-      registeredAt,
-      completed: false,
-    }
-
-    tasks.set(id, tracker)
-
-    // Notify the runtime about the new task
-    await wrapGrpcCall(
-      "WaitUntilService",
-      "NotifyTaskRegistered",
-      async () => {
-        await this.client.notifyTaskRegistered({
-          applicationId: this.applicationId,
-          taskDescription: description,
-        })
-      },
-      {},
-    )
-
-    // Track completion
-    promise
-      .then(() => {
-        tracker.completed = true
-      })
-      .catch(error => {
-        tracker.completed = true
-        tracker.error = error instanceof Error ? error : new Error(String(error))
-      })
-
-    return tracker
-  }
-
-  /**
-   * Wait for all background tasks to complete.
-   *
-   * Called during drain to ensure all tasks finish before shutdown.
-   */
-  async waitForAll(): Promise<void> {
-    const pending = Array.from(tasks.values())
-      .filter(t => !t.completed)
-      .map(t => t.promise.catch(() => {}))
-
-    await Promise.all(pending)
-  }
-
-  /**
-   * Get the current task count.
-   */
-  async getTaskCount(): Promise<number> {
-    return await wrapGrpcCall(
-      "WaitUntilService",
-      "GetTaskCount",
-      async () => {
-        const response = await this.client.getTaskCount({
-          applicationId: this.applicationId,
-        })
-        return response.taskCount
-      },
-      {},
-    )
-  }
-
-  /**
-   * Wait for a drain signal from the runtime.
-   *
-   * This blocks until the runtime signals that it's time to drain.
-   */
-  async waitForDrainSignal(): Promise<{
-    shouldDrain: boolean
-    drainReason: string
-  }> {
-    return await wrapGrpcCall(
-      "WaitUntilService",
-      "WaitForDrainSignal",
-      async () => {
-        const response = await this.client.waitForDrainSignal({
-          applicationId: this.applicationId,
-          timeout: undefined,
-        })
-        return {
-          shouldDrain: response.shouldDrain,
-          drainReason: response.drainReason,
-        }
-      },
-      {},
-    )
-  }
-
-  /**
-   * Notify the runtime that drain is complete.
-   *
-   * @param tasksDrained - Number of tasks that were drained
-   * @param success - Whether all tasks completed successfully
-   * @param errorMessage - Optional error message if draining failed
-   */
-  async notifyDrainComplete(
-    tasksDrained: number,
-    success: boolean,
-    errorMessage?: string,
-  ): Promise<void> {
-    await wrapGrpcCall(
-      "WaitUntilService",
-      "NotifyDrainComplete",
-      async () => {
-        await this.client.notifyDrainComplete({
-          applicationId: this.applicationId,
-          tasksDrained,
-          success,
-          errorMessage,
-        })
-      },
-      {},
-    )
-  }
-
-  /**
-   * Get all tracked tasks.
-   */
-  getTasks(): Map<string, TaskTracker> {
-    return tasks
-  }
-
-  /**
-   * Clear all completed tasks.
-   */
-  clearCompleted(): void {
-    for (const [id, tracker] of tasks) {
-      if (tracker.completed) {
-        tasks.delete(id)
-      }
-    }
-  }
-}
-
-// Global wait-until manager instance
-let globalManager: WaitUntilManager | undefined
-
-/**
- * Initialize the global wait-until manager.
- *
- * @internal
- */
-export function initWaitUntilManager(channel: Channel, applicationId: string): WaitUntilManager {
-  globalManager = new WaitUntilManager(channel, applicationId)
-  return globalManager
-}
-
-/**
- * Get the global wait-until manager.
- *
- * @internal
- */
-export function getWaitUntilManager(): WaitUntilManager | undefined {
-  return globalManager
-}
-
-/**
- * Register a background task to continue after the response.
- *
- * This allows your function to return a response while continuing
- * to do work in the background. The runtime will wait for all
- * registered tasks to complete before shutting down.
- *
- * @param promise - The promise to track
- *
- * @example
- * ```typescript
- * import { waitUntil } from "@alienplatform/sdk"
- *
- * export default {
- *   async fetch(request: Request): Promise<Response> {
- *     const data = await request.json()
- *
- *     // Start background work
- *     waitUntil(sendAnalytics(data))
- *     waitUntil(updateCache(data))
- *
- *     // Return immediately
- *     return Response.json({ status: "accepted" })
- *   }
- * }
- * ```
- */
-export function waitUntil(promise: Promise<unknown>): void {
-  // Lazily initialize the global manager on first use. This handles
-  // HTTP-only apps (e.g. Hono) that never call ctx.run() but still
-  // need background tasks to be tracked by the runtime.
-  if (!globalManager) {
-    getChannel()
-      .then(channel => {
-        if (!globalManager) {
-          globalManager = new WaitUntilManager(channel, `app-${process.pid}`)
-        }
-        globalManager.register(promise).catch(error => {
-          console.error("Failed to register background task:", error)
-        })
-      })
-      .catch(() => {
-        // No gRPC channel available (not running in alien-runtime).
-        // Track locally as best-effort.
-        promise.catch(error => {
-          console.error("Background task failed:", error)
-        })
-      })
-    return
-  }
-
-  globalManager.register(promise).catch(error => {
-    console.error("Failed to register background task:", error)
-  })
-}

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "@alienplatform/typescript-config/base.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": "./src"
-  },
-  "include": ["src/**/*"]
-}

package/tsdown.config.ts

@@ -1,17 +0,0 @@
-import { defineConfig } from "tsdown"
-
-export default defineConfig({
-  entry: ["src/index.ts", "src/commands/index.ts"],
-  // Use tsc for declaration files instead of tsdown's built-in dts.
-  // With two entry points that share types, tsdown's rolldown-based dts
-  // generation code-splits the .d.ts output, putting shared types into
-  // index.d.ts (as a chunk with minified names) and the actual main entry
-  // types into index2.d.ts. This breaks the package.json "types" field.
-  dts: false,
-  hash: false,
-  ignoreWatch: ".turbo",
-  // Bundle all dependencies so the package is self-contained.
-  // This allows bun build --compile to work without needing
-  // transitive dependencies installed in the user's project.
-  noExternal: [/.*/],
-})