bundo-appgen 0.0.1-beta.7

package/src/config/apple/data.ts

@@ -0,0 +1,123 @@
+import type {
+	AssetCatalogs,
+} from "./asset-catalogs"
+
+import type {
+	AssetCatalogsNamespaced,
+} from "./asset-catalogs-namespaced"
+
+import type {
+	InfoPlist,
+} from "./info-plist"
+
+export interface Data {
+
+	/**
+	 * 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.
+	 */
+	appicon?: string,
+
+	/**
+	 * Put compatible files as Asset Catalogs in Apple app.
+	 * 
+	 * Unknown properties will be considered as namespace.
+	 * 
+	 * @see https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format/AssetTypes.html
+	 */
+	assetCatalogs?: AssetCatalogs | AssetCatalogsNamespaced,
+
+	/**
+	 * Build number for your Apple standalone app. Corresponds to `CFBundleVersion` and must match Apple's [specified format](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleversion).
+	 */
+	buildVersion: string,
+
+	bundleIdentifier: string,
+
+	/**
+	 * 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,
+
+	/**
+	 * 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).
+	 * 
+	 * The first locale in the array will take it as the default language for your app. If there is no locales provided, "en" locale will be used.
+	 */
+	locales?: string[],
+
+	/**
+	 * Apple app minimum deployment.
+	 * @default "15.6"
+	 */
+	minimumDeployment?: string,
+
+	/**
+	 * The name of your app as it appears on your home screen as a standalone app.
+	 * It will overrides `name` property in the common config.
+	 * 
+	 * This name will be used also for project name in Xcode with removed spaces and special characters.
+	 */
+	name?: string,
+
+	/**
+	 * 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.
+	 * 
+	 * ```ts
+	 * import type { Config } from "bundo.rn/appgen"
+	 * 
+	 * export default {
+	 * 
+	 *   resources: ["./path/to/your/font-files"],
+	 * 
+	 *   infoPlist: {
+	 *     ATSApplicationFontsPath: "font-files/"
+	 *   },
+	 * 
+	 * } satisfies Config.Data
+	 * ```
+	 */
+	resources?: string[],
+
+	/**
+	 * Create string catalog in your app for localizable string. This is useful if you want to localize your information property list of your app.
+	 * 
+	 * For example, to localize your app display name, you can provide a `InfoPlist` string catalog, with `CFBundleDisplayName` object and its key-value for each locale
+	 * ```ts
+	 * import type { Config } from "bundo.rn/appgen"
+	 * 
+	 * export default {
+	 *   locales: ["en", "de"],
+	 * 
+	 *   stringCatalogs: {
+	 *     InfoPlist: {
+	 *       CFBundleDisplayName: {
+	 *         en: "Hello World",
+	 *         de: "Hallo Welt"
+	 *       },
+	 *     },
+	 *   },
+	 * } satisfies Config.Data
+	 * ```
+	 */
+	stringCatalogs?: {
+		[CatalogName in string]: {
+			[Key in string]: {
+				[Locale in string]: string
+			}
+		}
+	},
+
+	/**
+	 * This corresponds to `CFBundleShortVersionString`, The required format can be found [here](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleshortversionstring)
+	 */
+	version: string,
+
+}

package/src/config/apple/index.mts

@@ -0,0 +1,7 @@
+export type * as AssetCatalogFormat from "./asset-catalog-format/index.ts"
+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"

package/src/config/apple/info-plist-value.ts

@@ -0,0 +1,16 @@
+export type InfoPlistValue =
+	| boolean
+	| string
+	| string[]
+	| DictionaryValue
+
+type DictionaryValue = {
+	[Key in string]:
+		| boolean
+		| string
+		| string[]
+		| DictionaryValue
+		| {
+			[Key2 in string]: DictionaryValue
+		}[]
+}

package/src/config/apple/info-plist.ts

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

package/src/config/data.ts

