modpack-lock 0.6.2 → 0.8.0

package/build/types/Lockfile.d.ts

@@ -0,0 +1,39 @@
+import type { ContentVersion } from "./index.js";
+/**
+ * Lockfile shape; contains detailed information about the modpack dependencies and their versions.
+ * @property version - The version of the lockfile
+ * @property generated - The date and time the lockfile was generated
+ * @property total - The total number of files in the modpack
+ * @property counts - An object containing the number of files in each dependency category
+ * @property dependencies - An object containing arrays with all the modpack's dependencies and their version information
+ */
+export type Lockfile = {
+    version: string;
+    generated: string;
+    total: number;
+    counts: Partial<Record<DependencyCategory, number>>;
+    dependencies: {
+        mods?: LockfileDependency[];
+        resourcepacks?: LockfileDependency[];
+        datapacks?: LockfileDependency[];
+        shaderpacks?: LockfileDependency[];
+    };
+};
+/**
+ * The categories of dependencies in the lockfile
+ * @property mods - The mods folder
+ * @property resourcepacks - The resourcepacks folder
+ * @property datapacks - The datapacks folder
+ * @property shaderpacks - The shaderpacks folder
+ */
+export type DependencyCategory = keyof Lockfile["dependencies"];
+/**
+ * The shape of a dependency in the lockfile
+ * @property path - The path to the dependency file in the modpack directory
+ * @property version - The version of the dependency, or null if the dependency is not found on Modrinth
+ */
+export type LockfileDependency = {
+    path: string;
+    version: ContentVersion | null;
+};
+//# sourceMappingURL=Lockfile.d.ts.map

package/build/types/Lockfile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Lockfile.d.ts","sourceRoot":"","sources":["../../src/types/Lockfile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,YAAY,CAAC;AAE/C;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,GAAG;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,YAAY,EAAE;QACV,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAC5B,aAAa,CAAC,EAAE,kBAAkB,EAAE,CAAC;QACrC,SAAS,CAAC,EAAE,kBAAkB,EAAE,CAAC;QACjC,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAC;KACtC,CAAC;CACL,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;CAClC,CAAC"}

package/build/types/Lockfile.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Lockfile.js.map

package/build/types/Lockfile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Lockfile.js","sourceRoot":"","sources":["../../src/types/Lockfile.ts"],"names":[],"mappings":""}

package/build/types/ModpackInfo.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Contains information about the modpack that is not dependent on the lockfile.
+ * @property name - The name of the modpack (Required)
+ * @property version - The modpack version (Required)
+ * @property description - A description of the modpack
+ * @property id - The modpack's slug/ID (Required)
+ * @property author - The author of the modpack (Required)
+ * @property projectUrl - The project's homepage URL
+ * @property sourceUrl - The project's source code URL
+ * @property license - The modpack's license
+ * @property modloader - The modpack's modloader (Required)
+ * @property targetModloaderVersion - The target modloader version
+ * @property targetMinecraftVersion - The target Minecraft version (Required)
+ */
+export type ModpackInfo = {
+    name: string;
+    version: string;
+    description: string;
+    id: string;
+    author: string;
+    projectUrl: string;
+    sourceUrl: string;
+    license: string;
+    modloader: string;
+    targetModloaderVersion: string;
+    targetMinecraftVersion: string;
+};
+//# sourceMappingURL=ModpackInfo.d.ts.map

package/build/types/ModpackInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModpackInfo.d.ts","sourceRoot":"","sources":["../../src/types/ModpackInfo.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,sBAAsB,EAAE,MAAM,CAAC;CAClC,CAAC"}

package/build/types/ModpackInfo.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ModpackInfo.js.map

package/build/types/ModpackInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModpackInfo.js","sourceRoot":"","sources":["../../src/types/ModpackInfo.ts"],"names":[],"mappings":""}

