@vicinae/api 0.16.1 → 0.16.3

package/dist/utils/extension-types.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateExtensionTypes = updateExtensionTypes;
+exports.createExtensionTypes = createExtensionTypes;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+/**
+ * Generates and updates the extension types file in the specified directory
+ */
+function updateExtensionTypes(manifest, outDir) {
+    const content = createExtensionTypes(manifest);
+    const envPath = (0, node_path_1.join)(outDir, "vicinae-env.d.ts");
+    (0, node_fs_1.writeFileSync)(envPath, content);
+    return { envPath };
+}
+/**
+ * Generates TypeScript type definitions from a manifest (package.json)
+ */
+function createExtensionTypes(manifest) {
+    const extPrefs = generateExtensionPreferences(manifest);
+    const cmdPrefs = generateCommandPreferences(manifest);
+    const argTypes = generateCommandArguments(manifest);
+    return `
+/// <reference types="@vicinae/api">
+
+/*
+ * This file is auto-generated from the extension's manifest.
+ * Do not modify manually. Instead, update the \`package.json\` file.
+ */
+
+type ExtensionPreferences = {
+  ${extPrefs}
+}
+
+declare type Preferences = ExtensionPreferences
+
+declare namespace Preferences {
+  ${cmdPrefs}
+}
+
+declare namespace Arguments {
+  ${argTypes}
+}
+	`.trim();
+}
+/**
+ * Generates TypeScript type definitions for extension preferences
+ */
+function generateExtensionPreferences(manifest) {
+    if (!manifest.preferences) {
+        return "";
+    }
+    const extPrefs = [];
+    for (const pref of manifest.preferences) {
+        let prefText = generateDocComment(pref.title, pref.description);
+        if (prefText) {
+            prefText += "\n\t";
+        }
+        prefText += `"${pref.name}"${pref.required ? "?" : ""}: ${getPreferenceType(pref)};`;
+        extPrefs.push(prefText);
+    }
+    return extPrefs.join("\n").trim();
+}
+/**
+ * Generates a JSDoc comment string for a preference or argument
+ */
+function generateDocComment(title, description) {
+    if (!title && !description) {
+        return "";
+    }
+    const content = [title, description].filter(Boolean).join(" - ");
+    return `\n\t/** ${content.trim()} */`;
+}
+/**
+ * Generates a TypeScript type string for a preference value
+ */
+function getPreferenceType(pref) {
+    if (pref.type === "checkbox") {
+        return "boolean";
+    }
+    if (pref.type === "dropdown" &&
+        Array.isArray(pref.data) &&
+        pref.data.length > 0) {
+        // Build a union type from the 'value' fields for dropdowns
+        const unionValues = pref.data
+            .map((option) => typeof option.value === "string" ? `"${option.value}"` : undefined)
+            .filter((v) => !!v)
+            .join(" | ");
+        return unionValues || "string";
+    }
+    return "string";
+}
+/**
+ * Generates TypeScript type definitions for command preferences
+ */
+function generateCommandPreferences(manifest) {
+    const cmdPrefs = [];
+    for (const cmd of manifest.commands) {
+        const prefix = generateDocComment(`Command: ${cmd.title}`) +
+            `\n\texport type ${toPascalCase(cmd.name)} = ExtensionPreferences & {`;
+        const prefs = [];
+        for (const pref of cmd.preferences ?? []) {
+            let prefText = "";
+            const docComment = generateDocComment(pref.title, pref.description);
+            if (docComment) {
+                prefText = `\n\t\t${docComment.trim()}\n\t\t`;
+            }
+            prefText += `"${pref.name}"${pref.required ? "?" : ""}: ${getPreferenceType(pref)};`;
+            prefs.push(prefText);
+        }
+        cmdPrefs.push(`${prefix}\n\t\t${prefs.join("\n").trim()}\n\t}`);
+    }
+    return cmdPrefs.join("\n").trim();
+}
+/**
+ * Generates TypeScript type definitions for command arguments
+ */
+function generateCommandArguments(manifest) {
+    const cmdArgs = [];
+    for (const cmd of manifest.commands) {
+        const prefix = generateDocComment(`Command: ${cmd.title}`) +
+            `\n\texport type ${toPascalCase(cmd.name)} = {`;
+        const args = [];
+        for (const arg of cmd.arguments ?? []) {
+            const docComment = generateDocComment(arg.placeholder);
+            let argText = `\n\t\t${docComment.trim()}\n\t\t`;
+            argText += `"${arg.name}"${arg.required ? "?" : ""}: ${getArgumentType(arg)}`;
+            args.push(argText);
+        }
+        cmdArgs.push(`${prefix}\n\t\t${args.join("\n").trim()}\n\t}`);
+    }
+    return cmdArgs.join("\n").trim();
+}
+/**
+ * Generates a TypeScript type string for an argument value
+ */
+function getArgumentType(arg) {
+    if (arg.type === "dropdown" &&
+        Array.isArray(arg.data) &&
+        arg.data.length > 0) {
+        // Build a union type from the 'value' fields
+        const unionValues = arg.data
+            .map((option) => typeof option.value === "string" ? `"${option.value}"` : undefined)
+            .filter((v) => !!v)
+            .join(" | ");
+        if (unionValues) {
+            return unionValues;
+        }
+    }
+    return "string";
+}
+/**
+ * Converts a string to PascalCase
+ */
+function toPascalCase(str) {
+    return str
+        .replace(/([a-z])([A-Z])/g, "$1 $2") // Splits camelCase words into separate words
+        .replace(/[-_]+|[^\p{L}\p{N}]/gu, " ") // Replaces dashes, underscores, and special characters with spaces
+        .toLowerCase() // Converts the entire string to lowercase
+        .replace(/(?:^|\s)(\p{L})/gu, (_, letter) => letter.toUpperCase()) // Capitalizes the first letter of each word
+        .replace(/\s+/g, ""); // Removes all spaces
+}

