feat(http): add plugin (#325)

2026-07-24 17:20:51 +02:00 · 2023-04-23 11:34:31 -07:00
parent 7a8633f429
commit 89fb40caac
17 changed files with 5370 additions and 4 deletions
@@ -1,6 +1,6 @@
 [workspace]
 members = ["plugins/*"]
-exclude = ["plugins/fs"]
+exclude = ["plugins/fs", "plugins/http"]
 resolver = "2"
 [workspace.dependencies]
@@ -0,0 +1,31 @@
 [package]
 name = "tauri-plugin-http"
 version = "0.1.0"
 edition = "2021"
 #edition.workspace = true
 #authors.workspace = true
 #license.workspace = true
 [dependencies]
 #serde.workspace = true
 #serde_json.workspace = true
 #tauri.workspace = true
 #log.workspace = true
 #thiserror.workspace = true
 tauri = { git = "https://github.com/tauri-apps/tauri", branch = "next" }
 serde = "1"
 serde_json = "1"
 thiserror = "1"
 glob = "0.3"
 rand = "0.8"
 bytes = { version = "1", features = [ "serde" ] }
 serde_repr = "0.1"
 http = "0.2"
 reqwest = { version = "0.11", default-features = false, features = [ "json", "stream" ] }
 [features]
 http-multipart = [ "reqwest/multipart" ]
 native-tls = [ "reqwest/native-tls" ]
 native-tls-vendored = [ "reqwest/native-tls-vendored" ]
 rustls-tls = [ "reqwest/rustls-tls" ]
@@ -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
@@ -0,0 +1,177 @@
                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/
   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
   1. Definitions.
      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.
      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.
      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.
      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.
      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.
      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.
      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).
      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.
      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."
      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.
   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.
   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.
   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:
      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and
      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and
      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and
      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.
      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.
   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.
   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.
   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.
   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.
   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.
   END OF TERMS AND CONDITIONS
@@ -0,0 +1,21 @@
 MIT License
 Copyright (c) 2017 - Present Tauri Apps Contributors
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
@@ -0,0 +1,65 @@
 ![{{plugin name}}](banner.jpg)
 <!-- description -->
 ## Install
 _This plugin requires a Rust version of at least **1.64**_
 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]
 <!-- plugin here --> = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" }
 ```
 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 <!-- plugin here -->
 # or
 npm add <!-- plugin here -->
 # or
 yarn add <!-- plugin here -->
 ```
 ## Usage
 First you need to register the core plugin with Tauri:
 `src-tauri/src/main.rs`
 ```rust
 fn main() {
    tauri::Builder::default()
        .plugin(<!-- plugin here -->)
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
 }
 ```
 Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
 ```javascript
 ```
 ## 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.
