@fgv/ts-utils 2.0.1-alpha.0 → 2.1.0

package/lib/packlets/record-jar/recordJarHelpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"recordJarHelpers.js","sourceRoot":"","sources":["../../../src/packlets/record-jar/recordJarHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,2CAA6B;AAE7B,kCAAwE;AA4BxE,MAAM,YAAY;IAQhB,gEAAgE;IAChE,YAAoB,OAAgC;QARpC,YAAO,GAAgB,EAAE,CAAC;QAGhC,YAAO,GAAc,EAAE,CAAC;QACxB,UAAK,GAAuB,SAAS,CAAC;QACtC,UAAK,GAA4B,SAAS,CAAC;QAInD,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;IAC/B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,KAAe,EAAE,OAAgC;QACnE,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;IAES,MAAM,CAAC,gBAAgB,CAAC,IAAY;QAC5C,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,cAAc,EAAE;YAClB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACvC;QACD,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;YAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;gBACtB,OAAO,IAAA,WAAI,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC;aAC7B;YACD,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC;SACrB;QACD,OAAO,IAAA,cAAO,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;IAC3C,CAAC;IAES,MAAM,CAAC,WAAW,CAAC,IAAY;QACvC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAES,MAAM,CAAC,eAAe,CAAC,IAAY;QAC3C,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,+BAA+B,EAAE,CAAC,KAAK,EAAE,EAAE;YACtE,QAAQ,KAAK,EAAE;gBACb,KAAK,MAAM;oBACT,OAAO,IAAI,CAAC;gBACd,KAAK,KAAK;oBACR,OAAO,GAAG,CAAC;gBACb,KAAK,KAAK;oBACR,OAAO,IAAI,CAAC;gBACd,KAAK,KAAK;oBACR,OAAO,IAAI,CAAC;gBACd,KAAK,KAAK;oBACR,OAAO,IAAI,CAAC;aACf;YACD,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;gBACzB,MAAM,OAAO,GAAG,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;gBACxD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAC9C,OAAO,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACtC;YACD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,OAAO,IAAA,WAAI,EAAC,wBAAwB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;SAC/E;QACD,OAAO,IAAA,cAAO,EAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAES,MAAM,CAAC,aAAa,CAAC,MAAiB,EAAE,OAA+B;QAC/E,IAAI,OAAO,CAAC,WAAW,EAAE;YACvB,MAAM,qBAAQ,MAAM,CAAE,CAAC,CAAC,6BAA6B;YACrD,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;gBACpD,CAAC,CAAC,OAAO,CAAC,WAAW;gBACrB,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAEhC,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE;gBAC/B,IAAI,IAAA,cAAO,EAAC,KAAK,EAAE,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE;oBAC/D,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAW,CAAC;oBACxC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;iBAC3B;aACF;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,MAAM,CAAC,KAAe;;QAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,cAAc,CAAA,EAAE;gBACxD,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAC1C,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;oBACtB,OAAO,IAAA,WAAI,EAAC,GAAG,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;iBACxC;aACF;iBAAM,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC7B,6CAA6C;gBAC7C,IAAI,IAAI,CAAC,KAAK,EAAE;oBACd,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,KAAK,CAAC;iBACnC;gBACD,SAAS;aACV;iBAAM,IAAI,CAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,cAAc,KAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC1D,4EAA4E;gBAC5E,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;oBAC5B,OAAO,IAAA,WAAI,EAAC,GAAG,CAAC,oBAAoB,IAAI,yBAAyB,CAAC,CAAC;iBACpE;gBACD,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;gBAC7C,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;oBACtB,OAAO,IAAA,WAAI,EAAC,GAAG,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;iBACxC;gBACD,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;aAC3B;iBAAM;gBACL,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtC,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;oBACtB,OAAO,IAAA,WAAI,EAAC,GAAG,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;iBACxC;aACF;SACF;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC1C,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;YACtB,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;SACnD;QACD,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAES,WAAW,CAAC,IAAY;QAChC,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,cAAc,GAAG,CAAC,EAAE;YACtB,OAAO,IAAA,WAAI,EAAC,oBAAoB,IAAI,mBAAmB,CAAC,CAAC;SAC1D;QACD,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC;QAE9E,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE;YAC9C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChC,OAAO,YAAY,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;gBACvE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;gBAClB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB,CAAC,IAAY;;QACvC,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAM,CAAC,cAAc,EAAE;YAC/B,uBAAuB;YACvB,MAAM,SAAS,GAAG,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,qBAAqB,mCAAI,CAAC,CAAC;YAC3D,IAAI,SAAS,GAAG,CAAC,EAAE;gBACjB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,SAAS,EAAE;oBAC5C,sBAAsB;oBACtB,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;iBACjC;aACF;SACF;QACD,OAAO,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;YAClE,OAAO,IAAA,cAAO,EAAC;gBACb,IAAI,EAAE,GAAG,IAAI,CAAC,KAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE;gBAC1C,cAAc,EAAE,OAAO,CAAC,cAAc;aACvC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB;QAC1B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAC9C,CAAC;IAES,mBAAmB;QAC3B,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE;YAC9C,IAAI,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,IAAI,MAAM,KAAK,SAAS,EAAE;gBACxB,MAAM,GAAG,YAAY,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC1D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC1B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;aACnB;YACD,OAAO,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB;QAC1B,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;YAC5B,IAAI,IAAI,CAAC,KAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC/B,OAAO,IAAA,WAAI,EAAC,8BAA8B,CAAC,CAAC;aAC7C;YACD,IAAI,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE;gBACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAM,CAAC,IAAI,CAAC;aAC7C;iBAAM,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE;gBACvD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAW,CAAC;gBACnD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,KAAM,CAAC,IAAI,CAAC,CAAC;aACxD;iBAAM;gBACL,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAa,CAAC;gBACrD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAM,CAAC,IAAI,CAAC,CAAC;aAChC;YACD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACvB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;SACxB;QACD,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;IACvB,CAAC;CACF;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,KAAe,EAAE,OAAgC;IACnF,OAAO,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAC5C,CAAC;AAFD,kDAEC;AAED;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,OAAe,EACf,OAAgC;IAEhC,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;QACrB,OAAO,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC;AAVD,sDAUC","sourcesContent":["/*\n * Copyright (c) 2022 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as fs from 'fs';\nimport * as path from 'path';\n\nimport { Result, captureResult, fail, isKeyOf, succeed } from '../base';\n\ninterface IRecordBody {\n  body: string;\n  isContinuation: boolean;\n}\n\n/**\n * Represents a single record in a JAR file\n * @public\n */\nexport type JarRecord = Record<string, string | string[]>;\n\n/**\n * @public\n */\nexport type JarFieldPicker<T extends JarRecord = JarRecord> = (record: T) => (keyof T)[];\n\n/**\n * Options for a JAR record parser.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface JarRecordParserOptions {\n  readonly arrayFields?: string[] | JarFieldPicker;\n  readonly fixedContinuationSize?: number;\n}\n\nclass RecordParser {\n  public readonly records: JarRecord[] = [];\n  public readonly options: JarRecordParserOptions;\n\n  protected _fields: JarRecord = {};\n  protected _name: string | undefined = undefined;\n  protected _body: IRecordBody | undefined = undefined;\n\n  // eslint-disable-next-line @typescript-eslint/no-empty-function\n  private constructor(options?: JarRecordParserOptions) {\n    this.options = options ?? {};\n  }\n\n  public static parse(lines: string[], options?: JarRecordParserOptions): Result<JarRecord[]> {\n    return new RecordParser(options)._parse(lines);\n  }\n\n  protected static _parseRecordBody(body: string): Result<IRecordBody> {\n    const isContinuation = body.endsWith('\\\\');\n    if (isContinuation) {\n      body = body.slice(0, body.length - 1);\n    }\n    if (this._hasEscapes(body)) {\n      const result = this._replaceEscapes(body);\n      if (result.isFailure()) {\n        return fail(result.message);\n      }\n      body = result.value;\n    }\n    return succeed({ body, isContinuation });\n  }\n\n  protected static _hasEscapes(from: string): boolean {\n    return from.includes('\\\\') || from.includes('&');\n  }\n\n  protected static _replaceEscapes(body: string): Result<string> {\n    const invalid: string[] = [];\n    const escaped = body.replace(/(\\\\.)|(&#x[a-fA-F0-9]{2,6};)/g, (match) => {\n      switch (match) {\n        case '\\\\\\\\':\n          return '\\\\';\n        case '\\\\&':\n          return '&';\n        case '\\\\r':\n          return '\\r';\n        case '\\\\n':\n          return '\\n';\n        case '\\\\t':\n          return '\\t';\n      }\n      if (match.startsWith('&')) {\n        const hexCode = `0x${match.slice(3, match.length - 1)}`;\n        const charCode = Number.parseInt(hexCode, 16);\n        return String.fromCharCode(charCode);\n      }\n      invalid.push(match);\n      return '\\\\';\n    });\n    if (invalid.length > 0) {\n      return fail(`unrecognized escape \"${invalid.join(', ')}\" in record-jar body`);\n    }\n    return succeed(escaped);\n  }\n\n  protected static _applyOptions(record: JarRecord, options: JarRecordParserOptions): JarRecord {\n    if (options.arrayFields) {\n      record = { ...record }; // don't edit incoming values\n      const arrayFields = Array.isArray(options.arrayFields)\n        ? options.arrayFields\n        : options.arrayFields(record);\n\n      for (const field of arrayFields) {\n        if (isKeyOf(field, record) && typeof record[field] === 'string') {\n          const current = record[field] as string;\n          record[field] = [current];\n        }\n      }\n    }\n    return record;\n  }\n\n  protected _parse(lines: string[]): Result<JarRecord[]> {\n    for (let n = 0; n < lines.length; n++) {\n      const line = lines[n];\n      if (line.startsWith('%%') && !this._body?.isContinuation) {\n        const result = this._writePendingRecord();\n        if (result.isFailure()) {\n          return fail(`${n}: ${result.message}`);\n        }\n      } else if (/^\\s*$/.test(line)) {\n        // ignore blank lines but cancel continuation\n        if (this._body) {\n          this._body.isContinuation = false;\n        }\n        continue;\n      } else if (this._body?.isContinuation || /^\\s+/.test(line)) {\n        // explicit continuation on previous line or implicit starts with whitespace\n        if (this._body === undefined) {\n          return fail(`${n}: continuation (\"${line}\") without prior value.`);\n        }\n        const result = this._parseContinuation(line);\n        if (result.isFailure()) {\n          return fail(`${n}: ${result.message}`);\n        }\n        this._body = result.value;\n      } else {\n        const result = this._parseField(line);\n        if (result.isFailure()) {\n          return fail(`${n}: ${result.message}`);\n        }\n      }\n    }\n\n    const result = this._writePendingRecord();\n    if (result.isFailure()) {\n      return fail(`${lines.length}: ${result.message}`);\n    }\n    return succeed(this.records);\n  }\n\n  protected _parseField(line: string): Result<boolean> {\n    const separatorIndex = line.indexOf(':');\n    if (separatorIndex < 1) {\n      return fail(`malformed line (\"${line}\") in record-jar.`);\n    }\n    const parts = [line.slice(0, separatorIndex), line.slice(separatorIndex + 1)];\n\n    return this._writePendingField().onSuccess(() => {\n      this._name = parts[0].trimEnd();\n      return RecordParser._parseRecordBody(parts[1].trim()).onSuccess((body) => {\n        this._body = body;\n        return succeed(true);\n      });\n    });\n  }\n\n  protected _parseContinuation(line: string): Result<IRecordBody> {\n    let trimmed = line.trim();\n    if (!this._body!.isContinuation) {\n      // istanbul ignore next\n      const fixedSize = this.options?.fixedContinuationSize ?? 0;\n      if (fixedSize > 0) {\n        if (trimmed.length < line.length - fixedSize) {\n          // oops, took too much\n          trimmed = line.slice(fixedSize);\n        }\n      }\n    }\n    return RecordParser._parseRecordBody(trimmed).onSuccess((newBody) => {\n      return succeed({\n        body: `${this._body!.body}${newBody.body}`,\n        isContinuation: newBody.isContinuation\n      });\n    });\n  }\n\n  protected _havePendingRecord(): boolean {\n    return Object.keys(this._fields).length > 0;\n  }\n\n  protected _writePendingRecord(): Result<JarRecord | undefined> {\n    return this._writePendingField().onSuccess(() => {\n      let record = this._havePendingRecord() ? this._fields : undefined;\n      if (record !== undefined) {\n        record = RecordParser._applyOptions(record, this.options);\n        this.records.push(record);\n        this._fields = {};\n      }\n      return succeed(undefined);\n    });\n  }\n\n  protected _writePendingField(): Result<boolean> {\n    if (this._name !== undefined) {\n      if (this._body!.body.length < 1) {\n        return fail('empty body value not allowed');\n      }\n      if (!isKeyOf(this._name, this._fields)) {\n        this._fields[this._name] = this._body!.body;\n      } else if (typeof this._fields[this._name] === 'string') {\n        const current = this._fields[this._name] as string;\n        this._fields[this._name] = [current, this._body!.body];\n      } else {\n        const current = this._fields[this._name] as string[];\n        current.push(this._body!.body);\n      }\n      this._name = undefined;\n      this._body = undefined;\n    }\n    return succeed(true);\n  }\n}\n\n/**\n * Reads a record-jar from an array of strings, each of which represents one\n * line in the source file.\n * @param lines - the array of strings to be parsed\n * @param options - Optional parser configuration\n * @returns a corresponding array of `Record<string, string>`\n * @public\n */\nexport function parseRecordJarLines(lines: string[], options?: JarRecordParserOptions): Result<JarRecord[]> {\n  return RecordParser.parse(lines, options);\n}\n\n/**\n * Reads a record-jar file from a supplied path.\n * @param srcPath - Source path from which the file is read.\n * @param options - Optional parser configuration\n * @returns The contents of the file as an array of `Record<string, string>`\n * @see https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01\n * @public\n */\nexport function readRecordJarFileSync(\n  srcPath: string,\n  options?: JarRecordParserOptions\n): Result<JarRecord[]> {\n  return captureResult(() => {\n    const fullPath = path.resolve(srcPath);\n    return fs.readFileSync(fullPath, 'utf8').toString().split(/\\r?\\n/);\n  }).onSuccess((lines) => {\n    return parseRecordJarLines(lines, options);\n  });\n}\n"]}
+{"version":3,"file":"recordJarHelpers.js","sourceRoot":"","sources":["../../../src/packlets/record-jar/recordJarHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,2CAA6B;AAE7B,kCAAwE;AA4BxE,MAAM,YAAY;IAQhB,gEAAgE;IAChE,YAAoB,OAAgC;QARpC,YAAO,GAAgB,EAAE,CAAC;QAGhC,YAAO,GAAc,EAAE,CAAC;QACxB,UAAK,GAAuB,SAAS,CAAC;QACtC,UAAK,GAA4B,SAAS,CAAC;QAInD,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;IAC/B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,KAAe,EAAE,OAAgC;QACnE,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;IAES,MAAM,CAAC,gBAAgB,CAAC,IAAY;QAC5C,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,cAAc,EAAE;YAClB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACvC;QACD,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;YAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;gBACtB,OAAO,IAAA,WAAI,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC;aAC7B;YACD,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC;SACrB;QACD,OAAO,IAAA,cAAO,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;IAC3C,CAAC;IAES,MAAM,CAAC,WAAW,CAAC,IAAY;QACvC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAES,MAAM,CAAC,eAAe,CAAC,IAAY;QAC3C,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,+BAA+B,EAAE,CAAC,KAAK,EAAE,EAAE;YACtE,QAAQ,KAAK,EAAE;gBACb,KAAK,MAAM;oBACT,OAAO,IAAI,CAAC;gBACd,KAAK,KAAK;oBACR,OAAO,GAAG,CAAC;gBACb,KAAK,KAAK;oBACR,OAAO,IAAI,CAAC;gBACd,KAAK,KAAK;oBACR,OAAO,IAAI,CAAC;gBACd,KAAK,KAAK;oBACR,OAAO,IAAI,CAAC;aACf;YACD,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;gBACzB,MAAM,OAAO,GAAG,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;gBACxD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAC9C,OAAO,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACtC;YACD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,OAAO,IAAA,WAAI,EAAC,wBAAwB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;SAC/E;QACD,OAAO,IAAA,cAAO,EAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAES,MAAM,CAAC,aAAa,CAAC,MAAiB,EAAE,OAA+B;QAC/E,IAAI,OAAO,CAAC,WAAW,EAAE;YACvB,MAAM,qBAAQ,MAAM,CAAE,CAAC,CAAC,6BAA6B;YACrD,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;gBACpD,CAAC,CAAC,OAAO,CAAC,WAAW;gBACrB,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAEhC,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE;gBAC/B,IAAI,IAAA,cAAO,EAAC,KAAK,EAAE,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE;oBAC/D,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAW,CAAC;oBACxC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;iBAC3B;aACF;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,MAAM,CAAC,KAAe;;QAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,cAAc,CAAA,EAAE;gBACxD,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAC1C,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;oBACtB,OAAO,IAAA,WAAI,EAAC,GAAG,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;iBACxC;aACF;iBAAM,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC7B,6CAA6C;gBAC7C,IAAI,IAAI,CAAC,KAAK,EAAE;oBACd,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,KAAK,CAAC;iBACnC;gBACD,SAAS;aACV;iBAAM,IAAI,CAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,cAAc,KAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC1D,4EAA4E;gBAC5E,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;oBAC5B,OAAO,IAAA,WAAI,EAAC,GAAG,CAAC,oBAAoB,IAAI,yBAAyB,CAAC,CAAC;iBACpE;gBACD,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;gBAC7C,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;oBACtB,OAAO,IAAA,WAAI,EAAC,GAAG,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;iBACxC;gBACD,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;aAC3B;iBAAM;gBACL,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtC,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;oBACtB,OAAO,IAAA,WAAI,EAAC,GAAG,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;iBACxC;aACF;SACF;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC1C,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;YACtB,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;SACnD;QACD,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAES,WAAW,CAAC,IAAY;QAChC,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,cAAc,GAAG,CAAC,EAAE;YACtB,OAAO,IAAA,WAAI,EAAC,oBAAoB,IAAI,mBAAmB,CAAC,CAAC;SAC1D;QACD,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC;QAE9E,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE;YAC9C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChC,OAAO,YAAY,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;gBACvE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;gBAClB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB,CAAC,IAAY;;QACvC,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAM,CAAC,cAAc,EAAE;YAC/B,oBAAoB;YACpB,MAAM,SAAS,GAAG,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,qBAAqB,mCAAI,CAAC,CAAC;YAC3D,IAAI,SAAS,GAAG,CAAC,EAAE;gBACjB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,SAAS,EAAE;oBAC5C,sBAAsB;oBACtB,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;iBACjC;aACF;SACF;QACD,OAAO,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE;YAClE,OAAO,IAAA,cAAO,EAAC;gBACb,IAAI,EAAE,GAAG,IAAI,CAAC,KAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE;gBAC1C,cAAc,EAAE,OAAO,CAAC,cAAc;aACvC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB;QAC1B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAC9C,CAAC;IAES,mBAAmB;QAC3B,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE;YAC9C,IAAI,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,IAAI,MAAM,KAAK,SAAS,EAAE;gBACxB,MAAM,GAAG,YAAY,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC1D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC1B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;aACnB;YACD,OAAO,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAES,kBAAkB;QAC1B,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;YAC5B,IAAI,IAAI,CAAC,KAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC/B,OAAO,IAAA,WAAI,EAAC,8BAA8B,CAAC,CAAC;aAC7C;YACD,IAAI,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE;gBACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAM,CAAC,IAAI,CAAC;aAC7C;iBAAM,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE;gBACvD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAW,CAAC;gBACnD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,KAAM,CAAC,IAAI,CAAC,CAAC;aACxD;iBAAM;gBACL,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAa,CAAC;gBACrD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAM,CAAC,IAAI,CAAC,CAAC;aAChC;YACD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACvB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;SACxB;QACD,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;IACvB,CAAC;CACF;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,KAAe,EAAE,OAAgC;IACnF,OAAO,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAC5C,CAAC;AAFD,kDAEC;AAED;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,OAAe,EACf,OAAgC;IAEhC,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;QACrB,OAAO,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC;AAVD,sDAUC","sourcesContent":["/*\n * Copyright (c) 2022 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as fs from 'fs';\nimport * as path from 'path';\n\nimport { Result, captureResult, fail, isKeyOf, succeed } from '../base';\n\ninterface IRecordBody {\n  body: string;\n  isContinuation: boolean;\n}\n\n/**\n * Represents a single record in a JAR file\n * @public\n */\nexport type JarRecord = Record<string, string | string[]>;\n\n/**\n * @public\n */\nexport type JarFieldPicker<T extends JarRecord = JarRecord> = (record: T) => (keyof T)[];\n\n/**\n * Options for a JAR record parser.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface JarRecordParserOptions {\n  readonly arrayFields?: string[] | JarFieldPicker;\n  readonly fixedContinuationSize?: number;\n}\n\nclass RecordParser {\n  public readonly records: JarRecord[] = [];\n  public readonly options: JarRecordParserOptions;\n\n  protected _fields: JarRecord = {};\n  protected _name: string | undefined = undefined;\n  protected _body: IRecordBody | undefined = undefined;\n\n  // eslint-disable-next-line @typescript-eslint/no-empty-function\n  private constructor(options?: JarRecordParserOptions) {\n    this.options = options ?? {};\n  }\n\n  public static parse(lines: string[], options?: JarRecordParserOptions): Result<JarRecord[]> {\n    return new RecordParser(options)._parse(lines);\n  }\n\n  protected static _parseRecordBody(body: string): Result<IRecordBody> {\n    const isContinuation = body.endsWith('\\\\');\n    if (isContinuation) {\n      body = body.slice(0, body.length - 1);\n    }\n    if (this._hasEscapes(body)) {\n      const result = this._replaceEscapes(body);\n      if (result.isFailure()) {\n        return fail(result.message);\n      }\n      body = result.value;\n    }\n    return succeed({ body, isContinuation });\n  }\n\n  protected static _hasEscapes(from: string): boolean {\n    return from.includes('\\\\') || from.includes('&');\n  }\n\n  protected static _replaceEscapes(body: string): Result<string> {\n    const invalid: string[] = [];\n    const escaped = body.replace(/(\\\\.)|(&#x[a-fA-F0-9]{2,6};)/g, (match) => {\n      switch (match) {\n        case '\\\\\\\\':\n          return '\\\\';\n        case '\\\\&':\n          return '&';\n        case '\\\\r':\n          return '\\r';\n        case '\\\\n':\n          return '\\n';\n        case '\\\\t':\n          return '\\t';\n      }\n      if (match.startsWith('&')) {\n        const hexCode = `0x${match.slice(3, match.length - 1)}`;\n        const charCode = Number.parseInt(hexCode, 16);\n        return String.fromCharCode(charCode);\n      }\n      invalid.push(match);\n      return '\\\\';\n    });\n    if (invalid.length > 0) {\n      return fail(`unrecognized escape \"${invalid.join(', ')}\" in record-jar body`);\n    }\n    return succeed(escaped);\n  }\n\n  protected static _applyOptions(record: JarRecord, options: JarRecordParserOptions): JarRecord {\n    if (options.arrayFields) {\n      record = { ...record }; // don't edit incoming values\n      const arrayFields = Array.isArray(options.arrayFields)\n        ? options.arrayFields\n        : options.arrayFields(record);\n\n      for (const field of arrayFields) {\n        if (isKeyOf(field, record) && typeof record[field] === 'string') {\n          const current = record[field] as string;\n          record[field] = [current];\n        }\n      }\n    }\n    return record;\n  }\n\n  protected _parse(lines: string[]): Result<JarRecord[]> {\n    for (let n = 0; n < lines.length; n++) {\n      const line = lines[n];\n      if (line.startsWith('%%') && !this._body?.isContinuation) {\n        const result = this._writePendingRecord();\n        if (result.isFailure()) {\n          return fail(`${n}: ${result.message}`);\n        }\n      } else if (/^\\s*$/.test(line)) {\n        // ignore blank lines but cancel continuation\n        if (this._body) {\n          this._body.isContinuation = false;\n        }\n        continue;\n      } else if (this._body?.isContinuation || /^\\s+/.test(line)) {\n        // explicit continuation on previous line or implicit starts with whitespace\n        if (this._body === undefined) {\n          return fail(`${n}: continuation (\"${line}\") without prior value.`);\n        }\n        const result = this._parseContinuation(line);\n        if (result.isFailure()) {\n          return fail(`${n}: ${result.message}`);\n        }\n        this._body = result.value;\n      } else {\n        const result = this._parseField(line);\n        if (result.isFailure()) {\n          return fail(`${n}: ${result.message}`);\n        }\n      }\n    }\n\n    const result = this._writePendingRecord();\n    if (result.isFailure()) {\n      return fail(`${lines.length}: ${result.message}`);\n    }\n    return succeed(this.records);\n  }\n\n  protected _parseField(line: string): Result<boolean> {\n    const separatorIndex = line.indexOf(':');\n    if (separatorIndex < 1) {\n      return fail(`malformed line (\"${line}\") in record-jar.`);\n    }\n    const parts = [line.slice(0, separatorIndex), line.slice(separatorIndex + 1)];\n\n    return this._writePendingField().onSuccess(() => {\n      this._name = parts[0].trimEnd();\n      return RecordParser._parseRecordBody(parts[1].trim()).onSuccess((body) => {\n        this._body = body;\n        return succeed(true);\n      });\n    });\n  }\n\n  protected _parseContinuation(line: string): Result<IRecordBody> {\n    let trimmed = line.trim();\n    if (!this._body!.isContinuation) {\n      /* c8 ignore next */\n      const fixedSize = this.options?.fixedContinuationSize ?? 0;\n      if (fixedSize > 0) {\n        if (trimmed.length < line.length - fixedSize) {\n          // oops, took too much\n          trimmed = line.slice(fixedSize);\n        }\n      }\n    }\n    return RecordParser._parseRecordBody(trimmed).onSuccess((newBody) => {\n      return succeed({\n        body: `${this._body!.body}${newBody.body}`,\n        isContinuation: newBody.isContinuation\n      });\n    });\n  }\n\n  protected _havePendingRecord(): boolean {\n    return Object.keys(this._fields).length > 0;\n  }\n\n  protected _writePendingRecord(): Result<JarRecord | undefined> {\n    return this._writePendingField().onSuccess(() => {\n      let record = this._havePendingRecord() ? this._fields : undefined;\n      if (record !== undefined) {\n        record = RecordParser._applyOptions(record, this.options);\n        this.records.push(record);\n        this._fields = {};\n      }\n      return succeed(undefined);\n    });\n  }\n\n  protected _writePendingField(): Result<boolean> {\n    if (this._name !== undefined) {\n      if (this._body!.body.length < 1) {\n        return fail('empty body value not allowed');\n      }\n      if (!isKeyOf(this._name, this._fields)) {\n        this._fields[this._name] = this._body!.body;\n      } else if (typeof this._fields[this._name] === 'string') {\n        const current = this._fields[this._name] as string;\n        this._fields[this._name] = [current, this._body!.body];\n      } else {\n        const current = this._fields[this._name] as string[];\n        current.push(this._body!.body);\n      }\n      this._name = undefined;\n      this._body = undefined;\n    }\n    return succeed(true);\n  }\n}\n\n/**\n * Reads a record-jar from an array of strings, each of which represents one\n * line in the source file.\n * @param lines - the array of strings to be parsed\n * @param options - Optional parser configuration\n * @returns a corresponding array of `Record<string, string>`\n * @public\n */\nexport function parseRecordJarLines(lines: string[], options?: JarRecordParserOptions): Result<JarRecord[]> {\n  return RecordParser.parse(lines, options);\n}\n\n/**\n * Reads a record-jar file from a supplied path.\n * @param srcPath - Source path from which the file is read.\n * @param options - Optional parser configuration\n * @returns The contents of the file as an array of `Record<string, string>`\n * @see https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01\n * @public\n */\nexport function readRecordJarFileSync(\n  srcPath: string,\n  options?: JarRecordParserOptions\n): Result<JarRecord[]> {\n  return captureResult(() => {\n    const fullPath = path.resolve(srcPath);\n    return fs.readFileSync(fullPath, 'utf8').toString().split(/\\r?\\n/);\n  }).onSuccess((lines) => {\n    return parseRecordJarLines(lines, options);\n  });\n}\n"]}

package/lib/packlets/validation/boolean.js

@@ -35,7 +35,7 @@ class BooleanValidator extends genericValidator_1.GenericValidator {
      * new {@link Validation.Classes.BooleanValidator | BooleanValidator}.
      */
     constructor(params) {
-        // istanbul ignore next
+        /* c8 ignore next */
         params = params !== null && params !== void 0 ? params : {};
         super(Object.assign({ validator: BooleanValidator.validateBoolean }, params));
     }

package/lib/packlets/validation/boolean.js.map

@@ -1 +1 @@
-{"version":3,"file":"boolean.js","sourceRoot":"","sources":["../../../src/packlets/validation/boolean.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAQzF;;;GAGG;AACH,MAAa,gBAA+B,SAAQ,mCAA6B;IAC/E;;;;OAIG;IACH,YAAmB,MAA8C;QAC/D,uBAAuB;QACvB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,KAAK,iBACH,SAAS,EAAE,gBAAgB,CAAC,eAAe,IACxC,MAAM,EACT,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,IAAa;QACzC,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE;YAC7B,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAA,WAAI,EAAC,IAAI,IAAI,kBAAkB,CAAC,CAAC;IAC1C,CAAC;CACF;AA3BD,4CA2BC","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n * @public\n */\nexport type BooleanValidatorConstructorParams<TC = unknown> = GenericValidatorConstructorParams<boolean, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `boolean` values.\n * @public\n */\nexport class BooleanValidator<TC = unknown> extends GenericValidator<boolean, TC> {\n  /**\n   * Constructs a new {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n   * @param params - Optional {@link Validation.Classes.BooleanValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n   */\n  public constructor(params?: BooleanValidatorConstructorParams<TC>) {\n    // istanbul ignore next\n    params = params ?? {};\n    super({\n      validator: BooleanValidator.validateBoolean,\n      ...params\n    });\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `boolean`.\n   * @param from - The `unknown` value to be tested.\n   * @returns Returns `true` if `from` is a `boolean`, or {@link Failure} with an error\n   * message if not.\n   */\n  public static validateBoolean(from: unknown): boolean | Failure<boolean> {\n    if (typeof from === 'boolean') {\n      return true;\n    }\n    return fail(`\"${from}\": not a boolean`);\n  }\n}\n"]}
+{"version":3,"file":"boolean.js","sourceRoot":"","sources":["../../../src/packlets/validation/boolean.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AACxC,yDAAyF;AAQzF;;;GAGG;AACH,MAAa,gBAA+B,SAAQ,mCAA6B;IAC/E;;;;OAIG;IACH,YAAmB,MAA8C;QAC/D,oBAAoB;QACpB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,KAAK,iBACH,SAAS,EAAE,gBAAgB,CAAC,eAAe,IACxC,MAAM,EACT,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,IAAa;QACzC,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE;YAC7B,OAAO,IAAI,CAAC;SACb;QACD,OAAO,IAAA,WAAI,EAAC,IAAI,IAAI,kBAAkB,CAAC,CAAC;IAC1C,CAAC;CACF;AA3BD,4CA2BC","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail } from '../base';\nimport { GenericValidator, GenericValidatorConstructorParams } from './genericValidator';\n\n/**\n * Parameters used to construct a {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n * @public\n */\nexport type BooleanValidatorConstructorParams<TC = unknown> = GenericValidatorConstructorParams<boolean, TC>;\n\n/**\n * An in-place {@link Validation.Validator | Validator} for `boolean` values.\n * @public\n */\nexport class BooleanValidator<TC = unknown> extends GenericValidator<boolean, TC> {\n  /**\n   * Constructs a new {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n   * @param params - Optional {@link Validation.Classes.BooleanValidatorConstructorParams | init params} for the\n   * new {@link Validation.Classes.BooleanValidator | BooleanValidator}.\n   */\n  public constructor(params?: BooleanValidatorConstructorParams<TC>) {\n    /* c8 ignore next */\n    params = params ?? {};\n    super({\n      validator: BooleanValidator.validateBoolean,\n      ...params\n    });\n  }\n\n  /**\n   * Static method which validates that a supplied `unknown` value is a `boolean`.\n   * @param from - The `unknown` value to be tested.\n   * @returns Returns `true` if `from` is a `boolean`, or {@link Failure} with an error\n   * message if not.\n   */\n  public static validateBoolean(from: unknown): boolean | Failure<boolean> {\n    if (typeof from === 'boolean') {\n      return true;\n    }\n    return fail(`\"${from}\": not a boolean`);\n  }\n}\n"]}

package/lib/packlets/validation/classes.d.ts

@@ -1,7 +1,7 @@
 export { ArrayValidator, ArrayValidatorConstructorParams } from './array';
-export { StringValidator, StringValidatorConstructorParams } from './string';
 export { BooleanValidator, BooleanValidatorConstructorParams } from './boolean';
 export { NumberValidator, NumberValidatorConstructorParams } from './number';
 export { FieldValidators, ObjectValidator, ObjectValidatorConstructorParams, ObjectValidatorOptions } from './object';
+export { StringValidator, StringValidatorConstructorParams } from './string';
 export { TypeGuardValidator, TypeGuardValidatorConstructorParams } from './typeGuard';
 //# sourceMappingURL=classes.d.ts.map

package/lib/packlets/validation/classes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"classes.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/classes.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,cAAc,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAC7E,OAAO,EAAE,gBAAgB,EAAE,iCAAiC,EAAE,MAAM,WAAW,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAC7E,OAAO,EACL,eAAe,EACf,eAAe,EACf,gCAAgC,EAChC,sBAAsB,EACvB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,kBAAkB,EAAE,mCAAmC,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"classes.d.ts","sourceRoot":"","sources":["../../../src/packlets/validation/classes.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,cAAc,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,iCAAiC,EAAE,MAAM,WAAW,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAC7E,OAAO,EACL,eAAe,EACf,eAAe,EACf,gCAAgC,EAChC,sBAAsB,EACvB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,eAAe,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,mCAAmC,EAAE,MAAM,aAAa,CAAC"}

package/lib/packlets/validation/classes.js

@@ -21,18 +21,19 @@
  * SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeGuardValidator = exports.ObjectValidator = exports.NumberValidator = exports.BooleanValidator = exports.StringValidator = exports.ArrayValidator = void 0;
-/* istanbul ignore file */
+exports.TypeGuardValidator = exports.StringValidator = exports.ObjectValidator = exports.NumberValidator = exports.BooleanValidator = exports.ArrayValidator = void 0;
+/* c8 ignore start */
 var array_1 = require("./array");
 Object.defineProperty(exports, "ArrayValidator", { enumerable: true, get: function () { return array_1.ArrayValidator; } });
-var string_1 = require("./string");
-Object.defineProperty(exports, "StringValidator", { enumerable: true, get: function () { return string_1.StringValidator; } });
 var boolean_1 = require("./boolean");
 Object.defineProperty(exports, "BooleanValidator", { enumerable: true, get: function () { return boolean_1.BooleanValidator; } });
 var number_1 = require("./number");
 Object.defineProperty(exports, "NumberValidator", { enumerable: true, get: function () { return number_1.NumberValidator; } });
 var object_1 = require("./object");
 Object.defineProperty(exports, "ObjectValidator", { enumerable: true, get: function () { return object_1.ObjectValidator; } });
+var string_1 = require("./string");
+Object.defineProperty(exports, "StringValidator", { enumerable: true, get: function () { return string_1.StringValidator; } });
 var typeGuard_1 = require("./typeGuard");
 Object.defineProperty(exports, "TypeGuardValidator", { enumerable: true, get: function () { return typeGuard_1.TypeGuardValidator; } });
+/* c8 ignore stop */
 //# sourceMappingURL=classes.js.map

package/lib/packlets/validation/classes.js.map

@@ -1 +1 @@
-{"version":3,"file":"classes.js","sourceRoot":"","sources":["../../../src/packlets/validation/classes.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,0BAA0B;AAE1B,iCAA0E;AAAjE,uGAAA,cAAc,OAAA;AACvB,mCAA6E;AAApE,yGAAA,eAAe,OAAA;AACxB,qCAAgF;AAAvE,2GAAA,gBAAgB,OAAA;AACzB,mCAA6E;AAApE,yGAAA,eAAe,OAAA;AACxB,mCAKkB;AAHhB,yGAAA,eAAe,OAAA;AAIjB,yCAAsF;AAA7E,+GAAA,kBAAkB,OAAA","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\n/* istanbul ignore file */\n\nexport { ArrayValidator, ArrayValidatorConstructorParams } from './array';\nexport { StringValidator, StringValidatorConstructorParams } from './string';\nexport { BooleanValidator, BooleanValidatorConstructorParams } from './boolean';\nexport { NumberValidator, NumberValidatorConstructorParams } from './number';\nexport {\n  FieldValidators,\n  ObjectValidator,\n  ObjectValidatorConstructorParams,\n  ObjectValidatorOptions\n} from './object';\nexport { TypeGuardValidator, TypeGuardValidatorConstructorParams } from './typeGuard';\n"]}
+{"version":3,"file":"classes.js","sourceRoot":"","sources":["../../../src/packlets/validation/classes.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,qBAAqB;AAErB,iCAA0E;AAAjE,uGAAA,cAAc,OAAA;AACvB,qCAAgF;AAAvE,2GAAA,gBAAgB,OAAA;AACzB,mCAA6E;AAApE,yGAAA,eAAe,OAAA;AACxB,mCAKkB;AAHhB,yGAAA,eAAe,OAAA;AAIjB,mCAA6E;AAApE,yGAAA,eAAe,OAAA;AACxB,yCAAsF;AAA7E,+GAAA,kBAAkB,OAAA;AAE3B,oBAAoB","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\n/* c8 ignore start */\n\nexport { ArrayValidator, ArrayValidatorConstructorParams } from './array';\nexport { BooleanValidator, BooleanValidatorConstructorParams } from './boolean';\nexport { NumberValidator, NumberValidatorConstructorParams } from './number';\nexport {\n  FieldValidators,\n  ObjectValidator,\n  ObjectValidatorConstructorParams,\n  ObjectValidatorOptions\n} from './object';\nexport { StringValidator, StringValidatorConstructorParams } from './string';\nexport { TypeGuardValidator, TypeGuardValidatorConstructorParams } from './typeGuard';\n\n/* c8 ignore stop */\n"]}

package/lib/packlets/validation/field.js

@@ -42,7 +42,7 @@ class FieldValidator extends validatorBase_1.ValidatorBase {
         super({ options });
         this.fieldName = fieldName;
         this.fieldValidator = fieldValidator;
-        // istanbul ignore next
+        /* c8 ignore next */
         this._fieldOptions = options !== null && options !== void 0 ? options : {};
     }
     /**
@@ -63,7 +63,7 @@ class FieldValidator extends validatorBase_1.ValidatorBase {
             }
             return optional ? true : (0, base_1.fail)(`"${this.fieldName}": Field not found in "${JSON.stringify(from)}`);
         }
-        // istanbul ignore next -- defense in depth
+        /* c8 ignore next 2 -- defense in depth */
         return (0, base_1.fail)(`Cannot validate field '${this.fieldName}' from non-object "${JSON.stringify(from)}"`);
     }
 }