package/package.json

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

package/types/jsx.d.ts

@@ -1,13 +1,13 @@
-import * as React from "react";
-
-import type { ListItemDetailProps } from "../api/components/list";
-import { ImageLike } from "../api/image";
-import { SerializedColorLike } from "../api/color";
-import { Keyboard } from "../api/keyboard";
-import { Grid } from "../api/components/grid";
-
-import "react";
-import type { Application, Quicklink } from "../src";
+import type * as React from "react";
+import type {
+	DatePickerType,
+	Grid,
+	Keyboard,
+	List,
+	Quicklink,
+	SerializedColorLike,
+	SerializedImageLike,
+} from "../src";
 
 type BaseFormField = {
 	onBlur?: Function;
@@ -18,6 +18,9 @@ type BaseFormField = {
 declare module "react" {
 	namespace JSX {
 		interface IntrinsicElements {
+			view: {
+				children: React.ReactNode;
+			};
 			detail: {
 				navigationTitle?: string;
 				markdown: string;
@@ -41,18 +44,24 @@ declare module "react" {
 				title: string;
 				id?: string;
 				subtitle?: string;
-				icon?: ImageLike;
+				icon?:
+					| SerializedImageLike
+					| {
+							value?: SerializedImageLike | null;
+							tooltip: string;
+					  };
 				keywords?: string[];
-				children?: ReactNode;
+				accessories?: List.Item.SerializedAccessory[];
+				children?: React.ReactNode;
 			};
-			"list-item-detail": ListItemDetailProps;
+			"list-item-detail": List.Item.Detail.Props;
 			"list-item-detail-metadata": any;
 
 			grid: {
 				inset?: Grid.Inset;
 				columns?: number;
 				fit: Grid.Fit;
-				aspectRatio: Grid.AspectRatio;
+				aspectRatio: number;
 
 				children?: React.ReactNode;
 				filtering?: boolean;
@@ -67,7 +76,7 @@ declare module "react" {
 				inset?: Grid.Inset;
 				columns?: number;
 				fit?: Grid.Fit;
-				aspectRatio?: Grid.AspectRatio;
+				aspectRatio?: number;
 
 				title?: string;
 				subtitle?: string;
@@ -77,18 +86,21 @@ declare module "react" {
 				title?: string;
 				id?: string;
 				subtitle?: string;
-				content?:
-					| ImageLike
-					| { color: ColorLike }
-					| { value: ImageLike; tooltip?: string };
+				content?: SerializedImageLike | { color: SerializedColorLike };
+				tooltip?: string;
 				keywords?: string[];
-				children?: ReactNode;
+				accessory?: {
+					icon?: SerializedImageLike;
+					tooltip?: string | null;
+				};
+				children?: React.ReactNode;
 			};
 
 			"empty-view": {
 				description?: string;
 				title?: string;
-				icon?: ImageLike;
+				icon?: SerializedImageLike;
+				children?: React.ReactNode;
 			};
 			metadata: {
 				children?: React.ReactNode;
@@ -96,7 +108,7 @@ declare module "react" {
 			"metadata-label": {
 				title: string;
 				text: string;
-				icon?: ImageLike;
+				icon?: SerializedImageLike;
 			};
 			"metadata-separator": {};
 			"metadata-link": {
@@ -110,7 +122,7 @@ declare module "react" {
 			};
 			"action-panel-submenu": {
 				title: string;
-				icon?: ImageLike;
+				icon?: SerializedImageLike;
 				onOpen?: () => void;
 				onSearchTextChange?: (text: string) => void;
 				children?: React.ReactNode;
@@ -123,8 +135,8 @@ declare module "react" {
 				title: string;
 				onAction: () => void;
 				onSubmit?: Function;
-				shortcut?: Keyboard.Shortcut;
-				icon?: ImageLike;
+				shortcut?: Keyboard.Shortcut | Keyboard.Shortcut.Common;
+				icon?: SerializedImageLike;
 				autoFocus?: boolean;
 				type?: string;
 				quicklink?: Quicklink;
@@ -135,7 +147,7 @@ declare module "react" {
 			};
 			"tag-item": {
 				color?: SerializedColorLike;
-				icon?: ImageLike;
+				icon?: SerializedImageLike;
 				text?: string;
 				onAction?: () => void;
 			};
@@ -154,14 +166,23 @@ declare module "react" {
 			"tag-picker-item": {
 				title: string;
 				value: string;
-				icon?: ImageLike;
+				icon?: SerializedImageLike;
 			};
 			"text-area-field": BaseFormField & {};
-			"file-picker-field": BaseFormField & {};
+			"file-picker-field": BaseFormField & {
+				allowMultipleSelection?: boolean;
+				canChooseDirectories?: boolean;
+				canChooseFiles?: boolean;
+				showHiddenFiles?: boolean;
+			};
 			"dropdown-field": BaseFormField & {
-				children?: ReactNode;
+				children?: React.ReactNode;
+			};
+			"date-picker-field": BaseFormField & {
+				min?: Date;
+				max?: Date;
+				type?: DatePickerType;
 			};
-			"date-picker-field": {};
 			"checkbox-field": BaseFormField & {};
 			"password-field": {};
 			"textarea-field": {};
@@ -169,16 +190,16 @@ declare module "react" {
 			dropdown: {
 				onChange?: Function;
 				onSearchTextChange?: (text: string) => void;
-				children?: ReactNode;
+				children?: React.ReactNode;
 			};
 			"dropdown-section": {
 				title?: string;
-				children: ReactNode;
+				children: React.ReactNode;
 			};
 			"dropdown-item": {
 				title: string;
 				value: string;
-				icon?: ImageLike;
+				icon?: SerializedImageLike;
 				keywords?: string[];
 			};