bundo-appgen 0.0.1-beta.7

package/src/_bin/_main/_helpers/platform/get-data.mts

@@ -0,0 +1,48 @@
+import {
+	CompatibilityError,
+} from "./compatibility-error.mts"
+
+import type {
+	Data,
+} from "./data.ts"
+
+import {
+	isCompatible,
+} from "./is-compatible.mts"
+
+let cache: Data
+
+/**
+ * Throw error if this run in non compatible platform or non JavaScript development runtime.
+ */
+export function getData(): Data {
+	if(cache) {
+		return cache
+	}
+
+	if(!isCompatible()) {
+		throw CompatibilityError
+	}
+
+	const isBun = typeof Bun !== "undefined" || !!process.versions.bun
+
+	let developmentRuntime: Data["developmentRuntime"]
+
+	if(isBun) {
+		developmentRuntime = {
+			type: "bun",
+			version: process.versions.bun,
+		}
+	} else {
+		developmentRuntime = {
+			type: "node",
+			version: process.versions.node,
+		}
+	}
+
+	cache = {
+		developmentRuntime,
+	}
+
+	return cache
+}

package/src/_bin/_main/_helpers/platform/index.mts

@@ -0,0 +1,4 @@
+export * from "./compatibility-error.mts"
+export * from "./get-data.mts"
+export * from "./is-compatible.mts"
+export type * from "./data.ts"

package/src/_bin/_main/_helpers/platform/is-compatible.mts

@@ -0,0 +1,30 @@
+import {
+	GlobalVars,
+} from "../../../_global-vars/index.mts"
+
+/**
+ * This is a mono helper if the bundo runs for non compatible platform and JS development runtime.
+ */
+export function isCompatible(): boolean {
+
+	const
+		/**
+		 * We only support macOS and Windows for bundo-appgen,
+		 * unless client is using the option `--force-cross-platform`.
+		 */
+		supportdRNPlatforms: NodeJS.Platform[] =
+			[
+				"darwin",
+				"win32",
+			],
+
+		osCompatible =
+			supportdRNPlatforms.indexOf(process.platform) > -1
+
+	if(!osCompatible) {
+		return GlobalVars.argv.get().forceCrossPlatform
+	}
+
+	return false
+
+}

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/_init-appiconsets.mts

