structured-outputs 0.1.0-beta.7 → 0.1.0-beta.8

package/src/deps/jsr.io/@std/fs/1.0.5/ensure_file.ts

@@ -0,0 +1,100 @@
+// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+import * as dntShim from "../../../../../_dnt.shims.js";
+
+import { dirname } from "../../path/1.0.7/dirname.js";
+import { ensureDir, ensureDirSync } from "./ensure_dir.js";
+import { getFileInfoType } from "./_get_file_info_type.js";
+import { toPathString } from "./_to_path_string.js";
+
+/**
+ * Asynchronously ensures that the file exists.
+ *
+ * If the file already exists, this function does nothing. If the parent
+ * directories for the file do not exist, they are created.
+ *
+ * Requires `--allow-read` and `--allow-write` permissions.
+ *
+ * @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access}
+ * for more information on Deno's permissions system.
+ *
+ * @param filePath The path of the file to ensure, as a string or URL.
+ *
+ * @returns A void promise that resolves once the file exists.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { ensureFile } from "@std/fs/ensure-file";
+ *
+ * await ensureFile("./folder/targetFile.dat");
+ * ```
+ */
+export async function ensureFile(filePath: string | URL): Promise<void> {
+  try {
+    // if file exists
+    const stat = await dntShim.Deno.lstat(filePath);
+    if (!stat.isFile) {
+      throw new Error(
+        `Failed to ensure file exists: expected 'file', got '${
+          getFileInfoType(stat)
+        }'`,
+      );
+    }
+  } catch (err) {
+    // if file not exists
+    if (err instanceof dntShim.Deno.errors.NotFound) {
+      // ensure dir exists
+      await ensureDir(dirname(toPathString(filePath)));
+      // create file
+      await dntShim.Deno.writeFile(filePath, new Uint8Array());
+      return;
+    }
+
+    throw err;
+  }
+}
+
+/**
+ * Synchronously ensures that the file exists.
+ *
+ * If the file already exists, this function does nothing. If the parent
+ * directories for the file do not exist, they are created.
+ *
+ * Requires `--allow-read` and `--allow-write` permissions.
+ *
+ * @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access}
+ * for more information on Deno's permissions system.
+ *
+ * @param filePath The path of the file to ensure, as a string or URL.
+ *
+ * @returns A void value that returns once the file exists.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { ensureFileSync } from "@std/fs/ensure-file";
+ *
+ * ensureFileSync("./folder/targetFile.dat");
+ * ```
+ */
+export function ensureFileSync(filePath: string | URL): void {
+  try {
+    // if file exists
+    const stat = dntShim.Deno.lstatSync(filePath);
+    if (!stat.isFile) {
+      throw new Error(
+        `Failed to ensure file exists: expected 'file', got '${
+          getFileInfoType(stat)
+        }'`,
+      );
+    }
+  } catch (err) {
+    // if file not exists
+    if (err instanceof dntShim.Deno.errors.NotFound) {
+      // ensure dir exists
+      ensureDirSync(dirname(toPathString(filePath)));
+      // create file
+      dntShim.Deno.writeFileSync(filePath, new Uint8Array());
+      return;
+    }
+    throw err;
+  }
+}

package/src/deps/jsr.io/@std/fs/1.0.5/ensure_link.ts

