Merge pull request #65 from ctrl-hub/add-members-stats

Add stats to BaseService

Author: jgreaves8

dist/Client.js

@@ -239,7 +239,7 @@ export class Client {
         try {
             // @todo switch on cookie, "X-Session-Token" or client_credentials
             const fetchResponse = await fetch(url, {
-                credentials: 'include', // @todo only required for cookie based auth,
+                credentials: 'include',
                 headers: headers,
             });
             let json = await fetchResponse.json();

dist/index.js

@@ -1275,6 +1275,22 @@ class SchemeTemplate extends BaseModel {
   }
 }
 
+// src/models/OrganisationMemberStats.ts
+class OrganisationMemberStats extends BaseModel {
+  type = "members-stats";
+  members = {
+    users: 0,
+    service_accounts: 0
+  };
+  constructor(data) {
+    super(data);
+    this.members = data?.attributes?.members || {
+      users: 0,
+      members: 0
+    };
+  }
+}
+
 // src/utils/Hydrator.ts
 class Hydrator {
   modelMap = {
@@ -1293,6 +1309,7 @@ class Hydrator {
     groups: Group,
     "operation-templates": OperationTemplate,
     operations: Operation,
+    "members-stats": OrganisationMemberStats,
     permissions: Permission,
     properties: Property,
     roles: Role,
@@ -1562,19 +1579,26 @@ class BaseService extends RequestBuilder {
     };
   }
   async create(model, params) {
-    if (params) {
-    }
+    if (params) {}
     const jsonApiSerializer = new JsonApiSerializer(this.hydrator.getModelMap());
     const payload = jsonApiSerializer.buildCreatePayload(model);
     return await this.client.makePostRequest(this.endpoint, payload);
   }
   async update(id, model, params) {
-    if (params) {
-    }
+    if (params) {}
     const jsonApiSerializer = new JsonApiSerializer(this.hydrator.getModelMap());
     const payload = jsonApiSerializer.buildUpdatePayload(model);
     return await this.client.makePatchRequest(`${this.endpoint}/${id}`, payload);
   }
+  async stats(options) {
+    const statsEndpoint = `${this.endpoint}/stats`;
+    const { requestOptions } = this.buildRequestParams("", options);
+    const resp = await this.client.makeGetRequest(statsEndpoint, requestOptions);
+    if (resp.data && typeof resp.data === "object") {
+      resp.data = this.hydrator.hydrateResponse(resp.data, resp.included || []);
+    }
+    return resp;
+  }
 }
 
 // src/services/FormCategoriesService.ts
@@ -1985,6 +2009,9 @@ class OrganisationMembersService extends BaseService {
   constructor(client) {
     super(client, "/v3/orgs/:orgId/iam/members");
   }
+  stats(options) {
+    return super.stats(options);
+  }
 }
 
 // src/services/SchemeTemplatesService.ts
@@ -2254,9 +2281,6 @@ class ClientConfig {
 }
 // src/models/Organisation.ts
 class Organisation extends BaseModel {
-  constructor() {
-    super(...arguments);
-  }
   type = "organisations";
   static relationships = [];
 }

dist/models/OrganisationMemberStats.d.ts

@@ -0,0 +1,11 @@
+import { BaseModel } from './BaseModel';
+type MembersStats = {
+    users: number;
+    service_accounts: number;
+};
+export declare class OrganisationMemberStats extends BaseModel {
+    type: string;
+    members: MembersStats;
+    constructor(data?: any);
+}
+export {};

dist/models/OrganisationMemberStats.js

@@ -0,0 +1,15 @@
+import { BaseModel } from './BaseModel';
+export class OrganisationMemberStats extends BaseModel {
+    type = 'members-stats';
+    members = {
+        users: 0,
+        service_accounts: 0
+    };
+    constructor(data) {
+        super(data);
+        this.members = data?.attributes?.members || {
+            users: 0,
+            members: 0
+        };
+    }
+}

dist/services/BaseService.d.ts

@@ -30,4 +30,5 @@ export declare class BaseService<T extends Model> extends RequestBuilder {
     get(param: RequestOptionsType): Promise<InternalResponse<T[]>>;
     create(model: T, params?: unknown): Promise<InternalResponse<T>>;
     update(id: string, model: Model, params?: unknown): Promise<InternalResponse<T>>;
+    stats<R = any>(options?: RequestOptionsType): Promise<InternalResponse<R>>;
 }

dist/services/BaseService.js

@@ -40,4 +40,13 @@ export class BaseService extends RequestBuilder {
         const payload = jsonApiSerializer.buildUpdatePayload(model);
         return await this.client.makePatchRequest(`${this.endpoint}/${id}`, payload);
     }
+    async stats(options) {
+        const statsEndpoint = `${this.endpoint}/stats`;
+        const { requestOptions } = this.buildRequestParams('', options);
+        const resp = await this.client.makeGetRequest(statsEndpoint, requestOptions);
+        if (resp.data && typeof resp.data === 'object') {
+            resp.data = this.hydrator.hydrateResponse(resp.data, resp.included || []);
+        }
+        return resp;
+    }
 }

dist/services/OrganisationMembersService.d.ts

@@ -1,6 +1,16 @@
 import { BaseService } from '../services/BaseService';
 import { Client } from '../Client';
 import type { User } from '../models/User';
+import type { InternalResponse } from '../types/Response';
+import type { RequestOptionsType } from '../utils/RequestOptions';
+type OrganisationMembersStats = {
+    members: {
+        users: number;
+        service_accounts: number;
+    };
+};
 export declare class OrganisationMembersService extends BaseService<User> {
     constructor(client: Client);
+    stats<R = OrganisationMembersStats>(options?: RequestOptionsType): Promise<InternalResponse<R>>;
 }
+export {};

dist/services/OrganisationMembersService.js

@@ -4,4 +4,7 @@ export class OrganisationMembersService extends BaseService {
     constructor(client) {
         super(client, "/v3/orgs/:orgId/iam/members");
     }
+    stats(options) {
+        return super.stats(options);
+    }
 }

dist/utils/Hydrator.js

@@ -34,6 +34,7 @@ import { Street } from '../models/Street';
 import { Appointment } from '../models/Appointment';
 import { WorkOrderTemplate } from '../models/WorkOrderTemplate';
 import { SchemeTemplate } from '../models/SchemeTemplate';
+import { OrganisationMemberStats } from '../models/OrganisationMemberStats';
 export class Hydrator {
     modelMap = {
         appointments: Appointment,
@@ -51,6 +52,7 @@ export class Hydrator {
         groups: Group,
         "operation-templates": OperationTemplate,
         operations: Operation,
+        "members-stats": OrganisationMemberStats,
         permissions: Permission,
         properties: Property,
         roles: Role,

package.json

@@ -4,7 +4,7 @@
         "type": "git",
         "url": "https://github.com/ctrl-hub/sdk.ts"
     },
-    "version": "0.1.140",
+    "version": "0.1.141",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "type": "module",