@vicinae/api 0.14.0 → 0.14.2

package/dist/api/components/actions.d.ts

@@ -7,7 +7,12 @@ import { Form } from "./form";
 export type BaseActionProps = {
     title: string;
     icon?: ImageLike;
-    shortcut?: Keyboard.Shortcut;
+    /**
+     * The shortcut to bind this action to.
+     * It is highly recommended to use named shortcuts such as
+     * Keyboard.Shortcut.Common.Copy as they will respect user preferences.
+     */
+    shortcut?: Keyboard.Shortcut | Keyboard.Shortcut.Common;
     autoFocus?: boolean;
     style?: "regular" | "destructive";
 };

package/dist/api/components/form.js

@@ -21,10 +21,12 @@ const TextField = ({ ref, ...props }) => {
     (0, use_imperative_form_handle_1.useImperativeFormHandle)(ref);
     return ((0, jsx_runtime_1.jsx)("text-field", { ...wrapFormItemProps(props) }));
 };
-const PasswordField = ({ ...props }) => {
+const PasswordField = ({ ref, ...props }) => {
+    (0, use_imperative_form_handle_1.useImperativeFormHandle)(ref);
     return (0, jsx_runtime_1.jsx)("password-field", { ...props });
 };
-const DatePicker = ({ ...props }) => {
+const DatePicker = ({ ref, ...props }) => {
+    (0, use_imperative_form_handle_1.useImperativeFormHandle)(ref);
     return (0, jsx_runtime_1.jsx)("date-picker-field", { ...props });
 };
 const Checkbox = ({ ref, ...props }) => {
@@ -33,8 +35,9 @@ const Checkbox = ({ ref, ...props }) => {
 };
 //FIXME: we probably need to reuse the existing dropdown in
 // a smarter way.
-const DropdownRoot = ({ children, ...props }) => {
+const DropdownRoot = ({ ref, children, ...props }) => {
     // FIXME: testing stuff, we need to generalize this to all form items
+    (0, use_imperative_form_handle_1.useImperativeFormHandle)(ref);
     return ((0, jsx_runtime_1.jsx)("dropdown-field", { ...wrapFormItemProps(props), children: children }));
 };
 const Dropdown = Object.assign(DropdownRoot, {
@@ -50,10 +53,12 @@ const TagPickerItem = ({ icon, ...props }) => {
 const TagPicker = Object.assign(TagPickerRoot, {
     Item: TagPickerItem
 });
-const TextArea = (props) => {
+const TextArea = ({ ref, ...props }) => {
+    (0, use_imperative_form_handle_1.useImperativeFormHandle)(ref);
     return ((0, jsx_runtime_1.jsx)("text-area-field", { ...wrapFormItemProps(props) }));
 };
-const FilePicker = (props) => {
+const FilePicker = ({ ref, ...props }) => {
+    (0, use_imperative_form_handle_1.useImperativeFormHandle)(ref);
     return ((0, jsx_runtime_1.jsx)("file-picker-field", { ...wrapFormItemProps(props) }));
 };
 const Description = (props) => {

package/dist/api/keyboard.d.ts

@@ -1,16 +1,29 @@
 export type KeyEquivalent = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "." | "," | ";" | "=" | "+" | "-" | "[" | "]" | "{" | "}" | "«" | "»" | "(" | ")" | "/" | "\\" | "'" | "`" | "§" | "^" | "@" | "$" | "return" | "delete" | "deleteForward" | "tab" | "arrowUp" | "arrowDown" | "arrowLeft" | "arrowRight" | "pageUp" | "pageDown" | "home" | "end" | "space" | "escape" | "enter" | "backspace";
+export type KeyModifier = "cmd" | "ctrl" | "opt" | "shift";
 export declare namespace Keyboard {
+    namespace Shortcut {
+        type Common = 'copy' | 'copy-deeplink' | 'copy-name' | 'copy-path' | 'save' | 'duplicate' | 'edit' | 'move-down' | 'move-up' | 'new' | 'open' | 'open-with' | 'pin' | 'refresh' | 'remove' | 'remove-all';
+        const Common: {
+            Copy: string;
+            CopyDeeplink: string;
+            CopyName: string;
+            CopyPath: string;
+            Save: string;
+            Duplicate: string;
+            Edit: string;
+            MoveDown: string;
+            MoveUp: string;
+            New: string;
+            Open: string;
+            OpenWith: string;
+            Pin: string;
+            Refresh: string;
+            Remove: string;
+            RemoveAll: string;
+        };
+    }
     type Shortcut = {
         key: KeyEquivalent;
         modifiers: KeyModifier[];
     };
 }
-export type KeyModifier = "cmd" | "ctrl" | "opt" | "shift";
-export declare const Keyboard: {
-    Shortcut: {
-        Common: {
-            Copy: Keyboard.Shortcut;
-            CopyName: Keyboard.Shortcut;
-        };
-    };
-};

package/dist/api/keyboard.js

@@ -1,11 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Keyboard = void 0;
-exports.Keyboard = {
-    Shortcut: {
-        Common: {
-            Copy: { modifiers: ["cmd", "shift"], key: "c" },
-            CopyName: { modifiers: ["cmd", "shift"], key: "." },
-        },
-    },
-};
+var Keyboard;
+(function (Keyboard) {
+    let Shortcut;
+    (function (Shortcut) {
+        Shortcut.Common = {
+            Copy: "copy",
+            CopyDeeplink: 'copy',
+            CopyName: 'copy',
+            CopyPath: 'copy',
+            Save: 'save',
+            Duplicate: 'duplicate',
+            Edit: 'edit',
+            MoveDown: 'move-down',
+            MoveUp: 'move-up',
+            New: 'new',
+            Open: 'open',
+            OpenWith: 'open-with',
+            Pin: 'pin',
+            Refresh: 'refresh',
+            Remove: 'remove',
+            RemoveAll: 'remove-all',
+        };
+    })(Shortcut = Keyboard.Shortcut || (Keyboard.Shortcut = {}));
+    ;
+})(Keyboard || (exports.Keyboard = Keyboard = {}));
+;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vicinae/api",
-  "version": "0.14.0",
+  "version": "0.14.2",
   "description": "TypeScript SDK to build Vicinae extensions",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",