@vicinae/api 0.3.0

package/dist/api/context/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./navigation-provider"), exports);

package/dist/api/context/navigation-context.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from "react";
+export type NavigationContextType = {
+    push: (node: ReactNode) => void;
+    pop: () => void;
+};
+declare const ctx: import("react").Context<NavigationContextType>;
+export default ctx;

package/dist/api/context/navigation-context.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = require("react");
+const ctx = (0, react_1.createContext)({
+    pop: () => { throw new Error('not implemented'); },
+    push: () => { throw new Error('not implemented'); },
+});
+exports.default = ctx;

package/dist/api/context/navigation-provider.d.ts

@@ -0,0 +1,4 @@
+import React, { ReactNode } from 'react';
+export declare const NavigationProvider: React.FC<{
+    root: ReactNode;
+}>;

package/dist/api/context/navigation-provider.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NavigationProvider = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const navigation_context_1 = __importDefault(require("./navigation-context"));
+const bus_1 = require("../bus");
+const View = ({ children }) => {
+    return (0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: children });
+};
+const NavigationProvider = ({ root }) => {
+    const [navStack, setNavStack] = (0, react_1.useState)([root]);
+    const pop = () => {
+        bus_1.bus.turboRequest('ui.popView', {}).then(() => {
+            setNavStack((cur) => cur.slice(0, -1));
+        });
+    };
+    const push = (node) => {
+        bus_1.bus.turboRequest('ui.pushView', {}).then(() => {
+            setNavStack((cur) => [...cur, node]);
+        });
+    };
+    (0, react_1.useEffect)(() => {
+        //console.log('changed nav stack size', navStack.length);
+    }, [navStack]);
+    (0, react_1.useEffect)(() => {
+        const listener = bus_1.bus.subscribe('pop-view', () => {
+            setNavStack((cur) => cur.slice(0, -1));
+        });
+        return () => listener.unsubscribe();
+    }, []);
+    return ((0, jsx_runtime_1.jsx)(navigation_context_1.default.Provider, { value: {
+            push,
+            pop
+        }, children: navStack.map((el, idx) => (0, jsx_runtime_1.jsx)(View, { children: el }, idx)) }));
+};
+exports.NavigationProvider = NavigationProvider;

package/dist/api/controls.d.ts

@@ -0,0 +1,3 @@
+export declare const closeMainWindow: () => Promise<void>;
+export declare const clearSearchBar: () => Promise<void>;
+export declare const getSelectedText: () => Promise<string>;

package/dist/api/controls.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSelectedText = exports.clearSearchBar = exports.closeMainWindow = void 0;
+const bus_1 = require("./bus");
+const closeMainWindow = async () => {
+    await bus_1.bus.turboRequest('ui.closeMainWindow', {});
+};
+exports.closeMainWindow = closeMainWindow;
+const clearSearchBar = async () => {
+    await bus_1.bus.turboRequest('ui.setSearchText', { text: '' });
+};
+exports.clearSearchBar = clearSearchBar;
+const getSelectedText = async () => {
+    const response = await bus_1.bus.turboRequest('ui.getSelectedText', {});
+    if (!response.ok) {
+        throw new Error(`Failed to get selected text`);
+    }
+    return response.value.text;
+};
+exports.getSelectedText = getSelectedText;

package/dist/api/environment.d.ts

@@ -0,0 +1,118 @@
+import { Form } from "./components";
+export interface LaunchContext {
+    [item: string]: any;
+}
+export interface Arguments {
+    [item: string]: any;
+}
+export declare type LaunchProps<T extends {
+    arguments?: Arguments;
+    draftValues?: Form.Values;
+    launchContext?: LaunchContext;
+} = {
+    arguments: Arguments;
+    draftValues: Form.Values;
+    launchContext?: LaunchContext;
+}> = {
+    /**
+     * The type of launch for the command (user initiated or background).
+     */
+    launchType: LaunchType;
+    /**
+     * Use these values to populate the initial state for your command.
+     */
+    arguments: T["arguments"];
+    /**
+     * When a user enters the command via a draft, this object will contain the user inputs that were saved as a draft.
+     * Use its values to populate the initial state for your Form.
+     */
+    draftValues?: T["draftValues"];
+    /**
+     * When the command is launched programmatically via `launchCommand`, this object contains the value passed to `context`.
+     */
+    launchContext?: T["launchContext"];
+    /**
+     * When the command is launched as a fallback command, this string contains the text of the root search.
+     */
+    fallbackText?: string;
+};
+export declare enum LaunchType {
+    /**
+     * A regular launch through user interaction
+     */
+    UserInitiated = "userInitiated",
+    /**
+     * Scheduled through an interval and launched from background
+     */
+    Background = "background"
+}
+export interface Environment {
+    /**
+     * The version of the main Raycast app
+     */
+    raycastVersion: string;
+    /**
+     * The name of the extension, as specified in package.json
+     */
+    extensionName: string;
+    /**
+     * The name of the launched command, as specified in package.json
+     */
+    commandName: string;
+    /**
+     * The mode of the launched command, as specified in package.json
+     */
+    commandMode: "no-view" | "view" | "menu-bar";
+    /**
+     * The absolute path to the assets directory of the extension.
+     *
+     * @remarks
+     * This directory is used internally to load icons, images, and other bundled assets.
+     */
+    assetsPath: string;
+    /**
+     * The absolute path for the support directory of an extension. Use it to read and write files related to your extension or command.
+     */
+    supportPath: string;
+    /**
+     * Indicates whether the command is a development command (vs. an installed command from the Store).
+     */
+    isDevelopment: boolean;
+    /**
+     * The appearance used by the Raycast application.
+     */
+    appearance: "light" | "dark";
+    /**
+     * The theme used by the Raycast application.
+     * @deprecated Use `appearance` instead
+     */
+    theme: "light" | "dark";
+    /**
+     * The text size used by the Raycast application.
+     */
+    textSize: "medium" | "large";
+    /**
+     * The type of launch for the command (user initiated or background).
+     */
+    launchType: LaunchType;
+    /**
+     * Returns whether the user has access to the given API.
+     *
+     *  @example
+     * ```typescript
+     * import { unstableAI, environment } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   if (environment.canAccess(unstableAI)) {
+     *     // use unstableAI
+     *   }
+     * }
+     * ```
+     */
+    canAccess(api: unknown): boolean;
+    /**
+     * @deprecated Use the top-level prop `launchContext` instead.
+     */
+    launchContext?: LaunchContext;
+}
+export declare const environment: Environment;