package/build/types/OptionalFileOptions.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The options available for the user to add optional files to the modpack
+ * @property addLicense - Whether to add the license text to the modpack
+ * @property addReadme - Whether to add the README.md file to the modpack
+ * @property addGitignore - Whether to add the .gitignore file to the modpack
+ */
+export type OptionalFileOptions = "addLicense" | "addReadme" | "addGitignore";
+//# sourceMappingURL=OptionalFileOptions.d.ts.map

package/build/types/OptionalFileOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionalFileOptions.d.ts","sourceRoot":"","sources":["../../src/types/OptionalFileOptions.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,CAAC"}

package/build/types/OptionalFileOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=OptionalFileOptions.js.map

package/build/types/OptionalFileOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionalFileOptions.js","sourceRoot":"","sources":["../../src/types/OptionalFileOptions.ts"],"names":[],"mappings":""}

package/build/types/contentFiles.d.ts

@@ -0,0 +1,24 @@
+import type { DependencyCategory } from "./index.js";
+/**
+ * A directory that contains modpack content (e.g. mods, resourcepacks, datapacks, shaderpacks)
+ * @property name - The name of the directory
+ * @property path - The path to the directory
+ */
+export type ContentDirectory = {
+    name: DependencyCategory;
+    path: string;
+};
+/**
+ * A binary content file in the modpack -- a file tracked by the modpack lockfile
+ * @property path - The path to the file
+ * @property fullPath - The full path to the file
+ * @property hash - The hash of the file
+ * @property category - The content category of the file (e.g. mods, resourcepacks, datapacks, shaderpacks)
+ */
+export type ContentFile = {
+    path: string;
+    fullPath: string;
+    hash: string;
+    category: DependencyCategory;
+};
+//# sourceMappingURL=contentFiles.d.ts.map

package/build/types/contentFiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentFiles.d.ts","sourceRoot":"","sources":["../../src/types/contentFiles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,YAAY,CAAC;AAEnD;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC3B,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,kBAAkB,CAAC;CAChC,CAAC"}

package/build/types/contentFiles.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=contentFiles.js.map

package/build/types/contentFiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentFiles.js","sourceRoot":"","sources":["../../src/types/contentFiles.ts"],"names":[],"mappings":""}

package/build/types/githubResponses.d.ts

@@ -0,0 +1,17 @@
+/**
+ * One of the license objects in a response from the GitHub API
+ * @property spdx_id - The SPDX ID of the license
+ * @property key - The key of the license
+ */
+export type LicenseResponseItem = {
+    spdx_id: string;
+    key: string;
+};
+/**
+ * The response from the GitHub API for a license text
+ * @property body - The text of the license
+ */
+export type LicenseTextResponse = {
+    body: string;
+};
+//# sourceMappingURL=githubResponses.d.ts.map

package/build/types/githubResponses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"githubResponses.d.ts","sourceRoot":"","sources":["../../src/types/githubResponses.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/build/types/githubResponses.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=githubResponses.js.map

package/build/types/githubResponses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"githubResponses.js","sourceRoot":"","sources":["../../src/types/githubResponses.ts"],"names":[],"mappings":""}

package/build/types/index.d.ts

@@ -0,0 +1,9 @@
+export type * from "./Lockfile.js";
+export type * from "./Jsonfile.js";
+export type * from "./ModpackInfo.js";
+export type * from "./options.js";
+export type * from "./modrinthResponses.js";
+export type * from "./githubResponses.js";
+export type * from "./contentFiles.js";
+export type * from "./OptionalFileOptions.js";
+//# sourceMappingURL=index.d.ts.map

package/build/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,eAAe,CAAC;AACnC,mBAAmB,eAAe,CAAC;AACnC,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,cAAc,CAAC;AAClC,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,0BAA0B,CAAC"}

package/build/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/build/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/build/types/modrinthResponses.d.ts

