@backblaze-labs/b2-sdk 0.3.0 → 0.4.0

package/dist/raw/url.js.map

@@ -1 +1 @@
-{"version":3,"file":"url.js","names":[],"sources":["../../src/raw/url.ts"],"sourcesContent":["/**\n * B2-style API version segment, such as `v1`, `v3`, or `v4`.\n *\n * The template-literal type documents the compile-time shape; use\n * {@link isB2ApiVersion} when accepting untyped runtime input.\n */\nexport type B2ApiVersion = `v${number}`\n\nconst SLASH = '/'\nconst BACKSLASH = '\\\\'\nconst VERSION_PREFIX = 'v'\nconst VERSION_DIGITS = '0123456789'\nconst URL_DELIMITERS = ['?', '#'] as const\n\n/** URL path options for a B2 API endpoint. */\nexport interface B2UrlOptions {\n  /** Base path prefix before the optional version segment. Defaults to `b2api`. */\n  readonly prefix?: string\n  /**\n   * Optional API version segment. SDK storage endpoints use `v3` and `v4`;\n   * Computer Backup endpoints use the same `vN` segment shape under a\n   * different prefix, such as `api/backup/v1`.\n   */\n  readonly version?: B2ApiVersion\n  /** Endpoint name appended after the prefix and optional version. */\n  readonly endpoint: string\n}\n\n/** URL path options for a B2 API surface before the endpoint is selected. */\nexport type B2EndpointUrlOptions = Omit<B2UrlOptions, 'endpoint'>\n\n/**\n * Returns true when `value` is a B2 API version segment of the form `vN`.\n *\n * @param value - Candidate API version segment.\n *\n * @returns Whether the value is a valid B2 API version segment.\n */\nexport function isB2ApiVersion(value: string): value is B2ApiVersion {\n  if (!value.startsWith(VERSION_PREFIX) || value.length === VERSION_PREFIX.length) return false\n\n  for (let index = VERSION_PREFIX.length; index < value.length; index += 1) {\n    const digit = value[index]\n    if (digit === undefined || !VERSION_DIGITS.includes(digit)) return false\n  }\n\n  return true\n}\n\nfunction assertB2ApiVersion(value: string): asserts value is B2ApiVersion {\n  if (!isB2ApiVersion(value)) {\n    throw new TypeError('Invalid version: expected a B2 API version segment like \"v3\"')\n  }\n}\n\nfunction trimSlashes(\n  value: string,\n  { leading, trailing }: { readonly leading: boolean; readonly trailing: boolean },\n): string {\n  let start = 0\n  let end = value.length\n\n  while (leading && start < end && value[start] === SLASH) {\n    start += 1\n  }\n  while (trailing && end > start && value[end - 1] === SLASH) {\n    end -= 1\n  }\n\n  return start === 0 && end === value.length ? value : value.slice(start, end)\n}\n\nfunction hasUrlDelimiter(value: string): boolean {\n  return URL_DELIMITERS.some((delimiter) => value.includes(delimiter))\n}\n\nfunction hasEncodedPathDelimiter(value: string): boolean {\n  const lowerValue = value.toLowerCase()\n  return (\n    lowerValue.includes('%2f') ||\n    lowerValue.includes('%3f') ||\n    lowerValue.includes('%23') ||\n    lowerValue.includes('%5c')\n  )\n}\n\nfunction withDotEscapesDecoded(value: string): string {\n  let decoded = ''\n  let index = 0\n\n  while (index < value.length) {\n    if (value.slice(index, index + 3).toLowerCase() === '%2e') {\n      decoded += '.'\n      index += 3\n    } else {\n      decoded += value[index]\n      index += 1\n    }\n  }\n\n  return decoded\n}\n\nfunction isTraversalComponent(value: string): boolean {\n  const decoded = withDotEscapesDecoded(value)\n  return decoded === '.' || decoded === '..'\n}\n\nfunction validatePathComponent(component: string, optionName: string): void {\n  if (component.length === 0) {\n    throw new TypeError(`Invalid ${optionName}: path components must not be empty`)\n  }\n  if (hasUrlDelimiter(component)) {\n    throw new TypeError(`Invalid ${optionName}: path components must not contain \"?\" or \"#\"`)\n  }\n  if (component.includes(BACKSLASH)) {\n    throw new TypeError(`Invalid ${optionName}: path components must not contain \"\\\\\"`)\n  }\n  if (hasEncodedPathDelimiter(component)) {\n    throw new TypeError(\n      `Invalid ${optionName}: path components must not contain encoded \"/\", \"\\\\\", \"?\", or \"#\"`,\n    )\n  }\n  if (isTraversalComponent(component)) {\n    throw new TypeError(`Invalid ${optionName}: path components must not be \".\" or \"..\"`)\n  }\n}\n\nfunction preparePathPrefix(prefix: string): string {\n  const trimmed = trimSlashes(prefix, { leading: true, trailing: true })\n  if (trimmed.length === 0) return ''\n\n  for (const component of trimmed.split(SLASH)) {\n    validatePathComponent(component, 'prefix')\n  }\n\n  return trimmed\n}\n\nfunction preparePathSegment(segment: string, optionName: string): string {\n  const trimmed = trimSlashes(segment, { leading: true, trailing: true })\n  if (trimmed.length === 0) return ''\n  if (trimmed.includes(SLASH)) {\n    throw new TypeError(`Invalid ${optionName}: expected a single path segment`)\n  }\n\n  validatePathComponent(trimmed, optionName)\n  return trimmed\n}\n\nfunction prepareVersionSegment(version: B2ApiVersion): B2ApiVersion {\n  const trimmed = preparePathSegment(version, 'version')\n  assertB2ApiVersion(trimmed)\n  return trimmed\n}\n\n/**\n * Builds a B2 API endpoint URL from a base URL, path prefix, optional version,\n * and endpoint name.\n *\n * @param baseUrl - API or download base URL.\n * @param options - Path prefix, optional version, and endpoint name.\n *\n * @returns The absolute endpoint URL.\n */\nexport function b2Url(\n  baseUrl: string,\n  { prefix = 'b2api', version, endpoint }: B2UrlOptions,\n): string {\n  const base = trimSlashes(baseUrl, { leading: false, trailing: true })\n  const path = [\n    preparePathPrefix(prefix),\n    version === undefined ? undefined : prepareVersionSegment(version),\n    preparePathSegment(endpoint, 'endpoint'),\n  ]\n    .filter((segment): segment is string => segment !== undefined)\n    .filter((segment) => segment.length > 0)\n    .join(SLASH)\n\n  return path.length === 0 ? base : `${base}/${path}`\n}\n"],"mappings":";AAQA,IAAM,QAAQ;AACd,IAAM,YAAY;AAClB,IAAM,iBAAiB;AACvB,IAAM,iBAAiB;AACvB,IAAM,iBAAiB,CAAC,KAAK,GAAG;;;;;;;;AA0BhC,SAAgB,eAAe,OAAsC;CACnE,IAAI,CAAC,MAAM,WAAW,cAAc,KAAK,MAAM,WAAW,GAAuB,OAAO;CAExF,KAAK,IAAI,QAAQ,GAAuB,QAAQ,MAAM,QAAQ,SAAS,GAAG;EACxE,MAAM,QAAQ,MAAM;EACpB,IAAI,UAAU,KAAA,KAAa,CAAC,eAAe,SAAS,KAAK,GAAG,OAAO;CACrE;CAEA,OAAO;AACT;AAEA,SAAS,mBAAmB,OAA8C;CACxE,IAAI,CAAC,eAAe,KAAK,GACvB,MAAM,IAAI,UAAU,gEAA8D;AAEtF;AAEA,SAAS,YACP,OACA,EAAE,SAAS,YACH;CACR,IAAI,QAAQ;CACZ,IAAI,MAAM,MAAM;CAEhB,OAAO,WAAW,QAAQ,OAAO,MAAM,WAAW,OAChD,SAAS;CAEX,OAAO,YAAY,MAAM,SAAS,MAAM,MAAM,OAAO,OACnD,OAAO;CAGT,OAAO,UAAU,KAAK,QAAQ,MAAM,SAAS,QAAQ,MAAM,MAAM,OAAO,GAAG;AAC7E;AAEA,SAAS,gBAAgB,OAAwB;CAC/C,OAAO,eAAe,MAAM,cAAc,MAAM,SAAS,SAAS,CAAC;AACrE;AAEA,SAAS,wBAAwB,OAAwB;CACvD,MAAM,aAAa,MAAM,YAAY;CACrC,OACE,WAAW,SAAS,KAAK,KACzB,WAAW,SAAS,KAAK,KACzB,WAAW,SAAS,KAAK,KACzB,WAAW,SAAS,KAAK;AAE7B;AAEA,SAAS,sBAAsB,OAAuB;CACpD,IAAI,UAAU;CACd,IAAI,QAAQ;CAEZ,OAAO,QAAQ,MAAM,QACnB,IAAI,MAAM,MAAM,OAAO,QAAQ,CAAC,CAAC,CAAC,YAAY,MAAM,OAAO;EACzD,WAAW;EACX,SAAS;CACX,OAAO;EACL,WAAW,MAAM;EACjB,SAAS;CACX;CAGF,OAAO;AACT;AAEA,SAAS,qBAAqB,OAAwB;CACpD,MAAM,UAAU,sBAAsB,KAAK;CAC3C,OAAO,YAAY,OAAO,YAAY;AACxC;AAEA,SAAS,sBAAsB,WAAmB,YAA0B;CAC1E,IAAI,UAAU,WAAW,GACvB,MAAM,IAAI,UAAU,WAAW,WAAW,oCAAoC;CAEhF,IAAI,gBAAgB,SAAS,GAC3B,MAAM,IAAI,UAAU,WAAW,WAAW,8CAA8C;CAE1F,IAAI,UAAU,SAAS,SAAS,GAC9B,MAAM,IAAI,UAAU,WAAW,WAAW,wCAAwC;CAEpF,IAAI,wBAAwB,SAAS,GACnC,MAAM,IAAI,UACR,WAAW,WAAW,kEACxB;CAEF,IAAI,qBAAqB,SAAS,GAChC,MAAM,IAAI,UAAU,WAAW,WAAW,0CAA0C;AAExF;AAEA,SAAS,kBAAkB,QAAwB;CACjD,MAAM,UAAU,YAAY,QAAQ;EAAE,SAAS;EAAM,UAAU;CAAK,CAAC;CACrE,IAAI,QAAQ,WAAW,GAAG,OAAO;CAEjC,KAAK,MAAM,aAAa,QAAQ,MAAM,KAAK,GACzC,sBAAsB,WAAW,QAAQ;CAG3C,OAAO;AACT;AAEA,SAAS,mBAAmB,SAAiB,YAA4B;CACvE,MAAM,UAAU,YAAY,SAAS;EAAE,SAAS;EAAM,UAAU;CAAK,CAAC;CACtE,IAAI,QAAQ,WAAW,GAAG,OAAO;CACjC,IAAI,QAAQ,SAAS,KAAK,GACxB,MAAM,IAAI,UAAU,WAAW,WAAW,iCAAiC;CAG7E,sBAAsB,SAAS,UAAU;CACzC,OAAO;AACT;AAEA,SAAS,sBAAsB,SAAqC;CAClE,MAAM,UAAU,mBAAmB,SAAS,SAAS;CACrD,mBAAmB,OAAO;CAC1B,OAAO;AACT;;;;;;;;;;AAWA,SAAgB,MACd,SACA,EAAE,SAAS,SAAS,SAAS,YACrB;CACR,MAAM,OAAO,YAAY,SAAS;EAAE,SAAS;EAAO,UAAU;CAAK,CAAC;CACpE,MAAM,OAAO;EACX,kBAAkB,MAAM;EACxB,YAAY,KAAA,IAAY,KAAA,IAAY,sBAAsB,OAAO;EACjE,mBAAmB,UAAU,UAAU;CACzC,CAAC,CACE,QAAQ,YAA+B,YAAY,KAAA,CAAS,CAAC,CAC7D,QAAQ,YAAY,QAAQ,SAAS,CAAC,CAAC,CACvC,KAAK,KAAK;CAEb,OAAO,KAAK,WAAW,IAAI,OAAO,GAAG,KAAK,GAAG;AAC/C"}
+{"version":3,"file":"url.js","names":[],"sources":["../../src/raw/url.ts"],"sourcesContent":["/**\n * B2-style API version segment, such as `v1`, `v3`, or `v4`.\n *\n * The template-literal type documents the compile-time shape; use\n * {@link isB2ApiVersion} when accepting untyped runtime input.\n */\nexport type B2ApiVersion = `v${number}`\n\nconst SLASH = '/'\nconst BACKSLASH = '\\\\'\nconst VERSION_PREFIX = 'v'\nconst VERSION_DIGITS = '0123456789'\nconst URL_DELIMITERS = ['?', '#'] as const\n\n/** URL path options for a B2 API endpoint. */\nexport interface B2UrlOptions {\n  /** Base path prefix before the optional version segment. Defaults to `b2api`. */\n  readonly prefix?: string\n  /**\n   * Optional API version segment. SDK-built B2 native storage endpoints use\n   * the current published `v4` segment; Computer Backup endpoints use the same\n   * `vN` segment shape under a different prefix, such as `api/backup/v1`.\n   */\n  readonly version?: B2ApiVersion\n  /** Endpoint name appended after the prefix and optional version. */\n  readonly endpoint: string\n}\n\n/** URL path options for a B2 API surface before the endpoint is selected. */\nexport type B2EndpointUrlOptions = Omit<B2UrlOptions, 'endpoint'>\n\n/**\n * Returns true when `value` is a B2 API version segment of the form `vN`.\n *\n * @param value - Candidate API version segment.\n *\n * @returns Whether the value is a valid B2 API version segment.\n */\nexport function isB2ApiVersion(value: string): value is B2ApiVersion {\n  if (!value.startsWith(VERSION_PREFIX) || value.length === VERSION_PREFIX.length) return false\n\n  for (let index = VERSION_PREFIX.length; index < value.length; index += 1) {\n    const digit = value[index]\n    if (digit === undefined || !VERSION_DIGITS.includes(digit)) return false\n  }\n\n  return true\n}\n\nfunction assertB2ApiVersion(value: string): asserts value is B2ApiVersion {\n  if (!isB2ApiVersion(value)) {\n    throw new TypeError('Invalid version: expected a B2 API version segment like \"v3\"')\n  }\n}\n\nfunction trimSlashes(\n  value: string,\n  { leading, trailing }: { readonly leading: boolean; readonly trailing: boolean },\n): string {\n  let start = 0\n  let end = value.length\n\n  while (leading && start < end && value[start] === SLASH) {\n    start += 1\n  }\n  while (trailing && end > start && value[end - 1] === SLASH) {\n    end -= 1\n  }\n\n  return start === 0 && end === value.length ? value : value.slice(start, end)\n}\n\nfunction hasUrlDelimiter(value: string): boolean {\n  return URL_DELIMITERS.some((delimiter) => value.includes(delimiter))\n}\n\nfunction hasEncodedPathDelimiter(value: string): boolean {\n  const lowerValue = value.toLowerCase()\n  return (\n    lowerValue.includes('%2f') ||\n    lowerValue.includes('%3f') ||\n    lowerValue.includes('%23') ||\n    lowerValue.includes('%5c')\n  )\n}\n\nfunction withDotEscapesDecoded(value: string): string {\n  let decoded = ''\n  let index = 0\n\n  while (index < value.length) {\n    if (value.slice(index, index + 3).toLowerCase() === '%2e') {\n      decoded += '.'\n      index += 3\n    } else {\n      decoded += value[index]\n      index += 1\n    }\n  }\n\n  return decoded\n}\n\nfunction isTraversalComponent(value: string): boolean {\n  const decoded = withDotEscapesDecoded(value)\n  return decoded === '.' || decoded === '..'\n}\n\nfunction validatePathComponent(component: string, optionName: string): void {\n  if (component.length === 0) {\n    throw new TypeError(`Invalid ${optionName}: path components must not be empty`)\n  }\n  if (hasUrlDelimiter(component)) {\n    throw new TypeError(`Invalid ${optionName}: path components must not contain \"?\" or \"#\"`)\n  }\n  if (component.includes(BACKSLASH)) {\n    throw new TypeError(`Invalid ${optionName}: path components must not contain \"\\\\\"`)\n  }\n  if (hasEncodedPathDelimiter(component)) {\n    throw new TypeError(\n      `Invalid ${optionName}: path components must not contain encoded \"/\", \"\\\\\", \"?\", or \"#\"`,\n    )\n  }\n  if (isTraversalComponent(component)) {\n    throw new TypeError(`Invalid ${optionName}: path components must not be \".\" or \"..\"`)\n  }\n}\n\nfunction preparePathPrefix(prefix: string): string {\n  const trimmed = trimSlashes(prefix, { leading: true, trailing: true })\n  if (trimmed.length === 0) return ''\n\n  for (const component of trimmed.split(SLASH)) {\n    validatePathComponent(component, 'prefix')\n  }\n\n  return trimmed\n}\n\nfunction preparePathSegment(segment: string, optionName: string): string {\n  const trimmed = trimSlashes(segment, { leading: true, trailing: true })\n  if (trimmed.length === 0) return ''\n  if (trimmed.includes(SLASH)) {\n    throw new TypeError(`Invalid ${optionName}: expected a single path segment`)\n  }\n\n  validatePathComponent(trimmed, optionName)\n  return trimmed\n}\n\nfunction prepareVersionSegment(version: B2ApiVersion): B2ApiVersion {\n  const trimmed = preparePathSegment(version, 'version')\n  assertB2ApiVersion(trimmed)\n  return trimmed\n}\n\n/**\n * Builds a B2 API endpoint URL from a base URL, path prefix, optional version,\n * and endpoint name.\n *\n * @param baseUrl - API or download base URL.\n * @param options - Path prefix, optional version, and endpoint name.\n *\n * @returns The absolute endpoint URL.\n */\nexport function b2Url(\n  baseUrl: string,\n  { prefix = 'b2api', version, endpoint }: B2UrlOptions,\n): string {\n  const base = trimSlashes(baseUrl, { leading: false, trailing: true })\n  const path = [\n    preparePathPrefix(prefix),\n    version === undefined ? undefined : prepareVersionSegment(version),\n    preparePathSegment(endpoint, 'endpoint'),\n  ]\n    .filter((segment): segment is string => segment !== undefined)\n    .filter((segment) => segment.length > 0)\n    .join(SLASH)\n\n  return path.length === 0 ? base : `${base}/${path}`\n}\n"],"mappings":";AAQA,IAAM,QAAQ;AACd,IAAM,YAAY;AAClB,IAAM,iBAAiB;AACvB,IAAM,iBAAiB;AACvB,IAAM,iBAAiB,CAAC,KAAK,GAAG;;;;;;;;AA0BhC,SAAgB,eAAe,OAAsC;CACnE,IAAI,CAAC,MAAM,WAAW,cAAc,KAAK,MAAM,WAAW,GAAuB,OAAO;CAExF,KAAK,IAAI,QAAQ,GAAuB,QAAQ,MAAM,QAAQ,SAAS,GAAG;EACxE,MAAM,QAAQ,MAAM;EACpB,IAAI,UAAU,KAAA,KAAa,CAAC,eAAe,SAAS,KAAK,GAAG,OAAO;CACrE;CAEA,OAAO;AACT;AAEA,SAAS,mBAAmB,OAA8C;CACxE,IAAI,CAAC,eAAe,KAAK,GACvB,MAAM,IAAI,UAAU,gEAA8D;AAEtF;AAEA,SAAS,YACP,OACA,EAAE,SAAS,YACH;CACR,IAAI,QAAQ;CACZ,IAAI,MAAM,MAAM;CAEhB,OAAO,WAAW,QAAQ,OAAO,MAAM,WAAW,OAChD,SAAS;CAEX,OAAO,YAAY,MAAM,SAAS,MAAM,MAAM,OAAO,OACnD,OAAO;CAGT,OAAO,UAAU,KAAK,QAAQ,MAAM,SAAS,QAAQ,MAAM,MAAM,OAAO,GAAG;AAC7E;AAEA,SAAS,gBAAgB,OAAwB;CAC/C,OAAO,eAAe,MAAM,cAAc,MAAM,SAAS,SAAS,CAAC;AACrE;AAEA,SAAS,wBAAwB,OAAwB;CACvD,MAAM,aAAa,MAAM,YAAY;CACrC,OACE,WAAW,SAAS,KAAK,KACzB,WAAW,SAAS,KAAK,KACzB,WAAW,SAAS,KAAK,KACzB,WAAW,SAAS,KAAK;AAE7B;AAEA,SAAS,sBAAsB,OAAuB;CACpD,IAAI,UAAU;CACd,IAAI,QAAQ;CAEZ,OAAO,QAAQ,MAAM,QACnB,IAAI,MAAM,MAAM,OAAO,QAAQ,CAAC,CAAC,CAAC,YAAY,MAAM,OAAO;EACzD,WAAW;EACX,SAAS;CACX,OAAO;EACL,WAAW,MAAM;EACjB,SAAS;CACX;CAGF,OAAO;AACT;AAEA,SAAS,qBAAqB,OAAwB;CACpD,MAAM,UAAU,sBAAsB,KAAK;CAC3C,OAAO,YAAY,OAAO,YAAY;AACxC;AAEA,SAAS,sBAAsB,WAAmB,YAA0B;CAC1E,IAAI,UAAU,WAAW,GACvB,MAAM,IAAI,UAAU,WAAW,WAAW,oCAAoC;CAEhF,IAAI,gBAAgB,SAAS,GAC3B,MAAM,IAAI,UAAU,WAAW,WAAW,8CAA8C;CAE1F,IAAI,UAAU,SAAS,SAAS,GAC9B,MAAM,IAAI,UAAU,WAAW,WAAW,wCAAwC;CAEpF,IAAI,wBAAwB,SAAS,GACnC,MAAM,IAAI,UACR,WAAW,WAAW,kEACxB;CAEF,IAAI,qBAAqB,SAAS,GAChC,MAAM,IAAI,UAAU,WAAW,WAAW,0CAA0C;AAExF;AAEA,SAAS,kBAAkB,QAAwB;CACjD,MAAM,UAAU,YAAY,QAAQ;EAAE,SAAS;EAAM,UAAU;CAAK,CAAC;CACrE,IAAI,QAAQ,WAAW,GAAG,OAAO;CAEjC,KAAK,MAAM,aAAa,QAAQ,MAAM,KAAK,GACzC,sBAAsB,WAAW,QAAQ;CAG3C,OAAO;AACT;AAEA,SAAS,mBAAmB,SAAiB,YAA4B;CACvE,MAAM,UAAU,YAAY,SAAS;EAAE,SAAS;EAAM,UAAU;CAAK,CAAC;CACtE,IAAI,QAAQ,WAAW,GAAG,OAAO;CACjC,IAAI,QAAQ,SAAS,KAAK,GACxB,MAAM,IAAI,UAAU,WAAW,WAAW,iCAAiC;CAG7E,sBAAsB,SAAS,UAAU;CACzC,OAAO;AACT;AAEA,SAAS,sBAAsB,SAAqC;CAClE,MAAM,UAAU,mBAAmB,SAAS,SAAS;CACrD,mBAAmB,OAAO;CAC1B,OAAO;AACT;;;;;;;;;;AAWA,SAAgB,MACd,SACA,EAAE,SAAS,SAAS,SAAS,YACrB;CACR,MAAM,OAAO,YAAY,SAAS;EAAE,SAAS;EAAO,UAAU;CAAK,CAAC;CACpE,MAAM,OAAO;EACX,kBAAkB,MAAM;EACxB,YAAY,KAAA,IAAY,KAAA,IAAY,sBAAsB,OAAO;EACjE,mBAAmB,UAAU,UAAU;CACzC,CAAC,CACE,QAAQ,YAA+B,YAAY,KAAA,CAAS,CAAC,CAC7D,QAAQ,YAAY,QAAQ,SAAS,CAAC,CAAC,CACvC,KAAK,KAAK;CAEb,OAAO,KAAK,WAAW,IAAI,OAAO,GAAG,KAAK,GAAG;AAC/C"}