feat(redis-sp): add basic synchronization primitives

Author: format-x

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{js, ts, json}]
+indent_size = 2
+indent_style = space
+
+[*.{js, ts}]
+max_line_length = 120

.github/workflows/publish-package-to-npmjs.yml

@@ -0,0 +1,18 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,11 @@
+# JetBrains
+.idea/
+
+# Node.js
+node_modules/
+
+# Jest
+coverage/
+
+#Local
+dist/

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 120
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Dmitriy Shiryayev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,66 @@
-# redis-sp
+# redis-sp
+
+Redis SP (SP stands for Synchronization Primitives) is a set of synchronization primitives based on
+the [Redlock](https://redis.io/docs/reference/patterns/distributed-locks/) algorithm.
+
+## Installation
+
+```
+npm install redis-sp
+```
+
+## Usage
+
+### Mutex
+
+Mutex implementation based on the [Redlock](https://redis.io/docs/reference/patterns/distributed-locks/) algorithm
+
+```typescript
+import RedisClient from 'ioredis';
+import { RedisMutex } from 'redis-sp';
+
+async function main() {
+  const client = new RedisClient();
+
+  const mutex = new RedisMutex([client], getResourceIdSomehow());
+  await mutex.lock();
+
+  try {
+    // critical section of your code
+    await maybeFails();
+  } finally {
+    await mutex.unlock();
+  }
+}
+```
+
+### Counting Semaphore
+
+Implementation of a counting semaphore according to
+the [Fair semaphores | Redis](https://redis.com/ebook/part-2-core-concepts/chapter-6-application-components-in-redis/6-3-counting-semaphores/6-3-2-fair-semaphores/)
+with a slight difference (no race conditions due to the atomicity of Redis Lua scripts).
+
+```typescript
+import RedisClient from 'ioredis';
+import { RedisCountingSemaphore } from 'redis-sp';
+
+async function main() {
+  const client = new RedisClient();
+
+  const semaphore = new RedisCountingSemaphore(
+    [client],
+    getSharedResourceIdSomehow(),
+    getMaxSharedResourceOwnersSomehow(),
+  );
+  await semaphore.acquire();
+
+  try {
+    // critical section of your code
+    await maybeFails();
+  } finally {
+    await semaphore.release();
+  }
+}
+```
+
+Stay tuned for RW lock in the next major release!