twenty-client-sdk 2.31.0 → 2.33.0

package/dist/rest/index.d.ts

@@ -1,8 +1,10 @@
+export type TwentyClientRunAs = 'user' | 'application';
 export type RestApiClientOptions = {
     baseUrl?: string;
     token?: string;
     fetch?: typeof globalThis.fetch;
     defaultHeaders?: HeadersInit;
+    runAs?: TwentyClientRunAs;
 };
 export type RestApiRequestOptions = {
     headers?: HeadersInit;
@@ -28,6 +30,7 @@ export declare class RestApiClient {
     private defaultHeaders;
     private fetchImplementation;
     private authorizationToken;
+    private runAs;
     private refreshAccessTokenPromise;
     constructor(options?: RestApiClientOptions);
     request<TResponse = unknown>(method: string, path: string, options?: RestApiRequestOptions & {

package/dist/rest.cjs

@@ -1 +1 @@
-Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require("./application-BaeFV5yH.js");var t=e=>e!=null,n=class extends Error{constructor(e,t){super(e),this.name=`RestApiClientError`,this.status=t?.status,this.statusText=t?.statusText,this.url=t?.url,this.body=t?.body}},r=()=>globalThis.process?.env??{},i=e=>/^\/?s\//.test(e),a=e=>e.replace(/^(\/?)s\//,`$1`),o=(e,n,r)=>{let i=/^https?:\/\//i.test(n)?n:`${e}${n.startsWith(`/`)?``:`/`}${n}`;if(!t(r))return i;let a=new URLSearchParams;for(let[e,n]of Object.entries(r))t(n)&&a.append(e,String(n));let o=a.toString();return o.length===0?i:i.includes(`?`)?`${i}&${o}`:`${i}?${o}`},s=class{constructor(e){this.refreshAccessTokenPromise=null,this.baseUrl=e?.baseUrl,this.token=e?.token,this.defaultHeaders=e?.defaultHeaders,this.fetchImplementation=e?.fetch??globalThis.fetch??null,this.authorizationToken=e?.token??null}request(e,t,n){return this.execute(e,t,n?.body,n)}get(e,t){return this.execute(`GET`,e,void 0,t)}resolveUrl(e,t){let n=this.resolveTarget(e);return o(n.baseUrl,n.path,t?.query)}post(e,t,n){return this.execute(`POST`,e,t,n)}put(e,t,n){return this.execute(`PUT`,e,t,n)}patch(e,t,n){return this.execute(`PATCH`,e,t,n)}delete(e,t){return this.execute(`DELETE`,e,void 0,t)}resolveBaseUrl(){let i=this.baseUrl??r().TWENTY_API_URL;if(!t(i)||i.trim().length===0)throw new n(`Missing API url. Set the \`${e.r}\` environment variable or pass \`baseUrl\` to \`RestApiClient\`.`);return i.replace(/\/+$/,``)}resolveFunctionsBaseUrl(){let n=r()[e.n];if(!(!t(n)||n.trim().length===0))return n.trim().replace(/\/+$/,``)}resolveTarget(e){return t(this.baseUrl)||!i(e)?{baseUrl:this.resolveBaseUrl(),path:e}:{baseUrl:this.resolveFunctionsBaseUrl()??`${this.resolveBaseUrl()}/s`,path:a(e)}}resolveToken(){if(!t(this.authorizationToken)){let e=r();this.authorizationToken=this.token??e.TWENTY_APP_ACCESS_TOKEN??e.TWENTY_API_KEY??null}if(!t(this.authorizationToken)||this.authorizationToken.length===0)throw new n(`Missing application access token. Set the \`${e.i}\` environment variable or pass \`token\` to \`RestApiClient\`.`);return this.authorizationToken}async requestRefreshedAccessToken(){let t=globalThis.frontComponentHostCommunicationApi?.requestAccessTokenRefresh;return typeof t==`function`?(this.refreshAccessTokenPromise||=t().then(t=>typeof t!=`string`||t.length===0?null:(this.authorizationToken=t,r()[e.i]=t,t)).catch(e=>(console.error(`Twenty REST client: token refresh failed`,e),null)).finally(()=>{this.refreshAccessTokenPromise=null}),this.refreshAccessTokenPromise):null}sendRequest(e,r,i,a,o){if(!t(this.fetchImplementation))throw new n("Global `fetch` function is not available, pass a fetch implementation to `RestApiClient`.");let s=new Headers(this.defaultHeaders);t(o?.headers)&&new Headers(o.headers).forEach((e,t)=>s.set(t,e));let c=typeof FormData<`u`&&i instanceof FormData,l=t(i)&&!c&&typeof i!=`string`;c?s.delete(`Content-Type`):l&&s.set(`Content-Type`,`application/json`),s.set(`Authorization`,`Bearer ${a}`);let u=t(i)?c||typeof i==`string`?i:JSON.stringify(i):void 0;return this.fetchImplementation.call(globalThis,e,{method:r,headers:s,body:u,signal:o?.signal})}async parseResponse(e,t){let r=await e.text(),i;if(r.trim().length>0)try{i=JSON.parse(r)}catch{i=r}if(!e.ok)throw new n(`Request to ${t} failed with status ${e.status} ${e.statusText}`,{status:e.status,statusText:e.statusText,url:t,body:i});return i}async execute(e,n,r,i){let a=this.resolveTarget(n),s=o(a.baseUrl,a.path,i?.query),c=this.resolveToken(),l=await this.sendRequest(s,e,r,c,i);if(l.status===401){let n=await this.requestRefreshedAccessToken();t(n)&&(l=await this.sendRequest(s,e,r,n,i))}return this.parseResponse(l,s)}};exports.RestApiClient=s,exports.RestApiClientError=n;
+Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require("./application-jIH-TLc8.js");var t=e=>e!=null,n=class extends Error{constructor(e,t){super(e),this.name=`RestApiClientError`,this.status=t?.status,this.statusText=t?.statusText,this.url=t?.url,this.body=t?.body}},r=()=>globalThis.process?.env??{},i=e=>/^\/?s\//.test(e),a=e=>e.replace(/^(\/?)s\//,`$1`),o=(e,n,r)=>{let i=/^https?:\/\//i.test(n)?n:`${e}${n.startsWith(`/`)?``:`/`}${n}`;if(!t(r))return i;let a=new URLSearchParams;for(let[e,n]of Object.entries(r))t(n)&&a.append(e,String(n));let o=a.toString();return o.length===0?i:i.includes(`?`)?`${i}&${o}`:`${i}?${o}`},s=class{constructor(e){this.refreshAccessTokenPromise=null,this.baseUrl=e?.baseUrl,this.token=e?.token,this.defaultHeaders=e?.defaultHeaders,this.fetchImplementation=e?.fetch??globalThis.fetch??null,this.authorizationToken=e?.token??null,this.runAs=e?.runAs}request(e,t,n){return this.execute(e,t,n?.body,n)}get(e,t){return this.execute(`GET`,e,void 0,t)}resolveUrl(e,t){let n=this.resolveTarget(e);return o(n.baseUrl,n.path,t?.query)}post(e,t,n){return this.execute(`POST`,e,t,n)}put(e,t,n){return this.execute(`PUT`,e,t,n)}patch(e,t,n){return this.execute(`PATCH`,e,t,n)}delete(e,t){return this.execute(`DELETE`,e,void 0,t)}resolveBaseUrl(){let i=this.baseUrl??r().TWENTY_API_URL;if(!t(i)||i.trim().length===0)throw new n(`Missing API url. Set the \`${e.r}\` environment variable or pass \`baseUrl\` to \`RestApiClient\`.`);return i.replace(/\/+$/,``)}resolveFunctionsBaseUrl(){let n=r()[e.i];if(!(!t(n)||n.trim().length===0))return n.trim().replace(/\/+$/,``)}resolveTarget(e){return t(this.baseUrl)||!i(e)?{baseUrl:this.resolveBaseUrl(),path:e}:{baseUrl:this.resolveFunctionsBaseUrl()??`${this.resolveBaseUrl()}/s`,path:a(e)}}resolveToken(){let i=this.runAs===`application`?e.n:e.a;if(!t(this.authorizationToken)){let e=r();this.authorizationToken=this.token??e[i]??e.TWENTY_API_KEY??null}if(!t(this.authorizationToken)||this.authorizationToken.length===0)throw new n(`Missing application access token. Set the \`${i}\` environment variable or pass \`token\` to \`RestApiClient\`.`);return this.authorizationToken}async requestRefreshedAccessToken(){let t=globalThis.frontComponentHostCommunicationApi?.requestAccessTokenRefresh;return typeof t==`function`?(this.refreshAccessTokenPromise||=t().then(t=>typeof t!=`string`||t.length===0?null:(this.authorizationToken=t,r()[e.a]=t,t)).catch(e=>(console.error(`Twenty REST client: token refresh failed`,e),null)).finally(()=>{this.refreshAccessTokenPromise=null}),this.refreshAccessTokenPromise):null}sendRequest(e,r,i,a,o){if(!t(this.fetchImplementation))throw new n("Global `fetch` function is not available, pass a fetch implementation to `RestApiClient`.");let s=new Headers(this.defaultHeaders);t(o?.headers)&&new Headers(o.headers).forEach((e,t)=>s.set(t,e));let c=typeof FormData<`u`&&i instanceof FormData,l=t(i)&&!c&&typeof i!=`string`;c?s.delete(`Content-Type`):l&&s.set(`Content-Type`,`application/json`),s.set(`Authorization`,`Bearer ${a}`);let u=t(i)?c||typeof i==`string`?i:JSON.stringify(i):void 0;return this.fetchImplementation.call(globalThis,e,{method:r,headers:s,body:u,signal:o?.signal})}async parseResponse(e,t){let r=await e.text(),i;if(r.trim().length>0)try{i=JSON.parse(r)}catch{i=r}if(!e.ok)throw new n(`Request to ${t} failed with status ${e.status} ${e.statusText}`,{status:e.status,statusText:e.statusText,url:t,body:i});return i}async execute(e,n,r,i){let a=this.resolveTarget(n),s=o(a.baseUrl,a.path,i?.query),c=this.resolveToken(),l=await this.sendRequest(s,e,r,c,i);if(l.status===401){let n=await this.requestRefreshedAccessToken();t(n)&&(l=await this.sendRequest(s,e,r,n,i))}return this.parseResponse(l,s)}};exports.RestApiClient=s,exports.RestApiClientError=n;

package/dist/rest.mjs

@@ -1,19 +1,19 @@
-import { i as e, n as t, r as n } from "./application-Ce5JfsBq.mjs";
+import { a as e, i as t, n, r } from "./application-uUo_d2Xg.mjs";
 //#region src/rest/index.ts
-var r = (e) => e != null, i = class extends Error {
+var i = (e) => e != null, a = class extends Error {
 	constructor(e, t) {
 		super(e), this.name = "RestApiClientError", this.status = t?.status, this.statusText = t?.statusText, this.url = t?.url, this.body = t?.body;
 	}
-}, a = () => globalThis.process?.env ?? {}, o = (e) => /^\/?s\//.test(e), s = (e) => e.replace(/^(\/?)s\//, "$1"), c = (e, t, n) => {
-	let i = /^https?:\/\//i.test(t) ? t : `${e}${t.startsWith("/") ? "" : "/"}${t}`;
-	if (!r(n)) return i;
+}, o = () => globalThis.process?.env ?? {}, s = (e) => /^\/?s\//.test(e), c = (e) => e.replace(/^(\/?)s\//, "$1"), l = (e, t, n) => {
+	let r = /^https?:\/\//i.test(t) ? t : `${e}${t.startsWith("/") ? "" : "/"}${t}`;
+	if (!i(n)) return r;
 	let a = new URLSearchParams();
-	for (let [e, t] of Object.entries(n)) r(t) && a.append(e, String(t));
+	for (let [e, t] of Object.entries(n)) i(t) && a.append(e, String(t));
 	let o = a.toString();
-	return o.length === 0 ? i : i.includes("?") ? `${i}&${o}` : `${i}?${o}`;
-}, l = class {
+	return o.length === 0 ? r : r.includes("?") ? `${r}&${o}` : `${r}?${o}`;
+}, u = class {
 	constructor(e) {
-		this.refreshAccessTokenPromise = null, this.baseUrl = e?.baseUrl, this.token = e?.token, this.defaultHeaders = e?.defaultHeaders, this.fetchImplementation = e?.fetch ?? globalThis.fetch ?? null, this.authorizationToken = e?.token ?? null;
+		this.refreshAccessTokenPromise = null, this.baseUrl = e?.baseUrl, this.token = e?.token, this.defaultHeaders = e?.defaultHeaders, this.fetchImplementation = e?.fetch ?? globalThis.fetch ?? null, this.authorizationToken = e?.token ?? null, this.runAs = e?.runAs;
 	}
 	request(e, t, n) {
 		return this.execute(e, t, n?.body, n);
@@ -23,7 +23,7 @@ var r = (e) => e != null, i = class extends Error {
 	}
 	resolveUrl(e, t) {
 		let n = this.resolveTarget(e);
-		return c(n.baseUrl, n.path, t?.query);
+		return l(n.baseUrl, n.path, t?.query);
 	}
 	post(e, t, n) {
 		return this.execute("POST", e, t, n);
@@ -38,44 +38,45 @@ var r = (e) => e != null, i = class extends Error {
 		return this.execute("DELETE", e, void 0, t);
 	}
 	resolveBaseUrl() {
-		let e = this.baseUrl ?? a().TWENTY_API_URL;
-		if (!r(e) || e.trim().length === 0) throw new i(`Missing API url. Set the \`${n}\` environment variable or pass \`baseUrl\` to \`RestApiClient\`.`);
+		let e = this.baseUrl ?? o().TWENTY_API_URL;
+		if (!i(e) || e.trim().length === 0) throw new a(`Missing API url. Set the \`${r}\` environment variable or pass \`baseUrl\` to \`RestApiClient\`.`);
 		return e.replace(/\/+$/, "");
 	}
 	resolveFunctionsBaseUrl() {
-		let e = a()[t];
-		if (!(!r(e) || e.trim().length === 0)) return e.trim().replace(/\/+$/, "");
+		let e = o()[t];
+		if (!(!i(e) || e.trim().length === 0)) return e.trim().replace(/\/+$/, "");
 	}
 	resolveTarget(e) {
-		return r(this.baseUrl) || !o(e) ? {
+		return i(this.baseUrl) || !s(e) ? {
 			baseUrl: this.resolveBaseUrl(),
 			path: e
 		} : {
 			baseUrl: this.resolveFunctionsBaseUrl() ?? `${this.resolveBaseUrl()}/s`,
-			path: s(e)
+			path: c(e)
 		};
 	}
 	resolveToken() {
-		if (!r(this.authorizationToken)) {
-			let e = a();
-			this.authorizationToken = this.token ?? e.TWENTY_APP_ACCESS_TOKEN ?? e.TWENTY_API_KEY ?? null;
+		let t = this.runAs === "application" ? n : e;
+		if (!i(this.authorizationToken)) {
+			let e = o();
+			this.authorizationToken = this.token ?? e[t] ?? e.TWENTY_API_KEY ?? null;
 		}
-		if (!r(this.authorizationToken) || this.authorizationToken.length === 0) throw new i(`Missing application access token. Set the \`${e}\` environment variable or pass \`token\` to \`RestApiClient\`.`);
+		if (!i(this.authorizationToken) || this.authorizationToken.length === 0) throw new a(`Missing application access token. Set the \`${t}\` environment variable or pass \`token\` to \`RestApiClient\`.`);
 		return this.authorizationToken;
 	}
 	async requestRefreshedAccessToken() {
 		let t = globalThis.frontComponentHostCommunicationApi?.requestAccessTokenRefresh;
-		return typeof t == "function" ? (this.refreshAccessTokenPromise ||= t().then((t) => typeof t != "string" || t.length === 0 ? null : (this.authorizationToken = t, a()[e] = t, t)).catch((e) => (console.error("Twenty REST client: token refresh failed", e), null)).finally(() => {
+		return typeof t == "function" ? (this.refreshAccessTokenPromise ||= t().then((t) => typeof t != "string" || t.length === 0 ? null : (this.authorizationToken = t, o()[e] = t, t)).catch((e) => (console.error("Twenty REST client: token refresh failed", e), null)).finally(() => {
 			this.refreshAccessTokenPromise = null;
 		}), this.refreshAccessTokenPromise) : null;
 	}
-	sendRequest(e, t, n, a, o) {
-		if (!r(this.fetchImplementation)) throw new i("Global `fetch` function is not available, pass a fetch implementation to `RestApiClient`.");
+	sendRequest(e, t, n, r, o) {
+		if (!i(this.fetchImplementation)) throw new a("Global `fetch` function is not available, pass a fetch implementation to `RestApiClient`.");
 		let s = new Headers(this.defaultHeaders);
-		r(o?.headers) && new Headers(o.headers).forEach((e, t) => s.set(t, e));
-		let c = typeof FormData < "u" && n instanceof FormData, l = r(n) && !c && typeof n != "string";
-		c ? s.delete("Content-Type") : l && s.set("Content-Type", "application/json"), s.set("Authorization", `Bearer ${a}`);
-		let u = r(n) ? c || typeof n == "string" ? n : JSON.stringify(n) : void 0;
+		i(o?.headers) && new Headers(o.headers).forEach((e, t) => s.set(t, e));
+		let c = typeof FormData < "u" && n instanceof FormData, l = i(n) && !c && typeof n != "string";
+		c ? s.delete("Content-Type") : l && s.set("Content-Type", "application/json"), s.set("Authorization", `Bearer ${r}`);
+		let u = i(n) ? c || typeof n == "string" ? n : JSON.stringify(n) : void 0;
 		return this.fetchImplementation.call(globalThis, e, {
 			method: t,
 			headers: s,
@@ -90,7 +91,7 @@ var r = (e) => e != null, i = class extends Error {
 		} catch {
 			r = n;
 		}
-		if (!e.ok) throw new i(`Request to ${t} failed with status ${e.status} ${e.statusText}`, {
+		if (!e.ok) throw new a(`Request to ${t} failed with status ${e.status} ${e.statusText}`, {
 			status: e.status,
 			statusText: e.statusText,
 			url: t,
@@ -98,14 +99,14 @@ var r = (e) => e != null, i = class extends Error {
 		});
 		return r;
 	}
-	async execute(e, t, n, i) {
-		let a = this.resolveTarget(t), o = c(a.baseUrl, a.path, i?.query), s = this.resolveToken(), l = await this.sendRequest(o, e, n, s, i);
-		if (l.status === 401) {
+	async execute(e, t, n, r) {
+		let a = this.resolveTarget(t), o = l(a.baseUrl, a.path, r?.query), s = this.resolveToken(), c = await this.sendRequest(o, e, n, s, r);
+		if (c.status === 401) {
 			let t = await this.requestRefreshedAccessToken();
-			r(t) && (l = await this.sendRequest(o, e, n, t, i));
+			i(t) && (c = await this.sendRequest(o, e, n, t, r));
 		}
-		return this.parseResponse(l, o);
+		return this.parseResponse(c, o);
 	}
 };
 //#endregion
-export { l as RestApiClient, i as RestApiClientError };
+export { u as RestApiClient, a as RestApiClientError };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "twenty-client-sdk",
-  "version": "2.31.0",
+  "version": "2.33.0",
   "sideEffects": false,
   "license": "MIT",
   "scripts": {