@@ -0,0 +1,135 @@
+/**
+ * The shape of a dependency on another version of another project
+ * @property version_id - The ID of the dependency version
+ * @property project_id - The ID of the project
+ * @property file_name - The name of the file
+ * @property dependency_type - The type of dependency
+ */
+export type VersionDependency = {
+    version_id: string;
+    project_id: string;
+    file_name: string;
+    dependency_type: string;
+};
+/**
+ * A metadata for a specific version file of a project on Modrinth. Saved in the lockfile.
+ * @property id - The ID of the version
+ * @property project_id - The ID of the project
+ * @property author_id - The ID of the author
+ * @property date_published - The date the version was published
+ * @property downloads - The number of downloads of the version
+ * @property files - The files of the version
+ * @property game_versions - The game versions the version is compatible with
+ * @property loaders - The loaders the version is compatible with
+ * @property featured - Whether the version is featured
+ * @property name - The name of the version
+ * @property version_number - The version number
+ * @property changelog - The changelog of the version
+ * @property changelog_url - The URL of the changelog
+ * @property version_type - The type of version
+ * @property status - The status of the version
+ * @property requested_status - The requested status of the version
+ * @property dependencies - The dependencies for this version
+ */
+export type ContentVersion = {
+    id: string;
+    project_id: string;
+    author_id: string;
+    date_published: string;
+    downloads: number;
+    files: any[];
+    game_versions?: string[];
+    loaders?: string[];
+    featured?: boolean;
+    name?: string;
+    version_number?: string;
+    changelog?: string;
+    changelog_url?: string | null;
+    version_type?: string;
+    status?: string;
+    requested_status?: string | null;
+    dependencies?: VersionDependency[];
+};
+/**
+ * The shape of a project response from the Modrinth API
+ */
+export type ProjectResponseItem = {
+    id: string;
+    project_type: string;
+    team: string;
+    published: string;
+    updated: string;
+    downloads: number;
+    followers: number;
+    slug?: string;
+    client_side?: string;
+    server_side?: string;
+    game_versions?: string[];
+    organization?: string | null;
+    title?: string;
+    description?: string;
+    body?: string;
+    body_url?: string | null;
+    approved?: string;
+    queued?: string | null;
+    status?: string;
+    requested_status?: string | null;
+    moderator_message?: string | null;
+    license?: any;
+    categories?: string[];
+    additional_categories?: string[];
+    loaders?: string[];
+    versions?: string[];
+    icon_url?: string;
+    issues_url?: string;
+    source_url?: string;
+    wiki_url?: string;
+    discord_url?: string;
+    donation_urls?: string[];
+    gallery?: string[];
+    color?: number;
+    thread_id?: string;
+    monetization_status?: string;
+};
+/**
+ * The types of Minecraft versions that can be returned from the Modrinth API
+ */
+export type MinecraftVersionType = "release" | "alpha" | "beta" | "snapshot";
+/**
+ * The shape of an item in the Minecraft versions response from the Modrinth API
+ */
+export type MinecraftVersionResponseItem = {
+    version: string;
+    version_type: MinecraftVersionType;
+    date: string;
+    major: boolean;
+};
+/**
+ * The shape of an item in the modloaders response from the Modrinth API
+ */
+export type ModloaderResponseItem = {
+    icon: string;
+    name: string;
+    supported_project_types: string[];
+};
+/**
+ * The shape of an item in the users response from the Modrinth API
+ */
+export type UserResponseItem = {
+    username: string;
+    id: string;
+    created: string;
+    role: "admin" | "moderator" | "developer";
+    name?: string;
+    email?: string | null;
+    bio?: string;
+    payout_data?: any;
+    avatar_url?: string;
+    badges?: number;
+    auth_providers?: string[];
+    email_verified?: boolean | null;
+    has_password?: boolean | null;
+    has_totp?: boolean | null;
+    github_id?: number | null;
+};
+//# sourceMappingURL=modrinthResponses.d.ts.map

package/build/types/modrinthResponses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modrinthResponses.d.ts","sourceRoot":"","sources":["../../src/types/modrinthResponses.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,GAAG,EAAE,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,oBAAoB,CAAC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B,CAAC"}

package/build/types/modrinthResponses.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=modrinthResponses.js.map

package/build/types/modrinthResponses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modrinthResponses.js","sourceRoot":"","sources":["../../src/types/modrinthResponses.ts"],"names":[],"mappings":""}

