bundo-appgen 0.0.10 → 0.0.11

package/src/_bin/_main/_init-template/_init-apple/_mod-files/_privacy-manifest.mts

@@ -0,0 +1,119 @@
+import * as node_fs from "node:fs"
+import * as node_path from "node:path"
+
+import type * as Config from "../../../../../config/index.mts"
+
+import {
+	GlobalVars,
+} from "../../../../_global-vars/index.mts"
+
+export function privacyManifest(
+	platform: "macos",
+) {
+
+	const
+		manifest =
+			GlobalVars.appConfig.get()[platform as "macos"]?.privacyManifest
+
+	if(!manifest) {
+		return
+	}
+
+	const
+		nativeProjectDir =
+			node_path.join(
+				node_path.dirname(GlobalVars.configFilePath.get()),
+				platform,
+			),
+
+		privacyInfoFilePath =
+			node_path.join(nativeProjectDir, "PrivacyInfo.xcprivacy")
+
+	let privacyInfoFile = `<?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>`
+
+	for(const [key, plist] of Object.entries(manifest)) {
+		privacyInfoFile += getDictionaryItem(key, plist)
+	}
+
+	privacyInfoFile += `
+</dict>
+</plist>`
+
+	node_fs.writeFileSync(
+		privacyInfoFilePath,
+		privacyInfoFile,
+		"utf8",
+	)
+
+}
+
+/**
+ * Info.plist and .entitlements file has done by the XcodeGen,
+ * but if there are other plist-format files that we need to create than the PrivacyInfo.xcprivacy,
+ * it is better to move out this function as a reusable helper for
+ * writing a plist XML file.
+ */
+function getDictionaryItem(
+	key: string,
+	plist: Config.Apple.PlistValue,
+	startIndentAmount: number = 1,
+): string {
+
+	const indent = Array(startIndentAmount).fill("\t").join("")
+
+	let tx = `\n${indent}<key>${key}</key>`
+
+	if(typeof plist == "boolean") {
+		if(plist) {
+			tx += `\n${indent}<true/>`
+		} else {
+			tx += `\n${indent}<false/>`
+		}
+	} else if(typeof plist == "string") {
+		if(!plist) {
+			throw new Error("A plist item is empty or not a valid string.")
+		}
+
+		tx += `\n${indent}<string>${plist}</string>`
+	} else if(Array.isArray(plist)) {
+		if(plist.length) {
+			tx += `\n${indent}<array>`
+
+			plist.forEach((value, index) => {
+				if(typeof value == "string") {
+					if(!value) {
+						throw new Error(`${key}[${index}] is empty or not a valid string.`)
+					}
+					tx += `\n${indent}\t<string>${value}</string>`
+				} else if(typeof value == "object" && value) {
+					tx += `\n${indent}<dict>`
+
+					for(const [key2, plist2] of Object.entries(value)) {
+						tx += getDictionaryItem(key2, plist2, startIndentAmount + 1)
+					}
+
+					tx += `\n${indent}</dict>`
+				}
+			})
+
+			tx += `\n${indent}</array>`
+		} else {
+			// allow empty array in the plist
+			tx += `\n<array/>`
+		}
+	} else if(typeof plist == "object" && plist) {
+		tx += `\n${indent}<dict>`
+
+		for(const [key2, plist2] of Object.entries(plist)) {
+			tx += getDictionaryItem(key2, plist2, startIndentAmount + 1)
+		}
+
+		tx += `\n${indent}</dict>`
+	}
+
+	return tx
+
+}

package/src/_bin/_main/_init-template/_init-apple/_mod-files/mod-files.mts

@@ -4,14 +4,20 @@ import {
 
 import {
 	podfile,
-} from "./_podfile.mts"
+} from "./_podfile/index.mts"
+
+import {
+	privacyManifest,
+} from "./_privacy-manifest.mts"
 
 export function modFiles(
-	platform: "macos" | "ios",
+	platform: "macos",
 ) {
 
 	appDelegateSwift(platform)
 
 	podfile(platform)
 
+	privacyManifest(platform)
+
 }

package/src/_bin/_main/_init-template/_init-apple/init-apple.mts

