@tauri-apps/plugin-fs 2.0.0-alpha.0

package/LICENSE.spdx

@@ -0,0 +1,20 @@
+SPDXVersion: SPDX-2.1
+DataLicense: CC0-1.0
+PackageName: tauri
+DataFormat: SPDXRef-1
+PackageSupplier: Organization: The Tauri Programme in the Commons Conservancy
+PackageHomePage: https://tauri.app
+PackageLicenseDeclared: Apache-2.0
+PackageLicenseDeclared: MIT
+PackageCopyrightText: 2019-2022, The Tauri Programme in the Commons Conservancy
+PackageSummary: <text>Tauri is a rust project that enables developers to make secure
+and small desktop applications using a web frontend.
+                </text>
+PackageComment: <text>The package includes the following libraries; see
+Relationship information.
+                </text>
+Created: 2019-05-20T09:00:00Z
+PackageDownloadLocation: git://github.com/tauri-apps/tauri
+PackageDownloadLocation: git+https://github.com/tauri-apps/tauri.git
+PackageDownloadLocation: git+ssh://github.com/tauri-apps/tauri.git
+Creator: Person: Daniel Thompson-Yvetot

package/README.md

@@ -0,0 +1,76 @@
+# File System
+
+Access the file system.
+
+## Install
+
+_This plugin requires a Rust version of at least **1.65**_
+
+There are three general methods of installation that we can recommend.
+
+1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
+2. Pull sources directly from Github using git tags / revision hashes (most secure)
+3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
+
+Install the Core plugin by adding the following to your `Cargo.toml` file:
+
+`src-tauri/Cargo.toml`
+
+```toml
+[dependencies]
+tauri-plugin-fs = "2.0.0-alpha"
+# alternatively with Git:
+tauri-plugin-fs = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
+```
+
+You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
+
+> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
+
+```sh
+pnpm add @tauri-apps/plugin-fs
+# or
+npm add @tauri-apps/plugin-fs
+# or
+yarn add @tauri-apps/plugin-fs
+
+# alternatively with Git:
+pnpm add https://github.com/tauri-apps/tauri-plugin-fs#v2
+# or
+npm add https://github.com/tauri-apps/tauri-plugin-fs#v2
+# or
+yarn add https://github.com/tauri-apps/tauri-plugin-fs#v2
+```
+
+## Usage
+
+First you need to register the core plugin with Tauri:
+
+`src-tauri/src/main.rs`
+
+```rust
+fn main() {
+    tauri::Builder::default()
+        .plugin(tauri_plugin_fs::init())
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
+```
+
+Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
+
+```javascript
+import { metadata } from "@tauri-apps/plugin-fs";
+
+await metadata("/path/to/file");
+```
+
+## Contributing
+
+PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
+
+## License
+
+Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
+
+MIT or MIT/Apache 2.0 where applicable.

package/dist-js/index.d.ts

