jitz-sharepoint-utilities 1.10.65 → 1.11.0

package/README.md

@@ -1,110 +1,110 @@
-# JitzSharePointUtilities
-
-Easily pluggable data layer for SharePoint Framework(SPFx) applications following Repository pattern and some SharePoint utilities
-
-### Prerequisites
-
-Create the SPFx project according to Microsoft's <a href="https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part" target="_blank">documentation</a>
-
-
-### How to use
-
-Install the package using the command below
-
-```
-npm i jitz-sharepoint-utilities
-
-```
-
-Import the package in your project
-
-```
-import UtilityService from 'jitz-sharepoint-utilities/lib/services/UtilityService';
-import UserService from 'jitz-sharepoint-utilities/lib/services/UserService';
-import { IRepository } from 'jitz-sharepoint-utilities/lib/repositories/IRepository';
-import Repository from 'jitz-sharepoint-utilities/lib/repositories/Repository';
-
-export interface IProduct extends IModel{ 
-
-}
-
-```
-
-Create the data model for the lists used on the project
-
-```
-
-import { IModel, IPersonOrGroup } from 'jitz-sharepoint-utilities/lib/common/IModels';
-
-export interface IProduct extends IModel{ 
-    customFieldsInTheList:string;
-    ....
-    ....
-}
-
-
-```
-
-Create the repository class for the list
-
-```
-
-import { IWebPartContext } from '@microsoft/sp-webpart-base';
-import {IProduct} from '../yourModelFile';
-import Repository from 'jitz-sharepoint-utilities/lib/repositories/Repository';
-
-
-export default class ProductRepository extends Repository<IProduct> {
-    
-    constructor(context: IWebPartContext,_listName:string="Products"){
-        super(context,_listName);
-    }
-   
-
-}
-
-```
-
-Use the repository
-
-```
-
-import { IRepository } from 'jitz-sharepoint-utilities/lib/repositories/IRepository';
-
-private _productRepository:IRepository<IProduct>;
-
-constructor(props: yourProps, state: yourState) {
-        super(props);
-        this.state = {
-            ...
-            ...
-        };
-
-        this._userService = new UserService(this.props.context);
-        this._productRepository = new ProductRepository(this.props.context);
-      }
-
-getProducts = () => {
-    this._productRepository.getAll().then((data)=>{
-        ...
-        ...
-    });
-}
-
-```
-
-Use User service
-
-```
-this._userService.getCurrentUser().then((user){});
-this._userService.getCurrentUserGroups().then((groups){});
-this._userService.checkIfCurrentUserInGroup(groupName).then((result){});
-this._userService.checkIfUserIsInGroup(userId, groupName).then((result){});
-this._userService.getUserById(id).then((user){});
-
-```
-### Keywords
-
-SPFx
-Typescript in SharePoint components
+# JitzSharePointUtilities
+
+Easily pluggable data layer for SharePoint Framework(SPFx) applications following Repository pattern and some SharePoint utilities
+
+### Prerequisites
+
+Create the SPFx project according to Microsoft's <a href="https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part" target="_blank">documentation</a>
+
+
+### How to use
+
+Install the package using the command below
+
+```
+npm i jitz-sharepoint-utilities
+
+```
+
+Import the package in your project
+
+```
+import UtilityService from 'jitz-sharepoint-utilities/lib/services/UtilityService';
+import UserService from 'jitz-sharepoint-utilities/lib/services/UserService';
+import { IRepository } from 'jitz-sharepoint-utilities/lib/repositories/IRepository';
+import Repository from 'jitz-sharepoint-utilities/lib/repositories/Repository';
+
+export interface IProduct extends IModel{ 
+
+}
+
+```
+
+Create the data model for the lists used on the project
+
+```
+
+import { IModel, IPersonOrGroup } from 'jitz-sharepoint-utilities/lib/common/IModels';
+
+export interface IProduct extends IModel{ 
+    customFieldsInTheList:string;
+    ....
+    ....
+}
+
+
+```
+
+Create the repository class for the list
+
+```
+
+import { IWebPartContext } from '@microsoft/sp-webpart-base';
+import {IProduct} from '../yourModelFile';
+import Repository from 'jitz-sharepoint-utilities/lib/repositories/Repository';
+
+
+export default class ProductRepository extends Repository<IProduct> {
+    
+    constructor(context: IWebPartContext,_listName:string="Products"){
+        super(context,_listName);
+    }
+   
+
+}
+
+```
+
+Use the repository
+
+```
+
+import { IRepository } from 'jitz-sharepoint-utilities/lib/repositories/IRepository';
+
+private _productRepository:IRepository<IProduct>;
+
+constructor(props: yourProps, state: yourState) {
+        super(props);
+        this.state = {
+            ...
+            ...
+        };
+
+        this._userService = new UserService(this.props.context);
+        this._productRepository = new ProductRepository(this.props.context);
+      }
+
+getProducts = () => {
+    this._productRepository.getAll().then((data)=>{
+        ...
+        ...
+    });
+}
+
+```
+
+Use User service
+
+```
+this._userService.getCurrentUser().then((user){});
+this._userService.getCurrentUserGroups().then((groups){});
+this._userService.checkIfCurrentUserInGroup(groupName).then((result){});
+this._userService.checkIfUserIsInGroup(userId, groupName).then((result){});
+this._userService.getUserById(id).then((user){});
+
+```
+### Keywords
+
+SPFx
+Typescript in SharePoint components
 SharePoint

