@milaboratories/pl-errors 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './parsed_error';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,33 @@
+"use strict";var $=Object.defineProperty;var y=(e,r,t)=>r in e?$(e,r,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[r]=t;var c=(e,r,t)=>y(e,typeof r!="symbol"?r+"":r,t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const u=require("zod"),g=require("@milaboratories/pl-client");class d extends Error{constructor(t,o,s,n,i,a,l){super(t);c(this,"message");this.fullMessage=t,this.plErrorType=o,this.plMessage=s,this.errors=n,this.fieldName=i,this.resource=a,this.resourceType=l,this.name="PlErrorReport",this.message=this.toString()}toString(){const t=this.resourceType?`${g.resourceTypeToString(this.resourceType)},`:"",o=this.resource?g.resourceIdToString(this.resource):"",s=this.fieldName?`/${this.fieldName}`:"",n=this.plErrorType?`error type: ${this.plErrorType}`:"",i=this.errors.map(a=>a.message).join(`
+
+`);return`PlErrorReport: resource: ${t} ${o}${s}
+${n}
+${i}`}}class E extends Error{constructor(r){super(r),this.message=r,this.name="PlInternalError"}}class f extends Error{constructor(t,o,s,n){super(t);c(this,"message");this.fullMessage=t,this.templateName=o,this.tengoMessage=s,this.tengoStacktrace=n,this.name="PlWorkflowError",this.message=this.toString()}toString(){return`PlWorkflowError:
+template: ${this.templateName}
+message:
+${this.tengoMessage}
+tengo stacktrace:
+${this.tengoStacktrace}
+
+full message:
+${this.fullMessage}`}}class h extends Error{constructor(t,o,s,n,i){super(t);c(this,"message");this.fullMessage=t,this.commandName=o,this.exitCode=s,this.stdout=n,this.workingDirectory=i,this.name="PlRunnerError",this.message=this.toString()}toString(){return`PlRunnerError:
+command: ${this.commandName}
+exit code: ${this.exitCode}
+working directory: ${this.workingDirectory}
+stdout:
+${this.stdout}
+
+full message:
+${this.fullMessage}`}}class S extends h{constructor(t,o,s,n,i){super(t,o,s,n,i);c(this,"message");this.name="PlMonetizationError",this.message=this.toString()}toString(){return`PlMonetizationError:
+command: ${this.commandName}
+exit code: ${this.exitCode}
+working directory: ${this.workingDirectory}
+stdout:
+${this.stdout}
+
+full message:
+${this.fullMessage}`}}const w=u.z.object({errorType:u.z.string(),message:u.z.string()});function T(e,r,t,o){const s=w.parse(JSON.parse(e)),n=P(s.message);return new d(e,s.errorType,s.message,n,o,r,t)}function P(e){const r={stage:"initial",value:[],result:[]};for(const o of e.split(`
+`)){if(r.stage=="initial")r.stage="path";else if(r.stage=="path"&&!m(o))r.stage="message";else if(r.stage=="message"&&m(o)){r.stage="path";const s=r.value.join(`
+`);r.result.push(p(s)),r.value=[]}r.value.push(o)}const t=r.value.join(`
+`);return r.result.push(p(t)),r.result}function m(e){for(const r of["U","I","O","S","OTW","D","MTW"])if(e.startsWith(`[${r}]`))return!0;return!1}function p(e){const r=/working directory: "(.*)"[\s\S]failed to run command: "([^"]+)" exited with code (\d+)\.[\s\S]*?Here is the latest command output:[\s\S]*?\t([\s\S]*)/,t=e.match(r);if(t){const n=t[1],i=t[2],a=parseInt(t[3],10),l=t[4].trim();return i.endsWith("mnz-client")&&a==1?new S(e,i,a,l,n):new h(e,i,a,l,n)}const o=/cannot eval code: cannot eval template: template: (.+)\n\t(.*?)\n\t(at [\s\S]*)/,s=e.match(o);if(s){const n=s[1],i=s[2],a=s[3];return new f(e,n,i,a)}return new E(e)}exports.PlErrorReport=d;exports.PlInternalError=E;exports.PlMonetizationError=S;exports.PlRunnerError=h;exports.PlTengoError=f;exports.parsePlError=T;exports.parseSubErrors=P;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/parsed_error.ts"],"sourcesContent":["/** Pl Backend throws arbitrary errors, and we're trying to parse them here. */\n\nimport { z } from \"zod\";\nimport { ResourceId, resourceIdToString, ResourceType, resourceTypeToString } from \"@milaboratories/pl-client\";\n\n/**\n * A parsed error from the Pl backend.\n * It contains several suberrors, which could be one or different causes of the error.\n */\nexport class PlErrorReport extends Error {\n  message: string;\n\n  constructor(\n    /** Full message from the Pl backend. */\n    public readonly fullMessage: string,\n\n    /** Either CID conflict or a error from controller. */\n    public readonly plErrorType: string,\n\n    /** Parsed pl backend message that will be futher parsed into suberrors. */\n    public readonly plMessage: string,\n\n    /** Could be several different errors, the name is from AggregateError. */\n    public readonly errors: PlCoreError[],\n\n    /** Optional info about a resource where the error happened. */\n    public readonly fieldName?: string,\n    public readonly resource?: ResourceId,\n    public readonly resourceType?: ResourceType,\n  ) {\n    super(fullMessage);\n    this.name = 'PlErrorReport';\n    this.message = this.toString();\n  }\n\n  toString() {\n    const rt = this.resourceType ? `${resourceTypeToString(this.resourceType)},` : '';\n    const r = this.resource ? resourceIdToString(this.resource) : '';\n    const f = this.fieldName ? `/${this.fieldName}` : '';\n    const errType = this.plErrorType ? `error type: ${this.plErrorType}` : '';\n    const subErrors = this.errors.map(e => e.message).join('\\n\\n');\n\n    return `PlErrorReport: resource: ${rt} ${r}${f}\n${errType}\n${subErrors}`;\n  }\n}\n\n/**\n * A suberror of a parsed error.\n */\nexport type PlCoreError =\n  | PlInternalError\n  | PlTengoError\n  | PlRunnerError\n  | PlMonetizationError;\n\n/**\n * An general error when we couldn't parse the cause.\n */\nexport class PlInternalError extends Error {\n  constructor(\n    public readonly message: string,\n  ) {\n    super(message);\n    this.name = 'PlInternalError';\n  }\n}\n\n/**\n * Happens when workflow template panics.\n */\nexport class PlTengoError extends Error {\n  message: string;\n\n  constructor(\n    public readonly fullMessage: string,\n    public readonly templateName: string,\n    public readonly tengoMessage: string,\n    public readonly tengoStacktrace: string,\n  ) {\n    super(fullMessage);\n    this.name = 'PlWorkflowError';\n    this.message = this.toString();\n  }\n\n  toString() {\n    return `PlWorkflowError:\ntemplate: ${this.templateName}\nmessage:\n${this.tengoMessage}\ntengo stacktrace:\n${this.tengoStacktrace}\n\nfull message:\n${this.fullMessage}`;\n  }\n}\n\n/**\n * Happens when a command fails to run.\n */\nexport class PlRunnerError extends Error {\n  message: string;\n\n  constructor(\n    public readonly fullMessage: string,\n    public readonly commandName: string,\n    public readonly exitCode: number,\n    public readonly stdout: string,\n    public readonly workingDirectory: string,\n  ) {\n    super(fullMessage);\n    this.name = 'PlRunnerError';\n    this.message = this.toString();\n  }\n\n  toString() {\n    return `PlRunnerError:\ncommand: ${this.commandName}\nexit code: ${this.exitCode}\nworking directory: ${this.workingDirectory}\nstdout:\n${this.stdout}\n\nfull message:\n${this.fullMessage}`;\n  }\n}\n\n/**\n * Happens when a monetization command fails to run.\n */\nexport class PlMonetizationError extends PlRunnerError {\n  message: string;\n\n  constructor(\n    fullMessage: string,\n    commandName: string,\n    exitCode: number,\n    stdout: string,\n    workingDirectory: string,\n  ) {\n    super(fullMessage, commandName, exitCode, stdout, workingDirectory);\n    this.name = 'PlMonetizationError';\n    this.message = this.toString();\n  }\n\n  toString() {\n    return `PlMonetizationError:\ncommand: ${this.commandName}\nexit code: ${this.exitCode}\nworking directory: ${this.workingDirectory}\nstdout:\n${this.stdout}\n\nfull message:\n${this.fullMessage}`;\n  }\n}\n\n/**\n * How the Pl backend represents an error.\n */\nconst backendErrorSchema = z.object({\n  errorType: z.string(),\n  message: z.string(),\n});\n\n/**\n * Parses a Pl error and suberrors from the Pl backend.\n */\nexport function parsePlError(\n  error: string,\n\n  resource?: ResourceId,\n  resourceType?: ResourceType,\n  field?: string,\n): PlErrorReport {\n  const parsed = backendErrorSchema.parse(JSON.parse(error));\n  const subErrors = parseSubErrors(parsed.message);\n\n  return new PlErrorReport(\n    error,\n    parsed.errorType,\n    parsed.message,\n    subErrors,\n\n    field,\n    resource,\n    resourceType,\n  );\n}\n\n/**\n * Reduces over the lines of the pl error message\n * to extract messages, and categorizes them.\n */\nexport function parseSubErrors(message: string): PlCoreError[] {\n  // the state of this reducing function\n  const state = {\n    stage: 'initial' as 'initial' | 'path' | 'message',\n    value: [] as string[],\n    result: [] as PlCoreError[],\n  };\n\n  for (const line of message.split('\\n')) {\n    if (state.stage == 'initial') {\n      // we need initial stage because apparently the first line\n      // of the error doesn't have [I], but is a path line.\n      state.stage = 'path';\n\n    } else if (state.stage == 'path' && !isPath(line)) {\n      state.stage = 'message';\n\n    } else if (state.stage == 'message' && isPath(line)) {\n      state.stage = 'path';\n      const text = state.value.join('\\n');\n      state.result.push(parseCoreError(text));\n      state.value = [];\n    }\n\n    state.value.push(line);\n  }\n\n  const text = state.value.join('\\n');\n  state.result.push(parseCoreError(text));\n\n  return state.result;\n}\n\nfunction isPath(line: string): boolean {\n  for (const fieldType of ['U', 'I', 'O', 'S', 'OTW', 'D', 'MTW']) {\n    if (line.startsWith(`[${fieldType}]`))\n      return true;\n  }\n\n  return false;\n}\n\n/**\n * Parses a suberror from the Pl backend.\n */\nfunction parseCoreError(message: string): PlCoreError {\n  // trying to parse a runner or monetization error.\n  // https://regex101.com/r/tmKLj7/1\n  const runnerErrorRegex = /working directory: \"(.*)\"[\\s\\S]failed to run command: \"([^\"]+)\" exited with code (\\d+)\\.[\\s\\S]*?Here is the latest command output:[\\s\\S]*?\\t([\\s\\S]*)/;\n  const match = message.match(runnerErrorRegex);\n  if (match) {\n    const workingDirectory = match[1];\n    const command = match[2];\n    const exitCode = parseInt(match[3], 10);\n    const stdout = match[4].trim();\n\n    if (command.endsWith(`mnz-client`) && exitCode == 1) {\n      return new PlMonetizationError(message, command, exitCode, stdout, workingDirectory);\n    }\n\n    return new PlRunnerError(message, command, exitCode, stdout, workingDirectory);\n  }\n\n  // trying to parse a Tengo error.\n  // https://regex101.com/r/1a7RpO/1\n  const workflowErrorRegex = /cannot eval code: cannot eval template: template: (.+)\\n\\t(.*?)\\n\\t(at [\\s\\S]*)/;\n  const workflowMatch = message.match(workflowErrorRegex);\n  if (workflowMatch) {\n    const templateName = workflowMatch[1];\n    const errorMessage = workflowMatch[2];\n    const stackTrace = workflowMatch[3];\n\n    return new PlTengoError(message, templateName, errorMessage, stackTrace);\n  }\n\n  // if we couldn't parse the error, return a general error.\n  return new PlInternalError(message);\n}\n"],"names":["PlErrorReport","fullMessage","plErrorType","plMessage","errors","fieldName","resource","resourceType","__publicField","rt","resourceTypeToString","r","resourceIdToString","f","errType","subErrors","e","PlInternalError","message","PlTengoError","templateName","tengoMessage","tengoStacktrace","PlRunnerError","commandName","exitCode","stdout","workingDirectory","PlMonetizationError","backendErrorSchema","z","parsePlError","error","field","parsed","parseSubErrors","state","line","isPath","text","parseCoreError","fieldType","runnerErrorRegex","match","command","workflowErrorRegex","workflowMatch","errorMessage","stackTrace"],"mappings":"kTASO,MAAMA,UAAsB,KAAM,CAGvC,YAEkBC,EAGAC,EAGAC,EAGAC,EAGAC,EACAC,EACAC,EAChB,CACA,MAAMN,CAAW,EApBnBO,EAAA,gBAIkB,KAAA,YAAAP,EAGA,KAAA,YAAAC,EAGA,KAAA,UAAAC,EAGA,KAAA,OAAAC,EAGA,KAAA,UAAAC,EACA,KAAA,SAAAC,EACA,KAAA,aAAAC,EAGhB,KAAK,KAAO,gBACP,KAAA,QAAU,KAAK,SAAS,CAAA,CAG/B,UAAW,CACH,MAAAE,EAAK,KAAK,aAAe,GAAGC,uBAAqB,KAAK,YAAY,CAAC,IAAM,GACzEC,EAAI,KAAK,SAAWC,EAAmB,mBAAA,KAAK,QAAQ,EAAI,GACxDC,EAAI,KAAK,UAAY,IAAI,KAAK,SAAS,GAAK,GAC5CC,EAAU,KAAK,YAAc,eAAe,KAAK,WAAW,GAAK,GACjEC,EAAY,KAAK,OAAO,OAASC,EAAE,OAAO,EAAE,KAAK;AAAA;AAAA,CAAM,EAE7D,MAAO,4BAA4BP,CAAE,IAAIE,CAAC,GAAGE,CAAC;AAAA,EAChDC,CAAO;AAAA,EACPC,CAAS,EAAA,CAEX,CAcO,MAAME,UAAwB,KAAM,CACzC,YACkBC,EAChB,CACA,MAAMA,CAAO,EAFG,KAAA,QAAAA,EAGhB,KAAK,KAAO,iBAAA,CAEhB,CAKO,MAAMC,UAAqB,KAAM,CAGtC,YACkBlB,EACAmB,EACAC,EACAC,EAChB,CACA,MAAMrB,CAAW,EARnBO,EAAA,gBAGkB,KAAA,YAAAP,EACA,KAAA,aAAAmB,EACA,KAAA,aAAAC,EACA,KAAA,gBAAAC,EAGhB,KAAK,KAAO,kBACP,KAAA,QAAU,KAAK,SAAS,CAAA,CAG/B,UAAW,CACF,MAAA;AAAA,YACC,KAAK,YAAY;AAAA;AAAA,EAE3B,KAAK,YAAY;AAAA;AAAA,EAEjB,KAAK,eAAe;AAAA;AAAA;AAAA,EAGpB,KAAK,WAAW,EAAA,CAElB,CAKO,MAAMC,UAAsB,KAAM,CAGvC,YACkBtB,EACAuB,EACAC,EACAC,EACAC,EAChB,CACA,MAAM1B,CAAW,EATnBO,EAAA,gBAGkB,KAAA,YAAAP,EACA,KAAA,YAAAuB,EACA,KAAA,SAAAC,EACA,KAAA,OAAAC,EACA,KAAA,iBAAAC,EAGhB,KAAK,KAAO,gBACP,KAAA,QAAU,KAAK,SAAS,CAAA,CAG/B,UAAW,CACF,MAAA;AAAA,WACA,KAAK,WAAW;AAAA,aACd,KAAK,QAAQ;AAAA,qBACL,KAAK,gBAAgB;AAAA;AAAA,EAExC,KAAK,MAAM;AAAA;AAAA;AAAA,EAGX,KAAK,WAAW,EAAA,CAElB,CAKO,MAAMC,UAA4BL,CAAc,CAGrD,YACEtB,EACAuB,EACAC,EACAC,EACAC,EACA,CACA,MAAM1B,EAAauB,EAAaC,EAAUC,EAAQC,CAAgB,EATpEnB,EAAA,gBAUE,KAAK,KAAO,sBACP,KAAA,QAAU,KAAK,SAAS,CAAA,CAG/B,UAAW,CACF,MAAA;AAAA,WACA,KAAK,WAAW;AAAA,aACd,KAAK,QAAQ;AAAA,qBACL,KAAK,gBAAgB;AAAA;AAAA,EAExC,KAAK,MAAM;AAAA;AAAA;AAAA,EAGX,KAAK,WAAW,EAAA,CAElB,CAKA,MAAMqB,EAAqBC,IAAE,OAAO,CAClC,UAAWA,IAAE,OAAO,EACpB,QAASA,IAAE,OAAO,CACpB,CAAC,EAKM,SAASC,EACdC,EAEA1B,EACAC,EACA0B,EACe,CACf,MAAMC,EAASL,EAAmB,MAAM,KAAK,MAAMG,CAAK,CAAC,EACnDjB,EAAYoB,EAAeD,EAAO,OAAO,EAE/C,OAAO,IAAIlC,EACTgC,EACAE,EAAO,UACPA,EAAO,QACPnB,EAEAkB,EACA3B,EACAC,CACF,CACF,CAMO,SAAS4B,EAAejB,EAAgC,CAE7D,MAAMkB,EAAQ,CACZ,MAAO,UACP,MAAO,CAAC,EACR,OAAQ,CAAA,CACV,EAEA,UAAWC,KAAQnB,EAAQ,MAAM;AAAA,CAAI,EAAG,CAClC,GAAAkB,EAAM,OAAS,UAGjBA,EAAM,MAAQ,eAELA,EAAM,OAAS,QAAU,CAACE,EAAOD,CAAI,EAC9CD,EAAM,MAAQ,kBAELA,EAAM,OAAS,WAAaE,EAAOD,CAAI,EAAG,CACnDD,EAAM,MAAQ,OACd,MAAMG,EAAOH,EAAM,MAAM,KAAK;AAAA,CAAI,EAClCA,EAAM,OAAO,KAAKI,EAAeD,CAAI,CAAC,EACtCH,EAAM,MAAQ,CAAC,CAAA,CAGXA,EAAA,MAAM,KAAKC,CAAI,CAAA,CAGvB,MAAME,EAAOH,EAAM,MAAM,KAAK;AAAA,CAAI,EAClC,OAAAA,EAAM,OAAO,KAAKI,EAAeD,CAAI,CAAC,EAE/BH,EAAM,MACf,CAEA,SAASE,EAAOD,EAAuB,CAC1B,UAAAI,IAAa,CAAC,IAAK,IAAK,IAAK,IAAK,MAAO,IAAK,KAAK,EAC5D,GAAIJ,EAAK,WAAW,IAAII,CAAS,GAAG,EAC3B,MAAA,GAGJ,MAAA,EACT,CAKA,SAASD,EAAetB,EAA8B,CAGpD,MAAMwB,EAAmB,wJACnBC,EAAQzB,EAAQ,MAAMwB,CAAgB,EAC5C,GAAIC,EAAO,CACH,MAAAhB,EAAmBgB,EAAM,CAAC,EAC1BC,EAAUD,EAAM,CAAC,EACjBlB,EAAW,SAASkB,EAAM,CAAC,EAAG,EAAE,EAChCjB,EAASiB,EAAM,CAAC,EAAE,KAAK,EAE7B,OAAIC,EAAQ,SAAS,YAAY,GAAKnB,GAAY,EACzC,IAAIG,EAAoBV,EAAS0B,EAASnB,EAAUC,EAAQC,CAAgB,EAG9E,IAAIJ,EAAcL,EAAS0B,EAASnB,EAAUC,EAAQC,CAAgB,CAAA,CAK/E,MAAMkB,EAAqB,kFACrBC,EAAgB5B,EAAQ,MAAM2B,CAAkB,EACtD,GAAIC,EAAe,CACX,MAAA1B,EAAe0B,EAAc,CAAC,EAC9BC,EAAeD,EAAc,CAAC,EAC9BE,EAAaF,EAAc,CAAC,EAElC,OAAO,IAAI3B,EAAaD,EAASE,EAAc2B,EAAcC,CAAU,CAAA,CAIlE,OAAA,IAAI/B,EAAgBC,CAAO,CACpC"}

