@pistonite/pure 0.28.0 → 0.29.0

package/src/fs/FsOpenFile.ts

@@ -1,256 +0,0 @@
-import { errstr } from "../result";
-
-import { fsErr, FsErr, fsFail, type FsResult } from "./FsError.ts";
-import type { FsFileStandalone } from "./FsFileStandalone.ts";
-import { FsFileStandaloneImplFileAPI } from "./FsFileStandaloneImplFileAPI.ts";
-import { FsFileStandaloneImplHandleAPI } from "./FsFileStandaloneImplHandleAPI.ts";
-
-/**
- * Prompt user to open a file
- *
- * FileSystemAccess API is used on supported platforms, which allows writing after
- * user grants the permission once at the time of writing to the file. If failed or not supported,
- * the DOM input element is used as a fallback.
- */
-export const fsOpenFile = async (
-    options?: FsFileOpenOptions,
-): Promise<FsResult<FsFileStandalone>> => {
-    const result = await fsOpenFileInternal(false, options || {});
-    if (result.err) {
-        return result;
-    }
-    if (!result.val.length) {
-        return { err: fsErr(FsErr.UserAbort, "No files selected") };
-    }
-    return { val: result.val[0] };
-};
-
-/**
- * Prompt user to open multiple files
- *
- * FileSystemAccess API is used on supported platforms, which allows writing after
- * user grants the permission once at the time of writing to the file. If failed or not supported,
- * the DOM input element is used as a fallback.
- *
- * The returned array is guaranteed to have at least 1 file.
- */
-export const fsOpenFileMultiple = async (
-    options?: FsFileOpenOptions,
-): Promise<FsResult<FsFileStandalone[]>> => {
-    const result = await fsOpenFileInternal(true, options || {});
-    if (result.err) {
-        return result;
-    }
-    if (!result.val.length) {
-        return { err: fsErr(FsErr.UserAbort, "No files selected") };
-    }
-    return result;
-};
-
-const fsOpenFileInternal = async (
-    multiple: boolean,
-    options: FsFileOpenOptions,
-): Promise<FsResult<FsFileStandalone[]>> => {
-    if (isFileSystemAccessAPISupportedForStandaloneFileOpen()) {
-        const result = await fsOpenFileWithFileSystemAccessAPI(multiple, options);
-        if (result.val || result.err.code === FsErr.UserAbort) {
-            return result;
-        }
-    }
-    // fallback if FileSystemAccessAPI is not supported or fails
-    return fsOpenFileWithFileAPI(multiple, options);
-};
-
-const fsOpenFileWithFileAPI = async (
-    multiple: boolean,
-    { types }: FsFileOpenOptions,
-): Promise<FsResult<FsFileStandalone[]>> => {
-    const element = document.createElement("input");
-    element.type = "file";
-    if (multiple) {
-        element.multiple = true;
-    }
-    if (types?.length) {
-        const accept = new Set<string>();
-        const len = types.length;
-        for (let i = 0; i < len; i++) {
-            const acceptArray = types[i].accept;
-            const acceptLen = acceptArray.length;
-            for (let j = 0; j < acceptLen; j++) {
-                const acceptValue = acceptArray[j];
-                if (typeof acceptValue === "string") {
-                    accept.add(acceptValue);
-                } else {
-                    const { mime, extensions } = acceptValue;
-                    if (mime) {
-                        accept.add(mime);
-                    }
-                    if (extensions.length) {
-                        extensions.forEach((ext) => {
-                            if (ext) {
-                                accept.add(ext);
-                            }
-                        });
-                    }
-                }
-            }
-        }
-        element.accept = Array.from(accept).join(",");
-    }
-    try {
-        return new Promise((resolve) => {
-            element.addEventListener("cancel", () => {
-                resolve({
-                    err: fsErr(FsErr.UserAbort, "cancel listener invoked"),
-                });
-            });
-            element.addEventListener("change", () => {
-                if (!element.files?.length) {
-                    resolve({
-                        err: fsErr(FsErr.UserAbort, "no files selected"),
-                    });
-                    return;
-                }
-                const array = [];
-                for (let i = 0; i < element.files.length; i++) {
-                    array.push(new FsFileStandaloneImplFileAPI(element.files[i]));
-                }
-                resolve({ val: array });
-            });
-            element.click();
-        });
-    } catch (e) {
-        return { err: fsFail(errstr(e)) };
-    }
-};
-
-const fsOpenFileWithFileSystemAccessAPI = async (
-    multiple: boolean,
-    { id, types, disallowWildcard }: FsFileOpenOptions,
-): Promise<FsResult<FsFileStandalone[]>> => {
-    const convertedTypes = types?.map((type) => {
-        const { description, accept } = type;
-        const convertedAccept: Record<string, string[]> = {};
-        const anyMimeType = [];
-        const len = accept.length;
-        for (let i = 0; i < len; i++) {
-            const acceptValue = accept[i];
-            if (typeof acceptValue === "string") {
-                if (acceptValue) {
-                    anyMimeType.push(acceptValue);
-                }
-                continue;
-            }
-            const { mime, extensions } = acceptValue;
-            if (!mime || mime === "*/*") {
-                anyMimeType.push(...extensions);
-                continue;
-            }
-            if (mime in convertedAccept) {
-                convertedAccept[mime].push(...extensions);
-            } else {
-                convertedAccept[mime] = [...extensions];
-            }
-        }
-        if (anyMimeType.length) {
-            convertedAccept["*/*"] = anyMimeType;
-        }
-        return { description, accept: convertedAccept };
-    });
-    try {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const output = await (globalThis as any).showOpenFilePicker({
-            id,
-            excludeAcceptAllOption: types && types.length && disallowWildcard,
-            multiple,
-            types: convertedTypes,
-        });
-        const len = output.length;
-        const convertedOutput = [];
-        for (let i = 0; i < len; i++) {
-            convertedOutput.push(new FsFileStandaloneImplHandleAPI(output[i]));
-        }
-        return { val: convertedOutput };
-    } catch (e) {
-        if (e && typeof e === "object" && "name" in e) {
-            if (e.name === "AbortError") {
-                return { err: fsErr(FsErr.UserAbort, "User abort") };
-            }
-            if (e.name === "SecurityError") {
-                return { err: fsErr(FsErr.PermissionDenied, "Security error") };
-            }
-        }
-        return { err: fsFail(errstr(e)) };
-    }
-};
-
-export type FsFileOpenOptions = {
-    /**
-     * ID for the file open operation
-     *
-     * Supported implementation can use this to open the picker in the same
-     * directory for the same ID
-     */
-    id?: string;
-
-    /**
-     * If the "*.*" file type should be hidden in the picker.
-     *
-     * In unsupported implementations, this will be ignored, and the "*.*"
-     * file type will always be visible.
-     *
-     * By default, this is false
-     */
-    disallowWildcard?: boolean;
-
-    /** List of file types to accept */
-    types?: FsFileOpenType[];
-};
-
-export type FsFileOpenType = {
-    /**
-     * Optional description for the type, which may display in the file picker
-     *
-     * In unsupported implementations, this will be ignored.
-     */
-    description?: string;
-
-    /**
-     * List of file mime types or extensions to accept for this file type
-     *
-     * String elements are file extensions, with the "." prefix. More context
-     * can be provided with an object element with mime type and extensions to
-     * have better file type descriptions in the picker (if supported).
-     */
-    accept: (FsFileOpenTypeAccept | string)[];
-};
-
-export type FsFileOpenTypeAccept = {
-    /** Optional mime type, which the browser can be used to display file type descriptions */
-    mime?: string;
-    /** extensions to accept (with the "." prefix) */
-    extensions: string[];
-};
-
-const isFileSystemAccessAPISupportedForStandaloneFileOpen = () => {
-    if (!globalThis || !globalThis.isSecureContext) {
-        return false;
-    }
-    if (
-        !("showOpenFilePicker" in globalThis) ||
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        typeof (globalThis as any).showOpenFilePicker !== "function"
-    ) {
-        return false;
-    }
-    if (!globalThis.FileSystemFileHandle) {
-        return false;
-    }
-    if (!globalThis.FileSystemFileHandle.prototype.getFile) {
-        return false;
-    }
-    if (!globalThis.FileSystemFileHandle.prototype.createWritable) {
-        return false;
-    }
-    return true;
-};