@@ -0,0 +1,59 @@
+import type * as Apple from "./apple/index.mts"
+
+import type {
+	PluginRegistry,
+} from "./plugin-registry"
+
+export interface Data {
+
+	/**
+	 * Please, only register a plugin in this field if you are really trust the plugin will not doing anything suspicious.
+	 * 
+	 * Plugin in this registry is **letting a plugin to run its function in less restrictive way**, and run after all the restrictive plugins has finished.
+	 * 
+	 * In this field, we let plugins run their functions in with these listed permissions
+	 * 
+	 * - File System : Read and/or write access to these directories:
+	 * 	- _rw_ : <project>/macos
+	 * 	- _rw_ : <project>/windows
+	 * 	- _r_ : node_modules directory lookup relatively from your project and global modules
+	 * 	- _r_ : Its own plugin directory
+	 * - Networking : HTTP request such as `fetch`.
+	 * 
+	 * A plugin can modify some provided template files such as `AppDelegate.swift` without asking your permission.
+	 * It is strongly recommended to check or audit your generated native project.
+	 *  
+	 * Read {@link https://nodejs.org/api/permissions.html|Node.js Permission Model} for more informations.
+	 */
+	lessRestrictivePlugins?: PluginRegistry,
+
+	/**
+	 * The name of your app as it appears on user screen as a standalone app. This value can be overriden in the platform specific config property if some cases the app name is different each platform.
+	 * 
+	 * This name will be used also for project name in Xcode and Visual Studio with removed spaces and special characters.
+	 */
+	name?: string,
+
+	macos?: Apple.Data,
+
+	/**
+	 * Register a plugin for letting the plugin to customize your generated native project, such as adding assets, modifying native code, and other advanced configurations.
+	 * 
+	 * Plugins in this registry will only allow plugins to run their function in restrictive way. A plugin cannot perform a non restricted action such as File System, Networking, Child Process, and other actions in Node.js. See {@link https://nodejs.org/api/permissions.html|Node.js Permission Model}.
+	 * 
+	 * In this field, we let plugins run their functions in with these listed permissions
+	 * 
+	 * - File System - Read only access to these directories and/or files
+	 * 	- <project>/macos/HelloWorld/AppDelegate.swift
+	 * 	- <project>/macos/Podfile
+	 * 	- node_modules directory lookup relatively from your project and global modules
+	 * 	- Its own plugin directory
+	 * 
+	 * A plugin still can modify some provided template files such as `AppDelegate.swift` without asking your permission.
+	 * It is recommended to check or audit your generated native project.
+	 */
+	plugins?: PluginRegistry,
+
+	windows?: unknown, // TODO
+
+}

package/src/config/index.mts

@@ -0,0 +1,4 @@
+export * as Apple from "./apple/index.mts"
+export type * from "./data.ts"
+export type * from "./plugin-item.ts"
+export type * from "./plugin-registry.ts"

package/src/config/plugin-item.ts

@@ -0,0 +1,4 @@
+export type PluginItem =
+	| string
+	| [string]
+	| [string, Record<string, unknown>]

package/src/config/plugin-registry.ts

@@ -0,0 +1,5 @@
+import type {
+	PluginItem,
+} from "./plugin-item"
+
+export type PluginRegistry = PluginItem[]

package/src/index.mts

@@ -0,0 +1,2 @@
+export * as Config from "./config/index.mts"
+export type * as Plugin from "./plugin/index.ts"

package/src/plugin/apple/context.ts