@@ -0,0 +1,541 @@
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 /**
 * Access the HTTP client written in Rust.
 *
 * The APIs must be allowlisted on `tauri.conf.json`:
 * ```json
 * {
 *   "tauri": {
 *     "allowlist": {
 *       "http": {
 *         "all": true, // enable all http APIs
 *         "request": true // enable HTTP request API
 *       }
 *     }
 *   }
 * }
 * ```
 * It is recommended to allowlist only the APIs you use for optimal bundle size and security.
 *
 * ## Security
 *
 * This API has a scope configuration that forces you to restrict the URLs and paths that can be accessed using glob patterns.
 *
 * For instance, this scope configuration only allows making HTTP requests to the GitHub API for the `tauri-apps` organization:
 * ```json
 * {
 *   "tauri": {
 *     "allowlist": {
 *       "http": {
 *         "scope": ["https://api.github.com/repos/tauri-apps/*"]
 *       }
 *     }
 *   }
 * }
 * ```
 * Trying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access.
 *
 * @module
 */
 import { invoke } from '@tauri-apps/api/tauri'
 /**
 * @since 1.0.0
 */
 interface Duration {
  secs: number
  nanos: number
 }
 /**
 * @since 1.0.0
 */
 interface ClientOptions {
  /**
   * Defines the maximum number of redirects the client should follow.
   * If set to 0, no redirects will be followed.
   */
  maxRedirections?: number
  connectTimeout?: number | Duration
 }
 /**
 * @since 1.0.0
 */
 enum ResponseType {
  JSON = 1,
  Text = 2,
  Binary = 3
 }
 /**
 * @since 1.0.0
 */
 interface FilePart<T> {
  file: string | T
  mime?: string
  fileName?: string
 }
 type Part = string | Uint8Array | FilePart<Uint8Array>
 /**
 * The body object to be used on POST and PUT requests.
 *
 * @since 1.0.0
 */
 class Body {
  type: string
  payload: unknown
  /** @ignore */
  private constructor(type: string, payload: unknown) {
    this.type = type
    this.payload = payload
  }
  /**
   * Creates a new form data body. The form data is an object where each key is the entry name,
   * and the value is either a string or a file object.
   *
   * By default it sets the `application/x-www-form-urlencoded` Content-Type header,
   * but you can set it to `multipart/form-data` if the Cargo feature `http-multipart` is enabled.
   *
   * Note that a file path must be allowed in the `fs` allowlist scope.
   * @example
   * ```typescript
   * import { Body } from "tauri-plugin-http-api"
   * const body = Body.form({
   *   key: 'value',
   *   image: {
   *     file: '/path/to/file', // either a path or an array buffer of the file contents
   *     mime: 'image/jpeg', // optional
   *     fileName: 'image.jpg' // optional
   *   }
   * });
   *
   * // alternatively, use a FormData:
   * const form = new FormData();
   * form.append('key', 'value');
   * form.append('image', file, 'image.png');
   * const formBody = Body.form(form);
   * ```
   *
   * @param data The body data.
   *
   * @returns The body object ready to be used on the POST and PUT requests.
   */
  static form(data: Record<string, Part> | FormData): Body {
    const form: Record<string, string | number[] | FilePart<number[]>> = {}
    const append = (
      key: string,
      v: string | Uint8Array | FilePart<Uint8Array> | File
    ): void => {
      if (v !== null) {
        let r
        if (typeof v === 'string') {
          r = v
        } else if (v instanceof Uint8Array || Array.isArray(v)) {
          r = Array.from(v)
        } else if (v instanceof File) {
          r = { file: v.name, mime: v.type, fileName: v.name }
        } else if (typeof v.file === 'string') {
          r = { file: v.file, mime: v.mime, fileName: v.fileName }
        } else {
          r = { file: Array.from(v.file), mime: v.mime, fileName: v.fileName }
        }
        form[String(key)] = r
      }
    }
    if (data instanceof FormData) {
      for (const [key, value] of data) {
        append(key, value)
      }
    } else {
      for (const [key, value] of Object.entries(data)) {
        append(key, value)
      }
    }
    return new Body('Form', form)
  }
  /**
   * Creates a new JSON body.
   * @example
   * ```typescript
   * import { Body } from "tauri-plugin-http-api"
   * Body.json({
   *   registered: true,
   *   name: 'tauri'
   * });
   * ```
   *
   * @param data The body JSON object.
   *
   * @returns The body object ready to be used on the POST and PUT requests.
   */
  static json<K extends string | number | symbol, V>(data: Record<K, V>): Body {
    return new Body('Json', data)
  }
  /**
   * Creates a new UTF-8 string body.
   * @example
   * ```typescript
   * import { Body } from "tauri-plugin-http-api"
   * Body.text('The body content as a string');
   * ```
   *
   * @param value The body string.
   *
   * @returns The body object ready to be used on the POST and PUT requests.
   */
  static text(value: string): Body {
    return new Body('Text', value)
  }
  /**
   * Creates a new byte array body.
   * @example
   * ```typescript
   * import { Body } from "tauri-plugin-http-api"
   * Body.bytes(new Uint8Array([1, 2, 3]));
   * ```
   *
   * @param bytes The body byte array.
   *
   * @returns The body object ready to be used on the POST and PUT requests.
   */
  static bytes(
    bytes: Iterable<number> | ArrayLike<number> | ArrayBuffer
  ): Body {
    // stringifying Uint8Array doesn't return an array of numbers, so we create one here
    return new Body(
      'Bytes',
      Array.from(bytes instanceof ArrayBuffer ? new Uint8Array(bytes) : bytes)
    )
  }
 }
 /** The request HTTP verb. */
 type HttpVerb =
  | 'GET'
  | 'POST'
  | 'PUT'
  | 'DELETE'
  | 'PATCH'
  | 'HEAD'
  | 'OPTIONS'
  | 'CONNECT'
  | 'TRACE'
 /**
 * Options object sent to the backend.
 *
 * @since 1.0.0
 */
 interface HttpOptions {
  method: HttpVerb
  url: string
  headers?: Record<string, unknown>
  query?: Record<string, unknown>
  body?: Body
  timeout?: number | Duration
  responseType?: ResponseType
 }
 /** Request options. */
 type RequestOptions = Omit<HttpOptions, 'method' | 'url'>
 /** Options for the `fetch` API. */
 type FetchOptions = Omit<HttpOptions, 'url'>
 /** @ignore */
 interface IResponse<T> {
  url: string
  status: number
  headers: Record<string, string>
  rawHeaders: Record<string, string[]>
  data: T
 }
 /**
 * Response object.
 *
 * @since 1.0.0
 * */
 class Response<T> {
  /** The request URL. */
  url: string
  /** The response status code. */
  status: number
  /** A boolean indicating whether the response was successful (status in the range 200–299) or not. */
  ok: boolean
  /** The response headers. */
  headers: Record<string, string>
  /** The response raw headers. */
  rawHeaders: Record<string, string[]>
  /** The response data. */
  data: T
  /** @ignore */
  constructor(response: IResponse<T>) {
    this.url = response.url
    this.status = response.status
    this.ok = this.status >= 200 && this.status < 300
    this.headers = response.headers
    this.rawHeaders = response.rawHeaders
    this.data = response.data
  }
 }
 /**
 * @since 1.0.0
 */
 class Client {
  id: number
  /** @ignore */
  constructor(id: number) {
    this.id = id
  }
  /**
   * Drops the client instance.
   * @example
   * ```typescript
   * import { getClient } from 'tauri-plugin-http-api';
   * const client = await getClient();
   * await client.drop();
   * ```
   */
  async drop(): Promise<void> {
    return invoke('plugin:http|drop_client', {
      client: this.id
    })
  }
  /**
   * Makes an HTTP request.
   * @example
   * ```typescript
   * import { getClient } from 'tauri-plugin-http-api';
   * const client = await getClient();
   * const response = await client.request({
   *   method: 'GET',
   *   url: 'http://localhost:3003/users',
   * });
   * ```
   */
  async request<T>(options: HttpOptions): Promise<Response<T>> {
    const jsonResponse =
      !options.responseType || options.responseType === ResponseType.JSON
    if (jsonResponse) {
      options.responseType = ResponseType.Text
    }
    return invoke<IResponse<T>>('plugin:http|request', {
      client: this.id,
      options
    }).then((res) => {
      const response = new Response(res)
      if (jsonResponse) {
        /* eslint-disable */
        try {
          response.data = JSON.parse(response.data as string)
        } catch (e) {
          if (response.ok && (response.data as unknown as string) === '') {
            response.data = {} as T
          } else if (response.ok) {
            throw Error(
              `Failed to parse response \`${response.data}\` as JSON: ${e};
              try setting the \`responseType\` option to \`ResponseType.Text\` or \`ResponseType.Binary\` if the API does not return a JSON response.`
            )
          }
        }
        /* eslint-enable */
        return response
      }
      return response
    })
  }
  /**
   * Makes a GET request.
   * @example
   * ```typescript
   * import { getClient, ResponseType } from 'tauri-plugin-http-api';
   * const client = await getClient();
   * const response = await client.get('http://localhost:3003/users', {
   *   timeout: 30,
   *   // the expected response type
   *   responseType: ResponseType.JSON
   * });
   * ```
   */
  async get<T>(url: string, options?: RequestOptions): Promise<Response<T>> {
    return this.request({
      method: 'GET',
      url,
      ...options
    })
  }
  /**
   * Makes a POST request.
   * @example
   * ```typescript
   * import { getClient, Body, ResponseType } from 'tauri-plugin-http-api';
   * const client = await getClient();
   * const response = await client.post('http://localhost:3003/users', {
   *   body: Body.json({
   *     name: 'tauri',
   *     password: 'awesome'
   *   }),
   *   // in this case the server returns a simple string
   *   responseType: ResponseType.Text,
   * });
   * ```
   */
  async post<T>(
    url: string,
    body?: Body,
    options?: RequestOptions
  ): Promise<Response<T>> {
    return this.request({
      method: 'POST',
      url,
      body,
      ...options
    })
  }
  /**
   * Makes a PUT request.
   * @example
   * ```typescript
   * import { getClient, Body } from 'tauri-plugin-http-api';
   * const client = await getClient();
   * const response = await client.put('http://localhost:3003/users/1', {
   *   body: Body.form({
   *     file: {
   *       file: '/home/tauri/avatar.png',
   *       mime: 'image/png',
   *       fileName: 'avatar.png'
   *     }
   *   })
   * });
   * ```
   */
  async put<T>(
    url: string,
    body?: Body,
    options?: RequestOptions
  ): Promise<Response<T>> {
    return this.request({
      method: 'PUT',
      url,
      body,
      ...options
    })
  }
  /**
   * Makes a PATCH request.
   * @example
   * ```typescript
   * import { getClient, Body } from 'tauri-plugin-http-api';
   * const client = await getClient();
   * const response = await client.patch('http://localhost:3003/users/1', {
   *   body: Body.json({ email: 'contact@tauri.app' })
   * });
   * ```
   */
  async patch<T>(url: string, options?: RequestOptions): Promise<Response<T>> {
    return this.request({
      method: 'PATCH',
      url,
      ...options
    })
  }
  /**
   * Makes a DELETE request.
   * @example
   * ```typescript
   * import { getClient } from 'tauri-plugin-http-api';
   * const client = await getClient();
   * const response = await client.delete('http://localhost:3003/users/1');
   * ```
   */
  async delete<T>(url: string, options?: RequestOptions): Promise<Response<T>> {
    return this.request({
      method: 'DELETE',
      url,
      ...options
    })
  }
 }
 /**
 * Creates a new client using the specified options.
 * @example
 * ```typescript
 * import { getClient } from 'tauri-plugin-http-api';
 * const client = await getClient();
 * ```
 *
 * @param options Client configuration.
 *
 * @returns A promise resolving to the client instance.
 *
 * @since 1.0.0
 */
 async function getClient(options?: ClientOptions): Promise<Client> {
  return invoke<number>('plugin:http|create_client', {
    options
  }).then((id) => new Client(id))
 }
 /** @internal */
 let defaultClient: Client | null = null
 /**
 * Perform an HTTP request using the default client.
 * @example
 * ```typescript
 * import { fetch } from 'tauri-plugin-http-api';
 * const response = await fetch('http://localhost:3003/users/2', {
 *   method: 'GET',
 *   timeout: 30,
 * });
 * ```
 */
 async function fetch<T>(
  url: string,
  options?: FetchOptions
 ): Promise<Response<T>> {
  if (defaultClient === null) {
    defaultClient = await getClient()
  }
  return defaultClient.request({
    url,
    method: options?.method ?? 'GET',
    ...options
  })
 }
 export type {
  Duration,
  ClientOptions,
  Part,
  HttpVerb,
  HttpOptions,
  RequestOptions,
  FetchOptions
 }
 export { getClient, fetch, Body, Client, Response, ResponseType, type FilePart }
