cdk-turso 0.0.3 → 0.1.0

package/.jsii

@@ -2791,7 +2791,7 @@
   },
   "name": "cdk-turso",
   "readme": {
-    "markdown": "# CDK Turso\n\nCDK construct to create a [Turso cloud](https://docs.turso.tech/turso-cloud) database.\n\n## Installation\n\n```bash\nnpm install cdk-turso\n```\n\n## Usage\n\n```typescript\nimport { Stack } from 'aws-cdk-lib';\nimport { StringParameter } from 'aws-cdk-lib/aws-ssm';\nimport { TursoDatabase } from 'cdk-turso';\n\nconst stack = new Stack();\n\n// SSM Parameter containing your Turso API token\nconst apiToken = new StringParameter(stack, 'TursoApiToken', {\n  parameterName: '/turso/api-token',\n  stringValue: 'your-api-token',\n});\n\nconst database = new TursoDatabase(stack, 'Database', {\n  databaseName: 'my-database',\n  group: 'group-name',\n  organizationSlug: 'my-org',\n  apiToken,\n});\n\n// Use the database attributes\ndatabase.dbId;     // Database ID\ndatabase.hostname; // Database hostname\ndatabase.databaseName; // Database name\n```\n\n## API\n\n### TursoDatabaseProps\n\n| Prop | Type | Required | Description |\n|------|------|----------|-------------|\n| `databaseName` | `string` | Yes | Database name (lowercase, numbers, dashes only, max 64 chars) |\n| `group` | `string` | Yes | Turso group name (must already exist) |\n| `organizationSlug` | `string` | Yes | Organization slug |\n| `apiToken` | `ssm.IParameter` | Yes | SSM Parameter containing the Turso API token |\n| `sizeLimit` | `string` | No | Size limit (e.g., '256mb') |\n| `seed` | `TursoDatabaseSeed` | No | Database seed configuration |\n| `encryption` | `TursoDatabaseEncryption` | No | Encryption configuration |\n\n### TursoDatabaseSeed\n\n```typescript\ninterface TursoDatabaseSeed {\n  readonly type: string;      // Seed type (e.g., 'schema')\n  readonly name: string;       // Seed name\n  readonly timestamp?: string;  // Optional timestamp\n}\n```\n\n### TursoDatabaseEncryption\n\n```typescript\ninterface TursoDatabaseEncryption {\n  readonly encryptionKey: string;    // KMS key ARN\n  readonly encryptionCipher: string; // Cipher type (e.g., 'AES')\n}\n```\n\n### TursoDatabase\n\n| Attribute | Type | Description |\n|-----------|------|-------------|\n| `dbId` | `string` | Turso database ID |\n| `hostname` | `string` | DNS hostname (e.g., `my-db-my-org.turso.io`) for libSQL/HTTP connections |\n| `databaseName` | `string` | Database name |\n\n## Requirements\n\n- Node.js 24.x runtime for the Lambda handler\n- The Lambda handler requires the AWS SDK for JavaScript v3 (pre-installed in Lambda runtime)\n"
+    "markdown": "# CDK Turso\n\nCDK construct to create a [Turso cloud](https://docs.turso.tech/turso-cloud) database.\n\n## Installation\n\n```bash\nnpm install cdk-turso\n```\n\n## Usage\n\n```typescript\nimport { Stack } from 'aws-cdk-lib';\nimport { StringParameter } from 'aws-cdk-lib/aws-ssm';\nimport { TursoDatabase } from 'cdk-turso';\n\nconst stack = new Stack();\n\n// SSM Parameter containing your Turso API token\nconst apiToken = new StringParameter(stack, 'TursoApiToken', {\n  parameterName: '/turso/api-token',\n  stringValue: 'your-api-token',\n});\n\nconst database = new TursoDatabase(stack, 'Database', {\n  databaseName: 'my-database',\n  group: 'group-name',\n  organizationSlug: 'my-org',\n  apiToken,\n});\n\n// Use the database attributes\ndatabase.dbId;     // Database ID\ndatabase.hostname; // Database hostname\ndatabase.databaseName; // Database name\n```\n\n### Auth Token\n\nGenerate a database auth token and store it as a SecureString in SSM Parameter Store:\n\n```typescript\nimport { TursoAuthToken } from 'cdk-turso';\n\nconst authToken = new TursoAuthToken(stack, 'AuthToken', {\n  database,\n  parameterName: '/turso/db-token',\n  expiration: '2w',          // optional, default: 'never'\n  authorization: 'read-only', // optional, default: 'full-access'\n});\n\n// The SSM parameter name where the JWT is stored\nauthToken.parameterName;\n```\n\n## API\n\n### TursoDatabaseProps\n\n| Prop | Type | Required | Description |\n|------|------|----------|-------------|\n| `databaseName` | `string` | Yes | Database name (lowercase, numbers, dashes only, max 64 chars) |\n| `group` | `string` | Yes | Turso group name (must already exist) |\n| `organizationSlug` | `string` | Yes | Organization slug |\n| `apiToken` | `ssm.IParameter` | Yes | SSM Parameter containing the Turso API token |\n| `sizeLimit` | `string` | No | Size limit (e.g., '256mb') |\n| `seed` | `TursoDatabaseSeed` | No | Database seed configuration |\n| `encryption` | `TursoDatabaseEncryption` | No | Encryption configuration |\n\n### TursoDatabaseSeed\n\n```typescript\ninterface TursoDatabaseSeed {\n  readonly type: string;      // Seed type (e.g., 'schema')\n  readonly name: string;       // Seed name\n  readonly timestamp?: string;  // Optional timestamp\n}\n```\n\n### TursoDatabaseEncryption\n\n```typescript\ninterface TursoDatabaseEncryption {\n  readonly encryptionKey: string;    // KMS key ARN\n  readonly encryptionCipher: string; // Cipher type (e.g., 'AES')\n}\n```\n\n### TursoDatabase\n\n| Attribute | Type | Description |\n|-----------|------|-------------|\n| `dbId` | `string` | Turso database ID |\n| `hostname` | `string` | DNS hostname (e.g., `my-db-my-org.turso.io`) for libSQL/HTTP connections |\n| `databaseName` | `string` | Database name |\n| `organizationSlug` | `string` | Organization slug |\n| `apiToken` | `ssm.IParameter` | SSM Parameter containing the Turso API token |\n\n### TursoAuthTokenProps\n\n| Prop | Type | Required | Description |\n|------|------|----------|-------------|\n| `database` | `TursoDatabase` | Yes | The Turso database to create an auth token for |\n| `parameterName` | `string` | Yes | SSM parameter name where the generated JWT will be stored as a SecureString |\n| `expiration` | `string` | No | Token expiry (e.g., `'2w'`, `'1d30m'`). Default: `'never'` |\n| `authorization` | `string` | No | `'full-access'` or `'read-only'`. Default: `'full-access'` |\n\n### TursoAuthToken\n\n| Attribute | Type | Description |\n|-----------|------|-------------|\n| `parameterName` | `string` | The SSM parameter name where the auth token is stored |\n\n## Requirements\n\n- Node.js 24.x runtime for the Lambda handler\n- The Lambda handler requires the AWS SDK for JavaScript v3 (pre-installed in Lambda runtime)\n"
   },
   "repository": {
     "type": "git",
@@ -2804,6 +2804,152 @@
     }
   },
   "types": {
+    "cdk-turso.TursoAuthToken": {
+      "assembly": "cdk-turso",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "cdk-turso.TursoAuthToken",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/turso-auth-token.ts",
+          "line": 42
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "cdk-turso.TursoAuthTokenProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/turso-auth-token.ts",
+        "line": 36
+      },
+      "name": "TursoAuthToken",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "The SSM parameter name where the auth token is stored."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/turso-auth-token.ts",
+            "line": 40
+          },
+          "name": "parameterName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/turso-auth-token:TursoAuthToken"
+    },
+    "cdk-turso.TursoAuthTokenProps": {
+      "assembly": "cdk-turso",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "cdk-turso.TursoAuthTokenProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/turso-auth-token.ts",
+        "line": 9
+      },
+      "name": "TursoAuthTokenProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The Turso database to create an auth token for."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/turso-auth-token.ts",
+            "line": 13
+          },
+          "name": "database",
+          "type": {
+            "fqn": "cdk-turso.TursoDatabase"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The SSM parameter name where the generated JWT will be stored as a SecureString."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/turso-auth-token.ts",
+            "line": 19
+          },
+          "name": "parameterName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"full-access\"",
+            "stability": "stable",
+            "summary": "Authorization level for the token."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/turso-auth-token.ts",
+            "line": 33
+          },
+          "name": "authorization",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"never\"",
+            "stability": "stable",
+            "summary": "Expiration time for the token (e.g., `\"2w\"`, `\"1d30m\"`)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/turso-auth-token.ts",
+            "line": 26
+          },
+          "name": "expiration",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/turso-auth-token:TursoAuthTokenProps"
+    },
     "cdk-turso.TursoDatabase": {
       "assembly": "cdk-turso",
       "base": "constructs.Construct",
@@ -2817,7 +2963,7 @@
         },
         "locationInModule": {
           "filename": "src/turso-database.ts",
-          "line": 38
+          "line": 40
         },
         "parameters": [
           {
@@ -2847,6 +2993,20 @@
       },
       "name": "TursoDatabase",
       "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/turso-database.ts",
+            "line": 38
+          },
+          "name": "apiToken",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ssm.IParameter"
+          }
+        },
         {
           "docs": {
             "stability": "stable"
@@ -2889,6 +3049,20 @@
           "type": {
             "primitive": "string"
           }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/turso-database.ts",
+            "line": 37
+          },
+          "name": "organizationSlug",
+          "type": {
+            "primitive": "string"
+          }
         }
       ],
       "symbolId": "src/turso-database:TursoDatabase"