package/dist/index.mjs

@@ -0,0 +1,148 @@
+var p = Object.defineProperty;
+var d = (e, t, r) => t in e ? p(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
+var c = (e, t, r) => d(e, typeof t != "symbol" ? t + "" : t, r);
+import { z as u } from "zod";
+import { resourceTypeToString as f, resourceIdToString as E } from "@milaboratories/pl-client";
+class $ extends Error {
+  constructor(r, o, s, n, i, a, l) {
+    super(r);
+    c(this, "message");
+    this.fullMessage = r, this.plErrorType = o, this.plMessage = s, this.errors = n, this.fieldName = i, this.resource = a, this.resourceType = l, this.name = "PlErrorReport", this.message = this.toString();
+  }
+  toString() {
+    const r = this.resourceType ? `${f(this.resourceType)},` : "", o = this.resource ? E(this.resource) : "", s = this.fieldName ? `/${this.fieldName}` : "", n = this.plErrorType ? `error type: ${this.plErrorType}` : "", i = this.errors.map((a) => a.message).join(`
+
+`);
+    return `PlErrorReport: resource: ${r} ${o}${s}
+${n}
+${i}`;
+  }
+}
+class S extends Error {
+  constructor(t) {
+    super(t), this.message = t, this.name = "PlInternalError";
+  }
+}
+class w extends Error {
+  constructor(r, o, s, n) {
+    super(r);
+    c(this, "message");
+    this.fullMessage = r, this.templateName = o, this.tengoMessage = s, this.tengoStacktrace = n, this.name = "PlWorkflowError", this.message = this.toString();
+  }
+  toString() {
+    return `PlWorkflowError:
+template: ${this.templateName}
+message:
+${this.tengoMessage}
+tengo stacktrace:
+${this.tengoStacktrace}
+
+full message:
+${this.fullMessage}`;
+  }
+}
+class g extends Error {
+  constructor(r, o, s, n, i) {
+    super(r);
+    c(this, "message");
+    this.fullMessage = r, this.commandName = o, this.exitCode = s, this.stdout = n, this.workingDirectory = i, this.name = "PlRunnerError", this.message = this.toString();
+  }
+  toString() {
+    return `PlRunnerError:
+command: ${this.commandName}
+exit code: ${this.exitCode}
+working directory: ${this.workingDirectory}
+stdout:
+${this.stdout}
+
+full message:
+${this.fullMessage}`;
+  }
+}
+class y extends g {
+  constructor(r, o, s, n, i) {
+    super(r, o, s, n, i);
+    c(this, "message");
+    this.name = "PlMonetizationError", this.message = this.toString();
+  }
+  toString() {
+    return `PlMonetizationError:
+command: ${this.commandName}
+exit code: ${this.exitCode}
+working directory: ${this.workingDirectory}
+stdout:
+${this.stdout}
+
+full message:
+${this.fullMessage}`;
+  }
+}
+const x = u.object({
+  errorType: u.string(),
+  message: u.string()
+});
+function N(e, t, r, o) {
+  const s = x.parse(JSON.parse(e)), n = T(s.message);
+  return new $(
+    e,
+    s.errorType,
+    s.message,
+    n,
+    o,
+    t,
+    r
+  );
+}
+function T(e) {
+  const t = {
+    stage: "initial",
+    value: [],
+    result: []
+  };
+  for (const o of e.split(`
+`)) {
+    if (t.stage == "initial")
+      t.stage = "path";
+    else if (t.stage == "path" && !h(o))
+      t.stage = "message";
+    else if (t.stage == "message" && h(o)) {
+      t.stage = "path";
+      const s = t.value.join(`
+`);
+      t.result.push(m(s)), t.value = [];
+    }
+    t.value.push(o);
+  }
+  const r = t.value.join(`
+`);
+  return t.result.push(m(r)), t.result;
+}
+function h(e) {
+  for (const t of ["U", "I", "O", "S", "OTW", "D", "MTW"])
+    if (e.startsWith(`[${t}]`))
+      return !0;
+  return !1;
+}
+function m(e) {
+  const t = /working directory: "(.*)"[\s\S]failed to run command: "([^"]+)" exited with code (\d+)\.[\s\S]*?Here is the latest command output:[\s\S]*?\t([\s\S]*)/, r = e.match(t);
+  if (r) {
+    const n = r[1], i = r[2], a = parseInt(r[3], 10), l = r[4].trim();
+    return i.endsWith("mnz-client") && a == 1 ? new y(e, i, a, l, n) : new g(e, i, a, l, n);
+  }
+  const o = /cannot eval code: cannot eval template: template: (.+)\n\t(.*?)\n\t(at [\s\S]*)/, s = e.match(o);
+  if (s) {
+    const n = s[1], i = s[2], a = s[3];
+    return new w(e, n, i, a);
+  }
+  return new S(e);
+}
+export {
+  $ as PlErrorReport,
+  S as PlInternalError,
+  y as PlMonetizationError,
+  g as PlRunnerError,
+  w as PlTengoError,
+  N as parsePlError,
+  T as parseSubErrors
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/parsed_error.ts"],"sourcesContent":["/** Pl Backend throws arbitrary errors, and we're trying to parse them here. */\n\nimport { z } from \"zod\";\nimport { ResourceId, resourceIdToString, ResourceType, resourceTypeToString } from \"@milaboratories/pl-client\";\n\n/**\n * A parsed error from the Pl backend.\n * It contains several suberrors, which could be one or different causes of the error.\n */\nexport class PlErrorReport extends Error {\n  message: string;\n\n  constructor(\n    /** Full message from the Pl backend. */\n    public readonly fullMessage: string,\n\n    /** Either CID conflict or a error from controller. */\n    public readonly plErrorType: string,\n\n    /** Parsed pl backend message that will be futher parsed into suberrors. */\n    public readonly plMessage: string,\n\n    /** Could be several different errors, the name is from AggregateError. */\n    public readonly errors: PlCoreError[],\n\n    /** Optional info about a resource where the error happened. */\n    public readonly fieldName?: string,\n    public readonly resource?: ResourceId,\n    public readonly resourceType?: ResourceType,\n  ) {\n    super(fullMessage);\n    this.name = 'PlErrorReport';\n    this.message = this.toString();\n  }\n\n  toString() {\n    const rt = this.resourceType ? `${resourceTypeToString(this.resourceType)},` : '';\n    const r = this.resource ? resourceIdToString(this.resource) : '';\n    const f = this.fieldName ? `/${this.fieldName}` : '';\n    const errType = this.plErrorType ? `error type: ${this.plErrorType}` : '';\n    const subErrors = this.errors.map(e => e.message).join('\\n\\n');\n\n    return `PlErrorReport: resource: ${rt} ${r}${f}\n${errType}\n${subErrors}`;\n  }\n}\n\n/**\n * A suberror of a parsed error.\n */\nexport type PlCoreError =\n  | PlInternalError\n  | PlTengoError\n  | PlRunnerError\n  | PlMonetizationError;\n\n/**\n * An general error when we couldn't parse the cause.\n */\nexport class PlInternalError extends Error {\n  constructor(\n    public readonly message: string,\n  ) {\n    super(message);\n    this.name = 'PlInternalError';\n  }\n}\n\n/**\n * Happens when workflow template panics.\n */\nexport class PlTengoError extends Error {\n  message: string;\n\n  constructor(\n    public readonly fullMessage: string,\n    public readonly templateName: string,\n    public readonly tengoMessage: string,\n    public readonly tengoStacktrace: string,\n  ) {\n    super(fullMessage);\n    this.name = 'PlWorkflowError';\n    this.message = this.toString();\n  }\n\n  toString() {\n    return `PlWorkflowError:\ntemplate: ${this.templateName}\nmessage:\n${this.tengoMessage}\ntengo stacktrace:\n${this.tengoStacktrace}\n\nfull message:\n${this.fullMessage}`;\n  }\n}\n\n/**\n * Happens when a command fails to run.\n */\nexport class PlRunnerError extends Error {\n  message: string;\n\n  constructor(\n    public readonly fullMessage: string,\n    public readonly commandName: string,\n    public readonly exitCode: number,\n    public readonly stdout: string,\n    public readonly workingDirectory: string,\n  ) {\n    super(fullMessage);\n    this.name = 'PlRunnerError';\n    this.message = this.toString();\n  }\n\n  toString() {\n    return `PlRunnerError:\ncommand: ${this.commandName}\nexit code: ${this.exitCode}\nworking directory: ${this.workingDirectory}\nstdout:\n${this.stdout}\n\nfull message:\n${this.fullMessage}`;\n  }\n}\n\n/**\n * Happens when a monetization command fails to run.\n */\nexport class PlMonetizationError extends PlRunnerError {\n  message: string;\n\n  constructor(\n    fullMessage: string,\n    commandName: string,\n    exitCode: number,\n    stdout: string,\n    workingDirectory: string,\n  ) {\n    super(fullMessage, commandName, exitCode, stdout, workingDirectory);\n    this.name = 'PlMonetizationError';\n    this.message = this.toString();\n  }\n\n  toString() {\n    return `PlMonetizationError:\ncommand: ${this.commandName}\nexit code: ${this.exitCode}\nworking directory: ${this.workingDirectory}\nstdout:\n${this.stdout}\n\nfull message:\n${this.fullMessage}`;\n  }\n}\n\n/**\n * How the Pl backend represents an error.\n */\nconst backendErrorSchema = z.object({\n  errorType: z.string(),\n  message: z.string(),\n});\n\n/**\n * Parses a Pl error and suberrors from the Pl backend.\n */\nexport function parsePlError(\n  error: string,\n\n  resource?: ResourceId,\n  resourceType?: ResourceType,\n  field?: string,\n): PlErrorReport {\n  const parsed = backendErrorSchema.parse(JSON.parse(error));\n  const subErrors = parseSubErrors(parsed.message);\n\n  return new PlErrorReport(\n    error,\n    parsed.errorType,\n    parsed.message,\n    subErrors,\n\n    field,\n    resource,\n    resourceType,\n  );\n}\n\n/**\n * Reduces over the lines of the pl error message\n * to extract messages, and categorizes them.\n */\nexport function parseSubErrors(message: string): PlCoreError[] {\n  // the state of this reducing function\n  const state = {\n    stage: 'initial' as 'initial' | 'path' | 'message',\n    value: [] as string[],\n    result: [] as PlCoreError[],\n  };\n\n  for (const line of message.split('\\n')) {\n    if (state.stage == 'initial') {\n      // we need initial stage because apparently the first line\n      // of the error doesn't have [I], but is a path line.\n      state.stage = 'path';\n\n    } else if (state.stage == 'path' && !isPath(line)) {\n      state.stage = 'message';\n\n    } else if (state.stage == 'message' && isPath(line)) {\n      state.stage = 'path';\n      const text = state.value.join('\\n');\n      state.result.push(parseCoreError(text));\n      state.value = [];\n    }\n\n    state.value.push(line);\n  }\n\n  const text = state.value.join('\\n');\n  state.result.push(parseCoreError(text));\n\n  return state.result;\n}\n\nfunction isPath(line: string): boolean {\n  for (const fieldType of ['U', 'I', 'O', 'S', 'OTW', 'D', 'MTW']) {\n    if (line.startsWith(`[${fieldType}]`))\n      return true;\n  }\n\n  return false;\n}\n\n/**\n * Parses a suberror from the Pl backend.\n */\nfunction parseCoreError(message: string): PlCoreError {\n  // trying to parse a runner or monetization error.\n  // https://regex101.com/r/tmKLj7/1\n  const runnerErrorRegex = /working directory: \"(.*)\"[\\s\\S]failed to run command: \"([^\"]+)\" exited with code (\\d+)\\.[\\s\\S]*?Here is the latest command output:[\\s\\S]*?\\t([\\s\\S]*)/;\n  const match = message.match(runnerErrorRegex);\n  if (match) {\n    const workingDirectory = match[1];\n    const command = match[2];\n    const exitCode = parseInt(match[3], 10);\n    const stdout = match[4].trim();\n\n    if (command.endsWith(`mnz-client`) && exitCode == 1) {\n      return new PlMonetizationError(message, command, exitCode, stdout, workingDirectory);\n    }\n\n    return new PlRunnerError(message, command, exitCode, stdout, workingDirectory);\n  }\n\n  // trying to parse a Tengo error.\n  // https://regex101.com/r/1a7RpO/1\n  const workflowErrorRegex = /cannot eval code: cannot eval template: template: (.+)\\n\\t(.*?)\\n\\t(at [\\s\\S]*)/;\n  const workflowMatch = message.match(workflowErrorRegex);\n  if (workflowMatch) {\n    const templateName = workflowMatch[1];\n    const errorMessage = workflowMatch[2];\n    const stackTrace = workflowMatch[3];\n\n    return new PlTengoError(message, templateName, errorMessage, stackTrace);\n  }\n\n  // if we couldn't parse the error, return a general error.\n  return new PlInternalError(message);\n}\n"],"names":["PlErrorReport","fullMessage","plErrorType","plMessage","errors","fieldName","resource","resourceType","__publicField","rt","resourceTypeToString","r","resourceIdToString","f","errType","subErrors","e","PlInternalError","message","PlTengoError","templateName","tengoMessage","tengoStacktrace","PlRunnerError","commandName","exitCode","stdout","workingDirectory","PlMonetizationError","backendErrorSchema","z","parsePlError","error","field","parsed","parseSubErrors","state","line","isPath","text","parseCoreError","fieldType","runnerErrorRegex","match","command","workflowErrorRegex","workflowMatch","errorMessage","stackTrace"],"mappings":";;;;;AASO,MAAMA,UAAsB,MAAM;AAAA,EAGvC,YAEkBC,GAGAC,GAGAC,GAGAC,GAGAC,GACAC,GACAC,GAChB;AACA,UAAMN,CAAW;AApBnB,IAAAO,EAAA;AAIkB,SAAA,cAAAP,GAGA,KAAA,cAAAC,GAGA,KAAA,YAAAC,GAGA,KAAA,SAAAC,GAGA,KAAA,YAAAC,GACA,KAAA,WAAAC,GACA,KAAA,eAAAC,GAGhB,KAAK,OAAO,iBACP,KAAA,UAAU,KAAK,SAAS;AAAA,EAAA;AAAA,EAG/B,WAAW;AACH,UAAAE,IAAK,KAAK,eAAe,GAAGC,EAAqB,KAAK,YAAY,CAAC,MAAM,IACzEC,IAAI,KAAK,WAAWC,EAAmB,KAAK,QAAQ,IAAI,IACxDC,IAAI,KAAK,YAAY,IAAI,KAAK,SAAS,KAAK,IAC5CC,IAAU,KAAK,cAAc,eAAe,KAAK,WAAW,KAAK,IACjEC,IAAY,KAAK,OAAO,IAAI,OAAKC,EAAE,OAAO,EAAE,KAAK;AAAA;AAAA,CAAM;AAE7D,WAAO,4BAA4BP,CAAE,IAAIE,CAAC,GAAGE,CAAC;AAAA,EAChDC,CAAO;AAAA,EACPC,CAAS;AAAA,EAAA;AAEX;AAcO,MAAME,UAAwB,MAAM;AAAA,EACzC,YACkBC,GAChB;AACA,UAAMA,CAAO,GAFG,KAAA,UAAAA,GAGhB,KAAK,OAAO;AAAA,EAAA;AAEhB;AAKO,MAAMC,UAAqB,MAAM;AAAA,EAGtC,YACkBlB,GACAmB,GACAC,GACAC,GAChB;AACA,UAAMrB,CAAW;AARnB,IAAAO,EAAA;AAGkB,SAAA,cAAAP,GACA,KAAA,eAAAmB,GACA,KAAA,eAAAC,GACA,KAAA,kBAAAC,GAGhB,KAAK,OAAO,mBACP,KAAA,UAAU,KAAK,SAAS;AAAA,EAAA;AAAA,EAG/B,WAAW;AACF,WAAA;AAAA,YACC,KAAK,YAAY;AAAA;AAAA,EAE3B,KAAK,YAAY;AAAA;AAAA,EAEjB,KAAK,eAAe;AAAA;AAAA;AAAA,EAGpB,KAAK,WAAW;AAAA,EAAA;AAElB;AAKO,MAAMC,UAAsB,MAAM;AAAA,EAGvC,YACkBtB,GACAuB,GACAC,GACAC,GACAC,GAChB;AACA,UAAM1B,CAAW;AATnB,IAAAO,EAAA;AAGkB,SAAA,cAAAP,GACA,KAAA,cAAAuB,GACA,KAAA,WAAAC,GACA,KAAA,SAAAC,GACA,KAAA,mBAAAC,GAGhB,KAAK,OAAO,iBACP,KAAA,UAAU,KAAK,SAAS;AAAA,EAAA;AAAA,EAG/B,WAAW;AACF,WAAA;AAAA,WACA,KAAK,WAAW;AAAA,aACd,KAAK,QAAQ;AAAA,qBACL,KAAK,gBAAgB;AAAA;AAAA,EAExC,KAAK,MAAM;AAAA;AAAA;AAAA,EAGX,KAAK,WAAW;AAAA,EAAA;AAElB;AAKO,MAAMC,UAA4BL,EAAc;AAAA,EAGrD,YACEtB,GACAuB,GACAC,GACAC,GACAC,GACA;AACA,UAAM1B,GAAauB,GAAaC,GAAUC,GAAQC,CAAgB;AATpE,IAAAnB,EAAA;AAUE,SAAK,OAAO,uBACP,KAAA,UAAU,KAAK,SAAS;AAAA,EAAA;AAAA,EAG/B,WAAW;AACF,WAAA;AAAA,WACA,KAAK,WAAW;AAAA,aACd,KAAK,QAAQ;AAAA,qBACL,KAAK,gBAAgB;AAAA;AAAA,EAExC,KAAK,MAAM;AAAA;AAAA;AAAA,EAGX,KAAK,WAAW;AAAA,EAAA;AAElB;AAKA,MAAMqB,IAAqBC,EAAE,OAAO;AAAA,EAClC,WAAWA,EAAE,OAAO;AAAA,EACpB,SAASA,EAAE,OAAO;AACpB,CAAC;AAKM,SAASC,EACdC,GAEA1B,GACAC,GACA0B,GACe;AACf,QAAMC,IAASL,EAAmB,MAAM,KAAK,MAAMG,CAAK,CAAC,GACnDjB,IAAYoB,EAAeD,EAAO,OAAO;AAE/C,SAAO,IAAIlC;AAAA,IACTgC;AAAA,IACAE,EAAO;AAAA,IACPA,EAAO;AAAA,IACPnB;AAAA,IAEAkB;AAAA,IACA3B;AAAA,IACAC;AAAA,EACF;AACF;AAMO,SAAS4B,EAAejB,GAAgC;AAE7D,QAAMkB,IAAQ;AAAA,IACZ,OAAO;AAAA,IACP,OAAO,CAAC;AAAA,IACR,QAAQ,CAAA;AAAA,EACV;AAEA,aAAWC,KAAQnB,EAAQ,MAAM;AAAA,CAAI,GAAG;AAClC,QAAAkB,EAAM,SAAS;AAGjB,MAAAA,EAAM,QAAQ;AAAA,aAELA,EAAM,SAAS,UAAU,CAACE,EAAOD,CAAI;AAC9C,MAAAD,EAAM,QAAQ;AAAA,aAELA,EAAM,SAAS,aAAaE,EAAOD,CAAI,GAAG;AACnD,MAAAD,EAAM,QAAQ;AACd,YAAMG,IAAOH,EAAM,MAAM,KAAK;AAAA,CAAI;AAClC,MAAAA,EAAM,OAAO,KAAKI,EAAeD,CAAI,CAAC,GACtCH,EAAM,QAAQ,CAAC;AAAA,IAAA;AAGX,IAAAA,EAAA,MAAM,KAAKC,CAAI;AAAA,EAAA;AAGvB,QAAME,IAAOH,EAAM,MAAM,KAAK;AAAA,CAAI;AAClC,SAAAA,EAAM,OAAO,KAAKI,EAAeD,CAAI,CAAC,GAE/BH,EAAM;AACf;AAEA,SAASE,EAAOD,GAAuB;AAC1B,aAAAI,KAAa,CAAC,KAAK,KAAK,KAAK,KAAK,OAAO,KAAK,KAAK;AAC5D,QAAIJ,EAAK,WAAW,IAAII,CAAS,GAAG;AAC3B,aAAA;AAGJ,SAAA;AACT;AAKA,SAASD,EAAetB,GAA8B;AAGpD,QAAMwB,IAAmB,yJACnBC,IAAQzB,EAAQ,MAAMwB,CAAgB;AAC5C,MAAIC,GAAO;AACH,UAAAhB,IAAmBgB,EAAM,CAAC,GAC1BC,IAAUD,EAAM,CAAC,GACjBlB,IAAW,SAASkB,EAAM,CAAC,GAAG,EAAE,GAChCjB,IAASiB,EAAM,CAAC,EAAE,KAAK;AAE7B,WAAIC,EAAQ,SAAS,YAAY,KAAKnB,KAAY,IACzC,IAAIG,EAAoBV,GAAS0B,GAASnB,GAAUC,GAAQC,CAAgB,IAG9E,IAAIJ,EAAcL,GAAS0B,GAASnB,GAAUC,GAAQC,CAAgB;AAAA,EAAA;AAK/E,QAAMkB,IAAqB,mFACrBC,IAAgB5B,EAAQ,MAAM2B,CAAkB;AACtD,MAAIC,GAAe;AACX,UAAA1B,IAAe0B,EAAc,CAAC,GAC9BC,IAAeD,EAAc,CAAC,GAC9BE,IAAaF,EAAc,CAAC;AAElC,WAAO,IAAI3B,EAAaD,GAASE,GAAc2B,GAAcC,CAAU;AAAA,EAAA;AAIlE,SAAA,IAAI/B,EAAgBC,CAAO;AACpC;"}