@@ -0,0 +1,32 @@
 {
  "name": "tauri-plugin-http-api",
  "version": "0.0.0",
  "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"
  },
  "scripts": {
    "build": "rollup -c"
  },
  "files": [
    "dist-js",
    "!dist-js/**/*.map",
    "README.md",
    "LICENSE"
  ],
  "devDependencies": {
    "tslib": "^2.4.1"
  },
  "dependencies": {
    "@tauri-apps/api": "^1.2.0"
  }
 }
@@ -0,0 +1,11 @@
 import { readFileSync } from "fs";
 import { createConfig } from "../../shared/rollup.config.mjs";
 export default createConfig({
  input: "guest-js/index.ts",
  pkg: JSON.parse(
    readFileSync(new URL("./package.json", import.meta.url), "utf8")
  ),
  external: [/^@tauri-apps\/api/],
 });
@@ -0,0 +1,337 @@
 use std::{collections::HashMap, path::PathBuf, time::Duration};
 use reqwest::{header, Method, Url};
 use serde::{Deserialize, Deserializer, Serialize};
 use serde_json::Value;
 use serde_repr::{Deserialize_repr, Serialize_repr};
 #[derive(Deserialize)]
 #[serde(untagged)]
 enum SerdeDuration {
    Seconds(u64),
    Duration(Duration),
 }
 fn deserialize_duration<'de, D: Deserializer<'de>>(
    deserializer: D,
 ) -> std::result::Result<Option<Duration>, D::Error> {
    if let Some(duration) = Option::<SerdeDuration>::deserialize(deserializer)? {
        Ok(Some(match duration {
            SerdeDuration::Seconds(s) => Duration::from_secs(s),
            SerdeDuration::Duration(d) => d,
        }))
    } else {
        Ok(None)
    }
 }
 /// The builder of [`Client`].
 #[derive(Debug, Clone, Default, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct ClientBuilder {
    /// Max number of redirections to follow.
    pub max_redirections: Option<usize>,
    /// Connect timeout for the request.
    #[serde(deserialize_with = "deserialize_duration", default)]
    pub connect_timeout: Option<Duration>,
 }
 impl ClientBuilder {
    /// Builds the Client.
    pub fn build(self) -> crate::Result<Client> {
        let mut client_builder = reqwest::Client::builder();
        if let Some(max_redirections) = self.max_redirections {
            client_builder = client_builder.redirect(if max_redirections == 0 {
                reqwest::redirect::Policy::none()
            } else {
                reqwest::redirect::Policy::limited(max_redirections)
            });
        }
        if let Some(connect_timeout) = self.connect_timeout {
            client_builder = client_builder.connect_timeout(connect_timeout);
        }
        let client = client_builder.build()?;
        Ok(Client(client))
    }
 }
 /// The HTTP client based on [`reqwest`].
 #[derive(Debug, Clone)]
 pub struct Client(reqwest::Client);
 impl Client {
    /// Executes an HTTP request
    ///
    /// # Examples
    pub async fn send(&self, mut request: HttpRequestBuilder) -> crate::Result<Response> {
        let method = Method::from_bytes(request.method.to_uppercase().as_bytes())?;
        let mut request_builder = self.0.request(method, request.url.as_str());
        if let Some(query) = request.query {
            request_builder = request_builder.query(&query);
        }
        if let Some(timeout) = request.timeout {
            request_builder = request_builder.timeout(timeout);
        }
        if let Some(body) = request.body {
            request_builder = match body {
                Body::Bytes(data) => request_builder.body(bytes::Bytes::from(data)),
                Body::Text(text) => request_builder.body(bytes::Bytes::from(text)),
                Body::Json(json) => request_builder.json(&json),
                Body::Form(form_body) => {
                    #[allow(unused_variables)]
                    fn send_form(
                        request_builder: reqwest::RequestBuilder,
                        headers: &mut Option<HeaderMap>,
                        form_body: FormBody,
                    ) -> crate::Result<reqwest::RequestBuilder> {
                        #[cfg(feature = "http-multipart")]
                        if matches!(
                            headers
                                .as_ref()
                                .and_then(|h| h.0.get("content-type"))
                                .map(|v| v.as_bytes()),
                            Some(b"multipart/form-data")
                        ) {
                            // the Content-Type header will be set by reqwest in the `.multipart` call
                            headers.as_mut().map(|h| h.0.remove("content-type"));
                            let mut multipart = reqwest::multipart::Form::new();
                            for (name, part) in form_body.0 {
                                let part = match part {
                                    FormPart::File {
                                        file,
                                        mime,
                                        file_name,
                                    } => {
                                        let bytes: Vec<u8> = file.try_into()?;
                                        let mut part = reqwest::multipart::Part::bytes(bytes);
                                        if let Some(mime) = mime {
                                            part = part.mime_str(&mime)?;
                                        }
                                        if let Some(file_name) = file_name {
                                            part = part.file_name(file_name);
                                        }
                                        part
                                    }
                                    FormPart::Text(value) => reqwest::multipart::Part::text(value),
                                };
                                multipart = multipart.part(name, part);
                            }
                            return Ok(request_builder.multipart(multipart));
                        }
                        let mut form = Vec::new();
                        for (name, part) in form_body.0 {
                            match part {
                                FormPart::File { file, .. } => {
                                    let bytes: Vec<u8> = file.try_into()?;
                                    form.push((name, serde_json::to_string(&bytes)?))
                                }
                                FormPart::Text(value) => form.push((name, value)),
                            }
                        }
                        Ok(request_builder.form(&form))
                    }
                    send_form(request_builder, &mut request.headers, form_body)?
                }
            };
        }
        if let Some(headers) = request.headers {
            request_builder = request_builder.headers(headers.0);
        }
        let http_request = request_builder.build()?;
        let response = self.0.execute(http_request).await?;
        Ok(Response(
            request.response_type.unwrap_or(ResponseType::Json),
            response,
        ))
    }
 }
 #[derive(Serialize_repr, Deserialize_repr, Clone, Debug)]
 #[repr(u16)]
 #[non_exhaustive]
 /// The HTTP response type.
 pub enum ResponseType {
    /// Read the response as JSON
    Json = 1,
    /// Read the response as text
    Text,
    /// Read the response as binary
    Binary,
 }
 #[derive(Debug)]
 pub struct Response(ResponseType, reqwest::Response);
 impl Response {
    /// Reads the response.
    ///
    /// Note that the body is serialized to a [`Value`].
    pub async fn read(self) -> crate::Result<ResponseData> {
        let url = self.1.url().clone();
        let mut headers = HashMap::new();
        let mut raw_headers = HashMap::new();
        for (name, value) in self.1.headers() {
            headers.insert(
                name.as_str().to_string(),
                String::from_utf8(value.as_bytes().to_vec())?,
            );
            raw_headers.insert(
                name.as_str().to_string(),
                self.1
                    .headers()
                    .get_all(name)
                    .into_iter()
                    .map(|v| String::from_utf8(v.as_bytes().to_vec()).map_err(Into::into))
                    .collect::<crate::Result<Vec<String>>>()?,
            );
        }
        let status = self.1.status().as_u16();
        let data = match self.0 {
            ResponseType::Json => self.1.json().await?,
            ResponseType::Text => Value::String(self.1.text().await?),
            ResponseType::Binary => serde_json::to_value(&self.1.bytes().await?)?,
        };
        Ok(ResponseData {
            url,
            status,
            headers,
            raw_headers,
            data,
        })
    }
 }
 #[derive(Debug, Serialize)]
 #[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct ResponseData {
    /// Response URL. Useful if it followed redirects.
    pub url: Url,
    /// Response status code.
    pub status: u16,
    /// Response headers.
    pub headers: HashMap<String, String>,
    /// Response raw headers.
    pub raw_headers: HashMap<String, Vec<String>>,
    /// Response data.
    pub data: Value,
 }
 /// A file path or contents.
 #[derive(Debug, Clone, Deserialize)]
 #[serde(untagged)]
 #[non_exhaustive]
 pub enum FilePart {
    /// File path.
    Path(PathBuf),
    /// File contents.
    Contents(Vec<u8>),
 }
 impl TryFrom<FilePart> for Vec<u8> {
    type Error = crate::Error;
    fn try_from(file: FilePart) -> crate::Result<Self> {
        let bytes = match file {
            FilePart::Path(path) => std::fs::read(path)?,
            FilePart::Contents(bytes) => bytes,
        };
        Ok(bytes)
    }
 }
 #[derive(Debug, Deserialize)]
 #[serde(untagged)]
 #[non_exhaustive]
 pub enum FormPart {
    /// A string value.
    Text(String),
    /// A file value.
    #[serde(rename_all = "camelCase")]
    File {
        /// File path or content.
        file: FilePart,
        /// Mime type of this part.
        /// Only used when the `Content-Type` header is set to `multipart/form-data`.
        mime: Option<String>,
        /// File name.
        /// Only used when the `Content-Type` header is set to `multipart/form-data`.
        file_name: Option<String>,
    },
 }
 #[derive(Debug, Deserialize)]
 pub struct FormBody(pub(crate) HashMap<String, FormPart>);
 #[derive(Debug, Deserialize)]
 #[serde(tag = "type", content = "payload")]
 #[non_exhaustive]
 pub enum Body {
    Form(FormBody),
    Json(Value),
    Text(String),
    Bytes(Vec<u8>),
 }
 #[derive(Debug, Default)]
 pub struct HeaderMap(header::HeaderMap);
 impl<'de> Deserialize<'de> for HeaderMap {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let map = HashMap::<String, String>::deserialize(deserializer)?;
        let mut headers = header::HeaderMap::default();
        for (key, value) in map {
            if let (Ok(key), Ok(value)) = (
                header::HeaderName::from_bytes(key.as_bytes()),
                header::HeaderValue::from_str(&value),
            ) {
                headers.insert(key, value);
            } else {
                return Err(serde::de::Error::custom(format!(
                    "invalid header `{key}` `{value}`"
                )));
            }
        }
        Ok(Self(headers))
    }
 }
 #[derive(Debug, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct HttpRequestBuilder {
    /// The request method (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, CONNECT or TRACE)
    pub method: String,
    /// The request URL
    pub url: Url,
    /// The request query params
    pub query: Option<HashMap<String, String>>,
    /// The request headers
    pub headers: Option<HeaderMap>,
    /// The request body
    pub body: Option<Body>,
    /// Timeout for the whole request
    #[serde(deserialize_with = "deserialize_duration", default)]
    pub timeout: Option<Duration>,
    /// The response type (defaults to Json)
    pub response_type: Option<ResponseType>,
 }