@@ -3129,6 +3303,6 @@
       "symbolId": "src/turso-database:TursoDatabaseSeed"
     }
   },
-  "version": "0.0.3",
-  "fingerprint": "2JbcEWhNjajcTuFaNl+79TwukC95w10mlbSw0EwU9+Y="
+  "version": "0.1.0",
+  "fingerprint": "REUxXAoWes6zthnEgIY1bBBwu+YaicBewP+x2lu8gL4="
 }

package/API.md

@@ -2,6 +2,118 @@
 
 ## Constructs <a name="Constructs" id="Constructs"></a>
 
+### TursoAuthToken <a name="TursoAuthToken" id="cdk-turso.TursoAuthToken"></a>
+
+#### Initializers <a name="Initializers" id="cdk-turso.TursoAuthToken.Initializer"></a>
+
+```typescript
+import { TursoAuthToken } from 'cdk-turso'
+
+new TursoAuthToken(scope: Construct, id: string, props: TursoAuthTokenProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#cdk-turso.TursoAuthToken.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#cdk-turso.TursoAuthToken.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#cdk-turso.TursoAuthToken.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-turso.TursoAuthTokenProps">TursoAuthTokenProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="cdk-turso.TursoAuthToken.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="cdk-turso.TursoAuthToken.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="cdk-turso.TursoAuthToken.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#cdk-turso.TursoAuthTokenProps">TursoAuthTokenProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#cdk-turso.TursoAuthToken.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="cdk-turso.TursoAuthToken.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#cdk-turso.TursoAuthToken.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### ~~`isConstruct`~~ <a name="isConstruct" id="cdk-turso.TursoAuthToken.isConstruct"></a>
+
+```typescript
+import { TursoAuthToken } from 'cdk-turso'
+
+TursoAuthToken.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+###### `x`<sup>Required</sup> <a name="x" id="cdk-turso.TursoAuthToken.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#cdk-turso.TursoAuthToken.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#cdk-turso.TursoAuthToken.property.parameterName">parameterName</a></code> | <code>string</code> | The SSM parameter name where the auth token is stored. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="cdk-turso.TursoAuthToken.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `parameterName`<sup>Required</sup> <a name="parameterName" id="cdk-turso.TursoAuthToken.property.parameterName"></a>
+
+```typescript
+public readonly parameterName: string;
+```
+
+- *Type:* string
+
+The SSM parameter name where the auth token is stored.
+
+---
+
+
 ### TursoDatabase <a name="TursoDatabase" id="cdk-turso.TursoDatabase"></a>
 
 #### Initializers <a name="Initializers" id="cdk-turso.TursoDatabase.Initializer"></a>
