@knocklabs/client 0.15.1 → 0.15.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.15.2
+
+### Patch Changes
+
+- fb68ce1: feat: adds javascript client version to user agent
+
 ## 0.15.1
 
 ### Patch Changes

package/dist/cjs/api.js

@@ -1,2 +1,2 @@
-"use strict";var i=Object.defineProperty;var n=(t,e,s)=>e in t?i(t,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):t[e]=s;var r=(t,e,s)=>n(t,typeof e!="symbol"?e+"":e,s);Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const u=require("axios"),l=require("axios-retry"),c=require("phoenix"),a=t=>t&&typeof t=="object"&&"default"in t?t:{default:t},p=a(u),o=a(l);class d{constructor(e){r(this,"host");r(this,"apiKey");r(this,"userToken");r(this,"axiosClient");r(this,"socket");this.host=e.host,this.apiKey=e.apiKey,this.userToken=e.userToken||null,this.axiosClient=p.default.create({baseURL:this.host,headers:{Accept:"application/json","Content-Type":"application/json",Authorization:`Bearer ${this.apiKey}`,"X-Knock-User-Token":this.userToken}}),typeof window<"u"&&(this.socket=new c.Socket(`${this.host.replace("http","ws")}/ws/v1`,{params:{user_token:this.userToken,api_key:this.apiKey}})),o.default(this.axiosClient,{retries:3,retryCondition:this.canRetryRequest,retryDelay:o.default.exponentialDelay})}async makeRequest(e){try{const s=await this.axiosClient(e);return{statusCode:s.status<300?"ok":"error",body:s.data,error:void 0,status:s.status}}catch(s){return console.error(s),{statusCode:"error",status:500,body:void 0,error:s}}}canRetryRequest(e){return o.default.isNetworkError(e)?!0:e.response?e.response.status>=500&&e.response.status<=599||e.response.status===429:!1}}exports.default=d;
+"use strict";var a=Object.defineProperty;var n=(t,e,s)=>e in t?a(t,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):t[e]=s;var r=(t,e,s)=>n(t,typeof e!="symbol"?e+"":e,s);Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const u=require("axios"),l=require("axios-retry"),c=require("phoenix"),i=t=>t&&typeof t=="object"&&"default"in t?t:{default:t},h=i(u),o=i(l);class p{constructor(e){r(this,"host");r(this,"apiKey");r(this,"userToken");r(this,"axiosClient");r(this,"socket");this.host=e.host,this.apiKey=e.apiKey,this.userToken=e.userToken||null,this.axiosClient=h.default.create({baseURL:this.host,headers:{Accept:"application/json","Content-Type":"application/json",Authorization:`Bearer ${this.apiKey}`,"X-Knock-User-Token":this.userToken,"User-Agent":this.getUserAgent()}}),typeof window<"u"&&(this.socket=new c.Socket(`${this.host.replace("http","ws")}/ws/v1`,{params:{user_token:this.userToken,api_key:this.apiKey}})),o.default(this.axiosClient,{retries:3,retryCondition:this.canRetryRequest,retryDelay:o.default.exponentialDelay})}async makeRequest(e){try{const s=await this.axiosClient(e);return{statusCode:s.status<300?"ok":"error",body:s.data,error:void 0,status:s.status}}catch(s){return console.error(s),{statusCode:"error",status:500,body:void 0,error:s}}}canRetryRequest(e){return o.default.isNetworkError(e)?!0:e.response?e.response.status>=500&&e.response.status<=599||e.response.status===429:!1}getUserAgent(){return"Knock/ClientJS 0.15.2"}}exports.default=p;
 //# sourceMappingURL=api.js.map

