bundo-appgen 0.0.1-beta.7

package/src/_bin/plugin-sandbox-runner/evaluated-plugin-registry.ts

@@ -0,0 +1,12 @@
+import type {
+	Plugin,
+} from "../../index.mts"
+
+export type EvaluatedPluginRegistry = {
+	/**
+	 * This is the name registered in the plugin registry.
+	 */
+	name: string,
+	mainPath: string,
+	parameter: Plugin.Context["parameter"],
+}[]

package/src/_bin/plugin-sandbox-runner/index.ts

@@ -0,0 +1,3 @@
+export type * from "./argv-json"
+export type * from "./evaluated-plugin-registry"
+export type * from "./plugin-runner-context-result"

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

@@ -0,0 +1,33 @@
+import type {
+	Plugin,
+} from "../../index.mts"
+
+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/_bin/plugin-sandbox-runner/plugin-sandbox-runner.mts

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+
+import yargs from "yargs"
+import * as YargsHelpers from "yargs/helpers"
+
+import {
+	execPlugins,
+} from "./_exec-plugins.mts"
+
+import type {
+	ArgvJSON,
+} from "./argv-json.ts"
+
+// Please, only allow permission in this script for
+
+// - File System read for:
+// 		- <projectDirectory>/macos/<projectName>/AppDelegate.swift
+// 		- <projectDirectory>/macos/Podfile
+
+try {
+
+	const
+		argv =
+			yargs(YargsHelpers.hideBin(process.argv))
+				.options({
+					"json": {
+						type: "string",
+						description: "See bundo-appgen/src/_bin/plugin-sandbox-runner/_argv-json.ts",
+					},
+				})
+				.parseSync(),
+
+		argvJSON =
+			JSON.parse(argv.json || "") as unknown as ArgvJSON
+
+	if(!argvJSON.evaluatedPluginRegistry?.length) {
+		// we already do a preventing to exec this plugin-sandbox-runner.mts
+		// if plugin registry is empty.
+		// Just in case, if we don't.
+		throw new Error("Not a valid Evaluated Plugin Registry array.")
+	}
+
+	const result = await execPlugins({
+		projectDirectory: argvJSON.projectDirectory,
+		projectName: argvJSON.projectName,
+		registry: argvJSON.evaluatedPluginRegistry,
+	})
+
+	// send message through IPC channel
+	process.send?.(
+		JSON.stringify({
+			...result,
+			messageID: argvJSON.messageID,
+		}),
+	)
+
+} catch(err) {
+	if(err instanceof Error && err.message) {
+		console.error(
+			"\x1b[31mPlugin Sandbox Runner Error\x1b[0m: " +
+			err.message,
+		)
+		process.exitCode = 1
+	} else {
+		console.error("Unknown error. Please report it to https://github.com/RakaDoank/bundo.rn", { cause: err })
+		process.exitCode = 1
+	}
+}

package/src/config/apple/asset-catalog-format/app-icon/index.ts

@@ -0,0 +1,2 @@
+export type * from "./set-type"
+export type * from "./size"

package/src/config/apple/asset-catalog-format/app-icon/set-type.ts

