@hot-updater/aws 1.0.0-rc.2 → 1.0.0-rc.21

package/dist/init/index.d.cts

@@ -1,10 +1,119 @@
+import { RunInitOptions } from "@hot-updater/cli-tools";
+//#region iac/dynamodb.d.ts
+declare const buildDynamoDBCreateTableInput: (tableName: string) => {
+  AttributeDefinitions: {
+    AttributeName: string;
+    AttributeType: "S";
+  }[];
+  BillingMode: "PAY_PER_REQUEST";
+  DeletionProtectionEnabled: true;
+  KeySchema: ({
+    readonly AttributeName: "pk";
+    readonly KeyType: "HASH";
+  } | {
+    readonly AttributeName: "sk";
+    readonly KeyType: "RANGE";
+  })[];
+  OnDemandThroughput: {
+    readonly MaxReadRequestUnits: 4000;
+    readonly MaxWriteRequestUnits: 100;
+  };
+  TableName: string;
+};
+/**
+ * The schema settings items of core and the managed server's plugins, which
+ * the database checks before its first read, as one BatchWriteItem request:
+ * what `migrateDynamoDB` writes to a new table for those plugins.
+ */
+declare const buildDynamoDBSchemaSettingsInput: (tableName: string) => {
+  RequestItems: {
+    [x: string]: {
+      PutRequest: {
+        Item: {
+          pk: {
+            S: string;
+          };
+          sk: {
+            S: string;
+          };
+          key: {
+            S: string;
+          };
+          value: {
+            S: string;
+          };
+          _v: {
+            N: string;
+          };
+        };
+      };
+    }[];
+  };
+};
+declare const buildDynamoDBBackupInput: (tableName: string) => {
+  PointInTimeRecoverySpecification: {
+    PointInTimeRecoveryEnabled: true;
+  };
+  TableName: string;
+};
+/**
+ * Turns on the table's TTL, which deletes expired items for free: the store
+ * writes `_ttl`, in epoch seconds, on every item of a row with retention.
+ */
+declare const buildDynamoDBTimeToLiveInput: (tableName: string) => {
+  TableName: string;
+  TimeToLiveSpecification: {
+    AttributeName: string;
+    Enabled: true;
+  };
+};
+//#endregion
+//#region iac/iam.d.ts
+declare const buildDynamoDBPolicy: (region: string, accountId: string, tableName: string) => {
+  Version: string;
+  Statement: {
+    Action: string[];
+    Condition: {
+      "ForAllValues:StringLike": {
+        "dynamodb:LeadingKeys": string[];
+      };
+    };
+    Effect: string;
+    Resource: string[];
+  }[];
+};
+declare const buildS3Policy: (bucketName: string) => {
+  Version: string;
+  Statement: {
+    Action: string[];
+    Effect: string;
+    Resource: string[];
+  }[];
+};
+declare const buildSsmPolicy: (region: string, accountId: string, parameterName: string) => {
+  Version: string;
+  Statement: {
+    Effect: string;
+    Action: string[];
+    Resource: string;
+  }[];
+};
+declare const LAMBDA_EDGE_TRUST_POLICY: {
+  Version: string;
+  Statement: {
+    Effect: string;
+    Principal: {
+      Service: string[];
+    };
+    Action: string;
+  }[];
+};
+//#endregion
 //#region iac/init/index.d.ts
 declare const AWS_AUTH_MODES: readonly ["local-session", "shared-profile", "sso", "account"];
 type AwsAuthMode = (typeof AWS_AUTH_MODES)[number];
-declare const isAwsAuthMode: (value: string | undefined) => value is AwsAuthMode;
 declare const AWS_REGION_VALUES: readonly ["af-south-1", "ap-east-1", "ap-east-2", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ap-southeast-5", "ap-southeast-6", "ap-southeast-7", "ca-central-1", "ca-west-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "mx-central-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"];
 type AwsRegionValue = (typeof AWS_REGION_VALUES)[number];
