@domicile-desktop/sdk 0.0.0-alpha-e1457b57e6b2 → 0.0.0-alpha-e2ddcb67524d

package/dist/portal.d.ts

@@ -45,6 +45,12 @@ export declare enum PortalKind {
     /** A kind this SDK cannot parse. Answer it with {@link PortalAnswer.Refused}. */
     Unknown = 15
 }
+/**
+ * The {@link PortalRequestBase.appId} of a dialog the shell asked for itself,
+ * such as the one `system(host).screenshot()` puts up. No application can have
+ * it.
+ */
+export declare const SHELL_APP_ID = "domicile:shell";
 /** What every request carries. */
 export type PortalRequestBase = {
     /** The id {@link answerPortalRequest} takes. */

package/dist/portal.js

@@ -53,6 +53,12 @@ export var PortalKind;
     /** A kind this SDK cannot parse. Answer it with {@link PortalAnswer.Refused}. */
     PortalKind[PortalKind["Unknown"] = 15] = "Unknown";
 })(PortalKind || (PortalKind = {}));
+/**
+ * The {@link PortalRequestBase.appId} of a dialog the shell asked for itself,
+ * such as the one `system(host).screenshot()` puts up. No application can have
+ * it.
+ */
+export const SHELL_APP_ID = "domicile:shell";
 /** Which `FileChooser` method asked. */
 export var FileChooserMode;
 (function (FileChooserMode) {

package/dist/system-message.d.ts

@@ -33,10 +33,14 @@ declare const systemReplySchema: z.ZodObject<{
         signature: z.ZodString;
     }, z.core.$loose>, z.ZodObject<{
         kind: z.ZodLiteral<"started">;
+    }, z.core.$loose>, z.ZodObject<{
+        kind: z.ZodLiteral<"saved">;
+        path: z.ZodString;
     }, z.core.$loose>, z.ZodObject<{
         error: z.ZodObject<{
             kind: z.ZodEnum<{
                 already_exists: "already_exists";
+                canceled: "canceled";
                 dbus: "dbus";
                 invalid_input: "invalid_input";
                 is_a_directory: "is_a_directory";
@@ -86,6 +90,7 @@ declare const systemEndSchema: z.ZodObject<{
         error: z.ZodObject<{
             kind: z.ZodEnum<{
                 already_exists: "already_exists";
+                canceled: "canceled";
                 dbus: "dbus";
                 invalid_input: "invalid_input";
                 is_a_directory: "is_a_directory";
@@ -136,10 +141,14 @@ declare const systemMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         signature: z.ZodString;
     }, z.core.$loose>, z.ZodObject<{
         kind: z.ZodLiteral<"started">;
+    }, z.core.$loose>, z.ZodObject<{
+        kind: z.ZodLiteral<"saved">;
+        path: z.ZodString;
     }, z.core.$loose>, z.ZodObject<{
         error: z.ZodObject<{
             kind: z.ZodEnum<{
                 already_exists: "already_exists";
+                canceled: "canceled";
                 dbus: "dbus";
                 invalid_input: "invalid_input";
                 is_a_directory: "is_a_directory";
@@ -187,6 +196,7 @@ declare const systemMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         error: z.ZodObject<{
             kind: z.ZodEnum<{
                 already_exists: "already_exists";
+                canceled: "canceled";
                 dbus: "dbus";
                 invalid_input: "invalid_input";
                 is_a_directory: "is_a_directory";

package/dist/system-message.js

@@ -13,6 +13,7 @@ const systemErrorSchema = z.looseObject({
         "invalid_input",
         "locked",
         "dbus",
+        "canceled",
         "other",
     ]),
     message: z.string(),
@@ -40,6 +41,7 @@ const systemReplySchema = z.looseObject({
             signature: z.string(),
         }),
         z.looseObject({ kind: z.literal("started") }),
+        z.looseObject({ kind: z.literal("saved"), path: z.string() }),
         z.looseObject({ error: systemErrorSchema, kind: z.literal("failed") }),
     ]),
     type: z.literal("system_reply"),

package/dist/system.d.ts

@@ -13,7 +13,9 @@ export declare enum SystemErrorKind {
     Locked = 6,
     /** A D-Bus method returned an error; the message starts with its name. */
     Dbus = 7,
-    Other = 8
+    /** The user dismissed the dialog the call put up. */
+    Canceled = 8,
+    Other = 9
 }
 export type SystemError = {
     kind: SystemErrorKind;
@@ -144,6 +146,13 @@ export type System = {
     run: (argv: readonly string[], options?: Omit<SpawnOptions, "stdin">) => Promise<Result<Ran, SystemError>>;
     dbusCall: (call: DbusCall) => Promise<Result<DbusBody, SystemError>>;
     dbusMatch: (match: DbusMatch) => Promise<Result<Listening<DbusSignal>, SystemError>>;
+    /**
+     * Take a screenshot as an interactive Screenshot portal call takes one, as
+     * if the shell were the application: the desk freezes, `<PortalDialogs />`
+     * draws the screenshot dialog, and the area picked is saved under
+     * `$XDG_PICTURES_DIR/Screenshots/`. Resolves with the saved PNG's path.
+     */
+    screenshot: () => Promise<Result<string, SystemError>>;
 };
 /** What {@link system} needs of the desktop `Shell` is handed. */
 export type SystemHost = Pick<DomicileHost, "callSystem"> & {

package/dist/system.js

@@ -21,7 +21,9 @@ export var SystemErrorKind;
     SystemErrorKind[SystemErrorKind["Locked"] = 6] = "Locked";
     /** A D-Bus method returned an error; the message starts with its name. */
     SystemErrorKind[SystemErrorKind["Dbus"] = 7] = "Dbus";
-    SystemErrorKind[SystemErrorKind["Other"] = 8] = "Other";
+    /** The user dismissed the dialog the call put up. */
+    SystemErrorKind[SystemErrorKind["Canceled"] = 8] = "Canceled";
+    SystemErrorKind[SystemErrorKind["Other"] = 9] = "Other";
 })(SystemErrorKind || (SystemErrorKind = {}));
 export var FileType;
 (function (FileType) {
@@ -94,6 +96,7 @@ export const system = (host) => {
             ]);
             return exited.map((exit) => ({ ...exit, stderr, stdout }));
         }),
+        screenshot: () => oneShot(calls, { call: "screenshot" }, (reply) => reply.kind === "saved" ? reply.path : unexpected(reply)),
         spawn: (argv, options) => spawn(calls, argv, options),
         stat: (path) => oneShot(calls, { call: "stat", path }, (reply) => reply.kind === "stat"
             ? {
@@ -350,6 +353,9 @@ const errorKind = (kind) => {
         case "dbus": {
             return SystemErrorKind.Dbus;
         }
+        case "canceled": {
+            return SystemErrorKind.Canceled;
+        }
         case "other": {
             return SystemErrorKind.Other;
         }

package/package.json

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