atlas-crm-api-client 1.1.7 → 1.2.0

package/lib/cjs/client.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const l=require("axios"),y="https://atlascrm.avisi-apps.com",w="CRM";class n extends Error{constructor(s,t,e){super(s),this.message=s,this.status=t,this.data=e,this.name="AtlasCrmError"}}class k{constructor(s){this.accessToken=null,this.tokenExpiry=null,this.baseUrl=(s.baseUrl??y).replace(/\/$/,""),this.clientId=s.clientId,this.clientSecret=s.clientSecret,this.workspace=s.workspace??w,this.companies=this.createEntityNamespace("company"),this.contacts=this.createEntityNamespace("contact"),this.sales=this.createEntityNamespace("sale"),this.comments=this.createCommentsNamespace(),this.issues=this.createIssuesNamespace()}async request(s,t,e={},i=0){var h;const u=await this.getValidToken();let c=`${this.baseUrl}${t}`;if(e.params){const o=new URLSearchParams,a={...e.params};a.sortType!==void 0&&a["sort-type"]===void 0&&(a["sort-type"]=a.sortType),a.sortBy!==void 0&&a["sort-by"]===void 0&&(a["sort-by"]=a.sortBy),delete a.sortType,delete a.sortBy,Object.entries(a).forEach(([m,p])=>{p!==void 0&&o.append(m,String(p))}),c+=(c.includes("?")?"&":"?")+o.toString()}let r;try{r=await l.request({url:c,method:s,headers:{Authorization:`Bearer ${u}`,Accept:"application/json","Content-Type":"application/json"},data:e.body?e.body:void 0,validateStatus:()=>!0})}catch(o){const a=o;throw new n(a.message||"Request failed",(h=a.response)==null?void 0:h.status)}if(r.status===401&&i<1)return this.accessToken=null,this.request(s,t,e,i+1);if(r.status<200||r.status>=300){const o=r.data&&typeof r.data=="object"?r.data:{message:typeof r.data=="string"?r.data:void 0},a=o.message||`Request failed with status ${r.status}`;throw new n(a,r.status,o)}return r.data}async authenticate(){var i;const s=Buffer.from(`${this.clientId}:${this.clientSecret}`).toString("base64");let t;try{t=await l.request({url:`${this.baseUrl}/api/1.0/oauth/token`,method:"POST",headers:{Authorization:`Basic ${s}`,"Content-Type":"application/x-www-form-urlencoded"},data:new URLSearchParams({grant_type:"client_credentials"}).toString(),validateStatus:()=>!0})}catch(u){const c=u;throw new n(c.message||"Authentication failed",(i=c.response)==null?void 0:i.status)}if(t.status<200||t.status>=300)throw new n("Authentication failed",t.status,t.data);const e=t.data;return this.accessToken=e.access_token,this.tokenExpiry=Date.now()+e.expires_in*1e3-3e4,e.access_token}async getValidToken(){return this.accessToken&&this.tokenExpiry&&Date.now()<this.tokenExpiry?this.accessToken:this.authenticate()}createEntityNamespace(s){const t=`/api/1.0/workspace/${this.workspace}/entities`;return{list:(e={})=>this.request("GET",t,{params:{...e,type:s}}),get:e=>this.request("GET",`${t}/${e}`),create:e=>this.request("POST",t,{body:{type:s,fields:e}}),update:(e,i)=>this.request("PUT",`${t}/${e}`,{body:{fields:i}}),delete:e=>this.request("DELETE",`${t}/${e}`),getTemplate:()=>this.request("GET",`/api/1.0/workspace/${this.workspace}/template/${s}`)}}createIssuesNamespace(){return{link:(s,t)=>this.request("POST",`/api/1.0/workspace/${this.workspace}/entities/${s}/issues`,{body:{"issue-ids":t}}),unlink:(s,t)=>this.request("DELETE",`/api/1.0/workspace/${this.workspace}/entities/${s}/issues`,{body:{"issue-ids":t}})}}createCommentsNamespace(){return{create:(s,t,e)=>this.request("POST",`/api/1.0/workspace/${this.workspace}/entities/${s}/comments`,{body:{format:"plain-text",comment:t,"account-id":e}})}}}exports.AtlasCrmClient=k;exports.AtlasCrmError=n;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const l=require("axios"),E="https://atlascrm.avisi-apps.com",k="CRM";class c extends Error{constructor(e,s,t){super(e),this.message=e,this.status=s,this.data=t,this.name="AtlasCrmError"}}class f{constructor(e){this.accessToken=null,this.tokenExpiry=null,this.baseUrl=(e.baseUrl??E).replace(/\/$/,""),this.clientId=e.clientId,this.clientSecret=e.clientSecret,this.workspace=e.workspace??k,this.companies=this.createEntityNamespace("company"),this.contacts=this.createEntityNamespace("contact"),this.sales=this.createEntityNamespace("sale"),this.comments=this.createCommentsNamespace(),this.issues=this.createIssuesNamespace()}async request(e,s,t={},r=0){var p;const u=await this.getValidToken();let n=`${this.baseUrl}${s}`;if(t.params){const o=new URLSearchParams,a={...t.params};a.sortType!==void 0&&a["sort-type"]===void 0&&(a["sort-type"]=a.sortType),a.sortBy!==void 0&&a["sort-by"]===void 0&&(a["sort-by"]=a.sortBy);const h=a.filters;delete a.sortType,delete a.sortBy,delete a.filters,Object.entries(a).forEach(([y,w])=>{this.appendQueryParam(o,y,w)}),h&&this.appendFilters(o,h);const d=o.toString();d&&(n+=(n.includes("?")?"&":"?")+d)}let i;try{i=await l.request({url:n,method:e,headers:{Authorization:`Bearer ${u}`,Accept:"application/json","Content-Type":"application/json"},data:t.body?t.body:void 0,validateStatus:()=>!0})}catch(o){const a=o;throw new c(a.message||"Request failed",(p=a.response)==null?void 0:p.status)}if(i.status===401&&r<1)return this.accessToken=null,this.request(e,s,t,r+1);if(i.status<200||i.status>=300){const o=i.data&&typeof i.data=="object"?i.data:{message:typeof i.data=="string"?i.data:void 0},a=o.message||`Request failed with status ${i.status}`;throw new c(a,i.status,o)}return i.data}appendQueryParam(e,s,t){if(t!=null){if(Array.isArray(t)){t.forEach(r=>{r!=null&&e.append(s,this.toQueryValue(r))});return}e.append(s,this.toQueryValue(t))}}appendFilters(e,s){s.forEach(t=>{const r=t.operator?`fields.${t.fieldId}[${t.operator}]`:`fields.${t.fieldId}`;this.appendQueryParam(e,r,t.value)})}toQueryValue(e){return e instanceof Date?e.toISOString():String(e)}async authenticate(){var r;const e=Buffer.from(`${this.clientId}:${this.clientSecret}`).toString("base64");let s;try{s=await l.request({url:`${this.baseUrl}/api/1.0/oauth/token`,method:"POST",headers:{Authorization:`Basic ${e}`,"Content-Type":"application/x-www-form-urlencoded"},data:new URLSearchParams({grant_type:"client_credentials"}).toString(),validateStatus:()=>!0})}catch(u){const n=u;throw new c(n.message||"Authentication failed",(r=n.response)==null?void 0:r.status)}if(s.status<200||s.status>=300)throw new c("Authentication failed",s.status,s.data);const t=s.data;return this.accessToken=t.access_token,this.tokenExpiry=Date.now()+t.expires_in*1e3-3e4,t.access_token}async getValidToken(){return this.accessToken&&this.tokenExpiry&&Date.now()<this.tokenExpiry?this.accessToken:this.authenticate()}createEntityNamespace(e){const s=`/api/1.0/workspace/${this.workspace}/entities`;return{list:(t={})=>this.request("GET",s,{params:{...t,type:e}}),get:t=>this.request("GET",`${s}/${t}`),create:t=>this.request("POST",s,{body:{type:e,fields:t}}),update:(t,r)=>this.request("PUT",`${s}/${t}`,{body:{fields:r}}),delete:t=>this.request("DELETE",`${s}/${t}`),getTemplate:()=>this.request("GET",`/api/1.0/workspace/${this.workspace}/template/${e}`)}}createIssuesNamespace(){return{link:(e,s)=>this.request("POST",`/api/1.0/workspace/${this.workspace}/entities/${e}/issues`,{body:{"issue-ids":s}}),unlink:(e,s)=>this.request("DELETE",`/api/1.0/workspace/${this.workspace}/entities/${e}/issues`,{body:{"issue-ids":s}})}}createCommentsNamespace(){return{create:(e,s,t)=>this.request("POST",`/api/1.0/workspace/${this.workspace}/entities/${e}/comments`,{body:{format:"plain-text",comment:s,"account-id":t}})}}}exports.AtlasCrmClient=f;exports.AtlasCrmError=c;