@@ -0,0 +1,376 @@
+/**
+ * Access the file system.
+ *
+ * ## Security
+ *
+ * This module prevents path traversal, not allowing absolute paths or parent dir components
+ * (i.e. "/usr/path/to/file" or "../path/to/file" paths are not allowed).
+ * Paths accessed with this API must be relative to one of the {@link BaseDirectory | base directories}
+ * so if you need access to arbitrary filesystem paths, you must write such logic on the core layer instead.
+ *
+ * The API has a scope configuration that forces you to restrict the paths that can be accessed using glob patterns.
+ *
+ * The scope configuration is an array of glob patterns describing folder paths that are allowed.
+ * For instance, this scope configuration only allows accessing files on the
+ * *databases* folder of the {@link path.appDataDir | $APPDATA directory}:
+ * ```json
+ * {
+ *   "plugins": {
+ *     "fs": {
+ *       "scope": ["$APPDATA/databases/*"]
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * Notice the use of the `$APPDATA` variable. The value is injected at runtime, resolving to the {@link path.appDataDir | app data directory}.
+ * The available variables are:
+ * {@link path.appConfigDir | `$APPCONFIG`}, {@link path.appDataDir | `$APPDATA`}, {@link path.appLocalDataDir | `$APPLOCALDATA`},
+ * {@link path.appCacheDir | `$APPCACHE`}, {@link path.appLogDir | `$APPLOG`},
+ * {@link path.audioDir | `$AUDIO`}, {@link path.cacheDir | `$CACHE`}, {@link path.configDir | `$CONFIG`}, {@link path.dataDir | `$DATA`},
+ * {@link path.localDataDir | `$LOCALDATA`}, {@link path.desktopDir | `$DESKTOP`}, {@link path.documentDir | `$DOCUMENT`},
+ * {@link path.downloadDir | `$DOWNLOAD`}, {@link path.executableDir | `$EXE`}, {@link path.fontDir | `$FONT`}, {@link path.homeDir | `$HOME`},
+ * {@link path.pictureDir | `$PICTURE`}, {@link path.publicDir | `$PUBLIC`}, {@link path.runtimeDir | `$RUNTIME`},
+ * {@link path.templateDir | `$TEMPLATE`}, {@link path.videoDir | `$VIDEO`}, {@link path.resourceDir | `$RESOURCE`},
+ * {@link os.tempdir | `$TEMP`}.
+ *
+ * Trying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access.
+ *
+ * Note that this scope applies to **all** APIs on this module.
+ *
+ * @module
+ */
+import { BaseDirectory } from "@tauri-apps/api/path";
+declare global {
+    interface Window {
+        __TAURI_INVOKE__: <T>(cmd: string, args?: unknown) => Promise<T>;
+    }
+}
+interface Permissions {
+    /**
+     * `true` if these permissions describe a readonly (unwritable) file.
+     */
+    readonly: boolean;
+    /**
+     * The underlying raw `st_mode` bits that contain the standard Unix permissions for this file.
+     */
+    mode: number | undefined;
+}
+/**
+ * Metadata information about a file.
+ * This structure is returned from the `metadata` function or method
+ * and represents known metadata about a file such as its permissions, size, modification times, etc.
+ */
+interface Metadata {
+    /**
+     * The last access time of this metadata.
+     */
+    accessedAt: Date;
+    /**
+     * The creation time listed in this metadata.
+     */
+    createdAt: Date;
+    /**
+     * The last modification time listed in this metadata.
+     */
+    modifiedAt: Date;
+    /**
+     * `true` if this metadata is for a directory.
+     */
+    isDir: boolean;
+    /**
+     * `true` if this metadata is for a regular file.
+     */
+    isFile: boolean;
+    /**
+     * `true` if this metadata is for a symbolic link.
+     */
+    isSymlink: boolean;
+    /**
+     * The size of the file, in bytes, this metadata is for.
+     */
+    size: number;
+    /**
+     * The permissions of the file this metadata is for.
+     */
+    permissions: Permissions;
+    /**
+     * The ID of the device containing the file. Only available on Unix.
+     */
+    dev: number | undefined;
+    /**
+     * The inode number. Only available on Unix.
+     */
+    ino: number | undefined;
+    /**
+     * The rights applied to this file. Only available on Unix.
+     */
+    mode: number | undefined;
+    /**
+     * The number of hard links pointing to this file. Only available on Unix.
+     */
+    nlink: number | undefined;
+    /**
+     * The user ID of the owner of this file. Only available on Unix.
+     */
+    uid: number | undefined;
+    /**
+     * The group ID of the owner of this file. Only available on Unix.
+     */
+    gid: number | undefined;
+    /**
+     * The device ID of this file (if it is a special one). Only available on Unix.
+     */
+    rdev: number | undefined;
+    /**
+     * The block size for filesystem I/O. Only available on Unix.
+     */
+    blksize: number | undefined;
+    /**
+     * The number of blocks allocated to the file, in 512-byte units. Only available on Unix.
+     */
+    blocks: number | undefined;
+}
+/**
+ * @since 2.0.0
+ */
+interface FsOptions {
+    dir?: BaseDirectory;
+}
+/**
+ * @since 2.0.0
+ */
+interface FsDirOptions {
+    dir?: BaseDirectory;
+    recursive?: boolean;
+}
+/**
+ * Options object used to write a UTF-8 string to a file.
+ *
+ * @since 2.0.0
+ */
+interface FsTextFileOption {
+    /** Path to the file to write. */
+    path: string;
+    /** The UTF-8 string to write to the file. */
+    contents: string;
+}
+type BinaryFileContents = Iterable<number> | ArrayLike<number> | ArrayBuffer;
+/**
+ * Options object used to write a binary data to a file.
+ *
+ * @since 2.0.0
+ */
+interface FsBinaryFileOption {
+    /** Path to the file to write. */
+    path: string;
+    /** The byte array contents. */
+    contents: BinaryFileContents;
+}
+/**
+ * @since 2.0.0
+ */
+interface FileEntry {
+    path: string;
+    /**
+     * Name of the directory/file
+     * can be null if the path terminates with `..`
+     */
+    name?: string;
+    /** Children of this entry if it's a directory; null otherwise */
+    children?: FileEntry[];
+}
+/**
+ * Reads a file as an UTF-8 encoded string.
+ * @example
+ * ```typescript
+ * import { readTextFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Read the text file in the `$APPCONFIG/app.conf` path
+ * const contents = await readTextFile('app.conf', { dir: BaseDirectory.AppConfig });
+ * ```
+ *
+ * @since 2.0.0
+ */
+declare function readTextFile(filePath: string, options?: FsOptions): Promise<string>;
+/**
+ * Reads a file as byte array.
+ * @example
+ * ```typescript
+ * import { readBinaryFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Read the image file in the `$RESOURCEDIR/avatar.png` path
+ * const contents = await readBinaryFile('avatar.png', { dir: BaseDirectory.Resource });
+ * ```
+ *
+ * @since 2.0.0
+ */
+declare function readBinaryFile(filePath: string, options?: FsOptions): Promise<Uint8Array>;
+/**
+ * Writes a UTF-8 text file.
+ * @example
+ * ```typescript
+ * import { writeTextFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Write a text file to the `$APPCONFIG/app.conf` path
+ * await writeTextFile('app.conf', 'file contents', { dir: BaseDirectory.AppConfig });
+ * ```
+ *
+ * @since 2.0.0
+ */
+declare function writeTextFile(path: string, contents: string, options?: FsOptions): Promise<void>;
+/**
+ * Writes a UTF-8 text file.
+ * @example
+ * ```typescript
+ * import { writeTextFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Write a text file to the `$APPCONFIG/app.conf` path
+ * await writeTextFile({ path: 'app.conf', contents: 'file contents' }, { dir: BaseDirectory.AppConfig });
+ * ```
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function writeTextFile(file: FsTextFileOption, options?: FsOptions): Promise<void>;
+/**
+ * Writes a byte array content to a file.
+ * @example
+ * ```typescript
+ * import { writeBinaryFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Write a binary file to the `$APPDATA/avatar.png` path
+ * await writeBinaryFile('avatar.png', new Uint8Array([]), { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @param options Configuration object.
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function writeBinaryFile(path: string, contents: BinaryFileContents, options?: FsOptions): Promise<void>;
+/**
+ * Writes a byte array content to a file.
+ * @example
+ * ```typescript
+ * import { writeBinaryFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Write a binary file to the `$APPDATA/avatar.png` path
+ * await writeBinaryFile({ path: 'avatar.png', contents: new Uint8Array([]) }, { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @param file The object containing the file path and contents.
+ * @param options Configuration object.
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function writeBinaryFile(file: FsBinaryFileOption, options?: FsOptions): Promise<void>;
+/**
+ * List directory files.
+ * @example
+ * ```typescript
+ * import { readDir, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Reads the `$APPDATA/users` directory recursively
+ * const entries = await readDir('users', { dir: BaseDirectory.AppData, recursive: true });
+ *
+ * function processEntries(entries) {
+ *   for (const entry of entries) {
+ *     console.log(`Entry: ${entry.path}`);
+ *     if (entry.children) {
+ *       processEntries(entry.children)
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @since 2.0.0
+ */
+declare function readDir(dir: string, options?: FsDirOptions): Promise<FileEntry[]>;
+/**
+ * Creates a directory.
+ * If one of the path's parent components doesn't exist
+ * and the `recursive` option isn't set to true, the promise will be rejected.
+ * @example
+ * ```typescript
+ * import { createDir, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Create the `$APPDATA/users` directory
+ * await createDir('users', { dir: BaseDirectory.AppData, recursive: true });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function createDir(dir: string, options?: FsDirOptions): Promise<void>;
+/**
+ * Removes a directory.
+ * If the directory is not empty and the `recursive` option isn't set to true, the promise will be rejected.
+ * @example
+ * ```typescript
+ * import { removeDir, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Remove the directory `$APPDATA/users`
+ * await removeDir('users', { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function removeDir(dir: string, options?: FsDirOptions): Promise<void>;
+/**
+ * Copies a file to a destination.
+ * @example
+ * ```typescript
+ * import { copyFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Copy the `$APPCONFIG/app.conf` file to `$APPCONFIG/app.conf.bk`
+ * await copyFile('app.conf', 'app.conf.bk', { dir: BaseDirectory.AppConfig });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function copyFile(source: string, destination: string, options?: FsOptions): Promise<void>;
+/**
+ * Removes a file.
+ * @example
+ * ```typescript
+ * import { removeFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Remove the `$APPConfig/app.conf` file
+ * await removeFile('app.conf', { dir: BaseDirectory.AppConfig });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function removeFile(file: string, options?: FsOptions): Promise<void>;
+/**
+ * Renames a file.
+ * @example
+ * ```typescript
+ * import { renameFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Rename the `$APPDATA/avatar.png` file
+ * await renameFile('avatar.png', 'deleted.png', { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function renameFile(oldPath: string, newPath: string, options?: FsOptions): Promise<void>;
+/**
+ * Check if a path exists.
+ * @example
+ * ```typescript
+ * import { exists, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Check if the `$APPDATA/avatar.png` file exists
+ * await exists('avatar.png', { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @since 2.0.0
+ */
+declare function exists(path: string): Promise<boolean>;
+/**
+ * Returns the metadata for the given path.
+ *
+ * @since 2.0.0
+ */
+declare function metadata(path: string): Promise<Metadata>;
+export type { FsOptions, FsDirOptions, FsTextFileOption, BinaryFileContents, FsBinaryFileOption, FileEntry, Permissions, Metadata, };
+export { BaseDirectory, BaseDirectory as Dir, readTextFile, readBinaryFile, writeTextFile, writeTextFile as writeFile, writeBinaryFile, readDir, createDir, removeDir, copyFile, removeFile, renameFile, exists, metadata, };

