serverless-spy 0.0.35 → 0.0.37

package/.jsii

@@ -3149,7 +3149,7 @@
         },
         "locationInModule": {
           "filename": "src/ServerlessSpy.ts",
-          "line": 37
+          "line": 53
         },
         "parameters": [
           {
@@ -3176,7 +3176,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/ServerlessSpy.ts",
-        "line": 25
+        "line": 40
       },
       "methods": [
         {
@@ -3185,7 +3185,7 @@
           },
           "locationInModule": {
             "filename": "src/ServerlessSpy.ts",
-            "line": 499
+            "line": 696
           },
           "name": "getConstructName",
           "parameters": [
@@ -3201,6 +3201,56 @@
               "primitive": "string"
             }
           }
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Initalize spying on resources."
+          },
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 181
+          },
+          "name": "spy",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "Limit which resources to spy on."
+              },
+              "name": "filter",
+              "optional": true,
+              "type": {
+                "fqn": "serverless-spy.SpyFilter"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Initalize spying on resources given as parameter."
+          },
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 168
+          },
+          "name": "spyNodes",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "Which reources and their children to spy on."
+              },
+              "name": "nodes",
+              "type": {
+                "collection": {
+                  "elementtype": {
+                    "fqn": "constructs.IConstruct"
+                  },
+                  "kind": "array"
+                }
+              }
+            }
+          ]
         }
       ],
       "name": "ServerlessSpy",
@@ -3211,7 +3261,7 @@
           },
           "locationInModule": {
             "filename": "src/ServerlessSpy.ts",
-            "line": 34
+            "line": 49
           },
           "name": "serviceKeys",
           "type": {
@@ -3229,7 +3279,7 @@
           },
           "locationInModule": {
             "filename": "src/ServerlessSpy.ts",
-            "line": 35
+            "line": 51
           },
           "name": "wsUrl",
           "type": {
@@ -3249,7 +3299,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/ServerlessSpy.ts",
-        "line": 21
+        "line": 23
       },
       "name": "ServerlessSpyProps",
       "properties": [
@@ -3261,18 +3311,195 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/ServerlessSpy.ts",
-            "line": 22
+            "line": 26
+          },
+          "name": "debugMode",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 24
           },
           "name": "generateSpyEventsFileLocation",
           "optional": true,
           "type": {
             "primitive": "string"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 25
+          },
+          "name": "spySqsWithNoSubscriptionAndDropAllMessages",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
         }
       ],
       "symbolId": "src/ServerlessSpy:ServerlessSpyProps"
+    },
+    "serverless-spy.SpyFilter": {
+      "assembly": "serverless-spy",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "serverless-spy.SpyFilter",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/ServerlessSpy.ts",
+        "line": 29
+      },
+      "name": "SpyFilter",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 37
+          },
+          "name": "spyDynamoDB",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 34
+          },
+          "name": "spyEventBridge",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 35
+          },
+          "name": "spyEventBridgeRule",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 30
+          },
+          "name": "spyLambda",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 36
+          },
+          "name": "spyS3",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 33
+          },
+          "name": "spySnsSubsription",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 32
+          },
+          "name": "spySnsTopic",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/ServerlessSpy.ts",
+            "line": 31
+          },
+          "name": "spySqs",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/ServerlessSpy:SpyFilter"
     }
   },
-  "version": "0.0.35",
-  "fingerprint": "CrSQFHEJbLX+hmZLDJzSjii7Vc2X31+q7zNgfIU6LZ0="
+  "version": "0.0.37",
+  "fingerprint": "2ONtPCNqDS77f37Yu7YezgvB97Ze+xW6Ry3lp9Gp6YU="
 }

package/API.md

@@ -44,6 +44,8 @@ new ServerlessSpy(scope: Construct, id: string, props?: ServerlessSpyProps)
 | --- | --- |
 | <code><a href="#serverless-spy.ServerlessSpy.toString">toString</a></code> | Returns a string representation of this construct. |
 | <code><a href="#serverless-spy.ServerlessSpy.getConstructName">getConstructName</a></code> | *No description.* |
+| <code><a href="#serverless-spy.ServerlessSpy.spy">spy</a></code> | Initalize spying on resources. |
+| <code><a href="#serverless-spy.ServerlessSpy.spyNodes">spyNodes</a></code> | Initalize spying on resources given as parameter. |
 
 ---
 
@@ -67,6 +69,38 @@ public getConstructName(construct: IConstruct): string
 
 ---
 