package/src/fs/FsPath.ts

@@ -1,137 +0,0 @@
-/**
- * Path utilities
- *
- * The library has the following path standard:
- * - All paths are relative (without leading /) to the root
- *   of the file system (i.e. the uploaded directory)
- * - Paths are always separated by /
- * - Empty string denotes root
- * - Paths cannot lead outside of root
- *
- *   @module
- */
-
-import { FsErr, type FsResult, fsErr } from "./FsError.ts";
-
-/** Get the root path. Current implementation is empty string. */
-export function fsRoot(): string {
-    return "";
-}
-
-/** Check if a path is the root directory, also handles badly formatted paths like ".///../" */
-export function fsIsRoot(p: string): boolean {
-    if (!p) {
-        return true;
-    }
-    for (let i = 0; i < p.length; i++) {
-        if (p[i] !== "/" || p[i] !== "." || p[i] !== "\\") {
-            return false;
-        }
-    }
-    return true;
-}
-
-/**
- * Get the base name of a path (i.e. remove the last component)
- *
- * If this path is the root directory, return InvalidPath.
- */
-export function fsGetBase(p: string): FsResult<string> {
-    if (fsIsRoot(p)) {
-        const err = fsErr(FsErr.InvalidPath, "Trying to get the base of root");
-        return { err };
-    }
-    const i = Math.max(p.lastIndexOf("/"), p.lastIndexOf("\\"));
-    if (i < 0) {
-        return { val: fsRoot() };
-    }
-    return { val: p.substring(0, i) };
-}
-
-/**
- * Get the name of a path (i.e. the last component)
- *
- * Returns the last component of the path.
- * Does not include leading or trailing slashes.
- *
- * If this path is the root directory, return IsRoot.
- */
-export function fsGetName(p: string): FsResult<string> {
-    p = stripTrailingSlashes(p);
-    if (fsIsRoot(p)) {
-        const err = fsErr(FsErr.IsRoot, "Root directory has no name");
-        return { err };
-    }
-    const i = Math.max(p.lastIndexOf("/"), p.lastIndexOf("\\"));
-    if (i < 0) {
-        return { val: p };
-    }
-    return { val: p.substring(i + 1) };
-}
-
-/**
- * Normalize .. and . in a path
- *
- * Returns InvalidPath if the path tries to escape the root directory.
- */
-export function fsNormalize(p: string): FsResult<string> {
-    let s = fsRoot();
-    for (const comp of fsComponents(p)) {
-        if (comp === "..") {
-            const base = fsGetBase(s);
-            if (base.err) {
-                return base;
-            }
-            s = base.val;
-            continue;
-        }
-        s = fsJoin(s, comp);
-    }
-    return { val: s };
-}
-
-/** Join two paths */
-export function fsJoin(p1: string, p2: string): string {
-    if (fsIsRoot(p1)) {
-        return p2;
-    }
-    return p1 + "/" + p2;
-}
-
-/** Iterate through the components of a path. Empty components and . are skipped */
-export function* fsComponents(p: string): Iterable<string> {
-    let i = 0;
-    while (i < p.length) {
-        let nextSlash = p.indexOf("/", i);
-        if (nextSlash < 0) {
-            nextSlash = p.length;
-        }
-        let nextBackslash = p.indexOf("\\", i);
-        if (nextBackslash < 0) {
-            nextBackslash = p.length;
-        }
-        let j = Math.min(nextSlash, nextBackslash);
-        if (j < 0) {
-            j = p.length;
-        }
-        const c = p.substring(i, j);
-        if (c && c !== ".") {
-            yield c;
-        }
-        i = j + 1;
-    }
-}
-
-/** Remove trailing slashes from a path */
-function stripTrailingSlashes(p: string): string {
-    let i = p.length - 1;
-    for (; i >= 0; i--) {
-        if (p[i] !== "/" && p[i] !== "\\") {
-            break;
-        }
-    }
-    if (i === p.length - 1) {
-        return p;
-    }
-    return p.substring(0, i + 1);
-}