package/dist/parsed_error.d.ts

@@ -0,0 +1,86 @@
+import { ResourceId, ResourceType } from '@milaboratories/pl-client';
+/**
+ * A parsed error from the Pl backend.
+ * It contains several suberrors, which could be one or different causes of the error.
+ */
+export declare class PlErrorReport extends Error {
+    /** Full message from the Pl backend. */
+    readonly fullMessage: string;
+    /** Either CID conflict or a error from controller. */
+    readonly plErrorType: string;
+    /** Parsed pl backend message that will be futher parsed into suberrors. */
+    readonly plMessage: string;
+    /** Could be several different errors, the name is from AggregateError. */
+    readonly errors: PlCoreError[];
+    /** Optional info about a resource where the error happened. */
+    readonly fieldName?: string | undefined;
+    readonly resource?: ResourceId | undefined;
+    readonly resourceType?: ResourceType | undefined;
+    message: string;
+    constructor(
+    /** Full message from the Pl backend. */
+    fullMessage: string, 
+    /** Either CID conflict or a error from controller. */
+    plErrorType: string, 
+    /** Parsed pl backend message that will be futher parsed into suberrors. */
+    plMessage: string, 
+    /** Could be several different errors, the name is from AggregateError. */
+    errors: PlCoreError[], 
+    /** Optional info about a resource where the error happened. */
+    fieldName?: string | undefined, resource?: ResourceId | undefined, resourceType?: ResourceType | undefined);
+    toString(): string;
+}
+/**
+ * A suberror of a parsed error.
+ */
+export type PlCoreError = PlInternalError | PlTengoError | PlRunnerError | PlMonetizationError;
+/**
+ * An general error when we couldn't parse the cause.
+ */
+export declare class PlInternalError extends Error {
+    readonly message: string;
+    constructor(message: string);
+}
+/**
+ * Happens when workflow template panics.
+ */
+export declare class PlTengoError extends Error {
+    readonly fullMessage: string;
+    readonly templateName: string;
+    readonly tengoMessage: string;
+    readonly tengoStacktrace: string;
+    message: string;
+    constructor(fullMessage: string, templateName: string, tengoMessage: string, tengoStacktrace: string);
+    toString(): string;
+}
+/**
+ * Happens when a command fails to run.
+ */
+export declare class PlRunnerError extends Error {
+    readonly fullMessage: string;
+    readonly commandName: string;
+    readonly exitCode: number;
+    readonly stdout: string;
+    readonly workingDirectory: string;
+    message: string;
+    constructor(fullMessage: string, commandName: string, exitCode: number, stdout: string, workingDirectory: string);
+    toString(): string;
+}
+/**
+ * Happens when a monetization command fails to run.
+ */
+export declare class PlMonetizationError extends PlRunnerError {
+    message: string;
+    constructor(fullMessage: string, commandName: string, exitCode: number, stdout: string, workingDirectory: string);
+    toString(): string;
+}
+/**
+ * Parses a Pl error and suberrors from the Pl backend.
+ */
+export declare function parsePlError(error: string, resource?: ResourceId, resourceType?: ResourceType, field?: string): PlErrorReport;
+/**
+ * Reduces over the lines of the pl error message
+ * to extract messages, and categorizes them.
+ */
+export declare function parseSubErrors(message: string): PlCoreError[];
+//# sourceMappingURL=parsed_error.d.ts.map