package/jitzHttpClient.ts

@@ -1,44 +1,44 @@
-import axios from "axios";
-
-export interface IJitzHttpClient {
-  get: (url: string, header?: any) => any;
-  post: (url: string, data: any, header?: any) => any;
-}
-
-export default class JitzHttpClient implements IJitzHttpClient {
-  private header: any = {
-    Accept: "application/json;odata=verbose",
-    "Content-Type": "application/json;odata=verbose",
-  };
-  private _client: any;
-
-  constructor() {
-    this._client = axios.create({});
-  }
-
-  public get = (url: string, header?: any) => {
-    header = header || this.header;
-    var authOptions = {
-      method: "GET",
-      url: url,
-      data: JSON.stringify({}),
-      headers: header,
-      json: true,
-    };
-
-    return this._client(authOptions);
-  };
-
-  public post = (url: string, data: any, header?: any) => {
-    header = header || this.header;
-    var authOptions = {
-      method: "POST",
-      url: url,
-      data: JSON.stringify(data),
-      headers: header,
-      json: true,
-    };
-
-    return this._client(authOptions);
-  };
-}
+import axios from "axios";
+
+export interface IJitzHttpClient {
+  get: (url: string, header?: any) => any;
+  post: (url: string, data: any, header?: any) => any;
+}
+
+export default class JitzHttpClient implements IJitzHttpClient {
+  private header: any = {
+    Accept: "application/json;odata=verbose",
+    "Content-Type": "application/json;odata=verbose",
+  };
+  private _client: any;
+
+  constructor() {
+    this._client = axios.create({});
+  }
+
+  public get = (url: string, header?: any) => {
+    header = header || this.header;
+    var authOptions = {
+      method: "GET",
+      url: url,
+      data: JSON.stringify({}),
+      headers: header,
+      json: true,
+    };
+
+    return this._client(authOptions);
+  };
+
+  public post = (url: string, data: any, header?: any) => {
+    header = header || this.header;
+    var authOptions = {
+      method: "POST",
+      url: url,
+      data: JSON.stringify(data),
+      headers: header,
+      json: true,
+    };
+
+    return this._client(authOptions);
+  };
+}

package/jitzSPHttpClient.ts

