feat(*): first release of @csquare/ldapjs-client

Author: Mathieu Bour

.github/workflows/publish.yaml

@@ -0,0 +1,65 @@
+name: Publish on NPM registry
+on:
+  push:
+    branches: [main]
+    tags: ['**']
+  pull_request:
+    types: [opened, synchronize]
+jobs:
+  format:
+    name: Check format with Prettier
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '15'
+          registry-url: https://npm.pkg.github.com
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: Install NPM dependencies
+        run: npm install
+      - name: Run Prettier
+        run: npm run format:check
+  publish:
+    name: Publish to GitHub registry
+    needs: [format]
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-20.04
+    env:
+      HUSKY: '0'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Ensure tag validity
+        run: |
+          if [ $(jq -r .version package.json) != ${GITHUB_REF/refs\/tags\//} ]; then
+            echo "Error: $GITHUB_REF does not match package.json version"
+            exit 1
+          fi
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '15'
+          registry-url: https://npm.pkg.github.com
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: Install NPM dependencies
+        run: npm install
+      - name: Publish new release
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NODE_AUTH_TOKEN }}
+          access: public

.gitignore

@@ -0,0 +1,3 @@
+.idea/
+dist/
+node_modules/

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install standard-commithook

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install lint-staged

.lintstagedrc.yaml

@@ -0,0 +1,2 @@
+'**/*.{js,jsx,ts,tsx,json,css,scss,md}':
+  - prettier --write

.prettierignore

@@ -0,0 +1,4 @@
+.idea/
+dist/
+node_modules/
+package-lock.json

.standard-commitrc.json

@@ -0,0 +1,5 @@
+{
+  "types": ["feat", "fix", "chore", "build", "ci", "docs", "perf", "refactor", "revert", "style", "test"],
+  "promptScope": "suggest",
+  "scopes": "staged"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Cohesive Computing SA
+
+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

@@ -0,0 +1,34 @@
+# @csquare/ldapjs-client
+
+Promisified version of the `ldapjs` package with additional typings.
+
+## Acknowledgments
+
+This library heavily relies on the [ldapjs](https://github.com/ldapjs/node-ldapjs) package.
+Please see http://ldapjs.org/ for the complete detailed usage.
+
+## Installation
+
+Install with npm:
+
+```shell
+npm install --save @csquare/ldapjs-client
+```
+
+Install with Yarn:
+
+```shell
+yarn add @csquare/ldapjs-client
+```
+
+## Usage
+
+```typescript
+import { createClient } from '@csquare/ldapjs-client';
+
+(async () => {
+  const options = {};
+  const client = createClient(options);
+  await client.bind(/* args */);
+})();
+```