@@ -0,0 +1,66 @@
+// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+import * as dntShim from "../../../../../_dnt.shims.js";
+
+import { dirname } from "../../path/1.0.7/dirname.js";
+import { ensureDir, ensureDirSync } from "./ensure_dir.js";
+import { toPathString } from "./_to_path_string.js";
+
+/**
+ * Asynchronously ensures that the hard link exists.
+ *
+ * If the parent directories for the hard link do not exist, they are created.
+ *
+ * Requires `--allow-read` and `--allow-write` permissions.
+ *
+ * @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access}
+ * for more information on Deno's permissions system.
+ *
+ * @param src The source file path as a string or URL. Directory hard links are
+ * not allowed.
+ * @param dest The destination link path as a string or URL.
+ *
+ * @returns A void promise that resolves once the hard link exists.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { ensureLink } from "@std/fs/ensure-link";
+ *
+ * await ensureLink("./folder/targetFile.dat", "./folder/targetFile.link.dat");
+ * ```
+ */
+export async function ensureLink(src: string | URL, dest: string | URL) {
+  dest = toPathString(dest);
+  await ensureDir(dirname(dest));
+
+  await dntShim.Deno.link(toPathString(src), dest);
+}
+
+/**
+ * Synchronously ensures that the hard link exists.
+ *
+ * If the parent directories for the hard link do not exist, they are created.
+ *
+ * Requires `--allow-read` and `--allow-write` permissions.
+ *
+ * @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access}
+ * for more information on Deno's permissions system.
+ *
+ * @param src The source file path as a string or URL. Directory hard links are
+ * not allowed.
+ * @param dest The destination link path as a string or URL.
+ *
+ * @returns A void value that returns once the hard link exists.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { ensureLinkSync } from "@std/fs/ensure-link";
+ *
+ * ensureLinkSync("./folder/targetFile.dat", "./folder/targetFile.link.dat");
+ * ```
+ */
+export function ensureLinkSync(src: string | URL, dest: string | URL) {
+  dest = toPathString(dest);
+  ensureDirSync(dirname(dest));
+
+  dntShim.Deno.linkSync(toPathString(src), dest);
+}

package/src/deps/jsr.io/@std/fs/1.0.5/ensure_symlink.ts