@@ -1,158 +1,158 @@
-import axios from "axios";
-
-export interface IJitzSPContext {
-  client: IJitzSPHttpClient;
-  siteUrl: string;
-  init: () => void;
-}
-
-export class JitzSPContext implements IJitzSPContext {
-  public client: IJitzSPHttpClient;
-  public siteUrl: string;
-
-  constructor(siteUrl: string) {
-    this.siteUrl = siteUrl;
-    this.client = new JitzSPHttpClient(siteUrl);
-  }
-  public init = async () => {
-    await this.client.init();
-  };
-}
-
-export interface IJitzSPHttpClient {
-  init: () => void;
-  get: (url: string, header?: any) => any;
-  post: (url: string, data: any, header?: any) => any;
-  postWithOutStringify: (url: string, data: any, header?: any) => any;
-}
-
-export default class JitzSPHttpClient implements IJitzSPHttpClient {
-  public siteUrl: string;
-  public client: any;
-  public securityToken: string = "";
-  private header: any = {
-    Accept: "application/json;odata=verbose",
-    "Content-Type": "application/json;odata=verbose",
-  };
-
-  constructor(siteUrl: string = "") {
-    this.siteUrl = siteUrl;
-    this.securityToken = "";
-    this.client = axios.create({
-      baseURL: this.siteUrl,
-    });
-  }
-
-  public init = async () => {
-    await this.refreshSecurityValidation();
-  };
-
-  public get = (url: string, header?: any) => {
-    header = header || this.header;
-    header["X-RequestDigest"] = this.securityToken;
-    var authOptions = {
-      method: "GET",
-      url: url,
-      data: JSON.stringify({}),
-      headers: header,
-      json: true,
-    };
-
-    return this.client(authOptions);
-
-    // return this.getSecurityValidation().then((ctx: any) => {
-    //   this.securityToken = ctx.data.d.GetContextWebInformation.FormDigestValue;
-    //   header["X-RequestDigest"] = this.securityToken;
-    //   var authOptions = {
-    //     method: "GET",
-    //     url: url,
-    //     data: JSON.stringify({}),
-    //     headers: header,
-    //     json: true,
-    //   };
-
-    //   return this.client(authOptions);
-    // });
-  };
-
-  public post = (url: string, data: any, header?: any) => {
-    // debugger;
-    header = header || this.header;
-    header["X-RequestDigest"] = this.securityToken;
-    var authOptions = {
-      method: "POST",
-      url: url,
-      data: JSON.stringify(data),
-      headers: header,
-      json: true,
-    };
-
-    return this.client(authOptions);
-
-    // return this.getSecurityValidation().then((ctx: any) => {
-    //   this.securityToken = ctx.data.d.GetContextWebInformation.FormDigestValue;
-    //   header["X-RequestDigest"] = this.securityToken;
-    //   var authOptions = {
-    //     method: "POST",
-    //     url: url,
-    //     data: JSON.stringify(data),
-    //     headers: header,
-    //     json: true,
-    //   };
-
-    //   return this.client(authOptions);
-    // });
-  };
-
-  public postWithOutStringify = (url: string, data: any, header?: any) => {
-    // debugger;
-    header = header || this.header;
-    header["X-RequestDigest"] = this.securityToken;
-    var authOptions = {
-      method: "POST",
-      url: url,
-      data: data,
-      headers: header,
-      json: true,
-    };
-
-    return this.client(authOptions);
-  };
-
-  public getSecurityValidation = () => {
-    var authOptions = {
-      method: "POST",
-      url: "/_api/contextinfo",
-      data: JSON.stringify({}),
-      headers: {
-        Accept: "application/json;odata=verbose",
-        "Content-Type": "application/json;odata=verbose",
-      },
-      json: true,
-    };
-    return this.client(authOptions);
-  };
-
-  public refreshSecurityValidation = async () => {
-    var authOptions = {
-      method: "POST",
-      url: "/_api/contextinfo",
-      data: JSON.stringify({}),
-      headers: {
-        Accept: "application/json;odata=verbose",
-        "Content-Type": "application/json;odata=verbose",
-      },
-      json: true,
-    };
-
-    await this.client(authOptions).then((context: any) => {
-      this.securityToken =
-        context.data.d.GetContextWebInformation.FormDigestValue;
-      // console.log("Token:- "+this.securityToken);
-      var interval = setInterval(() => {
-        this.refreshSecurityValidation();
-        clearInterval(interval);
-      }, 600000); //300000
-    });
-  };
-}
+import axios from "axios";
+
+export interface IJitzSPContext {
+  client: IJitzSPHttpClient;
+  siteUrl: string;
+  init: () => void;
+}
+
+export class JitzSPContext implements IJitzSPContext {
+  public client: IJitzSPHttpClient;
+  public siteUrl: string;
+
+  constructor(siteUrl: string) {
+    this.siteUrl = siteUrl;
+    this.client = new JitzSPHttpClient(siteUrl);
+  }
+  public init = async () => {
+    await this.client.init();
+  };
+}
+
+export interface IJitzSPHttpClient {
+  init: () => void;
+  get: (url: string, header?: any) => any;
+  post: (url: string, data: any, header?: any) => any;
+  postWithOutStringify: (url: string, data: any, header?: any) => any;
+}
+
+export default class JitzSPHttpClient implements IJitzSPHttpClient {
+  public siteUrl: string;
+  public client: any;
+  public securityToken: string = "";
+  private header: any = {
+    Accept: "application/json;odata=verbose",
+    "Content-Type": "application/json;odata=verbose",
+  };
+
+  constructor(siteUrl: string = "") {
+    this.siteUrl = siteUrl;
+    this.securityToken = "";
+    this.client = axios.create({
+      baseURL: this.siteUrl,
+    });
+  }
+
+  public init = async () => {
+    await this.refreshSecurityValidation();
+  };
+
+  public get = (url: string, header?: any) => {
+    header = header || this.header;
+    header["X-RequestDigest"] = this.securityToken;
+    var authOptions = {
+      method: "GET",
+      url: url,
+      data: JSON.stringify({}),
+      headers: header,
+      json: true,
+    };
+
+    return this.client(authOptions);
+
+    // return this.getSecurityValidation().then((ctx: any) => {
+    //   this.securityToken = ctx.data.d.GetContextWebInformation.FormDigestValue;
+    //   header["X-RequestDigest"] = this.securityToken;
+    //   var authOptions = {
+    //     method: "GET",
+    //     url: url,
+    //     data: JSON.stringify({}),
+    //     headers: header,
+    //     json: true,
+    //   };
+
+    //   return this.client(authOptions);
+    // });
+  };
+
+  public post = (url: string, data: any, header?: any) => {
+    // debugger;
+    header = header || this.header;
+    header["X-RequestDigest"] = this.securityToken;
+    var authOptions = {
+      method: "POST",
+      url: url,
+      data: JSON.stringify(data),
+      headers: header,
+      json: true,
+    };
+
+    return this.client(authOptions);
+
+    // return this.getSecurityValidation().then((ctx: any) => {
+    //   this.securityToken = ctx.data.d.GetContextWebInformation.FormDigestValue;
+    //   header["X-RequestDigest"] = this.securityToken;
+    //   var authOptions = {
+    //     method: "POST",
+    //     url: url,
+    //     data: JSON.stringify(data),
+    //     headers: header,
+    //     json: true,
+    //   };
+
+    //   return this.client(authOptions);
+    // });
+  };
+
+  public postWithOutStringify = (url: string, data: any, header?: any) => {
+    // debugger;
+    header = header || this.header;
+    header["X-RequestDigest"] = this.securityToken;
+    var authOptions = {
+      method: "POST",
+      url: url,
+      data: data,
+      headers: header,
+      json: true,
+    };
+
+    return this.client(authOptions);
+  };
+
+  public getSecurityValidation = () => {
+    var authOptions = {
+      method: "POST",
+      url: "/_api/contextinfo",
+      data: JSON.stringify({}),
+      headers: {
+        Accept: "application/json;odata=verbose",
+        "Content-Type": "application/json;odata=verbose",
+      },
+      json: true,
+    };
+    return this.client(authOptions);
+  };
+
+  public refreshSecurityValidation = async () => {
+    var authOptions = {
+      method: "POST",
+      url: "/_api/contextinfo",
+      data: JSON.stringify({}),
+      headers: {
+        Accept: "application/json;odata=verbose",
+        "Content-Type": "application/json;odata=verbose",
+      },
+      json: true,
+    };
+
+    await this.client(authOptions).then((context: any) => {
+      this.securityToken =
+        context.data.d.GetContextWebInformation.FormDigestValue;
+      // console.log("Token:- "+this.securityToken);
+      var interval = setInterval(() => {
+        this.refreshSecurityValidation();
+        clearInterval(interval);
+      }, 600000); //300000
+    });
+  };
+}