package/dist/cjs/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sources":["../../src/api.ts"],"sourcesContent":["import axios, { AxiosError, AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport axiosRetry from \"axios-retry\";\nimport { Socket } from \"phoenix\";\n\ntype ApiClientOptions = {\n  host: string;\n  apiKey: string;\n  userToken: string | undefined;\n};\n\nexport interface ApiResponse {\n  // eslint-disable-next-line\n  error?: any;\n  // eslint-disable-next-line\n  body?: any;\n  statusCode: \"ok\" | \"error\";\n  status: number;\n}\n\nclass ApiClient {\n  private host: string;\n  private apiKey: string;\n  private userToken: string | null;\n  private axiosClient: AxiosInstance;\n\n  public socket: Socket | undefined;\n\n  constructor(options: ApiClientOptions) {\n    this.host = options.host;\n    this.apiKey = options.apiKey;\n    this.userToken = options.userToken || null;\n\n    // Create a retryable axios client\n    this.axiosClient = axios.create({\n      baseURL: this.host,\n      headers: {\n        Accept: \"application/json\",\n        \"Content-Type\": \"application/json\",\n        Authorization: `Bearer ${this.apiKey}`,\n        \"X-Knock-User-Token\": this.userToken,\n      },\n    });\n\n    if (typeof window !== \"undefined\") {\n      this.socket = new Socket(`${this.host.replace(\"http\", \"ws\")}/ws/v1`, {\n        params: {\n          user_token: this.userToken,\n          api_key: this.apiKey,\n        },\n      });\n    }\n\n    axiosRetry(this.axiosClient, {\n      retries: 3,\n      retryCondition: this.canRetryRequest,\n      retryDelay: axiosRetry.exponentialDelay,\n    });\n  }\n\n  async makeRequest(req: AxiosRequestConfig): Promise<ApiResponse> {\n    try {\n      const result = await this.axiosClient(req);\n\n      return {\n        statusCode: result.status < 300 ? \"ok\" : \"error\",\n        body: result.data,\n        error: undefined,\n        status: result.status,\n      };\n\n      // eslint:disable-next-line\n    } catch (e: unknown) {\n      console.error(e);\n\n      return {\n        statusCode: \"error\",\n        status: 500,\n        body: undefined,\n        error: e,\n      };\n    }\n  }\n\n  private canRetryRequest(error: AxiosError) {\n    // Retry Network Errors.\n    if (axiosRetry.isNetworkError(error)) {\n      return true;\n    }\n\n    if (!error.response) {\n      // Cannot determine if the request can be retried\n      return false;\n    }\n\n    // Retry Server Errors (5xx).\n    if (error.response.status >= 500 && error.response.status <= 599) {\n      return true;\n    }\n\n    // Retry if rate limited.\n    if (error.response.status === 429) {\n      return true;\n    }\n\n    return false;\n  }\n}\n\nexport default ApiClient;\n"],"names":["ApiClient","options","__publicField","axios","Socket","axiosRetry","req","result","e","error"],"mappings":"6ZAmBA,MAAMA,CAAU,CAQd,YAAYC,EAA2B,CAP/BC,EAAA,aACAA,EAAA,eACAA,EAAA,kBACAA,EAAA,oBAEDA,EAAA,eAGL,KAAK,KAAOD,EAAQ,KACpB,KAAK,OAASA,EAAQ,OACjB,KAAA,UAAYA,EAAQ,WAAa,KAGjC,KAAA,YAAcE,UAAM,OAAO,CAC9B,QAAS,KAAK,KACd,QAAS,CACP,OAAQ,mBACR,eAAgB,mBAChB,cAAe,UAAU,KAAK,MAAM,GACpC,qBAAsB,KAAK,SAAA,CAC7B,CACD,EAEG,OAAO,OAAW,MACf,KAAA,OAAS,IAAIC,EAAA,OAAO,GAAG,KAAK,KAAK,QAAQ,OAAQ,IAAI,CAAC,SAAU,CACnE,OAAQ,CACN,WAAY,KAAK,UACjB,QAAS,KAAK,MAAA,CAChB,CACD,GAGHC,EAAA,QAAW,KAAK,YAAa,CAC3B,QAAS,EACT,eAAgB,KAAK,gBACrB,WAAYA,EAAAA,QAAW,gBAAA,CACxB,CAAA,CAGH,MAAM,YAAYC,EAA+C,CAC3D,GAAA,CACF,MAAMC,EAAS,MAAM,KAAK,YAAYD,CAAG,EAElC,MAAA,CACL,WAAYC,EAAO,OAAS,IAAM,KAAO,QACzC,KAAMA,EAAO,KACb,MAAO,OACP,OAAQA,EAAO,MACjB,QAGOC,EAAY,CACnB,eAAQ,MAAMA,CAAC,EAER,CACL,WAAY,QACZ,OAAQ,IACR,KAAM,OACN,MAAOA,CACT,CAAA,CACF,CAGM,gBAAgBC,EAAmB,CAErC,OAAAJ,EAAA,QAAW,eAAeI,CAAK,EAC1B,GAGJA,EAAM,SAMPA,EAAM,SAAS,QAAU,KAAOA,EAAM,SAAS,QAAU,KAKzDA,EAAM,SAAS,SAAW,IATrB,EAaF,CAEX"}
+{"version":3,"file":"api.js","sources":["../../src/api.ts"],"sourcesContent":["import axios, { AxiosError, AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport axiosRetry from \"axios-retry\";\nimport { Socket } from \"phoenix\";\n\ntype ApiClientOptions = {\n  host: string;\n  apiKey: string;\n  userToken: string | undefined;\n};\n\nexport interface ApiResponse {\n  // eslint-disable-next-line\n  error?: any;\n  // eslint-disable-next-line\n  body?: any;\n  statusCode: \"ok\" | \"error\";\n  status: number;\n}\n\nclass ApiClient {\n  private host: string;\n  private apiKey: string;\n  private userToken: string | null;\n  private axiosClient: AxiosInstance;\n\n  public socket: Socket | undefined;\n\n  constructor(options: ApiClientOptions) {\n    this.host = options.host;\n    this.apiKey = options.apiKey;\n    this.userToken = options.userToken || null;\n\n    // Create a retryable axios client\n    this.axiosClient = axios.create({\n      baseURL: this.host,\n      headers: {\n        Accept: \"application/json\",\n        \"Content-Type\": \"application/json\",\n        Authorization: `Bearer ${this.apiKey}`,\n        \"X-Knock-User-Token\": this.userToken,\n        \"User-Agent\": this.getUserAgent(),\n      },\n    });\n\n    if (typeof window !== \"undefined\") {\n      this.socket = new Socket(`${this.host.replace(\"http\", \"ws\")}/ws/v1`, {\n        params: {\n          user_token: this.userToken,\n          api_key: this.apiKey,\n        },\n      });\n    }\n\n    axiosRetry(this.axiosClient, {\n      retries: 3,\n      retryCondition: this.canRetryRequest,\n      retryDelay: axiosRetry.exponentialDelay,\n    });\n  }\n\n  async makeRequest(req: AxiosRequestConfig): Promise<ApiResponse> {\n    try {\n      const result = await this.axiosClient(req);\n\n      return {\n        statusCode: result.status < 300 ? \"ok\" : \"error\",\n        body: result.data,\n        error: undefined,\n        status: result.status,\n      };\n\n      // eslint:disable-next-line\n    } catch (e: unknown) {\n      console.error(e);\n\n      return {\n        statusCode: \"error\",\n        status: 500,\n        body: undefined,\n        error: e,\n      };\n    }\n  }\n\n  private canRetryRequest(error: AxiosError) {\n    // Retry Network Errors.\n    if (axiosRetry.isNetworkError(error)) {\n      return true;\n    }\n\n    if (!error.response) {\n      // Cannot determine if the request can be retried\n      return false;\n    }\n\n    // Retry Server Errors (5xx).\n    if (error.response.status >= 500 && error.response.status <= 599) {\n      return true;\n    }\n\n    // Retry if rate limited.\n    if (error.response.status === 429) {\n      return true;\n    }\n\n    return false;\n  }\n\n  private getUserAgent() {\n    // Note: we're following format used in our Stainless SDKs:\n    // https://github.com/knocklabs/knock-node/blob/main/src/client.ts#L335\n    // If we add the env var to turbo.json, it caches it so the version\n    // never actually updates.\n    // eslint-disable-next-line turbo/no-undeclared-env-vars\n    return `Knock/ClientJS ${process.env.CLIENT_PACKAGE_VERSION}`;\n  }\n}\n\nexport default ApiClient;\n"],"names":["ApiClient","options","__publicField","axios","Socket","axiosRetry","req","result","e","error"],"mappings":"6ZAmBA,MAAMA,CAAU,CAQd,YAAYC,EAA2B,CAP/BC,EAAA,aACAA,EAAA,eACAA,EAAA,kBACAA,EAAA,oBAEDA,EAAA,eAGL,KAAK,KAAOD,EAAQ,KACpB,KAAK,OAASA,EAAQ,OACjB,KAAA,UAAYA,EAAQ,WAAa,KAGjC,KAAA,YAAcE,UAAM,OAAO,CAC9B,QAAS,KAAK,KACd,QAAS,CACP,OAAQ,mBACR,eAAgB,mBAChB,cAAe,UAAU,KAAK,MAAM,GACpC,qBAAsB,KAAK,UAC3B,aAAc,KAAK,aAAa,CAAA,CAClC,CACD,EAEG,OAAO,OAAW,MACf,KAAA,OAAS,IAAIC,EAAA,OAAO,GAAG,KAAK,KAAK,QAAQ,OAAQ,IAAI,CAAC,SAAU,CACnE,OAAQ,CACN,WAAY,KAAK,UACjB,QAAS,KAAK,MAAA,CAChB,CACD,GAGHC,EAAA,QAAW,KAAK,YAAa,CAC3B,QAAS,EACT,eAAgB,KAAK,gBACrB,WAAYA,EAAAA,QAAW,gBAAA,CACxB,CAAA,CAGH,MAAM,YAAYC,EAA+C,CAC3D,GAAA,CACF,MAAMC,EAAS,MAAM,KAAK,YAAYD,CAAG,EAElC,MAAA,CACL,WAAYC,EAAO,OAAS,IAAM,KAAO,QACzC,KAAMA,EAAO,KACb,MAAO,OACP,OAAQA,EAAO,MACjB,QAGOC,EAAY,CACnB,eAAQ,MAAMA,CAAC,EAER,CACL,WAAY,QACZ,OAAQ,IACR,KAAM,OACN,MAAOA,CACT,CAAA,CACF,CAGM,gBAAgBC,EAAmB,CAErC,OAAAJ,EAAA,QAAW,eAAeI,CAAK,EAC1B,GAGJA,EAAM,SAMPA,EAAM,SAAS,QAAU,KAAOA,EAAM,SAAS,QAAU,KAKzDA,EAAM,SAAS,SAAW,IATrB,EAaF,CAGD,cAAe,CAMd,MAAA,uBAAoD,CAE/D"}

