@wwdrew/expo-apple-music 1.1.0 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wwdrew/expo-apple-music",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Apple MusicKit wrapper for Expo",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -11,7 +11,7 @@
     "test": "jest --watchman=false",
     "test:expo": "expo-module test",
     "prepare": "expo-module prepare",
-    "prepublishOnly": "node scripts/npm-prepublish.mjs && expo-module prepublishOnly",
+    "prepublishOnly": "node scripts/npm-prepublish.mjs && expo-module prepublishOnly && expo-module build plugin",
     "pack:check": "npm run build && node scripts/verify-npm-pack.mjs",
     "expo-module": "expo-module",
     "dev-token": "node scripts/generate-developer-token.mjs",

package/plugin/build/apple-music-aars.d.ts

@@ -0,0 +1,14 @@
+/** Filenames must match `expo-module.config.json` → `gradleAarProjects`. */
+export declare const ANDROID_MUSICKIT_AAR_FILES: readonly ["musickitauth-release-1.1.2.aar", "mediaplayback-release-1.1.1.aar"];
+export type AndroidMusicKitAarFile = (typeof ANDROID_MUSICKIT_AAR_FILES)[number];
+export declare function getModuleAndroidLibsDir(moduleRoot: string): string;
+export declare class MissingAndroidMusicKitAarsError extends Error {
+    readonly sourceDir: string;
+    readonly missingFiles: readonly string[];
+    constructor(sourceDir: string, missingFiles: readonly string[]);
+}
+export declare function formatMissingAndroidMusicKitAarsMessage(sourceDir: string, missingFiles: readonly string[]): string;
+export declare function copyAndroidMusicKitAars(options: {
+    sourceDir: string;
+    moduleRoot: string;
+}): void;

package/plugin/build/apple-music-aars.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MissingAndroidMusicKitAarsError = exports.ANDROID_MUSICKIT_AAR_FILES = void 0;
+exports.getModuleAndroidLibsDir = getModuleAndroidLibsDir;
+exports.formatMissingAndroidMusicKitAarsMessage = formatMissingAndroidMusicKitAarsMessage;
+exports.copyAndroidMusicKitAars = copyAndroidMusicKitAars;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/** Filenames must match `expo-module.config.json` → `gradleAarProjects`. */
+exports.ANDROID_MUSICKIT_AAR_FILES = [
+    "musickitauth-release-1.1.2.aar",
+    "mediaplayback-release-1.1.1.aar",
+];
+function getModuleAndroidLibsDir(moduleRoot) {
+    return path_1.default.join(moduleRoot, "android", "libs");
+}
+class MissingAndroidMusicKitAarsError extends Error {
+    sourceDir;
+    missingFiles;
+    constructor(sourceDir, missingFiles) {
+        super(formatMissingAndroidMusicKitAarsMessage(sourceDir, missingFiles));
+        this.sourceDir = sourceDir;
+        this.missingFiles = missingFiles;
+        this.name = "MissingAndroidMusicKitAarsError";
+    }
+}
+exports.MissingAndroidMusicKitAarsError = MissingAndroidMusicKitAarsError;
+function formatMissingAndroidMusicKitAarsMessage(sourceDir, missingFiles) {
+    const fileList = missingFiles.map((file) => `  - ${file}`).join("\n");
+    return (`[expo-apple-music] Missing Apple MusicKit Android AAR file(s) in ${sourceDir}:\n` +
+        `${fileList}\n\n` +
+        "Download the MusicKit SDK for Android from https://developer.apple.com/musickit/ " +
+        "(Apple Developer account required), place both .aar files in the directory " +
+        "configured as `androidMusicKitAarDir`, then run `npx expo prebuild` again.");
+}
+function copyAndroidMusicKitAars(options) {
+    const { sourceDir, moduleRoot } = options;
+    const targetDir = getModuleAndroidLibsDir(moduleRoot);
+    if (!fs_1.default.existsSync(sourceDir)) {
+        throw new MissingAndroidMusicKitAarsError(sourceDir, [...exports.ANDROID_MUSICKIT_AAR_FILES]);
+    }
+    fs_1.default.mkdirSync(targetDir, { recursive: true });
+    const missingFiles = [];
+    for (const fileName of exports.ANDROID_MUSICKIT_AAR_FILES) {
+        const sourcePath = path_1.default.join(sourceDir, fileName);
+        if (!fs_1.default.existsSync(sourcePath)) {
+            missingFiles.push(fileName);
+            continue;
+        }
+        fs_1.default.copyFileSync(sourcePath, path_1.default.join(targetDir, fileName));
+    }
+    if (missingFiles.length > 0) {
+        throw new MissingAndroidMusicKitAarsError(sourceDir, missingFiles);
+    }
+}

package/plugin/build/index.d.ts

@@ -0,0 +1,5 @@
+import type { ExpoAppleMusicPluginProps } from "./with-expo-apple-music";
+export type { ExpoAppleMusicPluginProps } from "./with-expo-apple-music";
+export { DEFAULT_MUSIC_USAGE } from "./with-expo-apple-music";
+/** Typed `app.config` plugin entry (Expo SDK 56+). */
+export default function expoAppleMusic(props?: ExpoAppleMusicPluginProps): ["@wwdrew/expo-apple-music", ExpoAppleMusicPluginProps | void];

