@fy-stack/secret-construct 0.0.125 → 0.0.127

package/README.md

@@ -1,7 +1,13 @@
-# secret-construct
+# Secrets Construct Documentation
 
-This library was generated with [Nx](https://nx.dev).
+## `SecretsConstruct`
 
-## Building
+A construct that manages and encapsulates AWS Secrets Manager secrets. This construct implements the `Attachable` and `Grantable` interfaces.
 
-Run `nx build secret-construct` to build the library.
+- **Properties**
+    - `secrets: secretsManager.Secret`
+        - The AWS Secrets Manager secret managed by this construct.
+
+- **Constructor**
+    - `constructor(scope: Construct, id: string, props: SecretConstructProps)`
+        - Initializes the secrets construct with a unique identifier and configuration options defined by `SecretConstructProps`.

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

@@ -3,6 +3,10 @@ import { IGrantable } from 'aws-cdk-lib/aws-iam';
 import * as secretsManager from 'aws-cdk-lib/aws-secretsmanager';
 import { Construct } from 'constructs';
 import type { SecretConstructProps } from './type';
+/**
+ * A construct that manages and encapsulates AWS Secrets Manager secrets.
+ * This construct implements the {@link Attachable `Attachable`} and {@link Grantable `Grantable`} interfaces.
+ */
 export declare class SecretsConstruct extends Construct implements Attachable, Grantable {
     readonly secrets: secretsManager.Secret;
     constructor(scope: Construct, id: string, props: SecretConstructProps);

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

@@ -1 +1 @@
-{"version":3,"file":"secret-construct.d.ts","sourceRoot":"","sources":["../../src/lib/secret-construct.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAEnD,qBAAa,gBAAiB,SAAQ,SAAU,YAAW,UAAU,EAAE,SAAS;IAC9E,SAAgB,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC;gBAEnC,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,oBAAoB;IAgCrE,UAAU;;;;IAOV,SAAS,CAAC,KAAK,EAAE,UAAU;CAG5B"}
+{"version":3,"file":"secret-construct.d.ts","sourceRoot":"","sources":["../../src/lib/secret-construct.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAEnD;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,SAAU,YAAW,UAAU,EAAE,SAAS;IAC9E,SAAgB,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC;gBAEnC,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,oBAAoB;IAgCrE,UAAU;;;;IAOV,SAAS,CAAC,KAAK,EAAE,UAAU;CAG5B"}

package/dist/lib/secret-construct.js

@@ -5,6 +5,10 @@ const tslib_1 = require("tslib");
 const cdk = tslib_1.__importStar(require("aws-cdk-lib"));
 const secretsManager = tslib_1.__importStar(require("aws-cdk-lib/aws-secretsmanager"));
 const constructs_1 = require("constructs");
+/**
+ * A construct that manages and encapsulates AWS Secrets Manager secrets.
+ * This construct implements the {@link Attachable `Attachable`} and {@link Grantable `Grantable`} interfaces.
+ */
 class SecretsConstruct extends constructs_1.Construct {
     secrets;
     constructor(scope, id, props) {

package/dist/lib/type.d.ts

@@ -1,6 +1,16 @@
 import { Attachable } from '@fy-stack/types';
+/**
+ * Interface representing the properties for the construction of secrets.
+ */
 export interface SecretConstructProps {
+    /**
+     * A collection of default static values to be added to the secrets created
+     * */
     secrets?: Record<string, string | undefined>;
+    /**
+     * A collection of resources that can be attached. The keys are resource names, and the values
+     * are an instance of {@link Attachable `Attachable`}.
+     */
     resources?: Record<string, Attachable | undefined>;
 }
 //# sourceMappingURL=type.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../src/lib/type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC,CAAA;CACnD"}
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../src/lib/type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;SAEK;IACL,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAE7C;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC,CAAA;CACnD"}

package/package.json

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