@webority/mobile-support 0.173.0 → 0.174.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/commonjs/client.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.toSupportApiError=exports.supportRepliesUrl=exports.createSupportClient=exports.SupportApiError=exports.OFFLINE_MESSAGE=exports.GENERIC_MESSAGE=void 0;var _mobileCore=require("@webority/mobile-core");const isJsonObject=e=>"object"==typeof e&&null!==e&&!Array.isArray(e),reject=(e,t)=>{throw new Error(`${e} must be ${t}`)},readObject=(e,t)=>isJsonObject(e)?e:reject(t,"an object"),readString=(e,t,r)=>{const a=e[t];return"string"==typeof a?a:reject(`${r}.${t}`,"a string")},readNumber=(e,t,r)=>{const a=e[t];return"number"==typeof a&&Number.isFinite(a)?a:reject(`${r}.${t}`,"a number")},readBoolean=(e,t,r)=>{const a=e[t];return"boolean"==typeof a?a:reject(`${r}.${t}`,"true or false")},readNullable=(e,t,r,a)=>null===e[t]?null:a(e,t,r),readOptional=(e,t,r,a)=>void 0===e[t]?void 0:a(e,t,r),oneOf=e=>(t,r,a)=>{const s=readString(t,r,a);return e.find(e=>e===s)??reject(`${a}.${r}`,`one of ${e.join(", ")}`)},nested=e=>(t,r,a)=>e(t[r],`${a}.${r}`),parseList=(e,t,r)=>Array.isArray(e)?e.map((e,a)=>r(e,`${t}[${a}]`)):reject(t,"a list"),readList=(e,t,r,a)=>parseList(e[t],`${r}.${t}`,a),parseText=(e,t)=>"string"==typeof e?e:reject(t,"a string"),readStrings=(e,t,r)=>readList(e,t,r,parseText),readTicketStatus=oneOf(["Open","InProgress","WaitingOnCustomer","Resolved","Closed","Cancelled"]),readPriority=oneOf(["Low","Normal","High","Urgent"]),readSatisfaction=oneOf(["Satisfied","Unsatisfied"]),readAuthorKind=oneOf(["Customer","Agent","System","Assistant"]),readAttachmentKind=oneOf(["Screenshot","File"]),parseCategory=(e,t)=>{const r=readObject(e,t);return{name:readString(r,"name",t),queue:readString(r,"queue",t)}},parseSupportContactInfo=(e,t="SupportContactInfo")=>{const r=readObject(e,t);return{productName:readString(r,"productName",t),supportEmail:readString(r,"supportEmail",t),supportName:readString(r,"supportName",t),supportPhone:readNullable(r,"supportPhone",t,readString),supportHours:readNullable(r,"supportHours",t,readString),categories:readList(r,"categories",t,parseCategory),maxAttachmentBytes:readNumber(r,"maxAttachmentBytes",t),maxAttachmentsPerMessage:readNumber(r,"maxAttachmentsPerMessage",t),allowedContentTypes:readStrings(r,"allowedContentTypes",t),subjectMaxLength:readNumber(r,"subjectMaxLength",t),bodyMaxLength:readNumber(r,"bodyMaxLength",t),satisfactionCommentMaxLength:readNumber(r,"satisfactionCommentMaxLength",t)}},parseSupportTicketSummary=(e,t="SupportTicketSummary")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),category:readString(r,"category",t),subject:readString(r,"subject",t),status:readTicketStatus(r,"status",t),statusLabel:readString(r,"statusLabel",t),messageCount:readNumber(r,"messageCount",t),awaitingCustomer:readBoolean(r,"awaitingCustomer",t),queue:readString(r,"queue",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t)}},parseSupportAttachmentView=(e,t="SupportAttachmentView")=>{const r=readObject(e,t);return{id:readString(r,"id",t),fileName:readString(r,"fileName",t),contentType:readString(r,"contentType",t),sizeBytes:readNumber(r,"sizeBytes",t),kind:readAttachmentKind(r,"kind",t)}},parseSupportMessageView=(e,t="SupportMessageView")=>{const r=readObject(e,t);return{id:readString(r,"id",t),authorKind:readAuthorKind(r,"authorKind",t),authorName:readNullable(r,"authorName",t,readString),body:readString(r,"body",t),isInternal:readBoolean(r,"isInternal",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),attachments:readList(r,"attachments",t,parseSupportAttachmentView)}},parseSupportTicketLink=(e,t="SupportTicketLink")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),subject:readString(r,"subject",t)}},parseSupportTicketDetail=(e,t="SupportTicketDetail")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),queue:readString(r,"queue",t),accountId:readNullable(r,"accountId",t,readNumber),realm:readNullable(r,"realm",t,readString),category:readString(r,"category",t),subject:readString(r,"subject",t),status:readTicketStatus(r,"status",t),statusLabel:readString(r,"statusLabel",t),priority:readNullable(r,"priority",t,readPriority),reporterName:readString(r,"reporterName",t),reporterPlace:readOptional(r,"reporterPlace",t,readString),reporterEmail:readString(r,"reporterEmail",t),assignedAgentUserId:readNullable(r,"assignedAgentUserId",t,readNumber),assignedAgentName:readNullable(r,"assignedAgentName",t,readString),isOverdue:readBoolean(r,"isOverdue",t),pageUrl:readNullable(r,"pageUrl",t,readString),userAgent:readNullable(r,"userAgent",t,readString),appVersion:readNullable(r,"appVersion",t,readString),satisfaction:readNullable(r,"satisfaction",t,readSatisfaction),satisfactionComment:readNullable(r,"satisfactionComment",t,readString),canReopen:readBoolean(r,"canReopen",t),canRate:readBoolean(r,"canRate",t),canCancel:readBoolean(r,"canCancel",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t),resolvedDateTimeUtc:readNullable(r,"resolvedDateTimeUtc",t,readString),closedDateTimeUtc:readNullable(r,"closedDateTimeUtc",t,readString),messages:readList(r,"messages",t,parseSupportMessageView),version:readString(r,"version",t),mergedInto:readOptional(r,"mergedInto",t,nested(parseSupportTicketLink)),mergedTickets:readOptional(r,"mergedTickets",t,(e,t,r)=>readList(e,t,r,parseSupportTicketLink))}},parseSupportPage=(e,t)=>(r,a=t)=>{const s=readObject(r,a);return{items:readList(s,"items",a,e),page:readNumber(s,"page",a),pageSize:readNumber(s,"pageSize",a),totalCount:readNumber(s,"totalCount",a),totalPages:readNumber(s,"totalPages",a)}},parseSupportTicketPage=parseSupportPage(parseSupportTicketSummary,"SupportPage<SupportTicketSummary>"),parseSupportTicketCounts=(e,t="SupportTicketCounts")=>{const r=readObject(e,t);return{open:readNumber(r,"open",t),needsReply:readNumber(r,"needsReply",t),resolved:readNumber(r,"resolved",t),withdrawn:readNumber(r,"withdrawn",t),total:readNumber(r,"total",t),oldestAwaitingAgentDateTimeUtc:readNullable(r,"oldestAwaitingAgentDateTimeUtc",t,readString)}},parseSupportSuggestedArticle=(e,t="SupportSuggestedArticle")=>{const r=readObject(e,t);return{title:readString(r,"title",t),summary:readString(r,"summary",t)}},parseSupportSuggestedArticles=(e,t="SupportSuggestedArticle[]")=>parseList(e,t,parseSupportSuggestedArticle),parseHelpCentreSettings=(e,t="HelpCentreSettings")=>{const r=readObject(e,t);return{publicUrl:readString(r,"publicUrl",t),searchAvailable:readBoolean(r,"searchAvailable",t)}},parseHelpArticleSummary=(e,t="HelpArticleSummary")=>{const r=readObject(e,t);return{id:readString(r,"id",t),slug:readString(r,"slug",t),title:readString(r,"title",t),summary:readString(r,"summary",t),publishedDateTimeUtc:readNullable(r,"publishedDateTimeUtc",t,readString),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t)}},parseHelpArticlePage=parseSupportPage(parseHelpArticleSummary,"SupportPage<HelpArticleSummary>"),parseHelpArticleView=(e,t="HelpArticleView")=>{const r=readObject(e,t);return{...parseHelpArticleSummary(r,t),bodyMarkdown:readString(r,"bodyMarkdown",t)}},parseHelpArticleSummaries=(e,t="HelpArticleSummary[]")=>parseList(e,t,parseHelpArticleSummary),parseArrayBuffer=(e,t="ArrayBuffer")=>e instanceof ArrayBuffer?e:reject(t,"the attachment bytes"),OFFLINE_MESSAGE=exports.OFFLINE_MESSAGE="You are offline. Check your connection and try again.",GENERIC_MESSAGE=exports.GENERIC_MESSAGE="Something went wrong. Try again in a moment.";class SupportApiError extends Error{constructor(e,t,r){super(t),this.name="SupportApiError",this.code=e,this.status=r}}exports.SupportApiError=SupportApiError;const toSupportApiError=e=>{if(e instanceof SupportApiError)return e;const t="object"==typeof e&&null!==e?e:{};if("RequestOfflineError"===t.name)return new SupportApiError("offline",OFFLINE_MESSAGE,null);const r="number"==typeof t.response?.status?t.response.status:null,a=t.response?.data,s="object"==typeof a&&null!==a?a:void 0,i="string"==typeof s?.code?s.code:"unknown";return s&&"string"==typeof s.detail&&s.detail.trim()?new SupportApiError(i,s.detail,r):t.response?new SupportApiError(i,GENERIC_MESSAGE,r):new SupportApiError("network",OFFLINE_MESSAGE,null)};exports.toSupportApiError=toSupportApiError;const UPLOAD_TIMEOUT_MS=3e5,textFields=(e,t)=>void 0!==t&&""!==t?[{name:e,value:t}]:[],fileFields=(e,t)=>(t??[]).map(t=>({name:e,file:{uri:t.uri,name:t.name,type:t.type}})),multipartRequest=(e,t)=>({method:"POST",url:e,headers:{"Content-Type":"multipart/form-data","Idempotency-Key":(0,_mobileCore.newIdempotencyKey)()},body:{kind:"multipart",fields:t},timeoutMs:3e5}),supportRepliesUrl=(e,t)=>`${e}/tickets/${encodeURIComponent(t)}/replies`;exports.supportRepliesUrl=supportRepliesUrl;const queryString=e=>{const t=[],add=(e,r)=>{void 0!==r&&""!==r&&t.push(`${e}=${encodeURIComponent(String(r))}`)};return add("status",e.status),add("search",e.search?.trim()),add("queue",e.queue?.trim()),add("page",e.page),add("pageSize",e.pageSize),t.length>0?`?${t.join("&")}`:""},createSupportClient=(e,t="/api/support",r)=>{const a=t.replace(/\/+$/,""),ticketUrl=e=>`${a}/tickets/${encodeURIComponent(e)}`,call=async(e,t,r)=>{let a;try{a=(await t()).data}catch(e){throw toSupportApiError(e)}try{return r(a)}catch(t){throw new Error(`${e}: ${t instanceof Error?t.message:String(t)}`,{cause:t})}},getBytes=t=>call("GET /attachments/{id}",()=>e.get(`${a}/attachments/${encodeURIComponent(t)}`,{responseType:"arraybuffer"}),parseArrayBuffer),s=r?.replace(/\/+$/,"");return{basePath:a,helpCentre:void 0===s?void 0:{settings:t=>call("GET help /settings",()=>e.get(`${s}/settings`,{signal:t?.signal}),parseHelpCentreSettings),list:(t={},r)=>call("GET help /articles",()=>e.get(`${s}/articles${queryString(t)}`,{signal:r?.signal}),parseHelpArticlePage),get:(t,r)=>call("GET help /articles/{slug}",()=>e.get(`${s}/articles/${encodeURIComponent(t)}`,{signal:r?.signal}),parseHelpArticleView),search:(t,r)=>call("GET help /search",()=>e.get(`${s}/search?q=${encodeURIComponent(t)}`,{signal:r?.signal}),parseHelpArticleSummaries)},getConfig:()=>call("GET /settings",()=>e.get(`${a}/settings`),parseSupportContactInfo),listTickets:(t={})=>call("GET /tickets",()=>e.get(`${a}/tickets${queryString(t)}`),parseSupportTicketPage),getTicketCounts:()=>call("GET /tickets/counts",()=>e.get(`${a}/tickets/counts`),parseSupportTicketCounts),getTicket:t=>call("GET /tickets/{id}",()=>e.get(ticketUrl(t)),parseSupportTicketDetail),ticketRequest:e=>multipartRequest(`${a}/tickets`,[{name:"category",value:e.category},{name:"subject",value:e.subject},{name:"body",value:e.body},...textFields("queue",e.queue),...textFields("pageUrl",e.pageUrl),...textFields("userAgent",e.userAgent),...textFields("appVersion",e.appVersion),...fileFields("files",e.files),...fileFields("screenshots",e.screenshots)]),getSuggestions:t=>call("GET /suggestions",()=>e.get(`${a}/suggestions?subject=${encodeURIComponent(t)}`),parseSupportSuggestedArticles),replyRequest:(e,t)=>multipartRequest(supportRepliesUrl(a,e),[{name:"body",value:t.body},...fileFields("files",t.files),...fileFields("screenshots",t.screenshots)]),reopen:t=>call("POST /tickets/{id}/reopen",()=>e.post(`${ticketUrl(t)}/reopen`),parseSupportTicketDetail),cancel:t=>call("POST /tickets/{id}/cancel",()=>e.post(`${ticketUrl(t)}/cancel`),parseSupportTicketDetail),rate:(t,r)=>call("POST /tickets/{id}/rating",()=>e.post(`${ticketUrl(t)}/rating`,{satisfaction:r.satisfaction,comment:r.comment?.trim()?r.comment.trim():null}),parseSupportTicketDetail),getAttachmentBytes:getBytes,getAttachmentDataUri:async e=>{const t=await getBytes(e.id);return`data:${e.contentType};base64,${(0,_mobileCore.encodeBase64)(t)}`}}};exports.createSupportClient=createSupportClient;
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.toSupportApiError=exports.supportRepliesUrl=exports.createSupportClient=exports.SupportApiError=exports.OFFLINE_MESSAGE=exports.GENERIC_MESSAGE=void 0;var _mobileCore=require("@webority/mobile-core");const isJsonObject=e=>"object"==typeof e&&null!==e&&!Array.isArray(e),reject=(e,t)=>{throw new Error(`${e} must be ${t}`)},readObject=(e,t)=>isJsonObject(e)?e:reject(t,"an object"),readString=(e,t,r)=>{const a=e[t];return"string"==typeof a?a:reject(`${r}.${t}`,"a string")},readNumber=(e,t,r)=>{const a=e[t];return"number"==typeof a&&Number.isFinite(a)?a:reject(`${r}.${t}`,"a number")},readBoolean=(e,t,r)=>{const a=e[t];return"boolean"==typeof a?a:reject(`${r}.${t}`,"true or false")},readNullable=(e,t,r,a)=>null===e[t]?null:a(e,t,r),readOptional=(e,t,r,a)=>void 0===e[t]?void 0:a(e,t,r),oneOf=e=>(t,r,a)=>{const s=readString(t,r,a);return e.find(e=>e===s)??reject(`${a}.${r}`,`one of ${e.join(", ")}`)},nested=e=>(t,r,a)=>e(t[r],`${a}.${r}`),parseList=(e,t,r)=>Array.isArray(e)?e.map((e,a)=>r(e,`${t}[${a}]`)):reject(t,"a list"),readList=(e,t,r,a)=>parseList(e[t],`${r}.${t}`,a),parseText=(e,t)=>"string"==typeof e?e:reject(t,"a string"),readStrings=(e,t,r)=>readList(e,t,r,parseText),readTicketStatus=oneOf(["Open","InProgress","WaitingOnCustomer","Resolved","Closed","Cancelled"]),readPriority=oneOf(["Low","Normal","High","Urgent"]),readSatisfaction=oneOf(["Satisfied","Unsatisfied"]),readAuthorKind=oneOf(["Customer","Agent","System","Assistant"]),readAttachmentKind=oneOf(["Screenshot","File"]),parseCategory=(e,t)=>{const r=readObject(e,t);return{name:readString(r,"name",t),queue:readString(r,"queue",t)}},parseSupportContactInfo=(e,t="SupportContactInfo")=>{const r=readObject(e,t);return{productName:readString(r,"productName",t),supportEmail:readString(r,"supportEmail",t),supportName:readString(r,"supportName",t),supportPhone:readNullable(r,"supportPhone",t,readString),supportHours:readNullable(r,"supportHours",t,readString),categories:readList(r,"categories",t,parseCategory),maxAttachmentBytes:readNumber(r,"maxAttachmentBytes",t),maxAttachmentsPerMessage:readNumber(r,"maxAttachmentsPerMessage",t),allowedContentTypes:readStrings(r,"allowedContentTypes",t),subjectMaxLength:readNumber(r,"subjectMaxLength",t),bodyMaxLength:readNumber(r,"bodyMaxLength",t),satisfactionCommentMaxLength:readNumber(r,"satisfactionCommentMaxLength",t)}},parseSupportTicketSummary=(e,t="SupportTicketSummary")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),category:readString(r,"category",t),subject:readString(r,"subject",t),status:readTicketStatus(r,"status",t),statusLabel:readString(r,"statusLabel",t),messageCount:readNumber(r,"messageCount",t),awaitingCustomer:readBoolean(r,"awaitingCustomer",t),queue:readString(r,"queue",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t)}},parseSupportAttachmentView=(e,t="SupportAttachmentView")=>{const r=readObject(e,t);return{id:readString(r,"id",t),fileName:readString(r,"fileName",t),contentType:readString(r,"contentType",t),sizeBytes:readNumber(r,"sizeBytes",t),kind:readAttachmentKind(r,"kind",t)}},parseSupportMessageView=(e,t="SupportMessageView")=>{const r=readObject(e,t);return{id:readString(r,"id",t),authorKind:readAuthorKind(r,"authorKind",t),authorName:readNullable(r,"authorName",t,readString),body:readString(r,"body",t),isInternal:readBoolean(r,"isInternal",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),attachments:readList(r,"attachments",t,parseSupportAttachmentView)}},parseSupportTicketLink=(e,t="SupportTicketLink")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),subject:readString(r,"subject",t)}},parseSupportTicketDetail=(e,t="SupportTicketDetail")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),queue:readString(r,"queue",t),accountId:readNullable(r,"accountId",t,readNumber),realm:readNullable(r,"realm",t,readString),category:readString(r,"category",t),subject:readString(r,"subject",t),status:readTicketStatus(r,"status",t),statusLabel:readString(r,"statusLabel",t),priority:readNullable(r,"priority",t,readPriority),reporterName:readString(r,"reporterName",t),reporterPlace:readOptional(r,"reporterPlace",t,readString),reporterEmail:readString(r,"reporterEmail",t),assignedAgentUserId:readNullable(r,"assignedAgentUserId",t,readNumber),assignedAgentName:readNullable(r,"assignedAgentName",t,readString),isOverdue:readBoolean(r,"isOverdue",t),pageUrl:readNullable(r,"pageUrl",t,readString),userAgent:readNullable(r,"userAgent",t,readString),appVersion:readNullable(r,"appVersion",t,readString),satisfaction:readNullable(r,"satisfaction",t,readSatisfaction),satisfactionComment:readNullable(r,"satisfactionComment",t,readString),canReopen:readBoolean(r,"canReopen",t),canRate:readBoolean(r,"canRate",t),canCancel:readBoolean(r,"canCancel",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t),resolvedDateTimeUtc:readNullable(r,"resolvedDateTimeUtc",t,readString),closedDateTimeUtc:readNullable(r,"closedDateTimeUtc",t,readString),messages:readList(r,"messages",t,parseSupportMessageView),version:readString(r,"version",t),mergedInto:readOptional(r,"mergedInto",t,nested(parseSupportTicketLink)),mergedTickets:readOptional(r,"mergedTickets",t,(e,t,r)=>readList(e,t,r,parseSupportTicketLink))}},parseSupportPage=(e,t)=>(r,a=t)=>{const s=readObject(r,a);return{items:readList(s,"items",a,e),page:readNumber(s,"page",a),pageSize:readNumber(s,"pageSize",a),totalCount:readNumber(s,"totalCount",a),totalPages:readNumber(s,"totalPages",a)}},parseSupportTicketPage=parseSupportPage(parseSupportTicketSummary,"SupportPage<SupportTicketSummary>"),parseSupportTicketCounts=(e,t="SupportTicketCounts")=>{const r=readObject(e,t);return{open:readNumber(r,"open",t),needsReply:readNumber(r,"needsReply",t),resolved:readNumber(r,"resolved",t),withdrawn:readNumber(r,"withdrawn",t),total:readNumber(r,"total",t),oldestAwaitingAgentDateTimeUtc:readNullable(r,"oldestAwaitingAgentDateTimeUtc",t,readString)}},parseSupportSuggestedArticle=(e,t="SupportSuggestedArticle")=>{const r=readObject(e,t);return{title:readString(r,"title",t),summary:readString(r,"summary",t)}},parseSupportSuggestedArticles=(e,t="SupportSuggestedArticle[]")=>parseList(e,t,parseSupportSuggestedArticle),parseHelpCentreSettings=(e,t="HelpCentreSettings")=>{const r=readObject(e,t);return{publicUrl:readString(r,"publicUrl",t),searchAvailable:readBoolean(r,"searchAvailable",t)}},parseHelpArticleSummary=(e,t="HelpArticleSummary")=>{const r=readObject(e,t);return{id:readString(r,"id",t),slug:readString(r,"slug",t),title:readString(r,"title",t),summary:readString(r,"summary",t),publishedDateTimeUtc:readNullable(r,"publishedDateTimeUtc",t,readString),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t)}},parseHelpArticlePage=parseSupportPage(parseHelpArticleSummary,"SupportPage<HelpArticleSummary>"),parseHelpArticleView=(e,t="HelpArticleView")=>{const r=readObject(e,t);return{...parseHelpArticleSummary(r,t),bodyMarkdown:readString(r,"bodyMarkdown",t)}},parseHelpArticleSummaries=(e,t="HelpArticleSummary[]")=>parseList(e,t,parseHelpArticleSummary),parseArrayBuffer=(e,t="ArrayBuffer")=>e instanceof ArrayBuffer?e:reject(t,"the attachment bytes"),OFFLINE_MESSAGE=exports.OFFLINE_MESSAGE="You are offline. Check your connection and try again.",GENERIC_MESSAGE=exports.GENERIC_MESSAGE="Something went wrong. Try again in a moment.";class SupportApiError extends Error{constructor(e,t,r){super(t),this.name="SupportApiError",this.code=e,this.status=r}}exports.SupportApiError=SupportApiError;const toSupportApiError=e=>{if(e instanceof SupportApiError)return e;const t="object"==typeof e&&null!==e?e:{};if("RequestOfflineError"===t.name)return new SupportApiError("offline",OFFLINE_MESSAGE,null);const r="number"==typeof t.response?.status?t.response.status:null,a=t.response?.data,s="object"==typeof a&&null!==a?a:void 0,i="string"==typeof s?.code?s.code:"unknown";return s&&"string"==typeof s.detail&&s.detail.trim()?new SupportApiError(i,s.detail,r):t.response?new SupportApiError(i,GENERIC_MESSAGE,r):new SupportApiError("network",OFFLINE_MESSAGE,null)};exports.toSupportApiError=toSupportApiError;const UPLOAD_TIMEOUT_MS=3e5,textFields=(e,t)=>void 0!==t&&""!==t?[{name:e,value:t}]:[],fileFields=(e,t)=>(t??[]).map(t=>({name:e,file:{uri:t.uri,name:t.name,type:t.type}})),uploadIdFields=e=>(e??[]).map(e=>({name:"uploadIds",value:e})),multipartRequest=(e,t)=>({method:"POST",url:e,headers:{"Content-Type":"multipart/form-data","Idempotency-Key":(0,_mobileCore.newIdempotencyKey)()},body:{kind:"multipart",fields:t},timeoutMs:3e5}),supportRepliesUrl=(e,t)=>`${e}/tickets/${encodeURIComponent(t)}/replies`;exports.supportRepliesUrl=supportRepliesUrl;const queryString=e=>{const t=[],add=(e,r)=>{void 0!==r&&""!==r&&t.push(`${e}=${encodeURIComponent(String(r))}`)};return add("status",e.status),add("search",e.search?.trim()),add("queue",e.queue?.trim()),add("page",e.page),add("pageSize",e.pageSize),t.length>0?`?${t.join("&")}`:""},createSupportClient=(e,t="/api/support",r)=>{const a=t.replace(/\/+$/,""),ticketUrl=e=>`${a}/tickets/${encodeURIComponent(e)}`,call=async(e,t,r)=>{let a;try{a=(await t()).data}catch(e){throw toSupportApiError(e)}try{return r(a)}catch(t){throw new Error(`${e}: ${t instanceof Error?t.message:String(t)}`,{cause:t})}},getBytes=t=>call("GET /attachments/{id}",()=>e.get(`${a}/attachments/${encodeURIComponent(t)}`,{responseType:"arraybuffer"}),parseArrayBuffer),s=r?.replace(/\/+$/,"");return{basePath:a,helpCentre:void 0===s?void 0:{settings:t=>call("GET help /settings",()=>e.get(`${s}/settings`,{signal:t?.signal}),parseHelpCentreSettings),list:(t={},r)=>call("GET help /articles",()=>e.get(`${s}/articles${queryString(t)}`,{signal:r?.signal}),parseHelpArticlePage),get:(t,r)=>call("GET help /articles/{slug}",()=>e.get(`${s}/articles/${encodeURIComponent(t)}`,{signal:r?.signal}),parseHelpArticleView),search:(t,r)=>call("GET help /search",()=>e.get(`${s}/search?q=${encodeURIComponent(t)}`,{signal:r?.signal}),parseHelpArticleSummaries)},getConfig:()=>call("GET /settings",()=>e.get(`${a}/settings`),parseSupportContactInfo),listTickets:(t={})=>call("GET /tickets",()=>e.get(`${a}/tickets${queryString(t)}`),parseSupportTicketPage),getTicketCounts:()=>call("GET /tickets/counts",()=>e.get(`${a}/tickets/counts`),parseSupportTicketCounts),getTicket:t=>call("GET /tickets/{id}",()=>e.get(ticketUrl(t)),parseSupportTicketDetail),ticketRequest:e=>multipartRequest(`${a}/tickets`,[{name:"category",value:e.category},{name:"subject",value:e.subject},{name:"body",value:e.body},...textFields("queue",e.queue),...textFields("pageUrl",e.pageUrl),...textFields("userAgent",e.userAgent),...textFields("appVersion",e.appVersion),...fileFields("files",e.files),...fileFields("screenshots",e.screenshots),...uploadIdFields(e.uploadIds)]),getSuggestions:t=>call("GET /suggestions",()=>e.get(`${a}/suggestions?subject=${encodeURIComponent(t)}`),parseSupportSuggestedArticles),replyRequest:(e,t)=>multipartRequest(supportRepliesUrl(a,e),[{name:"body",value:t.body},...fileFields("files",t.files),...fileFields("screenshots",t.screenshots),...uploadIdFields(t.uploadIds)]),uploadRequest:(e,t)=>{const r=(0,_mobileCore.newIdempotencyKey)();return{uploadId:r,request:{method:"POST",url:`${a}/uploads`,headers:{"Idempotency-Key":r},body:{kind:"resumable",file:e,metadata:{filename:e.name,filetype:e.type,kind:t}},timeoutMs:3e5}}},reopen:t=>call("POST /tickets/{id}/reopen",()=>e.post(`${ticketUrl(t)}/reopen`),parseSupportTicketDetail),cancel:t=>call("POST /tickets/{id}/cancel",()=>e.post(`${ticketUrl(t)}/cancel`),parseSupportTicketDetail),rate:(t,r)=>call("POST /tickets/{id}/rating",()=>e.post(`${ticketUrl(t)}/rating`,{satisfaction:r.satisfaction,comment:r.comment?.trim()?r.comment.trim():null}),parseSupportTicketDetail),getAttachmentBytes:getBytes,getAttachmentDataUri:async e=>{const t=await getBytes(e.id);return`data:${e.contentType};base64,${(0,_mobileCore.encodeBase64)(t)}`}}};exports.createSupportClient=createSupportClient;
|
package/lib/module/client.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";import{encodeBase64,newIdempotencyKey}from"@webority/mobile-core";const isJsonObject=e=>"object"==typeof e&&null!==e&&!Array.isArray(e),reject=(e,t)=>{throw new Error(`${e} must be ${t}`)},readObject=(e,t)=>isJsonObject(e)?e:reject(t,"an object"),readString=(e,t,r)=>{const a=e[t];return"string"==typeof a?a:reject(`${r}.${t}`,"a string")},readNumber=(e,t,r)=>{const a=e[t];return"number"==typeof a&&Number.isFinite(a)?a:reject(`${r}.${t}`,"a number")},readBoolean=(e,t,r)=>{const a=e[t];return"boolean"==typeof a?a:reject(`${r}.${t}`,"true or false")},readNullable=(e,t,r,a)=>null===e[t]?null:a(e,t,r),readOptional=(e,t,r,a)=>void 0===e[t]?void 0:a(e,t,r),oneOf=e=>(t,r,a)=>{const n=readString(t,r,a);return e.find(e=>e===n)??reject(`${a}.${r}`,`one of ${e.join(", ")}`)},nested=e=>(t,r,a)=>e(t[r],`${a}.${r}`),parseList=(e,t,r)=>Array.isArray(e)?e.map((e,a)=>r(e,`${t}[${a}]`)):reject(t,"a list"),readList=(e,t,r,a)=>parseList(e[t],`${r}.${t}`,a),parseText=(e,t)=>"string"==typeof e?e:reject(t,"a string"),readStrings=(e,t,r)=>readList(e,t,r,parseText),readTicketStatus=oneOf(["Open","InProgress","WaitingOnCustomer","Resolved","Closed","Cancelled"]),readPriority=oneOf(["Low","Normal","High","Urgent"]),readSatisfaction=oneOf(["Satisfied","Unsatisfied"]),readAuthorKind=oneOf(["Customer","Agent","System","Assistant"]),readAttachmentKind=oneOf(["Screenshot","File"]),parseCategory=(e,t)=>{const r=readObject(e,t);return{name:readString(r,"name",t),queue:readString(r,"queue",t)}},parseSupportContactInfo=(e,t="SupportContactInfo")=>{const r=readObject(e,t);return{productName:readString(r,"productName",t),supportEmail:readString(r,"supportEmail",t),supportName:readString(r,"supportName",t),supportPhone:readNullable(r,"supportPhone",t,readString),supportHours:readNullable(r,"supportHours",t,readString),categories:readList(r,"categories",t,parseCategory),maxAttachmentBytes:readNumber(r,"maxAttachmentBytes",t),maxAttachmentsPerMessage:readNumber(r,"maxAttachmentsPerMessage",t),allowedContentTypes:readStrings(r,"allowedContentTypes",t),subjectMaxLength:readNumber(r,"subjectMaxLength",t),bodyMaxLength:readNumber(r,"bodyMaxLength",t),satisfactionCommentMaxLength:readNumber(r,"satisfactionCommentMaxLength",t)}},parseSupportTicketSummary=(e,t="SupportTicketSummary")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),category:readString(r,"category",t),subject:readString(r,"subject",t),status:readTicketStatus(r,"status",t),statusLabel:readString(r,"statusLabel",t),messageCount:readNumber(r,"messageCount",t),awaitingCustomer:readBoolean(r,"awaitingCustomer",t),queue:readString(r,"queue",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t)}},parseSupportAttachmentView=(e,t="SupportAttachmentView")=>{const r=readObject(e,t);return{id:readString(r,"id",t),fileName:readString(r,"fileName",t),contentType:readString(r,"contentType",t),sizeBytes:readNumber(r,"sizeBytes",t),kind:readAttachmentKind(r,"kind",t)}},parseSupportMessageView=(e,t="SupportMessageView")=>{const r=readObject(e,t);return{id:readString(r,"id",t),authorKind:readAuthorKind(r,"authorKind",t),authorName:readNullable(r,"authorName",t,readString),body:readString(r,"body",t),isInternal:readBoolean(r,"isInternal",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),attachments:readList(r,"attachments",t,parseSupportAttachmentView)}},parseSupportTicketLink=(e,t="SupportTicketLink")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),subject:readString(r,"subject",t)}},parseSupportTicketDetail=(e,t="SupportTicketDetail")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),queue:readString(r,"queue",t),accountId:readNullable(r,"accountId",t,readNumber),realm:readNullable(r,"realm",t,readString),category:readString(r,"category",t),subject:readString(r,"subject",t),status:readTicketStatus(r,"status",t),statusLabel:readString(r,"statusLabel",t),priority:readNullable(r,"priority",t,readPriority),reporterName:readString(r,"reporterName",t),reporterPlace:readOptional(r,"reporterPlace",t,readString),reporterEmail:readString(r,"reporterEmail",t),assignedAgentUserId:readNullable(r,"assignedAgentUserId",t,readNumber),assignedAgentName:readNullable(r,"assignedAgentName",t,readString),isOverdue:readBoolean(r,"isOverdue",t),pageUrl:readNullable(r,"pageUrl",t,readString),userAgent:readNullable(r,"userAgent",t,readString),appVersion:readNullable(r,"appVersion",t,readString),satisfaction:readNullable(r,"satisfaction",t,readSatisfaction),satisfactionComment:readNullable(r,"satisfactionComment",t,readString),canReopen:readBoolean(r,"canReopen",t),canRate:readBoolean(r,"canRate",t),canCancel:readBoolean(r,"canCancel",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t),resolvedDateTimeUtc:readNullable(r,"resolvedDateTimeUtc",t,readString),closedDateTimeUtc:readNullable(r,"closedDateTimeUtc",t,readString),messages:readList(r,"messages",t,parseSupportMessageView),version:readString(r,"version",t),mergedInto:readOptional(r,"mergedInto",t,nested(parseSupportTicketLink)),mergedTickets:readOptional(r,"mergedTickets",t,(e,t,r)=>readList(e,t,r,parseSupportTicketLink))}},parseSupportPage=(e,t)=>(r,a=t)=>{const n=readObject(r,a);return{items:readList(n,"items",a,e),page:readNumber(n,"page",a),pageSize:readNumber(n,"pageSize",a),totalCount:readNumber(n,"totalCount",a),totalPages:readNumber(n,"totalPages",a)}},parseSupportTicketPage=parseSupportPage(parseSupportTicketSummary,"SupportPage<SupportTicketSummary>"),parseSupportTicketCounts=(e,t="SupportTicketCounts")=>{const r=readObject(e,t);return{open:readNumber(r,"open",t),needsReply:readNumber(r,"needsReply",t),resolved:readNumber(r,"resolved",t),withdrawn:readNumber(r,"withdrawn",t),total:readNumber(r,"total",t),oldestAwaitingAgentDateTimeUtc:readNullable(r,"oldestAwaitingAgentDateTimeUtc",t,readString)}},parseSupportSuggestedArticle=(e,t="SupportSuggestedArticle")=>{const r=readObject(e,t);return{title:readString(r,"title",t),summary:readString(r,"summary",t)}},parseSupportSuggestedArticles=(e,t="SupportSuggestedArticle[]")=>parseList(e,t,parseSupportSuggestedArticle),parseHelpCentreSettings=(e,t="HelpCentreSettings")=>{const r=readObject(e,t);return{publicUrl:readString(r,"publicUrl",t),searchAvailable:readBoolean(r,"searchAvailable",t)}},parseHelpArticleSummary=(e,t="HelpArticleSummary")=>{const r=readObject(e,t);return{id:readString(r,"id",t),slug:readString(r,"slug",t),title:readString(r,"title",t),summary:readString(r,"summary",t),publishedDateTimeUtc:readNullable(r,"publishedDateTimeUtc",t,readString),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t)}},parseHelpArticlePage=parseSupportPage(parseHelpArticleSummary,"SupportPage<HelpArticleSummary>"),parseHelpArticleView=(e,t="HelpArticleView")=>{const r=readObject(e,t);return{...parseHelpArticleSummary(r,t),bodyMarkdown:readString(r,"bodyMarkdown",t)}},parseHelpArticleSummaries=(e,t="HelpArticleSummary[]")=>parseList(e,t,parseHelpArticleSummary),parseArrayBuffer=(e,t="ArrayBuffer")=>e instanceof ArrayBuffer?e:reject(t,"the attachment bytes");export const OFFLINE_MESSAGE="You are offline. Check your connection and try again.";export const GENERIC_MESSAGE="Something went wrong. Try again in a moment.";export class SupportApiError extends Error{constructor(e,t,r){super(t),this.name="SupportApiError",this.code=e,this.status=r}}export const toSupportApiError=e=>{if(e instanceof SupportApiError)return e;const t="object"==typeof e&&null!==e?e:{};if("RequestOfflineError"===t.name)return new SupportApiError("offline",OFFLINE_MESSAGE,null);const r="number"==typeof t.response?.status?t.response.status:null,a=t.response?.data,n="object"==typeof a&&null!==a?a:void 0,s="string"==typeof n?.code?n.code:"unknown";return n&&"string"==typeof n.detail&&n.detail.trim()?new SupportApiError(s,n.detail,r):t.response?new SupportApiError(s,GENERIC_MESSAGE,r):new SupportApiError("network",OFFLINE_MESSAGE,null)};const UPLOAD_TIMEOUT_MS=3e5,textFields=(e,t)=>void 0!==t&&""!==t?[{name:e,value:t}]:[],fileFields=(e,t)=>(t??[]).map(t=>({name:e,file:{uri:t.uri,name:t.name,type:t.type}})),multipartRequest=(e,t)=>({method:"POST",url:e,headers:{"Content-Type":"multipart/form-data","Idempotency-Key":newIdempotencyKey()},body:{kind:"multipart",fields:t},timeoutMs:3e5});export const supportRepliesUrl=(e,t)=>`${e}/tickets/${encodeURIComponent(t)}/replies`;const queryString=e=>{const t=[],add=(e,r)=>{void 0!==r&&""!==r&&t.push(`${e}=${encodeURIComponent(String(r))}`)};return add("status",e.status),add("search",e.search?.trim()),add("queue",e.queue?.trim()),add("page",e.page),add("pageSize",e.pageSize),t.length>0?`?${t.join("&")}`:""};export const createSupportClient=(e,t="/api/support",r)=>{const a=t.replace(/\/+$/,""),ticketUrl=e=>`${a}/tickets/${encodeURIComponent(e)}`,call=async(e,t,r)=>{let a;try{a=(await t()).data}catch(e){throw toSupportApiError(e)}try{return r(a)}catch(t){throw new Error(`${e}: ${t instanceof Error?t.message:String(t)}`,{cause:t})}},getBytes=t=>call("GET /attachments/{id}",()=>e.get(`${a}/attachments/${encodeURIComponent(t)}`,{responseType:"arraybuffer"}),parseArrayBuffer),n=r?.replace(/\/+$/,"");return{basePath:a,helpCentre:void 0===n?void 0:{settings:t=>call("GET help /settings",()=>e.get(`${n}/settings`,{signal:t?.signal}),parseHelpCentreSettings),list:(t={},r)=>call("GET help /articles",()=>e.get(`${n}/articles${queryString(t)}`,{signal:r?.signal}),parseHelpArticlePage),get:(t,r)=>call("GET help /articles/{slug}",()=>e.get(`${n}/articles/${encodeURIComponent(t)}`,{signal:r?.signal}),parseHelpArticleView),search:(t,r)=>call("GET help /search",()=>e.get(`${n}/search?q=${encodeURIComponent(t)}`,{signal:r?.signal}),parseHelpArticleSummaries)},getConfig:()=>call("GET /settings",()=>e.get(`${a}/settings`),parseSupportContactInfo),listTickets:(t={})=>call("GET /tickets",()=>e.get(`${a}/tickets${queryString(t)}`),parseSupportTicketPage),getTicketCounts:()=>call("GET /tickets/counts",()=>e.get(`${a}/tickets/counts`),parseSupportTicketCounts),getTicket:t=>call("GET /tickets/{id}",()=>e.get(ticketUrl(t)),parseSupportTicketDetail),ticketRequest:e=>multipartRequest(`${a}/tickets`,[{name:"category",value:e.category},{name:"subject",value:e.subject},{name:"body",value:e.body},...textFields("queue",e.queue),...textFields("pageUrl",e.pageUrl),...textFields("userAgent",e.userAgent),...textFields("appVersion",e.appVersion),...fileFields("files",e.files),...fileFields("screenshots",e.screenshots)]),getSuggestions:t=>call("GET /suggestions",()=>e.get(`${a}/suggestions?subject=${encodeURIComponent(t)}`),parseSupportSuggestedArticles),replyRequest:(e,t)=>multipartRequest(supportRepliesUrl(a,e),[{name:"body",value:t.body},...fileFields("files",t.files),...fileFields("screenshots",t.screenshots)]),reopen:t=>call("POST /tickets/{id}/reopen",()=>e.post(`${ticketUrl(t)}/reopen`),parseSupportTicketDetail),cancel:t=>call("POST /tickets/{id}/cancel",()=>e.post(`${ticketUrl(t)}/cancel`),parseSupportTicketDetail),rate:(t,r)=>call("POST /tickets/{id}/rating",()=>e.post(`${ticketUrl(t)}/rating`,{satisfaction:r.satisfaction,comment:r.comment?.trim()?r.comment.trim():null}),parseSupportTicketDetail),getAttachmentBytes:getBytes,getAttachmentDataUri:async e=>{const t=await getBytes(e.id);return`data:${e.contentType};base64,${encodeBase64(t)}`}}};
|
|
1
|
+
"use strict";import{encodeBase64,newIdempotencyKey}from"@webority/mobile-core";const isJsonObject=e=>"object"==typeof e&&null!==e&&!Array.isArray(e),reject=(e,t)=>{throw new Error(`${e} must be ${t}`)},readObject=(e,t)=>isJsonObject(e)?e:reject(t,"an object"),readString=(e,t,r)=>{const a=e[t];return"string"==typeof a?a:reject(`${r}.${t}`,"a string")},readNumber=(e,t,r)=>{const a=e[t];return"number"==typeof a&&Number.isFinite(a)?a:reject(`${r}.${t}`,"a number")},readBoolean=(e,t,r)=>{const a=e[t];return"boolean"==typeof a?a:reject(`${r}.${t}`,"true or false")},readNullable=(e,t,r,a)=>null===e[t]?null:a(e,t,r),readOptional=(e,t,r,a)=>void 0===e[t]?void 0:a(e,t,r),oneOf=e=>(t,r,a)=>{const n=readString(t,r,a);return e.find(e=>e===n)??reject(`${a}.${r}`,`one of ${e.join(", ")}`)},nested=e=>(t,r,a)=>e(t[r],`${a}.${r}`),parseList=(e,t,r)=>Array.isArray(e)?e.map((e,a)=>r(e,`${t}[${a}]`)):reject(t,"a list"),readList=(e,t,r,a)=>parseList(e[t],`${r}.${t}`,a),parseText=(e,t)=>"string"==typeof e?e:reject(t,"a string"),readStrings=(e,t,r)=>readList(e,t,r,parseText),readTicketStatus=oneOf(["Open","InProgress","WaitingOnCustomer","Resolved","Closed","Cancelled"]),readPriority=oneOf(["Low","Normal","High","Urgent"]),readSatisfaction=oneOf(["Satisfied","Unsatisfied"]),readAuthorKind=oneOf(["Customer","Agent","System","Assistant"]),readAttachmentKind=oneOf(["Screenshot","File"]),parseCategory=(e,t)=>{const r=readObject(e,t);return{name:readString(r,"name",t),queue:readString(r,"queue",t)}},parseSupportContactInfo=(e,t="SupportContactInfo")=>{const r=readObject(e,t);return{productName:readString(r,"productName",t),supportEmail:readString(r,"supportEmail",t),supportName:readString(r,"supportName",t),supportPhone:readNullable(r,"supportPhone",t,readString),supportHours:readNullable(r,"supportHours",t,readString),categories:readList(r,"categories",t,parseCategory),maxAttachmentBytes:readNumber(r,"maxAttachmentBytes",t),maxAttachmentsPerMessage:readNumber(r,"maxAttachmentsPerMessage",t),allowedContentTypes:readStrings(r,"allowedContentTypes",t),subjectMaxLength:readNumber(r,"subjectMaxLength",t),bodyMaxLength:readNumber(r,"bodyMaxLength",t),satisfactionCommentMaxLength:readNumber(r,"satisfactionCommentMaxLength",t)}},parseSupportTicketSummary=(e,t="SupportTicketSummary")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),category:readString(r,"category",t),subject:readString(r,"subject",t),status:readTicketStatus(r,"status",t),statusLabel:readString(r,"statusLabel",t),messageCount:readNumber(r,"messageCount",t),awaitingCustomer:readBoolean(r,"awaitingCustomer",t),queue:readString(r,"queue",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t)}},parseSupportAttachmentView=(e,t="SupportAttachmentView")=>{const r=readObject(e,t);return{id:readString(r,"id",t),fileName:readString(r,"fileName",t),contentType:readString(r,"contentType",t),sizeBytes:readNumber(r,"sizeBytes",t),kind:readAttachmentKind(r,"kind",t)}},parseSupportMessageView=(e,t="SupportMessageView")=>{const r=readObject(e,t);return{id:readString(r,"id",t),authorKind:readAuthorKind(r,"authorKind",t),authorName:readNullable(r,"authorName",t,readString),body:readString(r,"body",t),isInternal:readBoolean(r,"isInternal",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),attachments:readList(r,"attachments",t,parseSupportAttachmentView)}},parseSupportTicketLink=(e,t="SupportTicketLink")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),subject:readString(r,"subject",t)}},parseSupportTicketDetail=(e,t="SupportTicketDetail")=>{const r=readObject(e,t);return{id:readString(r,"id",t),number:readString(r,"number",t),queue:readString(r,"queue",t),accountId:readNullable(r,"accountId",t,readNumber),realm:readNullable(r,"realm",t,readString),category:readString(r,"category",t),subject:readString(r,"subject",t),status:readTicketStatus(r,"status",t),statusLabel:readString(r,"statusLabel",t),priority:readNullable(r,"priority",t,readPriority),reporterName:readString(r,"reporterName",t),reporterPlace:readOptional(r,"reporterPlace",t,readString),reporterEmail:readString(r,"reporterEmail",t),assignedAgentUserId:readNullable(r,"assignedAgentUserId",t,readNumber),assignedAgentName:readNullable(r,"assignedAgentName",t,readString),isOverdue:readBoolean(r,"isOverdue",t),pageUrl:readNullable(r,"pageUrl",t,readString),userAgent:readNullable(r,"userAgent",t,readString),appVersion:readNullable(r,"appVersion",t,readString),satisfaction:readNullable(r,"satisfaction",t,readSatisfaction),satisfactionComment:readNullable(r,"satisfactionComment",t,readString),canReopen:readBoolean(r,"canReopen",t),canRate:readBoolean(r,"canRate",t),canCancel:readBoolean(r,"canCancel",t),createdDateTimeUtc:readString(r,"createdDateTimeUtc",t),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t),resolvedDateTimeUtc:readNullable(r,"resolvedDateTimeUtc",t,readString),closedDateTimeUtc:readNullable(r,"closedDateTimeUtc",t,readString),messages:readList(r,"messages",t,parseSupportMessageView),version:readString(r,"version",t),mergedInto:readOptional(r,"mergedInto",t,nested(parseSupportTicketLink)),mergedTickets:readOptional(r,"mergedTickets",t,(e,t,r)=>readList(e,t,r,parseSupportTicketLink))}},parseSupportPage=(e,t)=>(r,a=t)=>{const n=readObject(r,a);return{items:readList(n,"items",a,e),page:readNumber(n,"page",a),pageSize:readNumber(n,"pageSize",a),totalCount:readNumber(n,"totalCount",a),totalPages:readNumber(n,"totalPages",a)}},parseSupportTicketPage=parseSupportPage(parseSupportTicketSummary,"SupportPage<SupportTicketSummary>"),parseSupportTicketCounts=(e,t="SupportTicketCounts")=>{const r=readObject(e,t);return{open:readNumber(r,"open",t),needsReply:readNumber(r,"needsReply",t),resolved:readNumber(r,"resolved",t),withdrawn:readNumber(r,"withdrawn",t),total:readNumber(r,"total",t),oldestAwaitingAgentDateTimeUtc:readNullable(r,"oldestAwaitingAgentDateTimeUtc",t,readString)}},parseSupportSuggestedArticle=(e,t="SupportSuggestedArticle")=>{const r=readObject(e,t);return{title:readString(r,"title",t),summary:readString(r,"summary",t)}},parseSupportSuggestedArticles=(e,t="SupportSuggestedArticle[]")=>parseList(e,t,parseSupportSuggestedArticle),parseHelpCentreSettings=(e,t="HelpCentreSettings")=>{const r=readObject(e,t);return{publicUrl:readString(r,"publicUrl",t),searchAvailable:readBoolean(r,"searchAvailable",t)}},parseHelpArticleSummary=(e,t="HelpArticleSummary")=>{const r=readObject(e,t);return{id:readString(r,"id",t),slug:readString(r,"slug",t),title:readString(r,"title",t),summary:readString(r,"summary",t),publishedDateTimeUtc:readNullable(r,"publishedDateTimeUtc",t,readString),updatedDateTimeUtc:readString(r,"updatedDateTimeUtc",t)}},parseHelpArticlePage=parseSupportPage(parseHelpArticleSummary,"SupportPage<HelpArticleSummary>"),parseHelpArticleView=(e,t="HelpArticleView")=>{const r=readObject(e,t);return{...parseHelpArticleSummary(r,t),bodyMarkdown:readString(r,"bodyMarkdown",t)}},parseHelpArticleSummaries=(e,t="HelpArticleSummary[]")=>parseList(e,t,parseHelpArticleSummary),parseArrayBuffer=(e,t="ArrayBuffer")=>e instanceof ArrayBuffer?e:reject(t,"the attachment bytes");export const OFFLINE_MESSAGE="You are offline. Check your connection and try again.";export const GENERIC_MESSAGE="Something went wrong. Try again in a moment.";export class SupportApiError extends Error{constructor(e,t,r){super(t),this.name="SupportApiError",this.code=e,this.status=r}}export const toSupportApiError=e=>{if(e instanceof SupportApiError)return e;const t="object"==typeof e&&null!==e?e:{};if("RequestOfflineError"===t.name)return new SupportApiError("offline",OFFLINE_MESSAGE,null);const r="number"==typeof t.response?.status?t.response.status:null,a=t.response?.data,n="object"==typeof a&&null!==a?a:void 0,s="string"==typeof n?.code?n.code:"unknown";return n&&"string"==typeof n.detail&&n.detail.trim()?new SupportApiError(s,n.detail,r):t.response?new SupportApiError(s,GENERIC_MESSAGE,r):new SupportApiError("network",OFFLINE_MESSAGE,null)};const UPLOAD_TIMEOUT_MS=3e5,textFields=(e,t)=>void 0!==t&&""!==t?[{name:e,value:t}]:[],fileFields=(e,t)=>(t??[]).map(t=>({name:e,file:{uri:t.uri,name:t.name,type:t.type}})),uploadIdFields=e=>(e??[]).map(e=>({name:"uploadIds",value:e})),multipartRequest=(e,t)=>({method:"POST",url:e,headers:{"Content-Type":"multipart/form-data","Idempotency-Key":newIdempotencyKey()},body:{kind:"multipart",fields:t},timeoutMs:3e5});export const supportRepliesUrl=(e,t)=>`${e}/tickets/${encodeURIComponent(t)}/replies`;const queryString=e=>{const t=[],add=(e,r)=>{void 0!==r&&""!==r&&t.push(`${e}=${encodeURIComponent(String(r))}`)};return add("status",e.status),add("search",e.search?.trim()),add("queue",e.queue?.trim()),add("page",e.page),add("pageSize",e.pageSize),t.length>0?`?${t.join("&")}`:""};export const createSupportClient=(e,t="/api/support",r)=>{const a=t.replace(/\/+$/,""),ticketUrl=e=>`${a}/tickets/${encodeURIComponent(e)}`,call=async(e,t,r)=>{let a;try{a=(await t()).data}catch(e){throw toSupportApiError(e)}try{return r(a)}catch(t){throw new Error(`${e}: ${t instanceof Error?t.message:String(t)}`,{cause:t})}},getBytes=t=>call("GET /attachments/{id}",()=>e.get(`${a}/attachments/${encodeURIComponent(t)}`,{responseType:"arraybuffer"}),parseArrayBuffer),n=r?.replace(/\/+$/,"");return{basePath:a,helpCentre:void 0===n?void 0:{settings:t=>call("GET help /settings",()=>e.get(`${n}/settings`,{signal:t?.signal}),parseHelpCentreSettings),list:(t={},r)=>call("GET help /articles",()=>e.get(`${n}/articles${queryString(t)}`,{signal:r?.signal}),parseHelpArticlePage),get:(t,r)=>call("GET help /articles/{slug}",()=>e.get(`${n}/articles/${encodeURIComponent(t)}`,{signal:r?.signal}),parseHelpArticleView),search:(t,r)=>call("GET help /search",()=>e.get(`${n}/search?q=${encodeURIComponent(t)}`,{signal:r?.signal}),parseHelpArticleSummaries)},getConfig:()=>call("GET /settings",()=>e.get(`${a}/settings`),parseSupportContactInfo),listTickets:(t={})=>call("GET /tickets",()=>e.get(`${a}/tickets${queryString(t)}`),parseSupportTicketPage),getTicketCounts:()=>call("GET /tickets/counts",()=>e.get(`${a}/tickets/counts`),parseSupportTicketCounts),getTicket:t=>call("GET /tickets/{id}",()=>e.get(ticketUrl(t)),parseSupportTicketDetail),ticketRequest:e=>multipartRequest(`${a}/tickets`,[{name:"category",value:e.category},{name:"subject",value:e.subject},{name:"body",value:e.body},...textFields("queue",e.queue),...textFields("pageUrl",e.pageUrl),...textFields("userAgent",e.userAgent),...textFields("appVersion",e.appVersion),...fileFields("files",e.files),...fileFields("screenshots",e.screenshots),...uploadIdFields(e.uploadIds)]),getSuggestions:t=>call("GET /suggestions",()=>e.get(`${a}/suggestions?subject=${encodeURIComponent(t)}`),parseSupportSuggestedArticles),replyRequest:(e,t)=>multipartRequest(supportRepliesUrl(a,e),[{name:"body",value:t.body},...fileFields("files",t.files),...fileFields("screenshots",t.screenshots),...uploadIdFields(t.uploadIds)]),uploadRequest:(e,t)=>{const r=newIdempotencyKey();return{uploadId:r,request:{method:"POST",url:`${a}/uploads`,headers:{"Idempotency-Key":r},body:{kind:"resumable",file:e,metadata:{filename:e.name,filetype:e.type,kind:t}},timeoutMs:3e5}}},reopen:t=>call("POST /tickets/{id}/reopen",()=>e.post(`${ticketUrl(t)}/reopen`),parseSupportTicketDetail),cancel:t=>call("POST /tickets/{id}/cancel",()=>e.post(`${ticketUrl(t)}/cancel`),parseSupportTicketDetail),rate:(t,r)=>call("POST /tickets/{id}/rating",()=>e.post(`${ticketUrl(t)}/rating`,{satisfaction:r.satisfaction,comment:r.comment?.trim()?r.comment.trim():null}),parseSupportTicketDetail),getAttachmentBytes:getBytes,getAttachmentDataUri:async e=>{const t=await getBytes(e.id);return`data:${e.contentType};base64,${encodeBase64(t)}`}}};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { OutboxRequest } from "@webority/mobile-core/outbox";
|
|
2
|
-
import type { HelpArticleSummary, HelpArticleView, HelpCentreSettings, NewSupportTicketInput, SupportAttachmentView, SupportContactInfo, SupportPage, SupportRatingInput, SupportReplyInput, SupportSuggestedArticle, SupportTicketCounts, SupportTicketDetail, SupportTicketQuery, SupportTicketSummary } from "./types";
|
|
2
|
+
import type { HelpArticleSummary, HelpArticleView, HelpCentreSettings, NewSupportTicketInput, SupportAttachmentKind, SupportAttachmentView, SupportContactInfo, SupportFilePart, SupportPage, SupportRatingInput, SupportReplyInput, SupportSuggestedArticle, SupportTicketCounts, SupportTicketDetail, SupportTicketQuery, SupportTicketSummary } from "./types";
|
|
3
3
|
/**
|
|
4
4
|
* The slice of an HTTP client the support client needs. The app's signed-in
|
|
5
5
|
* axios instance (mobile-core's `userClient`, or its own) satisfies it as is, so
|
|
@@ -67,6 +67,11 @@ export interface SupportClient {
|
|
|
67
67
|
getSuggestions?(subject: string): Promise<SupportSuggestedArticle[]>;
|
|
68
68
|
/** The reply request for the outbox: multipart with a fresh Idempotency-Key. */
|
|
69
69
|
replyRequest(id: string, input: SupportReplyInput): OutboxRequest;
|
|
70
|
+
/** The upload request for the outbox, and the id a ticket or reply lists in uploadIds. The id is the request's Idempotency-Key. */
|
|
71
|
+
uploadRequest(file: SupportFilePart, kind: SupportAttachmentKind): {
|
|
72
|
+
uploadId: string;
|
|
73
|
+
request: OutboxRequest;
|
|
74
|
+
};
|
|
70
75
|
reopen(id: string): Promise<SupportTicketDetail>;
|
|
71
76
|
/** Withdraws the ticket; resolves to the updated ticket. */
|
|
72
77
|
cancel(id: string): Promise<SupportTicketDetail>;
|
|
@@ -178,11 +178,15 @@ export interface NewSupportTicketInput {
|
|
|
178
178
|
queue?: string | undefined;
|
|
179
179
|
files?: SupportFilePart[];
|
|
180
180
|
screenshots?: SupportFilePart[];
|
|
181
|
+
/** Finished uploads to attach, as the ids uploadRequest returned. */
|
|
182
|
+
uploadIds?: string[];
|
|
181
183
|
}
|
|
182
184
|
export interface SupportReplyInput {
|
|
183
185
|
body: string;
|
|
184
186
|
files?: SupportFilePart[];
|
|
185
187
|
screenshots?: SupportFilePart[];
|
|
188
|
+
/** Finished uploads to attach, as the ids uploadRequest returned. */
|
|
189
|
+
uploadIds?: string[];
|
|
186
190
|
}
|
|
187
191
|
export interface SupportRatingInput {
|
|
188
192
|
satisfaction: SupportSatisfaction;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { OutboxRequest } from "@webority/mobile-core/outbox";
|
|
2
|
-
import type { HelpArticleSummary, HelpArticleView, HelpCentreSettings, NewSupportTicketInput, SupportAttachmentView, SupportContactInfo, SupportPage, SupportRatingInput, SupportReplyInput, SupportSuggestedArticle, SupportTicketCounts, SupportTicketDetail, SupportTicketQuery, SupportTicketSummary } from "./types.js";
|
|
2
|
+
import type { HelpArticleSummary, HelpArticleView, HelpCentreSettings, NewSupportTicketInput, SupportAttachmentKind, SupportAttachmentView, SupportContactInfo, SupportFilePart, SupportPage, SupportRatingInput, SupportReplyInput, SupportSuggestedArticle, SupportTicketCounts, SupportTicketDetail, SupportTicketQuery, SupportTicketSummary } from "./types.js";
|
|
3
3
|
/**
|
|
4
4
|
* The slice of an HTTP client the support client needs. The app's signed-in
|
|
5
5
|
* axios instance (mobile-core's `userClient`, or its own) satisfies it as is, so
|
|
@@ -67,6 +67,11 @@ export interface SupportClient {
|
|
|
67
67
|
getSuggestions?(subject: string): Promise<SupportSuggestedArticle[]>;
|
|
68
68
|
/** The reply request for the outbox: multipart with a fresh Idempotency-Key. */
|
|
69
69
|
replyRequest(id: string, input: SupportReplyInput): OutboxRequest;
|
|
70
|
+
/** The upload request for the outbox, and the id a ticket or reply lists in uploadIds. The id is the request's Idempotency-Key. */
|
|
71
|
+
uploadRequest(file: SupportFilePart, kind: SupportAttachmentKind): {
|
|
72
|
+
uploadId: string;
|
|
73
|
+
request: OutboxRequest;
|
|
74
|
+
};
|
|
70
75
|
reopen(id: string): Promise<SupportTicketDetail>;
|
|
71
76
|
/** Withdraws the ticket; resolves to the updated ticket. */
|
|
72
77
|
cancel(id: string): Promise<SupportTicketDetail>;
|
|
@@ -178,11 +178,15 @@ export interface NewSupportTicketInput {
|
|
|
178
178
|
queue?: string | undefined;
|
|
179
179
|
files?: SupportFilePart[];
|
|
180
180
|
screenshots?: SupportFilePart[];
|
|
181
|
+
/** Finished uploads to attach, as the ids uploadRequest returned. */
|
|
182
|
+
uploadIds?: string[];
|
|
181
183
|
}
|
|
182
184
|
export interface SupportReplyInput {
|
|
183
185
|
body: string;
|
|
184
186
|
files?: SupportFilePart[];
|
|
185
187
|
screenshots?: SupportFilePart[];
|
|
188
|
+
/** Finished uploads to attach, as the ids uploadRequest returned. */
|
|
189
|
+
uploadIds?: string[];
|
|
186
190
|
}
|
|
187
191
|
export interface SupportRatingInput {
|
|
188
192
|
satisfaction: SupportSatisfaction;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@webority/mobile-support",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.174.0",
|
|
4
4
|
"description": "Customer support tickets for Webority React Native apps: the support API client, hooks, ticket screens, contact card and a report-an-issue button that attaches a screenshot.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"react-native",
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"!**/*.map"
|
|
63
63
|
],
|
|
64
64
|
"peerDependencies": {
|
|
65
|
-
"@webority/mobile-core": "0.
|
|
66
|
-
"@webority/mobile-ui": "0.
|
|
65
|
+
"@webority/mobile-core": "0.174.0",
|
|
66
|
+
"@webority/mobile-ui": "0.174.0",
|
|
67
67
|
"expo": ">=58.0.0",
|
|
68
68
|
"expo-file-system": ">=58.0.0",
|
|
69
69
|
"expo-image-manipulator": ">=58.0.0",
|
|
@@ -125,9 +125,9 @@
|
|
|
125
125
|
"@testing-library/react-native": "14.1.0",
|
|
126
126
|
"@types/jest": "29.5.14",
|
|
127
127
|
"@types/react": "19.3.0",
|
|
128
|
-
"@webority/mobile-core": "0.
|
|
128
|
+
"@webority/mobile-core": "0.174.0",
|
|
129
129
|
"@webority/mobile-dev": "0.0.0",
|
|
130
|
-
"@webority/mobile-ui": "0.
|
|
130
|
+
"@webority/mobile-ui": "0.174.0",
|
|
131
131
|
"expo": "58.0.23",
|
|
132
132
|
"expo-file-system": "58.0.13",
|
|
133
133
|
"expo-image-manipulator": "58.0.16",
|