@@ -0,0 +1,68 @@
+import type * as Config from "../../config/index.mts"
+
+import type {
+	Files,
+} from "./files"
+
+// import type {
+// 	PodSpecSourceFromCocoapods,
+// } from "./pod-spec-source-from-cocoapods"
+
+// import type {
+// 	PodSpecSourceFromGit,
+// } from "./pod-spec-source-from-git"
+
+// import type {
+// 	PodSpecSourceFromLocal,
+// } from "./pod-spec-source-from-local"
+
+export interface Context {
+
+	// /**
+	//  * @deprecated
+	//  * It will be replaced by Swift Package Manager in the future.
+	//  * We need to wait until React Native and React Native macOS support Swift Package Manager completely.
+	//  * 
+	//  * @see https://guides.cocoapods.org/using/the-podfile.html
+	//  */
+	// readonly Podfile: {
+	// 	/**
+	// 	 * Add a Pod for client application.
+	// 	 * 
+	// 	 * The Pod array is initially an empty array, but incrementally added and overwritten by other plugins.
+	// 	 */
+	// 	readonly pod: {
+	// 		name: string,
+	// 		source:
+	// 			| PodSpecSourceFromCocoapods
+	// 			| PodSpecSourceFromGit
+	// 			| PodSpecSourceFromLocal
+	// 	}[],
+	// },
+
+	/**
+	 * Read and modify the templated files in raw source text.
+	 * 
+	 * The initial source text will be the client app files.
+	 * If the `appgen` run for the first time or clean run, the source text will be the `bundo-appgen` templates files.
+	 * 
+	 * The source text is incrementally modified by client, other plugins, and yours.
+	 * Be careful about modifying the source text file.
+	 * 
+	 * See the directory `bundo-appgen/templates` in the node_modules
+	 * or in our GitHub repository for your references.
+	 */
+	readonly files: Files,
+
+	/**
+	 * Write a Info Plist for client app.
+	 * 
+	 * The Info Plist object is initially an empty object,
+	 * which means you cannot read what is the current Info Plist configuration from client configuration,
+	 * but incrementally added and overwritten by other plugins.
+	 * 
+	 * The Info Plist result from plugin cannot overwrite an Info Plist item of client app with the same key.
+	 */
+	readonly infoPlist: Config.Apple.InfoPlist,
+
+}

package/src/plugin/apple/files.ts

@@ -0,0 +1,14 @@
+export interface Files {
+	readonly Project: {
+		["AppDelegate.swift"]: string,
+		// add: (
+		// 	filename: string,
+		// 	source: string,
+		// ) => void,
+	},
+	Podfile: string,
+	// add: (
+	// 	filename: string,
+	// 	source: string,
+	// ) => void,
+}

package/src/plugin/apple/index.ts

@@ -0,0 +1,5 @@
+export type * from "./context"
+export type * from "./files"
+export type * from "./pod-spec-source-from-cocoapods"
+export type * from "./pod-spec-source-from-git"
+export type * from "./pod-spec-source-from-local"

package/src/plugin/apple/pod-spec-source-from-cocoapods.ts

@@ -0,0 +1,9 @@
+export interface PodSpecSourceFromCocoapods {
+	operator?:
+		| ">"
+		| ">="
+		| "<"
+		| "<="
+		| "~>",
+	value: string,
+}

package/src/plugin/apple/pod-spec-source-from-git.ts

@@ -0,0 +1,13 @@
+export interface PodSpecSourceFromGit {
+	gitUrl: string,
+	revision?:
+		| {
+			branch: string,
+		}
+		| {
+			tag: string,
+		}
+		| {
+			commit: string,
+		},
+}

package/src/plugin/apple/pod-spec-source-from-local.ts

@@ -0,0 +1,6 @@
+export interface PodSpecSourceFromLocal {
+	/**
+	 * Using the files from a local folder to the machine.
+	 */
+	path: string,
+}

package/src/plugin/context.ts

@@ -0,0 +1,12 @@
+import type * as Apple from "./apple"
+
+export interface Context<PluginParam extends object = object> {
+
+	/**
+	 * An object that user passed to your plugin through plugin registry.
+	 */
+	readonly parameter: PluginParam | undefined,
+
+	readonly macos: Apple.Context,
+
+}

package/src/plugin/index.ts

@@ -0,0 +1,2 @@
+export type * from "./context"
+export type * as Apple from "./apple"