package/lib/cjs/client.d.cts

@@ -55,6 +55,9 @@ export declare class AtlasCrmClient {
      * Internal Request Handler
      */
     private request;
+    private appendQueryParam;
+    private appendFilters;
+    private toQueryValue;
     /**
      * OAuth2 Client Credentials Handshake
      */

package/lib/cjs/types.d.cts

@@ -37,6 +37,13 @@ export type AtlasCrmConfig = {
     clientSecret: string;
     workspace?: string;
 };
+export type FilterOperator = 'eq' | 'contains' | 'gte' | 'lte';
+export type EntityFilterValue = string | number | boolean | Date;
+export type EntityFilter = {
+    fieldId: string;
+    value: EntityFilterValue | EntityFilterValue[];
+    operator?: FilterOperator;
+};
 export type QueryParams = {
     size?: number;
     'sort-type'?: 'asc' | 'desc';
@@ -44,6 +51,7 @@ export type QueryParams = {
     'sort-by'?: string;
     sortBy?: string;
     cursor?: string;
+    filters?: EntityFilter[];
     [key: string]: any;
 };
 export type TemplateField = {

package/lib/esm/client.d.ts

@@ -55,6 +55,9 @@ export declare class AtlasCrmClient {
      * Internal Request Handler
      */
     private request;
+    private appendQueryParam;
+    private appendFilters;
+    private toQueryValue;
     /**
      * OAuth2 Client Credentials Handshake
      */

package/lib/esm/client.js

@@ -1,72 +1,100 @@
 import l from "axios";
-const y = "https://atlascrm.avisi-apps.com", w = "CRM";
-class n extends Error {
-  constructor(s, t, e) {
-    super(s), this.message = s, this.status = t, this.data = e, this.name = "AtlasCrmError";
+const k = "https://atlascrm.avisi-apps.com", E = "CRM";
+class c extends Error {
+  constructor(e, s, t) {
+    super(e), this.message = e, this.status = s, this.data = t, this.name = "AtlasCrmError";
   }
 }
-class E {
-  constructor(s) {
-    this.accessToken = null, this.tokenExpiry = null, this.baseUrl = (s.baseUrl ?? y).replace(/\/$/, ""), this.clientId = s.clientId, this.clientSecret = s.clientSecret, this.workspace = s.workspace ?? w, this.companies = this.createEntityNamespace("company"), this.contacts = this.createEntityNamespace("contact"), this.sales = this.createEntityNamespace("sale"), this.comments = this.createCommentsNamespace(), this.issues = this.createIssuesNamespace();
+class $ {
+  constructor(e) {
+    this.accessToken = null, this.tokenExpiry = null, this.baseUrl = (e.baseUrl ?? k).replace(/\/$/, ""), this.clientId = e.clientId, this.clientSecret = e.clientSecret, this.workspace = e.workspace ?? E, this.companies = this.createEntityNamespace("company"), this.contacts = this.createEntityNamespace("contact"), this.sales = this.createEntityNamespace("sale"), this.comments = this.createCommentsNamespace(), this.issues = this.createIssuesNamespace();
   }
   /**
    * Internal Request Handler
    */
-  async request(s, t, e = {}, i = 0) {
+  async request(e, s, t = {}, r = 0) {
     var u;
-    const h = await this.getValidToken();
-    let c = `${this.baseUrl}${t}`;
-    if (e.params) {
-      const o = new URLSearchParams(), a = { ...e.params };
-      a.sortType !== void 0 && a["sort-type"] === void 0 && (a["sort-type"] = a.sortType), a.sortBy !== void 0 && a["sort-by"] === void 0 && (a["sort-by"] = a.sortBy), delete a.sortType, delete a.sortBy, Object.entries(a).forEach(([m, p]) => {
-        p !== void 0 && o.append(m, String(p));
-      }), c += (c.includes("?") ? "&" : "?") + o.toString();
+    const p = await this.getValidToken();
+    let n = `${this.baseUrl}${s}`;
+    if (t.params) {
+      const o = new URLSearchParams(), a = { ...t.params };
+      a.sortType !== void 0 && a["sort-type"] === void 0 && (a["sort-type"] = a.sortType), a.sortBy !== void 0 && a["sort-by"] === void 0 && (a["sort-by"] = a.sortBy);
+      const h = a.filters;
+      delete a.sortType, delete a.sortBy, delete a.filters, Object.entries(a).forEach(([y, w]) => {
+        this.appendQueryParam(
+          o,
+          y,
+          w
+        );
+      }), h && this.appendFilters(o, h);
+      const d = o.toString();
+      d && (n += (n.includes("?") ? "&" : "?") + d);
     }
-    let r;
+    let i;
     try {
-      r = await l.request({
-        url: c,
-        method: s,
+      i = await l.request({
+        url: n,
+        method: e,
         headers: {
-          Authorization: `Bearer ${h}`,
+          Authorization: `Bearer ${p}`,
           Accept: "application/json",
           "Content-Type": "application/json"
         },
-        data: e.body ? e.body : void 0,
+        data: t.body ? t.body : void 0,
         validateStatus: () => !0
       });
     } catch (o) {
       const a = o;
-      throw new n(
+      throw new c(
         a.message || "Request failed",
         (u = a.response) == null ? void 0 : u.status
       );
     }
-    if (r.status === 401 && i < 1)
-      return this.accessToken = null, this.request(s, t, e, i + 1);
-    if (r.status < 200 || r.status >= 300) {
-      const o = r.data && typeof r.data == "object" ? r.data : {
-        message: typeof r.data == "string" ? r.data : void 0
-      }, a = o.message || `Request failed with status ${r.status}`;
-      throw new n(a, r.status, o);
+    if (i.status === 401 && r < 1)
+      return this.accessToken = null, this.request(e, s, t, r + 1);
+    if (i.status < 200 || i.status >= 300) {
+      const o = i.data && typeof i.data == "object" ? i.data : {
+        message: typeof i.data == "string" ? i.data : void 0
+      }, a = o.message || `Request failed with status ${i.status}`;
+      throw new c(a, i.status, o);
     }
-    return r.data;
+    return i.data;
+  }
+  appendQueryParam(e, s, t) {
+    if (t != null) {
+      if (Array.isArray(t)) {
+        t.forEach((r) => {
+          r != null && e.append(s, this.toQueryValue(r));
+        });
+        return;
+      }
+      e.append(s, this.toQueryValue(t));
+    }
+  }
+  appendFilters(e, s) {
+    s.forEach((t) => {
+      const r = t.operator ? `fields.${t.fieldId}[${t.operator}]` : `fields.${t.fieldId}`;
+      this.appendQueryParam(e, r, t.value);
+    });
+  }
+  toQueryValue(e) {
+    return e instanceof Date ? e.toISOString() : String(e);
   }
   /**
    * OAuth2 Client Credentials Handshake
    */
   async authenticate() {
-    var i;
-    const s = Buffer.from(
+    var r;
+    const e = Buffer.from(
       `${this.clientId}:${this.clientSecret}`
     ).toString("base64");
-    let t;
+    let s;
     try {
-      t = await l.request({
+      s = await l.request({
         url: `${this.baseUrl}/api/1.0/oauth/token`,
         method: "POST",
         headers: {
-          Authorization: `Basic ${s}`,
+          Authorization: `Basic ${e}`,
           "Content-Type": "application/x-www-form-urlencoded"
         },
         data: new URLSearchParams({
@@ -74,21 +102,21 @@ class E {
         }).toString(),
         validateStatus: () => !0
       });
-    } catch (h) {
-      const c = h;
-      throw new n(
-        c.message || "Authentication failed",
-        (i = c.response) == null ? void 0 : i.status
+    } catch (p) {
+      const n = p;
+      throw new c(
+        n.message || "Authentication failed",
+        (r = n.response) == null ? void 0 : r.status
       );
     }
-    if (t.status < 200 || t.status >= 300)
-      throw new n(
+    if (s.status < 200 || s.status >= 300)
+      throw new c(
         "Authentication failed",
-        t.status,
-        t.data
+        s.status,
+        s.data
       );
-    const e = t.data;
-    return this.accessToken = e.access_token, this.tokenExpiry = Date.now() + e.expires_in * 1e3 - 3e4, e.access_token;
+    const t = s.data;
+    return this.accessToken = t.access_token, this.tokenExpiry = Date.now() + t.expires_in * 1e3 - 3e4, t.access_token;
   }
   async getValidToken() {
     return this.accessToken && this.tokenExpiry && Date.now() < this.tokenExpiry ? this.accessToken : this.authenticate();
@@ -96,54 +124,54 @@ class E {
   /**
    * Generic Entity Operations Factory
    */
-  createEntityNamespace(s) {
-    const t = `/api/1.0/workspace/${this.workspace}/entities`;
+  createEntityNamespace(e) {
+    const s = `/api/1.0/workspace/${this.workspace}/entities`;
     return {
-      list: (e = {}) => this.request("GET", t, {
-        params: { ...e, type: s }
+      list: (t = {}) => this.request("GET", s, {
+        params: { ...t, type: e }
       }),
-      get: (e) => this.request("GET", `${t}/${e}`),
-      create: (e) => this.request("POST", t, {
-        body: { type: s, fields: e }
+      get: (t) => this.request("GET", `${s}/${t}`),
+      create: (t) => this.request("POST", s, {
+        body: { type: e, fields: t }
       }),
-      update: (e, i) => this.request("PUT", `${t}/${e}`, {
-        body: { fields: i }
+      update: (t, r) => this.request("PUT", `${s}/${t}`, {
+        body: { fields: r }
       }),
-      delete: (e) => this.request("DELETE", `${t}/${e}`),
+      delete: (t) => this.request("DELETE", `${s}/${t}`),
       getTemplate: () => this.request(
         "GET",
-        `/api/1.0/workspace/${this.workspace}/template/${s}`
+        `/api/1.0/workspace/${this.workspace}/template/${e}`
       )
     };
   }
   createIssuesNamespace() {
     return {
-      link: (s, t) => this.request(
+      link: (e, s) => this.request(
         "POST",
-        `/api/1.0/workspace/${this.workspace}/entities/${s}/issues`,
+        `/api/1.0/workspace/${this.workspace}/entities/${e}/issues`,
         {
-          body: { "issue-ids": t }
+          body: { "issue-ids": s }
         }
       ),
-      unlink: (s, t) => this.request(
+      unlink: (e, s) => this.request(
         "DELETE",
-        `/api/1.0/workspace/${this.workspace}/entities/${s}/issues`,
+        `/api/1.0/workspace/${this.workspace}/entities/${e}/issues`,
         {
-          body: { "issue-ids": t }
+          body: { "issue-ids": s }
         }
       )
     };
   }
   createCommentsNamespace() {
     return {
-      create: (s, t, e) => this.request(
+      create: (e, s, t) => this.request(
         "POST",
-        `/api/1.0/workspace/${this.workspace}/entities/${s}/comments`,
+        `/api/1.0/workspace/${this.workspace}/entities/${e}/comments`,
         {
           body: {
             format: "plain-text",
-            comment: t,
-            "account-id": e
+            comment: s,
+            "account-id": t
           }
         }
       )
@@ -151,6 +179,6 @@ class E {
   }
 }
 export {
-  E as AtlasCrmClient,
-  n as AtlasCrmError
+  $ as AtlasCrmClient,
+  c as AtlasCrmError
 };

package/lib/esm/types.d.ts

@@ -37,6 +37,13 @@ export type AtlasCrmConfig = {
     clientSecret: string;
     workspace?: string;
 };
+export type FilterOperator = 'eq' | 'contains' | 'gte' | 'lte';
+export type EntityFilterValue = string | number | boolean | Date;
+export type EntityFilter = {
+    fieldId: string;
+    value: EntityFilterValue | EntityFilterValue[];
+    operator?: FilterOperator;
+};
 export type QueryParams = {
     size?: number;
     'sort-type'?: 'asc' | 'desc';
@@ -44,6 +51,7 @@ export type QueryParams = {
     'sort-by'?: string;
     sortBy?: string;
     cursor?: string;
+    filters?: EntityFilter[];
     [key: string]: any;
 };
 export type TemplateField = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "atlas-crm-api-client",
-  "version": "1.1.7",
+  "version": "1.2.0",
   "description": "A template for creating npm packages using TypeScript and VSCode",
   "main": "./lib/cjs/index.cjs",
   "files": [