@@ -22,13 +22,23 @@ import {
 } from "./_mod-files/index.mts"
 
 export function initApple(
-	platform: "macos" | "ios",
+	platform: "macos",
 ) {
 	const
-		// config.macos is already checked at bundo-appgen/src/_bin/_main/main.mts
 		config =
 			GlobalVars.appConfig.get(),
 
+		appleData =
+			config[platform]
+
+	// `config.macos` is already checked at bundo-appgen/src/_bin/_main/main.mts
+	// but if somehow if bundo-appgen is supporting other Apple platforms,
+	// we need a correct check in the bundo-appgen/src/_bin/_check-config-validitidy.mts
+	if(!appleData) {
+		throw new Error(`"${platform}" config is empty.`)
+	}
+
+	const
 		projectDirectory =
 			node_path.dirname(GlobalVars.configFilePath.get()),
 
@@ -54,20 +64,15 @@ export function initApple(
 			node_path.join(nativeProjectDirectory, "HelloWorld"),
 			node_path.join(nativeProjectDirectory, projectName),
 		)
-
-		modFiles(platform)
 	}
 
-	// Intentionally asserted as "macos"
-	// TODO : "ios"
-	const appleData = config[platform as "macos"]!
+	modFiles(platform)
 
 	createAssetCatalogs(
 		appleData.assetCatalogs,
 		{
 			bundleIdentifier: appleData.bundleIdentifier,
 			platform,
-			projectName,
 		},
 	)
 

package/src/_bin/_main/_init-template/init-template.mts