@@ -0,0 +1,72 @@
 use tauri::{path::SafePathBuf, AppHandle, Runtime, State};
 use crate::{
    ClientId, Http,
 };
 mod client;
 use client::{Body, ClientBuilder, FilePart, FormPart, HttpRequestBuilder, ResponseData};
 pub use client::Client;
 #[tauri::command]
 pub async fn create_client<R: Runtime>(
    _app: AppHandle<R>,
    http: State<'_, Http<R>>,
    options: Option<ClientBuilder>,
 ) -> super::Result<ClientId> {
    let client = options.unwrap_or_default().build()?;
    let mut store = http.clients.lock().unwrap();
    let id = rand::random::<ClientId>();
    store.insert(id, client);
    Ok(id)
 }
 #[tauri::command]
 pub async fn drop_client<R: Runtime>(
    _app: AppHandle<R>,
    http: State<'_, Http<R>>,
    client: ClientId,
 ) -> super::Result<()> {
    let mut store = http.clients.lock().unwrap();
    store.remove(&client);
    Ok(())
 }
 #[tauri::command]
 pub async fn request<R: Runtime>(
    app: AppHandle<R>,
    http: State<'_, Http<R>>,
    client_id: ClientId,
    options: Box<HttpRequestBuilder>,
 ) -> super::Result<ResponseData> {
    use crate::Manager;
    if http.scope.is_allowed(&options.url) {
        let client = http
            .clients
            .lock()
            .unwrap()
            .get(&client_id)
            .ok_or_else(|| crate::Error::HttpClientNotInitialized)?
            .clone();
        let options = *options;
        if let Some(Body::Form(form)) = &options.body {
            for value in form.0.values() {
                if let FormPart::File {
                    file: FilePart::Path(path),
                    ..
                } = value
                {
                    if SafePathBuf::new(path.clone()).is_err() || !app.fs_scope().is_allowed(path) {
                        return Err(crate::Error::PathNotAllowed(path.clone()));
                    }
                }
            }
        }
        let response = client.send(options).await?;
        Ok(response.read().await?)
    } else {
        Err(crate::Error::UrlNotAllowed(options.url))
    }
 }