package/plugin/build/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_MUSIC_USAGE = void 0;
+exports.default = expoAppleMusic;
+var with_expo_apple_music_1 = require("./with-expo-apple-music");
+Object.defineProperty(exports, "DEFAULT_MUSIC_USAGE", { enumerable: true, get: function () { return with_expo_apple_music_1.DEFAULT_MUSIC_USAGE; } });
+/** Typed `app.config` plugin entry (Expo SDK 56+). */
+function expoAppleMusic(props) {
+    return ["@wwdrew/expo-apple-music", props];
+}

package/plugin/build/with-expo-apple-music.d.ts

@@ -0,0 +1,18 @@
+import { type ConfigPlugin } from "@expo/config-plugins";
+export declare const DEFAULT_MUSIC_USAGE = "Allow $(PRODUCT_NAME) to access Apple Music.";
+export type ExpoAppleMusicPluginProps = {
+    /**
+     * Sets `NSAppleMusicUsageDescription` in the generated iOS Info.plist.
+     */
+    musicUsageDescription?: string;
+    /**
+     * Directory containing Apple's MusicKit Android `.aar` files (path relative to
+     * the app project root). Required when running `expo prebuild` for Android.
+     *
+     * The plugin copies the AARs into this package at prebuild time — they are not
+     * shipped on npm and cannot be redistributed by this library.
+     */
+    androidMusicKitAarDir?: string;
+};
+declare const withExpoAppleMusic: ConfigPlugin<ExpoAppleMusicPluginProps | void>;
+export default withExpoAppleMusic;

package/plugin/build/with-expo-apple-music.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_MUSIC_USAGE = void 0;
+const path_1 = __importDefault(require("path"));
+const config_plugins_1 = require("@expo/config-plugins");
+const apple_music_aars_1 = require("./apple-music-aars");
+/** plugin/build/*.js → package root */
+function getExpoAppleMusicModuleRoot() {
+    return path_1.default.join(__dirname, "..", "..");
+}
+/** MusicKit APIs used by this module require iOS 16.4+ (Expo SDK 56 minimum). */
+const IOS_DEPLOYMENT_TARGET = "16.4";
+const withIosDeploymentTargetPodfile = config_plugins_1.IOSConfig.BuildProperties.createBuildPodfilePropsConfigPlugin([
+    {
+        propName: "ios.deploymentTarget",
+        propValueGetter: () => IOS_DEPLOYMENT_TARGET,
+    },
+], "withExpoAppleMusicIosDeploymentTargetPodfile");
+const withIosDeploymentTargetXcodeProject = (config) => {
+    return (0, config_plugins_1.withXcodeProject)(config, (c) => {
+        const { Target, XcodeUtils } = config_plugins_1.IOSConfig;
+        const project = c.modResults;
+        const targetBuildConfigListIds = Target.getNativeTargets(project)
+            .filter(([_, target]) => Target.isTargetOfType(target, Target.TargetType.APPLICATION))
+            .map(([_, target]) => target.buildConfigurationList);
+        for (const buildConfigListId of targetBuildConfigListIds) {
+            for (const [, configurations] of XcodeUtils.getBuildConfigurationsForListId(project, buildConfigListId)) {
+                const { buildSettings } = configurations;
+                if (buildSettings?.IPHONEOS_DEPLOYMENT_TARGET) {
+                    buildSettings.IPHONEOS_DEPLOYMENT_TARGET = IOS_DEPLOYMENT_TARGET;
+                }
+            }
+        }
+        return c;
+    });
+};
+exports.DEFAULT_MUSIC_USAGE = "Allow $(PRODUCT_NAME) to access Apple Music.";
+const withAndroidMusicKitAars = (config, { androidMusicKitAarDir } = {}) => {
+    return (0, config_plugins_1.withDangerousMod)(config, [
+        "android",
+        async (config) => {
+            const configuredDir = androidMusicKitAarDir?.trim();
+            if (!configuredDir) {
+                throw new Error("[expo-apple-music] `androidMusicKitAarDir` is required for Android builds. " +
+                    "Download Apple's MusicKit SDK for Android, place the .aar files in a directory " +
+                    "in your app (for example `./vendor/apple-musickit-android`), and pass that path " +
+                    "to the expo-apple-music config plugin. See docs/GETTING_STARTED.md.");
+            }
+            const projectRoot = config.modRequest.projectRoot;
+            const sourceDir = path_1.default.resolve(projectRoot, configuredDir);
+            const moduleRoot = getExpoAppleMusicModuleRoot();
+            (0, apple_music_aars_1.copyAndroidMusicKitAars)({ sourceDir, moduleRoot });
+            return config;
+        },
+    ]);
+};
+const withExpoAppleMusic = (config, props) => {
+    const { musicUsageDescription, androidMusicKitAarDir } = props ?? {};
+    config = withIosDeploymentTargetPodfile(config);
+    config = withIosDeploymentTargetXcodeProject(config);
+    config = withAndroidMusicKitAars(config, { androidMusicKitAarDir });
+    return (0, config_plugins_1.withInfoPlist)(config, (c) => {
+        const current = c.modResults.NSAppleMusicUsageDescription;
+        const hasCurrent = typeof current === "string" && current.trim().length > 0;
+        const hasOption = typeof musicUsageDescription === "string" &&
+            musicUsageDescription.trim().length > 0;
+        if (hasOption) {
+            c.modResults.NSAppleMusicUsageDescription = musicUsageDescription;
+        }
+        else if (!hasCurrent) {
+            c.modResults.NSAppleMusicUsageDescription = exports.DEFAULT_MUSIC_USAGE;
+        }
+        return c;
+    });
+};
+exports.default = withExpoAppleMusic;