isaacscript-common 21.5.0 → 21.5.1

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 21.5.0
+isaacscript-common 21.5.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -50507,8 +50507,8 @@ return ____exports
  end,
 ["src.core.upgradeMod"] = function(...) 
 local ____lualib = require("lualib_bundle")
-local __TS__New = ____lualib.__TS__New
 local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local initOptionalFeatures
 local ____ModUpgraded = require("src.classes.ModUpgraded")
@@ -50528,20 +50528,6 @@ function initOptionalFeatures(self, mod, features)
         end
     end
 end
-local function upgradeModDocumentation(self, modVanilla, features, ____debug, timeThreshold)
-    if features == nil then
-        features = {}
-    end
-    if ____debug == nil then
-        ____debug = false
-    end
-    print(modVanilla)
-    print(features)
-    print(____debug)
-    print(timeThreshold)
-    local mod = RegisterMod("", 1)
-    return __TS__New(ModUpgraded, mod, false)
-end
 function ____exports.upgradeMod(self, modVanilla, features, ____debug, timeThreshold)
     if features == nil then
         features = {}

package/dist/src/core/upgradeMod.d.ts

@@ -1,2 +1,36 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+import { ISCFeature } from "../enums/ISCFeature";
+import { ModUpgradedWithFeatures } from "../types/private/ModUpgradedWithFeatures";
+type ISCFeatureTuple<T extends readonly ISCFeature[]> = ISCFeature extends T["length"] ? 'The list of features must be a tuple. Use the "as const" assertion when declaring the array.' : T;
+/**
+ * Use this function to enable the custom callbacks and other optional features provided by
+ * `isaacscript-common`.
+ *
+ * For example:
+ *
+ * ```ts
+ * const modVanilla = RegisterMod("My Mod", 1);
+ * const mod = upgradeMod(modVanilla);
+ *
+ * // Subscribe to vanilla callbacks.
+ * mod.AddCallback(ModCallback.POST_UPDATE, postUpdate);
+ *
+ * // Subscribe to custom callbacks.
+ * mod.AddCallbackCustom(ModCallbackCustom.POST_ITEM_PICKUP, postItemPickup);
+ * ```
+ *
+ * @param modVanilla The mod object returned by the `RegisterMod` function.
+ * @param features Optional. An array containing the optional standard library features that you
+ *                 want to enable, if any. Default is an empty array.
+ * @param debug Optional. Whether to log additional output when a callback is fired. Default is
+ *              false.
+ * @param timeThreshold Optional. If provided, will only log callbacks that take longer than the
+ *                      specified number of seconds (if the "--luadebug" launch flag is turned on)
+ *                      or milliseconds (if the "--luadebug" launch flag is turned off).
+ * @returns The upgraded mod object.
+ * @beta A dummy field used to hide this function from `api-extractor`.
+ */
+export declare function upgradeMod<T extends readonly ISCFeature[] = never[]>(modVanilla: Mod, features?: ISCFeatureTuple<T>, debug?: boolean, timeThreshold?: float): ModUpgradedWithFeatures<T>;
 export {};
 //# sourceMappingURL=upgradeMod.d.ts.map

