@vicinae/api 0.3.0

package/dist/commands/develop/index.js

@@ -0,0 +1,193 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const chokidar = __importStar(require("chokidar"));
+const esbuild = __importStar(require("esbuild"));
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = require("node:fs");
+const promises_1 = require("node:fs/promises");
+const node_path_1 = require("node:path");
+const logger_js_1 = require("../../utils/logger.js");
+const utils_js_1 = require("../../utils/utils.js");
+const vicinae_js_1 = require("../../utils/vicinae.js");
+const manifest_js_1 = __importDefault(require("../../schemas/manifest.js"));
+class Develop extends core_1.Command {
+    static args = {};
+    static description = "Start an extension development session";
+    static examples = [
+        `<%= config.bin %> <%= command.id %> --target /path/to/extension`,
+    ];
+    static flags = {
+        target: core_1.Flags.string({
+            aliases: ["input"],
+            char: "i",
+            default: process.cwd(),
+            defaultHelp: "The current working directory",
+            description: "Path to the extension directory",
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(Develop);
+        const logger = new logger_js_1.Logger();
+        const pkgPath = (0, node_path_1.join)(flags.target, "package.json");
+        if (!(0, node_fs_1.existsSync)(pkgPath)) {
+            logger.logError(`No package.json found at ${pkgPath}. Does this location point to a valid extension repository?`);
+            process.exit(1);
+        }
+        const json = JSON.parse((0, node_fs_1.readFileSync)(pkgPath, 'utf8'));
+        const e = manifest_js_1.default.safeParse(json);
+        if (e.error) {
+            logger.logError(`${pkgPath} is not a valid extension manifest: ${e.error}`);
+            process.exit(1);
+        }
+        const manifest = e.data;
+        const vicinae = new vicinae_js_1.VicinaeClient();
+        const typeCheck = async () => {
+            const spawned = (0, node_child_process_1.spawn)("npx", ["tsc", "--noEmit"]);
+            let stderr = Buffer.from("");
+            return new Promise((resolve) => {
+                spawned.stderr.on("data", (buf) => {
+                    stderr = Buffer.concat([stderr, buf]);
+                });
+                spawned.on("exit", (status) => resolve({ error: stderr.toString(), ok: status === 0 }));
+            });
+        };
+        const build = async (outDir) => {
+            logger.logInfo("Started type checking in background thread");
+            typeCheck().then(({ error, ok }) => {
+                if (!ok) {
+                    logger.logInfo(`Type checking error: ${error}`);
+                }
+                logger.logInfo("Done type checking");
+            });
+            const entryPoints = manifest.commands.map((cmd) => (0, node_path_1.join)("src", `${cmd.name}.tsx`));
+            logger.logInfo(`entrypoints [${entryPoints.join(", ")}]`);
+            const promises = manifest.commands.map((cmd) => {
+                const source = (0, node_path_1.join)(process.cwd(), "src", `${cmd.name}.tsx`);
+                return esbuild.build({
+                    bundle: true,
+                    entryPoints: [source],
+                    external: ["react", "@vicinae/api"],
+                    format: "cjs",
+                    outfile: (0, node_path_1.join)(outDir, `${cmd.name}.js`),
+                    platform: "node",
+                });
+            });
+            await Promise.all(promises);
+            const targetPkg = (0, node_path_1.join)(outDir, "package.json");
+            const targetAssets = (0, node_path_1.join)(outDir, "assets");
+            (0, node_fs_1.cpSync)("package.json", targetPkg, { force: true });
+            if ((0, node_fs_1.existsSync)("assets")) {
+                (0, node_fs_1.cpSync)("assets", targetAssets, { force: true, recursive: true });
+            }
+            else {
+                (0, node_fs_1.mkdirSync)(targetAssets, { recursive: true });
+            }
+        };
+        const pingError = vicinae.ping();
+        if (pingError) {
+            console.error(`Failed to ping vicinae\n`, pingError.message);
+            return;
+        }
+        process.chdir(flags.target);
+        const dataDir = (0, utils_js_1.extensionDataDir)();
+        const id = `${manifest.name}.dev`;
+        const extensionDir = (0, node_path_1.join)(dataDir, id);
+        const logFile = (0, node_path_1.join)(extensionDir, "dev.log");
+        const pidFile = (0, node_path_1.join)(extensionDir, "cli.pid");
+        (0, node_fs_1.mkdirSync)(extensionDir, { recursive: true });
+        await build(extensionDir);
+        logger.logReady("built extension successfully");
+        (0, node_fs_1.writeFileSync)(pidFile, `${process.pid}`);
+        (0, node_fs_1.writeFileSync)(logFile, "");
+        process.on("SIGINT", () => {
+            logger.logInfo("Shutting down...");
+            vicinae.stopDevSession(id);
+            throw new Error(`Development session interrupted`);
+        });
+        const error = vicinae.startDevSession(id);
+        if (error) {
+            console.error(`Failed to invoke vicinae`, error);
+            return;
+        }
+        chokidar
+            .watch(["src", "package.json", "assets"], {
+            awaitWriteFinish: { pollInterval: 100, stabilityThreshold: 100 },
+            ignoreInitial: true,
+        })
+            .on("all", (_, path) => {
+            logger.logEvent(`changed file ${path}:`);
+            try {
+                build(extensionDir);
+                logger.logReady("built extension successfully");
+                vicinae.refreshDevSession(id);
+            }
+            catch (error) {
+                logger.logEvent(`Failed to build extension: ${error}`);
+            }
+        });
+        const logFiles = new Map();
+        chokidar.watch(logFile).on("all", async (_, path) => {
+            const stats = await (0, promises_1.stat)(path);
+            if (!stats.isFile())
+                return;
+            if (!logFiles.has(path)) {
+                logger.logInfo(`Monitoring new log file at ${path}`);
+                logFiles.set(path, { cursor: 0, path });
+            }
+            const info = logFiles.get(path);
+            if (info.cursor > stats.size) {
+                info.cursor = 0;
+            }
+            if (stats.size === info.cursor)
+                return;
+            const handle = await (0, promises_1.open)(path, "r");
+            const buffer = Buffer.alloc(stats.size - info.cursor);
+            (0, node_fs_1.read)(handle.fd, buffer, 0, buffer.length, info.cursor, (error, nRead) => {
+                if (error)
+                    return;
+                info.cursor += nRead;
+                logger.logTimestamp(buffer.toString());
+                handle.close();
+            });
+        });
+    }
+}
+exports.default = Develop;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './api';

package/dist/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("./api"), exports);

package/dist/schemas/manifest.d.ts

@@ -0,0 +1,75 @@
+import { z } from "zod";
+declare const _default: z.ZodObject<{
+    icon: z.ZodString;
+    name: z.ZodString;
+    debug: z.ZodOptional<z.ZodObject<{
+        reloadShortcut: z.ZodOptional<z.ZodObject<{
+            key: z.ZodString;
+            modifiers: z.ZodArray<z.ZodEnum<{
+                shift: "shift";
+                command: "command";
+                option: "option";
+                control: "control";
+            }>>;
+        }, z.core.$strict>>;
+    }, z.core.$strip>>;
+    owner: z.ZodOptional<z.ZodString>;
+    title: z.ZodString;
+    access: z.ZodOptional<z.ZodEnum<{
+        public: "public";
+        private: "private";
+    }>>;
+    author: z.ZodString;
+    license: z.ZodLiteral<"MIT">;
+    platforms: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        macOS: "macOS";
+        Windows: "Windows";
+    }>>>;
+    commands: z.ZodArray<z.ZodObject<{
+        icon: z.ZodOptional<z.ZodString>;
+        mode: z.ZodEnum<{
+            "menu-bar": "menu-bar";
+            "no-view": "no-view";
+            view: "view";
+        }>;
+        name: z.ZodString;
+        title: z.ZodString;
+        keywords: z.ZodOptional<z.ZodAny>;
+        subtitle: z.ZodOptional<z.ZodString>;
+        description: z.ZodString;
+        interval: z.ZodOptional<z.ZodString>;
+        preferences: z.ZodOptional<z.ZodAny>;
+        arguments: z.ZodOptional<z.ZodAny>;
+        disabledByDefault: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$catchall<z.ZodAny>>>;
+    tools: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        icon: z.ZodOptional<z.ZodString>;
+        name: z.ZodString;
+        title: z.ZodString;
+        keywords: z.ZodOptional<z.ZodAny>;
+        description: z.ZodString;
+        functionalities: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            "AI attachment provider": "AI attachment provider";
+            "AI tool": "AI tool";
+        }>>>;
+        preferences: z.ZodOptional<z.ZodAny>;
+    }, z.core.$catchall<z.ZodAny>>>>;
+    ai: z.ZodOptional<z.ZodObject<{
+        instructions: z.ZodOptional<z.ZodString>;
+        evals: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            input: z.ZodString;
+            usedAsExample: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    keywords: z.ZodOptional<z.ZodAny>;
+    description: z.ZodString;
+    preferences: z.ZodOptional<z.ZodAny>;
+    categories: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    contributors: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    pastContributors: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    dependencies: z.ZodObject<{
+        "@raycast/api": z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    external: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export default _default;

package/dist/schemas/manifest.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const zod_1 = require("zod");
+exports.default = zod_1.z.object({ "icon": zod_1.z.string().regex(new RegExp("^[^\\s]+(?:[ ]*[^\\s]+)*$")).describe("A 512x512 icon representing the extension. It will be displayed in the Store and in Preferences. If any of the extension's commands doesn't have an icon, it will 'inherit' the extension's icon. Please note that light and dark themes are supported; just append '@dark' to the filename for the dark theme and the correct icon will be picked at run-time. For example, set for this property 'icon.png' and put in the assets folder the 'icon.png' and 'icon@dark.png' files."), "name": zod_1.z.string().regex(new RegExp("^(@workaround/)?[a-z0-9-~][a-z0-9-_~]*$")).min(3).max(255).describe("The slugged extension's name used internally as identifier and in the store as part of the URL."), "debug": zod_1.z.object({ "reloadShortcut": zod_1.z.object({ "key": zod_1.z.string().min(1).max(2).describe("The keyboard key pressed with the modifier to trigger an action (e.g. ⌘ + B)"), "modifiers": zod_1.z.array(zod_1.z.enum(["command", "option", "control", "shift"])).min(1).max(4).describe("Such as the command modifier (⌘), option modifier (⌥), control modifier (⌃), or shift modifier (⇧).") }).strict().describe("Keyboard shortcut used to refresh/reload a command while the Vicinae window is focused.").optional() }).describe("Compilation and run-time options to improve development experience.").optional(), "owner": zod_1.z.string().regex(new RegExp("^[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*$")).min(2).max(75).describe("User ultimately responsible for the extension. The extension's store URL is composed of the owner username and the extension's name.").optional(), "title": zod_1.z.string().regex(new RegExp("^[^\\s]+(?: [^\\s]+)*$")).min(2).max(255).describe("The extension title will be displayed in the Store and in Preferences."), "access": zod_1.z.enum(["public", "private"]).describe("Public extensions are downloadable by anybody, while private extensions can only be downloaded by a member of a given organization.").optional(), "author": zod_1.z.string().regex(new RegExp("^[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*$")).min(2).max(75).describe("User currently contributing the most to the extension."), "license": zod_1.z.literal("MIT").describe("Currently only MIT is accepted, although more licenses will probably be available in the future."), "platforms": zod_1.z.array(zod_1.z.enum(["macOS", "Windows"])).min(1).describe("Currently only `macOS` and `Windows` are accepted. If not present, the extension is assumed to be available on all platforms.").optional(), "commands": zod_1.z.array(zod_1.z.object({ "icon": zod_1.z.string().regex(new RegExp("^[^\\s]+(?:[ ]*[^\\s]+)*$")).describe("A 512x512 icon representing the command. It will be displayed in Preferences and Vicinae root search. If a command doesn't have an icon, it will 'inherit' the extension's icon. Please note that light and dark themes are supported; just append '@dark' or '@light' to the icons name and the correct icon will be picked at run-time. For example, write for this property 'icon.png' and have in the assets folder the 'icon@light.png' and 'icon@dark.png' assets.").optional(), "mode": zod_1.z.enum(["view", "no-view", "menu-bar"]).describe("A value of 'view' indicates that the command will show a main view when performed. 'no-view' means that the command does not push a view to the main navigation stack in Vicinae. The latter is handy for directly opening URL or other API functionality that doesn't require a user interface. 'menu-bar' renders an extra item in the macOS system menu bar at the top of the screen."), "name": zod_1.z.string().regex(new RegExp("^[a-z0-9-~][a-zA-Z0-9-._~]*$")).min(2).max(255).describe("The name directly maps to the entry point file for the command. So a command named 'index' would map to 'src/index.ts' (or any other supported TypeScript or JavaScript file extension such as .tsx, .js, .jsx)."), "title": zod_1.z.string().regex(new RegExp("^[^\\s]+(?: [^\\s]+)*$")).min(2).max(255).describe("The command title will be displayed in the Store, Preferences, and in Vicinae's root search."), "keywords": zod_1.z.any().optional(), "subtitle": zod_1.z.string().regex(new RegExp("^[^\\s]+(?: [^\\s]+)*$")).min(2).max(255).describe("The subtitle (if any) will be displayed next to the command name in the root search. It helps user differentiate potentially similar commands. For example, a Google Suite extension may define 2 commands titled 'Create Document'. To differentiate them, one of the subtitle can be 'Google Docs' while the other can be 'Google Sheets'.").optional(), "description": zod_1.z.string().regex(new RegExp("^[^\\s]+(\\s+[^\\s]+)*$")).min(0).max(2048).describe("It helps users understand what the command does. It will be displayed in the Store and in Preferences."), "interval": zod_1.z.string().regex(new RegExp("^(\\d+)(s|m|h|d)$")).describe("The value specifies that a no-view or menu-bar command should be launched in the background every X seconds (s), minutes (m), hours (h) or days (d). Examples: 90s, 1m, 12h, 1d. The minimum value is 10 seconds (10s).").optional(), "preferences": zod_1.z.any().describe("Commands can optionally contribute preferences that are shown in Vicinae Preferences > Extensions when selecting the command. You can use preferences for configuration values and passwords or personal access tokens. Commands automatically \"inherit\" extension preferences and can also override entries with the same `name`.").optional(), "arguments": zod_1.z.any().describe("An optional array of arguments that are requested from user when the command is called").optional(), "disabledByDefault": zod_1.z.boolean().describe("Defaults to `false`").optional() }).catchall(zod_1.z.any())).min(1).max(100).describe("List of all commands vended by this extensions. An extension must contain at least one command."), "tools": zod_1.z.array(zod_1.z.object({ "icon": zod_1.z.string().regex(new RegExp("^[^\\s]+(?:[ ]*[^\\s]+)*$")).describe("A 512x512 icon representing the tool. It will be displayed in various places across Vicinae. If a tool doesn't have an icon, it will 'inherit' the extension's icon. Please note that light and dark themes are supported; just append '@dark' or '@light' to the icons name and the correct icon will be picked at run-time. For example, write for this property 'icon.png' and have in the assets folder the 'icon@light.png' and 'icon@dark.png' assets.").optional(), "name": zod_1.z.string().regex(new RegExp("^[a-z0-9-][a-zA-Z0-9-_]*$")).min(2).max(64).describe("The name directly maps to the entry point file for the tool. So a tool named 'index' would map to 'src/tools/index.ts' (or any other supported TypeScript or JavaScript file extension such as .tsx, .js, .jsx)."), "title": zod_1.z.string().regex(new RegExp("^[^\\s]+(?: [^\\s]+)*$")).min(2).max(255).describe("The tool title will be displayed in the Store, Preferences, and any other places the tool might be referenced in the Vicinae UI."), "keywords": zod_1.z.any().optional(), "description": zod_1.z.string().regex(new RegExp("^[^\\s]+(\\s+[^\\s]+)*$")).min(12).max(2048).describe("It helps users (and other actors like AI) understand what the tool does. It will be displayed in the Store and in Preferences."), "functionalities": zod_1.z.array(zod_1.z.enum(["AI attachment provider", "AI tool"])).describe("Limits the tool to the specified functionalities. If not specified, the tool can be used in any context (if it matches the requirements for each of them).").optional(), "preferences": zod_1.z.any().describe("Tools can optionally contribute preferences that are shown in Vicinae Preferences > Extensions when selecting the AI Extension item. You can use preferences for configuration values and passwords or personal access tokens. Tools automatically \"inherit\" extension preferences and can also override entries with the same `name`.").optional() }).catchall(zod_1.z.any())).min(0).max(100).describe("List of all tools that the AI can use to interact with this extension.").optional(), "ai": zod_1.z.object({ "instructions": zod_1.z.string().describe("Additional system instructions added when the tools are used in AI").optional(), "evals": zod_1.z.array(zod_1.z.object({ "input": zod_1.z.string().describe("The prompt to evaluate"), "usedAsExample": zod_1.z.boolean().describe("Whether the eval can be used as an example in Vicinae (default `true`)").optional() })).describe("List of tests to evaluate the reliability of the tools when used in AI").optional() }).describe("Additional information related to the AI capabilities of the extension").optional(), "keywords": zod_1.z.any().optional(), "description": zod_1.z.string().regex(new RegExp("^[^\\s]+(\\s+[^\\s]+)*$")).min(16).max(2048).describe("It helps users understand what the extension does. It will be displayed in the Store and in Preferences."), "preferences": zod_1.z.any().describe("Extensions can contribute preferences that are shown in Vicinae Preferences > Extensions. You can use preferences for configuration values and passwords or personal access tokens.").optional(), "categories": zod_1.z.array(zod_1.z.string()).optional(), "contributors": zod_1.z.array(zod_1.z.string().regex(new RegExp("^[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*$")).min(2).max(75)).min(0).describe("Users who have meaningfully contributed to the extension's commands.").optional(), "pastContributors": zod_1.z.array(zod_1.z.string().regex(new RegExp("^[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*$")).min(2).max(75)).min(0).describe("Users who have meaningfully contributed to the extension's commands but do not maintain it anymore.").optional(), "dependencies": zod_1.z.object({ "@raycast/api": zod_1.z.string().describe("The Vicinae API version used by this extension.").optional() }).describe("Source dependencies following the npm package.json dependency format."), "external": zod_1.z.array(zod_1.z.string()).describe("An Array of package or file names that should be excluded from the build. The package will not be bundled, but the import is preserved and will be evaluated at runtime.").optional() });

package/dist/utils/logger.d.ts

@@ -0,0 +1,13 @@
+export declare class Logger {
+    prefixes: {
+        error: string;
+        event: string;
+        info: string;
+        ready: string;
+    };
+    logError(message: string): void;
+    logEvent(message: string): void;
+    logInfo(message: string): void;
+    logReady(message: string): void;
+    logTimestamp(s: string): void;
+}

package/dist/utils/logger.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+class Logger {
+    prefixes = {
+        error: `${chalk_1.default.red("error")}${chalk_1.default.reset()}`,
+        event: `${chalk_1.default.magenta("event")}${chalk_1.default.reset()}`,
+        info: `${chalk_1.default.blue("info")}${chalk_1.default.reset()}`,
+        ready: `${chalk_1.default.green("ready")}${chalk_1.default.reset()}`,
+    };
+    logError(message) {
+        console.log(`${this.prefixes.error.padEnd(15)} - ${message}`);
+    }
+    logEvent(message) {
+        console.log(`${this.prefixes.event.padEnd(15)} - ${message}`);
+    }
+    logInfo(message) {
+        console.log(`${this.prefixes.info.padEnd(15)} - ${message}`);
+    }
+    logReady(message) {
+        console.log(`${this.prefixes.ready.padEnd(15)} - ${message}`);
+    }
+    logTimestamp(s) {
+        const ts = new Date().toJSON();
+        const lines = s.split("\n");
+        for (let i = 0; i !== lines.length; ++i) {
+            const line = lines[i];
+            if (i === lines.length - 1 && line.length === 0)
+                continue;
+            console.log(`${chalk_1.default.gray(ts.padEnd(20))}${chalk_1.default.reset()} - ${line}`);
+        }
+    }
+}
+exports.Logger = Logger;

package/dist/utils/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const dataDir: () => string;
+export declare const extensionDataDir: () => string;

package/dist/utils/utils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extensionDataDir = exports.dataDir = void 0;
+const path_1 = require("path");
+const os_1 = require("os");
+const platformDataDir = () => {
+    const platform = process.platform;
+    if (platform === "linux")
+        return process.env.XDG_DATA_HOME || (0, path_1.join)((0, os_1.homedir)(), ".local", "share");
+    if (platform === "darwin")
+        return (0, path_1.join)((0, os_1.homedir)(), "Library", "Application Support");
+    if (platform === "win32")
+        return process.env.APPDATA || (0, path_1.join)((0, os_1.homedir)(), "AppData", "Roaming");
+    return (0, path_1.join)((0, os_1.homedir)(), ".data");
+};
+const dataDir = () => (0, path_1.join)(platformDataDir(), "vicinae");
+exports.dataDir = dataDir;
+const extensionDataDir = () => (0, path_1.join)((0, exports.dataDir)(), "extensions");
+exports.extensionDataDir = extensionDataDir;

package/dist/utils/vicinae.d.ts

@@ -0,0 +1,12 @@
+export type VicinaeClientOptions = {
+    binaryPath: string;
+};
+export declare class VicinaeClient {
+    private readonly options;
+    constructor(options?: VicinaeClientOptions);
+    ping(): Error | null;
+    refreshDevSession(extensionId: string): Error | null;
+    startDevSession(extensionId: string): Error | null;
+    stopDevSession(extensionId: string): Error | null;
+    private invoke;
+}

package/dist/utils/vicinae.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VicinaeClient = void 0;
+const node_child_process_1 = require("node:child_process");
+class VicinaeClient {
+    options;
+    constructor(options = { binaryPath: "vicinae" }) {
+        this.options = options;
+    }
+    ping() {
+        return this.invoke("/ping");
+    }
+    refreshDevSession(extensionId) {
+        return this.invoke(`/api/extensions/develop/refresh?id=${extensionId}`);
+    }
+    startDevSession(extensionId) {
+        return this.invoke(`/api/extensions/develop/start?id=${extensionId}`);
+    }
+    stopDevSession(extensionId) {
+        return this.invoke(`/api/extensions/develop/stop?id=${extensionId}`);
+    }
+    invoke(endpoint) {
+        if (endpoint.startsWith("/")) {
+            endpoint = endpoint.slice(1);
+        }
+        const url = `vicinae://${endpoint}`;
+        const result = (0, node_child_process_1.spawnSync)(this.options.binaryPath, [url]);
+        if (result.error)
+            return result.error;
+        return result.status === 0 ? null : new Error(result.stderr.toString());
+    }
+}
+exports.VicinaeClient = VicinaeClient;

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@vicinae/api",
+  "version": "0.3.0",
+  "description": "TypeScript SDK to build Vicinae extensions",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc --outDir dist",
+    "pack": "npm run build && npm pack"
+  },
+  "bin": {
+    "vici": "./bin/run.js"
+  },
+  "files": [
+    "dist",
+    "types"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "types": [
+    "./dist/index.d.ts"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/index.js",
+  "dependencies": {
+    "@jgoz/esbuild-plugin-typecheck": "^4.0.3",
+    "@types/node": "^22.10.1",
+    "chokidar": "^4.0.3",
+    "esbuild": "^0.25.2",
+    "ts-proto": "^2.7.5",
+    "@types/react": "^18.1.0",
+    "react": "^18.1.0",
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5",
+    "chalk": "^5.6.0",
+    "zod": "^4.0.17"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "chai": "^4",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6",
+    "eslint-config-prettier": "^10",
+    "mocha": "^10",
+    "oclif": "^4",
+    "shx": "^0.3.3",
+    "ts-node": "^10",
+    "typescript": "^5"
+  },
+  "oclif": {
+    "bin": "vici",
+    "dirname": "vici",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "repository": "vicinaehq/vici"
+}