@@ -0,0 +1,145 @@
+// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+import * as dntShim from "../../../../../_dnt.shims.js";
+
+import { dirname } from "../../path/1.0.7/dirname.js";
+import { resolve } from "../../path/1.0.7/resolve.js";
+import { ensureDir, ensureDirSync } from "./ensure_dir.js";
+import { getFileInfoType, type PathType } from "./_get_file_info_type.js";
+import { toPathString } from "./_to_path_string.js";
+
+// deno-lint-ignore no-explicit-any
+const isWindows = (dntShim.dntGlobalThis as any).Deno?.build.os === "windows";
+
+function resolveSymlinkTarget(target: string | URL, linkName: string | URL) {
+  if (typeof target !== "string") return target; // URL is always absolute path
+  if (typeof linkName === "string") {
+    return resolve(dirname(linkName), target);
+  } else {
+    return new URL(target, linkName);
+  }
+}
+
+function getSymlinkOption(
+  type: PathType | undefined,
+): dntShim.Deno.SymlinkOptions | undefined {
+  return isWindows ? { type: type === "dir" ? "dir" : "file" } : undefined;
+}
+
+/**
+ * Asynchronously ensures that the link exists, and points to a valid file.
+ *
+ * If the parent directories for the link do not exist, they are created. If the
+ * link already exists, and it is not modified, this function does nothing. If
+ * the link already exists, and it does not point to the given target, an error
+ * is thrown.
+ *
+ * Requires `--allow-read` and `--allow-write` permissions.
+ *
+ * @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access}
+ * for more information on Deno's permissions system.
+ *
+ * @param target The source file path as a string or URL.
+ * @param linkName The destination link path as a string or URL.
+ *
+ * @returns A void promise that resolves once the link exists.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { ensureSymlink } from "@std/fs/ensure-symlink";
+ *
+ * await ensureSymlink("./folder/targetFile.dat", "./folder/targetFile.link.dat");
+ * ```
+ */
+export async function ensureSymlink(
+  target: string | URL,
+  linkName: string | URL,
+) {
+  const targetRealPath = resolveSymlinkTarget(target, linkName);
+  const srcStatInfo = await dntShim.Deno.lstat(targetRealPath);
+  const srcFilePathType = getFileInfoType(srcStatInfo);
+
+  await ensureDir(dirname(toPathString(linkName)));
+
+  const options = getSymlinkOption(srcFilePathType);
+
+  try {
+    await dntShim.Deno.symlink(target, linkName, options);
+  } catch (error) {
+    if (!(error instanceof dntShim.Deno.errors.AlreadyExists)) {
+      throw error;
+    }
+    const linkStatInfo = await dntShim.Deno.lstat(linkName);
+    if (!linkStatInfo.isSymlink) {
+      const type = getFileInfoType(linkStatInfo);
+      throw new dntShim.Deno.errors.AlreadyExists(
+        `A '${type}' already exists at the path: ${linkName}`,
+      );
+    }
+    const linkPath = await dntShim.Deno.readLink(linkName);
+    const linkRealPath = resolve(linkPath);
+    if (linkRealPath !== targetRealPath) {
+      throw new dntShim.Deno.errors.AlreadyExists(
+        `A symlink targeting to an undesired path already exists: ${linkName} -> ${linkRealPath}`,
+      );
+    }
+  }
+}
+
+/**
+ * Synchronously ensures that the link exists, and points to a valid file.
+ *
+ * If the parent directories for the link do not exist, they are created. If the
+ * link already exists, and it is not modified, this function does nothing. If
+ * the link already exists, and it does not point to the given target, an error
+ * is thrown.
+ *
+ * Requires `--allow-read` and `--allow-write` permissions.
+ *
+ * @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access}
+ * for more information on Deno's permissions system.
+ *
+ * @param target The source file path as a string or URL.
+ * @param linkName The destination link path as a string or URL.
+ * @returns A void value that returns once the link exists.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { ensureSymlinkSync } from "@std/fs/ensure-symlink";
+ *
+ * ensureSymlinkSync("./folder/targetFile.dat", "./folder/targetFile.link.dat");
+ * ```
+ */
+export function ensureSymlinkSync(
+  target: string | URL,
+  linkName: string | URL,
+) {
+  const targetRealPath = resolveSymlinkTarget(target, linkName);
+  const srcStatInfo = dntShim.Deno.lstatSync(targetRealPath);
+  const srcFilePathType = getFileInfoType(srcStatInfo);
+
+  ensureDirSync(dirname(toPathString(linkName)));
+
+  const options = getSymlinkOption(srcFilePathType);
+
+  try {
+    dntShim.Deno.symlinkSync(target, linkName, options);
+  } catch (error) {
+    if (!(error instanceof dntShim.Deno.errors.AlreadyExists)) {
+      throw error;
+    }
+    const linkStatInfo = dntShim.Deno.lstatSync(linkName);
+    if (!linkStatInfo.isSymlink) {
+      const type = getFileInfoType(linkStatInfo);
+      throw new dntShim.Deno.errors.AlreadyExists(
+        `A '${type}' already exists at the path: ${linkName}`,
+      );
+    }
+    const linkPath = dntShim.Deno.readLinkSync(linkName);
+    const linkRealPath = resolve(linkPath);
+    if (linkRealPath !== targetRealPath) {
+      throw new dntShim.Deno.errors.AlreadyExists(
+        `A symlink targeting to an undesired path already exists: ${linkName} -> ${linkRealPath}`,
+      );
+    }
+  }
+}

package/src/deps/jsr.io/@std/fs/1.0.5/eol.ts