@@ -85,9 +197,11 @@ Any object.
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#cdk-turso.TursoDatabase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#cdk-turso.TursoDatabase.property.apiToken">apiToken</a></code> | <code>aws-cdk-lib.aws_ssm.IParameter</code> | *No description.* |
 | <code><a href="#cdk-turso.TursoDatabase.property.databaseName">databaseName</a></code> | <code>string</code> | *No description.* |
 | <code><a href="#cdk-turso.TursoDatabase.property.dbId">dbId</a></code> | <code>string</code> | *No description.* |
 | <code><a href="#cdk-turso.TursoDatabase.property.hostname">hostname</a></code> | <code>string</code> | DNS hostname for the database (e.g., `my-db-my-org.turso.io`). Use with libSQL or HTTP connections. |
+| <code><a href="#cdk-turso.TursoDatabase.property.organizationSlug">organizationSlug</a></code> | <code>string</code> | *No description.* |
 
 ---
 
@@ -103,6 +217,16 @@ The tree node.
 
 ---
 
+##### `apiToken`<sup>Required</sup> <a name="apiToken" id="cdk-turso.TursoDatabase.property.apiToken"></a>
+
+```typescript
+public readonly apiToken: IParameter;
+```
+
+- *Type:* aws-cdk-lib.aws_ssm.IParameter
+
+---
+
 ##### `databaseName`<sup>Required</sup> <a name="databaseName" id="cdk-turso.TursoDatabase.property.databaseName"></a>
 
 ```typescript
@@ -135,9 +259,90 @@ DNS hostname for the database (e.g., `my-db-my-org.turso.io`). Use with libSQL o
 
 ---
 
+##### `organizationSlug`<sup>Required</sup> <a name="organizationSlug" id="cdk-turso.TursoDatabase.property.organizationSlug"></a>
+
+```typescript
+public readonly organizationSlug: string;
+```
+
+- *Type:* string
+
+---
+
 
 ## Structs <a name="Structs" id="Structs"></a>
 
+### TursoAuthTokenProps <a name="TursoAuthTokenProps" id="cdk-turso.TursoAuthTokenProps"></a>
+
+#### Initializer <a name="Initializer" id="cdk-turso.TursoAuthTokenProps.Initializer"></a>
+
+```typescript
+import { TursoAuthTokenProps } from 'cdk-turso'
+
+const tursoAuthTokenProps: TursoAuthTokenProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#cdk-turso.TursoAuthTokenProps.property.database">database</a></code> | <code><a href="#cdk-turso.TursoDatabase">TursoDatabase</a></code> | The Turso database to create an auth token for. |
+| <code><a href="#cdk-turso.TursoAuthTokenProps.property.parameterName">parameterName</a></code> | <code>string</code> | The SSM parameter name where the generated JWT will be stored as a SecureString. |
+| <code><a href="#cdk-turso.TursoAuthTokenProps.property.authorization">authorization</a></code> | <code>string</code> | Authorization level for the token. |
+| <code><a href="#cdk-turso.TursoAuthTokenProps.property.expiration">expiration</a></code> | <code>string</code> | Expiration time for the token (e.g., `"2w"`, `"1d30m"`). |
+
+---
+
+##### `database`<sup>Required</sup> <a name="database" id="cdk-turso.TursoAuthTokenProps.property.database"></a>
+
+```typescript
+public readonly database: TursoDatabase;
+```
+
+- *Type:* <a href="#cdk-turso.TursoDatabase">TursoDatabase</a>
+
+The Turso database to create an auth token for.
+
+---
+
+##### `parameterName`<sup>Required</sup> <a name="parameterName" id="cdk-turso.TursoAuthTokenProps.property.parameterName"></a>
+
+```typescript
+public readonly parameterName: string;
+```
+
+- *Type:* string
+
+The SSM parameter name where the generated JWT will be stored as a SecureString.
+
+---
+
+##### `authorization`<sup>Optional</sup> <a name="authorization" id="cdk-turso.TursoAuthTokenProps.property.authorization"></a>
+
+```typescript
+public readonly authorization: string;
+```
+
+- *Type:* string
+- *Default:* "full-access"
+
+Authorization level for the token.
+
+---
+
+##### `expiration`<sup>Optional</sup> <a name="expiration" id="cdk-turso.TursoAuthTokenProps.property.expiration"></a>
+
+```typescript
+public readonly expiration: string;
+```
+
+- *Type:* string
+- *Default:* "never"
+
+Expiration time for the token (e.g., `"2w"`, `"1d30m"`).
+
+---
+
 ### TursoDatabaseEncryption <a name="TursoDatabaseEncryption" id="cdk-turso.TursoDatabaseEncryption"></a>
 
 #### Initializer <a name="Initializer" id="cdk-turso.TursoDatabaseEncryption.Initializer"></a>

