feat: initial commit (#2)

.eslintignore

@@ -0,0 +1,10 @@
+# Node modules
+node_modules
+
+# Build, examples
+dist
+examples
+
+# Config
+.eslintrc.cjs
+commitlint.config.cjs

.eslintrc.cjs

@@ -0,0 +1,26 @@
+module.exports = {
+  env: {
+    es2021: true,
+    node: true,
+    commonjs: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "prettier",
+  ],
+  plugins: ["@typescript-eslint"],
+  parser: "@typescript-eslint/parser",
+  overrides: [],
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+    project: "./tsconfig.json",
+  },
+  rules: {
+    "valid-jsdoc": 1,
+    "require-jsdoc": 1,
+    "@typescript-eslint/no-explicit-any": 0,
+  },
+};

.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: "npm"
+    # Look for `package.json` and `lock` files in the `root` directory
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    reviewers:
+      - "adnan-kamili"
+    target-branch: "develop"
+    commit-message:
+      prefix: "ci(dependabot)"
+      include: "scope"
+    ignore:
+      - dependency-name: "prettier"

.github/workflows/release.yml

@@ -0,0 +1,32 @@
+on:
+  push:
+    branches:
+      - main
+name: release-please
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      # Release Please creates a PR on main
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: node
+          package-name: test-release-please
+
+      # Publish to NPM
+      - uses: actions/checkout@v3
+        # If statements ensure that release is published to registries only when a new release is created.
+        if: ${{ steps.release.outputs.release_created }}
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: "https://registry.npmjs.org"
+        if: ${{ steps.release.outputs.release_created }}
+      - run: npm ci
+      - run: npm run build
+        if: ${{ steps.release.outputs.release_created }}
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+        if: ${{ steps.release.outputs.release_created }}

.gitignore

@@ -15,35 +15,10 @@ pids
 *.seed
 *.pid.lock
 
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
 # Dependency directories
 node_modules/
 jspm_packages/
 
-# TypeScript v1 declaration files
-typings/
-
 # TypeScript cache
 *.tsbuildinfo
 
@@ -53,52 +28,5 @@ typings/
 # Optional eslint cache
 .eslintcache
 
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# Next.js build output
-.next
-
-# Nuxt.js build / generate output
-.nuxt
+# Build files
 dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and *not* Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}

.husky/pre-commit

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

.npmignore

@@ -0,0 +1,17 @@
+# Source files, examples
+src
+examples
+
+# Linting/Formatting Configs
+.eslintrc.cjs
+.eslintignore
+.prettierignore
+.prettierrc.json
+commitlint.config.cjs
+lint-staged.config.cjs
+
+# Husky Git Hooks
+.husky
+
+# Github Workflows
+.github

.prettierignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+.parcel-cache

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "quoteProps": "consistent"
+}

README.md

@@ -1 +1 @@
-# web-api-client
+# web-api-client

commitlint.config.cjs

@@ -0,0 +1 @@
+module.exports = { extends: ["@commitlint/config-conventional"] };

examples/index.js

@@ -0,0 +1,46 @@
+import {
+  CryptlexWebApiClient,
+  CryptlexWebApiClientOptions,
+} from "@cryptlex/web-api-client";
+import { nanoid } from "nanoid";
+
+const ACCESS_TOKEN = "**ACCESS_TOKEN**";
+const PRODUCT_ID = "**PRODUCT_ID**";
+
+const cryptlexWebApiClientOptions = new CryptlexWebApiClientOptions(
+  ACCESS_TOKEN
+);
+const cryptlexWebApiClient = new CryptlexWebApiClient(
+  cryptlexWebApiClientOptions
+);
+
+main();
+
+/**
+ * This function creates a User and then subsequently creates a license linked to that user.
+ */
+async function main() {
+  try {
+    const userResponse = await cryptlexWebApiClient.createUser({
+      email: "john@doe.com",
+      firstName: "John",
+      lastName: "Doe",
+      password: nanoid(),
+      role: "user",
+    });
+    console.log(
+      "\nSuccessfully created user: " + JSON.stringify(userResponse.data)
+    );
+
+    // Create a license which is linked to the new user in the product defined by PRODUCT_ID
+    const licenseResponse = await cryptlexWebApiClient.createLicense({
+      productId: PRODUCT_ID,
+      userId: userResponse.data.id,
+    });
+    console.log(
+      "\nSuccessfully created license: " + JSON.stringify(licenseResponse.data)
+    );
+  } catch (error) {
+    console.error(error);
+  }
+}

examples/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@cryptlex/web-api-client-example",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "An example to show the working of the Cryptlex Web API client",
+  "main": "index.js",
+  "scripts": {
+    "start": "node index.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Cryptlex LLC",
+  "license": "ISC",
+  "dependencies": {
+    "@cryptlex/web-api-client": "latest",
+    "nanoid": "^4.0.0"
+  }
+}

lint-staged.config.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  "*.ts": "eslint --fix",
+  "*.{cjs,mjs,js,ts,html,scss,css,json,md}": "prettier --write",
+};