@closerepo/notification-contracts 1.11.0 → 1.13.0

package/dist/render.js

@@ -0,0 +1,23 @@
+import{z as e}from"zod";e.strictObject({eventId:e.uuid(),deliverBy:e.iso.datetime(),locale:e.string().min(1).max(35),contentLocale:e.string().min(1).max(35),title:e.string().trim().min(1).max(512),body:e.string(),url:e.url().refine(e=>new URL(e).protocol===`https:`,`notification_https_target_required`)});const t=32*1024,n=1380*60*1e3,r=t,i=t,a=n,o=32*1024,s=[`pending`,`delivering`,`partial`,`delivered`,`failed`,`expired`],c=[`accepted`,`enqueue_retry_wait`,`in_progress`,`partial_delivery`,`complete`,`retry_exhausted`,`delivery_deadline_exceeded`,`destination_configuration_unavailable`],l=[...s,`unconfirmed`],u=[...c,`delivery_unconfirmed`],d=[`pending`,`delivering`,`delivered`,`failed`,`expired`],f=[...d,`unconfirmed`],p=[`provider_timeout`,`provider_rate_limited`,`provider_unavailable`,`provider_rejected`,`destination_configuration_unavailable`,`delivery_interrupted`,`retry_exhausted`],m=[`invalid_request`,`request_too_large`,`producer_scope_mismatch`,`route_not_allowed`,`event_identity_conflict`,`route_not_found`,`route_empty`,`delivery_deadline_invalid`],h=[`invalid_type`,`invalid_value`,`too_small`,`too_big`,`invalid_format`,`unrecognized_keys`,`custom`],g=[`qq`,`tg`,`wechat`,`lark`],ee=new TextEncoder,_=/^[a-z][a-z0-9-]{0,62}$/,te=/^[a-z][a-z0-9-]{0,31}(?:\.[a-z][a-z0-9-]{0,31}){1,3}$/,ne=/^[A-Z0-9][\w.:-]{0,127}$/i;function v(e){return[...e].length}function y(t){return e.string().refine(e=>v(e)>0,{message:`too_small`}).refine(e=>v(e)<=t,{message:`too_big`})}const b=e.string().datetime({offset:!0}),x=e.object({key:e.string().regex(_),environment:e.string().regex(_)}).strict(),S=e.object({type:e.string().regex(_),id:e.string().regex(ne),revision:e.number().int().positive()}).strict(),C=e.string().min(1).max(127).regex(te),w=e.object({label:y(48),url:y(2048).refine(e=>[...e].every(e=>{let t=e.codePointAt(0);return t!==void 0&&t>31&&t!==127}),{message:`invalid_https_url`}).refine(e=>{try{return new URL(e).protocol===`https:`}catch{return!1}},{message:`invalid_https_url`})}).strict(),T={eventType:e.literal(`notification.delivery.requested`),eventId:e.string().uuid(),producer:x,routeKey:C,occurredAt:b,requestedAt:b,deliverBy:b,subject:S},re=e.object({contractVersion:e.literal(1),...T,message:e.object({type:e.literal(`link_summary`),title:y(160),summary:y(1200),facts:e.array(e.object({label:y(48),value:y(500)}).strict()).max(10),primaryLink:w,sourceLink:w.optional()}).strict()}).strict();function E(e,t,n,r){let i=Date.parse(e.requestedAt),a=Date.parse(e.deliverBy);(!Number.isFinite(i)||!Number.isFinite(a)||a<=i||a-i>n)&&t.addIssue({code:`custom`,message:`delivery_deadline_invalid`,path:[`deliverBy`]}),ee.encode(JSON.stringify(e)).byteLength>r&&t.addIssue({code:`custom`,message:`request_too_large`})}const ie=re.superRefine((e,r)=>E(e,r,n,t)),D={title:y(160),summary:y(1200),facts:e.array(e.object({label:y(48),value:y(500)}).strict()).max(10)},ae=e.discriminatedUnion(`key`,[e.object({key:e.literal(`source`),locale:e.literal(`und`),...D}).strict(),e.object({key:e.literal(`zh-CN`),locale:e.literal(`zh-CN`),...D}).strict()]),oe=e.array(ae).min(1).max(2).superRefine((e,t)=>{e.filter(e=>e.key===`source`).length!==1&&t.addIssue({code:`custom`,message:`source_variant_required_once`}),new Set(e.map(e=>e.key)).size!==e.length&&t.addIssue({code:`custom`,message:`message_variant_duplicate`})}),se=e.object({contractVersion:e.literal(2),...T,message:e.object({type:e.literal(`localized_link_summary`),variants:oe,primaryLink:w,sourceLink:w.optional()}).strict()}).strict().superRefine((e,t)=>E(e,t,828e5,32768)),ce=e.discriminatedUnion(`type`,[e.object({key:e.string().regex(_),type:e.literal(`text`),label:y(48).optional(),value:y(4e3)}).strict(),e.object({key:e.string().regex(_),type:e.literal(`fields`),items:e.array(e.object({label:y(48),value:y(1200)}).strict()).min(1).max(20)}).strict()]),O=e.array(ce).max(30).superRefine((e,t)=>{new Set(e.map(e=>e.key)).size!==e.length&&t.addIssue({code:`custom`,message:`message_section_duplicate`})}),k=O.min(1),A=e.discriminatedUnion(`key`,[e.object({key:e.literal(`source`),locale:e.literal(`und`),title:y(160),sections:k}).strict(),e.object({key:e.literal(`zh-CN`),locale:e.literal(`zh-CN`),title:y(160),sections:k}).strict()]),j=(e,t,n=!1)=>{e.filter(e=>e.key===`source`).length!==1&&t.addIssue({code:`custom`,message:`source_variant_required_once`}),new Set(e.map(e=>e.key)).size!==e.length&&t.addIssue({code:`custom`,message:`message_variant_duplicate`});let r=e.find(e=>e.key===`source`),i=e.find(e=>e.key===`zh-CN`);if(r&&i){let a=new Set(r.sections.map(e=>e.key)),o=new Set(i.sections.map(e=>e.key)),s=r.sections.filter(e=>!n||e.type!==`text`||o.has(e.key)).map(e=>`${e.key}:${e.type}`),c=i.sections.filter(e=>!n||e.type!==`text`||a.has(e.key)).map(e=>`${e.key}:${e.type}`);JSON.stringify(s)!==JSON.stringify(c)&&t.addIssue({code:`custom`,message:`message_variant_structure_mismatch`,path:[e.indexOf(i),`sections`]})}},le=e.array(A).min(1).max(2).superRefine(j),M=e.object({contractVersion:e.literal(3),...T,message:e.object({type:e.literal(`structured_notification`),variants:le,links:e.array(e.object({key:e.string().regex(_),...w.shape}).strict()).max(10).superRefine((e,t)=>{new Set(e.map(e=>e.key)).size!==e.length&&t.addIssue({code:`custom`,message:`message_link_duplicate`})})}).strict()}).strict(),ue=M.superRefine((e,t)=>E(e,t,828e5,32768)),N=e.object({label:y(48).optional(),value:y(r)}).strict(),de=e.discriminatedUnion(`key`,[A.options[0].extend({body:N}),A.options[1].extend({body:N})]),fe=M.extend({contractVersion:e.literal(4),message:M.shape.message.extend({variants:e.array(de).min(1).max(2).superRefine(j)})}).superRefine((e,t)=>E(e,t,828e5,r)),P=e.discriminatedUnion(`key`,[A.options[0].extend({bodyLabel:y(48).optional(),linkLabels:e.array(e.object({key:e.string().regex(_),label:y(48)}).strict()).max(10).superRefine((e,t)=>{new Set(e.map(e=>e.key)).size!==e.length&&t.addIssue({code:`custom`,message:`message_link_label_duplicate`})})}),A.options[1].extend({bodyLabel:y(48).optional(),linkLabels:e.array(e.object({key:e.string().regex(_),label:y(48)}).strict()).max(10).superRefine((e,t)=>{new Set(e.map(e=>e.key)).size!==e.length&&t.addIssue({code:`custom`,message:`message_link_label_duplicate`})})})]),pe=e.object({value:y(i)}).strict(),F=e.object({contractVersion:e.literal(5),...T,message:e.object({type:e.literal(`structured_notification`),variants:e.array(P).min(1).max(2).superRefine(j),links:e.array(e.object({key:e.string().regex(_),url:w.shape.url}).strict()).max(10).superRefine((e,t)=>{new Set(e.map(e=>e.key)).size!==e.length&&t.addIssue({code:`custom`,message:`message_link_duplicate`})}),body:pe}).strict()}).strict().superRefine((e,t)=>{E(e,t,a,i);let n=e.message.links.map(e=>e.key);for(let[r,i]of e.message.variants.entries()){let e=i.linkLabels.map(e=>e.key);JSON.stringify(e)!==JSON.stringify(n)&&t.addIssue({code:`custom`,message:`message_variant_link_labels_mismatch`,path:[`message`,`variants`,r,`linkLabels`]})}}),I=e.object({...F.shape,contractVersion:e.literal(6),message:F.shape.message.omit({body:!0}).extend({bodies:e.array(e.object({key:e.string().regex(_),value:y(i)}).strict()).max(2),variants:e.array(e.discriminatedUnion(`key`,[P.options[0].omit({bodyLabel:!0}).extend({sections:O,bodyRefs:e.array(e.object({key:e.string().regex(_),label:y(48).optional()}).strict()).max(2),footer:y(500).optional()}),P.options[1].omit({bodyLabel:!0}).extend({sections:O,bodyRefs:e.array(e.object({key:e.string().regex(_),label:y(48).optional()}).strict()).max(2),footer:y(500).optional()})])).min(1).max(2).superRefine((e,t)=>j(e,t,!0))})}).strict().superRefine(L);function L(e,t){E(e,t,a,i);let n=e.message.bodies.map(e=>e.key),r=e.message.links.map(e=>e.key);new Set(n).size!==n.length&&t.addIssue({code:`custom`,message:`message_body_duplicate`}),R(e.message.variants,n,r,t)}function R(e,t,n,r,i){for(let[a,o]of e.entries()){let e=o.bodyRefs.map(e=>e.key);(new Set(e).size!==e.length||e.some(e=>!t.includes(e)))&&r.addIssue({code:`custom`,message:`message_body_reference_invalid`,...i?{path:[...i,a,`bodyRefs`]}:{}}),JSON.stringify(o.linkLabels.map(e=>e.key))!==JSON.stringify(n)&&r.addIssue({code:`custom`,message:`message_variant_link_labels_mismatch`,...i?{path:[...i,a,`linkLabels`]}:{}})}}const z=e.array(C).min(1).superRefine((e,t)=>{new Set(e).size!==e.length&&t.addIssue({code:`custom`,message:`route_key_duplicate`})}),{routeKey:me,...he}=I.shape,B=I.shape.message,V=e.object({...he,contractVersion:e.literal(7),routeKeys:z,message:B}).strict().superRefine(L),H=e.object({...V.shape,contractVersion:e.literal(8),message:B.extend({channelVariants:e.partialRecord(e.enum(g),B.shape.variants).optional()})}).strict().superRefine((e,t)=>{L(e,t);let n=e.message.variants.map(e=>`${e.key}:${e.locale}`).sort(),r=e.message.bodies.map(e=>e.key),i=e.message.links.map(e=>e.key);for(let a of g){let o=e.message.channelVariants?.[a];if(!o)continue;let s=[`message`,`channelVariants`,a];JSON.stringify(o.map(e=>`${e.key}:${e.locale}`).sort())!==JSON.stringify(n)&&t.addIssue({code:`custom`,message:`message_channel_variant_languages_mismatch`,path:s}),R(o,r,i,t,s)}}),ge=e.object({locale:y(35),contentLocale:y(35),title:y(160).refine(e=>e.trim().length>0,`browser_message_title_blank`),body:e.string().max(8192),url:w.shape.url}).strict(),_e=e.object({...H.shape,contractVersion:e.literal(9),audience:e.object({topics:e.array(y(128)).min(1).max(2).superRefine((e,t)=>{new Set(e).size!==e.length&&t.addIssue({code:`custom`,message:`audience_topic_duplicate`})})}).strict().optional(),browserMessages:e.array(ge).min(1).max(5).superRefine((e,t)=>{new Set(e.map(e=>e.locale)).size!==e.length&&t.addIssue({code:`custom`,message:`browser_message_locale_duplicate`})}).optional()}).strict().superRefine((e,t)=>{let{audience:n,browserMessages:r,...i}=e,o=H.safeParse({...i,contractVersion:8});if(o.success)E(e,t,a,65536);else for(let e of o.error.issues)t.addIssue({...e});r!==void 0&&n===void 0&&t.addIssue({code:`custom`,message:`browser_message_audience_missing`,path:[`audience`]})}),ve=e.object({type:e.literal(`creator.draft.v1`),templateId:e.string().regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/),signalType:e.string().regex(/^[a-z][a-z0-9_]*$/),sourceTextZh:y(o),sourceUrl:w.shape.url.optional()}).strict();e.object({contractVersion:e.literal(1),eventType:e.literal(`local-task.delivery.requested`),eventId:e.string().uuid(),producer:x,routeKey:C,occurredAt:b,requestedAt:b,deliverBy:b,subject:S.extend({type:e.literal(`creator-event`)}),task:ve}).strict().superRefine((e,t)=>E(e,t,6048e5,o));const ye=e.union([ie,se,ue,fe,F,I,V,H,_e]),U=e.object({destinationKey:e.string().min(1),state:e.enum(d),attempts:e.number().int().min(0).max(4),failureCode:e.enum(p).nullable(),lastAttemptAt:b.nullable(),nextAttemptAt:b.nullable(),leaseExpiresAt:b.nullable()}).strict(),W=e.object({contractVersion:e.literal(1),eventId:e.string().uuid(),producer:x,routeKey:C,subject:S,state:e.enum(s),reason:e.enum(c),terminal:e.boolean(),acceptedAt:b,updatedAt:b,deliverBy:b,terminalAt:b.nullable(),destinations:e.array(U).min(1).max(20)}).strict(),G=e.object({name:e.string().min(1).max(100),message:e.string().max(500).optional(),code:e.union([e.string().max(100),e.number()]).optional(),status:e.union([e.string().max(100),e.number()]).optional()}).strict(),be=G.extend({cause:G.extend({cause:G.extend({cause:G.optional()}).optional()}).optional()}),xe=U.extend({state:e.enum(f),attempts:e.number().int().min(0),revision:e.number().int().min(0),cause:be.nullable(),unconfirmedAt:b.nullable()}),K=W.extend({contractVersion:e.literal(2),state:e.enum(l),reason:e.enum(u),revision:e.number().int().min(0),destinations:e.array(xe).min(1).max(20)}),Se=K.omit({routeKey:!0}).extend({contractVersion:e.literal(3),routeKeys:z}),q=e.union([W,K,Se]),Ce=e.object({path:e.array(e.union([e.string(),e.number().int().min(0)])).max(16),code:e.enum(h)}).strict(),we=e.object({code:e.literal(`invalid_request`),issues:e.array(Ce).max(20).optional()}).strict(),Te=e.object({code:e.enum(m.filter(e=>e!==`invalid_request`))}).strict(),J=e.union([we,Te]);e.discriminatedUnion(`status`,[e.object({status:e.literal(`accepted`),receipt:W}).strict(),e.object({status:e.literal(`rejected`),error:J}).strict()]),e.discriminatedUnion(`status`,[e.object({status:e.literal(`found`),receipt:W}).strict(),e.object({status:e.literal(`not_found`)}).strict(),e.object({status:e.literal(`unavailable`),error:e.object({code:e.literal(`receipt_unavailable`)}).strict()}).strict()]),e.discriminatedUnion(`status`,[e.object({status:e.literal(`accepted`),receipt:q}).strict(),e.object({status:e.literal(`rejected`),error:J}).strict()]),e.discriminatedUnion(`status`,[e.object({status:e.literal(`found`),receipt:q}).strict(),e.object({status:e.literal(`not_found`)}).strict(),e.object({status:e.literal(`unavailable`),error:e.object({code:e.literal(`receipt_unavailable`)}).strict()}).strict()]);function Ee(e,t){if((e.contractVersion===8||e.contractVersion===9)&&t!==void 0){let n=e.message.channelVariants?.[t];if(n!==void 0)return n}return e.message.variants}function Y(e,t=[`source`],n){let r=ye.parse(e);return r.contractVersion===6||r.contractVersion===7||r.contractVersion===8||r.contractVersion===9?{links:[],linksPerVariant:!0,variants:X(Ee(r,n).map(e=>({key:e.key,locale:e.locale,title:e.title,sections:e.sections,footer:e.footer,bodies:e.bodyRefs.map(e=>({label:e.label,value:r.message.bodies.find(t=>t.key===e.key).value})),links:r.message.links.map((t,n)=>({...t,label:e.linkLabels[n].label}))})),t)}:r.contractVersion===1?{links:[...r.message.sourceLink?[{key:`source`,...r.message.sourceLink}]:[],{key:`primary`,...r.message.primaryLink}],linksPerVariant:!1,variants:[{key:`source`,locale:`und`,sections:[{key:`summary`,type:`text`,value:r.message.summary},...r.message.facts.length>0?[{key:`facts`,type:`fields`,items:r.message.facts}]:[]],title:r.message.title}]}:r.contractVersion===3||r.contractVersion===4?{links:r.message.links,linksPerVariant:!1,variants:X(r.message.variants,t)}:r.contractVersion===5?{links:[],linksPerVariant:!0,variants:X(r.message.variants.map(e=>({key:e.key,locale:e.locale,sections:e.sections,title:e.title,body:{label:e.bodyLabel,value:r.message.body.value},links:r.message.links.map((t,n)=>({...t,label:e.linkLabels[n].label}))})),t)}:{links:[...r.message.sourceLink?[{key:`source`,...r.message.sourceLink}]:[],{key:`primary`,...r.message.primaryLink}],linksPerVariant:!1,variants:X(r.message.variants.map(e=>({key:e.key,locale:e.locale,sections:[{key:`summary`,type:`text`,value:e.summary},...e.facts.length>0?[{key:`facts`,type:`fields`,items:e.facts}]:[]],title:e.title})),t)}}function X(e,t){let n=new Map(e.map(e=>[e.key,e])),r=[...new Set(t)].flatMap(e=>{let t=n.get(e);return t?[t]:[]});return r.length>0?r:[n.get(`source`)]}function De(e,t=[`source`],n){return Y(e,t,n).variants.map(e=>e.key)}var Z=class extends Error{code=`mandatory_content_too_large`;constructor(){super(`generic_notification_mandatory_content_too_large`),this.name=`GenericNotificationRenderError`}};function Oe(e,t,n=[`source`],r={}){if(!Number.isSafeInteger(t)||t<1)throw Error(`generic_notification_plain_text_limit_invalid`);let i=Y(e,n,r.channel);if(e.contractVersion===6||e.contractVersion===7||e.contractVersion===8||e.contractVersion===9)return je(i.variants,t,r);let a=i.links.map(e=>$(e.label,e.url)),o=a.length>0?`\n\n${a.join(`
+
+`)}`:``,s=i.linksPerVariant?``:o,c=r.variantSuffixes?.[i.variants.at(-1).key]??``,l=c.length>0?``:s,u=`
+
+---
+
+`,d=i.variants.map((e,t)=>{let n=`${t===i.variants.length-1&&c.length>0?s:``}${r.variantSuffixes?.[e.key]??``}`,a=r.omitFirstTitle===!0&&t===0,o=e.sections.map(ke).join(`
+
+`),l=e.links??i.links,u=l.length>0?`\n\n${l.map(e=>$(e.label,e.url)).join(`
+
+`)}`:``;return e.body===void 0?{fixed:a?``:e.title,optional:o.length===0?``:`${a?``:`
+
+`}${o}`,minimum:0,suffix:`${i.linksPerVariant?u:``}${n}`}:{fixed:`${a?``:`${e.title}\n\n`}${o}\n\n${e.body.label===void 0?``:`${e.body.label}\n`}`,optional:e.body.value,minimum:1,suffix:`${i.linksPerVariant?u:``}${n}`}}),f=d.reduce((e,t)=>e+Q(t.fixed)+t.minimum,Q(u)*(d.length-1)+Q(l)+d.reduce((e,t)=>e+Q(t.suffix),0));if(f>t)throw new Z;let p=d.map(e=>Q(e.optional)),m=d.map(e=>e.minimum),h=t-f;for(;h>0;){let e=p.map((e,t)=>({demand:e,index:t})).filter(({demand:e,index:t})=>e>m[t]);if(e.length===0)break;let t=Math.max(1,Math.floor(h/e.length));for(let{demand:n,index:r}of e){let e=Math.min(t,h,n-m[r]);m[r]+=e,h-=e}}return`${d.map((e,t)=>`${e.fixed}${Me(e.optional,m[t])}${e.suffix}`).join(u)}${l}`}function ke(e){return e.type===`fields`?e.items.map(e=>`${e.label}: ${e.value}`).join(`
+`):e.label?`${e.label}\n${e.value}`:e.value}function Ae(e,t){let n=e.map(()=>0);for(;t>0;){let r=e.map((e,t)=>({demand:e,index:t})).filter(({demand:e,index:t})=>e>n[t]);if(r.length===0)break;let i=Math.max(1,Math.floor(t/r.length));for(let{demand:e,index:a}of r){let r=Math.min(i,t,e-n[a]);n[a]+=r,t-=r}}return n}function je(e,t,n){let r=`
+
+---
+
+`,i=e.map((e,t)=>{let r=e.bodies,i=[...n.omitFirstTitle&&t===0?[]:[e.title],...e.sections.map(ke)].join(`
+
+`),a=[...(e.links??[]).map(e=>$(e.label,e.url)),...e.footer===void 0?[]:[e.footer]].map(e=>`\n\n${e}`).join(``)+(n.variantSuffixes?.[e.key]??``),o=r.map((e,t)=>e.label===void 0?i.length===0&&t===0?``:`
+
+`:`\n\n${e.label}\n`),s=e.locale===`zh-CN`?`……（已截断）`:`… (truncated)`;return{bodies:r,prefix:i,suffix:a,labels:o,marker:s,minimums:r.map(e=>Math.min(Q(e.value),Q(s)))}}),a=Q(r)*(i.length-1)+i.reduce((e,t)=>e+Q(t.prefix+t.suffix+t.labels.join(``))+t.minimums.reduce((e,t)=>e+t,0),0);if(a>t)throw new Z;let o=Ae(i.map(e=>e.bodies.reduce((t,n,r)=>t+Q(n.value)-e.minimums[r],0)),t-a);return i.map((e,t)=>{let n=Ae(e.bodies.map((t,n)=>Q(t.value)-e.minimums[n]),o[t]),r=e.bodies.map((t,r)=>{let i=e.minimums[r]+n[r];if(Q(t.value)<=i)return e.labels[r]+t.value;let a=Math.max(0,i-Q(e.marker)),o=[...t.value].slice(0,a).join(``),s=Math.max(o.lastIndexOf(`
+`),o.lastIndexOf(`。`),o.lastIndexOf(`. `)),c=s>=o.length*.8?o.slice(0,s+1):o;return e.labels[r]+c+e.marker}).join(``);return e.prefix+r+e.suffix}).join(r)}function Q(e){return[...e].length}function $(e,t){return`${e}: ${new URL(t).toString()}`}function Me(e,t){if(t<=0)return``;let n=[...e];return n.length<=t?e:t===1?`…`:`${n.slice(0,t-1).join(``)}…`}export{Z as GenericNotificationRenderError,Oe as renderGenericNotificationPlainText,Ee as resolveGenericNotificationChannelVariants,Y as resolveGenericNotificationMessage,De as resolveGenericNotificationMessageVariantKeys};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@closerepo/notification-contracts",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "type": "module",
   "license": "UNLICENSED",
   "repository": {
@@ -13,12 +13,18 @@
   },
   "files": [
     "dist/index.d.ts",
-    "dist/index.js"
+    "dist/index.js",
+    "dist/render.d.ts",
+    "dist/render.js"
   ],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./render": {
+      "types": "./dist/render.d.ts",
+      "import": "./dist/render.js"
     }
   },
   "dependencies": {