simplelogin-client 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 Kenneth Wußmann
+
+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.

package/README.md

@@ -0,0 +1,78 @@
+<div align="center">
+  <h1><code>simplelogin-client</code></h1>
+  <p>
+    <strong>Zero-dependency TypeScript client for the <a href="https://simplelogin.io">SimpleLogin.io</a> API. Compatible with NodeJS and browsers.</strong>
+  </p>
+  <p>
+    <a href="https://kennethwussmann.github.io/simplelogin-client/typedoc/modules/SimpleLogin.html">Documentation</a> • <a href="https://kennethwussmann.github.io/simplelogin-client/redoc/index.html">API Spec</a> 
+  </p>
+</div>
+
+## Features
+
+> Interested in the state of the project? [Check the faq!](./docs/faq.md#whats-the-current-project-state)
+
+- [x] Account Management
+  - [x] Login (+MFA), Register, Activate, etc.
+  - [x] User info
+  - [x] API key management
+- [x] Alias Management
+  - [x] Get, Create, Update, Delete
+  - [x] Contacts and activities
+- [x] Mailbox Management
+  - [x] Get, Create, Update, Delete
+- [ ] Custom Domain Management
+  - [x] Get
+  - [ ] Update, Delete
+- [ ] Contact Management
+  - [x] Get, Create
+  - [ ] Delete
+  - [ ] Block & unblock
+- [ ] Notifications
+- [ ] Settings
+- [ ] Import & Export
+- [ ] Misc
+- [ ] Phone
+
+## Getting started
+
+`simplelogin-client` works in most NodeJS versions and browsers, but may require a tweak when not used with NodeJS 18 or in outdated browsers. Check the [compatibility guide](./docs/faq.md#what-nodejs-version-and-browsers-are-supported).
+
+To start using this API client in your JS/TS projects:
+
+```shell
+# Install dependency
+npm install --save simplelogin-client
+```
+
+```typescript
+import { SimpleLogin } from 'simplelogin-client';
+
+const alias = new SimpleLogin.AliasApi({
+  apiKey: process.env.API_KEY,
+});
+
+const createdAlias = await alias.createRandomAlias({
+  note: 'This alias was created with simplelogin-client!',
+});
+
+console.log(createdAlias);
+/* Output:
+{
+  id: 50001,
+  creation_date: '2023-02-10 20:19:37+00:00',
+  alias: 'nederlanden_heatherington@example.com',
+  mailbox: { email: 'somewhere@gmail.com', id: 50001 },
+  enabled: true,
+  pinned: false,
+  note: "This alias was created with simplelogin-client!",
+  ...
+}
+*/
+```
+
+Check the [documentation](https://kennethwussmann.github.io/simplelogin-client/typedoc/modules/SimpleLogin.html) for all available methods and the [FAQ](./docs/faq.md) in case of questions.
+
+## Development
+
+Want to contribute fixes to the API client or spec? Check the [development guide](./docs/development.md)!

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "simplelogin-client",
+  "version": "0.0.1",
+  "description": "",
+  "main": "tscBuild/index.js",
+  "types": "tscBuild/index.d.ts",
+  "scripts": {
+    "dev": "npm-watch",
+    "test": "jest --passWithNoTests",
+    "ci": "tsx scripts/index.ts ci",
+    "build": "tsx scripts/index.ts build",
+    "rebuild": "tsx scripts/index.ts rebuild",
+    "clean": "tsx scripts/index.ts clean",
+    "check-codegen": "tsx scripts/index.ts checkCodegen",
+    "lint": "tsx scripts/index.ts lint",
+    "format": "tsx scripts/index.ts format",
+    "dependency-update": "npm-check-updates -u --filterVersion \"/^[~^<>]| - |\\.x$/\" --deep && npm install",
+    "prepare": "husky install"
+  },
+  "files": [
+    "README.md",
+    "LICENSE",
+    "./tscBuild"
+  ],
+  "watch": {
+    "build": {
+      "patterns": "oas",
+      "extensions": "yml,yaml"
+    }
+  },
+  "lint-staged": {
+    "src/*.ts": "eslint --cache --fix",
+    "*.{ts,json,yml,yaml,html,md}": "prettier --write"
+  },
+  "engines": {
+    "node": "18",
+    "npm": "9"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@moia-oss/eslint-prettier-typescript-config": "^0.11.46",
+    "@types/jest": "^29.2.3",
+    "@types/node": "18.*",
+    "@types/node-fetch": "^2.6.2",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "boats": "^3.4.0",
+    "chalk": "^5.2.0",
+    "dotenv": "^16.0.3",
+    "eslint": "^8.33.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "globby": "^13.1.3",
+    "husky": "^8.0.3",
+    "jest": "^29.3.1",
+    "lint-staged": "^13",
+    "npm-check-updates": "^16.6.5",
+    "npm-watch": "^0.11.0",
+    "prettier": "^2.8.4",
+    "redoc-cli": "^0.13.20",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
+    "tsx": "^3.12.3",
+    "typedoc": "^0.23.24",
+    "typescript": "^4.9.5",
+    "zx": "^7.1.1"
+  }
+}

package/tscBuild/index.d.ts

@@ -0,0 +1 @@
+export * as SimpleLogin from './sdk';

package/tscBuild/index.js

@@ -0,0 +1,45 @@
+'use strict';
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, 'default', { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o['default'] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null)
+      for (var k in mod)
+        if (k !== 'default' && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.SimpleLogin = void 0;
+exports.SimpleLogin = __importStar(require('./sdk'));
+//# sourceMappingURL=index.js.map

package/tscBuild/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAAqC"}