Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/add-cloudfront.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@effect-aws/cloudfront": minor
---

Add the `@effect-aws/cloudfront` package with a Layer-based Effect wrapper around the AWS CloudFront signing helpers.
9 changes: 9 additions & 0 deletions .projenrc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,15 @@ new TypeScriptLibProject({
peerDeps: ["effect@>=3.15.5 <4.0.0"],
});

new TypeScriptLibProject({
parent: project,
name: "cloudfront",
description: "Effectful AWS CloudFront modules",
deps: ["@aws-sdk/cloudfront-signer@^3"],
devDeps: [...effectDeps],
peerDeps: ["effect@>=3.15.5 <4.0.0"],
});

project.addGitIgnore("/.direnv"); // flake environment creates .direnv folder
project.addGitIgnore("/docs"); // docs are generated
project.addGitIgnore(".idea");
Expand Down
21 changes: 21 additions & 0 deletions packages/cloudfront/.gitattributes

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 44 additions & 0 deletions packages/cloudfront/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions packages/cloudfront/.npmignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 29 additions & 0 deletions packages/cloudfront/.projen/deps.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions packages/cloudfront/.projen/files.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

120 changes: 120 additions & 0 deletions packages/cloudfront/.projen/tasks.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions packages/cloudfront/LICENSE

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

90 changes: 90 additions & 0 deletions packages/cloudfront/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# @effect-aws/cloudfront

[![npm version](https://img.shields.io/npm/v/%40effect-aws%2Fcloudfront?color=brightgreen&label=npm%20package)](https://www.npmjs.com/package/@effect-aws/cloudfront)
[![npm downloads](https://img.shields.io/npm/dm/%40effect-aws%2Fcloudfront)](https://www.npmjs.com/package/@effect-aws/cloudfront)

This package provides Effect modules for AWS CloudFront utilities.

## Installation

```bash
npm install --save @effect-aws/cloudfront
```

## Usage

### Signed URL

```ts
import { CloudFrontSigner } from "@effect-aws/cloudfront"
import { Effect } from "effect"

const program = CloudFrontSigner.getSignedUrl({
url: "https://d111111abcdef8.cloudfront.net/private-content/private.jpeg",
dateLessThan: new Date(Date.now() + 60 * 60 * 1000)
})

const result = program.pipe(
Effect.provide(
CloudFrontSigner.layer({
keyPairId: "K2JCJMDEHXQW5F",
privateKey: "CONTENTS-OF-PRIVATE-KEY"
})
),
Effect.runPromise
)
```

### Signed Cookies

```ts
import { CloudFrontSigner } from "@effect-aws/cloudfront"
import { Effect } from "effect"

const program = CloudFrontSigner.getSignedCookies({
url: "https://d111111abcdef8.cloudfront.net/private-content/*",
dateLessThan: new Date(Date.now() + 60 * 60 * 1000)
})

const result = program.pipe(
Effect.provide(
CloudFrontSigner.layer({
keyPairId: "K2JCJMDEHXQW5F",
privateKey: "CONTENTS-OF-PRIVATE-KEY"
})
),
Effect.runPromise
)
```

### Custom Policy

```ts
import { CloudFrontSigner } from "@effect-aws/cloudfront"
import { Effect } from "effect"

const policy = JSON.stringify({
Statement: [
{
Resource: "https://d111111abcdef8.cloudfront.net/private-content/*",
Condition: {
DateLessThan: {
"AWS:EpochTime": Math.floor(Date.now() / 1000) + 3600
}
}
}
]
})

const program = CloudFrontSigner.getSignedUrl({ policy })

const result = program.pipe(
Effect.provide(
CloudFrontSigner.layer({
keyPairId: "K2JCJMDEHXQW5F",
privateKey: "CONTENTS-OF-PRIVATE-KEY"
})
),
Effect.runPromise
)
```
Loading
Loading