package/dist-js/index.min.js

@@ -0,0 +1,278 @@
+var f$2=Object.defineProperty;var g$1=(a,b)=>{for(var c in b)f$2(a,c,{get:b[c],enumerable:!0});};var e$1=(a,b,c)=>{if(!b.has(a))throw TypeError("Cannot "+c)};var h$2=(a,b,c)=>(e$1(a,b,"read from private field"),c?c.call(a):b.get(a)),i=(a,b,c)=>{if(b.has(a))throw TypeError("Cannot add the same private member more than once");b instanceof WeakSet?b.add(a):b.set(a,c);},j$1=(a,b,c,d)=>(e$1(a,b,"write to private field"),d?d.call(a,c):b.set(a,c),c);
+
+var f$1={};g$1(f$1,{Channel:()=>a$1,PluginListener:()=>c$1,addPluginListener:()=>v$1,convertFileSrc:()=>m$1,invoke:()=>u$1,transformCallback:()=>o});function h$1(){return window.crypto.getRandomValues(new Uint32Array(1))[0]}function o(t,e=!1){let n=h$1(),r=`_${n}`;return Object.defineProperty(window,r,{value:i=>(e&&Reflect.deleteProperty(window,r),t?.(i)),writable:!1,configurable:!0}),n}var s,a$1=class a{constructor(){this.__TAURI_CHANNEL_MARKER__=!0;i(this,s,()=>{});this.id=o(e=>{h$2(this,s).call(this,e);});}set onmessage(e){j$1(this,s,e);}get onmessage(){return h$2(this,s)}toJSON(){return `__CHANNEL__:${this.id}`}};s=new WeakMap;var c$1=class c{constructor(e,n,r){this.plugin=e,this.event=n,this.channelId=r;}async unregister(){return u$1(`plugin:${this.plugin}|remove_listener`,{event:this.event,channelId:this.channelId})}};async function v$1(t,e,n){let r=new a$1;return r.onmessage=n,u$1(`plugin:${t}|register_listener`,{event:e,handler:r}).then(()=>new c$1(t,e,r.id))}async function u$1(t,e={}){return new Promise((n,r)=>{let i=o(d=>{n(d),Reflect.deleteProperty(window,`_${g}`);},!0),g=o(d=>{r(d),Reflect.deleteProperty(window,`_${i}`);},!0);window.__TAURI_IPC__({cmd:t,callback:i,error:g,...e});})}function m$1(t,e="asset"){let n=encodeURIComponent(t);return navigator.userAgent.includes("Windows")?`https://${e}.localhost/${n}`:`${e}://localhost/${n}`}
+
+var O={};g$1(O,{BaseDirectory:()=>e,appCacheDir:()=>p,appConfigDir:()=>u,appDataDir:()=>c,appLocalDataDir:()=>a,appLogDir:()=>V,audioDir:()=>l,basename:()=>H,cacheDir:()=>g,configDir:()=>d,dataDir:()=>m,delimiter:()=>T,desktopDir:()=>y,dirname:()=>E,documentDir:()=>f,downloadDir:()=>h,executableDir:()=>P,extname:()=>F,fontDir:()=>v,homeDir:()=>_,isAbsolute:()=>M,join:()=>z,localDataDir:()=>D,normalize:()=>j,pictureDir:()=>b,publicDir:()=>A,resolve:()=>W,resolveResource:()=>L,resourceDir:()=>C,runtimeDir:()=>x,sep:()=>k,templateDir:()=>R,videoDir:()=>w});function t(){return navigator.appVersion.includes("Win")}var e=(r=>(r[r.Audio=1]="Audio",r[r.Cache=2]="Cache",r[r.Config=3]="Config",r[r.Data=4]="Data",r[r.LocalData=5]="LocalData",r[r.Document=6]="Document",r[r.Download=7]="Download",r[r.Picture=8]="Picture",r[r.Public=9]="Public",r[r.Video=10]="Video",r[r.Resource=11]="Resource",r[r.Temp=12]="Temp",r[r.AppConfig=13]="AppConfig",r[r.AppData=14]="AppData",r[r.AppLocalData=15]="AppLocalData",r[r.AppCache=16]="AppCache",r[r.AppLog=17]="AppLog",r[r.Desktop=18]="Desktop",r[r.Executable=19]="Executable",r[r.Font=20]="Font",r[r.Home=21]="Home",r[r.Runtime=22]="Runtime",r[r.Template=23]="Template",r))(e||{});async function u(){return u$1("plugin:path|resolve_directory",{directory:13})}async function c(){return u$1("plugin:path|resolve_directory",{directory:14})}async function a(){return u$1("plugin:path|resolve_directory",{directory:15})}async function p(){return u$1("plugin:path|resolve_directory",{directory:16})}async function l(){return u$1("plugin:path|resolve_directory",{directory:1})}async function g(){return u$1("plugin:path|resolve_directory",{directory:2})}async function d(){return u$1("plugin:path|resolve_directory",{directory:3})}async function m(){return u$1("plugin:path|resolve_directory",{directory:4})}async function y(){return u$1("plugin:path|resolve_directory",{directory:18})}async function f(){return u$1("plugin:path|resolve_directory",{directory:6})}async function h(){return u$1("plugin:path|resolve_directory",{directory:7})}async function P(){return u$1("plugin:path|resolve_directory",{directory:19})}async function v(){return u$1("plugin:path|resolve_directory",{directory:20})}async function _(){return u$1("plugin:path|resolve_directory",{directory:21})}async function D(){return u$1("plugin:path|resolve_directory",{directory:5})}async function b(){return u$1("plugin:path|resolve_directory",{directory:8})}async function A(){return u$1("plugin:path|resolve_directory",{directory:9})}async function C(){return u$1("plugin:path|resolve_directory",{directory:11})}async function L(i){return u$1("plugin:path|resolve_directory",{directory:11,path:i})}async function x(){return u$1("plugin:path|resolve_directory",{directory:22})}async function R(){return u$1("plugin:path|resolve_directory",{directory:23})}async function w(){return u$1("plugin:path|resolve_directory",{directory:10})}async function V(){return u$1("plugin:path|resolve_directory",{directory:17})}var k=t()?"\\":"/",T=t()?";":":";async function W(...i){return u$1("plugin:path|resolve",{paths:i})}async function j(i){return u$1("plugin:path|normalize",{path:i})}async function z(...i){return u$1("plugin:path|join",{paths:i})}async function E(i){return u$1("plugin:path|dirname",{path:i})}async function F(i){return u$1("plugin:path|extname",{path:i})}async function H(i,o){return u$1("plugin:path|basename",{path:i,ext:o})}async function M(i){return u$1("plugin:path|isAbsolute",{path:i})}
+
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+/**
+ * Reads a file as an UTF-8 encoded string.
+ * @example
+ * ```typescript
+ * import { readTextFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Read the text file in the `$APPCONFIG/app.conf` path
+ * const contents = await readTextFile('app.conf', { dir: BaseDirectory.AppConfig });
+ * ```
+ *
+ * @since 2.0.0
+ */
+async function readTextFile(filePath, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|read_text_file", {
+        path: filePath,
+        options,
+    });
+}
+/**
+ * Reads a file as byte array.
+ * @example
+ * ```typescript
+ * import { readBinaryFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Read the image file in the `$RESOURCEDIR/avatar.png` path
+ * const contents = await readBinaryFile('avatar.png', { dir: BaseDirectory.Resource });
+ * ```
+ *
+ * @since 2.0.0
+ */
+async function readBinaryFile(filePath, options = {}) {
+    const arr = await window.__TAURI_INVOKE__("plugin:fs|read_file", {
+        path: filePath,
+        options,
+    });
+    return Uint8Array.from(arr);
+}
+/**
+ * Writes a UTF-8 text file.
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeTextFile(path, contents, options) {
+    if (typeof options === "object") {
+        Object.freeze(options);
+    }
+    if (typeof path === "object") {
+        Object.freeze(path);
+    }
+    const file = { path: "", contents: "" };
+    let fileOptions = options;
+    if (typeof path === "string") {
+        file.path = path;
+    }
+    else {
+        file.path = path.path;
+        file.contents = path.contents;
+    }
+    if (typeof contents === "string") {
+        file.contents = contents !== null && contents !== void 0 ? contents : "";
+    }
+    else {
+        fileOptions = contents;
+    }
+    return await window.__TAURI_INVOKE__("plugin:fs|write_file", {
+        path: file.path,
+        contents: Array.from(new TextEncoder().encode(file.contents)),
+        options: fileOptions,
+    });
+}
+/**
+ * Writes a byte array content to a file.
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeBinaryFile(path, contents, options) {
+    if (typeof options === "object") {
+        Object.freeze(options);
+    }
+    if (typeof path === "object") {
+        Object.freeze(path);
+    }
+    const file = { path: "", contents: [] };
+    let fileOptions = options;
+    if (typeof path === "string") {
+        file.path = path;
+    }
+    else {
+        file.path = path.path;
+        file.contents = path.contents;
+    }
+    if (contents && "dir" in contents) {
+        fileOptions = contents;
+    }
+    else if (typeof path === "string") {
+        // @ts-expect-error in this case `contents` is always a BinaryFileContents
+        file.contents = contents !== null && contents !== void 0 ? contents : [];
+    }
+    return await window.__TAURI_INVOKE__("plugin:fs|write_binary_file", {
+        path: file.path,
+        contents: Array.from(file.contents instanceof ArrayBuffer
+            ? new Uint8Array(file.contents)
+            : file.contents),
+        options: fileOptions,
+    });
+}
+/**
+ * List directory files.
+ * @example
+ * ```typescript
+ * import { readDir, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Reads the `$APPDATA/users` directory recursively
+ * const entries = await readDir('users', { dir: BaseDirectory.AppData, recursive: true });
+ *
+ * function processEntries(entries) {
+ *   for (const entry of entries) {
+ *     console.log(`Entry: ${entry.path}`);
+ *     if (entry.children) {
+ *       processEntries(entry.children)
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @since 2.0.0
+ */
+async function readDir(dir, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|read_dir", {
+        path: dir,
+        options,
+    });
+}
+/**
+ * Creates a directory.
+ * If one of the path's parent components doesn't exist
+ * and the `recursive` option isn't set to true, the promise will be rejected.
+ * @example
+ * ```typescript
+ * import { createDir, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Create the `$APPDATA/users` directory
+ * await createDir('users', { dir: BaseDirectory.AppData, recursive: true });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function createDir(dir, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|create_dir", {
+        path: dir,
+        options,
+    });
+}
+/**
+ * Removes a directory.
+ * If the directory is not empty and the `recursive` option isn't set to true, the promise will be rejected.
+ * @example
+ * ```typescript
+ * import { removeDir, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Remove the directory `$APPDATA/users`
+ * await removeDir('users', { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function removeDir(dir, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|remove_dir", {
+        path: dir,
+        options,
+    });
+}
+/**
+ * Copies a file to a destination.
+ * @example
+ * ```typescript
+ * import { copyFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Copy the `$APPCONFIG/app.conf` file to `$APPCONFIG/app.conf.bk`
+ * await copyFile('app.conf', 'app.conf.bk', { dir: BaseDirectory.AppConfig });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function copyFile(source, destination, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|copy_file", {
+        source,
+        destination,
+        options,
+    });
+}
+/**
+ * Removes a file.
+ * @example
+ * ```typescript
+ * import { removeFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Remove the `$APPConfig/app.conf` file
+ * await removeFile('app.conf', { dir: BaseDirectory.AppConfig });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function removeFile(file, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|remove_file", {
+        path: file,
+        options,
+    });
+}
+/**
+ * Renames a file.
+ * @example
+ * ```typescript
+ * import { renameFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Rename the `$APPDATA/avatar.png` file
+ * await renameFile('avatar.png', 'deleted.png', { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function renameFile(oldPath, newPath, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|rename_file", {
+        oldPath,
+        newPath,
+        options,
+    });
+}
+/**
+ * Check if a path exists.
+ * @example
+ * ```typescript
+ * import { exists, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Check if the `$APPDATA/avatar.png` file exists
+ * await exists('avatar.png', { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @since 2.0.0
+ */
+async function exists(path) {
+    return await window.__TAURI_INVOKE__("plugin:fs|exists", { path });
+}
+/**
+ * Returns the metadata for the given path.
+ *
+ * @since 2.0.0
+ */
+async function metadata(path) {
+    return await window
+        .__TAURI_INVOKE__("plugin:fs|metadata", {
+        path,
+    })
+        .then((metadata) => {
+        const { accessedAtMs, createdAtMs, modifiedAtMs, ...data } = metadata;
+        return {
+            accessedAt: new Date(accessedAtMs),
+            createdAt: new Date(createdAtMs),
+            modifiedAt: new Date(modifiedAtMs),
+            ...data,
+        };
+    });
+}
+
+export { e as BaseDirectory, e as Dir, copyFile, createDir, exists, metadata, readBinaryFile, readDir, readTextFile, removeDir, removeFile, renameFile, writeBinaryFile, writeTextFile as writeFile, writeTextFile };
+//# sourceMappingURL=index.min.js.map