package/dist/src/core/upgradeMod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upgradeMod.d.ts","sourceRoot":"","sources":["../../../src/core/upgradeMod.ts"],"names":[],"mappings":""}
+{"version":3,"file":"upgradeMod.d.ts","sourceRoot":"","sources":["../../../src/core/upgradeMod.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAIjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AAEnF,KAAK,eAAe,CAAC,CAAC,SAAS,SAAS,UAAU,EAAE,IAClD,UAAU,SAAS,CAAC,CAAC,QAAQ,CAAC,GAC1B,8FAA8F,GAC9F,CAAC,CAAC;AAER;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,SAAS,UAAU,EAAE,GAAG,KAAK,EAAE,EAClE,UAAU,EAAE,GAAG,EACf,QAAQ,GAAE,eAAe,CAAC,CAAC,CAAuC,EAClE,KAAK,UAAQ,EACb,aAAa,CAAC,EAAE,KAAK,GACpB,uBAAuB,CAAC,CAAC,CAAC,CAkB5B"}

package/dist/src/core/upgradeMod.lua

@@ -1,6 +1,6 @@
 local ____lualib = require("lualib_bundle")
-local __TS__New = ____lualib.__TS__New
 local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local initOptionalFeatures
 local ____ModUpgraded = require("src.classes.ModUpgraded")
@@ -45,48 +45,7 @@ end
 -- specified number of seconds (if the "--luadebug" launch flag is turned on)
 -- or milliseconds (if the "--luadebug" launch flag is turned off).
 -- @returns The upgraded mod object.
--- @notExported
--- @rename upgradeMod
-local function upgradeModDocumentation(self, modVanilla, features, ____debug, timeThreshold)
-    if features == nil then
-        features = {}
-    end
-    if ____debug == nil then
-        ____debug = false
-    end
-    print(modVanilla)
-    print(features)
-    print(____debug)
-    print(timeThreshold)
-    local mod = RegisterMod("", 1)
-    return __TS__New(ModUpgraded, mod, false)
-end
---- Use this function to enable the custom callbacks and other optional features provided by
--- `isaacscript-common`.
--- 
--- For example:
--- 
--- ```ts
--- const modVanilla = RegisterMod("My Mod", 1);
--- const mod = upgradeMod(modVanilla);
--- 
--- // Subscribe to vanilla callbacks.
--- mod.AddCallback(ModCallback.POST_UPDATE, postUpdate);
--- 
--- // Subscribe to custom callbacks.
--- mod.AddCallbackCustom(ModCallbackCustom.POST_ITEM_PICKUP, postItemPickup);
--- ```
--- 
--- @param modVanilla The mod object returned by the `RegisterMod` function.
--- @param features Optional. An array containing the optional standard library features that you
--- want to enable, if any. Default is an empty array.
--- @param debug Optional. Whether to log additional output when a callback is fired. Default is
--- false.
--- @param timeThreshold Optional. If provided, will only log callbacks that take longer than the
--- specified number of seconds (if the "--luadebug" launch flag is turned on)
--- or milliseconds (if the "--luadebug" launch flag is turned off).
--- @returns The upgraded mod object.
--- @internal
+-- @beta A dummy field used to hide this function from `api-extractor`.
 function ____exports.upgradeMod(self, modVanilla, features, ____debug, timeThreshold)
     if features == nil then
         features = {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "21.5.0",
+  "version": "21.5.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -20,7 +20,7 @@
   "author": "Zamiell",
   "type": "commonjs",
   "main": "dist/src/index",
-  "types": "dist/src/index.d.ts",
+  "types": "dist/index.rollup.d.ts",
   "dependencies": {
     "isaac-typescript-definitions": "^11.1.1"
   }

package/src/core/upgradeMod.ts

@@ -36,56 +36,8 @@ type ISCFeatureTuple<T extends readonly ISCFeature[]> =
  *                      specified number of seconds (if the "--luadebug" launch flag is turned on)
  *                      or milliseconds (if the "--luadebug" launch flag is turned off).
  * @returns The upgraded mod object.
- * @notExported
- * @rename upgradeMod
+ * @beta A dummy field used to hide this function from `api-extractor`.
  */
-// We duplicate the definition for `upgradeMod` because the original one has to be marked internal.
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-function upgradeModDocumentation(
-  modVanilla: Mod,
-  features: ISCFeature[] = [],
-  debug = false,
-  timeThreshold?: float,
-): ModUpgraded {
-  print(modVanilla);
-  print(features);
-  print(debug);
-  print(timeThreshold);
-
-  const mod = RegisterMod("", 1);
-  return new ModUpgraded(mod, false);
-}
-
-/**
- * Use this function to enable the custom callbacks and other optional features provided by
- * `isaacscript-common`.
- *
- * For example:
- *
- * ```ts
- * const modVanilla = RegisterMod("My Mod", 1);
- * const mod = upgradeMod(modVanilla);
- *
- * // Subscribe to vanilla callbacks.
- * mod.AddCallback(ModCallback.POST_UPDATE, postUpdate);
- *
- * // Subscribe to custom callbacks.
- * mod.AddCallbackCustom(ModCallbackCustom.POST_ITEM_PICKUP, postItemPickup);
- * ```
- *
- * @param modVanilla The mod object returned by the `RegisterMod` function.
- * @param features Optional. An array containing the optional standard library features that you
- *                 want to enable, if any. Default is an empty array.
- * @param debug Optional. Whether to log additional output when a callback is fired. Default is
- *              false.
- * @param timeThreshold Optional. If provided, will only log callbacks that take longer than the
- *                      specified number of seconds (if the "--luadebug" launch flag is turned on)
- *                      or milliseconds (if the "--luadebug" launch flag is turned off).
- * @returns The upgraded mod object.
- * @internal
- */
-// This has to be marked internal or else it will cause all of the feature classes to be included in
-// the output of `api-extractor`.
 export function upgradeMod<T extends readonly ISCFeature[] = never[]>(
   modVanilla: Mod,
   features: ISCFeatureTuple<T> = [] as unknown as ISCFeatureTuple<T>,