@prozilla-os/core 1.3.11 → 1.3.12

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Sieben De Beule
-
-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
+MIT License
+
+Copyright (c) 2023 Sieben De Beule
+
+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.

package/README.md

@@ -1,186 +1,186 @@
-<div align="center">
-  <br />
-  <p>
-    <a href="https://os.prozilla.dev/"><img src="https://os.prozilla.dev/assets/logo.svg?v=2" height="200" alt="ProzillaOS" /></a>
-  </p>
-  <p>
-    <a href="https://github.com/prozilla-os/ProzillaOS/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/github/license/Prozilla/ProzillaOS?style=flat-square&color=FF4D5B&label=License"></a>
-    <a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Stars" src="https://img.shields.io/github/stars/Prozilla/ProzillaOS?style=flat-square&color=FED24C&label=%E2%AD%90"></a>
-    <a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Forks" src="https://img.shields.io/github/forks/Prozilla/ProzillaOS?style=flat-square&color=4D9CFF&label=Forks&logo=github"></a>
-    <a href="https://www.npmjs.com/package/prozilla-os"><img alt="NPM Version" src="https://img.shields.io/npm/v/prozilla-os?logo=npm&style=flat-square&label=prozilla-os&color=FF4D5B"></a>
-  </p>
-</div>
-
-## About
-
-`@prozilla-os/core` is a React Vite component library written in TypeScript for building web-based operating systems, made by Prozilla.
-
-## Installation
-
-```sh
-npm install @prozilla-os/core
-yarn add @prozilla-os/core
-pnpm add @prozilla-os/core
-```
-
-## Usage
-
-### Basic setup
-
-```tsx
-import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView } from "@prozilla-os/core";
-
-function App() {
-  return (
-    <ProzillaOS systemName="Example" tagLine="Powered by ProzillaOS">
-      <Taskbar/>
-      <WindowsView/>
-      <ModalsView/>
-      <Desktop/>
-    </ProzillaOS>
-  );
-}
-```
-
-<br />
-
-### Configuration
-
-```tsx
-interface ProzillaOSProps {
-
-  systemName: string,
-
-  tagLine: string,
-
-  skin: new Skin({
-
-    appIcons: Record<number, string> | undefined,
-
- appNames: Record<number, string> | undefined,
-
- wallpapers: string[],
-
- defaultWallpaper: string,
-
- fileIcons: {
-  generic: string;
-  info: string | undefined;
-  text: string | undefined;
-  code: string | undefined;
- },
-
- folderIcons: {
-  generic: string;
-  images: string | undefined;
-  text: string | undefined;
-  link: string | undefined;
- },
-
- loadStyleSheet: () => void | undefined
-
-  })
-
-  config: {
-    apps: new AppsConfig({
-
-      apps: App[]
-
-    }),
-    desktop: new DesktopConfig({
-
-      /**
-       * @default 1
-       */
-      defaultIconSize: 0 | 1 | 2,
-
-      /**
-       * 0: vertical, 1: horizontal
-       * @default 0
-       * */
-      defaultIconDirection: 0 | 1
-
-    }),
- misc: new MiscConfig({
-
-      /**
-    * @default 250
-    */
-   doubleClickDelay: number
-
- })
-    modals: new ModalsConfig({
-
-      /**
-       * Default size of a dialog box
-       * @default new Vector2(400, 200)
-       */
-      defaultDialogSize: Vector2,
-
-      /**
-       * Default size of a file selector
-       * @default new Vector2(700, 400)
-       */
-      defaultFileSelectorSize: Vector2
-
-    }),
-    taskbar: new TaskbarConfig({
-
-      /**
-       * Height of the taskbar in CSS pixels
-       * @default 3 * 16
-       */
-      height: number
-
-    }),
-    tracking: new TrackingConfig({
-
-      /**
-       * Enable tracking
-       * @default true
-      */
-      enabled: boolean,
-
-      /** Google Analytics measurement ID */
-      GAMeasurementId: string
-
-    }),
-    windows: new WindowsConfig({
-
-      /**
-       * @default 32
-       */
-      screenMargin: number,
-
-      /**
-       * @default "-"
-       */
-      titleSeparator: string,
-
-      /**
-       * If the user's screen is smaller than these values, windows will always be maximized
-       * @default new Vector2(350, 350)
-       */
-      minScreenSize: Vector2
-
-    })
-  }
-
-}
-```
-
-## Links
-
-- [Demo][demo]
-- [Docs][docs]
-- [GitHub][github]
-- [npm][npm]
-- [Discord][discord]
-- [Ko-fi][ko-fi]
-
-[demo]: https://os.prozilla.dev/
-[docs]: https://os.prozilla.dev/docs/reference/core
-[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/core
-[npm]: https://www.npmjs.com/package/@prozilla-os/core
-[discord]: https://discord.gg/JwbyQP4tdz
-[ko-fi]: https://ko-fi.com/prozilla
+<div align="center">
+  <br />
+  <p>
+    <a href="https://os.prozilla.dev/"><img src="https://os.prozilla.dev/assets/logo.svg?v=2" height="200" alt="ProzillaOS" /></a>
+  </p>
+  <p>
+    <a href="https://github.com/prozilla-os/ProzillaOS/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/github/license/Prozilla/ProzillaOS?style=flat-square&color=FF4D5B&label=License"></a>
+    <a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Stars" src="https://img.shields.io/github/stars/Prozilla/ProzillaOS?style=flat-square&color=FED24C&label=%E2%AD%90"></a>
+    <a href="https://github.com/prozilla-os/ProzillaOS"><img alt="Forks" src="https://img.shields.io/github/forks/Prozilla/ProzillaOS?style=flat-square&color=4D9CFF&label=Forks&logo=github"></a>
+    <a href="https://www.npmjs.com/package/prozilla-os"><img alt="NPM Version" src="https://img.shields.io/npm/v/prozilla-os?logo=npm&style=flat-square&label=prozilla-os&color=FF4D5B"></a>
+  </p>
+</div>
+
+## About
+
+`@prozilla-os/core` is a React Vite component library written in TypeScript for building web-based operating systems, made by Prozilla.
+
+## Installation
+
+```sh
+npm install @prozilla-os/core
+yarn add @prozilla-os/core
+pnpm add @prozilla-os/core
+```
+
+## Usage
+
+### Basic setup
+
+```tsx
+import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView } from "@prozilla-os/core";
+
+function App() {
+  return (
+    <ProzillaOS systemName="Example" tagLine="Powered by ProzillaOS">
+      <Taskbar/>
+      <WindowsView/>
+      <ModalsView/>
+      <Desktop/>
+    </ProzillaOS>
+  );
+}
+```
+
+<br />
+
+### Configuration
+
+```tsx
+interface ProzillaOSProps {
+
+  systemName: string,
+
+  tagLine: string,
+
+  skin: new Skin({
+
+    appIcons: Record<number, string> | undefined,
+
+ appNames: Record<number, string> | undefined,
+
+ wallpapers: string[],
+
+ defaultWallpaper: string,
+
+ fileIcons: {
+  generic: string;
+  info: string | undefined;
+  text: string | undefined;
+  code: string | undefined;
+ },
+
+ folderIcons: {
+  generic: string;
+  images: string | undefined;
+  text: string | undefined;
+  link: string | undefined;
+ },
+
+ loadStyleSheet: () => void | undefined
+
+  })
+
+  config: {
+    apps: new AppsConfig({
+
+      apps: App[]
+
+    }),
+    desktop: new DesktopConfig({
+
+      /**
+       * @default 1
+       */
+      defaultIconSize: 0 | 1 | 2,
+
+      /**
+       * 0: vertical, 1: horizontal
+       * @default 0
+       * */
+      defaultIconDirection: 0 | 1
+
+    }),
+ misc: new MiscConfig({
+
+      /**
+    * @default 250
+    */
+   doubleClickDelay: number
+
+ })
+    modals: new ModalsConfig({
+
+      /**
+       * Default size of a dialog box
+       * @default new Vector2(400, 200)
+       */
+      defaultDialogSize: Vector2,
+
+      /**
+       * Default size of a file selector
+       * @default new Vector2(700, 400)
+       */
+      defaultFileSelectorSize: Vector2
+
+    }),
+    taskbar: new TaskbarConfig({
+
+      /**
+       * Height of the taskbar in CSS pixels
+       * @default 3 * 16
+       */
+      height: number
+
+    }),
+    tracking: new TrackingConfig({
+
+      /**
+       * Enable tracking
+       * @default true
+      */
+      enabled: boolean,
+
+      /** Google Analytics measurement ID */
+      GAMeasurementId: string
+
+    }),
+    windows: new WindowsConfig({
+
+      /**
+       * @default 32
+       */
+      screenMargin: number,
+
+      /**
+       * @default "-"
+       */
+      titleSeparator: string,
+
+      /**
+       * If the user's screen is smaller than these values, windows will always be maximized
+       * @default new Vector2(350, 350)
+       */
+      minScreenSize: Vector2
+
+    })
+  }
+
+}
+```
+
+## Links
+
+- [Demo][demo]
+- [Docs][docs]
+- [GitHub][github]
+- [npm][npm]
+- [Discord][discord]
+- [Ko-fi][ko-fi]
+
+[demo]: https://os.prozilla.dev/
+[docs]: https://os.prozilla.dev/docs/reference/core
+[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/core
+[npm]: https://www.npmjs.com/package/@prozilla-os/core
+[discord]: https://discord.gg/JwbyQP4tdz
+[ko-fi]: https://ko-fi.com/prozilla

package/dist/main.d.ts

@@ -213,6 +213,8 @@ declare interface AppsConfigOptions {
     apps: App<WindowProps>[];
 }
 
+export declare const AUDIO_EXTENSIONS: string[];
+
 export declare function Button({ className, href, children, icon, target, ...props }: ButtonProps): JSX_2.Element;
 
 declare interface ButtonProps {
@@ -283,6 +285,8 @@ declare interface DirectoryListProps {
 
 export declare function Divider(): JSX_2.Element;
 
+export declare function downloadUrl(url: string, name: string): void;
+
 export declare function DropdownAction({ label, icon, children, showOnHover }: DropdownActionProps): ReactElement;
 
 declare interface DropdownActionProps extends ActionProps {
@@ -374,6 +378,8 @@ declare interface InteractableProps {
 
 export declare function isValidUrl(string: string): boolean;
 
+export declare const MEDIA_EXTENSIONS: string[];
+
 export declare class MiscConfig {
     doubleClickDelay: MiscConfigOptions["doubleClickDelay"];
     constructor(options?: Partial<MiscConfigOptions>);
@@ -659,6 +665,8 @@ declare interface SkinOptions {
         text?: string;
         code?: string;
         external?: string;
+        video?: string;
+        audio?: string;
     };
     /**
      * URLs of icons for types of folders
@@ -668,6 +676,8 @@ declare interface SkinOptions {
         images?: string;
         text?: string;
         link?: string;
+        video?: string;
+        audio?: string;
     };
     /**
      * Function that dynamically imports style sheet
@@ -942,6 +952,8 @@ export declare class Vector2 {
     static lerp(vector2A: Vector2, vector2B: Vector2, t: number): Vector2;
 }
 
+export declare const VIDEO_EXTENSIONS: string[];
+
 declare class VirtualBase extends EventEmitter<EventNamesMap> {
     name: string;
     alias: string | undefined | null;
@@ -1074,6 +1086,8 @@ export declare class VirtualFile extends VirtualBase {
     isFile(): boolean;
     getIconUrl(): string;
     getType(): string;
+    download(): void;
+    isDownloadable(): boolean;
     toJSON(): VirtualFileJson | null;
     static removeFileScheme(source: string): string;
 }