@@ -0,0 +1,223 @@
+import * as node_fs from "node:fs"
+import * as node_path from "node:path"
+
+import type {
+	Config,
+} from "../../../../../index.mts"
+
+import {
+	GlobalVars,
+} from "../../../../_global-vars/index.mts"
+
+import * as MetadataCheck from "./_metadata-check/index.mts"
+
+/**
+ * Similar as the _init-imagesets.mts
+ */
+export function initAppiconsets(
+	appiconsets: Config.Apple.AssetCatalogs["appiconsets"],
+	metadata: {
+		bundleIdentifier: string,
+		projectName: string,
+		platform: "ios" | "macos",
+	},
+) {
+
+	if(!appiconsets?.length) {
+		return
+	}
+
+	const projectDirectory = node_path.dirname(GlobalVars.configFilePath.get())
+
+	const targetDirectory = node_path.join(
+		projectDirectory,
+		"macos",
+		metadata.projectName,
+		"Assets.xcassets",
+	)
+
+	let appiconset_index = -1
+	for(const appiconset of appiconsets) {
+		if(!appiconset.images.length) {
+			break
+		}
+
+		appiconset_index++
+
+		// +++++ create <name>.appiconset directory inside of the target directory
+		const _appiconset_directory = node_path.join(
+			targetDirectory,
+			`${appiconset.name}.appiconset`,
+		)
+		if(!node_fs.existsSync(_appiconset_directory)) {
+			node_fs.mkdirSync(_appiconset_directory)
+		}
+		// -----
+
+		// Intentionally commented the `existingImageFilenames`
+		// At this moment, we are allowing use the same file for different variant
+
+		// store a fast lookup of image filename
+		// const existingImageFilenames: string[] = []
+
+		const contentsJson: CatalogContentsJson = {
+			images: [],
+			info: {
+				version: 1,
+				author: metadata.bundleIdentifier,
+			},
+		}
+
+		let image_index = -1
+		for(const { path: imagePath, ...image } of appiconset.images) {
+			image_index++
+
+			const
+				imageFilePath =
+					node_path.resolve(projectDirectory, imagePath),
+
+				imageMetadata: (typeof contentsJson.images)[0] =
+					{
+						appearances: image.appearances?.[0]
+							? [{
+								appearance: image.appearances[0].appearance,
+								value: image.appearances[0].value,
+							}]
+							: undefined,
+						"display-gamut": image["display-gamut"] || undefined,
+						filename: node_path.basename(imageFilePath),
+						size: image.size,
+						idiom: image.idiom || "universal",
+						scale: image.scale || "1x",
+					}
+
+			{
+				const traceStr = `\`appiconsets[${appiconset_index}].images[${image_index}]\``
+
+				if(!imagePath) {
+					throw new Error(`Not a valid image path in the ${traceStr}.`)
+				}
+
+				if(
+					image.appearances?.length &&
+					!MetadataCheck.appearances(image.appearances)
+				) {
+					throw new Error(`Not a valid appearances in the ${traceStr}.`)
+				}
+
+				if(
+					image["display-gamut"] &&
+					!MetadataCheck.Image.displayGamut(image["display-gamut"])
+				) {
+					throw new Error(`Not a valid image "display-gamut" in the ${traceStr}.`)
+				}
+
+				if(!mapImageSize[image.size]) {
+					throw new Error(`Not a valid image size in the ${traceStr}.`)
+				}
+
+				if(
+					image["idiom"] &&
+					!MetadataCheck.idiom(image.idiom)
+				) {
+					throw new Error(`Not a valid idiom in the ${traceStr}.`)
+				}
+
+				// throw Error if the image is not existed
+				if(!node_fs.existsSync(imageFilePath)) {
+					throw new Error(`Cannot find ${imagePath} relatively from your project directory.`)
+				}
+
+				// throw if the image extname is not supported by Xcode
+				const imageExtname = node_path.extname(imageFilePath)
+				if(imageExtname !== ".png") {
+					throw new Error(`${imageExtname} file is not supported in Asset Catalogs.`)
+				}
+
+				// if(existingImageFilenames.indexOf(imageMetadata.filename) > -1) {
+				// 	throw new Error("Cannot use the same image file for different variant.")
+				// }
+
+				// It has different filename,
+				// but it is prohibited to use same variant
+				if(contentsJson.images.length) {
+					for(const existingImageMetadata of contentsJson.images) {
+						/**
+						 * Fix me.
+						 * This is just a lazy comparison.
+						 */
+						const isSimilar =
+							JSON.stringify(existingImageMetadata) ===
+							JSON.stringify(imageMetadata)
+
+						if(isSimilar) {
+							throw new Error("Cannot use multiple images with same variant.")
+						}
+					}
+				}
+			}
+
+			// Copy the image file
+			// place it to the `Assets.xcassets/<namespace?>/<name>.imageset/<imageFilename>
+			node_fs.copyFileSync(
+				imageFilePath,
+				node_path.join(_appiconset_directory, imageMetadata.filename),
+			)
+
+			// add the image data to the Contents.json
+			contentsJson.images.push({ ...imageMetadata })
+
+			// existingImageFilenames.push(imageMetadata.filename)
+		}
+
+		// Create Contents.json file inside of <name>.imageset directory
+		node_fs.writeFileSync(
+			node_path.join(_appiconset_directory, "Contents.json"),
+			JSON.stringify(
+				contentsJson,
+				null,
+				2,
+			),
+			"utf8",
+		)
+	}
+
+}
+
+/**
+ * An actual Xcode Contents.json for an asset catalog
+ */
+interface CatalogContentsJson {
+	images: (Omit<Config.Apple.AssetCatalogFormat.AppIcon.SetType["images"][0], "path"> & {
+		filename: string,
+	})[],
+	info: {
+		version: number,
+		author: string,
+	},
+}
+
+const
+	/**
+	 * This is just for a fast check if user input about the size is wrong
+	 */
+	mapImageSize: Record<Config.Apple.AssetCatalogFormat.AppIcon.Size, 1> =
+		{
+			"16x16": 1,
+			"20x20": 1,
+			"24x24": 1,
+			"27.5x27.5": 1,
+			"29x29": 1,
+			"32x32": 1,
+			"40x40": 1,
+			"44x44": 1,
+			"60x60": 1,
+			"76x76": 1,
+			"83.5x83.5": 1,
+			"86x86": 1,
+			"98x98": 1,
+			"128x128": 1,
+			"256x256": 1,
+			"512x512": 1,
+			"1024x1024": 1,
+		}

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/_init-imagesets.mts

