@ts-cloud/core 0.7.18 → 0.7.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/types.d.ts +28 -7
  2. package/package.json +2 -2
package/dist/types.d.ts CHANGED
@@ -50,18 +50,39 @@ export interface ObjectStorageConfig {
50
50
  forcePathStyle?: boolean;
51
51
  }
52
52
  /**
53
- * Hetzner Cloud configuration
53
+ * Hetzner Cloud configuration.
54
+ *
55
+ * Every field is optional and falls back to an environment variable, then to a
56
+ * documented default. What is written here always wins over the environment: a
57
+ * stray shell export must not silently redirect a deploy to another datacenter
58
+ * or another account.
59
+ *
60
+ * Resolution lives in one place: `resolveHetznerSettings` in
61
+ * `@stacksjs/ts-cloud` (`drivers/hetzner/config.ts`).
54
62
  */
55
63
  export interface HetznerConfig {
56
- /** Hetzner Cloud API token (falls back to HCLOUD_TOKEN / HETZNER_API_TOKEN) */
64
+ /**
65
+ * Hetzner Cloud API token. Normally left unset here and supplied via
66
+ * `HCLOUD_TOKEN` (or `HETZNER_API_TOKEN`), since it is a secret and this file
67
+ * is checked in. Never defaulted: a missing token fails loudly.
68
+ */
57
69
  apiToken?: string;
58
- /** Location slug, e.g. fsn1, nbg1, hel1 @default 'fsn1' */
70
+ /** Location slug, e.g. fsn1, nbg1, hel1. Env: `HCLOUD_LOCATION`. @default 'fsn1' */
59
71
  location?: string;
60
- /** Server image slug @default 'ubuntu-24.04' */
72
+ /**
73
+ * Server image slug. `infrastructure.compute.image` overrides this when set
74
+ * (it is the provider-agnostic way to pin an image). Env: `HCLOUD_IMAGE`.
75
+ * @default 'ubuntu-24.04'
76
+ */
61
77
  image?: string;
62
- /** Path to SSH private key used for deploy commands @default ~/.ssh/id_ed25519 */
78
+ /** Path to SSH private key used for deploy commands. Env: `HCLOUD_SSH_KEY`. @default '~/.ssh/id_ed25519' */
63
79
  sshPrivateKeyPath?: string;
64
- /** SSH user for deploy commands @default 'root' */
80
+ /**
81
+ * Path to the SSH public key uploaded to Hetzner. Env: `HCLOUD_SSH_PUBLIC_KEY`.
82
+ * @default `${sshPrivateKeyPath}.pub`
83
+ */
84
+ sshPublicKeyPath?: string;
85
+ /** SSH user for deploy commands. Env: `HCLOUD_SSH_USER`. @default 'root' */
65
86
  sshUser?: string;
66
87
  }
67
88
  /**
@@ -1671,7 +1692,7 @@ export interface ServerlessAppConfig {
1671
1692
  gatewayVersion?: 1 | 2;
1672
1693
  /**
1673
1694
  * Cheap keep-warm count. Drives a scheduled EventBridge warmer rule that pings
1674
- * the function(s) every few minutes (the runtime short-circuits warmer pings).
1695
+ * the function(_s) every few minutes (the runtime short-circuits warmer pings).
1675
1696
  * Reduces (does not eliminate) cold starts. For zero cold starts use
1676
1697
  * {@link provisionedConcurrency}. 0/undefined disables ping-warming.
1677
1698
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ts-cloud/core",
3
- "version": "0.7.18",
3
+ "version": "0.7.20",
4
4
  "type": "module",
5
5
  "description": "Core CloudFormation generation library for ts-cloud",
6
6
  "author": "Chris Breuer <chris@stacksjs.com>",
@@ -31,7 +31,7 @@
31
31
  "typecheck": "tsc --noEmit"
32
32
  },
33
33
  "dependencies": {
34
- "@ts-cloud/aws-types": "0.7.18"
34
+ "@ts-cloud/aws-types": "0.7.20"
35
35
  },
36
36
  "devDependencies": {
37
37
  "typescript": "^7.0.2"