simplelogin-client 0.1.7 → 0.2.3

package/README.md

@@ -4,7 +4,7 @@
     <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> 
+    <a href="https://kennethwussmann.github.io/simplelogin-client/typedoc/index.html">Documentation</a> • <a href="https://kennethwussmann.github.io/simplelogin-client/redoc/index.html">API Spec</a> 
   </p>
 </div>
 
@@ -21,18 +21,17 @@
   - [x] Contacts and activities
 - [x] Mailbox Management
   - [x] Get, Create, Update, Delete
-- [ ] Custom Domain Management
+- [ ] [Custom Domain Management](https://github.com/KennethWussmann/simplelogin-client/issues/7)
   - [x] Get
   - [ ] Update, Delete
-- [ ] Contact Management
+- [ ] [Contact Management](https://github.com/KennethWussmann/simplelogin-client/issues/8)
   - [x] Get, Create
   - [ ] Delete
   - [ ] Block & unblock
-- [ ] Notifications
-- [ ] Settings
-- [ ] Import & Export
-- [ ] Misc
-- [ ] Phone
+- [ ] [Notifications](https://github.com/KennethWussmann/simplelogin-client/issues/9)
+- [ ] [Settings](https://github.com/KennethWussmann/simplelogin-client/issues/10)
+- [ ] [Import & Export](https://github.com/KennethWussmann/simplelogin-client/issues/11)
+- [ ] [Phone & Misc](https://github.com/KennethWussmann/simplelogin-client/issues/12)
 
 ## Getting started
 
@@ -46,11 +45,13 @@ npm install --save simplelogin-client
 ```
 
 ```typescript
-import { SimpleLogin } from 'simplelogin-client';
+import { AliasApi, SimpleLoginConfig } from 'simplelogin-client';
 
-const alias = new SimpleLogin.AliasApi({
-  apiKey: process.env.API_KEY,
-});
+const alias = new AliasApi(
+  new SimpleLoginConfig({
+    apiKey: process.env.API_KEY,
+  }),
+);
 
 const createdAlias = await alias.createRandomAlias({
   note: 'This alias was created with simplelogin-client!',
@@ -71,7 +72,9 @@ console.log(createdAlias);
 */
 ```
 
-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.
+Check the [documentation](https://kennethwussmann.github.io/simplelogin-client/typedoc/index.html) for all available methods and the [FAQ](./docs/faq.md) in case of questions.
+
+> :bangbang: Please don't contact the SimpleLogin team with issues regarding this client. Instead open an issue in this repository.
 
 ## Development
 

package/docs/development.md

@@ -2,7 +2,7 @@
 
 It's basically writing OpenAPI spec, to contribute code to this client.
 
-The client is generated using [swagger-codegen](https://github.com/swagger-api/swagger-codegen) and the OpenAPI spec is written with [boats](https://github.com/j-d-carmichael/boats).
+The client is generated using [openapi-generator](https://openapi-generator.tech) and the OpenAPI spec is written with [boats](https://github.com/j-d-carmichael/boats).
 
 Everything in `./dist` & `./src/sdk` is generated and should not be modified manually. To adjust the API client, docs or the built OpenAPI spec, adjust the YAML files in `./oas` to document the API. Check the [boats documentation](https://j-d-carmichael.github.io/boats/#/) and the [OpenAPI v3 spec](https://swagger.io/specification/) for further guidance.
 

package/docs/faq.md

@@ -5,13 +5,13 @@
 Yes, the used API url can be adjusted when constructing the client:
 
 ```typescript
-import { SimpleLogin } from 'simplelogin-client';
+import { AliasApi, SimpleLoginConfig } from 'simplelogin-client';
 
-const alias = new SimpleLogin.AliasApi(
-  {
+const alias = new AliasApi(
+  new SimpleLoginConfig({
     apiKey: process.env.API_KEY,
-  },
-  'https://app.my-selfhosted-simplelogin.io/api', // <-- change me
+    basePath: 'https://app.my-selfhosted-simplelogin.io/api', // <-- change me
+  }),
 );
 ```
 
@@ -27,15 +27,14 @@ It does not require any dependencies by default when used in enviroments where a
 In case you want to use the client with older versions of NodeJS you may need to install a third-party `fetch` compliant library like [`node-fetch`](https://www.npmjs.com/package/node-fetch). You then just pass the `fetch` HTTP client into the API client:
 
 ```typescript
-import { SimpleLogin } from 'simplelogin-client';
+import { AliasApi } from 'simplelogin-client';
 import fetch from 'node-fetch'; // v2
 
-const alias = new SimpleLogin.AliasApi(
-  {
+const alias = new AliasApi(
+  new SimpleLoginConfig({
     apiKey: process.env.API_KEY,
-  },
-  undefined,
-  fetch, // <-- insert fetch API
+    fetchApi: fetch, // <-- insert fetch API
+  }),
 );
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simplelogin-client",
-  "version": "0.1.7",
+  "version": "0.2.3",
   "description": "Zero-dependency TypeScript client for the SimpleLogin.io API",
   "main": "tscBuild/index.js",
   "types": "tscBuild/index.d.ts",
@@ -28,7 +28,7 @@
     "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",
+    "dependency-update": "tsx scripts/index.ts dependencyUpdate",
     "prepare": "husky install"
   },
   "files": [
@@ -52,31 +52,28 @@
     "npm": "9"
   },
   "devDependencies": {
-    "@moia-oss/eslint-prettier-typescript-config": "^0.11.46",
-    "@types/jest": "^29.4.0",
+    "@moia-oss/eslint-prettier-typescript-config": "0.11.48",
+    "@types/jest": "^29.5.0",
     "@types/node": "18.*",
-    "@types/node-fetch": "^2.6.2",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
+    "@types/node-fetch": "^2.6.3",
+    "@typescript-eslint/eslint-plugin": "^5.58.0",
+    "@typescript-eslint/parser": "^5.58.0",
     "boats": "^3.4.0",
-    "chalk": "^5.2.0",
     "dotenv": "^16.0.3",
-    "eslint": "^8.34.0",
+    "eslint": "^8.38.0",
     "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-prettier": "^4.2.1",
-    "globby": "^13.1.3",
     "husky": "^8.0.3",
-    "jest": "^29.4.2",
+    "jest": "^29.5.0",
     "lint-staged": "^13",
-    "npm-check-updates": "^16.7.4",
+    "npm-check-updates": "^16.10.8",
     "npm-watch": "^0.11.0",
-    "prettier": "^2.8.4",
-    "redoc-cli": "^0.13.20",
-    "ts-jest": "^29.0.5",
+    "prettier": "^2.8.7",
+    "redoc-cli": "^0.13.21",
+    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
-    "tsx": "^3.12.3",
-    "typedoc": "^0.23.25",
-    "typescript": "^4.9.5",
-    "zx": "^7.1.1"
+    "tsx": "^3.12.6",
+    "typedoc": "^0.24.1",
+    "typescript": "4.9.5",
+    "zx": "^7.2.1"
   }
 }

package/tscBuild/config.d.ts

@@ -0,0 +1,26 @@
+import { Configuration, FetchAPI } from './sdk';
+export type SimpleLoginProps = {
+    /**
+     * Most API endpoints require an API key to be passed in the header.
+     * @default undefined
+     */
+    apiKey: string;
+    /**
+     * Override the default base path. This is useful for testing, or for selfhosted instances.
+     * @default https://app.simplelogin.io/api
+     */
+    basePath?: string;
+    /**
+     * In case you want to use the client with older versions of NodeJS you may need to install a third-party `fetch` compliant library like `node-fetch`.
+     * You then just pass the `fetch` HTTP client here.
+     * @default fetch provided by platform
+     */
+    fetchApi?: FetchAPI;
+};
+export declare class SimpleLoginConfig extends Configuration {
+    private props;
+    constructor(props: SimpleLoginProps);
+    get apiKey(): () => string;
+    get basePath(): string;
+    get fetchApi(): any;
+}

package/tscBuild/config.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleLoginConfig = void 0;
+const sdk_1 = require("./sdk");
+class SimpleLoginConfig extends sdk_1.Configuration {
+    props;
+    constructor(props) {
+        super();
+        this.props = props;
+    }
+    get apiKey() {
+        return () => this.props.apiKey;
+    }
+    get basePath() {
+        return this.props.basePath || super.basePath;
+    }
+    get fetchApi() {
+        return this.props.fetchApi || super.fetchApi;
+    }
+}
+exports.SimpleLoginConfig = SimpleLoginConfig;
+//# sourceMappingURL=config.js.map

package/tscBuild/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAAA,+BAAgD;AAqBhD,MAAa,iBAAkB,SAAQ,mBAAa;IAC9B;IAApB,YAAoB,KAAuB;QACzC,KAAK,EAAE,CAAC;QADU,UAAK,GAAL,KAAK,CAAkB;IAE3C,CAAC;IAED,IAAI,MAAM;QACR,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IACjC,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC;IAC/C,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC;IAC/C,CAAC;CACF;AAhBD,8CAgBC"}

package/tscBuild/index.d.ts

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

package/tscBuild/index.js

@@ -10,19 +10,10 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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;
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SimpleLogin = void 0;
-exports.SimpleLogin = __importStar(require("./sdk"));
+__exportStar(require("./sdk"), exports);
+__exportStar(require("./config"), exports);
 //# sourceMappingURL=index.js.map

package/tscBuild/index.js.map

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

package/tscBuild/sdk/apis/AccountApi.d.ts

@@ -0,0 +1,177 @@
+type RequestInit = any;
+/**
+ * SimpleLogin (unofficial)
+ * The unofficial SimpleLogin API docs as OpenAPI 3.0.0 spec. This is based on the official markdown based docs, but written in OpenAPI to allow for easier integration with other tools and generation of client SDKs. Please do not contact the SimpleLogin team for support or issues with this API documentation.
+ *
+ * The version of the OpenAPI document: 4.22.0
+ * Contact: contact@ketrwu.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AuthActivatePost, AuthForgotPasswordPost, AuthLogin, AuthLoginPost, AuthMfa, AuthMfaPost, AuthReactivatePost, AuthRegisterPost, Success, SudoPatch, UserApiKey, UserApiKeyPost, UserCookieToken, UserInfo, UserInfoPatch } from '../models';
+export interface ActivateAccountRequest {
+    authActivatePost: AuthActivatePost;
+}
+export interface CreateApiKeyRequest {
+    userApiKeyPost: UserApiKeyPost;
+}
+export interface EnableSudoModeRequest {
+    sudoPatch: SudoPatch;
+}
+export interface ForgotPasswordRequest {
+    authForgotPasswordPost: AuthForgotPasswordPost;
+}
+export interface LoginRequest {
+    authLoginPost: AuthLoginPost;
+}
+export interface MfaRequest {
+    authMfaPost: AuthMfaPost;
+}
+export interface ReactivateAccountRequest {
+    authReactivatePost: AuthReactivatePost;
+}
+export interface RegisterAccountRequest {
+    authRegisterPost: AuthRegisterPost;
+}
+export interface UpdateUserInfoRequest {
+    userInfoPatch: UserInfoPatch;
+}
+/**
+ *
+ */
+export declare class AccountApi extends runtime.BaseAPI {
+    /**
+     * Activate a new account with the activation code that was sent to the user\'s email.
+     * Activate account
+     */
+    activateAccountRaw(requestParameters: ActivateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Activate a new account with the activation code that was sent to the user\'s email.
+     * Activate account
+     */
+    activateAccount(requestParameters: ActivateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Create a new API key
+     * Create API key
+     */
+    createApiKeyRaw(requestParameters: CreateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserApiKey>>;
+    /**
+     * Create a new API key
+     * Create API key
+     */
+    createApiKey(requestParameters: CreateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserApiKey>;
+    /**
+     * Delete user (requires sudo mode)
+     * Delete user
+     */
+    deleteUserRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Success>>;
+    /**
+     * Delete user (requires sudo mode)
+     * Delete user
+     */
+    deleteUser(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Success>;
+    /**
+     * Enable sudo mode
+     * Enable sudo mode
+     */
+    enableSudoModeRaw(requestParameters: EnableSudoModeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Success>>;
+    /**
+     * Enable sudo mode
+     * Enable sudo mode
+     */
+    enableSudoMode(requestParameters: EnableSudoModeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Success>;
+    /**
+     * Request a link to reset the password for a registered account.
+     * Forgot password
+     */
+    forgotPasswordRaw(requestParameters: ForgotPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Request a link to reset the password for a registered account.
+     * Forgot password
+     */
+    forgotPassword(requestParameters: ForgotPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get a one time use cookie to exchange it for a valid cookie in the web app
+     * Get cookie token
+     */
+    getCookieTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserCookieToken>>;
+    /**
+     * Get a one time use cookie to exchange it for a valid cookie in the web app
+     * Get cookie token
+     */
+    getCookieToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserCookieToken>;
+    /**
+     * Get user info
+     * Get user info
+     */
+    getUserInfoRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserInfo>>;
+    /**
+     * Get user info
+     * Get user info
+     */
+    getUserInfo(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserInfo>;
+    /**
+     * Login using email and password to get an access token.
+     * Login
+     */
+    loginRaw(requestParameters: LoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthLogin>>;
+    /**
+     * Login using email and password to get an access token.
+     * Login
+     */
+    login(requestParameters: LoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthLogin>;
+    /**
+     * Log out user
+     * Logout
+     */
+    logoutRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserInfo>>;
+    /**
+     * Log out user
+     * Logout
+     */
+    logout(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserInfo>;
+    /**
+     * Authenticate using MFA
+     * MFA authentication
+     */
+    mfaRaw(requestParameters: MfaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthMfa>>;
+    /**
+     * Authenticate using MFA
+     * MFA authentication
+     */
+    mfa(requestParameters: MfaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthMfa>;
+    /**
+     * Request a new activation code for an account that was already registered, but not activated yet.
+     * Reactivate account
+     */
+    reactivateAccountRaw(requestParameters: ReactivateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Request a new activation code for an account that was already registered, but not activated yet.
+     * Reactivate account
+     */
+    reactivateAccount(requestParameters: ReactivateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Register a new account
+     * Register account
+     */
+    registerAccountRaw(requestParameters: RegisterAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Register a new account
+     * Register account
+     */
+    registerAccount(requestParameters: RegisterAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update user info
+     * Update user info
+     */
+    updateUserInfoRaw(requestParameters: UpdateUserInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserInfo>>;
+    /**
+     * Update user info
+     * Update user info
+     */
+    updateUserInfo(requestParameters: UpdateUserInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserInfo>;
+}
+export {};