package/src/fs/FsSave.ts

@@ -1,216 +0,0 @@
-import { ilog } from "../log/internal.ts";
-
-import { fsFail, type FsVoid } from "./FsError.ts";
-
-/** Save (download) a file using Blob */
-export function fsSave(content: string | Uint8Array<ArrayBuffer>, filename: string): FsVoid {
-    const blob = new Blob([content], {
-        // maybe lying, but should be fine
-        type: "text/plain;charset=utf-8",
-    });
-
-    try {
-        saveAs(blob, filename);
-        return {};
-    } catch (e) {
-        ilog.error(e);
-        return { err: fsFail("save failed") };
-    }
-}
-
-// The following code is adopted from
-// - https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/file-saver/index.d.ts
-// under this MIT license:
-/*
-This project is licensed under the MIT license.
-Copyrights are respective of each contributor listed at the beginning of each definition file.
-
-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.
- */
-
-type SaveAsFn = (data: Blob | string, filename?: string, options?: SaveAsFnOptions) => void;
-type SaveAsFnOptions = { autoBom: boolean };
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-// The following code is vendored from
-// - https://github.com/eligrey/FileSaver.js/blob/master/src/FileSaver.js
-// under this MIT license:
-/*
- * FileSaver.js
- * A saveAs() FileSaver implementation.
- *
- * By Eli Grey, http://eligrey.com
- *
- * License : https://github.com/eligrey/FileSaver.js/blob/master/LICENSE.md (MIT)
- * source  : http://purl.eligrey.com/github/FileSaver.js
- */
-
-// adoption note: this is now ECMA standard - https://github.com/tc39/proposal-global
-// The one and only way of getting global scope in all environments
-// https://stackoverflow.com/q/3277182/1008999
-// const _global =
-//     typeof window === "object" && window.window === window
-//         ? window
-//         : typeof self === "object" && self.self === self
-//           ? self
-//           : typeof global === "object" && global.global === global
-//             ? global
-//             : this;
-
-const download = (url: string | URL, name?: string, opts?: SaveAsFnOptions) => {
-    const xhr = new XMLHttpRequest();
-    xhr.open("GET", url);
-    xhr.responseType = "blob";
-    xhr.onload = function () {
-        saveAs(xhr.response, name, opts);
-    };
-    xhr.onerror = function () {
-        console.error("could not download file");
-    };
-    xhr.send();
-};
-
-const corsEnabled = (url: string | URL) => {
-    const xhr = new XMLHttpRequest();
-    // use sync to avoid popup blocker
-    xhr.open("HEAD", url, false);
-    try {
-        xhr.send();
-    } catch {
-        // ignore
-    }
-    return xhr.status >= 200 && xhr.status <= 299;
-};
-
-// adoption note: we drop support for old browsers, and just use click()
-// original note: `a.click()` doesn't work for all browsers (#465)
-// const click  = (node: Node) => {
-//   try {
-//     node.dispatchEvent(new MouseEvent('click'))
-//   } catch {
-//     const evt = document.createEvent('MouseEvents')
-//     evt.initMouseEvent('click', true, true, window, 0, 0, 0, 80,
-//                           20, false, false, false, false, 0, null)
-//     node.dispatchEvent(evt)
-//   }
-// }
-
-// adoption note: converted to check at call time, no need to
-// do this check at boot load
-const saveAs: SaveAsFn = (blob, name?, opts?) => {
-    // adoption note: this is likely to throw if window is not defined.. ?
-    if (typeof window !== "object" || window !== globalThis) {
-        // probably in some web worker
-        return;
-    }
-    // Detect WebView inside a native macOS app by ruling out all browsers
-    // We just need to check for 'Safari' because all other browsers (besides Firefox) include that too
-    // https://www.whatismybrowser.com/guides/the-latest-user-agent/macos
-    const isMacOSWebView =
-        globalThis.navigator &&
-        /Macintosh/.test(navigator.userAgent) &&
-        /AppleWebKit/.test(navigator.userAgent) &&
-        !/Safari/.test(navigator.userAgent);
-    // adoption note: removed blob.name, and pulled this line outside
-    name = name || "download";
-
-    if ("download" in HTMLAnchorElement.prototype && !isMacOSWebView) {
-        const URL = globalThis.URL || globalThis.webkitURL;
-        // Namespace is used to prevent conflict w/ Chrome Poper Blocker extension (Issue #561)
-        const a = document.createElementNS(
-            "http://www.w3.org/1999/xhtml",
-            "a",
-        ) as HTMLAnchorElement;
-
-        a.download = name;
-        a.rel = "noopener"; // tabnabbing
-
-        // TODO: detect chrome extensions & packaged apps
-        // a.target = '_blank'
-
-        if (typeof blob === "string") {
-            // Support regular links
-            a.href = blob;
-            if (a.origin !== location.origin) {
-                // adoption note: removed turnery and changed click()
-                if (corsEnabled(a.href)) {
-                    download(blob, name, opts);
-                } else {
-                    a.target = "_blank";
-                    a.click();
-                }
-            } else {
-                // adoption note: changed click()
-                a.click();
-            }
-        } else {
-            // Support blobs
-            a.href = URL.createObjectURL(blob);
-            // adoption note: not sure why 40s
-            setTimeout(() => {
-                URL.revokeObjectURL(a.href);
-            }, 4e4); // 40s
-            // adoption note: changed click()
-            setTimeout(() => {
-                a.click();
-            }, 0);
-        }
-        return;
-    }
-
-    // adoption note: drop IE support
-
-    // Fallback to using FileReader and a popup
-    // Open a popup immediately do go around popup blocker
-    // Mostly only available on user interaction and the fileReader is async so...
-    let popup = (window as any).popup || open("", "_blank");
-    if (popup) {
-        popup.document.title = popup.document.body.innerText = "downloading...";
-    }
-
-    if (typeof blob === "string") {
-        return download(blob, name, opts);
-    }
-
-    const force = blob.type === "application/octet-stream";
-    // adoption note: add any
-    const isSafari =
-        /constructor/i.test((globalThis as any).HTMLElement) || (globalThis as any).safari;
-    const isChromeIOS = /CriOS\/[\d]+/.test(navigator.userAgent);
-
-    if (
-        (isChromeIOS || (force && isSafari) || isMacOSWebView) &&
-        typeof FileReader !== "undefined"
-    ) {
-        // Safari doesn't allow downloading of blob URLs
-        const reader = new FileReader();
-        reader.onloadend = function () {
-            let url = reader.result as string;
-            url = isChromeIOS ? url : url.replace(/^data:[^;]*;/, "data:attachment/file;");
-            if (popup) {
-                popup.location.href = url;
-            } else {
-                (location as any) = url;
-            }
-            popup = null; // reverse-tabnabbing #460
-        };
-        reader.readAsDataURL(blob);
-    } else {
-        const URL = globalThis.URL || globalThis.webkitURL;
-        const url = URL.createObjectURL(blob);
-        if (popup) {
-            popup.location = url;
-        } else {
-            location.href = url;
-        }
-        popup = null; // reverse-tabnabbing #460
-        setTimeout(function () {
-            URL.revokeObjectURL(url);
-        }, 4e4); // 40s
-    }
-};

