@alienplatform/core 1.3.4 → 1.4.0

package/src/{function.ts → worker.ts}

@@ -1,76 +1,75 @@
 import {
-  type FunctionCode,
-  type Function as FunctionConfig,
-  FunctionSchema,
-  type FunctionTrigger,
   type Ingress,
   type ReadinessProbe,
   type ResourceType,
+  type WorkerCode,
+  type Worker as WorkerConfig,
+  WorkerSchema,
+  type WorkerTrigger,
 } from "./generated/index.js"
 import { Resource } from "./resource.js"
 
 export type {
   Ingress,
-  Function as FunctionConfig,
-  FunctionOutputs,
-  FunctionTrigger,
+  Worker as WorkerConfig,
+  WorkerOutputs,
+  WorkerTrigger,
   ReadinessProbe,
   HttpMethod,
 } from "./generated/index.js"
 export {
   IngressSchema,
-  FunctionSchema as FunctionConfigSchema,
-  FunctionOutputsSchema,
-  FunctionTriggerSchema,
+  WorkerSchema as WorkerConfigSchema,
+  WorkerOutputsSchema,
+  WorkerTriggerSchema,
   ReadinessProbeSchema,
   HttpMethodSchema,
 } from "./generated/index.js"
 
 /**
- * Represents a serverless function that executes code in response to triggers or direct invocations.
- * Functions are the primary compute resource in serverless applications, designed to be stateless and ephemeral.
+ * Represents a serverless worker that executes code in response to triggers or direct invocations.
+ * Workers are the primary compute resource in serverless applications, designed to be stateless and ephemeral.
  */