@@ -0,0 +1,74 @@
+// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+
+/** End-of-line character for POSIX platforms such as macOS and Linux. */
+import * as dntShim from "../../../../../_dnt.shims.js";
+
+export const LF = "\n" as const;
+
+/** End-of-line character for Windows platforms. */
+export const CRLF = "\r\n" as const;
+
+/**
+ * End-of-line character evaluated for the current platform.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { EOL } from "@std/fs/eol";
+ *
+ * EOL; // "\n" on POSIX platforms and "\r\n" on Windows
+ * ```
+ */
+export const EOL: "\n" | "\r\n" =
+  // deno-lint-ignore no-explicit-any
+  (dntShim.dntGlobalThis as any).Deno?.build.os === "windows" ? CRLF : LF;
+
+const regDetect = /(?:\r?\n)/g;
+
+/**
+ * Returns the detected EOL character(s) detected in the input string. If no EOL
+ * character is detected, `null` is returned.
+ *
+ * @param content The input string to detect EOL characters.
+ *
+ * @returns The detected EOL character(s) or `null` if no EOL character is detected.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { detect } from "@std/fs/eol";
+ *
+ * detect("deno\r\nis not\r\nnode"); // "\r\n"
+ * detect("deno\nis not\r\nnode"); // "\r\n"
+ * detect("deno\nis not\nnode"); // "\n"
+ * detect("deno is not node"); // null
+ * ```
+ */
+export function detect(content: string): typeof EOL | null {
+  const d = content.match(regDetect);
+  if (!d || d.length === 0) {
+    return null;
+  }
+  const hasCRLF = d.some((x: string): boolean => x === CRLF);
+
+  return hasCRLF ? CRLF : LF;
+}
+
+/**
+ * Normalize the input string to the targeted EOL.
+ *
+ * @param content The input string to normalize.
+ * @param eol The EOL character(s) to normalize the input string to.
+ *
+ * @returns The input string normalized to the targeted EOL.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { LF, format } from "@std/fs/eol";
+ *
+ * const CRLFinput = "deno\r\nis not\r\nnode";
+ *
+ * format(CRLFinput, LF); // "deno\nis not\nnode"
+ * ```
+ */
+export function format(content: string, eol: typeof EOL): string {
+  return content.replace(regDetect, eol);
+}

package/src/deps/jsr.io/@std/fs/1.0.5/exists.ts

