Move RemoteBackend and LocalBackend to enso-common for use in other modules

app/common/package.json

@@ -25,7 +25,7 @@
     "@internationalized/date": "3.7.0",
     "@types/node": "catalog:",
     "is-network-error": "^1.1.0",
-    "vue": "^3.5.13",
+    "vue": "catalog:",
     "zod": "catalog:"
   },
   "devDependencies": {

app/common/src/download.ts

@@ -0,0 +1,16 @@
+import type { Path } from './utilities/file.js'
+
+export interface DownloadUrlOptions {
+  readonly url: string
+  readonly path?: Path | null | undefined
+  readonly name?: string | null | undefined
+  readonly shouldUnpackProject?: boolean
+  readonly showFileDialog?: boolean
+}
+
+/** Options for `download` function. */
+export interface DownloadOptions {
+  readonly url: string
+  readonly name?: string | null | undefined
+  readonly electronOptions?: Omit<DownloadUrlOptions, 'name' | 'url'>
+}

app/common/src/options.ts

@@ -1,5 +1,4 @@
 /** @file Shared application options schema and helpers. */
-
 import { z } from 'zod'
 
 const DEFAULT_PROFILING_TIME = 120

app/common/src/services/Backend.ts

@@ -1,5 +1,6 @@
 /** @file Type definitions common between all backends. */
 import { z } from 'zod'
+import type { DownloadOptions } from '../download.js'
 import { getText, resolveDictionary, type Replacements, type TextId } from '../text.js'
 import * as dateTime from '../utilities/data/dateTime.js'
 import * as newtype from '../utilities/data/newtype.js'
@@ -95,7 +96,7 @@ export interface Logger {
   readonly error: (message: unknown, ...optionalParams: unknown[]) => void
 }
 
-type GetText = <K extends TextId>(key: K, ...replacements: Replacements[K]) => string
+export type GetText = <K extends TextId>(key: K, ...replacements: Replacements[K]) => string
 
 /** The {@link Backend} variant. If a new variant is created, it should be added to this enum. */
 export enum BackendType {
@@ -1635,15 +1636,23 @@ export class NetworkError extends Error {
 export class NotAuthorizedError extends NetworkError {}
 
 /** Interface for sending requests to a backend that manages assets and runs projects. */
-export default abstract class Backend {
+export abstract class Backend {
   abstract readonly type: BackendType
   abstract readonly baseUrl: URL
+  protected getText: GetText
+  private readonly client: HttpClient
+  protected readonly downloader: (options: DownloadOptions) => void | Promise<void>
 
-  /** Create a {@link LocalBackend}. */
+  /** Create a {@link Backend}. */
   constructor(
-    protected getText: GetText,
-    private readonly client: HttpClient,
-  ) {}
+    getText: GetText,
+    client: HttpClient,
+    downloader: (options: DownloadOptions) => void | Promise<void>,
+  ) {
+    this.getText = getText
+    this.client = client
+    this.downloader = downloader
+  }
 
   /**
    * Set `this.getText`. This function is exposed rather than the property itself to make it clear

app/gui/src/dashboard/layouts/Drive/Categories/Category.ts → app/common/src/services/Backend/Category.ts

@@ -1,6 +1,5 @@
 /** @file The categories available in the category switcher. */
-import type { SvgUseIcon } from '#/components/types'
-import type { UserId } from '#/services/Backend'
+import * as z from 'zod'
 import {
   BackendType,
   FilterBy,
@@ -9,11 +8,8 @@ import {
   type User,
   type UserGroup,
   type UserGroupId,
-} from '#/services/Backend'
-import { isUrlString } from '@/util/data/urlString'
-import { isIconName } from '@/util/iconMetadata/iconName'
-import type { DropOperation } from '@react-types/shared'
-import * as z from 'zod'
+  type UserId,
+} from '../Backend.js'
 
 // oxlint-disable-next-line no-unused-vars
 const PATH_SCHEMA = z.string().refine((s): s is Path => true)
@@ -22,9 +18,7 @@ const DIRECTORY_ID_SCHEMA = z.string().refine((s): s is DirectoryId => true)
 
 const EACH_CATEGORY_SCHEMA = z.object({
   label: z.string(),
-  icon: z.custom<SvgUseIcon | (string & {})>(
-    (icon) => typeof icon === 'string' && (isIconName(icon) || isUrlString(icon)),
-  ),
+  icon: z.string(),
   canUploadHere: z.boolean(),
   /**
    * Internal type discriminator.
@@ -170,7 +164,6 @@ export const CATEGORY_TO_FILTER_BY: Readonly<Record<Category['type'], FilterBy |
   trash: FilterBy.trashed,
   user: FilterBy.active,
   team: FilterBy.active,
-  // eslint-disable-next-line @typescript-eslint/naming-convention
   'local-directory': FilterBy.active,
 }
 
@@ -210,7 +203,7 @@ export function dropOperationBetweenCategories(
   from: Category,
   to: Category,
   parentId: DirectoryId | null = null,
-): DropOperation {
+): 'cancel' | 'copy' | 'move' | undefined {
   // Moving into the same category without a parentId is not allowed.
   if (from.type === to.type && parentId == null) {
     return 'cancel'

app/gui/src/dashboard/services/utilities.ts → app/common/src/services/Backend/utilities.ts

@@ -1,12 +1,8 @@
-/**
- * @file Module containing utility functions related to any backend.
- */
-import type { AnyCategory } from '../layouts/Drive/Categories/Category'
-import type { DirectoryId } from './Backend'
+/** @file Backend agnostic utility functions. */
+import type { DirectoryId } from '../Backend.js'
+import type { AnyCategory } from './Category.js'
 
-/**
- * Options for the parseDirectoriesPath function.
- */
+/** Options for {@link parseDirectoriesPath}. */
 export interface ParsedDirectoriesPathOptions {
   readonly rootDirectoryId: DirectoryId
   readonly getCategoryByDirectoryId: (id: DirectoryId) => AnyCategory | null
@@ -22,14 +18,12 @@ export interface PathItem {
   readonly icon: AnyCategory['icon']
 }
 
-/**
- * Parse the parents path and virtual parents path into a list of {@link PathItem}.
- */
+/** Parse the parents path and virtual parents path into a list of {@link PathItem}. */
 export function parseDirectoriesPath(options: ParsedDirectoriesPathOptions) {
   const { getCategoryByDirectoryId, parentsPath, rootDirectoryId, virtualParentsPath } = options
 
   // e.g: parentsPath = 'directory-id1adsf/directory-id2adsf/directory-id3adsf'
-  // eslint-disable-next-line no-restricted-syntax
+
   const splitPath = parentsPath.split('/') as DirectoryId[]
   const rootDirectoryInPath = splitPath[0] || rootDirectoryId