stacktape 3.5.7 → 3.6.0-beta.0

package/ai-docs/config-ref/state-machine.md

@@ -0,0 +1,235 @@
+---
+docType: config-ref
+title: State Machine
+resourceType: state-machine
+tags:
+  - state-machine
+  - step-functions
+  - stepfunctions
+  - workflow
+source: types/stacktape-config/state-machines.d.ts
+priority: 1
+---
+
+# State Machine
+
+Visual workflow engine for orchestrating Lambda functions, API calls, and other AWS services.
+
+Define multi-step workflows with branching, retries, parallel execution, and error handling —
+all without writing orchestration code. Pay per state transition (~$0.025/1,000 transitions).
+Defined using [Amazon States Language (ASL)](https://states-language.net/spec.html).
+
+Resource type: `state-machine`
+
+## TypeScript Definition
+
+```typescript
+/**
+ * #### Visual workflow engine for orchestrating Lambda functions, API calls, and other AWS services.
+ *
+ * ---
+ *
+ * Define multi-step workflows with branching, retries, parallel execution, and error handling —
+ * all without writing orchestration code. Pay per state transition (~$0.025/1,000 transitions).
+ * Defined using [Amazon States Language (ASL)](https://states-language.net/spec.html).
+ */
+interface StateMachine {
+  type: 'state-machine';
+  properties: StateMachineProps;
+  overrides?: ResourceOverrides;
+}
+
+interface StateMachineProps {
+  /**
+   * #### The workflow definition in [Amazon States Language (ASL)](https://states-language.net/spec.html).
+   */
+  definition: StateMachineDefinition;
+}
+interface StateMachineDefinition {
+  /**
+   * #### A human-readable description of the state machine.
+   */
+  Comment?: string;
+  /**
+   * #### The name of the state to start the execution at.
+   */
+  StartAt: string;
+  /**
+   * #### An object containing the states of the state machine.
+   */
+  States: {
+    [k: string]: State;
+  };
+  /**
+   * #### The version of the Amazon States Language.
+   */
+  Version?: string;
+  /**
+   * #### The maximum time, in seconds, that a state machine can run.
+   */
+  TimeoutSeconds?: number;
+}
+
+interface Choice {
+  Type: string;
+  Next?: string;
+  End?: true;
+  Comment?: string;
+  OutputPath?: string | null;
+  InputPath?: string | null;
+  Choices: Operator[];
+  Default?: string;
+}
+interface Operator {
+  Variable?: string;
+  Next?: string;
+  And?: Operator[];
+  Or?: Operator[];
+  Not?: Operator;
+  BooleanEquals?: boolean;
+  NumericEquals?: number;
+  NumericGreaterThan?: number;
+  NumericGreaterThanEquals?: number;
+  NumericLessThan?: number;
+  NumericLessThanEquals?: number;
+  StringEquals?: string;
+  StringGreaterThan?: string;
+  StringGreaterThanEquals?: string;
+  StringLessThan?: string;
+  StringLessThanEquals?: string;
+  TimestampEquals?: string;
+  TimestampGreaterThan?: string;
+  TimestampGreaterThanEquals?: string;
+  TimestampLessThan?: string;
+  TimestampLessThanEquals?: string;
+  [k: string]: any;
+}
+
+interface Fail {
+  Type: string;
+  Comment?: string;
+  OutputPath?: string | null;
+  InputPath?: string | null;
+  Cause?: string;
+  Error?: string;
+}
+
+interface StateMachineMap {
+  Type: string;
+  Next?: string;
+  End?: true;
+  Comment?: string;
+  OutputPath?: string | null;
+  InputPath?: string | null;
+  ResultPath?: string | null;
+  ItemsPath?: string | null;
+  MaxConcurrency?: number;
+  Iterator: StpStateMachine;
+  Parameters?: {
+    [k: string]: any;
+  };
+  Retry?: {
+    ErrorEquals: string[];
+    IntervalSeconds?: number;
+    MaxAttempts?: number;
+    BackoffRate?: number;
+    [k: string]: any;
+  }[];
+  Catch?: {
+    ErrorEquals: string[];
+    Next: string;
+    [k: string]: any;
+  }[];
+}
+
+interface Parallel {
+  Type: string;
+  Next?: string;
+  End?: true;
+  Comment?: string;
+  OutputPath?: string | null;
+  InputPath?: string | null;
+  ResultPath?: string | null;
+  Branches: StpStateMachine[];
+  Retry?: {
+    ErrorEquals: string[];
+    IntervalSeconds?: number;
+    MaxAttempts?: number;
+    BackoffRate?: number;
+    [k: string]: any;
+  }[];
+  Catch?: {
+    ErrorEquals: string[];
+    Next: string;
+    [k: string]: any;
+  }[];
+}
+
+interface Pass {
+  Type: string;
+  Next?: string;
+  End?: true;
+  Comment?: string;
+  OutputPath?: string | null;
+  InputPath?: string | null;
+  ResultPath?: string;
+  Parameters?: {
+    [k: string]: any;
+  };
+  Result?: any;
+}
+
+type State = Choice | Fail | Parallel | Pass | Succeed | Task | Wait | StateMachineMap;
+
+interface Succeed {
+  Type: string;
+  Comment?: string;
+}
+
+interface Task {
+  Type: string;
+  Next?: string;
+  End?: true;
+  Comment?: string;
+  OutputPath?: string | null;
+  InputPath?: string | null;
+  Resource:
+    | string
+    | {
+        [k: string]: any;
+      };
+  ResultPath?: string | null;
+  Retry?: {
+    ErrorEquals: string[];
+    IntervalSeconds?: number;
+    MaxAttempts?: number;
+    BackoffRate?: number;
+    [k: string]: any;
+  }[];
+  Catch?: {
+    ErrorEquals: string[];
+    Next: string;
+    [k: string]: any;
+  }[];
+  TimeoutSeconds?: number;
+  HeartbeatSeconds?: number;
+  Parameters?: {
+    [k: string]: any;
+  };
+}
+
+interface Wait {
+  Type: string;
+  Next?: string;
+  End?: true;
+  Comment?: string;
+  OutputPath?: string | null;
+  InputPath?: string | null;
+  Seconds?: number;
+  Timestamp?: string;
+  SecondsPath?: string | null;
+  TimestampPath?: string | null;
+}
+
+type StateMachineReferencableParam = 'arn' | 'name';
+```

package/ai-docs/config-ref/sveltekit-web.md

@@ -0,0 +1,81 @@
+---
+docType: config-ref
+title: Svelte Kit Web
+resourceType: sveltekit-web
+tags:
+  - sveltekit-web
+  - sveltekit
+  - svelte
+source: types/stacktape-config/sveltekit-web.d.ts
+priority: 1
+---
+
+# Svelte Kit Web
+
+Deploy a SvelteKit SSR app with Lambda (AWS adapter), S3 for static assets, and CloudFront CDN.
+
+For static-only SvelteKit sites, use `hosting-bucket` with `hostingContentType: 'sveltekit-static-website'` instead.
+
+Resource type: `sveltekit-web`
+
+## TypeScript Definition
+
+```typescript
+/**
+ * #### Deploy a SvelteKit SSR app with Lambda (AWS adapter), S3 for static assets, and CloudFront CDN.
+ *
+ * ---
+ *
+ * For static-only SvelteKit sites, use `hosting-bucket` with `hostingContentType: 'sveltekit-static-website'` instead.
+ */
+interface SvelteKitWeb {
+  type: 'sveltekit-web';
+  properties: SvelteKitWebProps;
+  overrides?: ResourceOverrides;
+}
+
+interface SvelteKitWebProps extends ResourceAccessProps {
+  /**
+   * #### Directory containing your `svelte.config.js`. For monorepos, point to the SvelteKit workspace.
+   *
+   * @default "."
+   */
+  appDirectory?: string;
+  /**
+   * #### Override the default `vite build` command.
+   */
+  buildCommand?: string;
+  /**
+   * #### Environment variables for the SSR function. Use `$ResourceParam()` or `$Secret()` for dynamic values.
+   */
+  environment?: EnvironmentVar[];
+  /**
+   * #### Attach custom domains with auto-managed DNS records and TLS certificates.
+   *
+   * ---
+   *
+   * **Prerequisite:** A Route 53 hosted zone for your domain must exist in your AWS account.
+   */
+  customDomains?: DomainConfiguration[];
+  /**
+   * #### Customize the SSR Lambda function (memory, timeout, VPC, logging).
+   */
+  serverLambda?: SsrWebServerLambdaConfig;
+  /**
+   * #### Name of a `web-app-firewall` resource to protect this app. Firewall `scope` must be `cdn`.
+   */
+  useFirewall?: string;
+  /**
+   * #### Dev server config for `stacktape dev`. Defaults to `vite dev`.
+   */
+  dev?: SsrWebDevConfig;
+  /**
+   * #### Set custom headers (e.g., `Cache-Control`) for static files matching a pattern.
+   */
+  fileOptions?: DirectoryUploadFilter[];
+  /**
+   * #### CDN cache controls for SSR routes and specific path patterns.
+   */
+  cdn?: SsrWebCdnConfig;
+}
+```

package/ai-docs/config-ref/tanstack-web.md

@@ -0,0 +1,75 @@
+---
+docType: config-ref
+title: Tan Stack Web
+resourceType: tanstack-web
+tags:
+  - tanstack-web
+  - tanstack
+  - tanstack-start
+source: types/stacktape-config/tanstack-web.d.ts
+priority: 1
+---
+
+# Tan Stack Web
+
+Deploy a TanStack Start SSR app with Lambda (Nitro aws-lambda preset), S3 for static assets, and CloudFront CDN.
+
+Resource type: `tanstack-web`
+
+## TypeScript Definition
+
+```typescript
+/**
+ * #### Deploy a TanStack Start SSR app with Lambda (Nitro aws-lambda preset), S3 for static assets, and CloudFront CDN.
+ */
+interface TanStackWeb {
+  type: 'tanstack-web';
+  properties: TanStackWebProps;
+  overrides?: ResourceOverrides;
+}
+
+interface TanStackWebProps extends ResourceAccessProps {
+  /**
+   * #### Directory containing your `app.config.ts`. For monorepos, point to the TanStack Start workspace.
+   *
+   * @default "."
+   */
+  appDirectory?: string;
+  /**
+   * #### Override the default `vinxi build` command.
+   */
+  buildCommand?: string;
+  /**
+   * #### Environment variables for the SSR function. Use `$ResourceParam()` or `$Secret()` for dynamic values.
+   */
+  environment?: EnvironmentVar[];
+  /**
+   * #### Attach custom domains with auto-managed DNS records and TLS certificates.
+   *
+   * ---
+   *
+   * **Prerequisite:** A Route 53 hosted zone for your domain must exist in your AWS account.
+   */
+  customDomains?: DomainConfiguration[];
+  /**
+   * #### Customize the SSR Lambda function (memory, timeout, VPC, logging).
+   */
+  serverLambda?: SsrWebServerLambdaConfig;
+  /**
+   * #### Name of a `web-app-firewall` resource to protect this app. Firewall `scope` must be `cdn`.
+   */
+  useFirewall?: string;
+  /**
+   * #### Dev server config for `stacktape dev`. Defaults to `vinxi dev`.
+   */
+  dev?: SsrWebDevConfig;
+  /**
+   * #### Set custom headers (e.g., `Cache-Control`) for static files matching a pattern.
+   */
+  fileOptions?: DirectoryUploadFilter[];
+  /**
+   * #### CDN cache controls for SSR routes and specific path patterns.
+   */
+  cdn?: SsrWebCdnConfig;
+}
+```

package/ai-docs/config-ref/upstash-redis.md

@@ -0,0 +1,59 @@
+---
+docType: config-ref
+title: Upstash Redis
+resourceType: upstash-redis
+tags:
+  - upstash-redis
+  - upstash
+source: types/stacktape-config/upstash-redis.d.ts
+priority: 1
+---
+
+# Upstash Redis
+
+Serverless Redis by Upstash — pay-per-request with no idle costs.
+
+Perfect for Lambda-based apps where a traditional Redis cluster would be wasteful.
+Accessible over HTTPS (REST API) or standard Redis protocol. Great for caching, sessions, rate limiting.
+
+Resource type: `upstash-redis`
+
+## TypeScript Definition
+
+```typescript
+/**
+ * #### Serverless Redis by Upstash — pay-per-request with no idle costs.
+ *
+ * ---
+ *
+ * Perfect for Lambda-based apps where a traditional Redis cluster would be wasteful.
+ * Accessible over HTTPS (REST API) or standard Redis protocol. Great for caching, sessions, rate limiting.
+ */
+interface UpstashRedis {
+  type: 'upstash-redis';
+  properties?: UpstashRedisProps;
+  overrides?: ResourceOverrides;
+}
+
+interface UpstashRedisProps {
+  /**
+   * #### Auto-remove old keys when memory is full. Prioritizes keys with TTL set. Enable for cache use cases.
+   *
+   * ---
+   *
+   * Without eviction, writes fail once the memory limit is reached. Enable this for caching workloads.
+   *
+   * @default false
+   */
+  enableEviction?: boolean;
+}
+
+type UpstashRedisReferencableParam =
+  | 'host'
+  | 'port'
+  | 'password'
+  | 'restToken'
+  | 'readOnlyRestToken'
+  | 'restUrl'
+  | 'redisUrl';
+```