@dontirun/state-machine-semaphore 0.1.239 → 0.1.241

package/.jsii

@@ -3308,6 +3308,6 @@
       "symbolId": "src/index:TableReadWriteCapacity"
     }
   },
-  "version": "0.1.239",
-  "fingerprint": "nR75levPebWNbklVznGzxIVlAkHWaInBcFBUb0MAgTU="
+  "version": "0.1.241",
+  "fingerprint": "38Rmryt1BB8FUd3E90oQpiSrgOc71UUtpqOH6xDHwt8="
 }

package/API.md

@@ -1,3 +1,123 @@
+# @dontirun/state-machine-semaphore
+
+[![npm version](https://img.shields.io/npm/v/@dontirun/state-machine-semaphore.svg)](https://img.shields.io/npm/v/@dontirun/state-machine-semaphore)
+[![PyPI version](https://img.shields.io/pypi/v/state-machine-semaphore.svg)](https://pypi.org/project/state-machine-semaphore)
+[![NuGet version](https://img.shields.io/nuget/v/Dontirun.StateMachineSemaphore)](https://www.nuget.org/packages/Dontirun.StateMachineSemaphore)
+[![Maven version](https://img.shields.io/maven-central/v/io.github.dontirun/statemachinesemaphore)](https://search.maven.org/artifact/io.github.dontirun/statemachinesemaphore)
+[![Go version](https://img.shields.io/github/go-mod/go-version/dontirun/state-machine-semaphore-go?color=orange&filename=dontirunstatemachinesemaphore%2Fgo.mod)](https://github.com/dontirun/state-machine-semaphore-go)
+
+[![View on Construct Hub](https://constructs.dev/badge?package=%40dontirun%2Fstate-machine-semaphore)](https://constructs.dev/packages/@dontirun/state-machine-semaphore)
+
+An [aws-cdk](https://github.com/aws/aws-cdk) construct that enables you to use AWS Step Functions to control concurrency in your distributed system. You can use this construct to distributed state machine semaphores to control concurrent invocations of contentious work.
+
+This construct is based off of [Justin Callison's](https://github.com/JustinCallison) example [code](https://github.com/aws-samples/aws-stepfunctions-examples/blob/main/sam/app-control-concurrency-with-dynamodb/statemachines/dynamodb-semaphore.asl.json). Make sure to check out Justin's [blogpost](https://aws.amazon.com/blogs/compute/controlling-concurrency-in-distributed-systems-using-aws-step-functions/) to learn about how the system works.
+
+## Examples
+
+### Example 1) A state machine with a controlled job
+
+<details>
+
+<summary>Click to see code</summary>
+
+```typescript
+import { Function } from 'aws-cdk-lib/aws-lambda';
+import { Duration, Stack, StackProps } from 'aws-cdk-lib';
+import { StateMachine, Succeed, Wait, WaitTime } from 'aws-cdk-lib/aws-stepfunctions';
+import { LambdaInvoke } from 'aws-cdk-lib/aws-stepfunctions-tasks';
+import { Construct } from 'constructs';
+import { Semaphore } from '@dontirun/state-machine-semaphore';
+
+
+export class CdkTestStack extends Stack {
+  constructor(scope: Construct, id: string, props?: StackProps) {
+    super(scope, id, props);
+
+    const contestedJob = new LambdaInvoke(this, 'ContestedJobPart1', {
+      lambdaFunction: Function.fromFunctionName(this, 'JobFunctionPart1', 'cool-function'),
+    }).next(new Wait(this, 'Wait', { time: WaitTime.duration(Duration.seconds(7)) }))
+      .next(new Wait(this, 'AnotherWait', { time: WaitTime.duration(Duration.seconds(7)) }))
+      .next(new Wait(this, 'YetAnotherWait', { time: WaitTime.duration(Duration.seconds(7)) }));
+
+    const afterContestedJob = new Succeed(this, 'Succeed');
+
+    const stateMachineFragment = new Semaphore(stack, 'Semaphore', { lockName: 'life', limit: 42, job: contestedJob, nextState: afterContestedJob });
+
+    new StateMachine(this, 'StateMachine', {
+      definition: stateMachineFragment,
+    });
+  }
+}
+```
+
+</details>
+
+
+<details>
+
+<summary>Click to see the state machine definition</summary>
+
+![Example 1 Definition](./images/Example1_Graph_Edit.png)
+</details>
+
+
+### Example 2) A state machine with multiple semaphores
+
+<details>
+
+<summary>Click to see code</summary>
+
+```typescript
+import { Function } from 'aws-cdk-lib/aws-lambda';
+import { Duration, Stack, StackProps } from 'aws-cdk-lib';
+import { StateMachine, Succeed, Wait, WaitTime } from 'aws-cdk-lib/aws-stepfunctions';
+import { LambdaInvoke } from 'aws-cdk-lib/aws-stepfunctions-tasks';
+import { Construct } from 'constructs';
+import { Semaphore } from '@dontirun/state-machine-semaphore';
+
+
+export class CdkTestStack extends Stack {
+  constructor(scope: Construct, id: string, props?: StackProps) {
+    super(scope, id, props);
+
+    const contestedJob = new LambdaInvoke(this, 'ContestedJobPart1', {
+      lambdaFunction: Function.fromFunctionName(this, 'JobFunctionPart1', 'cool-function'),
+    })
+    const notContestedJob = new LambdaInvoke(this, 'NotContestedJob', {
+      lambdaFunction: Function.fromFunctionName(this, 'NotContestedJobFunction', 'cooler-function'),
+    })
+    const contestedJob2 = new LambdaInvoke(this, 'ContestedJobPart2', {
+      lambdaFunction: Function.fromFunctionName(this, 'JobFunctionPart2', 'coolest-function'),
+    })
+    const afterContestedJob2 = new Succeed(this, 'Succeed');
+
+    const definition = new Semaphore(stack, 'Semaphore', { lockName: 'life', limit: 42, job: contestedJob, nextState: notContestedJob })
+      .next(new Semaphore(stack, 'Semaphore2', { lockName: 'liberty', limit: 7, job: contestedJob2, nextState: afterContestedJob2 }));
+
+    new StateMachine(this, 'StateMachine', {
+      definition: definition,
+    });
+  }
+}
+```
+
+</details>
+
+<details>
+
+<summary>Click to see the state machine definition</summary>
+
+![Example 2 Definition](./images/Example2_Graph_Edit.png)
+</details>
+
+## API Reference
+
+See [API.md](./API.md).
+
+## License
+
+This project is licensed under the Apache-2.0 License.
+
 # API Reference <a name="API Reference" id="api-reference"></a>
 
 ## Constructs <a name="Constructs" id="Constructs"></a>

package/lib/index.js

@@ -177,7 +177,7 @@ class Semaphore extends aws_stepfunctions_1.StateMachineFragment {
 }
 exports.Semaphore = Semaphore;
 _a = JSII_RTTI_SYMBOL_1;
-Semaphore[_a] = { fqn: "@dontirun/state-machine-semaphore.Semaphore", version: "0.1.239" };
+Semaphore[_a] = { fqn: "@dontirun/state-machine-semaphore.Semaphore", version: "0.1.241" };
 /**
  * The names and associated concurrency limits and number of uses of the sempahores.
  */

package/package.json

@@ -54,10 +54,10 @@
     "jest-junit": "^15",
     "jsii": "1.x",
     "jsii-diff": "^1.80.0",
-    "jsii-docgen": "^7.1.46",
+    "jsii-docgen": "^7.2.1",
     "jsii-pacmak": "^1.80.0",
     "npm-check-updates": "^16",
-    "projen": "^0.71.11",
+    "projen": "^0.71.16",
     "standard-version": "^9",
     "ts-jest": "^27",
     "typescript": "^4.9.5"
@@ -78,7 +78,7 @@
   ],
   "main": "lib/index.js",
   "license": "Apache-2.0",
-  "version": "0.1.239",
+  "version": "0.1.241",
   "jest": {
     "testMatch": [
       "<rootDir>/src/**/__tests__/**/*.ts?(x)",