package/build/types/options.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Contains options for the generation of the modpack files.
+ * @property dryRun - Whether to run in dry-run mode (no files written)
+ * @property quiet - Whether to quiet the console output
+ * @property silent - Whether to silence the console output
+ * @property gitignore - Whether to generate a .gitignore file
+ * @property readme - Whether to generate README.md files
+ * @property licenseFile - Whether to generate a license file
+ * @property path - The modpack root directory
+ */
+export interface Options {
+    dryRun?: boolean;
+    quiet?: boolean;
+    silent?: boolean;
+    gitignore?: boolean;
+    readme?: boolean;
+    licenseFile?: boolean;
+    path?: string;
+}
+/**
+ * Contains options for the initialization of the modpack files.
+ * @property folder - The modpack root directory
+ * @property noninteractive - Whether to initialize in non-interactive mode
+ * @property addLicense - Whether to add the license file to the modpack
+ * @property addGitignore - Whether to generate .gitignore rules
+ * @property addReadme - Whether to generate README.md files
+ * @property name - The option to set the modpack name
+ * @property version - The option to set the version
+ * @property id - The option to set the slug/ID
+ * @property description - The option to set the description
+ * @property author - The option to set the author
+ * @property projectUrl - The option to set the project URL
+ * @property sourceUrl - The option to set the source code URL
+ * @property license - The option to set the license
+ * @property modloader - The option to set the modloader
+ * @property targetModloaderVersion - The option to set the target modloader version
+ * @property targetMinecraftVersion - The option to set the target Minecraft version
+ * @property _init - Internal boolean added to indicate options come from the `init` command.
+ */
+export interface InitOptions extends Options {
+    folder?: string;
+    noninteractive?: boolean;
+    addLicense?: boolean;
+    addGitignore?: boolean;
+    addReadme?: boolean;
+    name?: string;
+    version?: string;
+    id?: string;
+    description?: string;
+    author?: string;
+    projectUrl?: string;
+    sourceUrl?: string;
+    license?: string;
+    modloader?: string;
+    targetModloaderVersion?: string;
+    targetMinecraftVersion?: string;
+    _init?: boolean;
+}
+/**
+ * Contains options for the running scripts defined in modpack.json.
+ * @property folder - The modpack root directory
+ * @property debug - Whether to print debug information
+ * @property _run - Internal boolean added to indicate options come from the `run` command.
+ */
+export interface RunOptions extends Options {
+    folder?: string;
+    debug?: boolean;
+    _run?: boolean;
+}
+//# sourceMappingURL=options.d.ts.map

package/build/types/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/types/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,WAAW,OAAO;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB"}

package/build/types/options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=options.js.map

package/build/types/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../src/types/options.ts"],"names":[],"mappings":""}

package/build/user_prompts.d.ts

@@ -0,0 +1,16 @@
+import prompts from "prompts";
+import type { OptionalFileOptions, InitOptions, Jsonfile, ModpackInfo } from "./types/index.js";
+/**
+ * Prompt the user for modpack information
+ * @param defaults - The default modpack information, used as the initial value for each prompt
+ * @returns The answers to the prompts from the user
+ */
+export declare function promptUserForInfo(defaults: Jsonfile): Promise<prompts.Answers<keyof ModpackInfo>>;
+/**
+ * Prompt the user about adding the license text to the modpack
+ * @param modpackInfo - The Jsonfile object containing the modpack information
+ * @param options - The default options
+ * @returns The answers from the user
+ */
+export declare function promptUserAboutOptionalFiles(modpackInfo: Jsonfile, options: InitOptions): Promise<prompts.Answers<OptionalFileOptions>>;
+//# sourceMappingURL=user_prompts.d.ts.map

package/build/user_prompts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user_prompts.d.ts","sourceRoot":"","sources":["../src/user_prompts.ts"],"names":[],"mappings":"AAAA,OAAO,OAAkE,MAAM,SAAS,CAAC;AAKzF,OAAO,KAAK,EAAC,mBAAmB,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAC,MAAM,kBAAkB,CAAC;AA8G9F;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,WAAW,CAAC,CAAC,CA0DvG;AAED;;;;;GAKG;AACH,wBAAsB,4BAA4B,CAC9C,WAAW,EAAE,QAAQ,EACrB,OAAO,EAAE,WAAW,GACrB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CA6B/C"}