@@ -0,0 +1,59 @@
+import type {
+	Appearances,
+} from "../appearances"
+
+import type {
+	Idiom,
+} from "../idiom"
+
+import type * as Image from "../image"
+
+import type {
+	Size,
+} from "./size"
+
+export interface SetType {
+
+	name: string,
+
+	images: {
+		// In Xcode, it generates "appearances" with array value, even the image is only one appearance variant per image.
+		appearances?: Appearances,
+		"display-gamut"?: Image.DisplayGamut,
+		/**
+		 * @default "universal"
+		 */
+		idiom?: Idiom,
+		/**
+		 * The filename in the path will be used as the filename property for the `Contents.json`.
+		 * Currently only support for PNG file.
+		 */
+		path: string,
+		/**
+		 * - 16x16 - An OS X icon
+		 * - 20x20 - An iPhone or iPad notification icon
+		 * - 24x24 - A 38mm Apple Watch notification center icon
+		 * - 27.5x27.5 - A 42mm Apple Watch notification center icon
+		 * - 29x29 -  An iPhone or iPad settings icon for iOS 7 or later. An Apple Watch companion settings icon
+		 * - 32x32 - An OS X icon
+		 * - 40x40 -  An iPhone or iPad Spotlight search results icon on iOS 7 or later. The main Apple Watch app icon.
+		 * - 44x44 - An Apple Watch long-look notification icon
+		 * - 60x60 - The main iPhone app icon for iOS 7 or later
+		 * - 76x76 - The main iPad app icon for iOS 7 or later
+		 * - 83.5x83.5 - The main iPad Pro app icon
+		 * - 86x86 - A 38mm Apple Watch short-look notification icon
+		 * - 98x98 - A 42mm Apple Watch short-look notification icon
+		 * - 128x128 - An OS X icon
+		 * - 256x256 - An OS X icon
+		 * - 512x512 - An OS X icon
+		 * - 1024x1024 - The App Store icon
+		 */
+		size: Size,
+
+		// Even though from this documentation https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format/AppIconType.html
+		// states that `appiconset` has `scale`, but I never find it in Xcode inspector.
+		// However, Xcode still generate the Contents.json with scale property.
+		scale?: Exclude<Image.Scale, "3x">
+	}[],
+
+}

package/src/config/apple/asset-catalog-format/app-icon/size.ts

@@ -0,0 +1,37 @@
+/**
+ * - 16x16 - An OS X icon
+ * - 20x20 - An iPhone or iPad notification icon
+ * - 24x24 - A 38mm Apple Watch notification center icon
+ * - 27.5x27.5 - A 42mm Apple Watch notification center icon
+ * - 29x29 -  An iPhone or iPad settings icon for iOS 7 or later. An Apple Watch companion settings icon
+ * - 32x32 - An OS X icon
+ * - 40x40 -  An iPhone or iPad Spotlight search results icon on iOS 7 or later. The main Apple Watch app icon.
+ * - 44x44 - An Apple Watch long-look notification icon
+ * - 60x60 - The main iPhone app icon for iOS 7 or later
+ * - 76x76 - The main iPad app icon for iOS 7 or later
+ * - 83.5x83.5 - The main iPad Pro app icon
+ * - 86x86 - A 38mm Apple Watch short-look notification icon
+ * - 98x98 - A 42mm Apple Watch short-look notification icon
+ * - 128x128 - An OS X icon
+ * - 256x256 - An OS X icon
+ * - 512x512 - An OS X icon
+ * - 1024x1024 - The App Store icon
+ */
+export type Size =
+	| "16x16"
+	| "20x20"
+	| "24x24"
+	| "27.5x27.5"
+	| "29x29"
+	| "32x32"
+	| "40x40"
+	| "44x44"
+	| "60x60"
+	| "76x76"
+	| "83.5x83.5"
+	| "86x86"
+	| "98x98"
+	| "128x128"
+	| "256x256"
+	| "512x512"
+	| "1024x1024"

package/src/config/apple/asset-catalog-format/appearances.ts

@@ -0,0 +1,10 @@
+/**
+ * We mock this value from Xcode.
+ * Xcode generates "appearances" with array value, even the image is only one appearance variant per image.
+ * 
+ * Probably, they have plan for the appearances in the future.
+ */
+export type Appearances = [{
+	appearance: "luminosity" | "contrast",
+	value: "light" | "dark",
+}]

package/src/config/apple/asset-catalog-format/idiom.ts

@@ -0,0 +1,16 @@
+/**
+ * @see https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format/ImageSetType.html#//apple_ref/doc/uid/TP40015170-CH25-SW2
+ */
+export type Idiom =
+	| "appLauncher"
+	| "companionSettings"
+	| "ios-marketing"
+	| "iphone"
+	| "ipad"
+	| "mac"
+	| "notificationCenter"
+	| "quickLook"
+	| "tv"
+	| "universal"
+	| "watch"
+	| "watch-marketing"