@@ -12,6 +12,8 @@ import {
 export function initTemplate() {
 	// config object is already checked at ../main.mts
 
+	// The platform target check here is not correct if we are supporting other platforms.
+	// bundo-appgen is only supporting the "macos" at this moment.
 	try {
 		if(process.platform == "darwin") {
 			initApple("macos")

package/src/_bin/_main/_xcodegen/_create-project-spec/_init-resources.mts

@@ -9,15 +9,19 @@ import {
 	GlobalVars,
 } from "../../../_global-vars/index.mts"
 
+/**
+ * This function is probably better at inside of ./_bin/_main/_init-template/_init-apple,
+ * but create-project-spec.mts needs the directory name as the "subpath" resource configuration.
+ */
 export function initResources(
 	resources: Config.Apple.Data["resources"],
 	metadata: {
 		platform: "macos" | "ios",
 	},
 ): {
-	basename: string,
-	isDirectory: boolean,
-}[] | null {
+	basenameFiles: string[],
+	subpaths: string[],
+} | null {
 
 	if(!resources?.length) {
 		return null
@@ -36,7 +40,10 @@ export function initResources(
 				"Resources",
 			),
 
-		data: NonNullable<ReturnType<typeof initResources>> =
+		basenameFiles: NonNullable<ReturnType<typeof initResources>>["basenameFiles"] =
+			[],
+
+		subpaths: NonNullable<ReturnType<typeof initResources>>["subpaths"] =
 			[]
 
 	node_fs.rmSync(resourcesDirectory, { recursive: true, force: true })
@@ -70,10 +77,11 @@ export function initResources(
 				},
 			)
 
-			data.push({
-				basename: node_path.basename(path),
-				isDirectory: lstat.isDirectory(),
-			})
+			if(lstat.isDirectory()) {
+				subpaths.push(node_path.basename(path))
+			} else {
+				basenameFiles.push(node_path.basename(path))
+			}
 		}
 	} catch(err) {
 		// remove the resources directory upon error
@@ -81,6 +89,10 @@ export function initResources(
 		throw err
 	}
 
-	return data
+	// return data
+	return {
+		basenameFiles,
+		subpaths,
+	}
 
 }

package/src/_bin/_main/_xcodegen/_create-project-spec/create-project-spec.mts

@@ -20,7 +20,7 @@ import {
  * Create `project.json` file in the "<project>/macos" directory.
  */
 export function createProjectSpec(
-	platform: "macos" | "ios",
+	platform: "macos",
 	overrideConfig?: {
 		infoPlist?: Config.Apple.Data["infoPlist"],
 	},
@@ -42,7 +42,7 @@ export function createProjectSpec(
 		config =
 			GlobalVars.appConfig.get()
 
-	// TODO : also check for "ios"
+	// TODO : other Apple platforms
 	if(
 		config.macos?.appicon &&
 		(
@@ -56,11 +56,24 @@ export function createProjectSpec(
 
 	if(
 		(platform == "macos" && !config.macos)
-		// TODO : "ios"
+		// TODO : other Apple platforms
 	) {
 		throw new Error(`${platform} configuration was not found.`)
 	}
 
+	const projectName = ConfigHelpers.getProjectName(config, platform)! // already validated
+
+	{
+		// remove the .entitlements file if any and rewrite if the entitlements properties is given.
+		// We need this because XcodeGen doesn't remove previous properties.
+
+		const entitlementsFilePath = node_path.join(nativeProjectDir, projectName, `${projectName}.entitlements`)
+
+		if(node_fs.existsSync(entitlementsFilePath)) {
+			node_fs.rmSync(entitlementsFilePath)
+		}
+	}
+
 	const
 		requireFromNativeDirectory =
 			node_module.createRequire(nativeProjectDir),
@@ -74,19 +87,14 @@ export function createProjectSpec(
 			),
 
 		appleData: Config.Apple.Data =
-			// Intentionally asserted as "macos"
-			// TODO : "ios"
 			{
-				...config[platform as "macos"]!,
+				...config[platform]!,
 				infoPlist: {
 					...overrideConfig?.infoPlist,
-					...config[platform as "macos"]!.infoPlist, // client's infoPlist takes precedence over the plugin
+					...config[platform]!.infoPlist, // client's infoPlist takes precedence over the plugin
 				},
 			},
 
-		projectName =
-			ConfigHelpers.getProjectName(config, platform)!, // already validated
-
 		resourcesData =
 			initResources(
 				config.macos?.resources,
@@ -95,12 +103,10 @@ export function createProjectSpec(
 				},
 			),
 
-		/* eslint-disable @typescript-eslint/no-explicit-any */
-
 		/**
 		 * See https://github.com/yonaskolb/XcodeGen/blob/master/Docs/ProjectSpec.md
 		 */
-		json: Record<string, any> =
+		json: Record<string, unknown> =
 			{
 
 				name: projectName,
@@ -116,26 +122,37 @@ export function createProjectSpec(
 								path: projectName,
 								type: "syncedFolder",
 							},
-							...(resourcesData?.map(resource => {
-								/**
-								 * The path "Resources" is just our group, and also our custom directory,
-								 * not an actual bundle resource directory content of macOS app, e.g. /Applications/HelloWorld.app/Contents/Resources.
-								 * The naming is purely a coincidence.
-								 * 
-								 * We intentionally to copy user files to our directory called "Resources".
-								 * Any user files will be copied to our "Resources" directory.
-								 * 
-								 * See placing content in a bundle
-								 * https://developer.apple.com/documentation/bundleresources/placing-content-in-a-bundle?language=objc
-								 */
+
+							/**
+							 * The path "Resources" is just our group, and also our custom directory,
+							 * not an actual bundle resource directory content of macOS app, e.g. /Applications/HelloWorld.app/Contents/Resources.
+							 * The naming is purely a coincidence.
+							 * 
+							 * We intentionally to copy user files to our directory called "Resources".
+							 * Any user files will be copied to our "Resources" directory.
+							 * 
+							 * See placing content in a bundle
+							 * https://developer.apple.com/documentation/bundleresources/placing-content-in-a-bundle?language=objc
+							 */
+
+							...(resourcesData?.basenameFiles.length ? [{
+								path: "Resources",
+								excludes: resourcesData.subpaths,
+								buildPhase: {
+									copyFiles: {
+										destination: "resources",
+									},
+								},
+							}] : []),
+
+							...(resourcesData?.subpaths?.map(subpath => {
 								return {
 									path: "Resources",
+									excludes: resourcesData.basenameFiles,
 									buildPhase: {
 										copyFiles: {
 											destination: "resources",
-											subpath: resource.isDirectory
-												? resource.basename
-												: undefined,
+											subpath,
 										},
 									},
 								}
@@ -162,6 +179,12 @@ export function createProjectSpec(
 								...appleData.infoPlist,
 							},
 						},
+
+						entitlements: appleData.entitlements ? {
+							path: `${projectName}/${projectName}.entitlements`,
+							properties: appleData.entitlements,
+						} : undefined,
+
 						postBuildScripts: [
 							{
 								name: "Bundle React Native code and images",
@@ -169,8 +192,6 @@ export function createProjectSpec(
 							},
 						],
 
-						scheme: {},
-
 						settings: {
 							ASSETCATALOG_COMPILER_APPICON_NAME: appleData.appicon,
 						},
@@ -206,8 +227,6 @@ export function createProjectSpec(
 
 			}
 
-	/* eslint-enable @typescript-eslint/no-explicit-any */
-
 	node_fs.writeFileSync(
 		node_path.join(
 			nativeProjectDir, "project.json",

package/src/_bin/_main/_xcodegen/_mod-known-regions/mod-known-regions.mts

@@ -10,14 +10,14 @@ import {
 } from "../../_helpers/index.mts"
 
 export function modKnownRegions(
-	platform: "macos" | "ios",
+	platform: "macos",
 ) {
 	const
 		config =
 			GlobalVars.appConfig.get(),
 
 		appleData =
-			config[platform as "macos"] // TODO : ios
+			config[platform as "macos"] // TODO : other Apple platforms
 
 	if(!appleData?.locales?.length) {
 		return

package/src/_bin/_main/_xcodegen/xcodegen.mts

@@ -14,7 +14,7 @@ import {
 } from "./_mod-known-regions/mod-known-regions.mts"
 
 export function xcodegen(
-	platform: "macos" | "ios",
+	platform: "macos",
 	overrideConfig?: Parameters<typeof createProjectSpec>[1],
 ) {
 	createProjectSpec(platform, overrideConfig)

package/src/_bin/_main/main.mts

@@ -130,7 +130,7 @@ export async function main() {
 		modPlugin(pluginContextResult)
 	}
 
-	// TODO : "ios"
+	// TODO : other Apple platforms
 	xcodegen(
 		"macos",
 		{

package/src/_bin/plugin-sandbox-runner/plugin-runner-context-result.ts

@@ -4,30 +4,3 @@ import type {
 
 export interface PluginRunnerContextResult extends Omit<Plugin.Context, "parameter"> {
 }
-
-// export interface PluginRunnerContextResult extends Omit<Plugin.Context, "parameter" | "macos"> {
-// 	macos: Omit<
-// 		Plugin.Context["macos"],
-// 		| "files"
-// 	> & {
-// 		files: Omit<
-// 			Plugin.Apple.Files,
-// 			| "add"
-// 			| "Project"
-// 		> & {
-// 			Project: Omit<
-// 				Plugin.Apple.Files["Project"],
-// 				| "add"
-// 			> & {
-// 				pluginFiles: {
-// 					filename: string,
-// 					source: string,
-// 				}[],
-// 			},
-// 			pluginFiles: {
-// 				filename: string,
-// 				source: string,
-// 			}[],
-// 		}
-// 	}
-// }

package/src/config/apple/asset-catalogs-namespaced.ts

@@ -9,5 +9,5 @@ export type AssetCatalogsNamespaced =
 		 * Stated by Xcode
 		 * "The app icon set must be a top level object in the asset."
 		 */
-		[Namespace in string]?: Omit<AssetCatalogs | AssetCatalogsNamespaced, "appiconsets">
+		[Namespace: Exclude<string, keyof AssetCatalogs>]: Omit<AssetCatalogs, "appiconsets"> | AssetCatalogsNamespaced
 	}

package/src/config/apple/data.ts

@@ -7,11 +7,23 @@ import type {
 } from "./asset-catalogs-namespaced"
 
 import type {
-	InfoPlist,
-} from "./info-plist"
+	Plist,
+} from "./plist"
+
+import type * as Podfile from "./podfile"
 
 export interface Data {
 
+	/**
+	 * @deprecated
+	 * React Native will move away from CocoaPods, and use Swift Package Manager.
+	 * Consider this deprecation as a warning, because Swift Package Manager in React Native is still experimental.
+	 * You can still use this until Swift Package Manager is supported in React Native completely.
+	 */
+	Podfile?: {
+		dependencies?: Podfile.PodDependency[],
+	},
+
 	/**
 	 * Use one name of `appiconsets` in Asset Catalogs as the app icon.
 	 * appgen script will throw an error if the name given is not found in the catalog.
@@ -34,12 +46,18 @@ export interface Data {
 
 	bundleIdentifier: string,
 
+	/**
+	 * Key-value pairs that grant an executable permission to use a service or technology.
+	 * @see https://developer.apple.com/documentation/bundleresources/entitlements
+	 */
+	entitlements?: Plist,
+
 	/**
 	 * Customize the information property list values for your app.
 	 * 
 	 * For human readable information property list, you can localize the information property through string catalog. See {@link stringCatalogs|`stringCatalogs`}
 	 */
-	infoPlist?: InfoPlist,
+	infoPlist?: Plist,
 
 	/**
 	 * Provide array of [language identifier](https://developer.apple.com/documentation/xcode/choosing-localization-regions-and-scripts), made up of a [2-letter language code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) of your desired language, with an optional region code (for example, en-US or en-GB).
@@ -62,13 +80,18 @@ export interface Data {
 	 */
 	name?: string,
 
+	/**
+	 * Describe the data your app or third-party SDK collects and the required reasons APIs it uses.
+	 */
+	privacyManifest?: Plist,
+
 	/**
 	 * Add files to the native bundle resources directory, e.g. "/Applications/Hello World.app/Contents/Resources".
 	 * This property expects an array of string, which the string represent as the path, and it can be pointing to a specific file or a directory.
 	 * 
 	 * For example, "../node_modules/foo-bar-module/xyz/abc" will copy the "abc" including its files if it is directory. Your app will has "abc" under bundle resources directory, e.g. "/Applications/Hello World.app/Contents/Resources/abc".
 	 * 
-	 * For another real example, you can copy your font files in the bundle resources, and use in your React Native macOS app.
+	 * For another real example, you can copy your font files to the bundle resources, and use it in your React Native macOS app.
 	 * 
 	 * ```ts
 	 * import type { Config } from "bundo.rn/appgen"

package/src/config/apple/index.mts

@@ -3,5 +3,6 @@ export type * from "./asset-catalogs.ts"
 export type * from "./asset-catalogs-namespaced.ts"
 export * from "./create-osx-appiconset.mts"
 export type * from "./data.ts"
-export type * from "./info-plist.ts"
-export type * from "./info-plist-value.ts"
+export type * from "./plist.ts"
+export type * from "./plist-value.ts"
+export type * as Podfile from "./podfile/index.ts"

package/src/config/apple/{info-plist-value.ts → plist-value.ts}

@@ -1,8 +1,9 @@
-export type InfoPlistValue =
+export type PlistValue =
 	| boolean
 	| string
 	| string[]
 	| DictionaryValue
+	| DictionaryValue[]
 
 type DictionaryValue = {
 	[Key in string]:
@@ -10,7 +11,7 @@ type DictionaryValue = {
 		| string
 		| string[]
 		| DictionaryValue
-		| {
-			[Key2 in string]: DictionaryValue
-		}[]
+		// | {
+		// 	[Key2 in string]: DictionaryValue
+		// }[]
 }

package/src/config/apple/plist.ts

@@ -0,0 +1,6 @@
+import type {
+	PlistValue,
+} from "./plist-value"
+
+export interface Plist extends Record<string, PlistValue> {
+}

package/src/config/apple/podfile/index.ts

@@ -0,0 +1,4 @@
+export type * from "./pod-dependency"
+export type * from "./pod-dependency-from-cocoapods"
+export type * from "./pod-dependency-from-git"
+export type * from "./pod-dependency-from-local"

package/src/config/apple/podfile/pod-dependency-from-cocoapods.ts

@@ -0,0 +1,15 @@
+export interface PodDependencyFromCocoapods {
+
+	type: "cocoapods",
+
+	/**
+	 * The pod name or a name for specific subspec e.g. "QueryKit/Attribute".
+	 */
+	name: string,
+
+	/**
+	 * Use latest or specific version of a Pod. See {@link https://guides.cocoapods.org/using/the-podfile.html#specifying-pod-versions|Specifying Pod Versions}
+	 */
+	version?: string,
+
+}

package/src/config/apple/podfile/pod-dependency-from-git.ts

@@ -0,0 +1,23 @@
+export interface PodDependencyFromGit {
+
+	type: "git",
+
+	/**
+	 * The pod name or a name for specific subspec e.g. "QueryKit/Attribute".
+	 */
+	name: string,
+
+	/**
+	 * @example "https://github.com/facebook/react-native.git"
+	 */
+	url: string,
+
+	revision?: {
+		type:
+			| "branch"
+			| "tag"
+			| "commit",
+		ref: string,
+	},
+
+}

package/src/config/apple/podfile/pod-dependency-from-local.ts

@@ -0,0 +1,15 @@
+export interface PodDependencyFromLocal {
+
+	type: "local",
+
+	/**
+	 * The pod name or a name for specific subspec e.g. "QueryKit/Attribute".
+	 */
+	name: string,
+
+	/**
+	 * Using the files from a local folder to the machine.
+	 */
+	path: string,
+
+}