@allthings/sdk 6.0.0 → 6.2.0-1

package/dist/src/rest/types.d.ts

@@ -3,6 +3,7 @@ import { MethodHttpDelete } from './delete';
 import { MethodHttpGet } from './get';
 import { MethodAgentCreate, MethodAgentCreatePermissions } from './methods/agent';
 import { MethodAppCreate, MethodAppGetById } from './methods/app';
+import { MethodBookingGetById, MethodBookingUpdateById } from './methods/booking';
 import { MethodBucketAddFile, MethodBucketCreate, MethodBucketGet, MethodBucketRemoveFile, MethodBucketRemoveFilesInPath } from './methods/bucket';
 import { MethodConversationCreateMessage, MethodConversationGetById } from './methods/conversation';
 import { MethodFileCreate, MethodFileDelete } from './methods/file';
@@ -21,7 +22,6 @@ import { MethodUtilisationPeriodAddRegistrationCode, MethodUtilisationPeriodChec
 import { MethodHttpPatch } from './patch';
 import { MethodHttpPost } from './post';
 import { MethodHttpPut } from './put';
-import { MethodBookingGetById, MethodBookingUpdateById } from './methods/booking';
 export declare enum EnumResource {
     group = "group",
     property = "property",
@@ -78,16 +78,18 @@ export declare enum EnumLookupUserType {
 }
 export type EntityResultList<Entity, ExtensionInterface = {}> = Promise<{
     readonly _embedded: {
-        readonly items: ReadonlyArray<Entity>;
+        readonly items: readonly Entity[];
     };
     readonly total: number;
 } & ExtensionInterface>;
 export interface IAllthingsRestClientOptions {
+    readonly accessToken?: string;
     readonly apiUrl: string;
     readonly authorizationCode?: string;
-    readonly accessToken?: string;
+    readonly authorizationRedirect?: (url: string) => any;
     readonly clientId?: string;
     readonly clientSecret?: string;
+    readonly implicit?: boolean;
     readonly oauthUrl: string;
     readonly password?: string;
     readonly redirectUri?: string;
@@ -95,26 +97,25 @@ export interface IAllthingsRestClientOptions {
     readonly requestBackOffInterval: number;
     readonly requestMaxRetries: number;
     readonly scope?: string;
+    readonly serviceName?: string;
     readonly state?: string;
     readonly tokenStore?: ITokenStore;
     readonly username?: string;
-    readonly implicit?: boolean;
-    readonly authorizationRedirect?: (url: string) => any;
 }
 export interface IClientExposedOAuth {
     readonly authorizationCode: {
         readonly getUri: (state?: string) => string;
         readonly requestToken: (authorizationCode?: string) => ReturnType<TokenRequester>;
     };
-    readonly refreshToken: (refreshToken?: string) => ReturnType<TokenRequester>;
     readonly generateState: () => string;
+    readonly refreshToken: (refreshToken?: string) => ReturnType<TokenRequester>;
 }
 export interface IAllthingsRestClient {
-    readonly options: Required<IAllthingsRestClientOptions>;
     readonly delete: MethodHttpDelete;
     readonly get: MethodHttpGet;
-    readonly post: MethodHttpPost;
+    readonly options: Required<IAllthingsRestClientOptions>;
     readonly patch: MethodHttpPatch;
+    readonly post: MethodHttpPost;
     readonly put: MethodHttpPut;
     readonly oauth: IClientExposedOAuth;
     readonly agentCreate: MethodAgentCreate;

package/dist/src/utils/functional.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-export type List<T> = ReadonlyArray<T>;
+export type List<T> = readonly T[];
 export declare const partial: (fn: (...args: any[]) => any | Promise<any>, ...partialArgs: any[]) => (...args: any[]) => any;
 export declare function times<T>(fn: (item: number, index: number) => T, n: number): List<T>;
 export declare function until<A, B>(predicate: (value: B, iteration: number) => boolean | Promise<boolean>, transformer: (value: A | B | undefined, iteration: number) => B | Promise<B>, initialValue?: A | B, iterationCount?: number): Promise<B>;

package/dist/src/utils/sleep.d.ts

@@ -1 +1 @@
-export default function sleep(miliseconds: number): Promise<boolean>;
+export default function sleep(milliseconds: number): Promise<boolean>;

package/dist/src/utils/upload.d.ts

@@ -1,14 +1,14 @@
 /// <reference types="node" />
 import { IAllthingsRestClient } from '..';
 import { IFile } from '../rest/methods/file';
-export declare const createManyFiles: (attachments: ReadonlyArray<{
+export declare const createManyFiles: (attachments: readonly {
     readonly content: Buffer;
     readonly filename: string;
-}>, apiClient: IAllthingsRestClient) => Promise<ReadonlyArray<IFile | Error>>;
-export declare function createManyFilesSorted(files: ReadonlyArray<{
+}[], apiClient: IAllthingsRestClient) => Promise<readonly (IFile | Error)[]>;
+export declare function createManyFilesSorted(files: readonly {
     readonly content: Buffer;
     readonly filename: string;
-}>, client: IAllthingsRestClient): Promise<{
-    readonly success: ReadonlyArray<string>;
-    readonly error: ReadonlyArray<Error>;
+}[], client: IAllthingsRestClient): Promise<{
+    readonly error: readonly Error[];
+    readonly success: readonly string[];
 }>;

package/dist/test/constants.js

@@ -0,0 +1,16 @@
+import { EnumCommunicationMethodType, EnumInputChannel, } from '../src/rest/types';
+export const APP_ID = '575027e58178f56a008b4568';
+export const APP_CHANNEL = 'App-575027e58178f56a008b4568';
+export const APP_PROPERTY_MANAGER_ID = '5a818c07ef5f2f00441146a2';
+export const CATEGORY_ID = '5eb9a4ff2a4433163d0e540a';
+export const COMMUNICATION_METHOD = {
+    id: '5dd7ca6bfbdbb4af89be9c37',
+    type: EnumCommunicationMethodType.email,
+    value: 'pr-coreyplatt@allthings.me',
+};
+export const CONVERSATION_ID = '5aa7cd7bd4959e004112e136';
+export const INPUT_CHANNEL = EnumInputChannel.EMAIL;
+export const SERVICE_PROVIDER_ID = '5a818c07ef5f2f00441146a2';
+export const USER_ID = '50f66beaeabc88ab0e000000';
+export const UTILISATION_PERIOD_ID = '5a9d65cd0ecb330045742be3';
+export const BOOKING_ID = '5aa68870d4959e00447d6f87';

package/dist/test/helpers.js

@@ -0,0 +1,55 @@
+import { nanoid as generateId } from 'nanoid';
+import restClient, { EnumUnitType } from '../src/rest';
+import { EnumLocale, EnumTimezone, } from '../src/rest/types';
+import { APP_ID, APP_PROPERTY_MANAGER_ID } from './constants';
+export async function createUserAndClient() {
+    const defaultClient = restClient();
+    const email = `${generateId()}@foobar.test`;
+    const password = generateId();
+    const data = {
+        description: 'Foobar User',
+        email,
+        externalId: generateId(),
+        locale: EnumLocale.en_US,
+        plainPassword: password,
+    };
+    return {
+        client: restClient({
+            password,
+            username: email,
+        }),
+        user: await defaultClient.userCreate(APP_ID, generateId(), data),
+    };
+}
+export async function createUtilisationPeriod() {
+    const defaultClient = restClient();
+    const property = await defaultClient.propertyCreate(APP_ID, {
+        name: 'CommunityArticleStatsGetByUser Test Property',
+        timezone: EnumTimezone.EuropeBerlin,
+    });
+    const group = await defaultClient.groupCreate(property.id, {
+        name: 'CommunityArticleStatsGetByUser Test Group',
+        propertyManagerId: APP_PROPERTY_MANAGER_ID,
+    });
+    const unit = await defaultClient.unitCreate(group.id, {
+        name: 'CommunityArticleStatsGetByUser Test Unit',
+        type: EnumUnitType.rented,
+    });
+    return defaultClient.utilisationPeriodCreate(unit.id, {
+        endDate: '2050-01-03',
+        externalId: generateId(),
+        startDate: '2015-01-03',
+    });
+}
+export async function createUserWithUtilizationPeriod() {
+    const defaultClient = restClient();
+    const [utilisationPeriod, { client, user }] = await Promise.all([
+        await createUtilisationPeriod(),
+        await createUserAndClient(),
+    ]);
+    await defaultClient.userCheckInToUtilisationPeriod(user.id, utilisationPeriod.id);
+    return {
+        client,
+        user,
+    };
+}

package/package.json

@@ -1,14 +1,8 @@
 {
   "name": "@allthings/sdk",
-  "version": "6.0.0",
+  "version": "6.2.0-1",
   "description": "",
   "author": "Allthings GmbH",
-  "maintainers": [
-    "Marco Lüthy <marco.luethy@gmail.com> (https://github.com/adieuadieu)"
-  ],
-  "contributors": [
-    "Marco Lüthy <marco.luethy@gmail.com> (https://github.com/adieuadieu)"
-  ],
   "keywords": [
     "allthings",
     "sdk"
@@ -20,7 +14,7 @@
   },
   "homepage": "https://github.com/allthings/node-sdk",
   "engines": {
-    "node": ">=18.5"
+    "node": ">=18.16"
   },
   "main": "dist/lib.cjs.js",
   "module": "dist/lib.esm.js",
@@ -41,13 +35,13 @@
     "test:ci": "jest --runInBand",
     "watch:build": "tsc -d -w & rollup -c --watch",
     "watch:test": "jest --watch",
-    "lint": "yarn lint:tsc && yarn lint:tslint",
-    "lint:tslint": "tslint -p tsconfig.json -t stylish",
+    "lint": "yarn lint:tsc && yarn lint:eslint",
+    "lint:eslint": "eslint src",
     "lint:tsc": "tsc --noEmit --pretty",
     "prebuild": "npm run clean",
     "build": "tsc -d && cp package.json dist/ && rollup -c --bundleConfigAsCjs && rm dist/package.json",
     "dev": "tsc -w",
-    "prepare": "husky install",
+    "prepare": "husky",
     "prepublishOnly": "npm run build",
     "prettier": "prettier --write",
     "security-check": "yarn audit --groups dependencies --level high || test $? -lt 7",
@@ -58,24 +52,27 @@
     "test:authorization-code": "open http://localhost:3333/test/fixtures/authorization-code?clientId=$ALLTHINGS_OAUTH_CLIENT_ID&clientSecret=$ALLTHINGS_OAUTH_CLIENT_SECRET"
   },
   "dependencies": {
+    "@aws-sdk/client-ssm": "3.574.0",
     "bottleneck": "2.19.5",
     "cross-fetch": "4.0.0",
     "query-string": "7.1.3"
   },
   "devDependencies": {
-    "@allthings/tslint-preset": "2.0.0",
-    "@commitlint/cli": "17.8.1",
-    "@commitlint/config-conventional": "17.8.1",
+    "@allthings/eslint-config": "1.1.0",
+    "@commitlint/cli": "19.3.0",
+    "@commitlint/config-conventional": "19.2.2",
+    "@rollup/plugin-node-resolve": "15.2.3",
     "@types/form-data": "2.5.0",
     "@types/jest": "26.0.24",
-    "@types/node": "18.17.13",
+    "@types/node": "18.19.31",
     "@types/query-string": "6.3.0",
     "coveralls": "3.1.1",
+    "eslint": "8.57.0",
     "form-data": "4.0.0",
-    "husky": "8.0.3",
+    "husky": "9.0.11",
     "jest": "26.6.3",
     "jest-environment-jsdom": "26.6.2",
-    "lint-staged": "14.0.1",
+    "lint-staged": "15.2.2",
     "nanoid": "3.3.7",
     "prettier": "3.2.5",
     "rimraf": "5.0.5",
@@ -83,12 +80,10 @@
     "rollup-plugin-commonjs": "10.1.0",
     "rollup-plugin-hashbang": "2.2.2",
     "rollup-plugin-json": "4.0.0",
-    "@rollup/plugin-node-resolve": "15.2.3",
     "rollup-plugin-replace": "2.2.0",
     "rollup-plugin-terser": "7.0.2",
     "semantic-release": "19.0.5",
     "ts-jest": "26.5.6",
-    "tslint": "6.1.3",
     "typescript": "4.9.5"
   },
   "prettier": {
@@ -141,7 +136,7 @@
     ],
     "coverageThreshold": {
       "global": {
-        "branches": 100,
+        "branches": 99,
         "functions": 100,
         "lines": 100,
         "statements": 100