@@ -0,0 +1,316 @@
+// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+
+/** Options for {@linkcode exists} and {@linkcode existsSync.} */
+import * as dntShim from "../../../../../_dnt.shims.js";
+
+export interface ExistsOptions {
+  /**
+   * When `true`, will check if the path is readable by the user as well.
+   *
+   * @default {false}
+   */
+  isReadable?: boolean;
+  /**
+   * When `true`, will check if the path is a directory as well. Directory
+   * symlinks are included.
+   *
+   * @default {false}
+   */
+  isDirectory?: boolean;
+  /**
+   * When `true`, will check if the path is a file as well. File symlinks are
+   * included.
+   *
+   * @default {false}
+   */
+  isFile?: boolean;
+}
+
+/**
+ * Asynchronously test whether or not the given path exists by checking with
+ * the file system.
+ *
+ * Note: Do not use this function if performing a check before another operation
+ * on that file. Doing so creates a race condition. Instead, perform the actual
+ * file operation directly. This function is not recommended for this use case.
+ * See the recommended method below.
+ *
+ * @see {@link https://en.wikipedia.org/wiki/Time-of-check_to_time-of-use} for
+ * more information on the time-of-check to time-of-use bug.
+ *
+ * Requires `--allow-read` permissions, and in some cases, `--allow-sys`
+ * permissions if `options.isReadable` is `true`.
+ *
+ * @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access}
+ * for more information on Deno's permissions system.
+ *
+ * @param path The path to the file or directory, as a string or URL.
+ * @param options Additional options for the check.
+ *
+ * @returns A promise that resolves with `true` if the path exists, `false`
+ * otherwise.
+ *
+ * @example Recommended method
+ * ```ts ignore
+ * // Notice no use of exists
+ * try {
+ *   await Deno.remove("./foo", { recursive: true });
+ * } catch (error) {
+ *   if (!(error instanceof Deno.errors.NotFound)) {
+ *     throw error;
+ *   }
+ *   // Do nothing...
+ * }
+ * ```
+ *
+ * Notice that `exists()` is not used in the above example. Doing so avoids a
+ * possible race condition. See the above note for details.
+ *
+ * @example Basic usage
+ * ```ts ignore
+ * import { exists } from "@std/fs/exists";
+ *
+ * await exists("./exists"); // true
+ * await exists("./does_not_exist"); // false
+ * ```
+ *
+ * @example Check if a path is readable
+ *
+ * Requires `--allow-sys` permissions in some cases.
+ *
+ * ```ts ignore
+ * import { exists } from "@std/fs/exists";
+ *
+ * await exists("./readable", { isReadable: true }); // true
+ * await exists("./not_readable", { isReadable: true }); // false
+ * ```
+ *
+ * @example Check if a path is a directory
+ * ```ts ignore
+ * import { exists } from "@std/fs/exists";
+ *
+ * await exists("./directory", { isDirectory: true }); // true
+ * await exists("./file", { isDirectory: true }); // false
+ * ```
+ *
+ * @example Check if a path is a file
+ * ```ts ignore
+ * import { exists } from "@std/fs/exists";
+ *
+ * await exists("./file", { isFile: true }); // true
+ * await exists("./directory", { isFile: true }); // false
+ * ```
+ *
+ * @example Check if a path is a readable directory
+ *
+ * Requires `--allow-sys` permissions in some cases.
+ *
+ * ```ts ignore
+ * import { exists } from "@std/fs/exists";
+ *
+ * await exists("./readable_directory", { isReadable: true, isDirectory: true }); // true
+ * await exists("./not_readable_directory", { isReadable: true, isDirectory: true }); // false
+ * ```
+ *
+ * @example Check if a path is a readable file
+ *
+ * Requires `--allow-sys` permissions in some cases.
+ *
+ * ```ts ignore
+ * import { exists } from "@std/fs/exists";
+ *
+ * await exists("./readable_file", { isReadable: true, isFile: true }); // true
+ * await exists("./not_readable_file", { isReadable: true, isFile: true }); // false
+ * ```
+ */
+export async function exists(
+  path: string | URL,
+  options?: ExistsOptions,
+): Promise<boolean> {
+  try {
+    const stat = await dntShim.Deno.stat(path);
+    if (
+      options &&
+      (options.isReadable || options.isDirectory || options.isFile)
+    ) {
+      if (options.isDirectory && options.isFile) {
+        throw new TypeError(
+          "ExistsOptions.options.isDirectory and ExistsOptions.options.isFile must not be true together",
+        );
+      }
+      if (
+        (options.isDirectory && !stat.isDirectory) ||
+        (options.isFile && !stat.isFile)
+      ) {
+        return false;
+      }
+      if (options.isReadable) {
+        return fileIsReadable(stat);
+      }
+    }
+    return true;
+  } catch (error) {
+    if (error instanceof dntShim.Deno.errors.NotFound) {
+      return false;
+    }
+    if (error instanceof dntShim.Deno.errors.PermissionDenied) {
+      if (
+        (await dntShim.Deno.permissions.query({ name: "read", path })).state ===
+          "granted"
+      ) {
+        // --allow-read not missing
+        return !options?.isReadable; // PermissionDenied was raised by file system, so the item exists, but can't be read
+      }
+    }
+    throw error;
+  }
+}
+
+/**
+ * Synchronously test whether or not the given path exists by checking with
+ * the file system.
+ *
+ * Note: Do not use this function if performing a check before another operation
+ * on that file. Doing so creates a race condition. Instead, perform the actual
+ * file operation directly. This function is not recommended for this use case.
+ * See the recommended method below.
+ *
+ * @see {@link https://en.wikipedia.org/wiki/Time-of-check_to_time-of-use} for
+ * more information on the time-of-check to time-of-use bug.
+ *
+ * Requires `--allow-read` permissions, and in some cases, `--allow-sys`
+ * permissions if `options.isReadable` is `true`.
+ *
+ * @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access}
+ * for more information on Deno's permissions system.
+ *
+ * @param path The path to the file or directory, as a string or URL.
+ * @param options Additional options for the check.
+ *
+ * @returns `true` if the path exists, `false` otherwise.
+ *
+ * @example Recommended method
+ * ```ts ignore
+ * // Notice no use of exists
+ * try {
+ *   Deno.removeSync("./foo", { recursive: true });
+ * } catch (error) {
+ *   if (!(error instanceof Deno.errors.NotFound)) {
+ *     throw error;
+ *   }
+ *   // Do nothing...
+ * }
+ * ```
+ *
+ * Notice that `existsSync()` is not used in the above example. Doing so avoids
+ * a possible race condition. See the above note for details.
+ *
+ * @example Basic usage
+ * ```ts ignore
+ * import { existsSync } from "@std/fs/exists";
+ *
+ * existsSync("./exists"); // true
+ * existsSync("./does_not_exist"); // false
+ * ```
+ *
+ * @example Check if a path is readable
+ *
+ * Requires `--allow-sys` permissions in some cases.
+ *
+ * ```ts ignore
+ * import { existsSync } from "@std/fs/exists";
+ *
+ * existsSync("./readable", { isReadable: true }); // true
+ * existsSync("./not_readable", { isReadable: true }); // false
+ * ```
+ *
+ * @example Check if a path is a directory
+ * ```ts ignore
+ * import { existsSync } from "@std/fs/exists";
+ *
+ * existsSync("./directory", { isDirectory: true }); // true
+ * existsSync("./file", { isDirectory: true }); // false
+ * ```
+ *
+ * @example Check if a path is a file
+ * ```ts ignore
+ * import { existsSync } from "@std/fs/exists";
+ *
+ * existsSync("./file", { isFile: true }); // true
+ * existsSync("./directory", { isFile: true }); // false
+ * ```
+ *
+ * @example Check if a path is a readable directory
+ *
+ * Requires `--allow-sys` permissions in some cases.
+ *
+ * ```ts ignore
+ * import { existsSync } from "@std/fs/exists";
+ *
+ * existsSync("./readable_directory", { isReadable: true, isDirectory: true }); // true
+ * existsSync("./not_readable_directory", { isReadable: true, isDirectory: true }); // false
+ * ```
+ *
+ * @example Check if a path is a readable file
+ *
+ * Requires `--allow-sys` permissions in some cases.
+ *
+ * ```ts ignore
+ * import { existsSync } from "@std/fs/exists";
+ *
+ * existsSync("./readable_file", { isReadable: true, isFile: true }); // true
+ * existsSync("./not_readable_file", { isReadable: true, isFile: true }); // false
+ * ```
+ */
+export function existsSync(
+  path: string | URL,
+  options?: ExistsOptions,
+): boolean {
+  try {
+    const stat = dntShim.Deno.statSync(path);
+    if (
+      options &&
+      (options.isReadable || options.isDirectory || options.isFile)
+    ) {
+      if (options.isDirectory && options.isFile) {
+        throw new TypeError(
+          "ExistsOptions.options.isDirectory and ExistsOptions.options.isFile must not be true together",
+        );
+      }
+      if (
+        (options.isDirectory && !stat.isDirectory) ||
+        (options.isFile && !stat.isFile)
+      ) {
+        return false;
+      }
+      if (options.isReadable) {
+        return fileIsReadable(stat);
+      }
+    }
+    return true;
+  } catch (error) {
+    if (error instanceof dntShim.Deno.errors.NotFound) {
+      return false;
+    }
+    if (error instanceof dntShim.Deno.errors.PermissionDenied) {
+      if (
+        dntShim.Deno.permissions.querySync({ name: "read", path }).state === "granted"
+      ) {
+        // --allow-read not missing
+        return !options?.isReadable; // PermissionDenied was raised by file system, so the item exists, but can't be read
+      }
+    }
+    throw error;
+  }
+}
+
+function fileIsReadable(stat: dntShim.Deno.FileInfo) {
+  if (stat.mode === null) {
+    return true; // Exclusive on Non-POSIX systems
+  } else if (dntShim.Deno.uid() === stat.uid) {
+    return (stat.mode & 0o400) === 0o400; // User is owner and can read?
+  } else if (dntShim.Deno.gid() === stat.gid) {
+    return (stat.mode & 0o040) === 0o040; // User group is owner and can read?
+  }
+  return (stat.mode & 0o004) === 0o004; // Others can read?
+}