package/lib/packlets/validation/field.js.map

@@ -1 +1 @@
-{"version":3,"file":"field.js","sourceRoot":"","sources":["../../../src/packlets/validation/field.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAiD;AAEjD,mDAAgD;AAWhD;;;;GAIG;AACH,MAAa,cAAkC,SAAQ,6BAAoB;IAczE;;;;;;;OAOG;IACH,YACE,SAAiB,EACjB,cAAgC,EAChC,OAAmC;QAEnC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,uBAAuB;QACvB,IAAI,CAAC,aAAa,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE;YACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,KAAK,IAAI,CAAC;YAEtD,IAAI,IAAA,cAAO,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE;gBACjC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE;oBACnD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc;yBAC/B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;yBACvC,SAAS,CAAC,CAAC,OAAe,EAAE,EAAE;wBAC7B,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC,CAAC;oBAC/C,CAAC,CAAC,CAAC;oBAEL,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;iBACvC;aACF;YAED,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,IAAI,IAAI,CAAC,SAAS,0BAA0B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACnG;QACD,2CAA2C;QAC3C,OAAO,IAAA,WAAI,EAAC,0BAA0B,IAAI,CAAC,SAAS,sBAAsB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrG,CAAC;CACF;AA1DD,wCA0DC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail, isKeyOf } from '../base';\nimport { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase } from './validatorBase';\n\n/**\n * Parameters used to construct a {@link Validation.FieldValidator | FieldValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface FieldValidatorOptions<TC> extends ValidatorOptions<TC> {\n  optional?: boolean;\n}\n\n/**\n * An in-place {@link Validation.Validator | Validator} for properties\n * an an object.\n * @public\n */\nexport class FieldValidator<T, TC = undefined> extends ValidatorBase<T, TC> {\n  /**\n   * The name of the property that this validator should validate.\n   */\n  public readonly fieldName: string;\n  /**\n   * The {@link Validation.Validator | Validator} to be applied against the named property.\n   */\n  public readonly fieldValidator: Validator<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _fieldOptions: FieldValidatorOptions<TC>;\n\n  /**\n   * Constructs a new {@link Validation.FieldValidator | FieldValidator.}.\n   * @param fieldName - The name of the property that this validator should validate.\n   * @param fieldValidator - The {@link Validation.Validator | Validator} to be applied\n   * against the named property.\n   * @param options - Additional {@link Validation.FieldValidatorOptions | options} to be\n   * applied to this validation.\n   */\n  public constructor(\n    fieldName: string,\n    fieldValidator: Validator<T, TC>,\n    options?: FieldValidatorOptions<TC>\n  ) {\n    super({ options });\n    this.fieldName = fieldName;\n    this.fieldValidator = fieldValidator;\n    // istanbul ignore next\n    this._fieldOptions = options ?? {};\n  }\n\n  /**\n   * {@inheritdoc Validation.ValidatorBase._validate}\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n      const optional = this._fieldOptions.optional === true;\n\n      if (isKeyOf(this.fieldName, from)) {\n        if (!optional || from[this.fieldName] !== undefined) {\n          const result = this.fieldValidator\n            .validate(from[this.fieldName], context)\n            .onFailure((message: string) => {\n              return fail(`${this.fieldName}: ${message}`);\n            });\n\n          return result.success ? true : result;\n        }\n      }\n\n      return optional ? true : fail(`\"${this.fieldName}\": Field not found in \"${JSON.stringify(from)}`);\n    }\n    // istanbul ignore next -- defense in depth\n    return fail(`Cannot validate field '${this.fieldName}' from non-object \"${JSON.stringify(from)}\"`);\n  }\n}\n"]}
+{"version":3,"file":"field.js","sourceRoot":"","sources":["../../../src/packlets/validation/field.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAiD;AAEjD,mDAAgD;AAWhD;;;;GAIG;AACH,MAAa,cAAkC,SAAQ,6BAAoB;IAczE;;;;;;;OAOG;IACH,YACE,SAAiB,EACjB,cAAgC,EAChC,OAAmC;QAEnC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,oBAAoB;QACpB,IAAI,CAAC,aAAa,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE;YACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,KAAK,IAAI,CAAC;YAEtD,IAAI,IAAA,cAAO,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE;gBACjC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE;oBACnD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc;yBAC/B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;yBACvC,SAAS,CAAC,CAAC,OAAe,EAAE,EAAE;wBAC7B,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC,CAAC;oBAC/C,CAAC,CAAC,CAAC;oBAEL,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;iBACvC;aACF;YAED,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,IAAI,IAAI,CAAC,SAAS,0BAA0B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACnG;QACD,0CAA0C;QAC1C,OAAO,IAAA,WAAI,EAAC,0BAA0B,IAAI,CAAC,SAAS,sBAAsB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrG,CAAC;CACF;AA1DD,wCA0DC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail, isKeyOf } from '../base';\nimport { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase } from './validatorBase';\n\n/**\n * Parameters used to construct a {@link Validation.FieldValidator | FieldValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface FieldValidatorOptions<TC> extends ValidatorOptions<TC> {\n  optional?: boolean;\n}\n\n/**\n * An in-place {@link Validation.Validator | Validator} for properties\n * an an object.\n * @public\n */\nexport class FieldValidator<T, TC = undefined> extends ValidatorBase<T, TC> {\n  /**\n   * The name of the property that this validator should validate.\n   */\n  public readonly fieldName: string;\n  /**\n   * The {@link Validation.Validator | Validator} to be applied against the named property.\n   */\n  public readonly fieldValidator: Validator<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _fieldOptions: FieldValidatorOptions<TC>;\n\n  /**\n   * Constructs a new {@link Validation.FieldValidator | FieldValidator.}.\n   * @param fieldName - The name of the property that this validator should validate.\n   * @param fieldValidator - The {@link Validation.Validator | Validator} to be applied\n   * against the named property.\n   * @param options - Additional {@link Validation.FieldValidatorOptions | options} to be\n   * applied to this validation.\n   */\n  public constructor(\n    fieldName: string,\n    fieldValidator: Validator<T, TC>,\n    options?: FieldValidatorOptions<TC>\n  ) {\n    super({ options });\n    this.fieldName = fieldName;\n    this.fieldValidator = fieldValidator;\n    /* c8 ignore next */\n    this._fieldOptions = options ?? {};\n  }\n\n  /**\n   * {@inheritdoc Validation.ValidatorBase._validate}\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (typeof from === 'object' && !Array.isArray(from) && from !== null) {\n      const optional = this._fieldOptions.optional === true;\n\n      if (isKeyOf(this.fieldName, from)) {\n        if (!optional || from[this.fieldName] !== undefined) {\n          const result = this.fieldValidator\n            .validate(from[this.fieldName], context)\n            .onFailure((message: string) => {\n              return fail(`${this.fieldName}: ${message}`);\n            });\n\n          return result.success ? true : result;\n        }\n      }\n\n      return optional ? true : fail(`\"${this.fieldName}\": Field not found in \"${JSON.stringify(from)}`);\n    }\n    /* c8 ignore next 2 -- defense in depth */\n    return fail(`Cannot validate field '${this.fieldName}' from non-object \"${JSON.stringify(from)}\"`);\n  }\n}\n"]}

