/*
 * Copyright (c) 2020 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

export interface FileResponse {
  /**
   * File URI.
   * @since 3
   */
  uri: string;

  /**
   * File size, in bytes.
   * If type is dir, the length value is fixed to 0.
   * @since 3
   */
  length: number;

  /**
   * Timestamp when the file is stored, which is the number of milliseconds elapsed since 1970/01/01 00:00:00.
   * For lite wearables, the value is fixed to 0, because this parameter is restricted by the underlying file system.
   * @since 3
   */
  lastModifiedTime: number;

  /**
   * File type. The values are as follows:
   * dir: directory
   * file: file
   * @since 3
   */
  type: "dir" | "file";

  /**
   * File list. When the recursive value is true and the type is dir, the file information under the subdirectory will be returned.
   * Otherwise, no value will be returned.
   * @since 3
   */
  subFiles?: Array<FileResponse>;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileMoveOption {
  /**
   * URI of the file to move.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  srcUri: string;

  /**
   * URI of the file moved to the target location.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  dstUri: string;

  /**
   * Called when the source file is moved to the specified location successfully.
   * This function returns the URI of the file moved to the target location.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: (uri: string) => void;

  /**
   * Called when moving fails.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileListResponse {
  /**
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fileList: Array<FileResponse>;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileListOption {
  /**
   * URI of the directory.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  uri: string;

  /**
   * Called when the list is obtained successfully.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: (data: FileListResponse) => void;

  /**
   * Called when the list fails to be obtained.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

export interface FileCopyOption {
  /**
   * URI of the file to copy.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  srcUri: string;

  /**
   * URI of the file moved to the target location.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  dstUri: string;

  /**
   * Called when the copy file is saved successful.
   * This function returns the URI of the file saved to the target location.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: (uri: string) => void;

  /**
   * Called when the copy or save operation fails.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

export interface FileGetOption {
  /**
   * File URI, which cannot be an application resource path.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  uri: string;

  /**
   * Whether to recursively obtain the file list under a subdirectory.
   * The default value is false.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  recursive?: boolean;

  /**
   * Called when file information is obtained successfully.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: (file: FileResponse) => void;

  /**
   * Called when file information fails to be obtained.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

export interface FileDeleteOption {
  /**
   * URI of the file to be deleted, which cannot be an application resource path.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  uri: string;

  /**
   * Called when local files are deleted successfully.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: () => void;

  /**
   * Called when the deletion fails.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileWriteTextOption {
  /**
   * URI of a local file. If it does not exist, a file will be created.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  uri: string;

  /**
   * Character string to write into the local file.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  text: string;

  /**
   * Encoding format. The default format is UTF-8.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  encoding?: string;

  /**
   * Whether to enable the append mode. The default value is false.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  append?: boolean;

  /**
   * Called when texts are written into a file successfully.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: () => void;

  /**
   * Called when texts fail to be written into a file.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileReadTextResponse {
  /**
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  text: string;
}

export interface FileReadTextOption {
  /**
   * URI of a local file.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  uri: string;

  /**
   * Encoding format. The default format is UTF-8.
   * Currently, only UTF-8 is supported.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  encoding?: string;

  /**
   * Position where the reading starts.
   * The default value is the start position of the file.
   * @devices liteWearable, smartVision
   * @since 3
   */
  position?: number;

  /**
   * Position where the reading starts.
   * The default value is the start position of the file.
   * @devices liteWearable, smartVision
   * @since 3
   */
  length?: number;

  /**
   * Called when texts are read successfully.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: (data: FileReadTextResponse) => void;

  /**
   * Called when texts fail to be read.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileWriteArrayBufferOption {
  /**
   * URI of a local file. If it does not exist, a file will be created.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  uri: string;

  /**
   * Buffer from which the data is derived.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  buffer: Uint8Array;

  /**
   * Offset to the position where the writing starts. The default value is 0.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  position?: number;

  /**
   * Whether to enable the append mode.
   * The default value is false. If the value is true, the position parameter will become invalid.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  append?: boolean;

  /**
   * Called when data from a buffer is written into a file successfully.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: () => void;

  /**
   * Called when data from a buffer fails to be written into a file.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileReadArrayBufferResponse {
  /**
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  buffer: Uint8Array;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileReadArrayBufferOption {
  /**
   * URI of a local file.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  uri: string;

  /**
   * Position where the reading starts.
   * The default value is the start position of the file.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  position?: number;

  /**
   * Length of the content to read.
   * If this parameter is not set, all content of the file will be read.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  length?: number;

  /**
   * Called when the buffer data is read successfully.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: (data: FileReadArrayBufferResponse) => void;

  /**
   * Called when the buffer data fails to be read.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileAccessOption {
  /**
   * URI of the directory or file.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  uri: string;

  /**
   * Called when the check result is obtained successfully.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: () => void;

  /**
   * Called when the check fails.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileMkdirOption {
  /**
   * URI of the directory.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * 3. A maximum of five recursions are allowed for creating the directory.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  uri: string;

  /**
   * Whether to create the directory after creating its upper-level directory recursively.
   * The default value is false.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  recursive?: boolean;

  /**
   * Called when the directory is created successfully.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: () => void;

  /**
   * Called when the creation fails.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export interface FileRmdirOption {
  /**
   * URI of the directory.
   * Restricted by the underlying file system of lite wearables, the value must meet the following requirements:
   * 1. The URI cannot contain special characters such as \/"*+,:;<=>?[]|\x7F.
   * 2. The maximum number of characters allowed is 128.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  uri: string;

  /**
   * Whether to delete files and subdirectories recursively.
   * The default value is false.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  recursive?: boolean;

  /**
   * Called when the directory is deleted successfully.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  success?: () => void;

  /**
   * Called when the deletion fails.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  fail?: (data: string, code: number) => void;

  /**
   * Called when the execution is completed.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   * @since 3
   */
  complete?: () => void;
}

/**
 * @devices tv, phone, tablet, wearable, liteWearable, smartVision
 */
export default class File {
  /**
   * Moves the source file to a specified location.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static move(options: FileMoveOption): void;

  /**
   * Copies a source file and save the copy to a specified location.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static copy(options: FileCopyOption): void;

  /**
   * Obtains the list of files in a specified directory.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static list(options: FileListOption): void;

  /**
   * Obtains information about a local file.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static get(options: FileGetOption): void;

  /**
   * Deletes local files.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static delete(options: FileDeleteOption): void;

  /**
   * Writes texts into a file.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static writeText(options: FileWriteTextOption): void;

  /**
   * Reads texts from a file.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static readText(options: FileReadTextOption): void;

  /**
   * Writes data from a buffer into a file.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static writeArrayBuffer(options: FileWriteArrayBufferOption): void;

  /**
   * Reads buffer data from a file.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static readArrayBuffer(options: FileReadArrayBufferOption): void;

  /**
   * Checks whether a file or directory exists.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static access(options: FileAccessOption): void;

  /**
   * Creates a directory.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static mkdir(options: FileMkdirOption): void;

  /**
   * Deletes a directory.
   * @param options Options.
   * @devices tv, phone, tablet, wearable, liteWearable, smartVision
   */
  static rmdir(options: FileRmdirOption): void;
}