@@ -0,0 +1,38 @@
 use std::path::PathBuf;
 use reqwest::Url;
 use serde::{Serialize, Serializer};
 #[derive(Debug, thiserror::Error)]
 pub enum Error {
    #[error(transparent)]
    Json(#[from] serde_json::Error),
    #[error(transparent)]
    Io(#[from] std::io::Error),
    #[error(transparent)]
    Network(#[from] reqwest::Error),
    /// URL not allowed by the scope.
    #[error("url not allowed on the configured scope: {0}")]
    UrlNotAllowed(Url),
    /// Path not allowed by the scope.
    #[error("path not allowed on the configured scope: {0}")]
    PathNotAllowed(PathBuf),
    /// Client with specified ID not found.
    #[error("http client dropped or not initialized")]
    HttpClientNotInitialized,
    /// HTTP method error.
    #[error(transparent)]
    HttpMethod(#[from] http::method::InvalidMethod),
    /// Failed to serialize header value as string.
    #[error(transparent)]
    Utf8(#[from] std::string::FromUtf8Error),
 }
 impl Serialize for Error {
    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(self.to_string().as_ref())
    }
 }
@@ -0,0 +1,52 @@
 pub use reqwest as client;
 use tauri::{
    plugin::{Builder, TauriPlugin},
    AppHandle, Manager, Runtime,
 };
 use std::{collections::HashMap, sync::Mutex};
 mod commands;
 mod error;
 mod scope;
 pub use error::Error;
 type Result<T> = std::result::Result<T, Error>;
 type ClientId = u32;
 pub struct Http<R: Runtime> {
    #[allow(dead_code)]
    app: AppHandle<R>,
    pub(crate) clients: Mutex<HashMap<ClientId, commands::Client>>,
    pub(crate) scope: scope::Scope,
 }
 impl<R: Runtime> Http<R> {}
 pub trait HttpExt<R: Runtime> {
    fn http(&self) -> &Http<R>;
 }
 impl<R: Runtime, T: Manager<R>> HttpExt<R> for T {
    fn http(&self) -> &Http<R> {
        self.state::<Http<R>>().inner()
    }
 }
 pub fn init<R: Runtime>() -> TauriPlugin<R> {
    Builder::new("http")
        .invoke_handler(tauri::generate_handler![
            commands::create_client,
            commands::drop_client,
            commands::request
        ])
        .setup(|app, _api| {
            app.manage(Http {
                app: app.clone(),
                clients: Default::default(),
                scope: scope::Scope::new(&app.config().tauri.allowlist.http.scope),
            });
            Ok(())
        })
        .build()
 }
@@ -0,0 +1,94 @@
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 use glob::Pattern;
 use reqwest::Url;
 use tauri::utils::config::HttpAllowlistScope;
 /// Scope for filesystem access.
 #[derive(Debug, Clone)]
 pub struct Scope {
    allowed_urls: Vec<Pattern>,
 }
 impl Scope {
    /// Creates a new scope from the allowlist's `http` scope configuration.
    pub(crate) fn new(scope: &HttpAllowlistScope) -> Self {
        Self {
            allowed_urls: scope
                .0
                .iter()
                .map(|url| {
                    glob::Pattern::new(url.as_str()).unwrap_or_else(|_| {
                        panic!("scoped URL is not a valid glob pattern: `{url}`")
                    })
                })
                .collect(),
        }
    }
    /// Determines if the given URL is allowed on this scope.
    pub fn is_allowed(&self, url: &Url) -> bool {
        self.allowed_urls
            .iter()
            .any(|allowed| allowed.matches(url.as_str()))
    }
 }
 #[cfg(test)]
 mod tests {
    use tauri_utils::config::HttpAllowlistScope;
    #[test]
    fn is_allowed() {
        // plain URL
        let scope = super::Scope::for_http_api(&HttpAllowlistScope(vec!["http://localhost:8080"
            .parse()
            .unwrap()]));
        assert!(scope.is_allowed(&"http://localhost:8080".parse().unwrap()));
        assert!(scope.is_allowed(&"http://localhost:8080/".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8080/file".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8080/path/to/asset.png".parse().unwrap()));
        assert!(!scope.is_allowed(&"https://localhost:8080".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8081".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://local:8080".parse().unwrap()));
        // URL with fixed path
        let scope =
            super::Scope::for_http_api(&HttpAllowlistScope(vec!["http://localhost:8080/file.png"
                .parse()
                .unwrap()]));
        assert!(scope.is_allowed(&"http://localhost:8080/file.png".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8080".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8080/file".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8080/file.png/other.jpg".parse().unwrap()));
        // URL with glob pattern
        let scope =
            super::Scope::for_http_api(&HttpAllowlistScope(vec!["http://localhost:8080/*.png"
                .parse()
                .unwrap()]));
        assert!(scope.is_allowed(&"http://localhost:8080/file.png".parse().unwrap()));
        assert!(scope.is_allowed(&"http://localhost:8080/assets/file.png".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8080/file.jpeg".parse().unwrap()));
        let scope =
            super::Scope::for_http_api(&HttpAllowlistScope(vec!["http://*".parse().unwrap()]));
        assert!(scope.is_allowed(&"http://something.else".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://something.else/path/to/file".parse().unwrap()));
        assert!(!scope.is_allowed(&"https://something.else".parse().unwrap()));
        let scope =
            super::Scope::for_http_api(&HttpAllowlistScope(vec!["http://**".parse().unwrap()]));
        assert!(scope.is_allowed(&"http://something.else".parse().unwrap()));
        assert!(scope.is_allowed(&"http://something.else/path/to/file".parse().unwrap()));
    }
 }
@@ -0,0 +1,4 @@
 {
  "extends": "../../tsconfig.base.json",
  "include": ["guest-js/*.ts"]
 }
@@ -46,9 +46,6 @@ pub fn init<R: Runtime>() -> TauriPlugin<R> {
      #[cfg(desktop)]
      let {{ plugin_name_snake_case }} = desktop::init(app, api)?;
      app.manage({{ plugin_name_snake_case }});
      // manage state so it is accessible by the commands
      app.manage(MyState::default());
      Ok(())
    })
    .build()