package/build/user_prompts.js

@@ -0,0 +1,132 @@
+import prompts, {} from "prompts";
+import slugify from "@sindresorhus/slugify";
+import * as config from "./config/index.js";
+import { getLicenseList, getLicenseText } from "./github_interactions.js";
+import { getMinecraftVersions, getModloaders } from "./modrinth_interactions.js";
+/**
+ * Capitalizes a string
+ */
+function capitalize(string) {
+    return `${string.charAt(0).toUpperCase()}${string.slice(1)}`;
+}
+/**
+ * Validate that a value is not empty
+ */
+function validateNotEmpty(value, field) {
+    if (value === undefined || value?.trim().length === 0) {
+        return `${field} cannot be empty`;
+    }
+    return true;
+}
+/**
+ * Returns a required text prompt
+ */
+function requiredText(name, message, initial) {
+    return {
+        type: "text",
+        name: name,
+        message: `${capitalize(message)}`,
+        initial: initial,
+        validate: (value) => {
+            return validateNotEmpty(value, name);
+        },
+    };
+}
+/**
+ * Returns an optional text prompt
+ */
+function optionalText(name, message, initial) {
+    return {
+        type: "text",
+        name: name,
+        message: `${capitalize(message)}`,
+        initial: initial,
+    };
+}
+/**
+ * Get the value of an "other" answer from the user
+ */
+async function getOtherAnswer(value, message, initial) {
+    if (value && value !== config.OTHER_OPTION.value) {
+        return value;
+    }
+    const question = await prompts(requiredText("other", message, initial), config.PROMPTS_OPTIONS);
+    return question.other || config.OTHER_OPTION.value;
+}
+/**
+ * Returns a required autocomplete prompt with a fallback to the "other" option
+ */
+function requiredAutocomplete(name, message, initial, choices, defaultValue) {
+    initial = initial || defaultValue || config.OTHER_OPTION.value;
+    if (initial && !choices.some((choice) => choice.value === initial)) {
+        choices.push({ title: initial, value: initial });
+    }
+    return {
+        type: "autocomplete",
+        name: name,
+        message: `${capitalize(message)}`,
+        initial: initial,
+        choices: choices,
+        //fallback: config.OTHER_OPTION.value,
+        format: async (value) => {
+            return await getOtherAnswer(value, ` └─𜰙 Other ${message}`, initial);
+        },
+    };
+}
+/**
+ * Returns a confirmation prompt to generate an optional file
+ */
+function fileGenerationConfirm(name, message, showPrompt) {
+    return {
+        type: showPrompt ? "confirm" : null,
+        name: name,
+        message: `${capitalize(message)}`,
+        initial: true,
+    };
+}
+/**
+ * Prompt the user for modpack information
+ * @param defaults - The default modpack information, used as the initial value for each prompt
+ * @returns The answers to the prompts from the user
+ */
+export async function promptUserForInfo(defaults) {
+    const licenseList = await getLicenseList();
+    const minecraftVersions = await getMinecraftVersions();
+    const modloaders = await getModloaders();
+    let answers = await prompts([
+        requiredText("name", config.infoFields.name.prompt, defaults.name),
+        requiredText("version", config.infoFields.version.prompt, defaults.version || config.DEFAULT_MODPACK_VERSION),
+        requiredText("id", config.infoFields.id.prompt, (prev, values) => {
+            return slugify(defaults.id || values.name, config.SLUGIFY_OPTIONS);
+        }),
+        optionalText("description", config.infoFields.description.prompt, defaults.description),
+        requiredText("author", config.infoFields.author.prompt, defaults.author),
+        optionalText("projectUrl", config.infoFields.projectUrl.prompt, (prev, values) => defaults.projectUrl || config.DEFAULT_PROJECT_URL(values.id)),
+        optionalText("sourceUrl", config.infoFields.sourceUrl.prompt, (prev, values) => defaults.sourceUrl || config.DEFAULT_SOURCE_URL(values.id, values.author)),
+        requiredAutocomplete("license", config.infoFields.license.prompt, defaults.license, licenseList, config.DEFAULT_MODPACK_LICENSE),
+        requiredAutocomplete("modloader", config.infoFields.modloader.prompt, defaults.modloader, modloaders, config.FALLBACK_MODLOADERS[0] ? config.FALLBACK_MODLOADERS[0].value : ""),
+        optionalText("targetModloaderVersion", config.infoFields.targetModloaderVersion.prompt, defaults.targetModloaderVersion),
+        requiredAutocomplete("targetMinecraftVersion", config.infoFields.targetMinecraftVersion.prompt, defaults.targetMinecraftVersion, minecraftVersions, minecraftVersions[0]?.value || ""),
+    ], config.PROMPTS_OPTIONS);
+    return answers;
+}
+/**
+ * Prompt the user about adding the license text to the modpack
+ * @param modpackInfo - The Jsonfile object containing the modpack information
+ * @param options - The default options
+ * @returns The answers from the user
+ */
+export async function promptUserAboutOptionalFiles(modpackInfo, options) {
+    const licenseText = modpackInfo.license ? await getLicenseText(modpackInfo.license) : null;
+    const answers = await prompts([
+        fileGenerationConfirm("addLicense", `${config.fileFields.addLicense.prompt}?`, licenseText && options.addLicense === undefined ? true : false),
+        fileGenerationConfirm("addReadme", `${config.fileFields.addReadme.prompt}?`, options.addReadme === undefined),
+        fileGenerationConfirm("addGitignore", `${config.fileFields.addGitignore.prompt}?`, options.addGitignore === undefined),
+    ], config.PROMPTS_OPTIONS);
+    answers.addLicense =
+        answers.addLicense === undefined ? (licenseText ? options.addLicense : false) : answers.addLicense;
+    answers.addReadme = answers.addReadme === undefined ? options.addReadme : answers.addReadme;
+    answers.addGitignore = answers.addGitignore === undefined ? options.addGitignore : answers.addGitignore;
+    return answers;
+}
+//# sourceMappingURL=user_prompts.js.map