-// biome-ignore lint/suspicious/noShadowRestrictedNames: intentionally shadows built-in `Function`
-export class Function {
-  private _config: Partial<FunctionConfig> = {
+export class Worker {
+  private _config: Partial<WorkerConfig> = {
     links: [],
     triggers: [],
     environment: {},
   }
 
   /**
-   * Creates a new Function builder.
-   * @param id Identifier for the function. Must contain only alphanumeric characters, hyphens, and underscores ([A-Za-z0-9-_]). Maximum 64 characters.
+   * Creates a new Worker builder.
+   * @param id Identifier for the worker. Must contain only alphanumeric characters, hyphens, and underscores ([A-Za-z0-9-_]). Maximum 64 characters.
    */
   constructor(id: string) {
     this._config.id = id
   }
 
   /**
-   * Returns a ResourceType representing any function resource.
-   * Used for creating permission targets that apply to all function resources.
-   * @returns The "function" resource type.
+   * Returns a ResourceType representing any worker resource.
+   * Used for creating permission targets that apply to all worker resources.
+   * @returns The "worker" resource type.
    */
   public static any(): ResourceType {
-    return "function"
+    return "worker"
   }
 
   /**
-   * Sets the code for the function, either a pre-built image or source code to be built.
-   * @param code The function code configuration.
-   * @returns The Function builder instance.
+   * Sets the code for the worker, either a pre-built image or source code to be built.
+   * @param code The worker code configuration.
+   * @returns The Worker builder instance.
    */
-  public code(code: FunctionCode): this {
+  public code(code: WorkerCode): this {
     this._config.code = code
     return this
   }
 
   /**
-   * Sets the memory allocated to the function in megabytes (MB).
+   * Sets the memory allocated to the worker in megabytes (MB).
    * Constraints: 128‑32768 MB (platform-specific limits may apply).
    * Default: 256 MB.
    * @param mb The memory in MB.
-   * @returns The Function builder instance.
+   * @returns The Worker builder instance.
    */
   public memoryMb(mb: number): this {
     this._config.memoryMb = mb
@@ -78,11 +77,11 @@ export class Function {
   }
 
   /**
-   * Sets the maximum execution time for the function in seconds.
+   * Sets the maximum execution time for the worker in seconds.
    * Constraints: 1‑3600 seconds (platform-specific limits may apply).
    * Default: 30 seconds.
    * @param sec The timeout in seconds.
-   * @returns The Function builder instance.
+   * @returns The Worker builder instance.
    */
   public timeoutSeconds(sec: number): this {
     this._config.timeoutSeconds = sec
@@ -90,10 +89,10 @@ export class Function {
   }
 
   /**
-   * Sets the maximum number of concurrent executions allowed for the function.
+   * Sets the maximum number of concurrent executions allowed for the worker.
    * `null` means platform default applies.
    * @param limit The concurrency limit, or `null` for platform default.
-   * @returns The Function builder instance.
+   * @returns The Worker builder instance.
    */
   public concurrencyLimit(limit: number | undefined): this {
     this._config.concurrencyLimit = limit
@@ -101,13 +100,13 @@ export class Function {
   }
 
   /**
-   * Controls network accessibility of the function.
-   * - `public`: Function accessible from the internet.
-   * - `private`: Function accessible only via cloud API calls / triggers.
-   * - `vpc`: Function deployed within a VPC with specific network controls.
+   * Controls network accessibility of the worker.
+   * - `public`: Worker accessible from the internet.
+   * - `private`: Worker accessible only via cloud API calls / triggers.
+   * - `vpc`: Worker deployed within a VPC with specific network controls.
    * Default: `private`.
    * @param value The ingress type.
-   * @returns The Function builder instance.
+   * @returns The Worker builder instance.
    */
   public ingress(value: Ingress): this {
     this._config.ingress = value
@@ -115,9 +114,9 @@ export class Function {
   }
 
   /**
-   * Sets key-value pairs as environment variables for the function.
+   * Sets key-value pairs as environment variables for the worker.
    * @param env A map of environment variable names to their values.
-   * @returns The Function builder instance.
+   * @returns The Worker builder instance.
    */
   public environment(env: Record<string, string>): this {
     this._config.environment = env
@@ -125,11 +124,11 @@ export class Function {
   }
 
   /**
-   * Links another resource (e.g., Storage, KV, Queue) to this function.
-   * This makes the linked resource accessible to the function, often by injecting
+   * Links another resource (e.g., Storage, KV, Queue) to this worker.
+   * This makes the linked resource accessible to the worker, often by injecting
    * environment variables or granting permissions.
    * @param resource The resource to link.
-   * @returns The Function builder instance.
+   * @returns The Worker builder instance.
    */
   public link(resource: Resource): this {
     if (!this._config.links) {
@@ -140,11 +139,11 @@ export class Function {
   }
 
   /**
-   * Assigns a permission profile to this function.
-   * The profile defines the permissions granted to this function when interacting
+   * Assigns a permission profile to this worker.
+   * The profile defines the permissions granted to this worker when interacting
    * with other cloud resources.
    * @param permissions The permission profile name.
-   * @returns The Function builder instance.
+   * @returns The Worker builder instance.
    */
   public permissions(permissions: string): this {
     this._config.permissions = permissions
@@ -152,9 +151,9 @@ export class Function {
   }
 
   /**
-   * Configures a readiness probe for the function.
-   * The probe will be executed after provisioning/update to verify the function is ready.
-   * Only works with functions that have Public ingress.
+   * Configures a readiness probe for the worker.
+   * The probe will be executed after provisioning/update to verify the worker is ready.
+   * Only works with workers that have Public ingress.
    *
    * @example
    * ```typescript
@@ -163,7 +162,7 @@ export class Function {
    *   path: "/health"
    * };
    *
-   * const func = new Function("my-api")
+   * const func = new Worker("my-api")
    *   .code({ type: "image", image: "my-api:latest" })
    *   .ingress("public")
    *   .readinessProbe(probe)
@@ -171,7 +170,7 @@ export class Function {
    * ```
    *
    * @param probe The readiness probe configuration.
-   * @returns The Function builder instance.
+   * @returns The Worker builder instance.
    */
   public readinessProbe(probe: ReadinessProbe): this {
     this._config.readinessProbe = probe
@@ -179,11 +178,11 @@ export class Function {
   }
 
   /**
-   * Enables or disables the Commands protocol for the function.
+   * Enables or disables the Commands protocol for the worker.
    * When enabled, the runtime polls the manager for pending commands and executes registered handlers.
    * Default: false.
-   * @param enabled Whether to enable commands for this function.
-   * @returns The Function builder instance.
+   * @param enabled Whether to enable commands for this worker.
+   * @returns The Worker builder instance.
    */
   public commandsEnabled(enabled: boolean): this {
     this._config.commandsEnabled = enabled
@@ -191,24 +190,24 @@ export class Function {
   }
 
   /**
-   * Adds a trigger to the function. Functions can have multiple triggers.
-   * Each trigger will independently invoke the function when its conditions are met.
+   * Adds a trigger to the worker. Workers can have multiple triggers.
+   * Each trigger will independently invoke the worker when its conditions are met.
    *
    * @example
    * ```typescript
    * // Queue trigger
-   * const queueTrigger: FunctionTrigger = {
+   * const queueTrigger: WorkerTrigger = {
    *   type: "queue",
    *   queue: myQueue.ref()
    * };
    *
    * // Schedule trigger
-   * const scheduleTrigg: FunctionTrigger = {
+   * const scheduleTrigg: WorkerTrigger = {
    *   type: "schedule",
    *   cron: "0 * * * *"
    * };
    *
-   * const func = new Function("my-func")
+   * const func = new Worker("my-func")
    *   .code({ type: "image", image: "my-image:latest" })
    *   .trigger(queueTrigger)
    *   .trigger(scheduleTrigger)
@@ -216,9 +215,9 @@ export class Function {
    * ```
    *
    * @param trigger The trigger configuration.
-   * @returns The Function builder instance.
+   * @returns The Worker builder instance.
    */
-  public trigger(trigger: FunctionTrigger): this {
+  public trigger(trigger: WorkerTrigger): this {
     if (!this._config.triggers) {
       this._config.triggers = []
     }
@@ -227,15 +226,15 @@ export class Function {
   }
 
   /**
-   * Builds and validates the function configuration.
-   * @returns An immutable Resource representing the configured function.
-   * @throws Error if the function configuration is invalid (e.g., missing code).
+   * Builds and validates the worker configuration.
+   * @returns An immutable Resource representing the configured worker.
+   * @throws Error if the worker configuration is invalid (e.g., missing code).
    */
   public build(): Resource {
-    const config = FunctionSchema.parse(this._config)
+    const config = WorkerSchema.parse(this._config)
 
     return new Resource({
-      type: "function",
+      type: "worker",
       ...config,
     })
   }

package/src/generated/schemas/function.json

@@ -1 +0,0 @@
-{"type":"object","description":"Represents a serverless function that executes code in response to triggers or direct invocations.\nFunctions are the primary compute resource in serverless applications, designed to be stateless and ephemeral.","required":["id","links","triggers","permissions","code"],"properties":{"code":{"description":"Code for the function, either a pre-built image or source code to be built.","oneOf":[{"type":"object","description":"Container image.","required":["image","type"],"properties":{"image":{"type":"string","description":"Container image (e.g., `ghcr.io/myorg/myimage:latest`)."},"type":{"type":"string","enum":["image"]}}},{"type":"object","description":"Source code to be built.","required":["src","toolchain","type"],"properties":{"src":{"type":"string","description":"The source directory to build from"},"toolchain":{"description":"Toolchain configuration with type-safe options","oneOf":[{"type":"object","description":"Rust with Cargo build system","required":["binaryName","type"],"properties":{"binaryName":{"type":"string","description":"Name of the binary to build and run"},"type":{"type":"string","enum":["rust"]}}},{"type":"object","description":"TypeScript/JavaScript compiled to single executable with Bun","required":["type"],"properties":{"binaryName":{"type":["string","null"],"description":"Name of the compiled binary (defaults to package.json name if not specified)"},"type":{"type":"string","enum":["typescript"]}}},{"type":"object","description":"Docker build from Dockerfile","required":["type"],"properties":{"buildArgs":{"type":["object","null"],"description":"Build arguments for docker build","additionalProperties":{"type":"string"},"propertyNames":{"type":"string"}},"dockerfile":{"type":["string","null"],"description":"Dockerfile path relative to src (default: \"Dockerfile\")"},"target":{"type":["string","null"],"description":"Multi-stage build target"},"type":{"type":"string","enum":["docker"]}}}],"x-readme-ref-name":"ToolchainConfig"},"type":{"type":"string","enum":["source"]}}}],"x-readme-ref-name":"FunctionCode"},"commandsEnabled":{"type":"boolean","description":"Whether the function can receive remote commands via the Commands protocol.\nWhen enabled, the runtime polls the manager for pending commands and executes registered handlers.","default":false},"concurrencyLimit":{"type":["integer","null"],"format":"int32","description":"Maximum number of concurrent executions allowed for the function.\nNone means platform default applies.","minimum":0},"environment":{"type":"object","description":"Key-value pairs to set as environment variables for the function.","additionalProperties":{"type":"string"},"propertyNames":{"type":"string"}},"id":{"type":"string","description":"Identifier for the function. Must contain only alphanumeric characters, hyphens, and underscores ([A-Za-z0-9-_]).\nMaximum 64 characters."},"ingress":{"oneOf":[{"description":"Controls network accessibility of the function.","type":"string","enum":["public","private"],"x-readme-ref-name":"Ingress"}],"default":"private"},"links":{"type":"array","items":{"type":"object","description":"New ResourceRef that works with any resource type.\nThis can eventually replace the enum-based ResourceRef for full extensibility.","required":["type","id"],"properties":{"id":{"type":"string"},"type":{"type":"string","description":"Resource type identifier that determines the specific kind of resource. This field is used for polymorphic deserialization and resource-specific behavior.","examples":["function","storage","queue","redis","postgres"],"x-readme-ref-name":"ResourceType"}},"x-readme-ref-name":"ResourceRef"},"description":"List of resource references this function depends on."},"memoryMb":{"type":"integer","format":"int32","description":"Memory allocated to the function in megabytes (MB).\nConstraints: 128‑32768 MB (platform-specific limits may apply)\nDefault: 256","default":256,"minimum":0},"permissions":{"type":"string","description":"Permission profile name that defines the permissions granted to this function.\nThis references a profile defined in the stack's permission definitions."},"readinessProbe":{"oneOf":[{"type":"null"},{"description":"Optional readiness probe configuration.\nOnly applicable for functions with Public ingress.\nWhen configured, the probe will be executed after provisioning/update to verify the function is ready.","type":"object","properties":{"method":{"description":"HTTP method to use for the probe request.\nDefault: GET","type":"string","enum":["GET","POST","PUT","DELETE","HEAD","OPTIONS","PATCH"],"x-readme-ref-name":"HttpMethod"},"path":{"type":"string","description":"Path to request for the probe (e.g., \"/health\", \"/ready\").\nDefault: \"/\""}},"x-readme-ref-name":"ReadinessProbe"}]},"timeoutSeconds":{"type":"integer","format":"int32","description":"Maximum execution time for the function in seconds.\nConstraints: 1‑3600 seconds (platform-specific limits may apply)\nDefault: 30","default":180,"minimum":0},"triggers":{"type":"array","items":{"oneOf":[{"type":"object","description":"Function triggered by queue messages (always 1 message per invocation)","required":["queue","type"],"properties":{"queue":{"type":"object","description":"Reference to the queue resource","required":["type","id"],"properties":{"id":{"type":"string"},"type":{"type":"string","description":"Resource type identifier that determines the specific kind of resource. This field is used for polymorphic deserialization and resource-specific behavior.","examples":["function","storage","queue","redis","postgres"],"x-readme-ref-name":"ResourceType"}},"x-readme-ref-name":"ResourceRef"},"type":{"type":"string","enum":["queue"]}}},{"type":"object","description":"Function triggered by storage events (object created, deleted, etc.)","required":["storage","events","type"],"properties":{"events":{"type":"array","items":{"type":"string"},"description":"Events to trigger on (e.g., [\"created\", \"deleted\"])"},"storage":{"type":"object","description":"Reference to the storage resource","required":["type","id"],"properties":{"id":{"type":"string"},"type":{"type":"string","description":"Resource type identifier that determines the specific kind of resource. This field is used for polymorphic deserialization and resource-specific behavior.","examples":["function","storage","queue","redis","postgres"],"x-readme-ref-name":"ResourceType"}},"x-readme-ref-name":"ResourceRef"},"type":{"type":"string","enum":["storage"]}}},{"type":"object","description":"Function triggered on a schedule (cron expression)","required":["cron","type"],"properties":{"cron":{"type":"string","description":"Cron expression for scheduling (standard 5-field unix cron)"},"type":{"type":"string","enum":["schedule"]}}}],"description":"Defines what triggers a function execution","x-readme-ref-name":"FunctionTrigger"},"description":"List of triggers that define what events automatically invoke this function.\nIf empty, the function is only invokable directly via HTTP calls or platform-specific invocation APIs.\nWhen configured, the function will be automatically invoked when any of the specified trigger conditions are met."}},"additionalProperties":false,"x-readme-ref-name":"Function"}

package/src/generated/schemas/functionCode.json

@@ -1 +0,0 @@
-{"oneOf":[{"type":"object","description":"Container image.","required":["image","type"],"properties":{"image":{"type":"string","description":"Container image (e.g., `ghcr.io/myorg/myimage:latest`)."},"type":{"type":"string","enum":["image"]}}},{"type":"object","description":"Source code to be built.","required":["src","toolchain","type"],"properties":{"src":{"type":"string","description":"The source directory to build from"},"toolchain":{"description":"Toolchain configuration with type-safe options","oneOf":[{"type":"object","description":"Rust with Cargo build system","required":["binaryName","type"],"properties":{"binaryName":{"type":"string","description":"Name of the binary to build and run"},"type":{"type":"string","enum":["rust"]}}},{"type":"object","description":"TypeScript/JavaScript compiled to single executable with Bun","required":["type"],"properties":{"binaryName":{"type":["string","null"],"description":"Name of the compiled binary (defaults to package.json name if not specified)"},"type":{"type":"string","enum":["typescript"]}}},{"type":"object","description":"Docker build from Dockerfile","required":["type"],"properties":{"buildArgs":{"type":["object","null"],"description":"Build arguments for docker build","additionalProperties":{"type":"string"},"propertyNames":{"type":"string"}},"dockerfile":{"type":["string","null"],"description":"Dockerfile path relative to src (default: \"Dockerfile\")"},"target":{"type":["string","null"],"description":"Multi-stage build target"},"type":{"type":"string","enum":["docker"]}}}],"x-readme-ref-name":"ToolchainConfig"},"type":{"type":"string","enum":["source"]}}}],"description":"Specifies the source of the function's executable code.\nThis can be a pre-built container image or source code that the system will build.","x-readme-ref-name":"FunctionCode"}

package/src/generated/schemas/functionOutputs.json

@@ -1 +0,0 @@
-{"type":"object","description":"Outputs generated by a successfully provisioned Function.","required":["functionName"],"properties":{"commandsPushTarget":{"type":["string","null"],"description":"Push target for commands delivery. Platform-specific:\n- AWS: Lambda function name or ARN\n- GCP: Full Pub/Sub topic path (projects/{project}/topics/{topic})\n- Azure: Service Bus \"{namespace}/{queue}\""},"functionName":{"type":"string","description":"The name of the function."},"identifier":{"type":["string","null"],"description":"The ARN or platform-specific identifier."},"loadBalancerEndpoint":{"oneOf":[{"type":"null"},{"description":"Load balancer endpoint information for DNS management (optional).\nUsed by the DNS controller to create custom domain mappings.","type":"object","required":["dnsName"],"properties":{"dnsName":{"type":"string","description":"The DNS name of the load balancer endpoint (e.g., ALB DNS, API Gateway domain)."},"hostedZoneId":{"type":["string","null"],"description":"AWS Route53 hosted zone ID (for ALIAS records). Only set on AWS."}},"x-readme-ref-name":"LoadBalancerEndpoint"}]},"url":{"type":["string","null"],"description":"The invocation URL (if applicable, e.g., for public ingress or specific platforms)."}},"x-readme-ref-name":"FunctionOutputs"}

package/src/generated/schemas/functionTrigger.json

@@ -1 +0,0 @@
-{"oneOf":[{"type":"object","description":"Function triggered by queue messages (always 1 message per invocation)","required":["queue","type"],"properties":{"queue":{"type":"object","description":"Reference to the queue resource","required":["type","id"],"properties":{"id":{"type":"string"},"type":{"type":"string","description":"Resource type identifier that determines the specific kind of resource. This field is used for polymorphic deserialization and resource-specific behavior.","examples":["function","storage","queue","redis","postgres"],"x-readme-ref-name":"ResourceType"}},"x-readme-ref-name":"ResourceRef"},"type":{"type":"string","enum":["queue"]}}},{"type":"object","description":"Function triggered by storage events (object created, deleted, etc.)","required":["storage","events","type"],"properties":{"events":{"type":"array","items":{"type":"string"},"description":"Events to trigger on (e.g., [\"created\", \"deleted\"])"},"storage":{"type":"object","description":"Reference to the storage resource","required":["type","id"],"properties":{"id":{"type":"string"},"type":{"type":"string","description":"Resource type identifier that determines the specific kind of resource. This field is used for polymorphic deserialization and resource-specific behavior.","examples":["function","storage","queue","redis","postgres"],"x-readme-ref-name":"ResourceType"}},"x-readme-ref-name":"ResourceRef"},"type":{"type":"string","enum":["storage"]}}},{"type":"object","description":"Function triggered on a schedule (cron expression)","required":["cron","type"],"properties":{"cron":{"type":"string","description":"Cron expression for scheduling (standard 5-field unix cron)"},"type":{"type":"string","enum":["schedule"]}}}],"description":"Defines what triggers a function execution","x-readme-ref-name":"FunctionTrigger"}

package/src/generated/zod/function-schema.ts

@@ -1,43 +0,0 @@
-/**
-* Generated by Kubb (https://kubb.dev/).
-* Do not edit manually.
-*/
-
-import * as z from "zod";
-import { FunctionCodeSchema } from "./function-code-schema.js";
-import { FunctionTriggerSchema } from "./function-trigger-schema.js";
-import { IngressSchema } from "./ingress-schema.js";
-import { ReadinessProbeSchema } from "./readiness-probe-schema.js";
-import { ResourceRefSchema } from "./resource-ref-schema.js";
-
-/**
- * @description Represents a serverless function that executes code in response to triggers or direct invocations.\nFunctions are the primary compute resource in serverless applications, designed to be stateless and ephemeral.
- */
-export const FunctionSchema = z.object({
-    get "code"(){
-                return FunctionCodeSchema.describe("Specifies the source of the function's executable code.\nThis can be a pre-built container image or source code that the system will build.")
-              },
-"commandsEnabled": z.optional(z.boolean().default(false).describe("Whether the function can receive remote commands via the Commands protocol.\nWhen enabled, the runtime polls the manager for pending commands and executes registered handlers.")),
-"concurrencyLimit": z.int().min(0).describe("Maximum number of concurrent executions allowed for the function.\nNone means platform default applies.").nullish(),
-"environment": z.optional(z.object({
-    
-    }).catchall(z.string()).describe("Key-value pairs to set as environment variables for the function.")),
-"id": z.string().describe("Identifier for the function. Must contain only alphanumeric characters, hyphens, and underscores ([A-Za-z0-9-_]).\nMaximum 64 characters."),
-get "ingress"(){
-                return IngressSchema.default("private").optional()
-              },
-get "links"(){
-                return z.array(ResourceRefSchema.describe("New ResourceRef that works with any resource type.\nThis can eventually replace the enum-based ResourceRef for full extensibility.")).describe("List of resource references this function depends on.")
-              },
-"memoryMb": z.optional(z.int().min(0).default(256).describe("Memory allocated to the function in megabytes (MB).\nConstraints: 128‑32768 MB (platform-specific limits may apply)\nDefault: 256")),
-"permissions": z.string().describe("Permission profile name that defines the permissions granted to this function.\nThis references a profile defined in the stack's permission definitions."),
-get "readinessProbe"(){
-                return z.union([ReadinessProbeSchema, z.null()]).optional()
-              },
-"timeoutSeconds": z.optional(z.int().min(0).default(180).describe("Maximum execution time for the function in seconds.\nConstraints: 1‑3600 seconds (platform-specific limits may apply)\nDefault: 30")),
-get "triggers"(){
-                return z.array(FunctionTriggerSchema.describe("Defines what triggers a function execution")).describe("List of triggers that define what events automatically invoke this function.\nIf empty, the function is only invokable directly via HTTP calls or platform-specific invocation APIs.\nWhen configured, the function will be automatically invoked when any of the specified trigger conditions are met.")
-              }
-    }).describe("Represents a serverless function that executes code in response to triggers or direct invocations.\nFunctions are the primary compute resource in serverless applications, designed to be stateless and ephemeral.")
-
-export type Function = z.infer<typeof FunctionSchema>