-declare const isAwsRegionValue: (value: string | undefined) => value is AwsRegionValue;
 declare const initProvider: {
   readonly label: "AWS + Lambda@Edge";
   readonly inputs: {
@@ -99,4 +208,16 @@ declare const initProvider: {
   };
 };
 //#endregion
-export { AWS_AUTH_MODES, AWS_REGION_VALUES, AwsAuthMode, AwsRegionValue, initProvider, isAwsAuthMode, isAwsRegionValue };
+//#region iac/index.d.ts
+declare const prepareDynamoDBDeployment: (input: {
+  readonly credentials: {
+    readonly accessKeyId: string;
+    readonly secretAccessKey: string;
+    readonly sessionToken?: string;
+  };
+  readonly region: string;
+  readonly tableName: string;
+}) => Promise<void>;
+declare const runInit: ({ build, envFile }: RunInitOptions) => Promise<void>;
+//#endregion
+export { LAMBDA_EDGE_TRUST_POLICY, buildDynamoDBBackupInput, buildDynamoDBCreateTableInput, buildDynamoDBPolicy, buildDynamoDBSchemaSettingsInput, buildDynamoDBTimeToLiveInput, buildS3Policy, buildSsmPolicy, initProvider, prepareDynamoDBDeployment, runInit };

package/dist/init/index.d.mts

@@ -1,10 +1,119 @@
+import { InitError, RunInitOptions } from "@hot-updater/cli-tools";
+//#region iac/dynamodb.d.ts
+declare const buildDynamoDBCreateTableInput: (tableName: string) => {
+  AttributeDefinitions: {
+    AttributeName: string;
+    AttributeType: "S";
+  }[];
+  BillingMode: "PAY_PER_REQUEST";
+  DeletionProtectionEnabled: true;
+  KeySchema: ({
+    readonly AttributeName: "pk";
+    readonly KeyType: "HASH";
+  } | {
+    readonly AttributeName: "sk";
+    readonly KeyType: "RANGE";
+  })[];
+  OnDemandThroughput: {
+    readonly MaxReadRequestUnits: 4000;
+    readonly MaxWriteRequestUnits: 100;
+  };
+  TableName: string;
+};
+/**
+ * The schema settings items of core and the managed server's plugins, which
+ * the database checks before its first read, as one BatchWriteItem request:
+ * what `migrateDynamoDB` writes to a new table for those plugins.
+ */
+declare const buildDynamoDBSchemaSettingsInput: (tableName: string) => {
+  RequestItems: {
+    [x: string]: {
+      PutRequest: {
+        Item: {
+          pk: {
+            S: string;
+          };
+          sk: {
+            S: string;
+          };
+          key: {
+            S: string;
+          };
+          value: {
+            S: string;
+          };
+          _v: {
+            N: string;
+          };
+        };
+      };
+    }[];
+  };
+};
+declare const buildDynamoDBBackupInput: (tableName: string) => {
+  PointInTimeRecoverySpecification: {
+    PointInTimeRecoveryEnabled: true;
+  };
+  TableName: string;
+};
+/**
+ * Turns on the table's TTL, which deletes expired items for free: the store
+ * writes `_ttl`, in epoch seconds, on every item of a row with retention.
+ */
+declare const buildDynamoDBTimeToLiveInput: (tableName: string) => {
+  TableName: string;
+  TimeToLiveSpecification: {
+    AttributeName: string;
+    Enabled: true;
+  };
+};
+//#endregion
+//#region iac/iam.d.ts
+declare const buildDynamoDBPolicy: (region: string, accountId: string, tableName: string) => {
+  Version: string;
+  Statement: {
+    Action: string[];
+    Condition: {
+      "ForAllValues:StringLike": {
+        "dynamodb:LeadingKeys": string[];
+      };
+    };
+    Effect: string;
+    Resource: string[];
+  }[];
+};
+declare const buildS3Policy: (bucketName: string) => {
+  Version: string;
+  Statement: {
+    Action: string[];
+    Effect: string;
+    Resource: string[];
+  }[];
+};
+declare const buildSsmPolicy: (region: string, accountId: string, parameterName: string) => {
+  Version: string;
+  Statement: {
+    Effect: string;
+    Action: string[];
+    Resource: string;
+  }[];
+};
+declare const LAMBDA_EDGE_TRUST_POLICY: {
+  Version: string;
+  Statement: {
+    Effect: string;
+    Principal: {
+      Service: string[];
+    };
+    Action: string;
+  }[];
+};
+//#endregion
 //#region iac/init/index.d.ts
 declare const AWS_AUTH_MODES: readonly ["local-session", "shared-profile", "sso", "account"];
 type AwsAuthMode = (typeof AWS_AUTH_MODES)[number];
-declare const isAwsAuthMode: (value: string | undefined) => value is AwsAuthMode;
 declare const AWS_REGION_VALUES: readonly ["af-south-1", "ap-east-1", "ap-east-2", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ap-southeast-5", "ap-southeast-6", "ap-southeast-7", "ca-central-1", "ca-west-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "mx-central-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"];
 type AwsRegionValue = (typeof AWS_REGION_VALUES)[number];
-declare const isAwsRegionValue: (value: string | undefined) => value is AwsRegionValue;
 declare const initProvider: {
   readonly label: "AWS + Lambda@Edge";
   readonly inputs: {
@@ -99,4 +208,16 @@ declare const initProvider: {
   };
 };
 //#endregion
-export { AWS_AUTH_MODES, AWS_REGION_VALUES, AwsAuthMode, AwsRegionValue, initProvider, isAwsAuthMode, isAwsRegionValue };
+//#region iac/index.d.ts
+declare const prepareDynamoDBDeployment: (input: {
+  readonly credentials: {
+    readonly accessKeyId: string;
+    readonly secretAccessKey: string;
+    readonly sessionToken?: string;
+  };
+  readonly region: string;
+  readonly tableName: string;
+}) => Promise<void>;
+declare const runInit: ({ build, envFile }: RunInitOptions) => Promise<void>;
+//#endregion
+export { LAMBDA_EDGE_TRUST_POLICY, buildDynamoDBBackupInput, buildDynamoDBCreateTableInput, buildDynamoDBPolicy, buildDynamoDBSchemaSettingsInput, buildDynamoDBTimeToLiveInput, buildS3Policy, buildSsmPolicy, initProvider, prepareDynamoDBDeployment, runInit };