package/README.md

@@ -36,6 +36,24 @@ database.hostname; // Database hostname
 database.databaseName; // Database name
 ```
 
+### Auth Token
+
+Generate a database auth token and store it as a SecureString in SSM Parameter Store:
+
+```typescript
+import { TursoAuthToken } from 'cdk-turso';
+
+const authToken = new TursoAuthToken(stack, 'AuthToken', {
+  database,
+  parameterName: '/turso/db-token',
+  expiration: '2w',          // optional, default: 'never'
+  authorization: 'read-only', // optional, default: 'full-access'
+});
+
+// The SSM parameter name where the JWT is stored
+authToken.parameterName;
+```
+
 ## API
 
 ### TursoDatabaseProps
@@ -76,6 +94,23 @@ interface TursoDatabaseEncryption {
 | `dbId` | `string` | Turso database ID |
 | `hostname` | `string` | DNS hostname (e.g., `my-db-my-org.turso.io`) for libSQL/HTTP connections |
 | `databaseName` | `string` | Database name |
+| `organizationSlug` | `string` | Organization slug |
+| `apiToken` | `ssm.IParameter` | SSM Parameter containing the Turso API token |
+
+### TursoAuthTokenProps
+
+| Prop | Type | Required | Description |
+|------|------|----------|-------------|
+| `database` | `TursoDatabase` | Yes | The Turso database to create an auth token for |
+| `parameterName` | `string` | Yes | SSM parameter name where the generated JWT will be stored as a SecureString |
+| `expiration` | `string` | No | Token expiry (e.g., `'2w'`, `'1d30m'`). Default: `'never'` |
+| `authorization` | `string` | No | `'full-access'` or `'read-only'`. Default: `'full-access'` |
+
+### TursoAuthToken
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `parameterName` | `string` | The SSM parameter name where the auth token is stored |
 
 ## Requirements
 

package/lib/handler-auth-token/index.d.ts

@@ -0,0 +1,15 @@
+export interface CloudFormationCustomResourceEvent {
+    RequestType: "Create" | "Update" | "Delete";
+    PhysicalResourceId?: string;
+    ResourceProperties: {
+        ServiceToken: string;
+        DatabaseName: string;
+        OrganizationSlug: string;
+        ParameterName: string;
+        Expiration?: string;
+        Authorization?: string;
+    };
+}
+export declare function handler(event: CloudFormationCustomResourceEvent): Promise<{
+    PhysicalResourceId: string;
+}>;