docs(packages): rename package

aws · Mar 22, 2022 · ab7d755 · ab7d755
1 parent 58321e4
commit ab7d755
Show file tree

Hide file tree

Showing 10 changed files with 7 additions and 7 deletions.
diff --git a/...cloudfront-request-presigner/CHANGELOG.md → packages/cloudfront-sign/CHANGELOG.md b/...cloudfront-request-presigner/CHANGELOG.md → packages/cloudfront-sign/CHANGELOG.md
diff --git a/...ages/cloudfront-request-presigner/LICENSE → packages/cloudfront-sign/LICENSE b/...ages/cloudfront-request-presigner/LICENSE → packages/cloudfront-sign/LICENSE
diff --git a/...es/cloudfront-request-presigner/README.md → packages/cloudfront-sign/README.md b/...es/cloudfront-request-presigner/README.md → packages/cloudfront-sign/README.md
@@ -1,6 +1,6 @@
-# @aws-sdk/cloudfront-request-presigner
+# @aws-sdk/cloudfront-sign
 
-This package provides a presigner based on a CloudFront trusted key group key pair to generate signed urls and cookies for accessing private content on CloudFront.
+This package provides functions to generate signed urls and cookies for accessing private content on CloudFront based on a CloudFront trusted key group key pair.
 
 > Please note the process for creating a pre-signed URL with Cloudfront is very different than the process for S3. For more information, please visit the documentation for [restricting CloudFront content with signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html).
 
@@ -9,7 +9,7 @@ This package provides a presigner based on a CloudFront trusted key group key pa
 JavaScript Example:
 
 ```javascript
-const { signUrl } = require("@aws-sdk/cloudfront-request-presigner");
+const { signUrl } = require("@aws-sdk/cloudfront-sign");
 const cloudfrontDistributionDomain = "https://d111111abcdef8.cloudfront.net";
 const s3ObjectKey = "private-content/private.jpeg";
 const url = `${cloudfrontDistributionDomain}/${s3ObjectKey}`;
@@ -27,7 +27,7 @@ const signedUrl = signUrl({
 ES6 Example
 
 ```javascript
-import { signUrl } from "@aws-sdk/cloudfront-request-presigner";
+import { signUrl } from "@aws-sdk/cloudfront-sign";
 const cloudfrontDistributionDomain = "https://d111111abcdef8.cloudfront.net";
 const s3ObjectKey = "private-content/private.jpeg";
 const url = `${cloudfrontDistributionDomain}/${s3ObjectKey}`;

diff --git a/...oudfront-request-presigner/jest.config.js → packages/cloudfront-sign/jest.config.js b/...oudfront-request-presigner/jest.config.js → packages/cloudfront-sign/jest.config.js
diff --git a/...cloudfront-request-presigner/package.json → packages/cloudfront-sign/package.json b/...cloudfront-request-presigner/package.json → packages/cloudfront-sign/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@aws-sdk/cloudfront-request-presigner",
+  "name": "@aws-sdk/cloudfront-sign",
   "version": "0.0.1",
   "scripts": {
     "prepublishOnly": "yarn build:cjs && yarn build:es",
@@ -38,10 +38,10 @@
       ]
     }
   },
-  "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/master/packages/cloudfront-request-presigner",
+  "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/master/packages/cloudfront-sign",
   "repository": {
     "type": "git",
     "url": "https://github.com/aws/aws-sdk-js-v3.git",
-    "directory": "packages/cloudfront-request-presigner"
+    "directory": "packages/cloudfront-sign"
   }
 }
diff --git a/...cloudfront-request-presigner/src/index.ts → packages/cloudfront-sign/src/index.ts b/...cloudfront-request-presigner/src/index.ts → packages/cloudfront-sign/src/index.ts
diff --git a/...dfront-request-presigner/src/sign.spec.ts → packages/cloudfront-sign/src/sign.spec.ts b/...dfront-request-presigner/src/sign.spec.ts → packages/cloudfront-sign/src/sign.spec.ts
diff --git a/.../cloudfront-request-presigner/src/sign.ts → packages/cloudfront-sign/src/sign.ts b/.../cloudfront-request-presigner/src/sign.ts → packages/cloudfront-sign/src/sign.ts
diff --git a/...front-request-presigner/tsconfig.cjs.json → packages/cloudfront-sign/tsconfig.cjs.json b/...front-request-presigner/tsconfig.cjs.json → packages/cloudfront-sign/tsconfig.cjs.json
diff --git a/...dfront-request-presigner/tsconfig.es.json → packages/cloudfront-sign/tsconfig.es.json b/...dfront-request-presigner/tsconfig.es.json → packages/cloudfront-sign/tsconfig.es.json