@brandingbrand/code-core - npm Package Compare versions

Comparing version 0.0.12 to 0.0.13

dist/executors/clean/platform/native.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { CleanOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { CleanOptions } from "../../../types/Options";
 export declare const execute: (options: CleanOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/clean/post/logger.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { CleanOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { CleanOptions } from "../../../types/Options";
 export declare const execute: (options: CleanOptions, config: Config) => Promise<void>;

dist/executors/clean/pre/env.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { CleanOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { CleanOptions } from "../../../types/Options";
 export declare const execute: (options: CleanOptions, config: Config) => Promise<void>;

dist/executors/clean/pre/logger.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { CleanOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { CleanOptions } from "../../../types/Options";
 export declare const execute: (options: CleanOptions, config: Config) => Promise<void>;

dist/executors/init/platform/clean.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { CleanOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { CleanOptions } from "../../../types/Options";
 export declare const execute: (options: CleanOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/platform/cocoapods.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/platform/entitlements.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/platform/frameworks.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/platform/manifest.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/platform/packages.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/platform/plist.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/platform/plugins.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/platform/strings.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/platform/styles.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/platform/template.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/init/post/logger.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config<unknown>) => Promise<void>;

dist/executors/init/post/summary.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config) => Promise<void>;

dist/executors/init/pre/env.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config<unknown>) => Promise<void>;

dist/executors/init/pre/logger.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config<unknown>) => Promise<void>;

dist/executors/init/pre/normalize.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config<unknown>) => Promise<void>;

dist/executors/init/pre/tsc.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { InitOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { InitOptions } from "../../../types/Options";
 export declare const execute: (options: InitOptions, config: Config<unknown>) => Promise<void>;

dist/executors/keys/platform/native.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { KeysOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { KeysOptions } from "../../../types/Options";
 export declare const execute: (options: KeysOptions, config: Config) => {
@@ -4,0 +4,0 @@ ios: () => Promise<void>;

dist/executors/keys/post/logger.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { KeysOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { KeysOptions } from "../../../types/Options";
 export declare const execute: (options: KeysOptions, config: Config) => Promise<void>;

dist/executors/keys/pre/logger.d.ts

@@ -1,3 +0,3 @@
-import type { Config } from "../../../types/types";
-import type { KeysOptions } from "../../../types/options";
+import type { Config } from "../../../types/Config";
+import type { KeysOptions } from "../../../types/Options";
 export declare const execute: (options: KeysOptions, config: Config) => Promise<void>;

dist/index.d.ts

@@ -0,5 +1,3 @@
+export * from "./types";
+export * from "./utils";
 export * from "./executors";
-export * from "./utils";
-export * from "./types/types";
-export * as android from "./types/android";
-export * as ios from "./types/ios";

dist/types/android/AndroidManifest.d.ts

@@ -81,2 +81,3 @@ export declare type StringBoolean = "true" | "false";
     "android:usesCleartextTraffic"?: StringBoolean;
+    "android:networkSecurityConfig"?: string;
     [key: string]: string | undefined;
@@ -89,2 +90,3 @@ };
     "android:windowSoftInputMode"?: string | "stateUnspecified" | "stateUnchanged" | "stateHidden" | "stateAlwaysHidden" | "stateVisible" | "stateAlwaysVisible" | "adjustUnspecified" | "adjustResize" | "adjustPan";
+    "android:screenOrientation": "unspecified" | "behind" | "landscape" | "portrait" | "reverseLandscape" | "reversePortrait" | "sensorLandscape" | "sensorPortrait" | "userLandscape" | "userPortrait" | "sensor" | "fullSensor" | "nosensor" | "user" | "fullUser" | "locked";
     [key: string]: string | undefined;
@@ -91,0 +93,0 @@ };

dist/types/android/index.d.ts

@@ -0,3 +1,5 @@
+export * as ColorsType from "./Colors";
 export * as StylesType from "./Styles";
 export * as StringsType from "./Strings";
 export * as AndroidManifestType from "./AndroidManifest";
+export * as NetworkSecurityConfigType from "./NetworkSecurityConfig";

dist/utils/android/index.d.ts

@@ -0,3 +1,5 @@
+export * as colors from "./colors";
 export * as styles from "./styles";
 export * as strings from "./strings";
 export * as manifest from "./manifest";
+export * as networkSecurityConfig from "./network-security-config";

dist/utils/android/manifest.d.ts

 import type { AndroidManifestType } from "../../types/android";
+/**
+ * Updates the attributes of the manifest element in AndroidManifest.xml
+ *
+ * @param {Partial<AndroidManifestType.AndroidManifestAttributes>} attributes - An object containing the attributes to update
+ * @returns {void}
+ */
 export declare const setManifestAttributes: (attributes: Partial<AndroidManifestType.AndroidManifestAttributes>) => Promise<void>;
+/**
+ * Updates the attributes of the application element in AndroidManifest.xml
+ *
+ * @param {Partial<AndroidManifestType.ManifestApplicationAttributes>} attrbutes - An object containing the attributes to update
+ * @param {string} [applicationName='.MainApplication'] - Name of the application element to update
+ * @returns {void}
+ */
 export declare const setApplicationAttributes: (attrbutes: Partial<AndroidManifestType.ManifestApplicationAttributes>, applicationName?: string) => Promise<void>;
+/**
+ * Sets attributes of the specified activity in the AndroidManifest.xml file.
+ *
+ * @param {Partial<AndroidManifestType.ManifestActivityAttributes>} attributes - The attributes to set.
+ * @param {string} [applicationName='.MainApplication'] - The name of the application element.
+ * @param {string} [activityName='.MainActivity'] - The name of the activity element.
+ */
 export declare const setActivityAttributes: (attrbutes: Partial<AndroidManifestType.ManifestActivityAttributes>, applicationName?: string, activityName?: string) => Promise<void>;
+/**
+ * Adds elements to the specified application in the AndroidManifest.xml file.
+ *
+ * @param {AndroidManifestType.ManifestApplicationElements} elements - The elements to add.
+ * @param {string} [applicationName='.MainApplication'] - The name of the application element.
+ */
 export declare const addApplicationEelements: (elements: AndroidManifestType.ManifestApplicationElements, applicationName?: string) => Promise<void>;
+/**
+ * Adds elements to the specified activity in the AndroidManifest.xml file.
+ *
+ * @param {AndroidManifestType.ManifestActivityElements} elements - The elements to add.
+ * @param {string} [applicationName='.MainApplication'] - The name of the application element.
+ * @param {string} [activityName='.MainActivity'] - The name of the activity element.
+ */
 export declare const addActivityElements: (elements: AndroidManifestType.ManifestActivityElements, applicationName?: string, activityName?: string) => Promise<void>;
+/**
+ * Adds elements to the AndroidManifest.xml file.
+ *
+ * @param {AndroidManifestType.AndroidManifestElements} elements - The elements to add.
+ */
 export declare const addManifestElements: (elements: AndroidManifestType.AndroidManifestElements) => Promise<void>;

dist/utils/android/strings.d.ts

 import type { StringsType } from "../../types/android";
+/**
+ * Adds new resources elements to the XML object.
+ *
+ * @param elements - The elements to add to the XML object.
+ */
 export declare const addResourcesElements: (elements: StringsType.StringsElements) => Promise<void>;
+/**
+ * Adds new items to an existing string array element.
+ *
+ * @param elements - The elements to add to the string array element.
+ * @param name - The name of the string array element.
+ */
 export declare const addStringArrayElements: (elements: StringsType.StringArrayElements, name: string) => Promise<void>;
+/**
+ * Adds new items to an existing plurals element.
+ *
+ * @param elements - The elements to add to the plurals element.
+ * @param name - The name of the plurals element.
+ */
 export declare const addPluralsElements: (elements: StringsType.PluralsElements, name: string) => Promise<void>;

dist/utils/android/styles.d.ts

 import type { StylesType } from "../../types/android";
+/**
+ * Sets the specified attributes for the AppTheme style.
+ *
+ * @param {Partial<StylesType.StyleAttributes>} attributes - The attributes to set.
+ * @returns {void}
+ */
 export declare const setAppThemeAttributes: (attributes: Partial<StylesType.StyleAttributes>) => Promise<void>;
+/**
+ * Adds the specified elements to the AppTheme style.
+ *
+ * @param {StylesType.StyleElements} elements - The elements to add.
+ * @returns {void}
+ */
 export declare const addAppThemeElements: (elements: StylesType.StyleElements) => Promise<void>;

dist/utils/env.d.ts

@@ -1,2 +0,24 @@
-export declare const get: () => Promise<any>;
-export declare const set: (_config: any) => void;
+/**
+ * Object to hold the most recent updated env configuration.
+ */
+declare const _default: {
+    /**
+     * Private up-to-date env configuration.
+     */
+    _env: any;
+    /**
+     * Getter to retrieve private up-to-date copy of env configuration
+     * or attempt to require to retrieve the env configruation via file
+     * or return empty object.
+     *
+     * @return {any} The env configuration.
+     */
+    readonly get: any;
+    /**
+     * Setter to update the private env configuration.
+     *
+     * @param {any} env Updated env configuration.
+     */
+    set: any;
+};
+export default _default;

dist/utils/errors/Warning.d.ts

@@ -0,4 +1,16 @@
+/**
+ * A custom error class representing a warning.
+ *
+ * @class Warning
+ * @extends {Error}
+ */
 declare class Warning extends Error {
+    /**
+     * Creates an instance of Warning.
+     *
+     * @param {string} message The warning message.
+     * @memberof Warning
+     */
     constructor(message: string);
 }
 export default Warning;

dist/utils/exec-async.d.ts

@@ -0,1 +1,7 @@
+/**
+ * Executes a command asynchronously using child_process.exec.
+ *
+ * @param {string} command - The command to execute.
+ * @returns {Promise<string>} - A promise that resolves with the stdout of the executed command if successful, otherwise rejects with the error.
+ */
 export declare const async: (command: string) => Promise<unknown>;

dist/utils/fs.d.ts

 import fse from "fs-extra";
+/**
+ * A proxied version of the fs-extra module.
+ *
+ * @type {*} The proxied version of the fs-extra module.
+ */
 declare const _default: typeof fse;
 export default _default;

dist/utils/index.d.ts

@@ -5,3 +5,2 @@ export * from "./ios";
 export * as os from "./os";
-export * as env from "./env";
 export * as fsk from "./fsk";
@@ -16,4 +15,6 @@ export * as path from "./path";
 export * as summary from "./summary";
+export * as writable from "./writable";
+export { default as env } from "./env";
 export * as platforms from "./platforms";
 export * as rimraf from "./rimraf-async";
 export * as packageManager from "./package-manager";

dist/utils/ios/info-plist.d.ts

@@ -1,5 +0,26 @@
-import type { Config } from "../../types/types";
+import type { Config } from "../../types/Config";
 import { InfoPlistType } from "../../types/ios";
+/**
+ * Executes a callback with the parsed Info.plist file as an object.
+ *
+ * @param {InfoPlistCallback} callback - The callback to execute.
+ * @param {Config} config - The configuration object for the app.
+ * @returns {Promise} - A Promise that resolves with the updated Info.plist file as an object.
+ */
 export declare const withInfoPlist: (callback: (plist: InfoPlistType.InfoPlist) => InfoPlistType.InfoPlist, config: Config) => Promise<void>;
+/**
+ * Sets a URL scheme in the Info.plist file.
+ *
+ * @param {string} urlScheme - The URL scheme to set.
+ * @param {Config} config - The configuration object for the app.
+ * @returns {Promise} - A Promise that resolves with the updated Info.plist file as an object.
+ */
 export declare const setUrlScheme: (urlScheme: string, config: Config) => Promise<void>;
+/**
+ * Sets the entire Info.plist file.
+ *
+ * @param {Object} data - The data to set.
+ * @param {Config} config - The configuration object for the app.
+ * @returns {Promise} - A Promise that resolves with the updated Info.plist file as an object.
+ */
 export declare const setPlist: (data: Record<string, unknown>, config: Config) => Promise<void>;

dist/utils/ios/plist.d.ts

@@ -0,1 +1,9 @@
+/**
+ * Asynchronously modifies a property of a plist file at the given path.
+ *
+ * @template T - The type of the plist file contents.
+ * @param {string} path - The path to the plist file.
+ * @param {(plist: T) => T} callback - The function that modifies the plist contents.
+ * @returns {Promise<void>} A promise that resolves when the modified plist has been written to disk.
+ */
 export declare const withPlist: <T>(path: string, callback: (plist: T) => T) => Promise<void>;

dist/utils/logger.d.ts

@@ -0,1 +1,28 @@
+/**
+ * A collection of ANSI color codes for console logging.
+ *
+ * @property {string} Reset - The ANSI code for resetting console color.
+ * @property {string} Bright - The ANSI code for brightening console color.
+ * @property {string} Dim - The ANSI code for dimming console color.
+ * @property {string} Underscore - The ANSI code for underlining console text.
+ * @property {string} Blink - The ANSI code for blinking console text.
+ * @property {string} Reverse - The ANSI code for reversing the foreground and background colors of console text.
+ * @property {string} Hidden - The ANSI code for hiding console text.
+ * @property {string} FgBlack - The ANSI code for setting the foreground color to black.
+ * @property {string} FgRed - The ANSI code for setting the foreground color to red.
+ * @property {string} FgGreen - The ANSI code for setting the foreground color to green.
+ * @property {string} FgYellow - The ANSI code for setting the foreground color to yellow.
+ * @property {string} FgBlue - The ANSI code for setting the foreground color to blue.
+ * @property {string} FgMagenta - The ANSI code for setting the foreground color to magenta.
+ * @property {string} FgCyan - The ANSI code for setting the foreground color to cyan.
+ * @property {string} FgWhite - The ANSI code for setting the foreground color to white.
+ * @property {string} BgBlack - The ANSI code for setting the background color to black.
+ * @property {string} BgRed - The ANSI code for setting the background color to red.
+ * @property {string} BgGreen - The ANSI code for setting the background color to green.
+ * @property {string} BgYellow - The ANSI code for setting the background color to yellow.
+ * @property {string} BgBlue - The ANSI code for setting the background color to blue.
+ * @property {string} BgMagenta - The ANSI code for setting the background color to magenta.
+ * @property {string} BgCyan - The ANSI code for setting the background color to cyan.
+ * @property {string} BgWhite - The ANSI code for setting the background color to white.
+ */
 export declare const colors: {
@@ -26,5 +53,30 @@ Reset: string;
 };
+/**
+ * Logs the given messages with type "info".
+ *
+ * @param {...string} messages - The messages to log.
+ * @returns {void}
+ */
 export declare const logInfo: (...messages: string[]) => void;
+/**
+ * Logs the given messages with type "error".
+ *
+ * @param {...string} messages - The messages to log.
+ * @returns {void}
+ */
 export declare const logError: (...messages: string[]) => void;
+/**
+ * Logs the given messages with type "warn".
+ *
+ * @param {...string} messages - The messages to log.
+ * @returns {void}
+ */
 export declare const logWarn: (...messages: string[]) => void;
+/**
+ * Returns a function that takes an option name and returns the value
+ * of the corresponding command line option from the given arguments.
+ *
+ * @param {string[]} argv - The command line arguments.
+ * @returns {(optionName: string) => string|undefined} - The option value.
+ */
 export declare const getCmdOption: (argv: string[]) => (a: string) => string | undefined;

dist/utils/os.d.ts

 /**
- * Whether or not the current platform is a Linux platform.
+ * Indicates whether the current platform is Linux.
+ * @type {boolean}
  */
 export declare const linux: boolean;
+/**
+ * Indicates whether the current platform is Windows.
+ * @type {boolean}
+ */
 export declare const win: boolean;

dist/utils/package-manager.d.ts

@@ -0,2 +1,18 @@
+/**
+ * Runs the specified callback with the appropriate package manager and run command based on which lock file exists.
+ *
+ * @param {function} callback - The function to run with the package manager and run command.
+ * @param {function} callback.packageManager - The package manager to use (either "npm" or "yarn").
+ * @param {function} callback.runCommand - The run command to use with npm (empty string) or yarn ("run").
+ * @returns {Promise<void>} - A Promise that resolves when the callback function has completed.
+ */
 export declare const withPackageManager: (callback: (packageManager: "npm" | "yarn", runCommand: string) => Promise<void>) => Promise<void>;
+/**
+ * Runs the specified callback with the version of the specified package, using the appropriate package manager.
+ *
+ * @param {string} packageName - The name of the package to get the version for.
+ * @param {function} callback - The function to run with the package version.
+ * @param {function} callback.packageVersion - The version of the package (or undefined if it is not installed).
+ * @returns {Promise<void>} - A Promise that resolves when the callback function has completed.
+ */
 export declare const withVersion: (packageName: string, callback: (packageVersion: string | undefined) => Promise<void>) => Promise<void>;

dist/utils/package-managers/npm/constants.d.ts

@@ -0,1 +1,7 @@
+/**
+ * The filename of the lockfile used by Npm.
+ *
+ * @constant
+ * @type {string}
+ */
 export declare const LOCK_FILE = "package-lock.json";

dist/utils/package-managers/npm/list.d.ts

@@ -1,2 +0,17 @@
-import type { List } from "../../../types/Npm";
+import type { Dependencies, List } from "../../../types/Npm";
+/**
+ * Returns the version of a package in an Npm list object.
+ *
+ * @param {string} packageName - The name of the package to retrieve the version for.
+ * @param {List} json - The Npm list object to search for the package.
+ * @returns {string|undefined} - The version of the package, or undefined if it is not found.
+ */
 export declare const version: (packageName: string, json: List) => string | undefined;
+/**
+ * Helper function to recursively search for a package in the dependencies object.
+ *
+ * @param {string} packageName - The name of the package to retrieve the version for.
+ * @param {Dependencies} dependencies - The dependencies object to search for the package.
+ * @returns {string|undefined} - The version of the package, or undefined if it is not found.
+ */
+export declare const rVersion: (packageName: string, dependencies: Dependencies) => string | undefined;

dist/utils/package-managers/yarn/constants.d.ts

@@ -0,1 +1,7 @@
+/**
+ * The filename of the lockfile used by Yarn.
+ *
+ * @constant
+ * @type {string}
+ */
 export declare const LOCK_FILE = "yarn.lock";

dist/utils/package-managers/yarn/list.d.ts

 import type { List } from "../../../types/Yarn";
+/**
+ * Returns the version of a given package in a Yarn lock file.
+ *
+ * @param {string} packageName - The name of the package to search for.
+ * @param {List} json - The parsed Yarn lock file in JSON format.
+ * @returns {string|undefined} - The version of the package or undefined if not found.
+ */
 export declare const version: (packageName: string, json: List) => string | undefined;

dist/utils/path.d.ts

@@ -1,2 +0,2 @@
-import type { Config } from "../types/types";
+import type { Config } from "../types/Config";
 export { basename, extname, normalize, resolve, sep } from "path";
@@ -43,3 +43,7 @@ export declare const app: {
     stylesPath: () => string;
+    colorsPath: () => string;
     fastfilePath: () => string;
 };
+export declare const hoist: {
+    resolve: (...paths: string[]) => string;
+};

dist/utils/platforms.d.ts

@@ -0,1 +1,7 @@
+/**
+ * Returns an array of strings representing the platforms based on the provided options.
+ *
+ * @param {string} options - The options provided to get platforms.
+ * @returns {Array<string>} An array of strings representing the platforms.
+ */
 export declare const get: (options: "ios" | "android" | "native") => Array<"ios" | "android">;

dist/utils/plugins.d.ts

@@ -0,2 +1,7 @@
+/**
+ * Retrieves the list of plugins used in the project, if available.
+ *
+ * @returns {string[]} An array of plugin names.
+ */
 export declare const get: () => string[];
 export declare const normalize: (bundleName: string) => string;

dist/utils/queue.d.ts

@@ -0,1 +1,6 @@
+/**
+ * Enqueue a function call with the provided arguments to the fastq promise queue.
+ *
+ * @param {...unknown[]} args - The arguments to pass to the function.
+ */
 export declare const enqueue: (...args: unknown[]) => Promise<any>;

dist/utils/rimraf-async.d.ts

 import rimraf from "rimraf";
+/**
+ * Asynchronously removes files and directories using `rimraf`.
+ *
+ * @param {string} path - The path to remove.
+ * @param {rimraf.Options} options - The options to pass to `rimraf`.
+ * @returns {Promise<void>} A promise that resolves when the removal is complete.
+ */
 export declare const async: (path: string, options: rimraf.Options) => Promise<void>;

dist/utils/spinner.d.ts

@@ -0,2 +1,13 @@
+/**
+ * Start a spinner in stderr with the given text.
+ *
+ * @param {string} text - The text to be displayed with the spinner.
+ * @returns {void}
+ */
 export declare const start: (text: string) => void;
+/**
+ * Stop the currently running spinner.
+ *
+ * @returns {void}
+ */
 export declare const stop: () => void;

dist/utils/summary.d.ts

@@ -1,3 +0,15 @@
-import { Items } from "../types/Summary";
+import { Hook, Items } from "../types/Summary";
+/**
+ * The array of summary items.
+ * @type {Items}
+ */
 export declare const items: Items[];
-export declare const withSummary: <TFunc, TArgs extends unknown[]>(fn: (...args: TArgs) => Promise<TFunc>, name: string, hook: string) => (...args: TArgs) => Promise<void>;
+/**
+ * Wraps an asynchronous function with a summary item.
+ * @template TFunc, TArgs
+ * @param {(...args: TArgs) => Promise<TFunc>} fn - The function to wrap.
+ * @param {string} name - The name of the summary item.
+ * @param {Hook} hook - The hook of the summary item.
+ * @returns {Promise<unknown>} - The result of the wrapped function.
+ */
+export declare const withSummary: <TFunc, TArgs extends unknown[]>(fn: (...args: TArgs) => Promise<TFunc>, name: string, hook: Hook) => (...args: TArgs) => Promise<void>;

dist/utils/xcode.d.ts

 import xcode from "xcode";
 import { XcodeProject } from "xcode";
-import type { Config } from "../types/types";
+import type { Config } from "../types/Config";
 export declare class Xcode {
@@ -5,0 +5,0 @@ config: Config;

dist/utils/xml.d.ts

 import { X2jOptionsOptional } from "fast-xml-parser";
+/**
+ * Parses XML file, performs given callback with parsed data,
+ * and writes the updated XML data back to the file.
+ * @template T
+ * @param {string} path - Path of the XML file to be parsed.
+ * @param {X2jOptionsOptional} options - Options for XML parser.
+ * @param {(xml: T) => void} callback - Callback to be performed with parsed data.
+ * @returns {Promise<void>} Promise that resolves after writing updated XML to the file.
+ */
 export declare const withXml: <T>(path: string, options: X2jOptionsOptional, callback: (xml: T) => void) => Promise<void>;

package.json

 {
   "name": "@brandingbrand/code-core",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "",
-  "publishConfig": {
-    "access": "public"
-  },
+  "license": "MIT",
+  "author": "",
+  "keywords": [],
   "main": "dist/index.js",
-  "module": "dist/index.module.js",
-  "types": "dist/index.d.ts",
-  "source": "src/index.ts",
-  "sideEffects": false,
   "exports": {
@@ -20,15 +16,20 @@ ".": {
   },
+  "module": "dist/index.module.js",
   "files": [
-    "dist"
+    "dist",
+    "assets/template"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "microbundle --target node --format cjs,esm --tsconfig tsconfig.build.json --no-sourcemap",
-    "postbuild": "cp -r src/template.ejs dist/template",
     "dev": "microbundle watch --target node --format cjs,esm --tsconfig tsconfig.build.json"
   },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
+  "sideEffects": false,
+  "source": "src/index.ts",
+  "types": "dist/index.d.ts",
   "dependencies": {
     "@expo/spawn-async": "^1.7.0",
+    "@types/fs-extra": "^9.0.13",
     "cli-spinners": "^2.7.0",
@@ -51,3 +52,2 @@ "cli-table": "^0.3.11",
     "@types/ejs": "^3.1.1",
-    "@types/fs-extra": "^9.0.13",
     "@types/glob": "^8.0.0",
@@ -54,0 +54,0 @@ "@types/lodash": "^4.14.191",

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

451344

15.41%

Dev dependency count

5

-16.67%

Number of package files

159

9.66%

Lines of code

6636

35.51%

Number of low supply chain risk alerts

37

-5.13%

Worsened metrics

Dependency count

15

7.14%

Dependency changes

• + Added

  @types/fs-extra@^9.0.13

• + Added

  @types/fs-extra@9.0.13
  (transitive)

• + Added

  @types/node@22.14.0
  (transitive)

• + Added

  undici-types@6.21.0
  (transitive)