package/src/config/apple/asset-catalog-format/image/color-space.ts

@@ -0,0 +1,3 @@
+export type ColorSpace =
+	| "sRGB"
+	| "display-P3"

package/src/config/apple/asset-catalog-format/image/compression-type.ts

@@ -0,0 +1,6 @@
+export type CompressionType =
+	| "automatic"
+	| "gpu-optimized-best"
+	| "gpu-optimized-smallest"
+	| "lossless"
+	| "lossy"

package/src/config/apple/asset-catalog-format/image/display-gamut.ts

@@ -0,0 +1,3 @@
+export type DisplayGamut =
+	| "sRGB"
+	| "display-P3"

package/src/config/apple/asset-catalog-format/image/index.ts

@@ -0,0 +1,6 @@
+// export type * from "./color-space"
+export type * from "./compression-type"
+export type * from "./display-gamut"
+export type * from "./language-direction"
+export type * from "./scale"
+export type * from "./set-type"

package/src/config/apple/asset-catalog-format/image/language-direction.ts

@@ -0,0 +1,3 @@
+export type LanguageDirection =
+	| "left-to-right"
+	| "right-to-left"

package/src/config/apple/asset-catalog-format/image/scale.ts

@@ -0,0 +1,11 @@
+/**
+ * - 1x - Targeted for unscaled displays
+ * - 2x - Targeted for Retina displays
+ * - 3x - Targeted for Retina displays with higher density such as those on the iPhone 6 Plus
+ * 
+ * @see https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format/ImageSetType.html#//apple_ref/doc/uid/TP40015170-CH25-SW3
+ */
+export type Scale =
+	| "1x"
+	| "2x"
+	| "3x"

package/src/config/apple/asset-catalog-format/image/set-type.ts

@@ -0,0 +1,85 @@
+import type {
+	Appearances,
+} from "../appearances"
+
+import type {
+	Idiom,
+} from "../idiom"
+
+// import type {
+// 	ColorSpace,
+// } from "./color-space"
+
+import type {
+	CompressionType,
+} from "./compression-type"
+
+import type {
+	DisplayGamut,
+} from "./display-gamut"
+
+import type {
+	LanguageDirection,
+} from "./language-direction"
+
+import type {
+	Scale,
+} from "./scale"
+
+/**
+ * @see https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format/ImageSetType.html
+ */
+export interface SetType {
+
+	/**
+	 * This is the actual image name and also be used for the .imageset folder name.
+	 * 
+	 * For example, if the name is `FooBar`, a "FooBar.imageset" directory will be created under our Asset Catalogs directory template.
+	 * You can check later at "macos/<Project>/Assets.xcassets/FooBar.imageset".
+	 * 
+	 * Then, you can access use the image in React Native by the name,
+	 * ```tsx
+	 * import { Image } from "react-native"
+	 * 
+	 * export function Component() {
+	 *  return (<>
+	 *   <Image source={{ uri: "FooBar" }}/>
+	 * 
+	 *   // if a namespace is given
+	 *   <Image source={{ uri: "WithNamespace/FooBar" }}/>
+	 *  </>)
+	 * }
+	 * ```
+	 */
+	name: string,
+
+	images: {
+		// In Xcode, it generates "appearances" with array value, even the image is only one appearance variant per image.
+		appearances?: Appearances,
+		// We cannot find "color-space" option in Xcode imageset inspector
+		// "color-space"?: ColorSpace,
+		"compression-type"?: CompressionType,
+		"display-gamut"?: DisplayGamut,
+		/**
+		 * @default "universal"
+		 */
+		idiom?: Idiom,
+		languageDirection?: LanguageDirection,
+		/**
+		 * The filename in the path will be used as the filename property for the `Contents.json`.
+		 * 
+		 * The file itself supported for
+		 * - .heif
+		 * - .heic
+		 * - .jpg
+		 * - .jpeg
+		 * - .png
+		 */
+		path: string,
+		/**
+		 * @default "1x"
+		 */
+		scale?: Scale,
+	}[],
+
+}

