@domicile-desktop/sdk 0.0.0-alpha-bf4214ef2f5b → 0.0.0-alpha-dfd80a336b89

package/dist/portal.d.ts

@@ -2,8 +2,12 @@ import type { DomicileHost } from "./domicile-host";
 export declare enum PortalKind {
     /** A yes/no question, such as whether an application may use the camera. */
     Access = 0,
+    /** Pick an application to open a file or URI with. */
+    AppChooser = 1,
+    /** Files to open, or where to save. */
+    FileChooser = 2,
     /** A kind this SDK cannot parse. Answer it with {@link PortalAnswer.Refused}. */
-    Unknown = 1
+    Unknown = 3
 }
 /** What every request carries. */
 export type PortalRequestBase = {
@@ -22,6 +26,79 @@ export type AccessBody = {
     grantLabel: string | undefined;
     denyLabel: string | undefined;
 };
+/** What an app chooser opens, and the applications it offers. */
+export type AppChooserBody = {
+    /** Desktop file IDs without `.desktop`. May change while the dialog is up. */
+    choices: readonly string[];
+    /** The application chosen last time for this content type. */
+    lastChoice: string | undefined;
+    /** The MIME type being opened. */
+    contentType: string | undefined;
+    uri: string | undefined;
+    /** The file's name, without its directory. */
+    filename: string | undefined;
+};
+/** Which `FileChooser` method asked. */
+export declare enum FileChooserMode {
+    /** Existing files, or a folder when `directory` is set. */
+    Open = 0,
+    /** One new path. */
+    Save = 1,
+    /** A folder to save `files` into. */
+    SaveFiles = 2
+}
+/** A named group of accepted extensions, such as "Images". */
+export type FileChooserFilter = {
+    /** Lowercase and without the dot; empty accepts any file. */
+    extensions: readonly string[];
+    name: string;
+};
+/**
+ * A question asked beside the files. No options means a checkbox, answered
+ * `"true"` or `"false"`.
+ */
+export type FileChoice = {
+    id: string;
+    /** The option id, or `"true"`/`"false"`, selected at first. */
+    initial: string;
+    label: string;
+    options: readonly {
+        id: string;
+        label: string;
+    }[];
+};
+/** A file chooser's request. Paths are absolute. */
+export type FileChooserBody = {
+    /** The confirm button's label; the shell's own when absent. */
+    acceptLabel: string | undefined;
+    choices: readonly FileChoice[];
+    /** The index in `filters` to start with. */
+    currentFilter: number | undefined;
+    /** The folder to start in; the home when absent. */
+    currentFolder: string | undefined;
+    /** The suggested name for {@link FileChooserMode.Save}. */
+    currentName: string | undefined;
+    /** Open a folder rather than a file. */
+    directory: boolean;
+    /** The names {@link FileChooserMode.SaveFiles} saves into the folder. */
+    files: readonly string[];
+    /** Empty accepts any file. */
+    filters: readonly FileChooserFilter[];
+    /** The user's home directory, where the picker's places are. */
+    home: string;
+    mode: FileChooserMode;
+    multiple: boolean;
+    title: string;
+};
+/** What the user chose in a file chooser. */
+export type FileChosen = {
+    /** Each {@link FileChoice}'s answer, by id. */
+    choices: ReadonlyMap<string, string>;
+    /** The index in the request's `filters` in use. */
+    currentFilter: number | undefined;
+    /** Absolute paths: the files, or the folder for `SaveFiles`. */
+    paths: readonly string[];
+};
 export declare const PortalRequest: {
     Access: (base: PortalRequestBase, body: AccessBody) => {
         /** The id {@link answerPortalRequest} takes. */
@@ -33,6 +110,26 @@ export declare const PortalRequest: {
         body: AccessBody;
         kind: PortalKind.Access;
     };
+    AppChooser: (base: PortalRequestBase, body: AppChooserBody) => {
+        /** The id {@link answerPortalRequest} takes. */
+        id: number;
+        /** The asking application's desktop file id. Empty when unknown. */
+        appId: string;
+        /** The `<app>` to show the dialog over, or the focused screen when absent. */
+        parentAppId: string | undefined;
+        body: AppChooserBody;
+        kind: PortalKind.AppChooser;
+    };
+    FileChooser: (base: PortalRequestBase, body: FileChooserBody) => {
+        /** The id {@link answerPortalRequest} takes. */
+        id: number;
+        /** The asking application's desktop file id. Empty when unknown. */
+        appId: string;
+        /** The `<app>` to show the dialog over, or the focused screen when absent. */
+        parentAppId: string | undefined;
+        body: FileChooserBody;
+        kind: PortalKind.FileChooser;
+    };
     Unknown: (base: PortalRequestBase, wireKind: string) => {
         /** The id {@link answerPortalRequest} takes. */
         id: number;
@@ -48,18 +145,31 @@ export type PortalRequest = ReturnType<(typeof PortalRequest)[keyof typeof Porta
 export declare enum PortalAnswerKind {
     /** The user allowed an {@link PortalKind.Access} request. */
     Access = 0,
+    /** The application the user picked in an {@link PortalKind.AppChooser}. */
+    AppChooser = 1,
+    /** The user chose in a {@link PortalKind.FileChooser}. */
+    FileChooser = 2,
     /** The user dismissed or denied the dialog. */
-    Canceled = 1,
+    Canceled = 3,
     /** The shell has no dialog for this kind. */
-    Refused = 2
+    Refused = 4
 }
 export declare const PortalAnswer: {
     Access: () => {
         kind: PortalAnswerKind.Access;
     };
+    /** `choice` must be one of the request's `choices`. */
+    AppChooser: (choice: string) => {
+        choice: string;
+        kind: PortalAnswerKind.AppChooser;
+    };
     Canceled: () => {
         kind: PortalAnswerKind.Canceled;
     };
+    FileChooser: (chosen: FileChosen) => {
+        chosen: FileChosen;
+        kind: PortalAnswerKind.FileChooser;
+    };
     Refused: () => {
         kind: PortalAnswerKind.Refused;
     };

package/dist/portal.js

@@ -9,15 +9,39 @@ export var PortalKind;
 (function (PortalKind) {
     /** A yes/no question, such as whether an application may use the camera. */
     PortalKind[PortalKind["Access"] = 0] = "Access";
+    /** Pick an application to open a file or URI with. */
+    PortalKind[PortalKind["AppChooser"] = 1] = "AppChooser";
+    /** Files to open, or where to save. */
+    PortalKind[PortalKind["FileChooser"] = 2] = "FileChooser";
     /** A kind this SDK cannot parse. Answer it with {@link PortalAnswer.Refused}. */
-    PortalKind[PortalKind["Unknown"] = 1] = "Unknown";
+    PortalKind[PortalKind["Unknown"] = 3] = "Unknown";
 })(PortalKind || (PortalKind = {}));
+/** Which `FileChooser` method asked. */
+export var FileChooserMode;
+(function (FileChooserMode) {
+    /** Existing files, or a folder when `directory` is set. */
+    FileChooserMode[FileChooserMode["Open"] = 0] = "Open";
+    /** One new path. */
+    FileChooserMode[FileChooserMode["Save"] = 1] = "Save";
+    /** A folder to save `files` into. */
+    FileChooserMode[FileChooserMode["SaveFiles"] = 2] = "SaveFiles";
+})(FileChooserMode || (FileChooserMode = {}));
 export const PortalRequest = {
     Access: (base, body) => ({
         ...base,
         body,
         kind: PortalKind.Access,
     }),
+    AppChooser: (base, body) => ({
+        ...base,
+        body,
+        kind: PortalKind.AppChooser,
+    }),
+    FileChooser: (base, body) => ({
+        ...base,
+        body,
+        kind: PortalKind.FileChooser,
+    }),
     Unknown: (base, wireKind) => ({
         ...base,
         kind: PortalKind.Unknown,
@@ -28,14 +52,27 @@ export var PortalAnswerKind;
 (function (PortalAnswerKind) {
     /** The user allowed an {@link PortalKind.Access} request. */
     PortalAnswerKind[PortalAnswerKind["Access"] = 0] = "Access";
+    /** The application the user picked in an {@link PortalKind.AppChooser}. */
+    PortalAnswerKind[PortalAnswerKind["AppChooser"] = 1] = "AppChooser";
+    /** The user chose in a {@link PortalKind.FileChooser}. */
+    PortalAnswerKind[PortalAnswerKind["FileChooser"] = 2] = "FileChooser";
     /** The user dismissed or denied the dialog. */
-    PortalAnswerKind[PortalAnswerKind["Canceled"] = 1] = "Canceled";
+    PortalAnswerKind[PortalAnswerKind["Canceled"] = 3] = "Canceled";
     /** The shell has no dialog for this kind. */
-    PortalAnswerKind[PortalAnswerKind["Refused"] = 2] = "Refused";
+    PortalAnswerKind[PortalAnswerKind["Refused"] = 4] = "Refused";
 })(PortalAnswerKind || (PortalAnswerKind = {}));
 export const PortalAnswer = {
     Access: () => ({ kind: PortalAnswerKind.Access }),
+    /** `choice` must be one of the request's `choices`. */
+    AppChooser: (choice) => ({
+        choice,
+        kind: PortalAnswerKind.AppChooser,
+    }),
     Canceled: () => ({ kind: PortalAnswerKind.Canceled }),
+    FileChooser: (chosen) => ({
+        chosen,
+        kind: PortalAnswerKind.FileChooser,
+    }),
     Refused: () => ({ kind: PortalAnswerKind.Refused }),
 };
 /**
@@ -56,7 +93,7 @@ export const watchPortalRequests = (host, listener) => {
 };
 /** Answer request `id`. The first answer to reach the compositor wins. */
 export const answerPortalRequest = (host, id, answer) => {
-    host.answerPortalRequest(id, JSON.stringify({ kind: wireAnswer(answer) }));
+    host.answerPortalRequest(id, JSON.stringify(wireAnswer(answer)));
 };
 const accessSchema = z
     .object({
@@ -73,12 +110,69 @@ const accessSchema = z
     subtitle: body.subtitle,
     title: body.title,
 }));
+const appChooserSchema = z
+    .object({
+    choices: z.array(z.string()),
+    content_type: z.string().optional(),
+    filename: z.string().optional(),
+    last_choice: z.string().optional(),
+    uri: z.string().optional(),
+})
+    .transform((body) => ({
+    choices: body.choices,
+    contentType: body.content_type,
+    filename: body.filename,
+    lastChoice: body.last_choice,
+    uri: body.uri,
+}));
+const fileChooserSchema = z
+    .object({
+    accept_label: z.string().optional(),
+    choices: z.array(z.object({
+        id: z.string(),
+        initial: z.string(),
+        label: z.string(),
+        options: z.array(z.object({ id: z.string(), label: z.string() })),
+    })),
+    current_filter: z.number().optional(),
+    current_folder: z.string().optional(),
+    current_name: z.string().optional(),
+    directory: z.boolean(),
+    files: z.array(z.string()),
+    filters: z.array(z.object({ extensions: z.array(z.string()), name: z.string() })),
+    home: z.string(),
+    mode: z.enum(["open", "save", "save_files"]),
+    multiple: z.boolean(),
+    title: z.string(),
+})
+    .transform((body) => ({
+    acceptLabel: body.accept_label,
+    choices: body.choices,
+    currentFilter: body.current_filter,
+    currentFolder: body.current_folder,
+    currentName: body.current_name,
+    directory: body.directory,
+    files: body.files,
+    filters: body.filters,
+    home: body.home,
+    mode: chooserMode(body.mode),
+    multiple: body.multiple,
+    title: body.title,
+}));
 /** Each kind's wire name, and how to read its body into a request. */
 const KINDS = new Map([
     [
         "access",
         (base, body) => PortalRequest.Access(base, accessSchema.parse(body)),
     ],
+    [
+        "app_chooser",
+        (base, body) => PortalRequest.AppChooser(base, appChooserSchema.parse(body)),
+    ],
+    [
+        "file_chooser",
+        (base, body) => PortalRequest.FileChooser(base, fileChooserSchema.parse(body)),
+    ],
 ]);
 const itemSchema = z.object({
     app_id: z.string(),
@@ -102,13 +196,33 @@ const parseRequest = (item) => {
         ? PortalRequest.Unknown(base, item.kind)
         : parse(base, item.body);
 };
+const chooserMode = (mode) => {
+    switch (mode) {
+        case "open":
+            return FileChooserMode.Open;
+        case "save":
+            return FileChooserMode.Save;
+        case "save_files":
+            return FileChooserMode.SaveFiles;
+    }
+};
+/** `answer` as the compositor reads it. */
 const wireAnswer = (answer) => {
     switch (answer.kind) {
         case PortalAnswerKind.Access:
-            return "access";
+            return { kind: "access" };
+        case PortalAnswerKind.AppChooser:
+            return { choice: answer.choice, kind: "app_chooser" };
         case PortalAnswerKind.Canceled:
-            return "canceled";
+            return { kind: "canceled" };
+        case PortalAnswerKind.FileChooser:
+            return {
+                choices: Object.fromEntries(answer.chosen.choices),
+                current_filter: answer.chosen.currentFilter,
+                kind: "file_chooser",
+                paths: answer.chosen.paths,
+            };
         case PortalAnswerKind.Refused:
-            return "refused";
+            return { kind: "refused" };
     }
 };

package/package.json

@@ -95,7 +95,7 @@
     "test:unit": "bun test"
   },
   "type": "module",
-  "version": "0.0.0-alpha-bf4214ef2f5b",
+  "version": "0.0.0-alpha-dfd80a336b89",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cprussin/domicile.git",