@exabugs/dynamodb-client 0.6.0 → 0.6.1

package/README.md

@@ -265,6 +265,77 @@ See the [example project's documentation](https://github.com/exabugs/dynamodb-cl
 
 ---
 
+## 🔧 Configuration Management
+
+### Parameter Store Integration
+
+The library supports AWS Parameter Store for flexible configuration management, eliminating the need for Terraform outputs in application code.
+
+#### Parameter Structure
+
+Parameters are organized hierarchically:
+
+```
+/{project_name}/{environment}/
+├── app/
+│   ├── records-api-url          # Lambda Function URL
+│   └── admin-ui/
+│       ├── cognito-user-pool-id
+│       ├── cognito-client-id
+│       └── cognito-domain
+├── infra/
+│   └── dynamodb-table-name
+└── lambda/
+    └── records-function-arn
+```
+
+#### Benefits
+
+- **🔄 Dynamic Configuration**: Update settings without redeployment
+- **🔐 Secure Storage**: All parameters encrypted with AWS managed KMS keys
+- **💰 Cost Effective**: Standard tier is free for typical usage
+- **📊 Audit Trail**: Complete change history via CloudTrail
+- **🎯 Environment Separation**: Clear dev/stg/prd isolation
+
+#### Usage in Applications
+
+**React Admin UI**:
+
+```typescript
+// Read configuration from Parameter Store
+const config = await getParametersByPath(`/${PROJECT_NAME}/${ENV}/app/admin-ui/`);
+
+const cognitoConfig = {
+  userPoolId: config['cognito-user-pool-id'],
+  clientId: config['cognito-client-id'],
+  domain: config['cognito-domain'],
+};
+```
+
+**Lambda Functions**:
+
+```typescript
+// Read specific parameters
+const recordsApiUrl = await getParameter(`/${PROJECT_NAME}/${ENV}/app/records-api-url`);
+```
+
+#### IAM Permissions
+
+The Terraform module automatically creates appropriate IAM policies:
+
+- **Admin UI**: Read access to `/app/admin-ui/*` parameters
+- **Fetch Lambda**: Read access to specific required parameters
+- **Minimal Permissions**: Following least privilege principle
+
+#### Migration from Terraform Outputs
+
+1. **Deploy Parameter Store module** (included in v0.6.0+)
+2. **Update application code** to read from Parameter Store
+3. **Remove Terraform output dependencies**
+4. **Enjoy flexible configuration management**
+
+---
+
 ## 🔧 Shadow Configuration
 
 ### Overview
@@ -273,12 +344,12 @@ The shadow feature automatically makes all fields sortable without requiring JSO
 
 ### Environment Variables
 
-| Variable | Default | Description |
-|----------|---------|-------------|
-| `SHADOW_CREATED_AT_FIELD` | `createdAt` | Field name for creation timestamp |
-| `SHADOW_UPDATED_AT_FIELD` | `updatedAt` | Field name for update timestamp |
-| `SHADOW_STRING_MAX_BYTES` | `100` | Max bytes for primitive types (array/object use 2x) |
-| `SHADOW_NUMBER_PADDING` | `15` | Padding digits for numbers |
+| Variable                  | Default     | Description                                         |
+| ------------------------- | ----------- | --------------------------------------------------- |
+| `SHADOW_CREATED_AT_FIELD` | `createdAt` | Field name for creation timestamp                   |
+| `SHADOW_UPDATED_AT_FIELD` | `updatedAt` | Field name for update timestamp                     |
+| `SHADOW_STRING_MAX_BYTES` | `100`       | Max bytes for primitive types (array/object use 2x) |
+| `SHADOW_NUMBER_PADDING`   | `15`        | Padding digits for numbers                          |
 
 ### Supported Types
 
@@ -300,7 +371,7 @@ const record = {
   viewCount: 123,
   published: true,
   tags: ['tech', 'aws'],
-  metadata: { category: 'tech' }
+  metadata: { category: 'tech' },
 };
 
 // Automatically generates shadow records:

package/dist/server/handler.cjs

@@ -1,5 +1,5 @@
-// @exabugs/dynamodb-client v0.6.0
-// Built: 2025-12-27T03:59:32.181Z
+// @exabugs/dynamodb-client v0.6.1
+// Built: 2025-12-27T04:48:12.419Z
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exabugs/dynamodb-client",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "DynamoDB Single-Table Client SDK with MongoDB-like API, Shadow Records, and Lambda implementation for serverless applications",
   "author": "exabugs",
   "license": "MIT",

package/terraform/main.tf

@@ -176,7 +176,7 @@ module "parameter_store" {
 
   # Cognito設定
   cognito_user_pool_id       = var.cognito_user_pool_id
-  cognito_admin_ui_client_id = var.cognito_client_id
+  cognito_admin_ui_client_id = var.cognito_admin_ui_client_id
   cognito_user_pool_domain   = var.cognito_user_pool_domain
 
   # DynamoDB設定

package/terraform/modules/parameter-store/README.md

@@ -25,17 +25,33 @@ module "parameter_store" {
   environment  = "dev"
   region       = "us-east-1"
 
-  # Records Lambda設定
-  records_function_url = "https://abc123.lambda-url.us-east-1.on.aws/"
-  records_function_arn = "arn:aws:lambda:us-east-1:123456789012:function:my-project-dev-records"
+  # Records Lambda設定（必須）
+  records_function_url = aws_lambda_function_url.records.function_url
+  records_function_arn = aws_lambda_function.records.arn
+}
+```
+
+**Note**: このモジュールは外部参照用のプレースホルダーパラメータも作成します。実際の値は他のTerraformモジュール（Cognito、DynamoDB等）から設定してください。
+
+### プレースホルダーパラメータの更新
 
-  # Cognito設定
-  cognito_user_pool_id       = "us-east-1_ABC123DEF"
-  cognito_admin_ui_client_id = "abc123def456ghi789"
-  cognito_user_pool_domain   = "my-project-dev"
+他のTerraformモジュールから値を設定する例：
+
+```hcl
+# Cognitoモジュールから
+resource "aws_ssm_parameter" "cognito_user_pool_id" {
+  name      = "/${var.project_name}/${var.environment}/app/admin-ui/cognito-user-pool-id"
+  type      = "SecureString"
+  value     = aws_cognito_user_pool.main.id
+  overwrite = true
+}
 
-  # DynamoDB設定
-  dynamodb_table_name = "my-project-dev-records"
+# DynamoDBモジュールから
+resource "aws_ssm_parameter" "dynamodb_table_name" {
+  name      = "/${var.project_name}/${var.environment}/infra/dynamodb-table-name"
+  type      = "SecureString"
+  value     = aws_dynamodb_table.main.name
+  overwrite = true
 }
 ```
 

package/terraform/modules/parameter-store/iam.tf

@@ -1,59 +1,13 @@
 # Parameter Store アクセス用IAMポリシー
 
-# Admin UI用Parameter Store読み取りポリシー
-resource "aws_iam_policy" "admin_ui_parameter_read" {
-  name        = "${var.project_name}-${var.environment}-admin-ui-parameter-read"
-  description = "Admin UI用Parameter Store読み取り権限"
+# Note: 実際のプロジェクトでは、以下のようなIAMポリシーを
+# 各リソース（Admin UI、Fetch Lambda等）で個別に定義してください：
 
-  policy = jsonencode({
-    Version = "2012-10-17"
-    Statement = [
-      {
-        Effect = "Allow"
-        Action = [
-          "ssm:GetParameter",
-          "ssm:GetParameters",
-          "ssm:GetParametersByPath"
-        ]
-        Resource = [
-          "arn:aws:ssm:${var.region}:*:parameter/${var.project_name}/${var.environment}/app/*"
-        ]
-      }
-    ]
-  })
+# Admin UI用Parameter Store読み取りポリシー例:
+# Resource: "arn:aws:ssm:region:*:parameter/{project_name}/{environment}/app/*"
 
-  tags = {
-    Environment = var.environment
-    ManagedBy   = "terraform"
-    Purpose     = "admin-ui-parameter-access"
-  }
-}
-
-# Fetch Lambda用Parameter Store読み取りポリシー
-resource "aws_iam_policy" "fetch_lambda_parameter_read" {
-  name        = "${var.project_name}-${var.environment}-fetch-lambda-parameter-read"
-  description = "Fetch Lambda用Parameter Store読み取り権限"
-
-  policy = jsonencode({
-    Version = "2012-10-17"
-    Statement = [
-      {
-        Effect = "Allow"
-        Action = [
-          "ssm:GetParameter",
-          "ssm:GetParameters"
-        ]
-        Resource = [
-          "arn:aws:ssm:${var.region}:*:parameter/${var.project_name}/${var.environment}/app/records-api-url",
-          "arn:aws:ssm:${var.region}:*:parameter/${var.project_name}/${var.environment}/lambda/records-function-arn"
-        ]
-      }
-    ]
-  })
-
-  tags = {
-    Environment = var.environment
-    ManagedBy   = "terraform"
-    Purpose     = "fetch-lambda-parameter-access"
-  }
-}
+# Fetch Lambda用Parameter Store読み取りポリシー例:
+# Resource: [
+#   "arn:aws:ssm:region:*:parameter/{project_name}/{environment}/app/records-api-url",
+#   "arn:aws:ssm:region:*:parameter/{project_name}/{environment}/lambda/records-function-arn"
+# ]

package/terraform/modules/parameter-store/main.tf

@@ -8,7 +8,7 @@ locals {
   # AWS管理キー（alias/aws/ssm）を使用（カスタマー管理キーは禁止）
 }
 
-# Records Lambda Function URL
+# Records Lambda Function URL (外部参照用)
 resource "aws_ssm_parameter" "app_records_api_url" {
   name  = "/${var.project_name}/${var.environment}/app/records-api-url"
   type  = local.parameter_type
@@ -24,7 +24,26 @@ resource "aws_ssm_parameter" "app_records_api_url" {
   }
 }
 
-# Cognito User Pool ID for Admin UI
+# Records Lambda Function ARN (外部参照用)
+resource "aws_ssm_parameter" "lambda_records_function_arn" {
+  name  = "/${var.project_name}/${var.environment}/lambda/records-function-arn"
+  type  = local.parameter_type
+  tier  = local.parameter_tier
+  value = var.records_function_arn
+
+  description = "Records Lambda Function ARN"
+
+  tags = {
+    Environment = var.environment
+    ManagedBy   = "terraform"
+    Category    = "lambda-info"
+  }
+}
+
+# 外部参照用のパラメータ（実際の値を設定）
+# アプリケーション（Admin UI、Fetch Lambda等）がこれらの値を参照する
+
+# Cognito User Pool ID (Admin UI参照用)
 resource "aws_ssm_parameter" "app_admin_ui_cognito_user_pool_id" {
   name  = "/${var.project_name}/${var.environment}/app/admin-ui/cognito-user-pool-id"
   type  = local.parameter_type
@@ -40,7 +59,7 @@ resource "aws_ssm_parameter" "app_admin_ui_cognito_user_pool_id" {
   }
 }
 
-# Cognito Client ID for Admin UI
+# Cognito Client ID (Admin UI参照用)
 resource "aws_ssm_parameter" "app_admin_ui_cognito_client_id" {
   name  = "/${var.project_name}/${var.environment}/app/admin-ui/cognito-client-id"
   type  = local.parameter_type
@@ -56,7 +75,7 @@ resource "aws_ssm_parameter" "app_admin_ui_cognito_client_id" {
   }
 }
 
-# Cognito Domain for Admin UI
+# Cognito Domain (Admin UI参照用)
 resource "aws_ssm_parameter" "app_admin_ui_cognito_domain" {
   name  = "/${var.project_name}/${var.environment}/app/admin-ui/cognito-domain"
   type  = local.parameter_type
@@ -72,7 +91,7 @@ resource "aws_ssm_parameter" "app_admin_ui_cognito_domain" {
   }
 }
 
-# DynamoDB Table Name
+# DynamoDB Table Name (外部参照用)
 resource "aws_ssm_parameter" "infra_dynamodb_table_name" {
   name  = "/${var.project_name}/${var.environment}/infra/dynamodb-table-name"
   type  = local.parameter_type
@@ -87,19 +106,3 @@ resource "aws_ssm_parameter" "infra_dynamodb_table_name" {
     Category    = "infra-info"
   }
 }
-
-# Records Lambda Function ARN
-resource "aws_ssm_parameter" "lambda_records_function_arn" {
-  name  = "/${var.project_name}/${var.environment}/lambda/records-function-arn"
-  type  = local.parameter_type
-  tier  = local.parameter_tier
-  value = var.records_function_arn
-
-  description = "Records Lambda Function ARN"
-
-  tags = {
-    Environment = var.environment
-    ManagedBy   = "terraform"
-    Category    = "lambda-info"
-  }
-}

package/terraform/modules/parameter-store/outputs.tf

@@ -39,20 +39,5 @@ output "parameter_paths" {
   }
 }
 
-# IAM Policy ARNs
-output "iam_policy_arns" {
-  description = "作成されたIAMポリシーのARN一覧"
-  value = {
-    admin_ui_parameter_read     = aws_iam_policy.admin_ui_parameter_read.arn
-    fetch_lambda_parameter_read = aws_iam_policy.fetch_lambda_parameter_read.arn
-  }
-}
-
-# IAM Policy Names
-output "iam_policy_names" {
-  description = "作成されたIAMポリシーの名前一覧"
-  value = {
-    admin_ui_parameter_read     = aws_iam_policy.admin_ui_parameter_read.name
-    fetch_lambda_parameter_read = aws_iam_policy.fetch_lambda_parameter_read.name
-  }
-}
+# Note: IAMポリシーは各プロジェクトで個別に定義してください
+# 詳細は iam.tf のコメントを参照

package/terraform/modules/parameter-store/variables.tf

@@ -20,13 +20,18 @@ variable "records_function_url" {
   type        = string
 }
 
+variable "records_function_arn" {
+  description = "Records Lambda Function ARN"
+  type        = string
+}
+
 variable "cognito_user_pool_id" {
   description = "Cognito User Pool ID"
   type        = string
 }
 
 variable "cognito_admin_ui_client_id" {
-  description = "Admin UI用Cognito App Client ID"
+  description = "Admin UI用Cognito User Pool Client ID"
   type        = string
 }
 
@@ -39,8 +44,3 @@ variable "dynamodb_table_name" {
   description = "DynamoDB Table Name"
   type        = string
 }
-
-variable "records_function_arn" {
-  description = "Records Lambda Function ARN"
-  type        = string
-}

package/terraform/variables.tf

@@ -41,6 +41,11 @@ variable "cognito_user_pool_domain" {
   type        = string
 }
 
+variable "cognito_admin_ui_client_id" {
+  description = "Admin UI用Cognito User Pool Client ID"
+  type        = string
+}
+
 variable "log_retention_days" {
   description = "CloudWatch Logsの保持期間（日数）"
   type        = number