package/build/user_prompts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user_prompts.js","sourceRoot":"","sources":["../src/user_prompts.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAyD,MAAM,SAAS,CAAC;AACzF,OAAO,OAAO,MAAM,uBAAuB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAC,cAAc,EAAE,cAAc,EAAC,MAAM,0BAA0B,CAAC;AACxE,OAAO,EAAC,oBAAoB,EAAE,aAAa,EAAC,MAAM,4BAA4B,CAAC;AAG/E;;GAEG;AACH,SAAS,UAAU,CAAC,MAAc;IAC9B,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AACjE,CAAC;AAED;;GAEG;AACH,SAAS,gBAAgB,CAAC,KAAa,EAAE,KAAa;IAClD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,EAAE,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpD,OAAO,GAAG,KAAK,kBAAkB,CAAC;IACtC,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CACjB,IAAiC,EACjC,OAAe,EACf,OAAgC;IAEhC,OAAO;QACH,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,EAAE;QACjC,OAAO,EAAE,OAAO;QAChB,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE;YACxB,OAAO,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACzC,CAAC;KACJ,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CACjB,IAAiC,EACjC,OAAe,EACf,OAAgC;IAEhC,OAAO;QACH,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,EAAE;QACjC,OAAO,EAAE,OAAO;KACnB,CAAC;AACN,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,cAAc,CAAC,KAAa,EAAE,OAAe,EAAE,OAAgC;IAC1F,IAAI,KAAK,IAAI,KAAK,KAAK,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IAEhG,OAAO,QAAQ,CAAC,KAAK,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,SAAS,oBAAoB,CACzB,IAAiC,EACjC,OAAe,EACf,OAAgC,EAChC,OAAiB,EACjB,YAAoB;IAEpB,OAAO,GAAG,OAAO,IAAI,YAAY,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC;IAC/D,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,OAAO,CAAC,EAAE,CAAC;QACjE,OAAO,CAAC,IAAI,CAAC,EAAC,KAAK,EAAE,OAAiB,EAAE,KAAK,EAAE,OAAiB,EAAC,CAAC,CAAC;IACvE,CAAC;IAED,OAAO;QACH,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,EAAE;QACjC,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,OAAO;QAChB,sCAAsC;QACtC,MAAM,EAAE,KAAK,EAAE,KAAa,EAAE,EAAE;YAC5B,OAAO,MAAM,cAAc,CAAC,KAAK,EAAE,eAAe,OAAO,EAAE,EAAE,OAAiB,CAAC,CAAC;QACpF,CAAC;KACJ,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAC1B,IAAmC,EACnC,OAAe,EACf,UAAmB;IAEnB,OAAO;QACH,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI;QACnC,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,EAAE;QACjC,OAAO,EAAE,IAAI;KAChB,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,QAAkB;IACtD,MAAM,WAAW,GAAG,MAAM,cAAc,EAAE,CAAC;IAC3C,MAAM,iBAAiB,GAAG,MAAM,oBAAoB,EAAE,CAAC;IACvD,MAAM,UAAU,GAAG,MAAM,aAAa,EAAE,CAAC;IACzC,IAAI,OAAO,GAAuC,MAAM,OAAO,CAC3D;QACI,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC;QAClE,YAAY,CACR,SAAS,EACT,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,EAChC,QAAQ,CAAC,OAAO,IAAI,MAAM,CAAC,uBAAuB,CACrD;QACD,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,MAAW,EAAE,EAAE;YAC1E,OAAO,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;QACvE,CAAC,CAAC;QACF,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC;QACvF,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC;QACxE,YAAY,CACR,YAAY,EACZ,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,EACnC,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,IAAI,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC,CACjF;QACD,YAAY,CACR,WAAW,EACX,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,EAClC,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,SAAS,IAAI,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAC9F;QACD,oBAAoB,CAChB,SAAS,EACT,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,EAChC,QAAQ,CAAC,OAAO,EAChB,WAAW,EACX,MAAM,CAAC,uBAAuB,CACjC;QACD,oBAAoB,CAChB,WAAW,EACX,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,EAClC,QAAQ,CAAC,SAAS,EAClB,UAAU,EACV,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAC3E;QACD,YAAY,CACR,wBAAwB,EACxB,MAAM,CAAC,UAAU,CAAC,sBAAsB,CAAC,MAAM,EAC/C,QAAQ,CAAC,sBAAsB,CAClC;QACD,oBAAoB,CAChB,wBAAwB,EACxB,MAAM,CAAC,UAAU,CAAC,sBAAsB,CAAC,MAAM,EAC/C,QAAQ,CAAC,sBAAsB,EAC/B,iBAAiB,EACjB,iBAAiB,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,EAAE,CACpC;KACJ,EACD,MAAM,CAAC,eAAe,CACzB,CAAC;IAEF,OAAO,OAAO,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAC9C,WAAqB,EACrB,OAAoB;IAEpB,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3F,MAAM,OAAO,GAAyC,MAAM,OAAO,CAC/D;QACI,qBAAqB,CACjB,YAAY,EACZ,GAAG,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,EACzC,WAAW,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CACjE;QACD,qBAAqB,CACjB,WAAW,EACX,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,GAAG,EACxC,OAAO,CAAC,SAAS,KAAK,SAAS,CAClC;QACD,qBAAqB,CACjB,cAAc,EACd,GAAG,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,MAAM,GAAG,EAC3C,OAAO,CAAC,YAAY,KAAK,SAAS,CACrC;KACJ,EACD,MAAM,CAAC,eAAe,CACzB,CAAC;IAEF,OAAO,CAAC,UAAU;QACd,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IACvG,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC5F,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;IAExG,OAAO,OAAO,CAAC;AACnB,CAAC"}