project.yml

name: Yojam
options:
  bundleIdPrefix: com.yojam
  deploymentTarget:
    macOS: "14.0"
  xcodeVersion: "16.0"
  generateEmptyDirectories: false

settings:
  base:
    SWIFT_VERSION: "6.0"
    MACOSX_DEPLOYMENT_TARGET: "14.0"
    ENABLE_HARDENED_RUNTIME: YES
    SWIFT_STRICT_CONCURRENCY: complete
    MARKETING_VERSION: "1.3.1"
    CURRENT_PROJECT_VERSION: "16"

packages:
  Sparkle:
    url: https://github.com/sparkle-project/Sparkle
    exactVersion: "2.9.1"
  SwiftURL:
    url: https://github.com/karwa/swift-url
    exactVersion: "0.4.2"

targets:
  YojamCore:
    type: framework
    platform: macOS
    sources:
      - path: Sources/YojamCore
    dependencies:
      - package: SwiftURL
        product: WebURL
    settings:
      base:
        PRODUCT_BUNDLE_IDENTIFIER: com.yojam.core
        APPLICATION_EXTENSION_API_ONLY: YES
        PRODUCT_NAME: YojamCore
        SKIP_INSTALL: YES
        GENERATE_INFOPLIST_FILE: YES
        INFOPLIST_KEY_CFBundleDisplayName: YojamCore
        CURRENT_PROJECT_VERSION: "$(CURRENT_PROJECT_VERSION)"
        MARKETING_VERSION: "$(MARKETING_VERSION)"

  Yojam:
    type: application
    platform: macOS
    sources:
      - path: Sources/Yojam
        excludes:
          - Resources/Info.plist
          - Resources/Yojam.entitlements
          - Resources/menubar.svg
    dependencies:
      - target: YojamCore
        embed: true
      - target: YojamShareExtension
        embed: true
        codeSign: true
        copy:
          destination: plugins
      - target: YojamSafariExtension
        embed: true
        codeSign: true
        copy:
          destination: plugins
      - target: YojamNativeHost
        embed: true
        codeSign: true
        link: false
        copy:
          destination: wrapper
          subpath: Contents/Helpers
      - package: Sparkle
    info:
      path: Sources/Yojam/Resources/Info.plist
      properties:
        LSUIElement: true
        LSApplicationCategoryType: public.app-category.utilities
        CFBundleShortVersionString: "$(MARKETING_VERSION)"
        CFBundleVersion: "$(CURRENT_PROJECT_VERSION)"
        SUFeedURL: https://yoj.am/appcast.xml
        SUPublicEDKey: ewMIKU3we8bcoyPz/88uD1n1fpThNNnDJIfXk/eHLGA=
        SUEnableAutomaticChecks: true
        # Sparkle's floor is one hour. Yojam runs all day in the menu bar, so a
        # daily check plus a background-only alert let users fall two releases
        # behind without noticing (issue #38).
        SUScheduledCheckInterval: 3600
        CFBundleURLTypes:
          - CFBundleURLName: Web URL
            CFBundleURLSchemes:
              - http
              - https
          - CFBundleURLName: Mail URL
            CFBundleURLSchemes:
              - mailto
          - CFBundleURLName: Phone URL
            CFBundleURLSchemes:
              - tel
          - CFBundleURLName: Yojam Control
            CFBundleURLSchemes:
              - yojam
        NSAppleEventsUsageDescription: "Yojam needs to send Apple Events to open private browsing windows in Safari and Orion."
        NSUserActivityTypes:
          - NSUserActivityTypeBrowsingWeb
        ASWebAuthenticationSessionWebBrowserSupportCapabilities:
          IsSupported: true
        CFBundleDocumentTypes:
          - CFBundleTypeName: HTML Document
            CFBundleTypeRole: Viewer
            LSItemContentTypes:
              - public.html
            LSHandlerRank: Default
          - CFBundleTypeName: XHTML Document
            CFBundleTypeRole: Viewer
            LSItemContentTypes:
              - public.xhtml
            LSHandlerRank: Default
          - CFBundleTypeName: Web Internet Location
            CFBundleTypeRole: Viewer
            LSHandlerRank: Alternate
            LSItemContentTypes:
              - com.apple.web-internet-location
              - com.apple.internet-location
              - public.url
        NSServices:
          - NSMenuItem:
              default: Open in Yojam
            NSMessage: openURLViaService
            NSPortName: Yojam
            # An empty NSRequiredContext marks the service as contextual. Without
            # it macOS files the entry under legacy services, which are switched
            # off by default in Keyboard Shortcuts > Services, so "Open in Yojam"
            # never appeared unless the user ticked it by hand (issue #37).
            NSRequiredContext: {}
            NSSendTypes:
              - public.url
              - public.rtf
              - public.utf8-plain-text
              - NSStringPboardType
              - public.plain-text
    entitlements:
      path: Sources/Yojam/Resources/Yojam.entitlements
      properties:
        com.apple.developer.ubiquity-kvstore-identifier: "$(TeamIdentifierPrefix)$(CFBundleIdentifier)"
        com.apple.security.automation.apple-events: true
        com.apple.security.application-groups:
          - group.org.yojam.shared
    settings:
      base:
        INFOPLIST_FILE: Sources/Yojam/Resources/Info.plist
        CODE_SIGN_ENTITLEMENTS: Sources/Yojam/Resources/Yojam.entitlements
        CODE_SIGN_STYLE: Automatic
        REGISTER_APP_GROUPS: YES
        PRODUCT_BUNDLE_IDENTIFIER: com.yojam.app
        PRODUCT_NAME: Yojam
        GENERATE_INFOPLIST_FILE: NO
        COMBINE_HIDPI_IMAGES: YES
        LD_RUNPATH_SEARCH_PATHS:
          - "@executable_path/../Frameworks"

  YojamShareExtension:
    type: app-extension
    platform: macOS
    sources:
      - path: Sources/YojamShareExtension
        excludes:
          - Info.plist
          - YojamShareExtension.entitlements
    dependencies:
      - target: YojamCore
        embed: false
    info:
      path: Sources/YojamShareExtension/Info.plist
      properties:
        CFBundleShortVersionString: "$(MARKETING_VERSION)"
        CFBundleVersion: "$(CURRENT_PROJECT_VERSION)"
    entitlements:
      path: Sources/YojamShareExtension/YojamShareExtension.entitlements
      properties:
        com.apple.security.app-sandbox: true
        com.apple.security.application-groups:
          - group.org.yojam.shared
    settings:
      base:
        INFOPLIST_FILE: Sources/YojamShareExtension/Info.plist
        CODE_SIGN_ENTITLEMENTS: Sources/YojamShareExtension/YojamShareExtension.entitlements
        PRODUCT_BUNDLE_IDENTIFIER: com.yojam.app.ShareExtension
        PRODUCT_NAME: YojamShareExtension
        CODE_SIGN_STYLE: Automatic
        REGISTER_APP_GROUPS: YES
        APPLICATION_EXTENSION_API_ONLY: YES
        GENERATE_INFOPLIST_FILE: NO
        SKIP_INSTALL: YES
        LD_RUNPATH_SEARCH_PATHS:
          - "@executable_path/../Frameworks"
          - "@executable_path/../../../../Frameworks"

  YojamSafariExtension:
    type: app-extension
    platform: macOS
    sources:
      - path: Sources/YojamSafariExtension
        excludes:
          - Info.plist
          - YojamSafariExtension.entitlements
          - Resources
    dependencies:
      - target: YojamCore
        embed: false
    info:
      path: Sources/YojamSafariExtension/Info.plist
      properties:
        CFBundleShortVersionString: "$(MARKETING_VERSION)"
        CFBundleVersion: "$(CURRENT_PROJECT_VERSION)"
        NSExtension:
          NSExtensionPointIdentifier: com.apple.Safari.web-extension
          NSExtensionPrincipalClass: "$(PRODUCT_MODULE_NAME).SafariWebExtensionHandler"
    entitlements:
      path: Sources/YojamSafariExtension/YojamSafariExtension.entitlements
      properties:
        com.apple.security.app-sandbox: true
        com.apple.security.network.client: true
        com.apple.security.application-groups:
          - group.org.yojam.shared
    settings:
      base:
        INFOPLIST_FILE: Sources/YojamSafariExtension/Info.plist
        CODE_SIGN_ENTITLEMENTS: Sources/YojamSafariExtension/YojamSafariExtension.entitlements
        PRODUCT_BUNDLE_IDENTIFIER: com.yojam.app.SafariExtension
        PRODUCT_NAME: YojamSafariExtension
        CODE_SIGN_STYLE: Automatic
        REGISTER_APP_GROUPS: YES
        APPLICATION_EXTENSION_API_ONLY: YES
        GENERATE_INFOPLIST_FILE: NO
        SKIP_INSTALL: YES
        LD_RUNPATH_SEARCH_PATHS:
          - "@executable_path/../Frameworks"
          - "@executable_path/../../../../Frameworks"
    preBuildScripts:
      - name: Copy Safari Extension Resources
        basedOnDependencyAnalysis: false
        script: |
          RESOURCE_DIR="${TARGET_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}"
          mkdir -p "${RESOURCE_DIR}"
          rsync -av --delete "${SRCROOT}/Extensions/shared/" "${RESOURCE_DIR}/"
          cp "${SRCROOT}/Extensions/safari/manifest.json" "${RESOURCE_DIR}/manifest.json"

  YojamNativeHost:
    type: application
    platform: macOS
    sources:
      - path: Sources/YojamNativeHost
        excludes:
          - Info.plist
          - YojamNativeHost.entitlements
    dependencies:
      - target: YojamCore
        embed: false
    info:
      path: Sources/YojamNativeHost/Info.plist
      properties:
        CFBundleShortVersionString: "$(MARKETING_VERSION)"
        CFBundleVersion: "$(CURRENT_PROJECT_VERSION)"
        LSBackgroundOnly: true
    entitlements:
      path: Sources/YojamNativeHost/YojamNativeHost.entitlements
      properties:
        com.apple.security.application-groups:
          - group.org.yojam.shared
    settings:
      base:
        PRODUCT_BUNDLE_IDENTIFIER: com.yojam.app.NativeHost
        PRODUCT_NAME: YojamNativeHost
        # A wildcard Mac profile does not authorise the shared App Group.
        # Automatic Developer ID export derives the distribution profile from this App ID.
        CODE_SIGN_STYLE: Manual
        CODE_SIGN_IDENTITY: Apple Development
        PROVISIONING_PROFILE_SPECIFIER: Yojam Native Host Development
        CODE_SIGN_ENTITLEMENTS: Sources/YojamNativeHost/YojamNativeHost.entitlements
        GENERATE_INFOPLIST_FILE: NO
        SKIP_INSTALL: YES
        LD_RUNPATH_SEARCH_PATHS:
          - "@executable_path/../../../../Frameworks"

  YojamCLI:
    type: tool
    platform: macOS
    sources:
      - path: Sources/YojamCLI
        excludes:
          - YojamCLI.entitlements
    dependencies:
      - target: YojamCore
        embed: false
    entitlements:
      path: Sources/YojamCLI/YojamCLI.entitlements
    settings:
      base:
        PRODUCT_BUNDLE_IDENTIFIER: com.yojam.app.CLI
        PRODUCT_NAME: yojam-cli
        CODE_SIGN_STYLE: Automatic
        CODE_SIGN_ENTITLEMENTS: Sources/YojamCLI/YojamCLI.entitlements
        SKIP_INSTALL: YES
        LD_RUNPATH_SEARCH_PATHS:
          - "@executable_path/../Frameworks"

  YojamTests:
    type: bundle.unit-test
    platform: macOS
    sources:
      - path: Tests/YojamTests
    dependencies:
      - target: Yojam
    settings:
      base:
        TEST_HOST: "$(BUILT_PRODUCTS_DIR)/Yojam.app/Contents/MacOS/Yojam"
        BUNDLE_LOADER: "$(TEST_HOST)"
        GENERATE_INFOPLIST_FILE: YES

  YojamCoreTests:
    type: bundle.unit-test
    platform: macOS
    sources:
      - path: Tests/YojamCoreTests
    dependencies:
      - target: YojamCore
    settings:
      base:
        GENERATE_INFOPLIST_FILE: YES