ai-localize-aws-cloudfront 2.0.5 → 2.0.7

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # ai-localize-aws-cloudfront
 
+## 2.0.7
+
+### Patch Changes
+
+- Added `repository`, `homepage`, `bugs`, `author` fields to `package.json` for npm registry display.
+- Added `sideEffects: false` to enable tree-shaking in bundlers.
+- Added `prepublishOnly` script to ensure the package is built before publishing.
+
+## 2.0.6
+
+### Patch Changes
+
+- Add per-package README.md files so each package displays documentation on npmjs.com
+- Update README version badge to 2.0.6
+
 ## 2.0.3
 
 ### Patch Changes

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 ai-localize-core contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,84 @@
+# ai-localize-aws-cloudfront
+
+> AWS S3 asset upload + CloudFront cache invalidation for the [ai-localize-core](https://github.com/ai-localize/ai-localize-core) platform.
+
+[![npm version](https://img.shields.io/npm/v/ai-localize-aws-cloudfront.svg)](https://www.npmjs.com/package/ai-localize-aws-cloudfront)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## What it does
+
+- **`S3Uploader`** — uploads static assets to an S3 bucket with content-hash deduplication
+- **`CloudFrontInvalidator`** — invalidates CloudFront distribution paths after upload
+- **`CdnMigrator`** — orchestrates the full CDN migration: upload → replace legacy URLs → invalidate
+
+## Installation
+
+```bash
+npm install ai-localize-aws-cloudfront
+```
+
+## Configuration
+
+Add the `aws` block to `ai-localize.config.json`:
+
+```json
+{
+  "aws": {
+    "region": "us-east-1",
+    "bucket": "my-assets-bucket",
+    "distributionId": "E1ABCDEFGHIJKL",
+    "cdnBaseUrl": "https://d123.cloudfront.net",
+    "legacyCdnPattern": "https://old-cdn.company.com",
+    "assetsPrefix": "static-assets/v1",
+    "profile": "my-aws-profile"
+  }
+}
+```
+
+Or via environment variables:
+
+```bash
+AWS_S3_BUCKET=my-assets-bucket
+AWS_CF_DISTRIBUTION_ID=E1ABCDEFGHIJKL
+AI_LOCALIZE_CDN_BASE_URL=https://d123.cloudfront.net
+AI_LOCALIZE_LEGACY_CDN_PATTERN=https://old-cdn.company.com
+```
+
+## Usage
+
+```ts
+import { S3Uploader, CloudFrontInvalidator, CdnMigrator } from 'ai-localize-aws-cloudfront';
+
+// Upload assets
+const uploader = new S3Uploader(config.aws);
+const uploadedAssets = await uploader.upload('./public');
+
+// Invalidate CloudFront
+const invalidator = new CloudFrontInvalidator(config.aws);
+await invalidator.invalidate(uploadedAssets.map(a => '/' + a.s3Key));
+
+// Or use the all-in-one migrator
+const migrator = new CdnMigrator(config);
+const result = await migrator.migrate({ assetsDir: './public', invalidate: true });
+```
+
+## CLI equivalent
+
+```bash
+# One-step migration
+npx ai-localize migrate-cdn --assets-dir ./public --invalidate
+
+# Separate steps
+npx ai-localize upload-assets --assets-dir ./public --output manifest.json
+npx ai-localize replace-cdn --manifest manifest.json
+```
+
+---
+
+## Part of ai-localize-core
+
+Install the CLI for the complete toolset: `npm install -g ai-localize-cli`
+
+MIT © ai-localize-core contributors

package/package.json

@@ -1,10 +1,22 @@
 {
   "name": "ai-localize-aws-cloudfront",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "description": "S3 upload, CloudFront invalidation and CDN URL migration for ai-localize-core",
+  "author": "ai-localize-core contributors",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ai-localize/ai-localize-core.git",
+    "directory": "packages/aws-cloudfront"
+  },
+  "homepage": "https://github.com/ai-localize/ai-localize-core/tree/main/packages/aws-cloudfront#readme",
+  "bugs": {
+    "url": "https://github.com/ai-localize/ai-localize-core/issues"
+  },
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "sideEffects": false,
   "files": [
     "dist",
     "README.md",
@@ -37,8 +49,8 @@
     "@aws-sdk/client-cloudfront": "^3.511.0",
     "@aws-sdk/lib-storage": "^3.511.0",
     "mime-types": "^2.1.35",
-    "ai-localize-shared": "2.0.5",
-    "ai-localize-codemods": "2.0.5"
+    "ai-localize-shared": "2.0.7",
+    "ai-localize-codemods": "2.0.7"
   },
   "devDependencies": {
     "@types/mime-types": "^2.1.4",
@@ -46,7 +58,6 @@
     "typescript": "^5.3.3",
     "vitest": "^1.2.1"
   },
-  "license": "MIT",
   "publishConfig": {
     "access": "public"
   },