package/dist/esm/api.mjs

@@ -17,7 +17,8 @@ class y {
         Accept: "application/json",
         "Content-Type": "application/json",
         Authorization: `Bearer ${this.apiKey}`,
-        "X-Knock-User-Token": this.userToken
+        "X-Knock-User-Token": this.userToken,
+        "User-Agent": this.getUserAgent()
       }
     }), typeof window < "u" && (this.socket = new u(`${this.host.replace("http", "ws")}/ws/v1`, {
       params: {
@@ -51,6 +52,9 @@ class y {
   canRetryRequest(e) {
     return o.isNetworkError(e) ? !0 : e.response ? e.response.status >= 500 && e.response.status <= 599 || e.response.status === 429 : !1;
   }
+  getUserAgent() {
+    return "Knock/ClientJS 0.15.2";
+  }
 }
 export {
   y as default

package/dist/esm/api.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"api.mjs","sources":["../../src/api.ts"],"sourcesContent":["import axios, { AxiosError, AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport axiosRetry from \"axios-retry\";\nimport { Socket } from \"phoenix\";\n\ntype ApiClientOptions = {\n  host: string;\n  apiKey: string;\n  userToken: string | undefined;\n};\n\nexport interface ApiResponse {\n  // eslint-disable-next-line\n  error?: any;\n  // eslint-disable-next-line\n  body?: any;\n  statusCode: \"ok\" | \"error\";\n  status: number;\n}\n\nclass ApiClient {\n  private host: string;\n  private apiKey: string;\n  private userToken: string | null;\n  private axiosClient: AxiosInstance;\n\n  public socket: Socket | undefined;\n\n  constructor(options: ApiClientOptions) {\n    this.host = options.host;\n    this.apiKey = options.apiKey;\n    this.userToken = options.userToken || null;\n\n    // Create a retryable axios client\n    this.axiosClient = axios.create({\n      baseURL: this.host,\n      headers: {\n        Accept: \"application/json\",\n        \"Content-Type\": \"application/json\",\n        Authorization: `Bearer ${this.apiKey}`,\n        \"X-Knock-User-Token\": this.userToken,\n      },\n    });\n\n    if (typeof window !== \"undefined\") {\n      this.socket = new Socket(`${this.host.replace(\"http\", \"ws\")}/ws/v1`, {\n        params: {\n          user_token: this.userToken,\n          api_key: this.apiKey,\n        },\n      });\n    }\n\n    axiosRetry(this.axiosClient, {\n      retries: 3,\n      retryCondition: this.canRetryRequest,\n      retryDelay: axiosRetry.exponentialDelay,\n    });\n  }\n\n  async makeRequest(req: AxiosRequestConfig): Promise<ApiResponse> {\n    try {\n      const result = await this.axiosClient(req);\n\n      return {\n        statusCode: result.status < 300 ? \"ok\" : \"error\",\n        body: result.data,\n        error: undefined,\n        status: result.status,\n      };\n\n      // eslint:disable-next-line\n    } catch (e: unknown) {\n      console.error(e);\n\n      return {\n        statusCode: \"error\",\n        status: 500,\n        body: undefined,\n        error: e,\n      };\n    }\n  }\n\n  private canRetryRequest(error: AxiosError) {\n    // Retry Network Errors.\n    if (axiosRetry.isNetworkError(error)) {\n      return true;\n    }\n\n    if (!error.response) {\n      // Cannot determine if the request can be retried\n      return false;\n    }\n\n    // Retry Server Errors (5xx).\n    if (error.response.status >= 500 && error.response.status <= 599) {\n      return true;\n    }\n\n    // Retry if rate limited.\n    if (error.response.status === 429) {\n      return true;\n    }\n\n    return false;\n  }\n}\n\nexport default ApiClient;\n"],"names":["ApiClient","options","__publicField","axios","Socket","axiosRetry","req","result","e","error"],"mappings":";;;;;;AAmBA,MAAMA,EAAU;AAAA,EAQd,YAAYC,GAA2B;AAP/B,IAAAC,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AAED,IAAAA,EAAA;AAGL,SAAK,OAAOD,EAAQ,MACpB,KAAK,SAASA,EAAQ,QACjB,KAAA,YAAYA,EAAQ,aAAa,MAGjC,KAAA,cAAcE,EAAM,OAAO;AAAA,MAC9B,SAAS,KAAK;AAAA,MACd,SAAS;AAAA,QACP,QAAQ;AAAA,QACR,gBAAgB;AAAA,QAChB,eAAe,UAAU,KAAK,MAAM;AAAA,QACpC,sBAAsB,KAAK;AAAA,MAAA;AAAA,IAC7B,CACD,GAEG,OAAO,SAAW,QACf,KAAA,SAAS,IAAIC,EAAO,GAAG,KAAK,KAAK,QAAQ,QAAQ,IAAI,CAAC,UAAU;AAAA,MACnE,QAAQ;AAAA,QACN,YAAY,KAAK;AAAA,QACjB,SAAS,KAAK;AAAA,MAAA;AAAA,IAChB,CACD,IAGHC,EAAW,KAAK,aAAa;AAAA,MAC3B,SAAS;AAAA,MACT,gBAAgB,KAAK;AAAA,MACrB,YAAYA,EAAW;AAAA,IAAA,CACxB;AAAA,EAAA;AAAA,EAGH,MAAM,YAAYC,GAA+C;AAC3D,QAAA;AACF,YAAMC,IAAS,MAAM,KAAK,YAAYD,CAAG;AAElC,aAAA;AAAA,QACL,YAAYC,EAAO,SAAS,MAAM,OAAO;AAAA,QACzC,MAAMA,EAAO;AAAA,QACb,OAAO;AAAA,QACP,QAAQA,EAAO;AAAA,MACjB;AAAA,aAGOC,GAAY;AACnB,qBAAQ,MAAMA,CAAC,GAER;AAAA,QACL,YAAY;AAAA,QACZ,QAAQ;AAAA,QACR,MAAM;AAAA,QACN,OAAOA;AAAA,MACT;AAAA,IAAA;AAAA,EACF;AAAA,EAGM,gBAAgBC,GAAmB;AAErC,WAAAJ,EAAW,eAAeI,CAAK,IAC1B,KAGJA,EAAM,WAMPA,EAAM,SAAS,UAAU,OAAOA,EAAM,SAAS,UAAU,OAKzDA,EAAM,SAAS,WAAW,MATrB;AAAA,EAaF;AAEX;"}
+{"version":3,"file":"api.mjs","sources":["../../src/api.ts"],"sourcesContent":["import axios, { AxiosError, AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport axiosRetry from \"axios-retry\";\nimport { Socket } from \"phoenix\";\n\ntype ApiClientOptions = {\n  host: string;\n  apiKey: string;\n  userToken: string | undefined;\n};\n\nexport interface ApiResponse {\n  // eslint-disable-next-line\n  error?: any;\n  // eslint-disable-next-line\n  body?: any;\n  statusCode: \"ok\" | \"error\";\n  status: number;\n}\n\nclass ApiClient {\n  private host: string;\n  private apiKey: string;\n  private userToken: string | null;\n  private axiosClient: AxiosInstance;\n\n  public socket: Socket | undefined;\n\n  constructor(options: ApiClientOptions) {\n    this.host = options.host;\n    this.apiKey = options.apiKey;\n    this.userToken = options.userToken || null;\n\n    // Create a retryable axios client\n    this.axiosClient = axios.create({\n      baseURL: this.host,\n      headers: {\n        Accept: \"application/json\",\n        \"Content-Type\": \"application/json\",\n        Authorization: `Bearer ${this.apiKey}`,\n        \"X-Knock-User-Token\": this.userToken,\n        \"User-Agent\": this.getUserAgent(),\n      },\n    });\n\n    if (typeof window !== \"undefined\") {\n      this.socket = new Socket(`${this.host.replace(\"http\", \"ws\")}/ws/v1`, {\n        params: {\n          user_token: this.userToken,\n          api_key: this.apiKey,\n        },\n      });\n    }\n\n    axiosRetry(this.axiosClient, {\n      retries: 3,\n      retryCondition: this.canRetryRequest,\n      retryDelay: axiosRetry.exponentialDelay,\n    });\n  }\n\n  async makeRequest(req: AxiosRequestConfig): Promise<ApiResponse> {\n    try {\n      const result = await this.axiosClient(req);\n\n      return {\n        statusCode: result.status < 300 ? \"ok\" : \"error\",\n        body: result.data,\n        error: undefined,\n        status: result.status,\n      };\n\n      // eslint:disable-next-line\n    } catch (e: unknown) {\n      console.error(e);\n\n      return {\n        statusCode: \"error\",\n        status: 500,\n        body: undefined,\n        error: e,\n      };\n    }\n  }\n\n  private canRetryRequest(error: AxiosError) {\n    // Retry Network Errors.\n    if (axiosRetry.isNetworkError(error)) {\n      return true;\n    }\n\n    if (!error.response) {\n      // Cannot determine if the request can be retried\n      return false;\n    }\n\n    // Retry Server Errors (5xx).\n    if (error.response.status >= 500 && error.response.status <= 599) {\n      return true;\n    }\n\n    // Retry if rate limited.\n    if (error.response.status === 429) {\n      return true;\n    }\n\n    return false;\n  }\n\n  private getUserAgent() {\n    // Note: we're following format used in our Stainless SDKs:\n    // https://github.com/knocklabs/knock-node/blob/main/src/client.ts#L335\n    // If we add the env var to turbo.json, it caches it so the version\n    // never actually updates.\n    // eslint-disable-next-line turbo/no-undeclared-env-vars\n    return `Knock/ClientJS ${process.env.CLIENT_PACKAGE_VERSION}`;\n  }\n}\n\nexport default ApiClient;\n"],"names":["ApiClient","options","__publicField","axios","Socket","axiosRetry","req","result","e","error"],"mappings":";;;;;;AAmBA,MAAMA,EAAU;AAAA,EAQd,YAAYC,GAA2B;AAP/B,IAAAC,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AAED,IAAAA,EAAA;AAGL,SAAK,OAAOD,EAAQ,MACpB,KAAK,SAASA,EAAQ,QACjB,KAAA,YAAYA,EAAQ,aAAa,MAGjC,KAAA,cAAcE,EAAM,OAAO;AAAA,MAC9B,SAAS,KAAK;AAAA,MACd,SAAS;AAAA,QACP,QAAQ;AAAA,QACR,gBAAgB;AAAA,QAChB,eAAe,UAAU,KAAK,MAAM;AAAA,QACpC,sBAAsB,KAAK;AAAA,QAC3B,cAAc,KAAK,aAAa;AAAA,MAAA;AAAA,IAClC,CACD,GAEG,OAAO,SAAW,QACf,KAAA,SAAS,IAAIC,EAAO,GAAG,KAAK,KAAK,QAAQ,QAAQ,IAAI,CAAC,UAAU;AAAA,MACnE,QAAQ;AAAA,QACN,YAAY,KAAK;AAAA,QACjB,SAAS,KAAK;AAAA,MAAA;AAAA,IAChB,CACD,IAGHC,EAAW,KAAK,aAAa;AAAA,MAC3B,SAAS;AAAA,MACT,gBAAgB,KAAK;AAAA,MACrB,YAAYA,EAAW;AAAA,IAAA,CACxB;AAAA,EAAA;AAAA,EAGH,MAAM,YAAYC,GAA+C;AAC3D,QAAA;AACF,YAAMC,IAAS,MAAM,KAAK,YAAYD,CAAG;AAElC,aAAA;AAAA,QACL,YAAYC,EAAO,SAAS,MAAM,OAAO;AAAA,QACzC,MAAMA,EAAO;AAAA,QACb,OAAO;AAAA,QACP,QAAQA,EAAO;AAAA,MACjB;AAAA,aAGOC,GAAY;AACnB,qBAAQ,MAAMA,CAAC,GAER;AAAA,QACL,YAAY;AAAA,QACZ,QAAQ;AAAA,QACR,MAAM;AAAA,QACN,OAAOA;AAAA,MACT;AAAA,IAAA;AAAA,EACF;AAAA,EAGM,gBAAgBC,GAAmB;AAErC,WAAAJ,EAAW,eAAeI,CAAK,IAC1B,KAGJA,EAAM,WAMPA,EAAM,SAAS,UAAU,OAAOA,EAAM,SAAS,UAAU,OAKzDA,EAAM,SAAS,WAAW,MATrB;AAAA,EAaF;AAAA,EAGD,eAAe;AAMd,WAAA;AAAA,EAAoD;AAE/D;"}

package/dist/types/api.d.ts

@@ -20,6 +20,7 @@ declare class ApiClient {
     constructor(options: ApiClientOptions);
     makeRequest(req: AxiosRequestConfig): Promise<ApiResponse>;
     private canRetryRequest;
+    private getUserAgent;
 }
 export default ApiClient;
 //# sourceMappingURL=api.d.ts.map

package/dist/types/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA,OAAc,EAA6B,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE7E,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,WAAW;IAE1B,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,IAAI,GAAG,OAAO,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,cAAM,SAAS;IACb,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,WAAW,CAAgB;IAE5B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEtB,OAAO,EAAE,gBAAgB;IAgC/B,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBhE,OAAO,CAAC,eAAe;CAuBxB;AAED,eAAe,SAAS,CAAC"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA,OAAc,EAA6B,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE7E,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,WAAW;IAE1B,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,IAAI,GAAG,OAAO,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,cAAM,SAAS;IACb,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,WAAW,CAAgB;IAE5B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEtB,OAAO,EAAE,gBAAgB;IAiC/B,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBhE,OAAO,CAAC,eAAe;IAwBvB,OAAO,CAAC,YAAY;CAQrB;AAED,eAAe,SAAS,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/client",
-  "version": "0.15.1",
+  "version": "0.15.2",
   "description": "The clientside library for interacting with Knock",
   "homepage": "https://github.com/knocklabs/javascript/tree/main/packages/client",
   "author": "@knocklabs",
@@ -77,7 +77,7 @@
     "eventemitter2": "^6.4.5",
     "jwt-decode": "^4.0.0",
     "nanoid": "^3.3.11",
-    "phoenix": "1.7.19",
+    "phoenix": "1.7.21",
     "urlpattern-polyfill": "^10.0.0"
   }
 }

package/src/api.ts

@@ -38,6 +38,7 @@ class ApiClient {
         "Content-Type": "application/json",
         Authorization: `Bearer ${this.apiKey}`,
         "X-Knock-User-Token": this.userToken,
+        "User-Agent": this.getUserAgent(),
       },
     });
 
@@ -104,6 +105,15 @@ class ApiClient {
 
     return false;
   }
+
+  private getUserAgent() {
+    // Note: we're following format used in our Stainless SDKs:
+    // https://github.com/knocklabs/knock-node/blob/main/src/client.ts#L335
+    // If we add the env var to turbo.json, it caches it so the version
+    // never actually updates.
+    // eslint-disable-next-line turbo/no-undeclared-env-vars
+    return `Knock/ClientJS ${process.env.CLIENT_PACKAGE_VERSION}`;
+  }
 }
 
 export default ApiClient;