@choochmeque/tauri-apple-extensions 0.1.1 → 0.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Choochmeque
+Copyright (c) 2025 Vladimir Pankratov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,66 +1,99 @@
 # tauri-apple-extensions
 
 [![npm](https://img.shields.io/npm/v/@choochmeque/tauri-apple-extensions.svg)](https://www.npmjs.com/package/@choochmeque/tauri-apple-extensions)
+[![codecov](https://codecov.io/gh/Choochmeque/tauri-apple-extensions/branch/main/graph/badge.svg)](https://codecov.io/gh/Choochmeque/tauri-apple-extensions)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
-Add iOS extensions to Tauri apps with a single command.
+Add iOS and macOS extensions to Tauri apps with a single command.
 
 ## Features
 
 - Automatic Xcode project configuration via XcodeGen
-- Plugin-based template system
+- Built-in skeleton templates with TODO markers
+- Plugin-based template system for custom implementations
+- Supports both iOS and macOS platforms
 - Idempotent - safe to re-run
-- Share Extension support (more extension types coming soon)
 
 ## Prerequisites
 
 - [XcodeGen](https://github.com/yonaskolb/XcodeGen) installed (`brew install xcodegen`)
-- Tauri iOS project initialized (`tauri ios init`)
+- Tauri iOS project initialized (`tauri ios init`) for iOS extensions
+- For macOS extensions: Tauri macOS Xcode project via [@choochmeque/tauri-macos-xcode](https://github.com/Choochmeque/tauri-macos-xcode)
 
 ## Installation
 
 ```bash
+# npm
 npm install -D @choochmeque/tauri-apple-extensions
-```
 
-## Usage
+# pnpm
+pnpm add -D @choochmeque/tauri-apple-extensions
+
+# yarn
+yarn add -D @choochmeque/tauri-apple-extensions
 
-### With a plugin (recommended)
+# bun
+bun add -D @choochmeque/tauri-apple-extensions
+```
 
-If you're using a Tauri plugin that provides iOS extension templates:
+## Usage
 
 ```bash
-npx @choochmeque/tauri-apple-extensions add share --plugin @choochmeque/tauri-plugin-sharekit-api
+# Add iOS Share Extension
+npx @choochmeque/tauri-apple-extensions ios add share
+
+# Add macOS Share Extension
+npx @choochmeque/tauri-apple-extensions macos add share
 ```
 
-### With custom templates
+This creates a Share Extension with a minimal skeleton template. Open the generated Swift file and implement your logic where you see `// TODO:` comments.
+
+### Options
 
 ```bash
-npx @choochmeque/tauri-apple-extensions add share --templates ./path/to/templates
+# Use templates from a plugin (plugin must include tauri-apple-extension config)
+npx @choochmeque/tauri-apple-extensions ios add share --plugin <plugin-name>
+
+# Use custom templates directory
+npx @choochmeque/tauri-apple-extensions ios add share --templates ./path/to/templates
 ```
 
+> **Note:** When using `--plugin`, the plugin's `package.json` must contain a `tauri-apple-extension` config. See [For Plugin Developers](#for-plugin-developers) below.
+
 ## Supported Extensions
 
-| Type | Status | Description |
-|------|--------|-------------|
-| `share` | Available | Share Extension for receiving shared content |
+| Type | Description |
+|------|-------------|
+| `share` | Share Extension for receiving shared content |
+
+## Post-Setup Steps
+
+After running the tool:
+
+1. Open the Xcode project:
+   - iOS: `src-tauri/gen/apple/*.xcodeproj`
+   - macOS: `src-tauri/gen/apple-macos/*.xcodeproj`
+2. Select your Apple Developer Team for both targets
+3. Enable **App Groups** capability for both targets
+4. Configure App Groups in [Apple Developer Portal](https://developer.apple.com/account/resources/identifiers/list/applicationGroup)
 
 ## For Plugin Developers
 
-To make your plugin compatible with this tool, add the following to your `package.json`:
+To make your plugin compatible, add to your `package.json`:
 
 ```json
 {
   "tauri-apple-extension": {
     "type": "share",
-    "templates": "./ios/templates"
+    "templates": {
+      "ios": "./templates/ios",
+      "macos": "./templates/macos"
+    }
   }
 }
 ```
 
-Your templates directory should contain:
-- Swift source files with `{{VARIABLE}}` placeholders
-- `Info.plist` for the extension
+Plugins can support one or both platforms. If a user runs the command for a platform your plugin doesn't support, they'll receive a clear error message.
 
 ### Template Variables
 
@@ -72,19 +105,10 @@ Your templates directory should contain:
 | `{{BUNDLE_IDENTIFIER}}` | Extension bundle identifier |
 | `{{PRODUCT_NAME}}` | App product name |
 
-## Post-Setup Steps
-
-After running the tool:
-
-1. Open the Xcode project (`src-tauri/gen/apple/*.xcodeproj`)
-2. Select your Apple Developer Team for both targets
-3. Enable required capabilities (e.g., App Groups) for both targets
-4. Configure the capability in Apple Developer Portal
-
 ## Contributing
 
-PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
+PRs welcome! Please open an issue first to discuss what you would like to change.
 
 ## License
 
-MIT
+[MIT](LICENSE)

package/dist/cli.js

@@ -44,17 +44,22 @@ function findTauriConfig(projectRoot) {
     }
     throw new Error("Could not find tauri.conf.json");
 }
-function findAppleProjectDir(projectRoot) {
+function findAppleProjectDir(projectRoot, platform) {
+    // iOS uses 'apple', macOS uses 'apple-macos'
+    const dirName = platform === "ios" ? "apple" : "apple-macos";
+    const initHint = platform === "ios"
+        ? "Run 'tauri ios init' first."
+        : "Set up macOS Xcode project using @choochmeque/tauri-macos-xcode first.";
     const paths = [
-        path.join(projectRoot, "src-tauri", "gen", "apple"),
-        path.join(projectRoot, "gen", "apple"),
+        path.join(projectRoot, "src-tauri", "gen", dirName),
+        path.join(projectRoot, "gen", dirName),
     ];
     for (const p of paths) {
         if (fs.existsSync(p)) {
             return p;
         }
     }
-    throw new Error("Could not find iOS project directory. Run 'tauri ios init' first.");
+    throw new Error(`Could not find ${platform} project directory. ${initHint}`);
 }
 function getAppInfo(tauriConfig, projectYml) {
     const parsed = parseYamlSimple(projectYml);
@@ -118,6 +123,25 @@ function addExtensionTarget(projectYml, targetConfig) {
     }
     return modified;
 }
+function addUrlSchemeToTarget(projectYml, targetName, urlScheme, bundleIdentifier) {
+    let modified = projectYml;
+    // Check if URL scheme already exists
+    if (modified.includes(`CFBundleURLSchemes`) && modified.includes(urlScheme)) {
+        return modified;
+    }
+    // Find the target's info section and add URL scheme
+    const targetRegex = new RegExp(`(${targetName}:[\\s\\S]*?info:[\\s\\S]*?properties:)([\\s\\S]*?)(\\n    \\w|\\n  \\w|$)`, "m");
+    const match = modified.match(targetRegex);
+    if (match) {
+        const urlSchemeYaml = `
+        CFBundleURLTypes:
+          - CFBundleURLName: ${bundleIdentifier}
+            CFBundleURLSchemes:
+              - ${urlScheme}`;
+        modified = modified.replace(targetRegex, `$1$2${urlSchemeYaml}$3`);
+    }
+    return modified;
+}
 function addDependencyToTarget(projectYml, mainTargetName, dependencyConfig) {
     let modified = projectYml;
     // Remove existing dependency if it exists
@@ -138,43 +162,31 @@ function addDependencyToTarget(projectYml, mainTargetName, dependencyConfig) {
     return modified;
 }
 
-function updateMainAppEntitlements(appleDir, appInfo) {
-    const targetName = `${appInfo.productName}_iOS`;
-    const entitlementsPath = path.join(appleDir, targetName, `${targetName}.entitlements`);
-    const appGroupId = `group.${appInfo.identifier}`;
-    let entitlements;
-    if (fs.existsSync(entitlementsPath)) {
-        entitlements = fs.readFileSync(entitlementsPath, "utf8");
-    }
-    else {
-        entitlements = `<?xml version="1.0" encoding="UTF-8"?>
+const EMPTY_ENTITLEMENTS = `<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
 </dict>
 </plist>`;
-    }
+function addAppGroupToEntitlements(entitlements, appGroupId) {
     // Check if app groups already configured
     if (entitlements.includes("com.apple.security.application-groups")) {
         if (!entitlements.includes(appGroupId)) {
             // Add our group to existing array
-            entitlements = entitlements.replace(/(<key>com\.apple\.security\.application-groups<\/key>\s*<array>)/, `$1\n        <string>${appGroupId}</string>`);
+            return entitlements.replace(/(<key>com\.apple\.security\.application-groups<\/key>\s*<array>)/, `$1\n        <string>${appGroupId}</string>`);
         }
+        return entitlements;
     }
-    else {
-        // Add app groups entitlement
-        entitlements = entitlements.replace(/<dict>\s*<\/dict>/, `<dict>
+    // Add app groups entitlement
+    return entitlements.replace(/<dict>\s*<\/dict>/, `<dict>
     <key>com.apple.security.application-groups</key>
     <array>
         <string>${appGroupId}</string>
     </array>
 </dict>`);
-    }
-    fs.writeFileSync(entitlementsPath, entitlements);
-    console.log(`Updated main app entitlements: ${entitlementsPath}`);
 }
-function createExtensionEntitlements(extensionDir, appGroupId) {
-    const entitlements = `<?xml version="1.0" encoding="UTF-8"?>
+function createEntitlementsContent(appGroupId) {
+    return `<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
@@ -184,44 +196,28 @@ function createExtensionEntitlements(extensionDir, appGroupId) {
     </array>
 </dict>
 </plist>`;
-    const entitlementsPath = path.join(extensionDir, `${path.basename(extensionDir)}.entitlements`);
-    fs.writeFileSync(entitlementsPath, entitlements);
-    return entitlementsPath;
 }
-
-function addUrlSchemeToInfoPlist(appleDir, appInfo) {
-    const targetName = `${appInfo.productName}_iOS`;
-    const infoPlistPath = path.join(appleDir, targetName, "Info.plist");
-    const urlScheme = appInfo.productName.toLowerCase().replace(/[^a-z0-9]/g, "");
-    if (!fs.existsSync(infoPlistPath)) {
-        console.log(`Info.plist not found at ${infoPlistPath}, skipping URL scheme setup`);
-        return;
+function updateMainAppEntitlements(appleDir, appInfo, platform) {
+    const platformSuffix = platform === "ios" ? "iOS" : "macOS";
+    const targetName = `${appInfo.productName}_${platformSuffix}`;
+    const entitlementsPath = path.join(appleDir, targetName, `${targetName}.entitlements`);
+    const appGroupId = `group.${appInfo.identifier}`;
+    let entitlements;
+    if (fs.existsSync(entitlementsPath)) {
+        entitlements = fs.readFileSync(entitlementsPath, "utf8");
     }
-    let infoPlist = fs.readFileSync(infoPlistPath, "utf8");
-    // Check if URL schemes already configured
-    if (infoPlist.includes("CFBundleURLSchemes")) {
-        if (!infoPlist.includes(urlScheme)) {
-            console.log(`URL scheme may need manual configuration. Add '${urlScheme}' to CFBundleURLSchemes.`);
-        }
-        return;
+    else {
+        entitlements = EMPTY_ENTITLEMENTS;
     }
-    // Add URL scheme - need to insert before closing </dict></plist>
-    const urlSchemeEntry = `    <key>CFBundleURLTypes</key>
-    <array>
-        <dict>
-            <key>CFBundleURLSchemes</key>
-            <array>
-                <string>${urlScheme}</string>
-            </array>
-            <key>CFBundleURLName</key>
-            <string>${appInfo.identifier}</string>
-        </dict>
-    </array>
-`;
-    // Insert before the last </dict>
-    infoPlist = infoPlist.replace(/(\s*)<\/dict>\s*<\/plist>/, `\n${urlSchemeEntry}$1</dict>\n</plist>`);
-    fs.writeFileSync(infoPlistPath, infoPlist);
-    console.log(`Added URL scheme '${urlScheme}' to Info.plist`);
+    entitlements = addAppGroupToEntitlements(entitlements, appGroupId);
+    fs.writeFileSync(entitlementsPath, entitlements);
+    console.log(`Updated main app entitlements: ${entitlementsPath}`);
+}
+function createExtensionEntitlements(extensionDir, appGroupId) {
+    const entitlements = createEntitlementsContent(appGroupId);
+    const entitlementsPath = path.join(extensionDir, `${path.basename(extensionDir)}.entitlements`);
+    fs.writeFileSync(entitlementsPath, entitlements);
+    return entitlementsPath;
 }
 
 function runXcodeGen(appleDir) {
@@ -269,7 +265,7 @@ const shareExtension = {
     extensionName(appInfo) {
         return `${appInfo.productName}-ShareExtension`;
     },
-    createFiles(appleDir, appInfo, templatesDir) {
+    createFiles(appleDir, appInfo, templatesDir, _platform) {
         const extensionDir = path.join(appleDir, "ShareExtension");
         const appGroupId = `group.${appInfo.identifier}`;
         const urlScheme = appInfo.productName
@@ -362,16 +358,19 @@ const shareExtension = {
         createExtensionEntitlements(extensionDir, appGroupId);
         console.log(`Created ShareExtension files in ${extensionDir}`);
     },
-    updateProjectYml(projectYml, appInfo) {
+    updateProjectYml(projectYml, appInfo, platform) {
         const extensionName = this.extensionName(appInfo);
         const extensionBundleId = `${appInfo.identifier}.ShareExtension`;
-        const targetName = `${appInfo.productName}_iOS`;
+        const platformSuffix = platform === "ios" ? "iOS" : "macOS";
+        const platformValue = platform === "ios" ? "iOS" : "macOS";
+        const deploymentTarget = platform === "ios" ? "14.0" : "11.0";
+        const targetName = `${appInfo.productName}_${platformSuffix}`;
         // Create the extension target YAML
         const extensionTarget = `
   ${extensionName}:
     type: app-extension
-    platform: iOS
-    deploymentTarget: "14.0"
+    platform: ${platformValue}
+    deploymentTarget: "${deploymentTarget}"
     sources:
       - path: ShareExtension
     info:
@@ -405,6 +404,11 @@ const shareExtension = {
         modified = addDependencyToTarget(modified, targetName, {
             target: extensionName,
         });
+        // Add URL scheme to main app for deep linking from extension
+        const urlScheme = appInfo.productName
+            .toLowerCase()
+            .replace(/[^a-z0-9]/g, "");
+        modified = addUrlSchemeToTarget(modified, targetName, urlScheme, appInfo.identifier);
         return modified;
     },
 };
@@ -415,6 +419,7 @@ const EXTENSIONS = {
     share: shareExtension,
 };
 function resolveTemplatesDir(options, extensionType) {
+    const { platform } = options;
     // Option 1: Explicit templates path
     if (options.templates) {
         const templatesPath = path.resolve(process.cwd(), options.templates);
@@ -434,16 +439,20 @@ function resolveTemplatesDir(options, extensionType) {
         if (extensionConfig.type !== extensionType) {
             throw new Error(`Plugin ${options.plugin} is for '${extensionConfig.type}' extension, not '${extensionType}'`);
         }
-        const templatesPath = path.join(pluginPath, extensionConfig.templates);
+        const platformTemplates = extensionConfig.templates[platform];
+        if (!platformTemplates) {
+            throw new Error(`Plugin ${options.plugin} does not support ${platform} platform`);
+        }
+        const templatesPath = path.join(pluginPath, platformTemplates);
         if (!fs.existsSync(templatesPath)) {
             throw new Error(`Plugin templates directory not found: ${templatesPath}`);
         }
         return templatesPath;
     }
-    // Option 3: Default templates (from bundled dist/cli.js -> ../templates)
-    const defaultTemplates = path.join(__dirname$1, "../templates", extensionType);
+    // Option 3: Default templates (from bundled dist/cli.js -> ../templates/{platform}/{type})
+    const defaultTemplates = path.join(__dirname$1, "../templates", platform, extensionType);
     if (!fs.existsSync(defaultTemplates)) {
-        throw new Error(`No templates found. Use --plugin or --templates to specify templates.`);
+        throw new Error(`No templates found for ${platform}/${extensionType}. Use --plugin or --templates to specify templates.`);
     }
     return defaultTemplates;
 }
@@ -461,7 +470,9 @@ function resolvePluginPath(pluginName) {
     throw new Error(`Plugin ${pluginName} not found in node_modules. Make sure it's installed.`);
 }
 async function addExtension(type, options) {
-    console.log(`\nTauri Apple Extensions - Add ${type}\n`);
+    const { platform } = options;
+    const platformDisplay = platform === "ios" ? "iOS" : "macOS";
+    console.log(`\nTauri Apple Extensions - Add ${type} (${platformDisplay})\n`);
     try {
         // Validate extension type
         const extension = EXTENSIONS[type];
@@ -473,7 +484,7 @@ async function addExtension(type, options) {
         const projectRoot = findProjectRoot();
         console.log(`Project root: ${projectRoot}`);
         const tauriConfig = findTauriConfig(projectRoot);
-        const appleDir = findAppleProjectDir(projectRoot);
+        const appleDir = findAppleProjectDir(projectRoot, platform);
         console.log(`Apple project dir: ${appleDir}`);
         // Get app info
         let projectYml = readProjectYml(appleDir);
@@ -493,16 +504,14 @@ async function addExtension(type, options) {
         console.log(`\nUsing templates from: ${templatesDir}`);
         // Run extension setup
         console.log(`\n1. Creating ${extension.displayName} files...`);
-        extension.createFiles(appleDir, appInfo, templatesDir);
+        extension.createFiles(appleDir, appInfo, templatesDir, platform);
         console.log(`\n2. Updating main app entitlements...`);
-        updateMainAppEntitlements(appleDir, appInfo);
-        console.log(`\n3. Adding URL scheme to Info.plist...`);
-        addUrlSchemeToInfoPlist(appleDir, appInfo);
-        console.log(`\n4. Updating project.yml...`);
+        updateMainAppEntitlements(appleDir, appInfo, platform);
+        console.log(`\n3. Updating project.yml (extension target + URL scheme)...`);
         projectYml = readProjectYml(appleDir);
-        projectYml = extension.updateProjectYml(projectYml, appInfo);
+        projectYml = extension.updateProjectYml(projectYml, appInfo, platform);
         writeProjectYml(appleDir, projectYml);
-        console.log(`\n5. Regenerating Xcode project...`);
+        console.log(`\n4. Regenerating Xcode project...`);
         runXcodeGen(appleDir);
         console.log(`\n========================================`);
         console.log(`${extension.displayName} setup complete!`);
@@ -525,12 +534,21 @@ async function addExtension(type, options) {
 const program = new Command();
 program
     .name("tauri-apple-extensions")
-    .description("Add iOS extensions to Tauri apps")
-    .version("0.1.1");
-program
-    .command("add <type>")
-    .description("Add an extension (e.g., share)")
-    .option("-p, --plugin <name>", "Plugin to use for templates")
-    .option("-t, --templates <path>", "Custom templates directory")
-    .action(addExtension);
+    .description("Add Apple extensions to Tauri apps")
+    .version("0.2.0");
+function createPlatformCommand(platform) {
+    const cmd = new Command(platform);
+    cmd.description(`Manage ${platform === "ios" ? "iOS" : "macOS"} extensions`);
+    cmd
+        .command("add <type>")
+        .description("Add an extension (e.g., share)")
+        .option("-p, --plugin <name>", "Plugin to use for templates")
+        .option("-t, --templates <path>", "Custom templates directory")
+        .action((type, options) => {
+        addExtension(type, { ...options, platform });
+    });
+    return cmd;
+}
+program.addCommand(createPlatformCommand("ios"));
+program.addCommand(createPlatformCommand("macos"));
 program.parse();

package/dist/core/entitlements.d.ts

@@ -1,3 +1,6 @@
-import type { AppInfo } from "../types.js";
-export declare function updateMainAppEntitlements(appleDir: string, appInfo: AppInfo): void;
+import type { AppInfo, Platform } from "../types.js";
+export declare const EMPTY_ENTITLEMENTS = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n</dict>\n</plist>";
+export declare function addAppGroupToEntitlements(entitlements: string, appGroupId: string): string;
+export declare function createEntitlementsContent(appGroupId: string): string;
+export declare function updateMainAppEntitlements(appleDir: string, appInfo: AppInfo, platform: Platform): void;
 export declare function createExtensionEntitlements(extensionDir: string, appGroupId: string): string;

package/dist/core/project-discovery.d.ts

@@ -1,5 +1,5 @@
-import type { AppInfo, TauriConfig } from "../types.js";
+import type { AppInfo, TauriConfig, Platform } from "../types.js";
 export declare function findProjectRoot(): string;
 export declare function findTauriConfig(projectRoot: string): TauriConfig;
-export declare function findAppleProjectDir(projectRoot: string): string;
+export declare function findAppleProjectDir(projectRoot: string, platform: Platform): string;
 export declare function getAppInfo(tauriConfig: TauriConfig, projectYml: string): AppInfo;

package/dist/core/project-yml.d.ts

@@ -2,4 +2,5 @@ import type { TargetConfig, DependencyConfig } from "../types.js";
 export declare function readProjectYml(appleDir: string): string;
 export declare function writeProjectYml(appleDir: string, content: string): void;
 export declare function addExtensionTarget(projectYml: string, targetConfig: TargetConfig): string;
+export declare function addUrlSchemeToTarget(projectYml: string, targetName: string, urlScheme: string, bundleIdentifier: string): string;
 export declare function addDependencyToTarget(projectYml: string, mainTargetName: string, dependencyConfig: DependencyConfig): string;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { addExtension } from "./commands/add.js";
 export { findProjectRoot, findTauriConfig, findAppleProjectDir, getAppInfo, } from "./core/project-discovery.js";
-export { readProjectYml, writeProjectYml } from "./core/project-yml.js";
+export { readProjectYml, writeProjectYml, addUrlSchemeToTarget, } from "./core/project-yml.js";
 export { updateMainAppEntitlements, createExtensionEntitlements, } from "./core/entitlements.js";
 export { addUrlSchemeToInfoPlist } from "./core/info-plist.js";
 export { runXcodeGen } from "./core/xcodegen.js";