package/src/fs/FsSupportStatus.ts

@@ -1,87 +0,0 @@
-/** What is supported by the current environment */
-export type FsSupportStatus = {
-    /** Returned by window.isSecureContext */
-    isSecureContext: boolean;
-
-    /**
-     * The implementation for FsFileSystem used
-     *
-     * See README.md for more information
-     */
-    implementation: "File" | "FileSystemAccess" | "FileEntry";
-};
-
-/** Get which implementation will be used for the current environment */
-export function fsGetSupportStatus(): FsSupportStatus {
-    if (isFileSystemAccessSupported()) {
-        return {
-            isSecureContext: globalThis.isSecureContext,
-            implementation: "FileSystemAccess",
-        };
-    }
-    if (isFileEntrySupported()) {
-        return {
-            isSecureContext: globalThis.isSecureContext,
-            implementation: "FileEntry",
-        };
-    }
-
-    return {
-        isSecureContext: !!globalThis && globalThis.isSecureContext,
-        implementation: "File",
-    };
-}
-
-function isFileSystemAccessSupported() {
-    if (!globalThis) {
-        return false;
-    }
-    if (!globalThis.isSecureContext) {
-        // In Chrome, you can still access the APIs but they just crash the page entirely
-        return false;
-    }
-    if (!globalThis.FileSystemDirectoryHandle) {
-        return false;
-    }
-
-    if (!globalThis.FileSystemFileHandle) {
-        return false;
-    }
-
-    // since TSlib doesn't have these, let's check here
-
-    // @ts-expect-error FileSystemDirectoryHandle should have a values() method
-    if (!globalThis.FileSystemDirectoryHandle.prototype.values) {
-        return false;
-    }
-
-    // @ts-expect-error window should have showDirectoryPicker
-    if (!globalThis.showDirectoryPicker) {
-        return false;
-    }
-
-    return true;
-}
-
-function isFileEntrySupported(): boolean {
-    if (!globalThis) {
-        return false;
-    }
-
-    // Chrome/Edge has this but it's named DirectoryEntry
-    // AND, they don't work (I forgot how exactly they don't work)
-
-    if (navigator && navigator.userAgent && navigator.userAgent.includes("Chrome")) {
-        return false;
-    }
-
-    if (!globalThis.FileSystemDirectoryEntry) {
-        return false;
-    }
-
-    if (!globalThis.FileSystemFileEntry) {
-        return false;
-    }
-
-    return true;
-}