@@ -0,0 +1,241 @@
+import * as node_fs from "node:fs"
+import * as node_path from "node:path"
+
+import type {
+	Config,
+} from "../../../../../index.mts"
+
+import {
+	GlobalVars,
+} from "../../../../_global-vars/index.mts"
+
+import * as MetadataCheck from "./_metadata-check/index.mts"
+
+export function initImagesets(
+	imagesets: Config.Apple.AssetCatalogs["imagesets"],
+	metadata: {
+		bundleIdentifier: string,
+		namespace?: string,
+		projectName: string,
+	},
+) {
+
+	if(!imagesets?.length) {
+		return
+	}
+
+	const projectDirectory = node_path.dirname(GlobalVars.configFilePath.get())
+
+	let targetDirectory = node_path.join(
+		projectDirectory,
+		"macos",
+		metadata.projectName,
+		"Assets.xcassets",
+	)
+
+	if(metadata.namespace) {
+		// append a namespace directory after Assets.xcassets
+		targetDirectory = node_path.join(targetDirectory, metadata.namespace)
+
+		// Create a namespace directory inside of "Assets.xcassets"
+		node_fs.mkdirSync(
+			targetDirectory,
+			{
+				recursive: true,
+			},
+		)
+
+		// create Contents.json in the namespace directory
+		node_fs.writeFileSync(
+			node_path.join(targetDirectory, "Contents.json"),
+			JSON.stringify({
+				info: {
+					version: 1,
+					author: metadata.bundleIdentifier,
+				},
+				properties: {
+					"provides-namespace": true,
+				},
+			}, null, 2),
+			"utf8",
+		)
+	}
+
+	let imageset_index = -1
+	for(const imageset of imagesets) {
+		if(!imageset.images.length) {
+			break
+		}
+
+		imageset_index++
+
+		// +++++ create <name>.imageset directory inside of the target directory
+		const _imageset_directory = node_path.join(
+			targetDirectory,
+			`${imageset.name}.imageset`,
+		)
+		if(!node_fs.existsSync(_imageset_directory)) {
+			node_fs.mkdirSync(_imageset_directory)
+		}
+		// -----
+
+		// store a fast lookup of image filename
+		const existingImageFilenames: string[] = []
+
+		const contentsJson: CatalogContentsJson = {
+			images: [],
+			info: {
+				version: 1,
+				author: metadata.bundleIdentifier,
+			},
+		}
+
+		let image_index = -1
+		for(const { path: imagePath, ...image } of imageset.images) {
+			image_index++
+
+			if(
+				!imagePath
+			) {
+				throw new Error("Not a valid image metadata object in the `imagesets[number].images[number]`")
+			}
+
+			const
+				imageFilePath =
+					node_path.resolve(projectDirectory, imagePath),
+
+				imageMetadata: (typeof contentsJson.images)[0] =
+					{
+						appearances: image.appearances?.[0]
+							// intentional for comparison with JSON.stringify
+							? [{
+								appearance: image.appearances[0].appearance,
+								value: image.appearances[0].value,
+							}]
+							: undefined,
+						"compression-type": image["compression-type"] || undefined,
+						"display-gamut": image["display-gamut"] || undefined,
+						filename: node_path.basename(imageFilePath),
+						idiom: image.idiom || "universal",
+						languageDirection: image.languageDirection,
+						scale: image.scale || "1x",
+					}
+
+			{
+				const traceStr = `\`appiconsets[${imageset_index}].images[${image_index}]\``
+
+				if(!imagePath) {
+					throw new Error(`Not a valid image path in the ${traceStr}.`)
+				}
+
+				if(
+					image.appearances?.length &&
+					!MetadataCheck.appearances(image.appearances)
+				) {
+					throw new Error(`Not a valid appearances in the ${traceStr}.`)
+				}
+
+				if(
+					image["compression-type"] &&
+					!MetadataCheck.Image.compressionType(image["compression-type"])
+				) {
+					throw new Error(`Not a valid image compression-type in the ${traceStr}.`)
+				}
+
+				if(
+					image["display-gamut"] &&
+					!MetadataCheck.Image.displayGamut(image["display-gamut"])
+				) {
+					throw new Error(`Not a valid image "display-gamut" in the ${traceStr}.`)
+				}
+
+				if(
+					image["idiom"] &&
+					!MetadataCheck.idiom(image.idiom)
+				) {
+					throw new Error(`Not a valid idiom in the ${traceStr}.`)
+				}
+
+				if(
+					image.languageDirection &&
+					!MetadataCheck.Image.languageDirection(image.languageDirection)
+				) {
+					throw new Error(`Not a valid image language direction in the ${traceStr}.`)
+				}
+
+				// throw Error if the image is not existed
+				if(!node_fs.existsSync(imageFilePath)) {
+					throw new Error(`Cannot find ${imagePath} relatively from your project directory.`)
+				}
+
+				// throw if the image extname is not supported by Xcode
+				const imageExtname = node_path.extname(imageFilePath)
+				if(supportedImageExts.indexOf(imageExtname) == -1) {
+					throw new Error(`${imageExtname} file is not supported in Asset Catalogs.`)
+				}
+
+				if(existingImageFilenames.indexOf(imageMetadata.filename) > -1) {
+					throw new Error("Cannot use the same image file for different variant.")
+				}
+
+				// It has different filename,
+				// but it is prohibited to use same variant
+				if(contentsJson.images.length) {
+					for(const existingImageMetadata of contentsJson.images) {
+						const isSimilar =
+							JSON.stringify(existingImageMetadata) ===
+							JSON.stringify(imageMetadata)
+
+						if(isSimilar) {
+							throw new Error("Cannot use multiple images with same variant.")
+						}
+					}
+				}
+			}
+
+
+			// Copy the image file
+			// place it to the `Assets.xcassets/<namespace?>/<name>.imageset/<imageFilename>
+			node_fs.copyFileSync(
+				imageFilePath,
+				node_path.join(_imageset_directory, imageMetadata.filename),
+			)
+
+			// add the image data to the Contents.json
+			contentsJson.images.push({ ...imageMetadata })
+		}
+
+		// Create Contents.json file inside of <name>.imageset directory
+		node_fs.writeFileSync(
+			node_path.join(_imageset_directory, "Contents.json"),
+			JSON.stringify(
+				contentsJson,
+				null,
+				2,
+			),
+			"utf8",
+		)
+	}
+
+}
+
+/**
+ * An actual Xcode Contents.json for an asset catalog
+ */
+interface CatalogContentsJson {
+	images: (Omit<Config.Apple.AssetCatalogFormat.Image.SetType["images"][0], "path"> & {
+		filename: string,
+	})[],
+	info: {
+		version: number,
+		author: string,
+	},
+}
+
+const supportedImageExts = [
+	".heic",
+	".heif",
+	".jpg",
+	".jpeg",
+	".png",
+]

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/_metadata-check/appearances.mts