package/dist-js/index.mjs

@@ -0,0 +1,274 @@
+export { BaseDirectory, BaseDirectory as Dir } from '@tauri-apps/api/path';
+
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+/**
+ * Reads a file as an UTF-8 encoded string.
+ * @example
+ * ```typescript
+ * import { readTextFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Read the text file in the `$APPCONFIG/app.conf` path
+ * const contents = await readTextFile('app.conf', { dir: BaseDirectory.AppConfig });
+ * ```
+ *
+ * @since 2.0.0
+ */
+async function readTextFile(filePath, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|read_text_file", {
+        path: filePath,
+        options,
+    });
+}
+/**
+ * Reads a file as byte array.
+ * @example
+ * ```typescript
+ * import { readBinaryFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Read the image file in the `$RESOURCEDIR/avatar.png` path
+ * const contents = await readBinaryFile('avatar.png', { dir: BaseDirectory.Resource });
+ * ```
+ *
+ * @since 2.0.0
+ */
+async function readBinaryFile(filePath, options = {}) {
+    const arr = await window.__TAURI_INVOKE__("plugin:fs|read_file", {
+        path: filePath,
+        options,
+    });
+    return Uint8Array.from(arr);
+}
+/**
+ * Writes a UTF-8 text file.
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeTextFile(path, contents, options) {
+    if (typeof options === "object") {
+        Object.freeze(options);
+    }
+    if (typeof path === "object") {
+        Object.freeze(path);
+    }
+    const file = { path: "", contents: "" };
+    let fileOptions = options;
+    if (typeof path === "string") {
+        file.path = path;
+    }
+    else {
+        file.path = path.path;
+        file.contents = path.contents;
+    }
+    if (typeof contents === "string") {
+        file.contents = contents !== null && contents !== void 0 ? contents : "";
+    }
+    else {
+        fileOptions = contents;
+    }
+    return await window.__TAURI_INVOKE__("plugin:fs|write_file", {
+        path: file.path,
+        contents: Array.from(new TextEncoder().encode(file.contents)),
+        options: fileOptions,
+    });
+}
+/**
+ * Writes a byte array content to a file.
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeBinaryFile(path, contents, options) {
+    if (typeof options === "object") {
+        Object.freeze(options);
+    }
+    if (typeof path === "object") {
+        Object.freeze(path);
+    }
+    const file = { path: "", contents: [] };
+    let fileOptions = options;
+    if (typeof path === "string") {
+        file.path = path;
+    }
+    else {
+        file.path = path.path;
+        file.contents = path.contents;
+    }
+    if (contents && "dir" in contents) {
+        fileOptions = contents;
+    }
+    else if (typeof path === "string") {
+        // @ts-expect-error in this case `contents` is always a BinaryFileContents
+        file.contents = contents !== null && contents !== void 0 ? contents : [];
+    }
+    return await window.__TAURI_INVOKE__("plugin:fs|write_binary_file", {
+        path: file.path,
+        contents: Array.from(file.contents instanceof ArrayBuffer
+            ? new Uint8Array(file.contents)
+            : file.contents),
+        options: fileOptions,
+    });
+}
+/**
+ * List directory files.
+ * @example
+ * ```typescript
+ * import { readDir, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Reads the `$APPDATA/users` directory recursively
+ * const entries = await readDir('users', { dir: BaseDirectory.AppData, recursive: true });
+ *
+ * function processEntries(entries) {
+ *   for (const entry of entries) {
+ *     console.log(`Entry: ${entry.path}`);
+ *     if (entry.children) {
+ *       processEntries(entry.children)
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @since 2.0.0
+ */
+async function readDir(dir, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|read_dir", {
+        path: dir,
+        options,
+    });
+}
+/**
+ * Creates a directory.
+ * If one of the path's parent components doesn't exist
+ * and the `recursive` option isn't set to true, the promise will be rejected.
+ * @example
+ * ```typescript
+ * import { createDir, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Create the `$APPDATA/users` directory
+ * await createDir('users', { dir: BaseDirectory.AppData, recursive: true });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function createDir(dir, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|create_dir", {
+        path: dir,
+        options,
+    });
+}
+/**
+ * Removes a directory.
+ * If the directory is not empty and the `recursive` option isn't set to true, the promise will be rejected.
+ * @example
+ * ```typescript
+ * import { removeDir, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Remove the directory `$APPDATA/users`
+ * await removeDir('users', { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function removeDir(dir, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|remove_dir", {
+        path: dir,
+        options,
+    });
+}
+/**
+ * Copies a file to a destination.
+ * @example
+ * ```typescript
+ * import { copyFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Copy the `$APPCONFIG/app.conf` file to `$APPCONFIG/app.conf.bk`
+ * await copyFile('app.conf', 'app.conf.bk', { dir: BaseDirectory.AppConfig });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function copyFile(source, destination, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|copy_file", {
+        source,
+        destination,
+        options,
+    });
+}
+/**
+ * Removes a file.
+ * @example
+ * ```typescript
+ * import { removeFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Remove the `$APPConfig/app.conf` file
+ * await removeFile('app.conf', { dir: BaseDirectory.AppConfig });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function removeFile(file, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|remove_file", {
+        path: file,
+        options,
+    });
+}
+/**
+ * Renames a file.
+ * @example
+ * ```typescript
+ * import { renameFile, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Rename the `$APPDATA/avatar.png` file
+ * await renameFile('avatar.png', 'deleted.png', { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function renameFile(oldPath, newPath, options = {}) {
+    return await window.__TAURI_INVOKE__("plugin:fs|rename_file", {
+        oldPath,
+        newPath,
+        options,
+    });
+}
+/**
+ * Check if a path exists.
+ * @example
+ * ```typescript
+ * import { exists, BaseDirectory } from '@tauri-apps/plugin-fs';
+ * // Check if the `$APPDATA/avatar.png` file exists
+ * await exists('avatar.png', { dir: BaseDirectory.AppData });
+ * ```
+ *
+ * @since 2.0.0
+ */
+async function exists(path) {
+    return await window.__TAURI_INVOKE__("plugin:fs|exists", { path });
+}
+/**
+ * Returns the metadata for the given path.
+ *
+ * @since 2.0.0
+ */
+async function metadata(path) {
+    return await window
+        .__TAURI_INVOKE__("plugin:fs|metadata", {
+        path,
+    })
+        .then((metadata) => {
+        const { accessedAtMs, createdAtMs, modifiedAtMs, ...data } = metadata;
+        return {
+            accessedAt: new Date(accessedAtMs),
+            createdAt: new Date(createdAtMs),
+            modifiedAt: new Date(modifiedAtMs),
+            ...data,
+        };
+    });
+}
+
+export { copyFile, createDir, exists, metadata, readBinaryFile, readDir, readTextFile, removeDir, removeFile, renameFile, writeBinaryFile, writeTextFile as writeFile, writeTextFile };
+//# sourceMappingURL=index.mjs.map

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@tauri-apps/plugin-fs",
+  "version": "2.0.0-alpha.0",
+  "description": "Access the file system.",
+  "license": "MIT or APACHE-2.0",
+  "authors": [
+    "Tauri Programme within The Commons Conservancy"
+  ],
+  "type": "module",
+  "browser": "dist-js/index.min.js",
+  "module": "dist-js/index.mjs",
+  "types": "dist-js/index.d.ts",
+  "exports": {
+    "import": "./dist-js/index.mjs",
+    "types": "./dist-js/index.d.ts",
+    "browser": "./dist-js/index.min.js"
+  },
+  "files": [
+    "dist-js",
+    "!dist-js/**/*.map",
+    "README.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "tslib": "^2.4.1"
+  },
+  "dependencies": {
+    "@tauri-apps/api": "2.0.0-alpha.4"
+  },
+  "scripts": {
+    "build": "rollup -c"
+  }
+}