package/dist/api/environment.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.environment = exports.LaunchType = void 0;
+;
+;
+var LaunchType;
+(function (LaunchType) {
+    /**
+     * A regular launch through user interaction
+     */
+    LaunchType["UserInitiated"] = "userInitiated";
+    /**
+     * Scheduled through an interval and launched from background
+     */
+    LaunchType["Background"] = "background";
+})(LaunchType || (exports.LaunchType = LaunchType = {}));
+exports.environment = {};

package/dist/api/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './use-applications';
+export * from './use-navigation';

package/dist/api/hooks/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./use-applications"), exports);
+__exportStar(require("./use-navigation"), exports);

package/dist/api/hooks/use-applications.d.ts

@@ -0,0 +1,2 @@
+import { Application } from "../utils";
+export declare const useApplications: () => [Application[], boolean, Error | null];

package/dist/api/hooks/use-applications.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useApplications = void 0;
+const react_1 = require("react");
+const utils_1 = require("../utils");
+const useApplications = () => {
+    const [isLoading, setIsLoading] = (0, react_1.useState)(true);
+    const [error, setError] = (0, react_1.useState)(null);
+    const [apps, setApps] = (0, react_1.useState)([]);
+    (0, react_1.useEffect)(() => {
+        setIsLoading(true);
+        (0, utils_1.getApplications)()
+            .then(setApps)
+            .catch(setError)
+            .finally(() => setIsLoading(false));
+    }, []);
+    return [apps, isLoading, error];
+};
+exports.useApplications = useApplications;

package/dist/api/hooks/use-imperative-form-handle.d.ts

@@ -0,0 +1,3 @@
+import { FormItemRef } from '../components/form';
+import { Ref } from 'react';
+export declare const useImperativeFormHandle: (ref?: Ref<FormItemRef>) => [string];

package/dist/api/hooks/use-imperative-form-handle.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useImperativeFormHandle = void 0;
+const crypto_1 = require("crypto");
+const react_1 = require("react");
+const bus_1 = require("../bus");
+const useImperativeFormHandle = (ref) => {
+    const handleId = (0, react_1.useRef)((0, crypto_1.randomUUID)());
+    (0, react_1.useImperativeHandle)(ref, () => {
+        return {
+            focus: () => {
+                bus_1.bus.emit(handleId.current, {
+                    type: 'focus'
+                });
+            },
+            reset: () => {
+                bus_1.bus.emit(handleId.current, {
+                    type: 'reset'
+                });
+            }
+        };
+    }, []);
+    return [handleId.current];
+};
+exports.useImperativeFormHandle = useImperativeFormHandle;

package/dist/api/hooks/use-navigation.d.ts

@@ -0,0 +1,4 @@
+export declare const useNavigation: () => {
+    push: (node: import("react").ReactNode) => void;
+    pop: () => void;
+};

package/dist/api/hooks/use-navigation.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useNavigation = void 0;
+const react_1 = require("react");
+const navigation_context_1 = __importDefault(require("../context/navigation-context"));
+const useNavigation = () => {
+    const { push, pop } = (0, react_1.useContext)(navigation_context_1.default);
+    return { push, pop };
+};
+exports.useNavigation = useNavigation;

package/dist/api/hooks.d.ts

@@ -0,0 +1 @@
+export declare const useEventListener: (fn: ((...args: any[]) => void) | undefined) => string | undefined;

package/dist/api/hooks.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useEventListener = void 0;
+const react_1 = require("react");
+const bus_1 = require("./bus");
+const handlerIdFactory = {
+    nextHandlerId: 0,
+    next() {
+        return this.nextHandlerId++;
+    }
+};
+const useEventListener = (fn) => {
+    const id = (0, react_1.useRef)(`handler:${handlerIdFactory.next()}`);
+    const callback = (0, react_1.useRef)();
+    (0, react_1.useEffect)(() => {
+        const { unsubscribe } = bus_1.bus.subscribe(id.current, (...args) => { callback.current?.(...args); });
+        return unsubscribe;
+    }, []);
+    (0, react_1.useEffect)(() => {
+        callback.current = fn;
+    }, [fn]);
+    return fn && id.current;
+};
+exports.useEventListener = useEventListener;