@@ -0,0 +1,24 @@
+import type * as Config from "../../../../../../config/index.mts"
+
+export function appearances(value: Array<unknown>): boolean {
+	if(!Array.isArray(value) || value.length != 1 || !value[0] || typeof value[0] != "object") {
+		return false
+	}
+
+	const it = value[0] as Record<string, string>
+
+	return !!__appearance[it.appearance as never] && !!__value[it.value as never]
+}
+
+const
+	__appearance: Record<Config.Apple.AssetCatalogFormat.Appearances[0]["appearance"], 1> =
+		{
+			contrast: 1,
+			luminosity: 1,
+		},
+
+	__value: Record<Config.Apple.AssetCatalogFormat.Appearances[0]["value"], 1> =
+		{
+			dark: 1,
+			light: 1,
+		}

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/_metadata-check/idiom.mts

@@ -0,0 +1,22 @@
+import type * as Config from "../../../../../../config/index.mts"
+
+export function idiom(value: string): boolean {
+	return !!value && !!__idiom[value as never]
+}
+
+const
+	__idiom: Record<Config.Apple.AssetCatalogFormat.Idiom, 1> =
+		{
+			"ios-marketing": 1,
+			"watch-marketing": 1,
+			appLauncher: 1,
+			companionSettings: 1,
+			ipad: 1,
+			iphone: 1,
+			mac: 1,
+			notificationCenter: 1,
+			quickLook: 1,
+			tv: 1,
+			universal: 1,
+			watch: 1,
+		}

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/_metadata-check/image/compression-type.mts