package/src/config/apple/asset-catalog-format/index.ts

@@ -0,0 +1,4 @@
+export type * as AppIcon from "./app-icon"
+export type * from "./appearances"
+export type * from "./idiom"
+export type * as Image from "./image"

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

@@ -0,0 +1,13 @@
+import type {
+	AssetCatalogs,
+} from "./asset-catalogs"
+
+export type AssetCatalogsNamespaced =
+	& AssetCatalogs
+	& {
+		/**
+		 * Stated by Xcode
+		 * "The app icon set must be a top level object in the asset."
+		 */
+		[Namespace in string]?: Omit<AssetCatalogs | AssetCatalogsNamespaced, "appiconsets">
+	}

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

@@ -0,0 +1,76 @@
+import type * as AssetCatalogFormat from "./asset-catalog-format"
+
+/**
+ * @see https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format/AssetTypes.html
+ */
+export interface AssetCatalogs {
+
+	/**
+	 * Provide app icons in Asset Catalogs.
+	 * 
+	 * Be aware! This configuration doesn't prevent you to provide incorrect or invalid app icon catalog data.
+	 * You may prefer to use our helper such as `Config.Apple.createOSXappiconset()` to provide correct data.
+	 * 
+	 * If you want to learn it, you can still use Xcode to provide app icon in Asset Catalogs,
+	 * and see how Xcode instructs you to provide correct image size for each platform, along with its variant.
+	 * 
+	 * Based on Apple documentation:
+	 * - iOS, iPadOS, tvOS, and watchOS apps can auto-generate all icon variations from a single 1024×1024 pixel image.
+	 * - For macOS and tvOS, you need to supply an asset for each size. At a minimum, you must provide all OS X icon sizes: 16x16, 32x32, 128x128, 256x256, 512x512, and 1024x1024.
+	 * - For visionOS, you need to supply a single 1024x1024 pixel asset
+	 * 
+	 * @see https://developer.apple.com/documentation/xcode/configuring-your-app-icon
+	 * @see https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format/AppIconType.html
+	 */
+	appiconsets?: AssetCatalogFormat.AppIcon.SetType[],
+
+	/**
+	 * Provide image assets in the {@link https://developer.apple.com/documentation/xcode/managing-assets-with-asset-catalogs|Asset Catalogs}.
+	 * 
+	 * For React Native side, this is useful if you want to bundle your image files by the system, instead of using raw loose file next to the JavaScript bundle, so the system ships only the scale a device needs.
+	 * 
+	 * ```tsx
+	 * // bundo.config.mjs
+	 * export default {
+	 *   macos: {
+	 *     assetCatalogs: {
+	 *       imagesets: [{
+	 *         name: "FooImg",
+	 *         images: [{
+	 *           path: "./path/to/your-image.png",
+	 *           scale: "1x",
+	 *         }, {
+	 *           path: "./path/to/your-image-much-larger-scale.png",
+	 *           scale: "2x",
+	 *         }],
+	 *       }],
+	 * 
+	 *       BarName: {
+	 *         imagesets: [{
+	 *           name: "MyImage",
+	 *           images: [{
+	 *             path: "./path/to/my-image.png"
+	 *           }],
+	 *         }]
+	 *       },
+	 *     }
+	 *   },
+	 * }
+	 * // ---
+	 * 
+	 * // React Native
+	 * import { Image } from "react-native"
+	 * 
+	 * export function Component() {
+	 *  return (<>
+	 *   <Image source={{ uri: "FooImg" }}/>
+	 *   <Image source={{ uri: "BarName/MyImage" }}/>
+	 *  </>)
+	 * }
+	 * ```
+	 * 
+	 * @see https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format/ImageSetType.html
+	 */
+	imagesets?: AssetCatalogFormat.Image.SetType[],
+
+}

package/src/config/apple/create-osx-appiconset.mts