+##### `spy` <a name="spy" id="serverless-spy.ServerlessSpy.spy"></a>
+
+```typescript
+public spy(filter?: SpyFilter): void
+```
+
+Initalize spying on resources.
+
+###### `filter`<sup>Optional</sup> <a name="filter" id="serverless-spy.ServerlessSpy.spy.parameter.filter"></a>
+
+- *Type:* <a href="#serverless-spy.SpyFilter">SpyFilter</a>
+
+Limit which resources to spy on.
+
+---
+
+##### `spyNodes` <a name="spyNodes" id="serverless-spy.ServerlessSpy.spyNodes"></a>
+
+```typescript
+public spyNodes(nodes: IConstruct[]): void
+```
+
+Initalize spying on resources given as parameter.
+
+###### `nodes`<sup>Required</sup> <a name="nodes" id="serverless-spy.ServerlessSpy.spyNodes.parameter.nodes"></a>
+
+- *Type:* constructs.IConstruct[]
+
+Which reources and their children to spy on.
+
+---
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -152,7 +186,19 @@ const serverlessSpyProps: ServerlessSpyProps = { ... }
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
+| <code><a href="#serverless-spy.ServerlessSpyProps.property.debugMode">debugMode</a></code> | <code>boolean</code> | *No description.* |
 | <code><a href="#serverless-spy.ServerlessSpyProps.property.generateSpyEventsFileLocation">generateSpyEventsFileLocation</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#serverless-spy.ServerlessSpyProps.property.spySqsWithNoSubscriptionAndDropAllMessages">spySqsWithNoSubscriptionAndDropAllMessages</a></code> | <code>boolean</code> | *No description.* |
+
+---
+
+##### `debugMode`<sup>Optional</sup> <a name="debugMode" id="serverless-spy.ServerlessSpyProps.property.debugMode"></a>
+
+```typescript
+public readonly debugMode: boolean;
+```
+
+- *Type:* boolean
 
 ---
 
@@ -166,5 +212,120 @@ public readonly generateSpyEventsFileLocation: string;
 
 ---
 
+##### `spySqsWithNoSubscriptionAndDropAllMessages`<sup>Optional</sup> <a name="spySqsWithNoSubscriptionAndDropAllMessages" id="serverless-spy.ServerlessSpyProps.property.spySqsWithNoSubscriptionAndDropAllMessages"></a>
+
+```typescript
+public readonly spySqsWithNoSubscriptionAndDropAllMessages: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+### SpyFilter <a name="SpyFilter" id="serverless-spy.SpyFilter"></a>
+
+#### Initializer <a name="Initializer" id="serverless-spy.SpyFilter.Initializer"></a>
+
+```typescript
+import { SpyFilter } from 'serverless-spy'
+
+const spyFilter: SpyFilter = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#serverless-spy.SpyFilter.property.spyDynamoDB">spyDynamoDB</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spyEventBridge">spyEventBridge</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spyEventBridgeRule">spyEventBridgeRule</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spyLambda">spyLambda</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spyS3">spyS3</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spySnsSubsription">spySnsSubsription</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spySnsTopic">spySnsTopic</a></code> | <code>boolean</code> | *No description.* |
+| <code><a href="#serverless-spy.SpyFilter.property.spySqs">spySqs</a></code> | <code>boolean</code> | *No description.* |
+
+---
+
+##### `spyDynamoDB`<sup>Optional</sup> <a name="spyDynamoDB" id="serverless-spy.SpyFilter.property.spyDynamoDB"></a>
+
+```typescript
+public readonly spyDynamoDB: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spyEventBridge`<sup>Optional</sup> <a name="spyEventBridge" id="serverless-spy.SpyFilter.property.spyEventBridge"></a>
+
+```typescript
+public readonly spyEventBridge: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spyEventBridgeRule`<sup>Optional</sup> <a name="spyEventBridgeRule" id="serverless-spy.SpyFilter.property.spyEventBridgeRule"></a>
+
+```typescript
+public readonly spyEventBridgeRule: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spyLambda`<sup>Optional</sup> <a name="spyLambda" id="serverless-spy.SpyFilter.property.spyLambda"></a>
+
+```typescript
+public readonly spyLambda: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spyS3`<sup>Optional</sup> <a name="spyS3" id="serverless-spy.SpyFilter.property.spyS3"></a>
+
+```typescript
+public readonly spyS3: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spySnsSubsription`<sup>Optional</sup> <a name="spySnsSubsription" id="serverless-spy.SpyFilter.property.spySnsSubsription"></a>
+
+```typescript
+public readonly spySnsSubsription: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spySnsTopic`<sup>Optional</sup> <a name="spySnsTopic" id="serverless-spy.SpyFilter.property.spySnsTopic"></a>
+
+```typescript
+public readonly spySnsTopic: boolean;
+```
+
+- *Type:* boolean
+
+---
+
+##### `spySqs`<sup>Optional</sup> <a name="spySqs" id="serverless-spy.SpyFilter.property.spySqs"></a>
+
+```typescript
+public readonly spySqs: boolean;
+```
+
+- *Type:* boolean
+
+---
+