package/dist/parsed_error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsed_error.d.ts","sourceRoot":"","sources":["../src/parsed_error.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAG/E,OAAO,EAAE,UAAU,EAAsB,YAAY,EAAwB,MAAM,2BAA2B,CAAC;AAE/G;;;GAGG;AACH,qBAAa,aAAc,SAAQ,KAAK;IAIpC,wCAAwC;aACxB,WAAW,EAAE,MAAM;IAEnC,sDAAsD;aACtC,WAAW,EAAE,MAAM;IAEnC,2EAA2E;aAC3D,SAAS,EAAE,MAAM;IAEjC,0EAA0E;aAC1D,MAAM,EAAE,WAAW,EAAE;IAErC,+DAA+D;aAC/C,SAAS,CAAC,EAAE,MAAM;aAClB,QAAQ,CAAC,EAAE,UAAU;aACrB,YAAY,CAAC,EAAE,YAAY;IAlB7C,OAAO,EAAE,MAAM,CAAC;;IAGd,wCAAwC;IACxB,WAAW,EAAE,MAAM;IAEnC,sDAAsD;IACtC,WAAW,EAAE,MAAM;IAEnC,2EAA2E;IAC3D,SAAS,EAAE,MAAM;IAEjC,0EAA0E;IAC1D,MAAM,EAAE,WAAW,EAAE;IAErC,+DAA+D;IAC/C,SAAS,CAAC,EAAE,MAAM,YAAA,EAClB,QAAQ,CAAC,EAAE,UAAU,YAAA,EACrB,YAAY,CAAC,EAAE,YAAY,YAAA;IAO7C,QAAQ;CAWT;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,eAAe,GACf,YAAY,GACZ,aAAa,GACb,mBAAmB,CAAC;AAExB;;GAEG;AACH,qBAAa,eAAgB,SAAQ,KAAK;aAEtB,OAAO,EAAE,MAAM;gBAAf,OAAO,EAAE,MAAM;CAKlC;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,KAAK;aAInB,WAAW,EAAE,MAAM;aACnB,YAAY,EAAE,MAAM;aACpB,YAAY,EAAE,MAAM;aACpB,eAAe,EAAE,MAAM;IANzC,OAAO,EAAE,MAAM,CAAC;gBAGE,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM;IAOzC,QAAQ;CAWT;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,KAAK;aAIpB,WAAW,EAAE,MAAM;aACnB,WAAW,EAAE,MAAM;aACnB,QAAQ,EAAE,MAAM;aAChB,MAAM,EAAE,MAAM;aACd,gBAAgB,EAAE,MAAM;IAP1C,OAAO,EAAE,MAAM,CAAC;gBAGE,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,MAAM;IAO1C,QAAQ;CAWT;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,OAAO,EAAE,MAAM,CAAC;gBAGd,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,MAAM;IAO1B,QAAQ;CAWT;AAUD;;GAEG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EAEb,QAAQ,CAAC,EAAE,UAAU,EACrB,YAAY,CAAC,EAAE,YAAY,EAC3B,KAAK,CAAC,EAAE,MAAM,GACb,aAAa,CAcf;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,EAAE,CA+B7D"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@milaboratories/pl-errors",
+  "version": "1.0.1",
+  "description": "Parsing errors from Pl backend",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "./dist/**/*",
+    "./src/**/*"
+  ],
+  "dependencies": {
+    "zod": "~3.23.8",
+    "@milaboratories/pl-client": "2.7.12"
+  },
+  "devDependencies": {
+    "typescript": "~5.5.4",
+    "vite": "^5.4.11",
+    "vitest": "^2.1.8",
+    "@milaboratories/platforma-build-configs": "1.0.2",
+    "@milaboratories/eslint-config": "^1.0.1"
+  },
+  "scripts": {
+    "type-check": "tsc --noEmit --composite false",
+    "build": "vite build",
+    "test": "vitest",
+    "do-pack": "rm -f *.tgz && pnpm pack && mv *.tgz package.tgz"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './parsed_error';

package/src/parsed_error.test.ts

@@ -0,0 +1,84 @@
+import { ResourceId, resourceIdFromString, stringifyWithResourceId } from "@milaboratories/pl-client";
+import { parsePlError, parseSubErrors, PlMonetizationError, PlErrorReport, PlRunnerError, PlTengoError } from './parsed_error';
+import { describe, it, expect } from 'vitest';
+
+const runnerError = '{"errorType":"","message":"\\"NG:0x2331A5\\" has 1 input errors:\\n[I] \\"NG:0x2331A5/blob\\": \\"NG:0x2331A4\\" has 1 input errors:\\n[I] \\"NG:0x2331A4/resource\\": \\"NG:0x2331CD\\" has 1 input errors:\\n[I] \\"NG:0x2331CD/resource\\": \\"NG:0x2331CA\\" has 1 input errors:\\n[I] \\"NG:0x2331CA/inputs\\": \\"NG:0x2331CB\\" has 1 input errors:\\n[I] \\"NG:0x2331CB/workdir\\": working directory: \\"workdirs/0x2331E0\\"\\nfailed to run command: \\"java\\" exited with code 22.\\nHere is the latest command output:\\n\\tLicense manager thread died.\\n\\t=== No License ===\\n\\t\\n\\tTo use MiXCR, please, provide a valid license.\\n\\t\\n\\tIf you already have a license, activate it by calling:\\n\\t  mixcr activate-license\\n\\t\\n\\t\\n"}'
+
+const tengoError = "{\"errorType\":\"\",\"message\":\"\\\"NG:0x16A\\\" has 1 input errors:\\n[I] \\\"NG:0x16A/resource\\\": cannot eval code: cannot eval template: template: @platforma-open/milaboratories.samples-and-data.workflow:main@1.10.0\\n\\tRuntime Error: File handle not set for \\\"R1\\\" in sample \\\"S63UG7K2IRZSSMAI4UVB5CNJ\\\"\\n\\tat @platforma-sdk/workflow-tengo:ll:25:1\\n\\tat @platforma-open/milaboratories.samples-and-data.workflow:main:205:7\\n\\tat @platforma-sdk/workflow-tengo:workflow:264:11\\n\\tat @platforma-sdk/workflow-tengo:tpl:470:11\\n\\tat @platforma-sdk/workflow-tengo:tpl:373:1\\n\\tat @platforma-sdk/workflow-tengo:workflow:261:1\\n\\tat @platforma-open/milaboratories.samples-and-data.workflow:main:35:1\"}"
+
+const monetizationSubErrors = `"NG:0x1F94C0" has 1 input errors:
+[I] "NG:0x1F94C0/resource": "NG:0x1F94FA" has 1 input errors:
+[I] "NG:0x1F94FA/resource": "NG:0x1F94F5" has 1 input errors:
+[I] "NG:0x1F94F5/inputs": "NG:0x1F94F6" has 1 input errors:
+[I] "NG:0x1F94F6/workdir": "NG:0x1F94F0" has 2 input errors:
+[I] "NG:0x1F94F0/refs": "NG:0x1F94F1" has 1 input errors:
+[I] "NG:0x1F94F1/monetization": "NG:0x1F94EE" has 1 input errors:
+[I] "NG:0x1F94EE/resource": "NG:0x1F94EC" has 1 input errors:
+[I] "NG:0x1F94EC/inputs": "NG:0x1F94ED" has 1 input errors:
+[I] "NG:0x1F94ED/resource": "NG:0x1F94EB" has 1 input errors:
+[I] "NG:0x1F94EB/resource": "NG:0x1F94E6" has 1 input errors:
+[I] "NG:0x1F94E6/resource": "NG:0x1F94E2" has 1 input errors:
+[I] "NG:0x1F94E2/inputs": "NG:0x1F94E3" has 1 input errors:
+[I] "NG:0x1F94E3/workdir": working directory: "workdirs/0x1F9514"
+failed to run command: "/home/snyssfx/PlatformaDev/local/packages/installed/platforma-open/platforma-open/milaboratories.software-small-binaries.mnz-client/main/1.5.9-linux-x64.0x1F1A04/mnz-client" exited with code 1.
+Here is the latest command output:
+	2025/03/13 17:25:18 get API error: VALIDATION_ERR Invalid /mnz/run-spec body: field productKey -> Invalid product key
+[I] "NG:0x1F94F0/workdirIn": "NG:0x1F94E9" has 1 input errors:
+[O] "NG:0x1F94E9/resource": "NG:0x1F94E2" has 1 input errors:
+[U] "NG:0x1F94E2/inputs": "NG:0x1F94E3" has 1 input errors:
+[MTW] "NG:0x1F94E3/workdir": working directory: "workdirs/0x1F9514"
+failed to run command: "/home/snyssfx/PlatformaDev/local/packages/installed/platforma-open/platforma-open/milaboratories.software-small-binaries.mnz-client/main/1.5.9-linux-x64.0x1F1A04/mnz-client" exited with code 1.
+Here is the latest command output:
+	2025/03/13 17:25:18 get API error: VALIDATION_ERR Invalid /mnz/run-spec body: field productKey -> Invalid product key`
+
+describe('parsePlError', () => {
+  it('should parse runner error correctly', () => {
+    const result = parsePlError(runnerError, resourceIdFromString('NG:0x2331A5')! as ResourceId, { name: 'RunCommand', version: "1" }, 'fieldName',);
+
+    expect(result).toBeInstanceOf(PlErrorReport);
+    expect(result.name).toBe('PlErrorReport');
+    expect(result.plErrorType).toBe('');
+    expect(result.fieldName).toBe('fieldName');
+    expect(stringifyWithResourceId(result.resource)).toBe('\"NG:0x2331a5\"');
+
+    expect(result.errors.length).toBe(1);
+    expect(result.errors[0]).toBeInstanceOf(PlRunnerError);
+    expect((result.errors[0] as PlRunnerError).commandName).toBe('java');
+    expect((result.errors[0] as PlRunnerError).exitCode).toBe(22);
+    expect((result.errors[0] as PlRunnerError).stdout).toBeDefined();
+    expect((result.errors[0] as PlRunnerError).workingDirectory).toBe('workdirs/0x2331E0');
+  });
+
+  it('should parse workflow error correctly', () => {
+    const result = parsePlError(tengoError, resourceIdFromString('NG:0x16A')! as ResourceId, { name: 'RunCommand', version: "1" }, 'fieldName');
+
+    expect(result).toBeInstanceOf(PlErrorReport);
+    expect(result.name).toBe('PlErrorReport');
+    expect(result.plErrorType).toBe('');
+    expect(result.fieldName).toBe('fieldName');
+    expect(stringifyWithResourceId(result.resource)).toBe('\"NG:0x16a\"');
+
+    expect(result.errors.length).toBe(1);
+    expect(result.errors[0]).toBeInstanceOf(PlTengoError);
+    expect((result.errors[0] as PlTengoError).templateName).toBe('@platforma-open/milaboratories.samples-and-data.workflow:main@1.10.0');
+    expect((result.errors[0] as PlTengoError).tengoMessage).toBe('Runtime Error: File handle not set for "R1" in sample "S63UG7K2IRZSSMAI4UVB5CNJ"');
+  });
+
+  it('should parse monetization sub errors correctly', () => {
+    const result = parseSubErrors(monetizationSubErrors);
+
+    expect(result.length).toBe(2);
+
+    expect(result[0]).toBeInstanceOf(PlMonetizationError);
+    expect((result[0] as PlMonetizationError).commandName).toContain('mnz-client');
+    expect((result[0] as PlMonetizationError).exitCode).toBe(1);
+    expect((result[0] as PlMonetizationError).stdout).toBeDefined();
+    expect((result[0] as PlMonetizationError).workingDirectory).toBe('workdirs/0x1F9514');
+
+    expect(result[1]).toBeInstanceOf(PlMonetizationError);
+    expect((result[1] as PlMonetizationError).commandName).toContain('mnz-client');
+    expect((result[1] as PlMonetizationError).exitCode).toBe(1);
+    expect((result[1] as PlMonetizationError).stdout).toBeDefined();
+    expect((result[1] as PlMonetizationError).workingDirectory).toBe('workdirs/0x1F9514');
+  });
+});

package/src/parsed_error.ts

@@ -0,0 +1,276 @@
+/** Pl Backend throws arbitrary errors, and we're trying to parse them here. */
+
+import { z } from "zod";
+import { ResourceId, resourceIdToString, ResourceType, resourceTypeToString } from "@milaboratories/pl-client";
+
+/**
+ * A parsed error from the Pl backend.
+ * It contains several suberrors, which could be one or different causes of the error.
+ */
+export class PlErrorReport extends Error {
+  message: string;
+
+  constructor(
+    /** Full message from the Pl backend. */
+    public readonly fullMessage: string,
+
+    /** Either CID conflict or a error from controller. */
+    public readonly plErrorType: string,
+
+    /** Parsed pl backend message that will be futher parsed into suberrors. */
+    public readonly plMessage: string,
+
+    /** Could be several different errors, the name is from AggregateError. */
+    public readonly errors: PlCoreError[],
+
+    /** Optional info about a resource where the error happened. */
+    public readonly fieldName?: string,
+    public readonly resource?: ResourceId,
+    public readonly resourceType?: ResourceType,
+  ) {
+    super(fullMessage);
+    this.name = 'PlErrorReport';
+    this.message = this.toString();
+  }
+
+  toString() {
+    const rt = this.resourceType ? `${resourceTypeToString(this.resourceType)},` : '';
+    const r = this.resource ? resourceIdToString(this.resource) : '';
+    const f = this.fieldName ? `/${this.fieldName}` : '';
+    const errType = this.plErrorType ? `error type: ${this.plErrorType}` : '';
+    const subErrors = this.errors.map(e => e.message).join('\n\n');
+
+    return `PlErrorReport: resource: ${rt} ${r}${f}
+${errType}
+${subErrors}`;
+  }
+}
+
+/**
+ * A suberror of a parsed error.
+ */
+export type PlCoreError =
+  | PlInternalError
+  | PlTengoError
+  | PlRunnerError
+  | PlMonetizationError;
+
+/**
+ * An general error when we couldn't parse the cause.
+ */
+export class PlInternalError extends Error {
+  constructor(
+    public readonly message: string,
+  ) {
+    super(message);
+    this.name = 'PlInternalError';
+  }
+}
+
+/**
+ * Happens when workflow template panics.
+ */
+export class PlTengoError extends Error {
+  message: string;
+
+  constructor(
+    public readonly fullMessage: string,
+    public readonly templateName: string,
+    public readonly tengoMessage: string,
+    public readonly tengoStacktrace: string,
+  ) {
+    super(fullMessage);
+    this.name = 'PlWorkflowError';
+    this.message = this.toString();
+  }
+
+  toString() {
+    return `PlWorkflowError:
+template: ${this.templateName}
+message:
+${this.tengoMessage}
+tengo stacktrace:
+${this.tengoStacktrace}
+
+full message:
+${this.fullMessage}`;
+  }
+}
+
+/**
+ * Happens when a command fails to run.
+ */
+export class PlRunnerError extends Error {
+  message: string;
+
+  constructor(
+    public readonly fullMessage: string,
+    public readonly commandName: string,
+    public readonly exitCode: number,
+    public readonly stdout: string,
+    public readonly workingDirectory: string,
+  ) {
+    super(fullMessage);
+    this.name = 'PlRunnerError';
+    this.message = this.toString();
+  }
+
+  toString() {
+    return `PlRunnerError:
+command: ${this.commandName}
+exit code: ${this.exitCode}
+working directory: ${this.workingDirectory}
+stdout:
+${this.stdout}
+
+full message:
+${this.fullMessage}`;
+  }
+}
+
+/**
+ * Happens when a monetization command fails to run.
+ */
+export class PlMonetizationError extends PlRunnerError {
+  message: string;
+
+  constructor(
+    fullMessage: string,
+    commandName: string,
+    exitCode: number,
+    stdout: string,
+    workingDirectory: string,
+  ) {
+    super(fullMessage, commandName, exitCode, stdout, workingDirectory);
+    this.name = 'PlMonetizationError';
+    this.message = this.toString();
+  }
+
+  toString() {
+    return `PlMonetizationError:
+command: ${this.commandName}
+exit code: ${this.exitCode}
+working directory: ${this.workingDirectory}
+stdout:
+${this.stdout}
+
+full message:
+${this.fullMessage}`;
+  }
+}
+
+/**
+ * How the Pl backend represents an error.
+ */
+const backendErrorSchema = z.object({
+  errorType: z.string(),
+  message: z.string(),
+});
+
+/**
+ * Parses a Pl error and suberrors from the Pl backend.
+ */
+export function parsePlError(
+  error: string,
+
+  resource?: ResourceId,
+  resourceType?: ResourceType,
+  field?: string,
+): PlErrorReport {
+  const parsed = backendErrorSchema.parse(JSON.parse(error));
+  const subErrors = parseSubErrors(parsed.message);
+
+  return new PlErrorReport(
+    error,
+    parsed.errorType,
+    parsed.message,
+    subErrors,
+
+    field,
+    resource,
+    resourceType,
+  );
+}
+
+/**
+ * Reduces over the lines of the pl error message
+ * to extract messages, and categorizes them.
+ */
+export function parseSubErrors(message: string): PlCoreError[] {
+  // the state of this reducing function
+  const state = {
+    stage: 'initial' as 'initial' | 'path' | 'message',
+    value: [] as string[],
+    result: [] as PlCoreError[],
+  };
+
+  for (const line of message.split('\n')) {
+    if (state.stage == 'initial') {
+      // we need initial stage because apparently the first line
+      // of the error doesn't have [I], but is a path line.
+      state.stage = 'path';
+
+    } else if (state.stage == 'path' && !isPath(line)) {
+      state.stage = 'message';
+
+    } else if (state.stage == 'message' && isPath(line)) {
+      state.stage = 'path';
+      const text = state.value.join('\n');
+      state.result.push(parseCoreError(text));
+      state.value = [];
+    }
+
+    state.value.push(line);
+  }
+
+  const text = state.value.join('\n');
+  state.result.push(parseCoreError(text));
+
+  return state.result;
+}
+
+function isPath(line: string): boolean {
+  for (const fieldType of ['U', 'I', 'O', 'S', 'OTW', 'D', 'MTW']) {
+    if (line.startsWith(`[${fieldType}]`))
+      return true;
+  }
+
+  return false;
+}
+
+/**
+ * Parses a suberror from the Pl backend.
+ */
+function parseCoreError(message: string): PlCoreError {
+  // trying to parse a runner or monetization error.
+  // https://regex101.com/r/tmKLj7/1
+  const runnerErrorRegex = /working directory: "(.*)"[\s\S]failed to run command: "([^"]+)" exited with code (\d+)\.[\s\S]*?Here is the latest command output:[\s\S]*?\t([\s\S]*)/;
+  const match = message.match(runnerErrorRegex);
+  if (match) {
+    const workingDirectory = match[1];
+    const command = match[2];
+    const exitCode = parseInt(match[3], 10);
+    const stdout = match[4].trim();
+
+    if (command.endsWith(`mnz-client`) && exitCode == 1) {
+      return new PlMonetizationError(message, command, exitCode, stdout, workingDirectory);
+    }
+
+    return new PlRunnerError(message, command, exitCode, stdout, workingDirectory);
+  }
+
+  // trying to parse a Tengo error.
+  // https://regex101.com/r/1a7RpO/1
+  const workflowErrorRegex = /cannot eval code: cannot eval template: template: (.+)\n\t(.*?)\n\t(at [\s\S]*)/;
+  const workflowMatch = message.match(workflowErrorRegex);
+  if (workflowMatch) {
+    const templateName = workflowMatch[1];
+    const errorMessage = workflowMatch[2];
+    const stackTrace = workflowMatch[3];
+
+    return new PlTengoError(message, templateName, errorMessage, stackTrace);
+  }
+
+  // if we couldn't parse the error, return a general error.
+  return new PlInternalError(message);
+}