@@ -0,0 +1,135 @@
+import type * as AssetCatalogFormat from "./asset-catalog-format/index.ts"
+
+/**
+ * An helper to provide correct OS X app icon in the catalog.
+ * You can provide a single image for 1024x1024 size in the `images` property.
+ * However, if you want to customize your app’s icon variants, such as to show more or less detail at a specific size, you can provide individual assets for the variations.
+ */
+export function createOSXappiconset(
+	data: {
+		name: string,
+		images: OSXappiconsetImages,
+	},
+) {
+
+	return {
+		name: data.name,
+		images: [
+			{
+				path: data.images["16x16"] || data.images["1024x1024"],
+				size: "16x16",
+				idiom: "mac",
+				scale: "1x",
+			},
+
+			{
+				path: data.images["32x32"] || data.images["1024x1024"],
+				size: "16x16",
+				idiom: "mac",
+				scale: "2x",
+			},
+
+			{
+				path: data.images["32x32"] || data.images["1024x1024"],
+				size: "32x32",
+				idiom: "mac",
+				scale: "1x",
+			},
+
+			{
+				path: data.images["64x64"] || data.images["1024x1024"],
+				size: "32x32",
+				idiom: "mac",
+				scale: "2x",
+			},
+
+			{
+				path: data.images["128x128"] || data.images["1024x1024"],
+				size: "128x128",
+				idiom: "mac",
+				scale: "1x",
+			},
+
+			{
+				path: data.images["256x256"] || data.images["1024x1024"],
+				size: "128x128",
+				idiom: "mac",
+				scale: "2x",
+			},
+
+			{
+				path: data.images["256x256"] || data.images["1024x1024"],
+				size: "256x256",
+				idiom: "mac",
+				scale: "1x",
+			},
+
+			{
+				path: data.images["512x512"] || data.images["1024x1024"],
+				size: "256x256",
+				idiom: "mac",
+				scale: "2x",
+			},
+
+			{
+				path: data.images["512x512"] || data.images["1024x1024"],
+				size: "512x512",
+				idiom: "mac",
+				scale: "1x",
+			},
+
+			// This is an actual valid metadata for App Store.
+			{
+				path: data.images["1024x1024"],
+				size: "512x512",
+				idiom: "mac",
+				scale: "2x",
+			},
+		],
+	} satisfies OSXappiconset
+
+}
+
+type OSXIconSize =
+	| Extract<
+		AssetCatalogFormat.AppIcon.Size,
+		| "16x16"
+		| "32x32"
+		| "128x128"
+		| "256x256"
+		| "512x512"
+		| "1024x1024"
+	>
+	| "64x64" // 2x scale - 32x32
+
+type OSXappiconsetImagesRequired = {
+	[Size in Extract<OSXIconSize, "1024x1024">]: string
+}
+
+type OSXappiconsetImages =
+	& OSXappiconsetImagesRequired
+	& Partial<{
+		[Size in Exclude<OSXIconSize, "1024x1024">]: string
+	}>
+
+interface OSXappiconImageData<Size extends OSXIconSize, Scale extends Exclude<AssetCatalogFormat.Image.Scale, "3x">> extends Pick<AssetCatalogFormat.AppIcon.SetType["images"][0], "path"> {
+	size: Size,
+	idiom: "mac"
+	scale: Scale,
+}
+
+interface OSXappiconset {
+	name: string,
+	images: [
+		OSXappiconImageData<"16x16",	"1x">,
+		OSXappiconImageData<"16x16",	"2x">,
+		OSXappiconImageData<"32x32",	"1x">,
+		OSXappiconImageData<"32x32",	"2x">,
+		OSXappiconImageData<"128x128",	"1x">,
+		OSXappiconImageData<"128x128",	"2x">,
+		OSXappiconImageData<"256x256",	"1x">,
+		OSXappiconImageData<"256x256",	"2x">,
+		OSXappiconImageData<"512x512",	"1x">,
+		OSXappiconImageData<"512x512",	"2x">, // App Store
+	]
+}