package/lib/packlets/validation/object.js

@@ -67,7 +67,7 @@ class ObjectValidator extends validatorBase_1.ValidatorBase {
         const resolved = {};
         for (const key in fields) {
             if (fields[key]) {
-                // istanbul ignore next
+                /* c8 ignore next */
                 const optional = fields[key].isOptional || ((_a = options === null || options === void 0 ? void 0 : options.optionalFields) === null || _a === void 0 ? void 0 : _a.includes(key));
                 resolved[key] = new field_1.FieldValidator(key, fields[key], { optional });
             }
@@ -84,7 +84,7 @@ class ObjectValidator extends validatorBase_1.ValidatorBase {
      * source properties.
      */
     partial(options) {
-        // istanbul ignore next
+        /* c8 ignore next */
         options = options !== null && options !== void 0 ? options : {};
         return new ObjectValidator({
             fields: this.fields,

package/lib/packlets/validation/object.js.map

@@ -1 +1 @@
-{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../src/packlets/validation/object.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AAExC,mDAAgF;AAEhF,mCAAyC;AA4CzC;;;;;;;GAOG;AACH,MAAa,eAAiC,SAAQ,6BAAoB;IAoBxE;;;;;;OAMG;IACH,YAAmB,MAA+C;;QAChE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;QACpC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACtF,IAAI,CAAC,cAAc;YACjB,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACO,MAAM,CAAC,kBAAkB,CACjC,MAA8B,EAC9B,OAAuC;;QAEvC,MAAM,QAAQ,GAAoC,EAAE,CAAC;QACrD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;gBACf,uBAAuB;gBACvB,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,KAAI,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,0CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC;gBAClF,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,sBAAc,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;aACpE;SACF;QACD,OAAO,QAAkC,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACI,OAAO,CAAC,OAAuC;QACpD,uBAAuB;QACvB,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,OAAO,IAAI,eAAe,CAAiB;YACzC,MAAM,EAAE,IAAI,CAAC,MAAyC;YACtD,OAAO,kCACF,IAAI,CAAC,OAAO,GACZ,OAAO,CACX;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,iBAA8B;;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,cAAc,EAAE,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC,EAAE,GAAG,iBAAiB,CAAC;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACpE,OAAO,IAAA,WAAI,EAAC,yBAAyB,CAAC,CAAC;SACxC;QAED,+CAA+C;QAC/C,gDAAgD;QAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;QACrD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACvC,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE;gBAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAClE,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;oBAChD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;iBAC/B;qBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;oBAC7B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;iBAC7B;aACF;SACF;QAED,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,cAAe,CAAC,GAAG,CAAC,CAAY,CAAC,CAAC,CAAC;YACzF,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,sCAAsC,CAAC,CAAC,CAAC;SACrF;QACD,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF;AAjID,0CAiIC","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail } from '../base';\nimport { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';\n\nimport { FieldValidator } from './field';\n\n/**\n * Per-property {@link Validation.Validator | validators} for each of the properties in `<T>`.\n * @public\n */\nexport type FieldValidators<T, TC = unknown> = { [key in keyof T]: Validator<T[key], TC> };\n\n/**\n * Options for an {@link Validation.Classes.ObjectValidator | ObjectValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectValidatorOptions<T, TC> extends ValidatorOptions<TC> {\n  /**\n   * If present, lists optional fields. Missing non-optional fields cause an error.\n   */\n  optionalFields?: (keyof T)[];\n  /**\n   * If true, unrecognized fields yield an error.  If false or undefined (default),\n   * unrecognized fields are ignored.\n   */\n  strict?: boolean;\n}\n\n/**\n * Options for the {@link Validation.Classes.ObjectValidator | ObjectValidator} constructor.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectValidatorConstructorParams<T, TC> extends ValidatorBaseConstructorParams<T, TC> {\n  /**\n   * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a\n   * {@link Validation.Validator | Validator} for each of the expected properties\n   * of a result object.\n   */\n  fields: FieldValidators<T>;\n  /**\n   * Optional additional {@link Validation.Classes.ObjectValidatorOptions | ValidatorOptions} to\n   * configure validation.\n   */\n  options?: ObjectValidatorOptions<T, TC>;\n}\n\n/**\n * In-place {@link Validation.Validator | Validator} for an object of type `<T>`.\n * @remarks\n * By default, succeeds if all of the required fields exist and are validate, and fails if\n * any required fields do not exist or are invalid.  See {@link Validation.Classes.ObjectValidatorOptions}\n * for other validation options.\n * @public\n */\nexport class ObjectValidator<T, TC = unknown> extends ValidatorBase<T, TC> {\n  /**\n   * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a\n   * {@link Validation.Validator | Validator} for each of the expected properties\n   */\n  public readonly fields: FieldValidators<T>;\n  /**\n   * {@link Validation.Classes.ObjectValidatorOptions | Options} which apply to this\n   * validator.\n   */\n  public readonly options: ObjectValidatorOptions<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _innerValidators: FieldValidators<T>;\n  /**\n   * @internal\n   */\n  protected readonly _allowedFields?: Set<keyof T>;\n\n  /**\n   * Constructs a new {@link Validation.Classes.ObjectValidator | ObjectValidator<T>}.\n   * @param fields - A {@link Validation.Classes.FieldValidators | FieldValidators<T>} containing\n   * a {@link Validation.Validator | Validator} for each field.\n   * @param options - An optional {@link Validation.Classes.ObjectValidatorOptions} to configure\n   * validation.\n   */\n  public constructor(params: ObjectValidatorConstructorParams<T, TC>) {\n    super(params);\n\n    this.fields = params.fields;\n    this.options = params.options ?? {};\n    this._innerValidators = ObjectValidator._resolveValidators(this.fields, this.options);\n    this._allowedFields =\n      this.options.strict === true ? new Set(Object.keys(this.fields) as (keyof T)[]) : undefined;\n  }\n\n  /**\n   * Creates the actual {@link Validation.Classes.FieldValidators | FieldValidators<T>} to be\n   * used by this converter by applying any options or traits defined in the options\n   * to the field converters passed to the constructor.\n   * @param fields - The base {@link Validation.Classes.FieldValidators | FieldValidators<T>} passed\n   * in to the constructor.\n   * @param options - The {@link Validation.Classes.ObjectValidatorOptions | object validator options}\n   * passed in to the constructor.\n   * @returns A new {@link Validation.Classes.FieldValidators | FieldValidators} with the fully-configured\n   * individual {@link Validation.Validator | field validators} to be applied.\n   * @internal\n   */\n  protected static _resolveValidators<T, TC>(\n    fields: FieldValidators<T, TC>,\n    options?: ObjectValidatorOptions<T, TC>\n  ): FieldValidators<T, TC> {\n    const resolved: Partial<FieldValidators<T, TC>> = {};\n    for (const key in fields) {\n      if (fields[key]) {\n        // istanbul ignore next\n        const optional = fields[key].isOptional || options?.optionalFields?.includes(key);\n        resolved[key] = new FieldValidator(key, fields[key], { optional });\n      }\n    }\n    return resolved as FieldValidators<T, TC>;\n  }\n\n  /**\n   * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} derived from this one but with\n   * new optional properties as specified by a supplied\n   * {@link Validation.Classes.ObjectValidatorOptions | ObjectValidatorOptions<T>}.\n   * @param options - The {@link Validation.Classes.ObjectValidatorOptions | options} to be applied to the new\n   * {@link Validation.Classes.ObjectValidator | validator}.\n   * @returns A new {@link Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional\n   * source properties.\n   */\n  public partial(options?: ObjectValidatorOptions<T, TC>): ObjectValidator<Partial<T>, TC> {\n    // istanbul ignore next\n    options = options ?? {};\n    return new ObjectValidator<Partial<T>, TC>({\n      fields: this.fields as FieldValidators<Partial<T>, TC>,\n      options: {\n        ...this.options,\n        ...options\n      },\n      traits: this.traits\n    });\n  }\n\n  /**\n   * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} derived from this one but with\n   * new optional properties as specified by a supplied array of `keyof T`.\n   * @param addOptionalProperties - The keys to be made optional.\n   * @returns A new {@link Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional\n   * source properties.\n   */\n  public addPartial(addOptionalFields: (keyof T)[]): ObjectValidator<Partial<T>, TC> {\n    return this.partial({\n      optionalFields: [...(this.options.optionalFields ?? []), ...addOptionalFields]\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.ValidatorBase._validate}\n   * @internal\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n      return fail('source is not an object');\n    }\n\n    // eslint bug thinks key is used before defined\n    // eslint-disable-next-line no-use-before-define\n    const converted = {} as { [key in keyof T]: T[key] };\n    const errors: string[] = [];\n    for (const key in this._innerValidators) {\n      if (this._innerValidators[key]) {\n        const result = this._innerValidators[key].validate(from, context);\n        if (result.success && result.value !== undefined) {\n          converted[key] = result.value;\n        } else if (result.isFailure()) {\n          errors.push(result.message);\n        }\n      }\n    }\n\n    if (this._allowedFields) {\n      const invalid = Object.keys(from).filter((k) => !this._allowedFields!.has(k as keyof T));\n      invalid.forEach((key) => errors.push(`${key}: unexpected field in source object.`));\n    }\n    return errors.length === 0 ? true : fail(errors.join('\\n'));\n  }\n}\n"]}
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../src/packlets/validation/object.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAwC;AAExC,mDAAgF;AAEhF,mCAAyC;AA4CzC;;;;;;;GAOG;AACH,MAAa,eAAiC,SAAQ,6BAAoB;IAoBxE;;;;;;OAMG;IACH,YAAmB,MAA+C;;QAChE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC;QACpC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACtF,IAAI,CAAC,cAAc;YACjB,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACO,MAAM,CAAC,kBAAkB,CACjC,MAA8B,EAC9B,OAAuC;;QAEvC,MAAM,QAAQ,GAAoC,EAAE,CAAC;QACrD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;gBACf,oBAAoB;gBACpB,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,KAAI,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,0CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC;gBAClF,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,sBAAc,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;aACpE;SACF;QACD,OAAO,QAAkC,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACI,OAAO,CAAC,OAAuC;QACpD,oBAAoB;QACpB,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,OAAO,IAAI,eAAe,CAAiB;YACzC,MAAM,EAAE,IAAI,CAAC,MAAyC;YACtD,OAAO,kCACF,IAAI,CAAC,OAAO,GACZ,OAAO,CACX;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,iBAA8B;;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,cAAc,EAAE,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC,EAAE,GAAG,iBAAiB,CAAC;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACO,SAAS,CAAC,IAAa,EAAE,OAAY;QAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACpE,OAAO,IAAA,WAAI,EAAC,yBAAyB,CAAC,CAAC;SACxC;QAED,+CAA+C;QAC/C,gDAAgD;QAChD,MAAM,SAAS,GAAG,EAAkC,CAAC;QACrD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACvC,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE;gBAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAClE,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;oBAChD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;iBAC/B;qBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE;oBAC7B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;iBAC7B;aACF;SACF;QAED,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,cAAe,CAAC,GAAG,CAAC,CAAY,CAAC,CAAC,CAAC;YACzF,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,sCAAsC,CAAC,CAAC,CAAC;SACrF;QACD,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF;AAjID,0CAiIC","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Failure, fail } from '../base';\nimport { Validator, ValidatorOptions } from './validator';\nimport { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';\n\nimport { FieldValidator } from './field';\n\n/**\n * Per-property {@link Validation.Validator | validators} for each of the properties in `<T>`.\n * @public\n */\nexport type FieldValidators<T, TC = unknown> = { [key in keyof T]: Validator<T[key], TC> };\n\n/**\n * Options for an {@link Validation.Classes.ObjectValidator | ObjectValidator}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectValidatorOptions<T, TC> extends ValidatorOptions<TC> {\n  /**\n   * If present, lists optional fields. Missing non-optional fields cause an error.\n   */\n  optionalFields?: (keyof T)[];\n  /**\n   * If true, unrecognized fields yield an error.  If false or undefined (default),\n   * unrecognized fields are ignored.\n   */\n  strict?: boolean;\n}\n\n/**\n * Options for the {@link Validation.Classes.ObjectValidator | ObjectValidator} constructor.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ObjectValidatorConstructorParams<T, TC> extends ValidatorBaseConstructorParams<T, TC> {\n  /**\n   * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a\n   * {@link Validation.Validator | Validator} for each of the expected properties\n   * of a result object.\n   */\n  fields: FieldValidators<T>;\n  /**\n   * Optional additional {@link Validation.Classes.ObjectValidatorOptions | ValidatorOptions} to\n   * configure validation.\n   */\n  options?: ObjectValidatorOptions<T, TC>;\n}\n\n/**\n * In-place {@link Validation.Validator | Validator} for an object of type `<T>`.\n * @remarks\n * By default, succeeds if all of the required fields exist and are validate, and fails if\n * any required fields do not exist or are invalid.  See {@link Validation.Classes.ObjectValidatorOptions}\n * for other validation options.\n * @public\n */\nexport class ObjectValidator<T, TC = unknown> extends ValidatorBase<T, TC> {\n  /**\n   * A {@link Validation.Classes.FieldValidators | FieldValidators} object specifying a\n   * {@link Validation.Validator | Validator} for each of the expected properties\n   */\n  public readonly fields: FieldValidators<T>;\n  /**\n   * {@link Validation.Classes.ObjectValidatorOptions | Options} which apply to this\n   * validator.\n   */\n  public readonly options: ObjectValidatorOptions<T, TC>;\n  /**\n   * @internal\n   */\n  protected readonly _innerValidators: FieldValidators<T>;\n  /**\n   * @internal\n   */\n  protected readonly _allowedFields?: Set<keyof T>;\n\n  /**\n   * Constructs a new {@link Validation.Classes.ObjectValidator | ObjectValidator<T>}.\n   * @param fields - A {@link Validation.Classes.FieldValidators | FieldValidators<T>} containing\n   * a {@link Validation.Validator | Validator} for each field.\n   * @param options - An optional {@link Validation.Classes.ObjectValidatorOptions} to configure\n   * validation.\n   */\n  public constructor(params: ObjectValidatorConstructorParams<T, TC>) {\n    super(params);\n\n    this.fields = params.fields;\n    this.options = params.options ?? {};\n    this._innerValidators = ObjectValidator._resolveValidators(this.fields, this.options);\n    this._allowedFields =\n      this.options.strict === true ? new Set(Object.keys(this.fields) as (keyof T)[]) : undefined;\n  }\n\n  /**\n   * Creates the actual {@link Validation.Classes.FieldValidators | FieldValidators<T>} to be\n   * used by this converter by applying any options or traits defined in the options\n   * to the field converters passed to the constructor.\n   * @param fields - The base {@link Validation.Classes.FieldValidators | FieldValidators<T>} passed\n   * in to the constructor.\n   * @param options - The {@link Validation.Classes.ObjectValidatorOptions | object validator options}\n   * passed in to the constructor.\n   * @returns A new {@link Validation.Classes.FieldValidators | FieldValidators} with the fully-configured\n   * individual {@link Validation.Validator | field validators} to be applied.\n   * @internal\n   */\n  protected static _resolveValidators<T, TC>(\n    fields: FieldValidators<T, TC>,\n    options?: ObjectValidatorOptions<T, TC>\n  ): FieldValidators<T, TC> {\n    const resolved: Partial<FieldValidators<T, TC>> = {};\n    for (const key in fields) {\n      if (fields[key]) {\n        /* c8 ignore next */\n        const optional = fields[key].isOptional || options?.optionalFields?.includes(key);\n        resolved[key] = new FieldValidator(key, fields[key], { optional });\n      }\n    }\n    return resolved as FieldValidators<T, TC>;\n  }\n\n  /**\n   * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} derived from this one but with\n   * new optional properties as specified by a supplied\n   * {@link Validation.Classes.ObjectValidatorOptions | ObjectValidatorOptions<T>}.\n   * @param options - The {@link Validation.Classes.ObjectValidatorOptions | options} to be applied to the new\n   * {@link Validation.Classes.ObjectValidator | validator}.\n   * @returns A new {@link Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional\n   * source properties.\n   */\n  public partial(options?: ObjectValidatorOptions<T, TC>): ObjectValidator<Partial<T>, TC> {\n    /* c8 ignore next */\n    options = options ?? {};\n    return new ObjectValidator<Partial<T>, TC>({\n      fields: this.fields as FieldValidators<Partial<T>, TC>,\n      options: {\n        ...this.options,\n        ...options\n      },\n      traits: this.traits\n    });\n  }\n\n  /**\n   * Creates a new {@link Validation.Classes.ObjectValidator | ObjectValidator} derived from this one but with\n   * new optional properties as specified by a supplied array of `keyof T`.\n   * @param addOptionalProperties - The keys to be made optional.\n   * @returns A new {@link Validation.Classes.ObjectValidator | ObjectValidator} with the additional optional\n   * source properties.\n   */\n  public addPartial(addOptionalFields: (keyof T)[]): ObjectValidator<Partial<T>, TC> {\n    return this.partial({\n      optionalFields: [...(this.options.optionalFields ?? []), ...addOptionalFields]\n    });\n  }\n\n  /**\n   * {@inheritdoc Validation.ValidatorBase._validate}\n   * @internal\n   */\n  protected _validate(from: unknown, context?: TC): boolean | Failure<T> {\n    if (typeof from !== 'object' || from === null || Array.isArray(from)) {\n      return fail('source is not an object');\n    }\n\n    // eslint bug thinks key is used before defined\n    // eslint-disable-next-line no-use-before-define\n    const converted = {} as { [key in keyof T]: T[key] };\n    const errors: string[] = [];\n    for (const key in this._innerValidators) {\n      if (this._innerValidators[key]) {\n        const result = this._innerValidators[key].validate(from, context);\n        if (result.success && result.value !== undefined) {\n          converted[key] = result.value;\n        } else if (result.isFailure()) {\n          errors.push(result.message);\n        }\n      }\n    }\n\n    if (this._allowedFields) {\n      const invalid = Object.keys(from).filter((k) => !this._allowedFields!.has(k as keyof T));\n      invalid.forEach((key) => errors.push(`${key}: unexpected field in source object.`));\n    }\n    return errors.length === 0 ? true : fail(errors.join('\\n'));\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-utils",
-  "version": "2.0.1-alpha.0",
+  "version": "2.1.0",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-utils.d.ts",
@@ -27,39 +27,39 @@
   },
   "homepage": "https://github.com/ErikFortune/fgv#readme",
   "devDependencies": {
-    "@jest/expect-utils": "^29.5.0",
-    "@microsoft/api-documenter": "^7.21.6",
-    "@microsoft/api-extractor": "^7.34.4",
-    "@types/jest": "^29.5.0",
-    "@types/luxon": "^3.2.0",
-    "@types/mustache": "^4.2.2",
-    "@types/node": "^18.15.10",
-    "@types/papaparse": "^5.3.7",
-    "@typescript-eslint/eslint-plugin": "^5.56.0",
-    "@typescript-eslint/parser": "^5.56.0",
-    "eslint": "^8.36.0",
-    "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-import": "^2.27.5",
+    "@jest/expect-utils": "^29.7.0",
+    "@microsoft/api-documenter": "^7.23.10",
+    "@microsoft/api-extractor": "^7.38.1",
+    "@types/jest": "^29.5.7",
+    "@types/luxon": "^3.3.3",
+    "@types/mustache": "^4.2.4",
+    "@types/node": "^20.8.9",
+    "@types/papaparse": "^5.3.10",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
+    "eslint": "^8.52.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
-    "jest": "^29.5.0",
-    "jest-extended": "^3.2.4",
-    "jest-matcher-utils": "^29.5.0",
-    "rimraf": "^4.4.1",
-    "ts-jest": "^29.0.5",
+    "jest": "^29.7.0",
+    "jest-extended": "^4.0.2",
+    "jest-matcher-utils": "^29.7.0",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5",
-    "eslint-plugin-n": "^15.0.0",
-    "jest-snapshot": "~29.5.0",
-    "@rushstack/heft": "~0.50.0",
-    "@rushstack/heft-node-rig": "~1.12.5",
-    "@rushstack/eslint-config": "~3.2.0",
-    "@types/heft-jest": "1.0.3",
-    "@rushstack/heft-jest-plugin": "~0.5.5",
+    "typescript": "^5.2.2",
+    "eslint-plugin-n": "^16.2.0",
+    "jest-snapshot": "~29.7.0",
+    "@rushstack/heft": "~0.63.0",
+    "@rushstack/heft-node-rig": "~2.3.8",
+    "@rushstack/eslint-config": "~3.4.1",
+    "@types/heft-jest": "1.0.5",
+    "@rushstack/heft-jest-plugin": "~0.10.2",
     "eslint-plugin-tsdoc": "~0.2.17"
   },
   "dependencies": {
-    "luxon": "^3.3.0",
+    "luxon": "^3.4.3",
     "mustache": "^4.2.0",
     "papaparse": "^5.4.1"
   }