@@ -0,0 +1,15 @@
+import type * as Config from "../../../../../../../config/index.mts"
+
+export function compressionType(value: string): boolean {
+	return !!value && !!__compressionType[value as never]
+}
+
+const
+	__compressionType: Record<Config.Apple.AssetCatalogFormat.Image.CompressionType, 1> =
+		{
+			"gpu-optimized-best": 1,
+			"gpu-optimized-smallest": 1,
+			automatic: 1,
+			lossless: 1,
+			lossy: 1,
+		}

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/_metadata-check/image/display-gamut.mts

@@ -0,0 +1,12 @@
+import type * as Config from "../../../../../../../config/index.mts"
+
+export function displayGamut(value: string): boolean {
+	return !!value && !!displayGamuts[value as never]
+}
+
+const
+	displayGamuts: Record<Config.Apple.AssetCatalogFormat.Image.DisplayGamut, 1> =
+		{
+			"display-P3": 1,
+			sRGB: 1,
+		}

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/_metadata-check/image/index.mts

@@ -0,0 +1,3 @@
+export * from "./compression-type.mts"
+export * from "./display-gamut.mts"
+export * from "./language-direction.mts"

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/_metadata-check/image/language-direction.mts

@@ -0,0 +1,12 @@
+import type * as Config from "../../../../../../../config/index.mts"
+
+export function languageDirection(value: string): boolean {
+	return !!value && !!__languageDirection[value as never]
+}
+
+const
+	__languageDirection: Record<Config.Apple.AssetCatalogFormat.Image.LanguageDirection, 1> =
+		{
+			"left-to-right": 1,
+			"right-to-left": 1,
+		}

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/_metadata-check/index.mts

@@ -0,0 +1,3 @@
+export * from "./appearances.mts"
+export * from "./idiom.mts"
+export * as Image from "./image/index.mts"

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/create-asset-catalogs.mts

@@ -0,0 +1,54 @@
+import type {
+	Config,
+} from "../../../../../index.mts"
+
+import {
+	initAppiconsets,
+} from "./_init-appiconsets.mts"
+
+import {
+	initImagesets,
+} from "./_init-imagesets.mts"
+
+export function createAssetCatalogs(
+	assetCatalogs: Config.Apple.Data["assetCatalogs"],
+	metadata: {
+		bundleIdentifier: string,
+		namespace?: string,
+		platform: "macos" | "ios",
+		projectName: string,
+	},
+) {
+	if(!assetCatalogs) {
+		return
+	}
+
+	for(const _key of Object.keys(assetCatalogs)) {
+		const key = _key as keyof typeof assetCatalogs
+
+		if(key == "imagesets") {
+			initImagesets(
+				assetCatalogs.imagesets,
+				metadata,
+			)
+		} else if(key == "appiconsets") {
+			initAppiconsets(
+				assetCatalogs.appiconsets,
+				metadata,
+			)
+		} else {
+			// key is namespace
+			const namespacedCatalogs = assetCatalogs[key] as unknown as Config.Apple.AssetCatalogs
+
+			if(namespacedCatalogs && Object.keys(namespacedCatalogs).length) {
+				createAssetCatalogs(
+					namespacedCatalogs,
+					{
+						...metadata,
+						namespace: key,
+					},
+				)
+			}
+		}
+	}
+}

package/src/_bin/_main/_init-template/_init-apple/_create-asset-catalogs/index.mts

@@ -0,0 +1 @@
+export * from "./create-asset-catalogs.mts"