@fy-stack/types 0.0.125 → 0.0.127

package/README.md

@@ -1,7 +1,62 @@
-# types
 
-This library was generated with [Nx](https://nx.dev).
+# FY-Stack Types
 
-## Building
+This module defines several interfaces for managing FY-Stack resources. These interfaces support actions like attaching resources, granting permissions, and integrating with CloudFront, SNS, and API Gateway.
 
-Run `nx build types` to build the library.
+## Interfaces
+
+### `Attachable`
+Represents a resource that can be attached to other resources.
+
+- **Method**
+    - `attachable(): Record<string, string>` 
+      Returns a set of key-value pairs representing the attributes needed to attach this resource to another. The keys and values in the returned object are specific to the resource.
+
+### `Attach`
+Represents a resource that can attach `Attachable` resources to itself.
+
+- **Method**
+    - `attach(attachable: Record<string, Attachable>): void`
+      Takes an object of `Attachable` resources and attaches each to the current resource. The `Attachable` resources are provided as a map, where each key-value pair represents a resource to be attached.
+
+### `Grantable`
+Represents a resource that can grant permissions to other resources.
+
+- **Method**
+    - `grantable(grant: IGrantable): void`
+      Accepts an `IGrantable` object and grants it the necessary permissions to interact with this resource.
+
+### `Grant`
+Represents a resource that can be granted permissions by other resources.
+
+- **Method**
+    - `grant(...grantables: Grantable[]): void`
+      Accepts multiple `Grantable` resources and initializes permission grants for each. This allows the resource to manage permission relationships with multiple other resources.
+
+### `CDNResource`
+Represents a resource that can be associated with a CloudFront distribution.
+
+- **Method**
+    - `cloudfront(path: string): Record<string, BehaviorOptions>`
+      Generates and returns a mapping of paths to CloudFront `BehaviorOptions`, which define how the resource should behave when distributed via CloudFront.
+
+### `Event`
+Represents a resource that can subscribe to an SNS topic.
+
+- **Method**
+    - `subscription(props: SubscriptionProps): ITopicSubscription`
+      Subscribes the resource to an SNS topic using the provided subscription properties. Returns an `ITopicSubscription` object representing the subscription.
+
+### `ApiResource`
+Represents a resource that can be integrated with an API Gateway.
+
+- **Method**
+    - `api(path: string): Record<string, HttpRouteIntegration>`
+      Generates a mapping of paths to API Gateway `HttpRouteIntegration`, allowing the resource to be exposed via an API Gateway route.
+
+### `ResourceRef`
+A type definition for referencing existing resources within an application, identified by name.
+
+- **Properties**
+    - `$resource: T`
+      Represents the name of the application or resource, allowing it to be referenced by name within the system. This is useful for referencing resources like `auth` or `uploads`.

package/dist/lib/types.d.ts

@@ -3,28 +3,76 @@ import type { BehaviorOptions } from 'aws-cdk-lib/aws-cloudfront';
 import type { IGrantable } from 'aws-cdk-lib/aws-iam';
 import type { ITopicSubscription } from 'aws-cdk-lib/aws-sns';
 import type { SubscriptionProps } from 'aws-cdk-lib/aws-sns-subscriptions';
+/**
+ * Resource can be attached to other resources
+ * */
 export interface Attachable {
+    /**
+     * Return values needed to enable resource to be attached
+     * */
     attachable(): Record<string, string>;
 }
+/**
+ * Other resources can be attached to this resource
+ * */
 export interface Attach {
+    /**
+     * Attach Attachable resources to Resource
+     * */
     attach(attachable: Record<string, Attachable>): void;
 }
+/**
+ * Resource can grant permission resources
+ * */
 export interface Grantable {
+    /**
+     * Grant permissions to IGrantable resource
+     * */
     grantable(grant: IGrantable): void;
 }
+/**
+ * Resource can be granted permissions by resources
+ * */
 export interface Grant {
+    /**
+     * Initialize permission grants from Grantable resources
+     * */
     grant(...grantables: Grantable[]): void;
 }
+/**
+ * Resource can be attached to a Cloudfront distribution
+ * */
 export interface CDNResource {
+    /**
+     * Generate map of paths to Cloudfront BehaviorOptions.
+     * */
     cloudfront(path: string): Record<string, BehaviorOptions>;
 }
+/**
+ * Resource can subscribe to an SNS topic
+ * */
 export interface Event {
+    /**
+     * Subscribe to SNS topic.
+     * */
     subscription(props: SubscriptionProps): ITopicSubscription;
 }
+/**
+ * Resource can be attached to an API gateway
+ * */
 export interface ApiResource {
+    /**
+     * Generate map of paths to API gateway HttpRouteIntegration.
+     * */
     api(path: string): Record<string, HttpRouteIntegration>;
 }
+/**
+ * Reference existing application or resource e.g. auth.
+ * */
 export type ResourceRef<T extends string = string> = {
+    /**
+     * Name of app or resources e.g. uploads, auth.
+     * */
     $resource: T;
 };
 //# 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,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAE3E,MAAM,WAAW,UAAU;IACzB,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,WAAW,SAAS;IACxB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,KAAK;IACpB,KAAK,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;CACzC;AAED,MAAM,WAAW,WAAW;IAC1B,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC3D;AAED,MAAM,WAAW,KAAK;IACpB,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,kBAAkB,CAAC;CAC5D;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CACzD;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAE3E;;KAEK;AACL,MAAM,WAAW,UAAU;IACzB;;SAEK;IACL,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED;;KAEK;AACL,MAAM,WAAW,MAAM;IACrB;;SAEK;IACL,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC;CACtD;AAED;;KAEK;AACL,MAAM,WAAW,SAAS;IACxB;;SAEK;IACL,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;CACpC;AAED;;KAEK;AACL,MAAM,WAAW,KAAK;IACpB;;SAEK;IACL,KAAK,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;CACzC;AAED;;KAEK;AACL,MAAM,WAAW,WAAW;IAC1B;;SAEK;IACL,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC3D;AAED;;KAEK;AACL,MAAM,WAAW,KAAK;IACpB;;SAEK;IACL,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,kBAAkB,CAAC;CAC5D;AAED;;KAEK;AACL,MAAM,WAAW,WAAW;IAC1B;;SAEK;IACL,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CACzD;AAED;;KAEK;AACL,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IACnD;;SAEK;IACL,SAAS,EAAE,CAAC,CAAC;CACd,CAAC"}

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "@fy-stack/types",
-  "version": "0.0.125",
+  "version": "0.0.127",
   "dependencies": {
-    "tslib": "^2.3.0",
-    "aws-cdk-lib": "2.164.1"
+    "tslib": "^2.3.0"
+  },
+  "peerDependencies": {
+    "aws-cdk-lib": "2.166.0"
   },
   "type": "commonjs",
   "main": "./dist/index.js",