@fy-stack/cdn-construct 0.0.124 → 0.0.126

package/README.md

@@ -1,7 +1,19 @@
-# cdn-construct
 
-This library was generated with [Nx](https://nx.dev).
+# CDN Construct Documentation
 
-## Building
+## `CDNConstruct`
+
+The `CDNConstruct` class is a custom AWS CDK construct that sets up a CloudFront distribution based on the provided routing and resource configurations.
+
+- **Properties**
+    - `distribution: cloudfront.Distribution`
+        - The CloudFront distribution managed by this construct.
+
+- **Constructor**
+    - `constructor(scope: Construct, id: string, props: CDNConstructProps)`
+        - Initializes the CDN construct with a unique identifier and configuration options defined by `CDNConstructProps`.
+        - **Parameters**
+            - `scope`: The scope in which this construct is defined.
+            - `id`: The unique identifier for this construct.
+            - `props`: Properties required to set up the CDN construct, including route mappings and resource configurations.
 
-Run `nx build cdn-construct` to build the library.

package/dist/lib/cdn-construct.d.ts

@@ -1,6 +1,10 @@
 import * as cloudfront from 'aws-cdk-lib/aws-cloudfront';
 import { Construct } from 'constructs';
 import { CDNConstructProps } from './types';
+/**
+ * CDNConstruct is a custom construct that sets up a CloudFront distribution
+ * based on provided routing and resource configurations.
+ */
 export declare class CDNConstruct extends Construct {
     distribution: cloudfront.Distribution;
     constructor(scope: Construct, id: string, props: CDNConstructProps);

package/dist/lib/cdn-construct.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cdn-construct.d.ts","sourceRoot":"","sources":["../../src/lib/cdn-construct.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE5C,qBAAa,YAAa,SAAQ,SAAS;IAClC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;gBAEjC,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB;CAsDnE"}
+{"version":3,"file":"cdn-construct.d.ts","sourceRoot":"","sources":["../../src/lib/cdn-construct.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE5C;;;GAGG;AACH,qBAAa,YAAa,SAAQ,SAAS;IAClC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;gBAEjC,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB;CAkCnE"}

package/dist/lib/cdn-construct.js

@@ -4,6 +4,10 @@ exports.CDNConstruct = void 0;
 const tslib_1 = require("tslib");
 const cloudfront = tslib_1.__importStar(require("aws-cdk-lib/aws-cloudfront"));
 const constructs_1 = require("constructs");
+/**
+ * CDNConstruct is a custom construct that sets up a CloudFront distribution
+ * based on provided routing and resource configurations.
+ */
 class CDNConstruct extends constructs_1.Construct {
     distribution;
     constructor(scope, id, props) {
@@ -29,25 +33,6 @@ class CDNConstruct extends constructs_1.Construct {
             additionalBehaviors,
             priceClass: cloudfront.PriceClass.PRICE_CLASS_100,
         });
-        /*if (props.storage && uploadEnabled) {
-          props.storage.bucket.addToResourcePolicy(
-            new iam.PolicyStatement({
-              effect: iam.Effect.ALLOW,
-              actions: ['s3:GetObject'],
-              principals: [new iam.ServicePrincipal('cloudfront.amazonaws.com')],
-              resources: ['arn:aws:s3:::' + props.storage.bucket.bucketName + '/!*'],
-              conditions: {
-                StringEquals: {
-                  'AWS:SourceArn':
-                    'arn:aws:cloudfront::' +
-                    account +
-                    ':distribution/' +
-                    this.distribution.distributionId,
-                },
-              },
-            })
-          );
-        }*/
     }
 }
 exports.CDNConstruct = CDNConstruct;

package/dist/lib/types.d.ts

@@ -1,6 +1,12 @@
 import type { CDNResource, ResourceRef } from '@fy-stack/types';
 export interface CDNConstructProps {
+    /**
+     * A mapping of route paths to resource references
+     * */
     routes: Record<string, ResourceRef>;
+    /**
+     * An optional mapping of resource names to CDN resources.
+     * */
     resources?: Record<string, CDNResource | undefined>;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEhE,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC,CAAC;CACrD"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEhE,MAAM,WAAW,iBAAiB;IAChC;;SAEK;IACL,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACpC;;SAEK;IACL,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC,CAAC;CACrD"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@fy-stack/cdn-construct",
-  "version": "0.0.124",
+  "version": "0.0.126",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@fy-stack/types": "0.0.124"
+    "@fy-stack/types": "0.0.126"
   },
   "peerDependencies": {
-    "aws-cdk-lib": "2.164.1",
+    "aws-cdk-lib": "2.166.0",
     "constructs": "10.4.2"
   },
   "type": "commonjs",